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 "2004-May-10"
 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:  lower than 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 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 133
 134 /*-------------------------------------------------------------------------*/
 135
 136 #include "ehci.h"
 137 #include "ehci-dbg.c"
 138
 139 /*-------------------------------------------------------------------------*/
 140
 141 /*
 142  * handshake - spin reading hc until handshake completes or fails
 143  * @ptr: address of hc register to be read
 144  * @mask: bits to look at in result of read
 145  * @done: value of those bits when handshake succeeds
 146  * @usec: timeout in microseconds
 147  *
 148  * Returns negative errno, or zero on success
 149  *
 150  * Success happens when the "mask" bits have the specified value (hardware
 151  * handshake done).  There are two failure modes:  "usec" have passed (major
 152  * hardware flakeout), or the register reads as all-ones (hardware removed).
 153  *
 154  * That last failure should_only happen in cases like physical cardbus eject
 155  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 156  * bridge shutdown:  shutting down the bridge before the devices using it.
 157  */
 158 static int handshake (u32 __iomem *ptr, u32 mask, u32 done, int usec)
 159 {
 160         u32     result;
 161
 162         do {
 163                 result = readl (ptr);
 164                 if (result == ~(u32)0)          /* card removed */
 165                         return -ENODEV;
 166                 result &= mask;
 167                 if (result == done)
 168                         return 0;
 169                 udelay (1);
 170                 usec--;
 171         } while (usec > 0);
 172         return -ETIMEDOUT;
 173 }
 174
 175 /*
 176  * hc states include: unknown, halted, ready, running
 177  * transitional states are messy just now
 178  * trying to avoid "running" unless urbs are active
 179  * a "ready" hc can be finishing prefetched work
 180  */
 181
 182 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 183 static int ehci_halt (struct ehci_hcd *ehci)
 184 {
 185         u32     temp = readl (&ehci->regs->status);
 186
 187         if ((temp & STS_HALT) != 0)
 188                 return 0;
 189
 190         temp = readl (&ehci->regs->command);
 191         temp &= ~CMD_RUN;
 192         writel (temp, &ehci->regs->command);
 193         return handshake (&ehci->regs->status, STS_HALT, STS_HALT, 16 * 125);
 194 }
 195
 196 /* reset a non-running (STS_HALT == 1) controller */
 197 static int ehci_reset (struct ehci_hcd *ehci)
 198 {
 199         u32     command = readl (&ehci->regs->command);
 200
 201         command |= CMD_RESET;
 202         dbg_cmd (ehci, "reset", command);
 203         writel (command, &ehci->regs->command);
 204         ehci->hcd.state = USB_STATE_HALT;
 205         ehci->next_statechange = jiffies;
 206         return handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
 207 }
 208
 209 /* idle the controller (from running) */
 210 static void ehci_ready (struct ehci_hcd *ehci)
 211 {
 212         u32     temp;
 213
 214 #ifdef DEBUG
 215         if (!HCD_IS_RUNNING (ehci->hcd.state))
 216                 BUG ();
 217 #endif
 218
 219         /* wait for any schedule enables/disables to take effect */
 220         temp = 0;
 221         if (ehci->async->qh_next.qh)
 222                 temp = STS_ASS;
 223         if (ehci->next_uframe != -1)
 224                 temp |= STS_PSS;
 225         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 226                                 temp, 16 * 125) != 0) {
 227                 ehci->hcd.state = USB_STATE_HALT;
 228                 return;
 229         }
 230
 231         /* then disable anything that's still active */
 232         temp = readl (&ehci->regs->command);
 233         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
 234         writel (temp, &ehci->regs->command);
 235
 236         /* hardware can take 16 microframes to turn off ... */
 237         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 238                                 0, 16 * 125) != 0) {
 239                 ehci->hcd.state = USB_STATE_HALT;
 240                 return;
 241         }
 242 }
 243
 244 /*-------------------------------------------------------------------------*/
 245
 246 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
 247
 248 #include "ehci-hub.c"
 249 #include "ehci-mem.c"
 250 #include "ehci-q.c"
 251 #include "ehci-sched.c"
 252
 253 /*-------------------------------------------------------------------------*/
 254
 255 static void ehci_watchdog (unsigned long param)
 256 {
 257         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 258         unsigned long           flags;
 259
 260         spin_lock_irqsave (&ehci->lock, flags);
 261
 262         /* lost IAA irqs wedge things badly; seen with a vt8235 */
 263         if (ehci->reclaim) {
 264                 u32             status = readl (&ehci->regs->status);
 265
 266                 if (status & STS_IAA) {
 267                         ehci_vdbg (ehci, "lost IAA\n");
 268                         COUNT (ehci->stats.lost_iaa);
 269                         writel (STS_IAA, &ehci->regs->status);
 270                         ehci->reclaim_ready = 1;
 271                 }
 272         }
 273
 274         /* stop async processing after it's idled a bit */
 275         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 276                 start_unlink_async (ehci, ehci->async);
 277
 278         /* ehci could run by timer, without IRQs ... */
 279         ehci_work (ehci, NULL);
 280
 281         spin_unlock_irqrestore (&ehci->lock, flags);
 282 }
 283
 284 #ifdef  CONFIG_PCI
 285
 286 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
 287  * off the controller (maybe it can boot from highspeed USB disks).
 288  */
 289 static int bios_handoff (struct ehci_hcd *ehci, int where, u32 cap)
 290 {
 291         if (cap & (1 << 16)) {
 292                 int msec = 5000;
 293                 struct pci_dev *pdev = to_pci_dev(ehci->hcd.self.controller);
 294
 295                 /* request handoff to OS */
 296                 cap |= 1 << 24;
 297                 pci_write_config_dword(pdev, where, cap);
 298
 299                 /* and wait a while for it to happen */
 300                 do {
 301                         msleep(10);
 302                         msec -= 10;
 303                         pci_read_config_dword(pdev, where, &cap);
 304                 } while ((cap & (1 << 16)) && msec);
 305                 if (cap & (1 << 16)) {
 306                         ehci_err (ehci, "BIOS handoff failed (%d, %04x)\n",
 307                                 where, cap);
 308                         // some BIOS versions seem buggy...
 309                         // return 1;
 310                         ehci_warn (ehci, "continuing after BIOS bug...\n");
 311                         return 0;
 312                 }
 313                 ehci_dbg (ehci, "BIOS handoff succeeded\n");
 314         }
 315         return 0;
 316 }
 317
 318 #endif
 319
 320 static int
 321 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
 322 {
 323         struct ehci_hcd         *ehci;
 324
 325         ehci = container_of (self, struct ehci_hcd, reboot_notifier);
 326
 327         /* make BIOS/etc use companion controller during reboot */
 328         writel (0, &ehci->regs->configured_flag);
 329         return 0;
 330 }
 331
 332
 333 /* called by khubd or root hub init threads */
 334
 335 static int ehci_hc_reset (struct usb_hcd *hcd)
 336 {
 337         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 338         u32                     temp;
 339         unsigned                count = 256/4;
 340
 341         spin_lock_init (&ehci->lock);
 342
 343         ehci->caps = hcd->regs;
 344         ehci->regs = (hcd->regs +
 345                                 HC_LENGTH (readl (&ehci->caps->hc_capbase)));
 346         dbg_hcs_params (ehci, "reset");
 347         dbg_hcc_params (ehci, "reset");
 348
 349 #ifdef  CONFIG_PCI
 350         writel(0, &ehci->regs->intr_enable);
 351         /* EHCI 0.96 and later may have "extended capabilities" */
 352         if (hcd->self.controller->bus == &pci_bus_type)
 353                 temp = HCC_EXT_CAPS (readl (&ehci->caps->hcc_params));
 354         else
 355                 temp = 0;
 356         while (temp && count--) {
 357                 u32             cap;
 358
 359                 pci_read_config_dword (to_pci_dev(ehci->hcd.self.controller),
 360                                 temp, &cap);
 361                 ehci_dbg (ehci, "capability %04x at %02x\n", cap, temp);
 362                 switch (cap & 0xff) {
 363                 case 1:                 /* BIOS/SMM/... handoff */
 364                         if (bios_handoff (ehci, temp, cap) != 0)
 365                                 return -EOPNOTSUPP;
 366                         break;
 367                 case 0x0a:              /* appendix C */
 368                         ehci_dbg (ehci, "debug registers, BAR %d offset %d\n",
 369                                 (cap >> 29) & 0x07, (cap >> 16) & 0x0fff);
 370                         break;
 371                 case 0:                 /* illegal reserved capability */
 372                         ehci_warn (ehci, "illegal capability!\n");
 373                         cap = 0;
 374                         /* FALLTHROUGH */
 375                 default:                /* unknown */
 376                         break;
 377                 }
 378                 temp = (cap >> 8) & 0xff;
 379         }
 380         if (!count) {
 381                 ehci_err (ehci, "bogus capabilities ... PCI problems!\n");
 382                 return -EIO;
 383         }
 384 #endif
 385
 386         /* cache this readonly data; minimize PCI reads */
 387         ehci->hcs_params = readl (&ehci->caps->hcs_params);
 388
 389         /* force HC to halt state */
 390         return ehci_halt (ehci);
 391 }
 392
 393 static int ehci_start (struct usb_hcd *hcd)
 394 {
 395         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 396         u32                     temp;
 397         struct usb_device       *udev;
 398         struct usb_bus          *bus;
 399         int                     retval;
 400         u32                     hcc_params;
 401         u8                      sbrn = 0;
 402
 403         init_timer (&ehci->watchdog);
 404         ehci->watchdog.function = ehci_watchdog;
 405         ehci->watchdog.data = (unsigned long) ehci;
 406
 407         /*
 408          * hw default: 1K periodic list heads, one per frame.
 409          * periodic_size can shrink by USBCMD update if hcc_params allows.
 410          */
 411         ehci->periodic_size = DEFAULT_I_TDPS;
 412         if ((retval = ehci_mem_init (ehci, GFP_KERNEL)) < 0)
 413                 return retval;
 414
 415         /* controllers may cache some of the periodic schedule ... */
 416         hcc_params = readl (&ehci->caps->hcc_params);
 417         if (HCC_ISOC_CACHE (hcc_params))        // full frame cache
 418                 ehci->i_thresh = 8;
 419         else                                    // N microframes cached
 420                 ehci->i_thresh = 2 + HCC_ISOC_THRES (hcc_params);
 421
 422         ehci->reclaim = NULL;
 423         ehci->next_uframe = -1;
 424
 425         /* controller state:  unknown --> reset */
 426
 427         /* EHCI spec section 4.1 */
 428         if ((retval = ehci_reset (ehci)) != 0) {
 429                 ehci_mem_cleanup (ehci);
 430                 return retval;
 431         }
 432         writel (ehci->periodic_dma, &ehci->regs->frame_list);
 433
 434 #ifdef  CONFIG_PCI
 435         if (hcd->self.controller->bus == &pci_bus_type) {
 436                 struct pci_dev          *pdev;
 437                 u16                     port_wake;
 438
 439                 pdev = to_pci_dev(hcd->self.controller);
 440
 441                 /* Serial Bus Release Number is at PCI 0x60 offset */
 442                 pci_read_config_byte(pdev, 0x60, &sbrn);
 443
 444                 /* port wake capability, reported by boot firmware */
 445                 pci_read_config_word(pdev, 0x62, &port_wake);
 446                 hcd->can_wakeup = (port_wake & 1) != 0;
 447
 448                 /* help hc dma work well with cachelines */
 449                 pci_set_mwi (pdev);
 450
 451                 /* chip-specific init */
 452                 switch (pdev->vendor) {
 453                 case PCI_VENDOR_ID_ARC:
 454                         if (pdev->device == PCI_DEVICE_ID_ARC_EHCI)
 455                                 ehci->is_arc_rh_tt = 1;
 456                         break;
 457                 }
 458
 459         }
 460 #endif
 461
 462         /*
 463          * dedicate a qh for the async ring head, since we couldn't unlink
 464          * a 'real' qh without stopping the async schedule [4.8].  use it
 465          * as the 'reclamation list head' too.
 466          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 467          * from automatically advancing to the next td after short reads.
 468          */
 469         ehci->async->qh_next.qh = NULL;
 470         ehci->async->hw_next = QH_NEXT (ehci->async->qh_dma);
 471         ehci->async->hw_info1 = cpu_to_le32 (QH_HEAD);
 472         ehci->async->hw_token = cpu_to_le32 (QTD_STS_HALT);
 473         ehci->async->hw_qtd_next = EHCI_LIST_END;
 474         ehci->async->qh_state = QH_STATE_LINKED;
 475         ehci->async->hw_alt_next = QTD_NEXT (ehci->async->dummy->qtd_dma);
 476         writel ((u32)ehci->async->qh_dma, &ehci->regs->async_next);
 477
 478         /*
 479          * hcc_params controls whether ehci->regs->segment must (!!!)
 480          * be used; it constrains QH/ITD/SITD and QTD locations.
 481          * pci_pool consistent memory always uses segment zero.
 482          * streaming mappings for I/O buffers, like pci_map_single(),
 483          * can return segments above 4GB, if the device allows.
 484          *
 485          * NOTE:  the dma mask is visible through dma_supported(), so
 486          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 487          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 488          * host side drivers though.
 489          */
 490         if (HCC_64BIT_ADDR (hcc_params)) {
 491                 writel (0, &ehci->regs->segment);
 492 #if 0
 493 // this is deeply broken on almost all architectures
 494                 if (!pci_set_dma_mask (to_pci_dev(ehci->hcd.self.controller), 0xffffffffffffffffULL))
 495                         ehci_info (ehci, "enabled 64bit PCI DMA\n");
 496 #endif
 497         }
 498
 499         /* clear interrupt enables, set irq latency */
 500         temp = readl (&ehci->regs->command) & 0x0fff;
 501         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 502                 log2_irq_thresh = 0;
 503         temp |= 1 << (16 + log2_irq_thresh);
 504         // if hc can park (ehci >= 0.96), default is 3 packets per async QH
 505         if (HCC_PGM_FRAMELISTLEN (hcc_params)) {
 506                 /* periodic schedule size can be smaller than default */
 507                 temp &= ~(3 << 2);
 508                 temp |= (EHCI_TUNE_FLS << 2);
 509                 switch (EHCI_TUNE_FLS) {
 510                 case 0: ehci->periodic_size = 1024; break;
 511                 case 1: ehci->periodic_size = 512; break;
 512                 case 2: ehci->periodic_size = 256; break;
 513                 default:        BUG ();
 514                 }
 515         }
 516         temp &= ~(CMD_IAAD | CMD_ASE | CMD_PSE),
 517         // Philips, Intel, and maybe others need CMD_RUN before the
 518         // root hub will detect new devices (why?); NEC doesn't
 519         temp |= CMD_RUN;
 520         writel (temp, &ehci->regs->command);
 521         dbg_cmd (ehci, "init", temp);
 522
 523         /* set async sleep time = 10 us ... ? */
 524
 525         /* wire up the root hub */
 526         bus = hcd_to_bus (hcd);
 527         udev = usb_alloc_dev (NULL, bus, 0);
 528         if (!udev) {
 529 done2:
 530                 ehci_mem_cleanup (ehci);
 531                 return -ENOMEM;
 532         }
 533
 534         /*
 535          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 536          * are explicitly handed to companion controller(s), so no TT is
 537          * involved with the root hub.  (Except where one is integrated,
 538          * and there's no companion controller unless maybe for USB OTG.)
 539          */
 540         ehci->reboot_notifier.notifier_call = ehci_reboot;
 541         register_reboot_notifier (&ehci->reboot_notifier);
 542
 543         ehci->hcd.state = USB_STATE_RUNNING;
 544         writel (FLAG_CF, &ehci->regs->configured_flag);
 545         readl (&ehci->regs->command);   /* unblock posted write */
 546
 547         temp = HC_VERSION(readl (&ehci->caps->hc_capbase));
 548         ehci_info (ehci,
 549                 "USB %x.%x enabled, EHCI %x.%02x, driver %s\n",
 550                 ((sbrn & 0xf0)>>4), (sbrn & 0x0f),
 551                 temp >> 8, temp & 0xff, DRIVER_VERSION);
 552
 553         /*
 554          * From here on, khubd concurrently accesses the root
 555          * hub; drivers will be talking to enumerated devices.
 556          *
 557          * Before this point the HC was idle/ready.  After, khubd
 558          * and device drivers may start it running.
 559          */
 560         udev->speed = USB_SPEED_HIGH;
 561         if (hcd_register_root (udev, hcd) != 0) {
 562                 if (hcd->state == USB_STATE_RUNNING)
 563                         ehci_ready (ehci);
 564                 ehci_reset (ehci);
 565                 usb_put_dev (udev);
 566                 retval = -ENODEV;
 567                 goto done2;
 568         }
 569
 570         writel (INTR_MASK, &ehci->regs->intr_enable); /* Turn On Interrupts */
 571
 572         create_debug_files (ehci);
 573
 574         return 0;
 575 }
 576
 577 /* always called by thread; normally rmmod */
 578
 579 static void ehci_stop (struct usb_hcd *hcd)
 580 {
 581         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 582         u8                      rh_ports, port;
 583
 584         ehci_dbg (ehci, "stop\n");
 585
 586         /* no more interrupts ... */
 587         if (hcd->state == USB_STATE_RUNNING)
 588                 ehci_ready (ehci);
 589         if (in_interrupt ()) {          /* must not happen!! */
 590                 ehci_err (ehci, "stopped in_interrupt!\n");
 591                 return;
 592         }
 593         del_timer_sync (&ehci->watchdog);
 594
 595         /* Turn off port power on all root hub ports. */
 596         rh_ports = HCS_N_PORTS (ehci->hcs_params);
 597         for (port = 1; port <= rh_ports; port++) {
 598                 ehci_hub_control(hcd, ClearPortFeature, USB_PORT_FEAT_POWER,
 599                         port, NULL, 0);
 600         }
 601
 602         ehci_reset (ehci);
 603         writel (0, &ehci->regs->intr_enable);
 604
 605         /* let companion controllers work when we aren't */
 606         writel (0, &ehci->regs->configured_flag);
 607         unregister_reboot_notifier (&ehci->reboot_notifier);
 608
 609         remove_debug_files (ehci);
 610
 611         /* root hub is shut down separately (first, when possible) */
 612         spin_lock_irq (&ehci->lock);
 613         if (ehci->async)
 614                 ehci_work (ehci, NULL);
 615         spin_unlock_irq (&ehci->lock);
 616         ehci_mem_cleanup (ehci);
 617
 618 #ifdef  EHCI_STATS
 619         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 620                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 621                 ehci->stats.lost_iaa);
 622         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 623                 ehci->stats.complete, ehci->stats.unlink);
 624 #endif
 625
 626         dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
 627 }
 628
 629 static int ehci_get_frame (struct usb_hcd *hcd)
 630 {
 631         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 632         return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
 633 }
 634
 635 /*-------------------------------------------------------------------------*/
 636
 637 #ifdef  CONFIG_PM
 638
 639 /* suspend/resume, section 4.3 */
 640
 641 /* These routines rely on PCI to handle powerdown and wakeup, and
 642  * transceivers that don't need any software attention to set up
 643  * the right sort of wakeup.
 644  */
 645
 646 static int ehci_suspend (struct usb_hcd *hcd, u32 state)
 647 {
 648         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 649
 650         while (time_before (jiffies, ehci->next_statechange))
 651                 msleep (100);
 652
 653 #ifdef  CONFIG_USB_SUSPEND
 654         (void) usb_suspend_device (hcd->self.root_hub, state);
 655 #else
 656         /* FIXME lock root hub */
 657         (void) ehci_hub_suspend (hcd);
 658 #endif
 659
 660         // save (PCI) FLADJ in case of Vaux power loss
 661
 662         return 0;
 663 }
 664
 665 static int ehci_resume (struct usb_hcd *hcd)
 666 {
 667         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 668         int                     retval;
 669
 670         // maybe restore (PCI) FLADJ
 671
 672         while (time_before (jiffies, ehci->next_statechange))
 673                 msleep (100);
 674
 675 #ifdef  CONFIG_USB_SUSPEND
 676         retval = usb_resume_device (hcd->self.root_hub);
 677 #else
 678         /* FIXME lock root hub */
 679         retval = ehci_hub_resume (hcd);
 680 #endif
 681         if (retval == 0)
 682                 hcd->self.controller->power.power_state = 0;
 683         return retval;
 684 }
 685
 686 #endif
 687
 688 /*-------------------------------------------------------------------------*/
 689
 690 /*
 691  * ehci_work is called from some interrupts, timers, and so on.
 692  * it calls driver completion functions, after dropping ehci->lock.
 693  */
 694 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
 695 {
 696         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 697         if (ehci->reclaim_ready)
 698                 end_unlink_async (ehci, regs);
 699
 700         /* another CPU may drop ehci->lock during a schedule scan while
 701          * it reports urb completions.  this flag guards against bogus
 702          * attempts at re-entrant schedule scanning.
 703          */
 704         if (ehci->scanning)
 705                 return;
 706         ehci->scanning = 1;
 707         scan_async (ehci, regs);
 708         if (ehci->next_uframe != -1)
 709                 scan_periodic (ehci, regs);
 710         ehci->scanning = 0;
 711
 712         /* the IO watchdog guards against hardware or driver bugs that
 713          * misplace IRQs, and should let us run completely without IRQs.
 714          * such lossage has been observed on both VT6202 and VT8235.
 715          */
 716         if ((ehci->async->qh_next.ptr != 0) || (ehci->periodic_sched != 0))
 717                 timer_action (ehci, TIMER_IO_WATCHDOG);
 718 }
 719
 720 /*-------------------------------------------------------------------------*/
 721
 722 static irqreturn_t ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
 723 {
 724         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 725         u32                     status;
 726         int                     bh;
 727
 728         spin_lock (&ehci->lock);
 729
 730         status = readl (&ehci->regs->status);
 731
 732         /* e.g. cardbus physical eject */
 733         if (status == ~(u32) 0) {
 734                 ehci_dbg (ehci, "device removed\n");
 735                 goto dead;
 736         }
 737
 738         status &= INTR_MASK;
 739         if (!status) {                  /* irq sharing? */
 740                 spin_unlock(&ehci->lock);
 741                 return IRQ_NONE;
 742         }
 743
 744         /* clear (just) interrupts */
 745         writel (status, &ehci->regs->status);
 746         readl (&ehci->regs->command);   /* unblock posted write */
 747         bh = 0;
 748
 749 #ifdef  EHCI_VERBOSE_DEBUG
 750         /* unrequested/ignored: Frame List Rollover */
 751         dbg_status (ehci, "irq", status);
 752 #endif
 753
 754         /* INT, ERR, and IAA interrupt rates can be throttled */
 755
 756         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 757         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 758                 if (likely ((status & STS_ERR) == 0))
 759                         COUNT (ehci->stats.normal);
 760                 else
 761                         COUNT (ehci->stats.error);
 762                 bh = 1;
 763         }
 764
 765         /* complete the unlinking of some qh [4.15.2.3] */
 766         if (status & STS_IAA) {
 767                 COUNT (ehci->stats.reclaim);
 768                 ehci->reclaim_ready = 1;
 769                 bh = 1;
 770         }
 771
 772         /* remote wakeup [4.3.1] */
 773         if ((status & STS_PCD) && ehci->hcd.remote_wakeup) {
 774                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 775
 776                 /* resume root hub? */
 777                 status = readl (&ehci->regs->command);
 778                 if (!(status & CMD_RUN))
 779                         writel (status | CMD_RUN, &ehci->regs->command);
 780
 781                 while (i--) {
 782                         status = readl (&ehci->regs->port_status [i]);
 783                         if (status & PORT_OWNER)
 784                                 continue;
 785                         if (!(status & PORT_RESUME)
 786                                         || ehci->reset_done [i] != 0)
 787                                 continue;
 788
 789                         /* start 20 msec resume signaling from this port,
 790                          * and make khubd collect PORT_STAT_C_SUSPEND to
 791                          * stop that signaling.
 792                          */
 793                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
 794                         mod_timer (&ehci->hcd.rh_timer,
 795                                         ehci->reset_done [i] + 1);
 796                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 797                 }
 798         }
 799
 800         /* PCI errors [4.15.2.4] */
 801         if (unlikely ((status & STS_FATAL) != 0)) {
 802                 ehci_err (ehci, "fatal error\n");
 803 dead:
 804                 ehci_reset (ehci);
 805                 /* generic layer kills/unlinks all urbs, then
 806                  * uses ehci_stop to clean up the rest
 807                  */
 808                 bh = 1;
 809         }
 810
 811         if (bh)
 812                 ehci_work (ehci, regs);
 813         spin_unlock (&ehci->lock);
 814         return IRQ_HANDLED;
 815 }
 816
 817 /*-------------------------------------------------------------------------*/
 818
 819 /*
 820  * non-error returns are a promise to giveback() the urb later
 821  * we drop ownership so next owner (or urb unlink) can get it
 822  *
 823  * urb + dev is in hcd.self.controller.urb_list
 824  * we're queueing TDs onto software and hardware lists
 825  *
 826  * hcd-specific init for hcpriv hasn't been done yet
 827  *
 828  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 829  * to a (possibly active) QH, and the same QH scanning code.
 830  */
 831 static int ehci_urb_enqueue (
 832         struct usb_hcd  *hcd,
 833         struct urb      *urb,
 834         int             mem_flags
 835 ) {
 836         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 837         struct list_head        qtd_list;
 838
 839         INIT_LIST_HEAD (&qtd_list);
 840
 841         switch (usb_pipetype (urb->pipe)) {
 842         // case PIPE_CONTROL:
 843         // case PIPE_BULK:
 844         default:
 845                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 846                         return -ENOMEM;
 847                 return submit_async (ehci, urb, &qtd_list, mem_flags);
 848
 849         case PIPE_INTERRUPT:
 850                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 851                         return -ENOMEM;
 852                 return intr_submit (ehci, urb, &qtd_list, mem_flags);
 853
 854         case PIPE_ISOCHRONOUS:
 855                 if (urb->dev->speed == USB_SPEED_HIGH)
 856                         return itd_submit (ehci, urb, mem_flags);
 857                 else
 858                         return sitd_submit (ehci, urb, mem_flags);
 859         }
 860 }
 861
 862 /* remove from hardware lists
 863  * completions normally happen asynchronously
 864  */
 865
 866 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 867 {
 868         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 869         struct ehci_qh          *qh;
 870         unsigned long           flags;
 871
 872         spin_lock_irqsave (&ehci->lock, flags);
 873         switch (usb_pipetype (urb->pipe)) {
 874         // case PIPE_CONTROL:
 875         // case PIPE_BULK:
 876         default:
 877                 qh = (struct ehci_qh *) urb->hcpriv;
 878                 if (!qh)
 879                         break;
 880
 881                 /* if we need to use IAA and it's busy, defer */
 882                 if (qh->qh_state == QH_STATE_LINKED
 883                                 && ehci->reclaim
 884                                 && HCD_IS_RUNNING (ehci->hcd.state)
 885                                 ) {
 886                         struct ehci_qh          *last;
 887
 888                         for (last = ehci->reclaim;
 889                                         last->reclaim;
 890                                         last = last->reclaim)
 891                                 continue;
 892                         qh->qh_state = QH_STATE_UNLINK_WAIT;
 893                         last->reclaim = qh;
 894
 895                 /* bypass IAA if the hc can't care */
 896                 } else if (!HCD_IS_RUNNING (ehci->hcd.state) && ehci->reclaim)
 897                         end_unlink_async (ehci, NULL);
 898
 899                 /* something else might have unlinked the qh by now */
 900                 if (qh->qh_state == QH_STATE_LINKED)
 901                         start_unlink_async (ehci, qh);
 902                 break;
 903
 904         case PIPE_INTERRUPT:
 905                 qh = (struct ehci_qh *) urb->hcpriv;
 906                 if (!qh)
 907                         break;
 908                 if (qh->qh_state == QH_STATE_LINKED) {
 909                         /* messy, can spin or block a microframe ... */
 910                         intr_deschedule (ehci, qh, 1);
 911                         /* qh_state == IDLE */
 912                 }
 913                 qh_completions (ehci, qh, NULL);
 914
 915                 /* reschedule QH iff another request is queued */
 916                 if (!list_empty (&qh->qtd_list)
 917                                 && HCD_IS_RUNNING (ehci->hcd.state)) {
 918                         int status;
 919
 920                         status = qh_schedule (ehci, qh);
 921                         spin_unlock_irqrestore (&ehci->lock, flags);
 922
 923                         if (status != 0) {
 924                                 // shouldn't happen often, but ...
 925                                 // FIXME kill those tds' urbs
 926                                 err ("can't reschedule qh %p, err %d",
 927                                         qh, status);
 928                         }
 929                         return status;
 930                 }
 931                 break;
 932
 933         case PIPE_ISOCHRONOUS:
 934                 // itd or sitd ...
 935
 936                 // wait till next completion, do it then.
 937                 // completion irqs can wait up to 1024 msec,
 938                 break;
 939         }
 940         spin_unlock_irqrestore (&ehci->lock, flags);
 941         return 0;
 942 }
 943
 944 /*-------------------------------------------------------------------------*/
 945
 946 // bulk qh holds the data toggle
 947
 948 static void
 949 ehci_endpoint_disable (struct usb_hcd *hcd, struct hcd_dev *dev, int ep)
 950 {
 951         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 952         int                     epnum;
 953         unsigned long           flags;
 954         struct ehci_qh          *qh;
 955
 956         /* ASSERT:  any requests/urbs are being unlinked */
 957         /* ASSERT:  nobody can be submitting urbs for this any more */
 958
 959         epnum = ep & USB_ENDPOINT_NUMBER_MASK;
 960         if (epnum != 0 && (ep & USB_DIR_IN))
 961                 epnum |= 0x10;
 962
 963 rescan:
 964         spin_lock_irqsave (&ehci->lock, flags);
 965         qh = (struct ehci_qh *) dev->ep [epnum];
 966         if (!qh)
 967                 goto done;
 968
 969         /* endpoints can be iso streams.  for now, we don't
 970          * accelerate iso completions ... so spin a while.
 971          */
 972         if (qh->hw_info1 == 0) {
 973                 ehci_vdbg (ehci, "iso delay\n");
 974                 goto idle_timeout;
 975         }
 976
 977         if (!HCD_IS_RUNNING (ehci->hcd.state))
 978                 qh->qh_state = QH_STATE_IDLE;
 979         switch (qh->qh_state) {
 980         case QH_STATE_UNLINK:           /* wait for hw to finish? */
 981 idle_timeout:
 982                 spin_unlock_irqrestore (&ehci->lock, flags);
 983                 set_current_state (TASK_UNINTERRUPTIBLE);
 984                 schedule_timeout (1);
 985                 goto rescan;
 986         case QH_STATE_IDLE:             /* fully unlinked */
 987                 if (list_empty (&qh->qtd_list)) {
 988                         qh_put (qh);
 989                         break;
 990                 }
 991                 /* else FALL THROUGH */
 992         default:
 993                 /* caller was supposed to have unlinked any requests;
 994                  * that's not our job.  just leak this memory.
 995                  */
 996                 ehci_err (ehci, "qh %p (#%d) state %d%s\n",
 997                         qh, epnum, qh->qh_state,
 998                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
 999                 break;
1000         }
1001         dev->ep[epnum] = NULL;
1002 done:
1003         spin_unlock_irqrestore (&ehci->lock, flags);
1004         return;
1005 }
1006
1007 /*-------------------------------------------------------------------------*/
1008
1009 static const struct hc_driver ehci_driver = {
1010         .description =          hcd_name,
1011
1012         /*
1013          * generic hardware linkage
1014          */
1015         .irq =                  ehci_irq,
1016         .flags =                HCD_MEMORY | HCD_USB2,
1017
1018         /*
1019          * basic lifecycle operations
1020          */
1021         .reset =                ehci_hc_reset,
1022         .start =                ehci_start,
1023 #ifdef  CONFIG_PM
1024         .suspend =              ehci_suspend,
1025         .resume =               ehci_resume,
1026 #endif
1027         .stop =                 ehci_stop,
1028
1029         /*
1030          * memory lifecycle (except per-request)
1031          */
1032         .hcd_alloc =            ehci_hcd_alloc,
1033         .hcd_free =             ehci_hcd_free,
1034
1035         /*
1036          * managing i/o requests and associated device resources
1037          */
1038         .urb_enqueue =          ehci_urb_enqueue,
1039         .urb_dequeue =          ehci_urb_dequeue,
1040         .endpoint_disable =     ehci_endpoint_disable,
1041
1042         /*
1043          * scheduling support
1044          */
1045         .get_frame_number =     ehci_get_frame,
1046
1047         /*
1048          * root hub support
1049          */
1050         .hub_status_data =      ehci_hub_status_data,
1051         .hub_control =          ehci_hub_control,
1052         .hub_suspend =          ehci_hub_suspend,
1053         .hub_resume =           ehci_hub_resume,
1054 };
1055
1056 /*-------------------------------------------------------------------------*/
1057
1058 /* EHCI 1.0 doesn't require PCI */
1059
1060 #ifdef  CONFIG_PCI
1061
1062 /* PCI driver selection metadata; PCI hotplugging uses this */
1063 static const struct pci_device_id pci_ids [] = { {
1064         /* handle any USB 2.0 EHCI controller */
1065         PCI_DEVICE_CLASS(((PCI_CLASS_SERIAL_USB << 8) | 0x20), ~0),
1066         .driver_data =  (unsigned long) &ehci_driver,
1067         },
1068         { /* end: all zeroes */ }
1069 };
1070 MODULE_DEVICE_TABLE (pci, pci_ids);
1071
1072 /* pci driver glue; this is a "new style" PCI driver module */
1073 static struct pci_driver ehci_pci_driver = {
1074         .name =         (char *) hcd_name,
1075         .id_table =     pci_ids,
1076
1077         .probe =        usb_hcd_pci_probe,
1078         .remove =       usb_hcd_pci_remove,
1079
1080 #ifdef  CONFIG_PM
1081         .suspend =      usb_hcd_pci_suspend,
1082         .resume =       usb_hcd_pci_resume,
1083 #endif
1084 };
1085
1086 #endif  /* PCI */
1087
1088
1089 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
1090
1091 MODULE_DESCRIPTION (DRIVER_INFO);
1092 MODULE_AUTHOR (DRIVER_AUTHOR);
1093 MODULE_LICENSE ("GPL");
1094
1095 static int __init init (void)
1096 {
1097         if (usb_disabled())
1098                 return -ENODEV;
1099
1100         pr_debug ("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1101                 hcd_name,
1102                 sizeof (struct ehci_qh), sizeof (struct ehci_qtd),
1103                 sizeof (struct ehci_itd), sizeof (struct ehci_sitd));
1104
1105         return pci_module_init (&ehci_pci_driver);
1106 }
1107 module_init (init);
1108
1109 static void __exit cleanup (void)
1110 {
1111         pci_unregister_driver (&ehci_pci_driver);
1112 }
1113 module_exit (cleanup);