drivers/usb/host/ehci-hcd.c

   1 /*
   2  * Copyright (c) 2000-2004 by David Brownell
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/pci.h>
  21 #include <linux/dmapool.h>
  22 #include <linux/kernel.h>
  23 #include <linux/delay.h>
  24 #include <linux/ioport.h>
  25 #include <linux/sched.h>
  26 #include <linux/vmalloc.h>
  27 #include <linux/errno.h>
  28 #include <linux/init.h>
  29 #include <linux/timer.h>
  30 #include <linux/ktime.h>
  31 #include <linux/list.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/usb.h>
  34 #include <linux/usb/hcd.h>
  35 #include <linux/moduleparam.h>
  36 #include <linux/dma-mapping.h>
  37 #include <linux/debugfs.h>
  38 #include <linux/slab.h>
  39
  40 #include <asm/byteorder.h>
  41 #include <asm/io.h>
  42 #include <asm/irq.h>
  43 #include <asm/system.h>
  44 #include <asm/unaligned.h>
  45
  46 /*-------------------------------------------------------------------------*/
  47
  48 /*
  49  * EHCI hc_driver implementation ... experimental, incomplete.
  50  * Based on the final 1.0 register interface specification.
  51  *
  52  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  53  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  54  * Next comes "CardBay", using USB 2.0 signals.
  55  *
  56  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  57  * Special thanks to Intel and VIA for providing host controllers to
  58  * test this driver on, and Cypress (including In-System Design) for
  59  * providing early devices for those host controllers to talk to!
  60  */
  61
  62 #define DRIVER_AUTHOR "David Brownell"
  63 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
  64
  65 static const char       hcd_name [] = "ehci_hcd";
  66
  67
  68 #undef VERBOSE_DEBUG
  69 #undef EHCI_URB_TRACE
  70
  71 #ifdef DEBUG
  72 #define EHCI_STATS
  73 #endif
  74
  75 /* magic numbers that can affect system performance */
  76 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
  77 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
  78 #define EHCI_TUNE_RL_TT         0
  79 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
  80 #define EHCI_TUNE_MULT_TT       1
  81 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
  82
  83 #define EHCI_IAA_MSECS          10              /* arbitrary */
  84 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
  85 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
  86 #define EHCI_SHRINK_FRAMES      5               /* async qh unlink delay */
  87
  88 /* Initial IRQ latency:  faster than hw default */
  89 static int log2_irq_thresh = 0;         // 0 to 6
  90 module_param (log2_irq_thresh, int, S_IRUGO);
  91 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
  92
  93 /* initial park setting:  slower than hw default */
  94 static unsigned park = 0;
  95 module_param (park, uint, S_IRUGO);
  96 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
  97
  98 /* for flakey hardware, ignore overcurrent indicators */
  99 static int ignore_oc = 0;
 100 module_param (ignore_oc, bool, S_IRUGO);
 101 MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
 102
 103 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 104
 105 /*-------------------------------------------------------------------------*/
 106
 107 #include "ehci.h"
 108 #include "ehci-dbg.c"
 109
 110 /*-------------------------------------------------------------------------*/
 111
 112 static void
 113 timer_action(struct ehci_hcd *ehci, enum ehci_timer_action action)
 114 {
 115         /* Don't override timeouts which shrink or (later) disable
 116          * the async ring; just the I/O watchdog.  Note that if a
 117          * SHRINK were pending, OFF would never be requested.
 118          */
 119         if (timer_pending(&ehci->watchdog)
 120                         && ((BIT(TIMER_ASYNC_SHRINK) | BIT(TIMER_ASYNC_OFF))
 121                                 & ehci->actions))
 122                 return;
 123
 124         if (!test_and_set_bit(action, &ehci->actions)) {
 125                 unsigned long t;
 126
 127                 switch (action) {
 128                 case TIMER_IO_WATCHDOG:
 129                         if (!ehci->need_io_watchdog)
 130                                 return;
 131                         t = EHCI_IO_JIFFIES;
 132                         break;
 133                 case TIMER_ASYNC_OFF:
 134                         t = EHCI_ASYNC_JIFFIES;
 135                         break;
 136                 /* case TIMER_ASYNC_SHRINK: */
 137                 default:
 138                         /* add a jiffie since we synch against the
 139                          * 8 KHz uframe counter.
 140                          */
 141                         t = DIV_ROUND_UP(EHCI_SHRINK_FRAMES * HZ, 1000) + 1;
 142                         break;
 143                 }
 144                 mod_timer(&ehci->watchdog, t + jiffies);
 145         }
 146 }
 147
 148 /*-------------------------------------------------------------------------*/
 149
 150 /*
 151  * handshake - spin reading hc until handshake completes or fails
 152  * @ptr: address of hc register to be read
 153  * @mask: bits to look at in result of read
 154  * @done: value of those bits when handshake succeeds
 155  * @usec: timeout in microseconds
 156  *
 157  * Returns negative errno, or zero on success
 158  *
 159  * Success happens when the "mask" bits have the specified value (hardware
 160  * handshake done).  There are two failure modes:  "usec" have passed (major
 161  * hardware flakeout), or the register reads as all-ones (hardware removed).
 162  *
 163  * That last failure should_only happen in cases like physical cardbus eject
 164  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 165  * bridge shutdown:  shutting down the bridge before the devices using it.
 166  */
 167 static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
 168                       u32 mask, u32 done, int usec)
 169 {
 170         u32     result;
 171
 172         do {
 173                 result = ehci_readl(ehci, ptr);
 174                 if (result == ~(u32)0)          /* card removed */
 175                         return -ENODEV;
 176                 result &= mask;
 177                 if (result == done)
 178                         return 0;
 179                 udelay (1);
 180                 usec--;
 181         } while (usec > 0);
 182         return -ETIMEDOUT;
 183 }
 184
 185 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 186 static int ehci_halt (struct ehci_hcd *ehci)
 187 {
 188         u32     temp = ehci_readl(ehci, &ehci->regs->status);
 189
 190         /* disable any irqs left enabled by previous code */
 191         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 192
 193         if ((temp & STS_HALT) != 0)
 194                 return 0;
 195
 196         temp = ehci_readl(ehci, &ehci->regs->command);
 197         temp &= ~CMD_RUN;
 198         ehci_writel(ehci, temp, &ehci->regs->command);
 199         return handshake (ehci, &ehci->regs->status,
 200                           STS_HALT, STS_HALT, 16 * 125);
 201 }
 202
 203 static int handshake_on_error_set_halt(struct ehci_hcd *ehci, void __iomem *ptr,
 204                                        u32 mask, u32 done, int usec)
 205 {
 206         int error;
 207
 208         error = handshake(ehci, ptr, mask, done, usec);
 209         if (error) {
 210                 ehci_halt(ehci);
 211                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 212                 ehci_err(ehci, "force halt; handshake %p %08x %08x -> %d\n",
 213                         ptr, mask, done, error);
 214         }
 215
 216         return error;
 217 }
 218
 219 /* put TDI/ARC silicon into EHCI mode */
 220 static void tdi_reset (struct ehci_hcd *ehci)
 221 {
 222         u32 __iomem     *reg_ptr;
 223         u32             tmp;
 224
 225         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
 226         tmp = ehci_readl(ehci, reg_ptr);
 227         tmp |= USBMODE_CM_HC;
 228         /* The default byte access to MMR space is LE after
 229          * controller reset. Set the required endian mode
 230          * for transfer buffers to match the host microprocessor
 231          */
 232         if (ehci_big_endian_mmio(ehci))
 233                 tmp |= USBMODE_BE;
 234         ehci_writel(ehci, tmp, reg_ptr);
 235 }
 236
 237 /* reset a non-running (STS_HALT == 1) controller */
 238 static int ehci_reset (struct ehci_hcd *ehci)
 239 {
 240         int     retval;
 241         u32     command = ehci_readl(ehci, &ehci->regs->command);
 242
 243         /* If the EHCI debug controller is active, special care must be
 244          * taken before and after a host controller reset */
 245         if (ehci->debug && !dbgp_reset_prep())
 246                 ehci->debug = NULL;
 247
 248         command |= CMD_RESET;
 249         dbg_cmd (ehci, "reset", command);
 250         ehci_writel(ehci, command, &ehci->regs->command);
 251         ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 252         ehci->next_statechange = jiffies;
 253         retval = handshake (ehci, &ehci->regs->command,
 254                             CMD_RESET, 0, 250 * 1000);
 255
 256         if (ehci->has_hostpc) {
 257                 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
 258                         (u32 __iomem *)(((u8 *)ehci->regs) + USBMODE_EX));
 259                 ehci_writel(ehci, TXFIFO_DEFAULT,
 260                         (u32 __iomem *)(((u8 *)ehci->regs) + TXFILLTUNING));
 261         }
 262         if (retval)
 263                 return retval;
 264
 265         if (ehci_is_TDI(ehci))
 266                 tdi_reset (ehci);
 267
 268         if (ehci->debug)
 269                 dbgp_external_startup();
 270
 271         return retval;
 272 }
 273
 274 /* idle the controller (from running) */
 275 static void ehci_quiesce (struct ehci_hcd *ehci)
 276 {
 277         u32     temp;
 278
 279 #ifdef DEBUG
 280         if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
 281                 BUG ();
 282 #endif
 283
 284         /* wait for any schedule enables/disables to take effect */
 285         temp = ehci_readl(ehci, &ehci->regs->command) << 10;
 286         temp &= STS_ASS | STS_PSS;
 287         if (handshake_on_error_set_halt(ehci, &ehci->regs->status,
 288                                         STS_ASS | STS_PSS, temp, 16 * 125))
 289                 return;
 290
 291         /* then disable anything that's still active */
 292         temp = ehci_readl(ehci, &ehci->regs->command);
 293         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
 294         ehci_writel(ehci, temp, &ehci->regs->command);
 295
 296         /* hardware can take 16 microframes to turn off ... */
 297         handshake_on_error_set_halt(ehci, &ehci->regs->status,
 298                                     STS_ASS | STS_PSS, 0, 16 * 125);
 299 }
 300
 301 /*-------------------------------------------------------------------------*/
 302
 303 static void end_unlink_async(struct ehci_hcd *ehci);
 304 static void ehci_work(struct ehci_hcd *ehci);
 305
 306 #include "ehci-hub.c"
 307 #include "ehci-mem.c"
 308 #include "ehci-q.c"
 309 #include "ehci-sched.c"
 310
 311 /*-------------------------------------------------------------------------*/
 312
 313 static void ehci_iaa_watchdog(unsigned long param)
 314 {
 315         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 316         unsigned long           flags;
 317
 318         spin_lock_irqsave (&ehci->lock, flags);
 319
 320         /* Lost IAA irqs wedge things badly; seen first with a vt8235.
 321          * So we need this watchdog, but must protect it against both
 322          * (a) SMP races against real IAA firing and retriggering, and
 323          * (b) clean HC shutdown, when IAA watchdog was pending.
 324          */
 325         if (ehci->reclaim
 326                         && !timer_pending(&ehci->iaa_watchdog)
 327                         && HC_IS_RUNNING(ehci_to_hcd(ehci)->state)) {
 328                 u32 cmd, status;
 329
 330                 /* If we get here, IAA is *REALLY* late.  It's barely
 331                  * conceivable that the system is so busy that CMD_IAAD
 332                  * is still legitimately set, so let's be sure it's
 333                  * clear before we read STS_IAA.  (The HC should clear
 334                  * CMD_IAAD when it sets STS_IAA.)
 335                  */
 336                 cmd = ehci_readl(ehci, &ehci->regs->command);
 337                 if (cmd & CMD_IAAD)
 338                         ehci_writel(ehci, cmd & ~CMD_IAAD,
 339                                         &ehci->regs->command);
 340
 341                 /* If IAA is set here it either legitimately triggered
 342                  * before we cleared IAAD above (but _way_ late, so we'll
 343                  * still count it as lost) ... or a silicon erratum:
 344                  * - VIA seems to set IAA without triggering the IRQ;
 345                  * - IAAD potentially cleared without setting IAA.
 346                  */
 347                 status = ehci_readl(ehci, &ehci->regs->status);
 348                 if ((status & STS_IAA) || !(cmd & CMD_IAAD)) {
 349                         COUNT (ehci->stats.lost_iaa);
 350                         ehci_writel(ehci, STS_IAA, &ehci->regs->status);
 351                 }
 352
 353                 ehci_vdbg(ehci, "IAA watchdog: status %x cmd %x\n",
 354                                 status, cmd);
 355                 end_unlink_async(ehci);
 356         }
 357
 358         spin_unlock_irqrestore(&ehci->lock, flags);
 359 }
 360
 361 static void ehci_watchdog(unsigned long param)
 362 {
 363         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 364         unsigned long           flags;
 365
 366         spin_lock_irqsave(&ehci->lock, flags);
 367
 368         /* stop async processing after it's idled a bit */
 369         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 370                 start_unlink_async (ehci, ehci->async);
 371
 372         /* ehci could run by timer, without IRQs ... */
 373         ehci_work (ehci);
 374
 375         spin_unlock_irqrestore (&ehci->lock, flags);
 376 }
 377
 378 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
 379  * The firmware seems to think that powering off is a wakeup event!
 380  * This routine turns off remote wakeup and everything else, on all ports.
 381  */
 382 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
 383 {
 384         int     port = HCS_N_PORTS(ehci->hcs_params);
 385
 386         while (port--)
 387                 ehci_writel(ehci, PORT_RWC_BITS,
 388                                 &ehci->regs->port_status[port]);
 389 }
 390
 391 /*
 392  * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
 393  * Should be called with ehci->lock held.
 394  */
 395 static void ehci_silence_controller(struct ehci_hcd *ehci)
 396 {
 397         ehci_halt(ehci);
 398         ehci_turn_off_all_ports(ehci);
 399
 400         /* make BIOS/etc use companion controller during reboot */
 401         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 402
 403         /* unblock posted writes */
 404         ehci_readl(ehci, &ehci->regs->configured_flag);
 405 }
 406
 407 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 408  * This forcibly disables dma and IRQs, helping kexec and other cases
 409  * where the next system software may expect clean state.
 410  */
 411 static void ehci_shutdown(struct usb_hcd *hcd)
 412 {
 413         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 414
 415         del_timer_sync(&ehci->watchdog);
 416         del_timer_sync(&ehci->iaa_watchdog);
 417
 418         spin_lock_irq(&ehci->lock);
 419         ehci_silence_controller(ehci);
 420         spin_unlock_irq(&ehci->lock);
 421 }
 422
 423 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
 424 {
 425         unsigned port;
 426
 427         if (!HCS_PPC (ehci->hcs_params))
 428                 return;
 429
 430         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
 431         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
 432                 (void) ehci_hub_control(ehci_to_hcd(ehci),
 433                                 is_on ? SetPortFeature : ClearPortFeature,
 434                                 USB_PORT_FEAT_POWER,
 435                                 port--, NULL, 0);
 436         /* Flush those writes */
 437         ehci_readl(ehci, &ehci->regs->command);
 438         msleep(20);
 439 }
 440
 441 /*-------------------------------------------------------------------------*/
 442
 443 /*
 444  * ehci_work is called from some interrupts, timers, and so on.
 445  * it calls driver completion functions, after dropping ehci->lock.
 446  */
 447 static void ehci_work (struct ehci_hcd *ehci)
 448 {
 449         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 450
 451         /* another CPU may drop ehci->lock during a schedule scan while
 452          * it reports urb completions.  this flag guards against bogus
 453          * attempts at re-entrant schedule scanning.
 454          */
 455         if (ehci->scanning)
 456                 return;
 457         ehci->scanning = 1;
 458         scan_async (ehci);
 459         if (ehci->next_uframe != -1)
 460                 scan_periodic (ehci);
 461         ehci->scanning = 0;
 462
 463         /* the IO watchdog guards against hardware or driver bugs that
 464          * misplace IRQs, and should let us run completely without IRQs.
 465          * such lossage has been observed on both VT6202 and VT8235.
 466          */
 467         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
 468                         (ehci->async->qh_next.ptr != NULL ||
 469                          ehci->periodic_sched != 0))
 470                 timer_action (ehci, TIMER_IO_WATCHDOG);
 471 }
 472
 473 /*
 474  * Called when the ehci_hcd module is removed.
 475  */
 476 static void ehci_stop (struct usb_hcd *hcd)
 477 {
 478         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 479
 480         ehci_dbg (ehci, "stop\n");
 481
 482         /* no more interrupts ... */
 483         del_timer_sync (&ehci->watchdog);
 484         del_timer_sync(&ehci->iaa_watchdog);
 485
 486         spin_lock_irq(&ehci->lock);
 487         if (HC_IS_RUNNING (hcd->state))
 488                 ehci_quiesce (ehci);
 489
 490         ehci_silence_controller(ehci);
 491         ehci_reset (ehci);
 492         spin_unlock_irq(&ehci->lock);
 493
 494         remove_companion_file(ehci);
 495         remove_debug_files (ehci);
 496
 497         /* root hub is shut down separately (first, when possible) */
 498         spin_lock_irq (&ehci->lock);
 499         if (ehci->async)
 500                 ehci_work (ehci);
 501         spin_unlock_irq (&ehci->lock);
 502         ehci_mem_cleanup (ehci);
 503
 504 #ifdef  EHCI_STATS
 505         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 506                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 507                 ehci->stats.lost_iaa);
 508         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 509                 ehci->stats.complete, ehci->stats.unlink);
 510 #endif
 511
 512         dbg_status (ehci, "ehci_stop completed",
 513                     ehci_readl(ehci, &ehci->regs->status));
 514 }
 515
 516 /* one-time init, only for memory state */
 517 static int ehci_init(struct usb_hcd *hcd)
 518 {
 519         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 520         u32                     temp;
 521         int                     retval;
 522         u32                     hcc_params;
 523         struct ehci_qh_hw       *hw;
 524
 525         spin_lock_init(&ehci->lock);
 526
 527         /*
 528          * keep io watchdog by default, those good HCDs could turn off it later
 529          */
 530         ehci->need_io_watchdog = 1;
 531         init_timer(&ehci->watchdog);
 532         ehci->watchdog.function = ehci_watchdog;
 533         ehci->watchdog.data = (unsigned long) ehci;
 534
 535         init_timer(&ehci->iaa_watchdog);
 536         ehci->iaa_watchdog.function = ehci_iaa_watchdog;
 537         ehci->iaa_watchdog.data = (unsigned long) ehci;
 538
 539         /*
 540          * hw default: 1K periodic list heads, one per frame.
 541          * periodic_size can shrink by USBCMD update if hcc_params allows.
 542          */
 543         ehci->periodic_size = DEFAULT_I_TDPS;
 544         INIT_LIST_HEAD(&ehci->cached_itd_list);
 545         INIT_LIST_HEAD(&ehci->cached_sitd_list);
 546         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
 547                 return retval;
 548
 549         /* controllers may cache some of the periodic schedule ... */
 550         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 551         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
 552                 ehci->i_thresh = 2 + 8;
 553         else                                    // N microframes cached
 554                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
 555
 556         ehci->reclaim = NULL;
 557         ehci->next_uframe = -1;
 558         ehci->clock_frame = -1;
 559
 560         /*
 561          * dedicate a qh for the async ring head, since we couldn't unlink
 562          * a 'real' qh without stopping the async schedule [4.8].  use it
 563          * as the 'reclamation list head' too.
 564          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 565          * from automatically advancing to the next td after short reads.
 566          */
 567         ehci->async->qh_next.qh = NULL;
 568         hw = ehci->async->hw;
 569         hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
 570         hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
 571         hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
 572         hw->hw_qtd_next = EHCI_LIST_END(ehci);
 573         ehci->async->qh_state = QH_STATE_LINKED;
 574         hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
 575
 576         /* clear interrupt enables, set irq latency */
 577         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 578                 log2_irq_thresh = 0;
 579         temp = 1 << (16 + log2_irq_thresh);
 580         if (HCC_CANPARK(hcc_params)) {
 581                 /* HW default park == 3, on hardware that supports it (like
 582                  * NVidia and ALI silicon), maximizes throughput on the async
 583                  * schedule by avoiding QH fetches between transfers.
 584                  *
 585                  * With fast usb storage devices and NForce2, "park" seems to
 586                  * make problems:  throughput reduction (!), data errors...
 587                  */
 588                 if (park) {
 589                         park = min(park, (unsigned) 3);
 590                         temp |= CMD_PARK;
 591                         temp |= park << 8;
 592                 }
 593                 ehci_dbg(ehci, "park %d\n", park);
 594         }
 595         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 596                 /* periodic schedule size can be smaller than default */
 597                 temp &= ~(3 << 2);
 598                 temp |= (EHCI_TUNE_FLS << 2);
 599                 switch (EHCI_TUNE_FLS) {
 600                 case 0: ehci->periodic_size = 1024; break;
 601                 case 1: ehci->periodic_size = 512; break;
 602                 case 2: ehci->periodic_size = 256; break;
 603                 default:        BUG();
 604                 }
 605         }
 606         ehci->command = temp;
 607
 608         /* Accept arbitrarily long scatter-gather lists */
 609         hcd->self.sg_tablesize = ~0;
 610         return 0;
 611 }
 612
 613 /* start HC running; it's halted, ehci_init() has been run (once) */
 614 static int ehci_run (struct usb_hcd *hcd)
 615 {
 616         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 617         int                     retval;
 618         u32                     temp;
 619         u32                     hcc_params;
 620
 621         hcd->uses_new_polling = 1;
 622         hcd->poll_rh = 0;
 623
 624         /* EHCI spec section 4.1 */
 625         if ((retval = ehci_reset(ehci)) != 0) {
 626                 ehci_mem_cleanup(ehci);
 627                 return retval;
 628         }
 629         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 630         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
 631
 632         /*
 633          * hcc_params controls whether ehci->regs->segment must (!!!)
 634          * be used; it constrains QH/ITD/SITD and QTD locations.
 635          * pci_pool consistent memory always uses segment zero.
 636          * streaming mappings for I/O buffers, like pci_map_single(),
 637          * can return segments above 4GB, if the device allows.
 638          *
 639          * NOTE:  the dma mask is visible through dma_supported(), so
 640          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 641          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 642          * host side drivers though.
 643          */
 644         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 645         if (HCC_64BIT_ADDR(hcc_params)) {
 646                 ehci_writel(ehci, 0, &ehci->regs->segment);
 647 #if 0
 648 // this is deeply broken on almost all architectures
 649                 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
 650                         ehci_info(ehci, "enabled 64bit DMA\n");
 651 #endif
 652         }
 653
 654
 655         // Philips, Intel, and maybe others need CMD_RUN before the
 656         // root hub will detect new devices (why?); NEC doesn't
 657         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
 658         ehci->command |= CMD_RUN;
 659         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 660         dbg_cmd (ehci, "init", ehci->command);
 661
 662         /*
 663          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 664          * are explicitly handed to companion controller(s), so no TT is
 665          * involved with the root hub.  (Except where one is integrated,
 666          * and there's no companion controller unless maybe for USB OTG.)
 667          *
 668          * Turning on the CF flag will transfer ownership of all ports
 669          * from the companions to the EHCI controller.  If any of the
 670          * companions are in the middle of a port reset at the time, it
 671          * could cause trouble.  Write-locking ehci_cf_port_reset_rwsem
 672          * guarantees that no resets are in progress.  After we set CF,
 673          * a short delay lets the hardware catch up; new resets shouldn't
 674          * be started before the port switching actions could complete.
 675          */
 676         down_write(&ehci_cf_port_reset_rwsem);
 677         hcd->state = HC_STATE_RUNNING;
 678         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
 679         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 680         msleep(5);
 681         up_write(&ehci_cf_port_reset_rwsem);
 682         ehci->last_periodic_enable = ktime_get_real();
 683
 684         temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase));
 685         ehci_info (ehci,
 686                 "USB %x.%x started, EHCI %x.%02x%s\n",
 687                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
 688                 temp >> 8, temp & 0xff,
 689                 ignore_oc ? ", overcurrent ignored" : "");
 690
 691         ehci_writel(ehci, INTR_MASK,
 692                     &ehci->regs->intr_enable); /* Turn On Interrupts */
 693
 694         /* GRR this is run-once init(), being done every time the HC starts.
 695          * So long as they're part of class devices, we can't do it init()
 696          * since the class device isn't created that early.
 697          */
 698         create_debug_files(ehci);
 699         create_companion_file(ehci);
 700
 701         return 0;
 702 }
 703
 704 /*-------------------------------------------------------------------------*/
 705
 706 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
 707 {
 708         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 709         u32                     status, masked_status, pcd_status = 0, cmd;
 710         int                     bh;
 711
 712         spin_lock (&ehci->lock);
 713
 714         status = ehci_readl(ehci, &ehci->regs->status);
 715
 716         /* e.g. cardbus physical eject */
 717         if (status == ~(u32) 0) {
 718                 ehci_dbg (ehci, "device removed\n");
 719                 goto dead;
 720         }
 721
 722         masked_status = status & INTR_MASK;
 723         if (!masked_status) {           /* irq sharing? */
 724                 spin_unlock(&ehci->lock);
 725                 return IRQ_NONE;
 726         }
 727
 728         /* clear (just) interrupts */
 729         ehci_writel(ehci, masked_status, &ehci->regs->status);
 730         cmd = ehci_readl(ehci, &ehci->regs->command);
 731         bh = 0;
 732
 733 #ifdef  VERBOSE_DEBUG
 734         /* unrequested/ignored: Frame List Rollover */
 735         dbg_status (ehci, "irq", status);
 736 #endif
 737
 738         /* INT, ERR, and IAA interrupt rates can be throttled */
 739
 740         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 741         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 742                 if (likely ((status & STS_ERR) == 0))
 743                         COUNT (ehci->stats.normal);
 744                 else
 745                         COUNT (ehci->stats.error);
 746                 bh = 1;
 747         }
 748
 749         /* complete the unlinking of some qh [4.15.2.3] */
 750         if (status & STS_IAA) {
 751                 /* guard against (alleged) silicon errata */
 752                 if (cmd & CMD_IAAD) {
 753                         ehci_writel(ehci, cmd & ~CMD_IAAD,
 754                                         &ehci->regs->command);
 755                         ehci_dbg(ehci, "IAA with IAAD still set?\n");
 756                 }
 757                 if (ehci->reclaim) {
 758                         COUNT(ehci->stats.reclaim);
 759                         end_unlink_async(ehci);
 760                 } else
 761                         ehci_dbg(ehci, "IAA with nothing to reclaim?\n");
 762         }
 763
 764         /* remote wakeup [4.3.1] */
 765         if (status & STS_PCD) {
 766                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 767
 768                 /* kick root hub later */
 769                 pcd_status = status;
 770
 771                 /* resume root hub? */
 772                 if (!(cmd & CMD_RUN))
 773                         usb_hcd_resume_root_hub(hcd);
 774
 775                 while (i--) {
 776                         int pstatus = ehci_readl(ehci,
 777                                                  &ehci->regs->port_status [i]);
 778
 779                         if (pstatus & PORT_OWNER)
 780                                 continue;
 781                         if (!(test_bit(i, &ehci->suspended_ports) &&
 782                                         ((pstatus & PORT_RESUME) ||
 783                                                 !(pstatus & PORT_SUSPEND)) &&
 784                                         (pstatus & PORT_PE) &&
 785                                         ehci->reset_done[i] == 0))
 786                                 continue;
 787
 788                         /* start 20 msec resume signaling from this port,
 789                          * and make khubd collect PORT_STAT_C_SUSPEND to
 790                          * stop that signaling.  Use 5 ms extra for safety,
 791                          * like usb_port_resume() does.
 792                          */
 793                         ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
 794                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 795                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
 796                 }
 797         }
 798
 799         /* PCI errors [4.15.2.4] */
 800         if (unlikely ((status & STS_FATAL) != 0)) {
 801                 ehci_err(ehci, "fatal error\n");
 802                 dbg_cmd(ehci, "fatal", cmd);
 803                 dbg_status(ehci, "fatal", status);
 804                 ehci_halt(ehci);
 805 dead:
 806                 ehci_reset(ehci);
 807                 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 808                 /* generic layer kills/unlinks all urbs, then
 809                  * uses ehci_stop to clean up the rest
 810                  */
 811                 bh = 1;
 812         }
 813
 814         if (bh)
 815                 ehci_work (ehci);
 816         spin_unlock (&ehci->lock);
 817         if (pcd_status)
 818                 usb_hcd_poll_rh_status(hcd);
 819         return IRQ_HANDLED;
 820 }
 821
 822 /*-------------------------------------------------------------------------*/
 823
 824 /*
 825  * non-error returns are a promise to giveback() the urb later
 826  * we drop ownership so next owner (or urb unlink) can get it
 827  *
 828  * urb + dev is in hcd.self.controller.urb_list
 829  * we're queueing TDs onto software and hardware lists
 830  *
 831  * hcd-specific init for hcpriv hasn't been done yet
 832  *
 833  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 834  * to a (possibly active) QH, and the same QH scanning code.
 835  */
 836 static int ehci_urb_enqueue (
 837         struct usb_hcd  *hcd,
 838         struct urb      *urb,
 839         gfp_t           mem_flags
 840 ) {
 841         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 842         struct list_head        qtd_list;
 843
 844         INIT_LIST_HEAD (&qtd_list);
 845
 846         switch (usb_pipetype (urb->pipe)) {
 847         case PIPE_CONTROL:
 848                 /* qh_completions() code doesn't handle all the fault cases
 849                  * in multi-TD control transfers.  Even 1KB is rare anyway.
 850                  */
 851                 if (urb->transfer_buffer_length > (16 * 1024))
 852                         return -EMSGSIZE;
 853                 /* FALLTHROUGH */
 854         /* case PIPE_BULK: */
 855         default:
 856                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 857                         return -ENOMEM;
 858                 return submit_async(ehci, urb, &qtd_list, mem_flags);
 859
 860         case PIPE_INTERRUPT:
 861                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 862                         return -ENOMEM;
 863                 return intr_submit(ehci, urb, &qtd_list, mem_flags);
 864
 865         case PIPE_ISOCHRONOUS:
 866                 if (urb->dev->speed == USB_SPEED_HIGH)
 867                         return itd_submit (ehci, urb, mem_flags);
 868                 else
 869                         return sitd_submit (ehci, urb, mem_flags);
 870         }
 871 }
 872
 873 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
 874 {
 875         /* failfast */
 876         if (!HC_IS_RUNNING(ehci_to_hcd(ehci)->state) && ehci->reclaim)
 877                 end_unlink_async(ehci);
 878
 879         /* If the QH isn't linked then there's nothing we can do
 880          * unless we were called during a giveback, in which case
 881          * qh_completions() has to deal with it.
 882          */
 883         if (qh->qh_state != QH_STATE_LINKED) {
 884                 if (qh->qh_state == QH_STATE_COMPLETING)
 885                         qh->needs_rescan = 1;
 886                 return;
 887         }
 888
 889         /* defer till later if busy */
 890         if (ehci->reclaim) {
 891                 struct ehci_qh          *last;
 892
 893                 for (last = ehci->reclaim;
 894                                 last->reclaim;
 895                                 last = last->reclaim)
 896                         continue;
 897                 qh->qh_state = QH_STATE_UNLINK_WAIT;
 898                 last->reclaim = qh;
 899
 900         /* start IAA cycle */
 901         } else
 902                 start_unlink_async (ehci, qh);
 903 }
 904
 905 /* remove from hardware lists
 906  * completions normally happen asynchronously
 907  */
 908
 909 static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
 910 {
 911         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 912         struct ehci_qh          *qh;
 913         unsigned long           flags;
 914         int                     rc;
 915
 916         spin_lock_irqsave (&ehci->lock, flags);
 917         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
 918         if (rc)
 919                 goto done;
 920
 921         switch (usb_pipetype (urb->pipe)) {
 922         // case PIPE_CONTROL:
 923         // case PIPE_BULK:
 924         default:
 925                 qh = (struct ehci_qh *) urb->hcpriv;
 926                 if (!qh)
 927                         break;
 928                 switch (qh->qh_state) {
 929                 case QH_STATE_LINKED:
 930                 case QH_STATE_COMPLETING:
 931                         unlink_async(ehci, qh);
 932                         break;
 933                 case QH_STATE_UNLINK:
 934                 case QH_STATE_UNLINK_WAIT:
 935                         /* already started */
 936                         break;
 937                 case QH_STATE_IDLE:
 938                         /* QH might be waiting for a Clear-TT-Buffer */
 939                         qh_completions(ehci, qh);
 940                         break;
 941                 }
 942                 break;
 943
 944         case PIPE_INTERRUPT:
 945                 qh = (struct ehci_qh *) urb->hcpriv;
 946                 if (!qh)
 947                         break;
 948                 switch (qh->qh_state) {
 949                 case QH_STATE_LINKED:
 950                 case QH_STATE_COMPLETING:
 951                         intr_deschedule (ehci, qh);
 952                         break;
 953                 case QH_STATE_IDLE:
 954                         qh_completions (ehci, qh);
 955                         break;
 956                 default:
 957                         ehci_dbg (ehci, "bogus qh %p state %d\n",
 958                                         qh, qh->qh_state);
 959                         goto done;
 960                 }
 961                 break;
 962
 963         case PIPE_ISOCHRONOUS:
 964                 // itd or sitd ...
 965
 966                 // wait till next completion, do it then.
 967                 // completion irqs can wait up to 1024 msec,
 968                 break;
 969         }
 970 done:
 971         spin_unlock_irqrestore (&ehci->lock, flags);
 972         return rc;
 973 }
 974
 975 /*-------------------------------------------------------------------------*/
 976
 977 // bulk qh holds the data toggle
 978
 979 static void
 980 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
 981 {
 982         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 983         unsigned long           flags;
 984         struct ehci_qh          *qh, *tmp;
 985
 986         /* ASSERT:  any requests/urbs are being unlinked */
 987         /* ASSERT:  nobody can be submitting urbs for this any more */
 988
 989 rescan:
 990         spin_lock_irqsave (&ehci->lock, flags);
 991         qh = ep->hcpriv;
 992         if (!qh)
 993                 goto done;
 994
 995         /* endpoints can be iso streams.  for now, we don't
 996          * accelerate iso completions ... so spin a while.
 997          */
 998         if (qh->hw == NULL) {
 999                 ehci_vdbg (ehci, "iso delay\n");
1000                 goto idle_timeout;
1001         }
1002
1003         if (!HC_IS_RUNNING (hcd->state))
1004                 qh->qh_state = QH_STATE_IDLE;
1005         switch (qh->qh_state) {
1006         case QH_STATE_LINKED:
1007         case QH_STATE_COMPLETING:
1008                 for (tmp = ehci->async->qh_next.qh;
1009                                 tmp && tmp != qh;
1010                                 tmp = tmp->qh_next.qh)
1011                         continue;
1012                 /* periodic qh self-unlinks on empty */
1013                 if (!tmp)
1014                         goto nogood;
1015                 unlink_async (ehci, qh);
1016                 /* FALL THROUGH */
1017         case QH_STATE_UNLINK:           /* wait for hw to finish? */
1018         case QH_STATE_UNLINK_WAIT:
1019 idle_timeout:
1020                 spin_unlock_irqrestore (&ehci->lock, flags);
1021                 schedule_timeout_uninterruptible(1);
1022                 goto rescan;
1023         case QH_STATE_IDLE:             /* fully unlinked */
1024                 if (qh->clearing_tt)
1025                         goto idle_timeout;
1026                 if (list_empty (&qh->qtd_list)) {
1027                         qh_put (qh);
1028                         break;
1029                 }
1030                 /* else FALL THROUGH */
1031         default:
1032 nogood:
1033                 /* caller was supposed to have unlinked any requests;
1034                  * that's not our job.  just leak this memory.
1035                  */
1036                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1037                         qh, ep->desc.bEndpointAddress, qh->qh_state,
1038                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
1039                 break;
1040         }
1041         ep->hcpriv = NULL;
1042 done:
1043         spin_unlock_irqrestore (&ehci->lock, flags);
1044         return;
1045 }
1046
1047 static void
1048 ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1049 {
1050         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1051         struct ehci_qh          *qh;
1052         int                     eptype = usb_endpoint_type(&ep->desc);
1053         int                     epnum = usb_endpoint_num(&ep->desc);
1054         int                     is_out = usb_endpoint_dir_out(&ep->desc);
1055         unsigned long           flags;
1056
1057         if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1058                 return;
1059
1060         spin_lock_irqsave(&ehci->lock, flags);
1061         qh = ep->hcpriv;
1062
1063         /* For Bulk and Interrupt endpoints we maintain the toggle state
1064          * in the hardware; the toggle bits in udev aren't used at all.
1065          * When an endpoint is reset by usb_clear_halt() we must reset
1066          * the toggle bit in the QH.
1067          */
1068         if (qh) {
1069                 usb_settoggle(qh->dev, epnum, is_out, 0);
1070                 if (!list_empty(&qh->qtd_list)) {
1071                         WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1072                 } else if (qh->qh_state == QH_STATE_LINKED ||
1073                                 qh->qh_state == QH_STATE_COMPLETING) {
1074
1075                         /* The toggle value in the QH can't be updated
1076                          * while the QH is active.  Unlink it now;
1077                          * re-linking will call qh_refresh().
1078                          */
1079                         if (eptype == USB_ENDPOINT_XFER_BULK)
1080                                 unlink_async(ehci, qh);
1081                         else
1082                                 intr_deschedule(ehci, qh);
1083                 }
1084         }
1085         spin_unlock_irqrestore(&ehci->lock, flags);
1086 }
1087
1088 static int ehci_get_frame (struct usb_hcd *hcd)
1089 {
1090         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1091         return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
1092                 ehci->periodic_size;
1093 }
1094
1095 /*-------------------------------------------------------------------------*/
1096
1097 MODULE_DESCRIPTION(DRIVER_DESC);
1098 MODULE_AUTHOR (DRIVER_AUTHOR);
1099 MODULE_LICENSE ("GPL");
1100
1101 #ifdef CONFIG_PCI
1102 #include "ehci-pci.c"
1103 #define PCI_DRIVER              ehci_pci_driver
1104 #endif
1105
1106 #ifdef CONFIG_USB_EHCI_FSL
1107 #include "ehci-fsl.c"
1108 #define PLATFORM_DRIVER         ehci_fsl_driver
1109 #endif
1110
1111 #ifdef CONFIG_USB_EHCI_MXC
1112 #include "ehci-mxc.c"
1113 #define PLATFORM_DRIVER         ehci_mxc_driver
1114 #endif
1115
1116 #ifdef CONFIG_SOC_AU1200
1117 #include "ehci-au1xxx.c"
1118 #define PLATFORM_DRIVER         ehci_hcd_au1xxx_driver
1119 #endif
1120
1121 #ifdef CONFIG_ARCH_OMAP3
1122 #include "ehci-omap.c"
1123 #define        PLATFORM_DRIVER         ehci_hcd_omap_driver
1124 #endif
1125
1126 #ifdef CONFIG_PPC_PS3
1127 #include "ehci-ps3.c"
1128 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_driver
1129 #endif
1130
1131 #ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1132 #include "ehci-ppc-of.c"
1133 #define OF_PLATFORM_DRIVER      ehci_hcd_ppc_of_driver
1134 #endif
1135
1136 #ifdef CONFIG_XPS_USB_HCD_XILINX
1137 #include "ehci-xilinx-of.c"
1138 #define XILINX_OF_PLATFORM_DRIVER       ehci_hcd_xilinx_of_driver
1139 #endif
1140
1141 #ifdef CONFIG_PLAT_ORION
1142 #include "ehci-orion.c"
1143 #define PLATFORM_DRIVER         ehci_orion_driver
1144 #endif
1145
1146 #ifdef CONFIG_ARCH_IXP4XX
1147 #include "ehci-ixp4xx.c"
1148 #define PLATFORM_DRIVER         ixp4xx_ehci_driver
1149 #endif
1150
1151 #ifdef CONFIG_USB_W90X900_EHCI
1152 #include "ehci-w90x900.c"
1153 #define PLATFORM_DRIVER         ehci_hcd_w90x900_driver
1154 #endif
1155
1156 #ifdef CONFIG_ARCH_AT91
1157 #include "ehci-atmel.c"
1158 #define PLATFORM_DRIVER         ehci_atmel_driver
1159 #endif
1160
1161 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1162     !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
1163     !defined(XILINX_OF_PLATFORM_DRIVER)
1164 #error "missing bus glue for ehci-hcd"
1165 #endif
1166
1167 static int __init ehci_hcd_init(void)
1168 {
1169         int retval = 0;
1170
1171         if (usb_disabled())
1172                 return -ENODEV;
1173
1174         printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
1175         set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1176         if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1177                         test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1178                 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1179                                 " before uhci_hcd and ohci_hcd, not after\n");
1180
1181         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1182                  hcd_name,
1183                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1184                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1185
1186 #ifdef DEBUG
1187         ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
1188         if (!ehci_debug_root) {
1189                 retval = -ENOENT;
1190                 goto err_debug;
1191         }
1192 #endif
1193
1194 #ifdef PLATFORM_DRIVER
1195         retval = platform_driver_register(&PLATFORM_DRIVER);
1196         if (retval < 0)
1197                 goto clean0;
1198 #endif
1199
1200 #ifdef PCI_DRIVER
1201         retval = pci_register_driver(&PCI_DRIVER);
1202         if (retval < 0)
1203                 goto clean1;
1204 #endif
1205
1206 #ifdef PS3_SYSTEM_BUS_DRIVER
1207         retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1208         if (retval < 0)
1209                 goto clean2;
1210 #endif
1211
1212 #ifdef OF_PLATFORM_DRIVER
1213         retval = of_register_platform_driver(&OF_PLATFORM_DRIVER);
1214         if (retval < 0)
1215                 goto clean3;
1216 #endif
1217
1218 #ifdef XILINX_OF_PLATFORM_DRIVER
1219         retval = of_register_platform_driver(&XILINX_OF_PLATFORM_DRIVER);
1220         if (retval < 0)
1221                 goto clean4;
1222 #endif
1223         return retval;
1224
1225 #ifdef XILINX_OF_PLATFORM_DRIVER
1226         /* of_unregister_platform_driver(&XILINX_OF_PLATFORM_DRIVER); */
1227 clean4:
1228 #endif
1229 #ifdef OF_PLATFORM_DRIVER
1230         of_unregister_platform_driver(&OF_PLATFORM_DRIVER);
1231 clean3:
1232 #endif
1233 #ifdef PS3_SYSTEM_BUS_DRIVER
1234         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1235 clean2:
1236 #endif
1237 #ifdef PCI_DRIVER
1238         pci_unregister_driver(&PCI_DRIVER);
1239 clean1:
1240 #endif
1241 #ifdef PLATFORM_DRIVER
1242         platform_driver_unregister(&PLATFORM_DRIVER);
1243 clean0:
1244 #endif
1245 #ifdef DEBUG
1246         debugfs_remove(ehci_debug_root);
1247         ehci_debug_root = NULL;
1248 err_debug:
1249 #endif
1250         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1251         return retval;
1252 }
1253 module_init(ehci_hcd_init);
1254
1255 static void __exit ehci_hcd_cleanup(void)
1256 {
1257 #ifdef XILINX_OF_PLATFORM_DRIVER
1258         of_unregister_platform_driver(&XILINX_OF_PLATFORM_DRIVER);
1259 #endif
1260 #ifdef OF_PLATFORM_DRIVER
1261         of_unregister_platform_driver(&OF_PLATFORM_DRIVER);
1262 #endif
1263 #ifdef PLATFORM_DRIVER
1264         platform_driver_unregister(&PLATFORM_DRIVER);
1265 #endif
1266 #ifdef PCI_DRIVER
1267         pci_unregister_driver(&PCI_DRIVER);
1268 #endif
1269 #ifdef PS3_SYSTEM_BUS_DRIVER
1270         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1271 #endif
1272 #ifdef DEBUG
1273         debugfs_remove(ehci_debug_root);
1274 #endif
1275         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1276 }
1277 module_exit(ehci_hcd_cleanup);
1278