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