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