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