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