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/config.h>
  20
  21 #ifdef CONFIG_USB_DEBUG
  22         #define DEBUG
  23 #else
  24         #undef DEBUG
  25 #endif
  26
  27 #include <linux/module.h>
  28 #include <linux/pci.h>
  29 #include <linux/dmapool.h>
  30 #include <linux/kernel.h>
  31 #include <linux/delay.h>
  32 #include <linux/ioport.h>
  33 #include <linux/sched.h>
  34 #include <linux/slab.h>
  35 #include <linux/smp_lock.h>
  36 #include <linux/errno.h>
  37 #include <linux/init.h>
  38 #include <linux/timer.h>
  39 #include <linux/list.h>
  40 #include <linux/interrupt.h>
  41 #include <linux/reboot.h>
  42 #include <linux/usb.h>
  43 #include <linux/moduleparam.h>
  44 #include <linux/dma-mapping.h>
  45
  46 #include "../core/hcd.h"
  47
  48 #include <asm/byteorder.h>
  49 #include <asm/io.h>
  50 #include <asm/irq.h>
  51 #include <asm/system.h>
  52 #include <asm/unaligned.h>
  53
  54
  55 /*-------------------------------------------------------------------------*/
  56
  57 /*
  58  * EHCI hc_driver implementation ... experimental, incomplete.
  59  * Based on the final 1.0 register interface specification.
  60  *
  61  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  62  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  63  * Next comes "CardBay", using USB 2.0 signals.
  64  *
  65  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  66  * Special thanks to Intel and VIA for providing host controllers to
  67  * test this driver on, and Cypress (including In-System Design) for
  68  * providing early devices for those host controllers to talk to!
  69  *
  70  * HISTORY:
  71  *
  72  * 2004-05-10 Root hub and PCI suspend/resume support; remote wakeup. (db)
  73  * 2004-02-24 Replace pci_* with generic dma_* API calls (dsaxena@plexity.net)
  74  * 2003-12-29 Rewritten high speed iso transfer support (by Michal Sojka,
  75  *      <sojkam@centrum.cz>, updates by DB).
  76  *
  77  * 2002-11-29   Correct handling for hw async_next register.
  78  * 2002-08-06   Handling for bulk and interrupt transfers is mostly shared;
  79  *      only scheduling is different, no arbitrary limitations.
  80  * 2002-07-25   Sanity check PCI reads, mostly for better cardbus support,
  81  *      clean up HC run state handshaking.
  82  * 2002-05-24   Preliminary FS/LS interrupts, using scheduling shortcuts
  83  * 2002-05-11   Clear TT errors for FS/LS ctrl/bulk.  Fill in some other
  84  *      missing pieces:  enabling 64bit dma, handoff from BIOS/SMM.
  85  * 2002-05-07   Some error path cleanups to report better errors; wmb();
  86  *      use non-CVS version id; better iso bandwidth claim.
  87  * 2002-04-19   Control/bulk/interrupt submit no longer uses giveback() on
  88  *      errors in submit path.  Bugfixes to interrupt scheduling/processing.
  89  * 2002-03-05   Initial high-speed ISO support; reduce ITD memory; shift
  90  *      more checking to generic hcd framework (db).  Make it work with
  91  *      Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt).
  92  * 2002-01-14   Minor cleanup; version synch.
  93  * 2002-01-08   Fix roothub handoff of FS/LS to companion controllers.
  94  * 2002-01-04   Control/Bulk queuing behaves.
  95  *
  96  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
  97  * 2001-June    Works with usb-storage and NEC EHCI on 2.4
  98  */
  99
 100 #define DRIVER_VERSION "10 Dec 2004"
 101 #define DRIVER_AUTHOR "David Brownell"
 102 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
 103
 104 static const char       hcd_name [] = "ehci_hcd";
 105
 106
 107 #undef EHCI_VERBOSE_DEBUG
 108 #undef EHCI_URB_TRACE
 109
 110 #ifdef DEBUG
 111 #define EHCI_STATS
 112 #endif
 113
 114 /* magic numbers that can affect system performance */
 115 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
 116 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
 117 #define EHCI_TUNE_RL_TT         0
 118 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
 119 #define EHCI_TUNE_MULT_TT       1
 120 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
 121
 122 #define EHCI_IAA_JIFFIES        (HZ/100)        /* arbitrary; ~10 msec */
 123 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
 124 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
 125 #define EHCI_SHRINK_JIFFIES     (HZ/200)        /* async qh unlink delay */
 126
 127 /* Initial IRQ latency:  faster than hw default */
 128 static int log2_irq_thresh = 0;         // 0 to 6
 129 module_param (log2_irq_thresh, int, S_IRUGO);
 130 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
 131
 132 /* initial park setting:  slower than hw default */
 133 static unsigned park = 0;
 134 module_param (park, uint, S_IRUGO);
 135 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
 136
 137 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 138
 139 /*-------------------------------------------------------------------------*/
 140
 141 #include "ehci.h"
 142 #include "ehci-dbg.c"
 143
 144 /*-------------------------------------------------------------------------*/
 145
 146 /*
 147  * handshake - spin reading hc until handshake completes or fails
 148  * @ptr: address of hc register to be read
 149  * @mask: bits to look at in result of read
 150  * @done: value of those bits when handshake succeeds
 151  * @usec: timeout in microseconds
 152  *
 153  * Returns negative errno, or zero on success
 154  *
 155  * Success happens when the "mask" bits have the specified value (hardware
 156  * handshake done).  There are two failure modes:  "usec" have passed (major
 157  * hardware flakeout), or the register reads as all-ones (hardware removed).
 158  *
 159  * That last failure should_only happen in cases like physical cardbus eject
 160  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 161  * bridge shutdown:  shutting down the bridge before the devices using it.
 162  */
 163 static int handshake (void __iomem *ptr, u32 mask, u32 done, int usec)
 164 {
 165         u32     result;
 166
 167         do {
 168                 result = readl (ptr);
 169                 if (result == ~(u32)0)          /* card removed */
 170                         return -ENODEV;
 171                 result &= mask;
 172                 if (result == done)
 173                         return 0;
 174                 udelay (1);
 175                 usec--;
 176         } while (usec > 0);
 177         return -ETIMEDOUT;
 178 }
 179
 180 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 181 static int ehci_halt (struct ehci_hcd *ehci)
 182 {
 183         u32     temp = readl (&ehci->regs->status);
 184
 185         if ((temp & STS_HALT) != 0)
 186                 return 0;
 187
 188         temp = readl (&ehci->regs->command);
 189         temp &= ~CMD_RUN;
 190         writel (temp, &ehci->regs->command);
 191         return handshake (&ehci->regs->status, STS_HALT, STS_HALT, 16 * 125);
 192 }
 193
 194 /* put TDI/ARC silicon into EHCI mode */
 195 static void tdi_reset (struct ehci_hcd *ehci)
 196 {
 197         u32 __iomem     *reg_ptr;
 198         u32             tmp;
 199
 200         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + 0x68);
 201         tmp = readl (reg_ptr);
 202         tmp |= 0x3;
 203         writel (tmp, reg_ptr);
 204 }
 205
 206 /* reset a non-running (STS_HALT == 1) controller */
 207 static int ehci_reset (struct ehci_hcd *ehci)
 208 {
 209         int     retval;
 210         u32     command = readl (&ehci->regs->command);
 211
 212         command |= CMD_RESET;
 213         dbg_cmd (ehci, "reset", command);
 214         writel (command, &ehci->regs->command);
 215         ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 216         ehci->next_statechange = jiffies;
 217         retval = handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
 218
 219         if (retval)
 220                 return retval;
 221
 222         if (ehci_is_TDI(ehci))
 223                 tdi_reset (ehci);
 224
 225         return retval;
 226 }
 227
 228 /* idle the controller (from running) */
 229 static void ehci_quiesce (struct ehci_hcd *ehci)
 230 {
 231         u32     temp;
 232
 233 #ifdef DEBUG
 234         if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
 235                 BUG ();
 236 #endif
 237
 238         /* wait for any schedule enables/disables to take effect */
 239         temp = readl (&ehci->regs->command) << 10;
 240         temp &= STS_ASS | STS_PSS;
 241         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 242                                 temp, 16 * 125) != 0) {
 243                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 244                 return;
 245         }
 246
 247         /* then disable anything that's still active */
 248         temp = readl (&ehci->regs->command);
 249         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
 250         writel (temp, &ehci->regs->command);
 251
 252         /* hardware can take 16 microframes to turn off ... */
 253         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 254                                 0, 16 * 125) != 0) {
 255                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 256                 return;
 257         }
 258 }
 259
 260 /*-------------------------------------------------------------------------*/
 261
 262 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
 263
 264 #include "ehci-hub.c"
 265 #include "ehci-mem.c"
 266 #include "ehci-q.c"
 267 #include "ehci-sched.c"
 268
 269 /*-------------------------------------------------------------------------*/
 270
 271 static void ehci_watchdog (unsigned long param)
 272 {
 273         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 274         unsigned long           flags;
 275
 276         spin_lock_irqsave (&ehci->lock, flags);
 277
 278         /* lost IAA irqs wedge things badly; seen with a vt8235 */
 279         if (ehci->reclaim) {
 280                 u32             status = readl (&ehci->regs->status);
 281
 282                 if (status & STS_IAA) {
 283                         ehci_vdbg (ehci, "lost IAA\n");
 284                         COUNT (ehci->stats.lost_iaa);
 285                         writel (STS_IAA, &ehci->regs->status);
 286                         ehci->reclaim_ready = 1;
 287                 }
 288         }
 289
 290         /* stop async processing after it's idled a bit */
 291         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 292                 start_unlink_async (ehci, ehci->async);
 293
 294         /* ehci could run by timer, without IRQs ... */
 295         ehci_work (ehci, NULL);
 296
 297         spin_unlock_irqrestore (&ehci->lock, flags);
 298 }
 299
 300 #ifdef  CONFIG_PCI
 301
 302 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
 303  * off the controller (maybe it can boot from highspeed USB disks).
 304  */
 305 static int bios_handoff (struct ehci_hcd *ehci, int where, u32 cap)
 306 {
 307         if (cap & (1 << 16)) {
 308                 int msec = 5000;
 309                 struct pci_dev *pdev =
 310                                 to_pci_dev(ehci_to_hcd(ehci)->self.controller);
 311
 312                 /* request handoff to OS */
 313                 cap |= 1 << 24;
 314                 pci_write_config_dword(pdev, where, cap);
 315
 316                 /* and wait a while for it to happen */
 317                 do {
 318                         msleep(10);
 319                         msec -= 10;
 320                         pci_read_config_dword(pdev, where, &cap);
 321                 } while ((cap & (1 << 16)) && msec);
 322                 if (cap & (1 << 16)) {
 323                         ehci_err (ehci, "BIOS handoff failed (%d, %04x)\n",
 324                                 where, cap);
 325                         // some BIOS versions seem buggy...
 326                         // return 1;
 327                         ehci_warn (ehci, "continuing after BIOS bug...\n");
 328                         return 0;
 329                 }
 330                 ehci_dbg (ehci, "BIOS handoff succeeded\n");
 331         }
 332         return 0;
 333 }
 334
 335 #endif
 336
 337 static int
 338 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
 339 {
 340         struct ehci_hcd         *ehci;
 341
 342         ehci = container_of (self, struct ehci_hcd, reboot_notifier);
 343
 344         /* make BIOS/etc use companion controller during reboot */
 345         writel (0, &ehci->regs->configured_flag);
 346         return 0;
 347 }
 348
 349 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
 350 {
 351         unsigned port;
 352
 353         if (!HCS_PPC (ehci->hcs_params))
 354                 return;
 355
 356         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
 357         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
 358                 (void) ehci_hub_control(ehci_to_hcd(ehci),
 359                                 is_on ? SetPortFeature : ClearPortFeature,
 360                                 USB_PORT_FEAT_POWER,
 361                                 port--, NULL, 0);
 362         msleep(20);
 363 }
 364
 365
 366 /* called by khubd or root hub init threads */
 367
 368 static int ehci_hc_reset (struct usb_hcd *hcd)
 369 {
 370         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 371         u32                     temp;
 372         unsigned                count = 256/4;
 373
 374         spin_lock_init (&ehci->lock);
 375
 376         ehci->caps = hcd->regs;
 377         ehci->regs = hcd->regs + HC_LENGTH (readl (&ehci->caps->hc_capbase));
 378         dbg_hcs_params (ehci, "reset");
 379         dbg_hcc_params (ehci, "reset");
 380
 381         /* cache this readonly data; minimize chip reads */
 382         ehci->hcs_params = readl (&ehci->caps->hcs_params);
 383
 384 #ifdef  CONFIG_PCI
 385         writel(0, &ehci->regs->intr_enable);
 386         if (hcd->self.controller->bus == &pci_bus_type) {
 387                 struct pci_dev  *pdev = to_pci_dev(hcd->self.controller);
 388
 389                 switch (pdev->vendor) {
 390                 case PCI_VENDOR_ID_TDI:
 391                         if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
 392                                 ehci->is_tdi_rh_tt = 1;
 393                                 tdi_reset (ehci);
 394                         }
 395                         break;
 396                 case PCI_VENDOR_ID_AMD:
 397                         /* AMD8111 EHCI doesn't work, according to AMD errata */
 398                         if (pdev->device == 0x7463) {
 399                                 ehci_info (ehci, "ignoring AMD8111 (errata)\n");
 400                                 return -EIO;
 401                         }
 402                         break;
 403                 }
 404
 405                 /* optional debug port, normally in the first BAR */
 406                 temp = pci_find_capability (pdev, 0x0a);
 407                 if (temp) {
 408                         pci_read_config_dword(pdev, temp, &temp);
 409                         temp >>= 16;
 410                         if ((temp & (3 << 13)) == (1 << 13)) {
 411                                 temp &= 0x1fff;
 412                                 ehci->debug = hcd->regs + temp;
 413                                 temp = readl (&ehci->debug->control);
 414                                 ehci_info (ehci, "debug port %d%s\n",
 415                                         HCS_DEBUG_PORT(ehci->hcs_params),
 416                                         (temp & DBGP_ENABLED)
 417                                                 ? " IN USE"
 418                                                 : "");
 419                                 if (!(temp & DBGP_ENABLED))
 420                                         ehci->debug = NULL;
 421                         }
 422                 }
 423
 424                 temp = HCC_EXT_CAPS (readl (&ehci->caps->hcc_params));
 425         } else
 426                 temp = 0;
 427
 428         /* EHCI 0.96 and later may have "extended capabilities" */
 429         while (temp && count--) {
 430                 u32             cap;
 431
 432                 pci_read_config_dword (to_pci_dev(hcd->self.controller),
 433                                 temp, &cap);
 434                 ehci_dbg (ehci, "capability %04x at %02x\n", cap, temp);
 435                 switch (cap & 0xff) {
 436                 case 1:                 /* BIOS/SMM/... handoff */
 437                         if (bios_handoff (ehci, temp, cap) != 0)
 438                                 return -EOPNOTSUPP;
 439                         break;
 440                 case 0:                 /* illegal reserved capability */
 441                         ehci_warn (ehci, "illegal capability!\n");
 442                         cap = 0;
 443                         /* FALLTHROUGH */
 444                 default:                /* unknown */
 445                         break;
 446                 }
 447                 temp = (cap >> 8) & 0xff;
 448         }
 449         if (!count) {
 450                 ehci_err (ehci, "bogus capabilities ... PCI problems!\n");
 451                 return -EIO;
 452         }
 453         if (ehci_is_TDI(ehci))
 454                 ehci_reset (ehci);
 455 #endif
 456
 457         ehci_port_power (ehci, 0);
 458
 459         /* at least the Genesys GL880S needs fixup here */
 460         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
 461         temp &= 0x0f;
 462         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
 463                 ehci_dbg (ehci, "bogus port configuration: "
 464                         "cc=%d x pcc=%d < ports=%d\n",
 465                         HCS_N_CC(ehci->hcs_params),
 466                         HCS_N_PCC(ehci->hcs_params),
 467                         HCS_N_PORTS(ehci->hcs_params));
 468
 469 #ifdef  CONFIG_PCI
 470                 if (hcd->self.controller->bus == &pci_bus_type) {
 471                         struct pci_dev  *pdev;
 472
 473                         pdev = to_pci_dev(hcd->self.controller);
 474                         switch (pdev->vendor) {
 475                         case 0x17a0:            /* GENESYS */
 476                                 /* GL880S: should be PORTS=2 */
 477                                 temp |= (ehci->hcs_params & ~0xf);
 478                                 ehci->hcs_params = temp;
 479                                 break;
 480                         case PCI_VENDOR_ID_NVIDIA:
 481                                 /* NF4: should be PCC=10 */
 482                                 break;
 483                         }
 484                 }
 485 #endif
 486         }
 487
 488         /* force HC to halt state */
 489         return ehci_halt (ehci);
 490 }
 491
 492 static int ehci_start (struct usb_hcd *hcd)
 493 {
 494         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 495         u32                     temp;
 496         struct usb_device       *udev;
 497         struct usb_bus          *bus;
 498         int                     retval;
 499         u32                     hcc_params;
 500         u8                      sbrn = 0;
 501         int                     first;
 502
 503         /* skip some things on restart paths */
 504         first = (ehci->watchdog.data == 0);
 505         if (first) {
 506                 init_timer (&ehci->watchdog);
 507                 ehci->watchdog.function = ehci_watchdog;
 508                 ehci->watchdog.data = (unsigned long) ehci;
 509         }
 510
 511         /*
 512          * hw default: 1K periodic list heads, one per frame.
 513          * periodic_size can shrink by USBCMD update if hcc_params allows.
 514          */
 515         ehci->periodic_size = DEFAULT_I_TDPS;
 516         if (first && (retval = ehci_mem_init (ehci, GFP_KERNEL)) < 0)
 517                 return retval;
 518
 519         /* controllers may cache some of the periodic schedule ... */
 520         hcc_params = readl (&ehci->caps->hcc_params);
 521         if (HCC_ISOC_CACHE (hcc_params))        // full frame cache
 522                 ehci->i_thresh = 8;
 523         else                                    // N microframes cached
 524                 ehci->i_thresh = 2 + HCC_ISOC_THRES (hcc_params);
 525
 526         ehci->reclaim = NULL;
 527         ehci->reclaim_ready = 0;
 528         ehci->next_uframe = -1;
 529
 530         /* controller state:  unknown --> reset */
 531
 532         /* EHCI spec section 4.1 */
 533         if ((retval = ehci_reset (ehci)) != 0) {
 534                 ehci_mem_cleanup (ehci);
 535                 return retval;
 536         }
 537         writel (ehci->periodic_dma, &ehci->regs->frame_list);
 538
 539 #ifdef  CONFIG_PCI
 540         if (hcd->self.controller->bus == &pci_bus_type) {
 541                 struct pci_dev          *pdev;
 542                 u16                     port_wake;
 543
 544                 pdev = to_pci_dev(hcd->self.controller);
 545
 546                 /* Serial Bus Release Number is at PCI 0x60 offset */
 547                 pci_read_config_byte(pdev, 0x60, &sbrn);
 548
 549                 /* port wake capability, reported by boot firmware */
 550                 pci_read_config_word(pdev, 0x62, &port_wake);
 551                 hcd->can_wakeup = (port_wake & 1) != 0;
 552
 553                 /* help hc dma work well with cachelines */
 554                 pci_set_mwi (pdev);
 555         }
 556 #endif
 557
 558         /*
 559          * dedicate a qh for the async ring head, since we couldn't unlink
 560          * a 'real' qh without stopping the async schedule [4.8].  use it
 561          * as the 'reclamation list head' too.
 562          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 563          * from automatically advancing to the next td after short reads.
 564          */
 565         if (first) {
 566                 ehci->async->qh_next.qh = NULL;
 567                 ehci->async->hw_next = QH_NEXT (ehci->async->qh_dma);
 568                 ehci->async->hw_info1 = cpu_to_le32 (QH_HEAD);
 569                 ehci->async->hw_token = cpu_to_le32 (QTD_STS_HALT);
 570                 ehci->async->hw_qtd_next = EHCI_LIST_END;
 571                 ehci->async->qh_state = QH_STATE_LINKED;
 572                 ehci->async->hw_alt_next = QTD_NEXT (ehci->async->dummy->qtd_dma);
 573         }
 574         writel ((u32)ehci->async->qh_dma, &ehci->regs->async_next);
 575
 576         /*
 577          * hcc_params controls whether ehci->regs->segment must (!!!)
 578          * be used; it constrains QH/ITD/SITD and QTD locations.
 579          * pci_pool consistent memory always uses segment zero.
 580          * streaming mappings for I/O buffers, like pci_map_single(),
 581          * can return segments above 4GB, if the device allows.
 582          *
 583          * NOTE:  the dma mask is visible through dma_supported(), so
 584          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 585          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 586          * host side drivers though.
 587          */
 588         if (HCC_64BIT_ADDR (hcc_params)) {
 589                 writel (0, &ehci->regs->segment);
 590 #if 0
 591 // this is deeply broken on almost all architectures
 592                 if (!pci_set_dma_mask (to_pci_dev(hcd->self.controller), 0xffffffffffffffffULL))
 593                         ehci_info (ehci, "enabled 64bit PCI DMA\n");
 594 #endif
 595         }
 596
 597         /* clear interrupt enables, set irq latency */
 598         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 599                 log2_irq_thresh = 0;
 600         temp = 1 << (16 + log2_irq_thresh);
 601         if (HCC_CANPARK(hcc_params)) {
 602                 /* HW default park == 3, on hardware that supports it (like
 603                  * NVidia and ALI silicon), maximizes throughput on the async
 604                  * schedule by avoiding QH fetches between transfers.
 605                  *
 606                  * With fast usb storage devices and NForce2, "park" seems to
 607                  * make problems:  throughput reduction (!), data errors...
 608                  */
 609                 if (park) {
 610                         park = min (park, (unsigned) 3);
 611                         temp |= CMD_PARK;
 612                         temp |= park << 8;
 613                 }
 614                 ehci_info (ehci, "park %d\n", park);
 615         }
 616         if (HCC_PGM_FRAMELISTLEN (hcc_params)) {
 617                 /* periodic schedule size can be smaller than default */
 618                 temp &= ~(3 << 2);
 619                 temp |= (EHCI_TUNE_FLS << 2);
 620                 switch (EHCI_TUNE_FLS) {
 621                 case 0: ehci->periodic_size = 1024; break;
 622                 case 1: ehci->periodic_size = 512; break;
 623                 case 2: ehci->periodic_size = 256; break;
 624                 default:        BUG ();
 625                 }
 626         }
 627         // Philips, Intel, and maybe others need CMD_RUN before the
 628         // root hub will detect new devices (why?); NEC doesn't
 629         temp |= CMD_RUN;
 630         writel (temp, &ehci->regs->command);
 631         dbg_cmd (ehci, "init", temp);
 632
 633         /* set async sleep time = 10 us ... ? */
 634
 635         /* wire up the root hub */
 636         bus = hcd_to_bus (hcd);
 637         udev = first ? usb_alloc_dev (NULL, bus, 0) : bus->root_hub;
 638         if (!udev) {
 639 done2:
 640                 ehci_mem_cleanup (ehci);
 641                 return -ENOMEM;
 642         }
 643         udev->speed = USB_SPEED_HIGH;
 644         udev->state = first ? USB_STATE_ATTACHED : USB_STATE_CONFIGURED;
 645
 646         /*
 647          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 648          * are explicitly handed to companion controller(s), so no TT is
 649          * involved with the root hub.  (Except where one is integrated,
 650          * and there's no companion controller unless maybe for USB OTG.)
 651          */
 652         if (first) {
 653                 ehci->reboot_notifier.notifier_call = ehci_reboot;
 654                 register_reboot_notifier (&ehci->reboot_notifier);
 655         }
 656
 657         hcd->state = HC_STATE_RUNNING;
 658         writel (FLAG_CF, &ehci->regs->configured_flag);
 659         readl (&ehci->regs->command);   /* unblock posted write */
 660
 661         temp = HC_VERSION(readl (&ehci->caps->hc_capbase));
 662         ehci_info (ehci,
 663                 "USB %x.%x %s, EHCI %x.%02x, driver %s\n",
 664                 ((sbrn & 0xf0)>>4), (sbrn & 0x0f),
 665                 first ? "initialized" : "restarted",
 666                 temp >> 8, temp & 0xff, DRIVER_VERSION);
 667
 668         /*
 669          * From here on, khubd concurrently accesses the root
 670          * hub; drivers will be talking to enumerated devices.
 671          * (On restart paths, khubd already knows about the root
 672          * hub and could find work as soon as we wrote FLAG_CF.)
 673          *
 674          * Before this point the HC was idle/ready.  After, khubd
 675          * and device drivers may start it running.
 676          */
 677         if (first && usb_hcd_register_root_hub (udev, hcd) != 0) {
 678                 if (hcd->state == HC_STATE_RUNNING)
 679                         ehci_quiesce (ehci);
 680                 ehci_reset (ehci);
 681                 usb_put_dev (udev);
 682                 retval = -ENODEV;
 683                 goto done2;
 684         }
 685
 686         writel (INTR_MASK, &ehci->regs->intr_enable); /* Turn On Interrupts */
 687
 688         if (first)
 689                 create_debug_files (ehci);
 690
 691         return 0;
 692 }
 693
 694 /* always called by thread; normally rmmod */
 695
 696 static void ehci_stop (struct usb_hcd *hcd)
 697 {
 698         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 699
 700         ehci_dbg (ehci, "stop\n");
 701
 702         /* Turn off port power on all root hub ports. */
 703         ehci_port_power (ehci, 0);
 704
 705         /* no more interrupts ... */
 706         del_timer_sync (&ehci->watchdog);
 707
 708         spin_lock_irq(&ehci->lock);
 709         if (HC_IS_RUNNING (hcd->state))
 710                 ehci_quiesce (ehci);
 711
 712         ehci_reset (ehci);
 713         writel (0, &ehci->regs->intr_enable);
 714         spin_unlock_irq(&ehci->lock);
 715
 716         /* let companion controllers work when we aren't */
 717         writel (0, &ehci->regs->configured_flag);
 718         unregister_reboot_notifier (&ehci->reboot_notifier);
 719
 720         remove_debug_files (ehci);
 721
 722         /* root hub is shut down separately (first, when possible) */
 723         spin_lock_irq (&ehci->lock);
 724         if (ehci->async)
 725                 ehci_work (ehci, NULL);
 726         spin_unlock_irq (&ehci->lock);
 727         ehci_mem_cleanup (ehci);
 728
 729 #ifdef  EHCI_STATS
 730         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 731                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 732                 ehci->stats.lost_iaa);
 733         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 734                 ehci->stats.complete, ehci->stats.unlink);
 735 #endif
 736
 737         dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
 738 }
 739
 740 static int ehci_get_frame (struct usb_hcd *hcd)
 741 {
 742         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 743         return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
 744 }
 745
 746 /*-------------------------------------------------------------------------*/
 747
 748 #ifdef  CONFIG_PM
 749
 750 /* suspend/resume, section 4.3 */
 751
 752 /* These routines rely on the bus (pci, platform, etc)
 753  * to handle powerdown and wakeup, and currently also on
 754  * transceivers that don't need any software attention to set up
 755  * the right sort of wakeup.
 756  */
 757
 758 static int ehci_suspend (struct usb_hcd *hcd, pm_message_t message)
 759 {
 760         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 761
 762         if (time_before (jiffies, ehci->next_statechange))
 763                 msleep (100);
 764
 765 #ifdef  CONFIG_USB_SUSPEND
 766         (void) usb_suspend_device (hcd->self.root_hub, message);
 767 #else
 768         usb_lock_device (hcd->self.root_hub);
 769         (void) ehci_hub_suspend (hcd);
 770         usb_unlock_device (hcd->self.root_hub);
 771 #endif
 772
 773         // save (PCI) FLADJ in case of Vaux power loss
 774         // ... we'd only use it to handle clock skew
 775
 776         return 0;
 777 }
 778
 779 static int ehci_resume (struct usb_hcd *hcd)
 780 {
 781         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 782         unsigned                port;
 783         struct usb_device       *root = hcd->self.root_hub;
 784         int                     retval = -EINVAL;
 785
 786         // maybe restore (PCI) FLADJ
 787
 788         if (time_before (jiffies, ehci->next_statechange))
 789                 msleep (100);
 790
 791         /* If any port is suspended, we know we can/must resume the HC. */
 792         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; ) {
 793                 u32     status;
 794                 port--;
 795                 status = readl (&ehci->regs->port_status [port]);
 796                 if (status & PORT_SUSPEND) {
 797                         down (&hcd->self.root_hub->serialize);
 798                         retval = ehci_hub_resume (hcd);
 799                         up (&hcd->self.root_hub->serialize);
 800                         break;
 801                 }
 802                 if (!root->children [port])
 803                         continue;
 804                 dbg_port (ehci, __FUNCTION__, port + 1, status);
 805                 usb_set_device_state (root->children[port],
 806                                         USB_STATE_NOTATTACHED);
 807         }
 808
 809         /* Else reset, to cope with power loss or flush-to-storage
 810          * style "resume" having activated BIOS during reboot.
 811          */
 812         if (port == 0) {
 813                 (void) ehci_halt (ehci);
 814                 (void) ehci_reset (ehci);
 815                 (void) ehci_hc_reset (hcd);
 816
 817                 /* emptying the schedule aborts any urbs */
 818                 spin_lock_irq (&ehci->lock);
 819                 if (ehci->reclaim)
 820                         ehci->reclaim_ready = 1;
 821                 ehci_work (ehci, NULL);
 822                 spin_unlock_irq (&ehci->lock);
 823
 824                 /* restart; khubd will disconnect devices */
 825                 retval = ehci_start (hcd);
 826
 827                 /* here we "know" root ports should always stay powered;
 828                  * but some controllers may lose all power.
 829                  */
 830                 ehci_port_power (ehci, 1);
 831         }
 832
 833         return retval;
 834 }
 835
 836 #endif
 837
 838 /*-------------------------------------------------------------------------*/
 839
 840 /*
 841  * ehci_work is called from some interrupts, timers, and so on.
 842  * it calls driver completion functions, after dropping ehci->lock.
 843  */
 844 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
 845 {
 846         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 847         if (ehci->reclaim_ready)
 848                 end_unlink_async (ehci, regs);
 849
 850         /* another CPU may drop ehci->lock during a schedule scan while
 851          * it reports urb completions.  this flag guards against bogus
 852          * attempts at re-entrant schedule scanning.
 853          */
 854         if (ehci->scanning)
 855                 return;
 856         ehci->scanning = 1;
 857         scan_async (ehci, regs);
 858         if (ehci->next_uframe != -1)
 859                 scan_periodic (ehci, regs);
 860         ehci->scanning = 0;
 861
 862         /* the IO watchdog guards against hardware or driver bugs that
 863          * misplace IRQs, and should let us run completely without IRQs.
 864          * such lossage has been observed on both VT6202 and VT8235.
 865          */
 866         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
 867                         (ehci->async->qh_next.ptr != NULL ||
 868                          ehci->periodic_sched != 0))
 869                 timer_action (ehci, TIMER_IO_WATCHDOG);
 870 }
 871
 872 /*-------------------------------------------------------------------------*/
 873
 874 static irqreturn_t ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
 875 {
 876         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 877         u32                     status;
 878         int                     bh;
 879
 880         spin_lock (&ehci->lock);
 881
 882         status = readl (&ehci->regs->status);
 883
 884         /* e.g. cardbus physical eject */
 885         if (status == ~(u32) 0) {
 886                 ehci_dbg (ehci, "device removed\n");
 887                 goto dead;
 888         }
 889
 890         status &= INTR_MASK;
 891         if (!status) {                  /* irq sharing? */
 892                 spin_unlock(&ehci->lock);
 893                 return IRQ_NONE;
 894         }
 895
 896         /* clear (just) interrupts */
 897         writel (status, &ehci->regs->status);
 898         readl (&ehci->regs->command);   /* unblock posted write */
 899         bh = 0;
 900
 901 #ifdef  EHCI_VERBOSE_DEBUG
 902         /* unrequested/ignored: Frame List Rollover */
 903         dbg_status (ehci, "irq", status);
 904 #endif
 905
 906         /* INT, ERR, and IAA interrupt rates can be throttled */
 907
 908         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 909         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 910                 if (likely ((status & STS_ERR) == 0))
 911                         COUNT (ehci->stats.normal);
 912                 else
 913                         COUNT (ehci->stats.error);
 914                 bh = 1;
 915         }
 916
 917         /* complete the unlinking of some qh [4.15.2.3] */
 918         if (status & STS_IAA) {
 919                 COUNT (ehci->stats.reclaim);
 920                 ehci->reclaim_ready = 1;
 921                 bh = 1;
 922         }
 923
 924         /* remote wakeup [4.3.1] */
 925         if ((status & STS_PCD) && hcd->remote_wakeup) {
 926                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 927
 928                 /* resume root hub? */
 929                 status = readl (&ehci->regs->command);
 930                 if (!(status & CMD_RUN))
 931                         writel (status | CMD_RUN, &ehci->regs->command);
 932
 933                 while (i--) {
 934                         status = readl (&ehci->regs->port_status [i]);
 935                         if (status & PORT_OWNER)
 936                                 continue;
 937                         if (!(status & PORT_RESUME)
 938                                         || ehci->reset_done [i] != 0)
 939                                 continue;
 940
 941                         /* start 20 msec resume signaling from this port,
 942                          * and make khubd collect PORT_STAT_C_SUSPEND to
 943                          * stop that signaling.
 944                          */
 945                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
 946                         mod_timer (&hcd->rh_timer,
 947                                         ehci->reset_done [i] + 1);
 948                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 949                 }
 950         }
 951
 952         /* PCI errors [4.15.2.4] */
 953         if (unlikely ((status & STS_FATAL) != 0)) {
 954                 /* bogus "fatal" IRQs appear on some chips... why?  */
 955                 status = readl (&ehci->regs->status);
 956                 dbg_cmd (ehci, "fatal", readl (&ehci->regs->command));
 957                 dbg_status (ehci, "fatal", status);
 958                 if (status & STS_HALT) {
 959                         ehci_err (ehci, "fatal error\n");
 960 dead:
 961                         ehci_reset (ehci);
 962                         writel (0, &ehci->regs->configured_flag);
 963                         /* generic layer kills/unlinks all urbs, then
 964                          * uses ehci_stop to clean up the rest
 965                          */
 966                         bh = 1;
 967                 }
 968         }
 969
 970         if (bh)
 971                 ehci_work (ehci, regs);
 972         spin_unlock (&ehci->lock);
 973         return IRQ_HANDLED;
 974 }
 975
 976 /*-------------------------------------------------------------------------*/
 977
 978 /*
 979  * non-error returns are a promise to giveback() the urb later
 980  * we drop ownership so next owner (or urb unlink) can get it
 981  *
 982  * urb + dev is in hcd.self.controller.urb_list
 983  * we're queueing TDs onto software and hardware lists
 984  *
 985  * hcd-specific init for hcpriv hasn't been done yet
 986  *
 987  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 988  * to a (possibly active) QH, and the same QH scanning code.
 989  */
 990 static int ehci_urb_enqueue (
 991         struct usb_hcd  *hcd,
 992         struct usb_host_endpoint *ep,
 993         struct urb      *urb,
 994         int             mem_flags
 995 ) {
 996         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 997         struct list_head        qtd_list;
 998
 999         INIT_LIST_HEAD (&qtd_list);
1000
1001         switch (usb_pipetype (urb->pipe)) {
1002         // case PIPE_CONTROL:
1003         // case PIPE_BULK:
1004         default:
1005                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1006                         return -ENOMEM;
1007                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
1008
1009         case PIPE_INTERRUPT:
1010                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1011                         return -ENOMEM;
1012                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
1013
1014         case PIPE_ISOCHRONOUS:
1015                 if (urb->dev->speed == USB_SPEED_HIGH)
1016                         return itd_submit (ehci, urb, mem_flags);
1017                 else
1018                         return sitd_submit (ehci, urb, mem_flags);
1019         }
1020 }
1021
1022 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
1023 {
1024         /* if we need to use IAA and it's busy, defer */
1025         if (qh->qh_state == QH_STATE_LINKED
1026                         && ehci->reclaim
1027                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
1028                 struct ehci_qh          *last;
1029
1030                 for (last = ehci->reclaim;
1031                                 last->reclaim;
1032                                 last = last->reclaim)
1033                         continue;
1034                 qh->qh_state = QH_STATE_UNLINK_WAIT;
1035                 last->reclaim = qh;
1036
1037         /* bypass IAA if the hc can't care */
1038         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
1039                 end_unlink_async (ehci, NULL);
1040
1041         /* something else might have unlinked the qh by now */
1042         if (qh->qh_state == QH_STATE_LINKED)
1043                 start_unlink_async (ehci, qh);
1044 }
1045
1046 /* remove from hardware lists
1047  * completions normally happen asynchronously
1048  */
1049
1050 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1051 {
1052         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1053         struct ehci_qh          *qh;
1054         unsigned long           flags;
1055
1056         spin_lock_irqsave (&ehci->lock, flags);
1057         switch (usb_pipetype (urb->pipe)) {
1058         // case PIPE_CONTROL:
1059         // case PIPE_BULK:
1060         default:
1061                 qh = (struct ehci_qh *) urb->hcpriv;
1062                 if (!qh)
1063                         break;
1064                 unlink_async (ehci, qh);
1065                 break;
1066
1067         case PIPE_INTERRUPT:
1068                 qh = (struct ehci_qh *) urb->hcpriv;
1069                 if (!qh)
1070                         break;
1071                 switch (qh->qh_state) {
1072                 case QH_STATE_LINKED:
1073                         intr_deschedule (ehci, qh);
1074                         /* FALL THROUGH */
1075                 case QH_STATE_IDLE:
1076                         qh_completions (ehci, qh, NULL);
1077                         break;
1078                 default:
1079                         ehci_dbg (ehci, "bogus qh %p state %d\n",
1080                                         qh, qh->qh_state);
1081                         goto done;
1082                 }
1083
1084                 /* reschedule QH iff another request is queued */
1085                 if (!list_empty (&qh->qtd_list)
1086                                 && HC_IS_RUNNING (hcd->state)) {
1087                         int status;
1088
1089                         status = qh_schedule (ehci, qh);
1090                         spin_unlock_irqrestore (&ehci->lock, flags);
1091
1092                         if (status != 0) {
1093                                 // shouldn't happen often, but ...
1094                                 // FIXME kill those tds' urbs
1095                                 err ("can't reschedule qh %p, err %d",
1096                                         qh, status);
1097                         }
1098                         return status;
1099                 }
1100                 break;
1101
1102         case PIPE_ISOCHRONOUS:
1103                 // itd or sitd ...
1104
1105                 // wait till next completion, do it then.
1106                 // completion irqs can wait up to 1024 msec,
1107                 break;
1108         }
1109 done:
1110         spin_unlock_irqrestore (&ehci->lock, flags);
1111         return 0;
1112 }
1113
1114 /*-------------------------------------------------------------------------*/
1115
1116 // bulk qh holds the data toggle
1117
1118 static void
1119 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1120 {
1121         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1122         unsigned long           flags;
1123         struct ehci_qh          *qh, *tmp;
1124
1125         /* ASSERT:  any requests/urbs are being unlinked */
1126         /* ASSERT:  nobody can be submitting urbs for this any more */
1127
1128 rescan:
1129         spin_lock_irqsave (&ehci->lock, flags);
1130         qh = ep->hcpriv;
1131         if (!qh)
1132                 goto done;
1133
1134         /* endpoints can be iso streams.  for now, we don't
1135          * accelerate iso completions ... so spin a while.
1136          */
1137         if (qh->hw_info1 == 0) {
1138                 ehci_vdbg (ehci, "iso delay\n");
1139                 goto idle_timeout;
1140         }
1141
1142         if (!HC_IS_RUNNING (hcd->state))
1143                 qh->qh_state = QH_STATE_IDLE;
1144         switch (qh->qh_state) {
1145         case QH_STATE_LINKED:
1146                 for (tmp = ehci->async->qh_next.qh;
1147                                 tmp && tmp != qh;
1148                                 tmp = tmp->qh_next.qh)
1149                         continue;
1150                 /* periodic qh self-unlinks on empty */
1151                 if (!tmp)
1152                         goto nogood;
1153                 unlink_async (ehci, qh);
1154                 /* FALL THROUGH */
1155         case QH_STATE_UNLINK:           /* wait for hw to finish? */
1156 idle_timeout:
1157                 spin_unlock_irqrestore (&ehci->lock, flags);
1158                 set_current_state (TASK_UNINTERRUPTIBLE);
1159                 schedule_timeout (1);
1160                 goto rescan;
1161         case QH_STATE_IDLE:             /* fully unlinked */
1162                 if (list_empty (&qh->qtd_list)) {
1163                         qh_put (qh);
1164                         break;
1165                 }
1166                 /* else FALL THROUGH */
1167         default:
1168 nogood:
1169                 /* caller was supposed to have unlinked any requests;
1170                  * that's not our job.  just leak this memory.
1171                  */
1172                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1173                         qh, ep->desc.bEndpointAddress, qh->qh_state,
1174                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
1175                 break;
1176         }
1177         ep->hcpriv = NULL;
1178 done:
1179         spin_unlock_irqrestore (&ehci->lock, flags);
1180         return;
1181 }
1182
1183 /*-------------------------------------------------------------------------*/
1184
1185 static const struct hc_driver ehci_driver = {
1186         .description =          hcd_name,
1187         .product_desc =         "EHCI Host Controller",
1188         .hcd_priv_size =        sizeof(struct ehci_hcd),
1189
1190         /*
1191          * generic hardware linkage
1192          */
1193         .irq =                  ehci_irq,
1194         .flags =                HCD_MEMORY | HCD_USB2,
1195
1196         /*
1197          * basic lifecycle operations
1198          */
1199         .reset =                ehci_hc_reset,
1200         .start =                ehci_start,
1201 #ifdef  CONFIG_PM
1202         .suspend =              ehci_suspend,
1203         .resume =               ehci_resume,
1204 #endif
1205         .stop =                 ehci_stop,
1206
1207         /*
1208          * managing i/o requests and associated device resources
1209          */
1210         .urb_enqueue =          ehci_urb_enqueue,
1211         .urb_dequeue =          ehci_urb_dequeue,
1212         .endpoint_disable =     ehci_endpoint_disable,
1213
1214         /*
1215          * scheduling support
1216          */
1217         .get_frame_number =     ehci_get_frame,
1218
1219         /*
1220          * root hub support
1221          */
1222         .hub_status_data =      ehci_hub_status_data,
1223         .hub_control =          ehci_hub_control,
1224         .hub_suspend =          ehci_hub_suspend,
1225         .hub_resume =           ehci_hub_resume,
1226 };
1227
1228 /*-------------------------------------------------------------------------*/
1229
1230 /* EHCI 1.0 doesn't require PCI */
1231
1232 #ifdef  CONFIG_PCI
1233
1234 /* PCI driver selection metadata; PCI hotplugging uses this */
1235 static const struct pci_device_id pci_ids [] = { {
1236         /* handle any USB 2.0 EHCI controller */
1237         PCI_DEVICE_CLASS(((PCI_CLASS_SERIAL_USB << 8) | 0x20), ~0),
1238         .driver_data =  (unsigned long) &ehci_driver,
1239         },
1240         { /* end: all zeroes */ }
1241 };
1242 MODULE_DEVICE_TABLE (pci, pci_ids);
1243
1244 /* pci driver glue; this is a "new style" PCI driver module */
1245 static struct pci_driver ehci_pci_driver = {
1246         .name =         (char *) hcd_name,
1247         .id_table =     pci_ids,
1248
1249         .probe =        usb_hcd_pci_probe,
1250         .remove =       usb_hcd_pci_remove,
1251
1252 #ifdef  CONFIG_PM
1253         .suspend =      usb_hcd_pci_suspend,
1254         .resume =       usb_hcd_pci_resume,
1255 #endif
1256 };
1257
1258 #endif  /* PCI */
1259
1260
1261 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
1262
1263 MODULE_DESCRIPTION (DRIVER_INFO);
1264 MODULE_AUTHOR (DRIVER_AUTHOR);
1265 MODULE_LICENSE ("GPL");
1266
1267 static int __init init (void)
1268 {
1269         if (usb_disabled())
1270                 return -ENODEV;
1271
1272         pr_debug ("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1273                 hcd_name,
1274                 sizeof (struct ehci_qh), sizeof (struct ehci_qtd),
1275                 sizeof (struct ehci_itd), sizeof (struct ehci_sitd));
1276
1277         return pci_register_driver (&ehci_pci_driver);
1278 }
1279 module_init (init);
1280
1281 static void __exit cleanup (void)
1282 {
1283         pci_unregister_driver (&ehci_pci_driver);
1284 }
1285 module_exit (cleanup);