drivers/usb/host/ehci-hcd.c

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