drivers/usb/host/ehci-hcd.c

   1 /*
   2  * Copyright (c) 2000-2002 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/kernel.h>
  30 #include <linux/delay.h>
  31 #include <linux/ioport.h>
  32 #include <linux/sched.h>
  33 #include <linux/slab.h>
  34 #include <linux/smp_lock.h>
  35 #include <linux/errno.h>
  36 #include <linux/init.h>
  37 #include <linux/timer.h>
  38 #include <linux/list.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/reboot.h>
  41 #include <linux/usb.h>
  42 #include <linux/moduleparam.h>
  43
  44 #include <linux/version.h>
  45 #include "../core/hcd.h"
  46
  47 #include <asm/byteorder.h>
  48 #include <asm/io.h>
  49 #include <asm/irq.h>
  50 #include <asm/system.h>
  51 #include <asm/unaligned.h>
  52
  53
  54 /*-------------------------------------------------------------------------*/
  55
  56 /*
  57  * EHCI hc_driver implementation ... experimental, incomplete.
  58  * Based on the final 1.0 register interface specification.
  59  *
  60  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  61  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  62  * Next comes "CardBay", using USB 2.0 signals.
  63  *
  64  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  65  * Special thanks to Intel and VIA for providing host controllers to
  66  * test this driver on, and Cypress (including In-System Design) for
  67  * providing early devices for those host controllers to talk to!
  68  *
  69  * HISTORY:
  70  *
  71  * 2002-11-29   Correct handling for hw async_next register.
  72  * 2002-08-06   Handling for bulk and interrupt transfers is mostly shared;
  73  *      only scheduling is different, no arbitrary limitations.
  74  * 2002-07-25   Sanity check PCI reads, mostly for better cardbus support,
  75  *      clean up HC run state handshaking.
  76  * 2002-05-24   Preliminary FS/LS interrupts, using scheduling shortcuts
  77  * 2002-05-11   Clear TT errors for FS/LS ctrl/bulk.  Fill in some other
  78  *      missing pieces:  enabling 64bit dma, handoff from BIOS/SMM.
  79  * 2002-05-07   Some error path cleanups to report better errors; wmb();
  80  *      use non-CVS version id; better iso bandwidth claim.
  81  * 2002-04-19   Control/bulk/interrupt submit no longer uses giveback() on
  82  *      errors in submit path.  Bugfixes to interrupt scheduling/processing.
  83  * 2002-03-05   Initial high-speed ISO support; reduce ITD memory; shift
  84  *      more checking to generic hcd framework (db).  Make it work with
  85  *      Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt).
  86  * 2002-01-14   Minor cleanup; version synch.
  87  * 2002-01-08   Fix roothub handoff of FS/LS to companion controllers.
  88  * 2002-01-04   Control/Bulk queuing behaves.
  89  *
  90  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
  91  * 2001-June    Works with usb-storage and NEC EHCI on 2.4
  92  */
  93
  94 #define DRIVER_VERSION "2003-Jun-13"
  95 #define DRIVER_AUTHOR "David Brownell"
  96 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
  97
  98 static const char       hcd_name [] = "ehci_hcd";
  99
 100
 101 // #define EHCI_VERBOSE_DEBUG
 102 // #define have_split_iso
 103
 104 #ifdef DEBUG
 105 #define EHCI_STATS
 106 #endif
 107
 108 /* magic numbers that can affect system performance */
 109 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
 110 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
 111 #define EHCI_TUNE_RL_TT         0
 112 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
 113 #define EHCI_TUNE_MULT_TT       1
 114 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
 115
 116 #define EHCI_IAA_JIFFIES        (HZ/100)        /* arbitrary; ~10 msec */
 117 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
 118 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
 119 #define EHCI_SHRINK_JIFFIES     (HZ/200)        /* async qh unlink delay */
 120
 121 /* Initial IRQ latency:  lower than default */
 122 static int log2_irq_thresh = 0;         // 0 to 6
 123 module_param (log2_irq_thresh, int, S_IRUGO);
 124 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
 125
 126 #define INTR_MASK (STS_IAA | STS_FATAL | STS_ERR | STS_INT)
 127
 128 /*-------------------------------------------------------------------------*/
 129
 130 #include "ehci.h"
 131 #include "ehci-dbg.c"
 132
 133 /*-------------------------------------------------------------------------*/
 134
 135 /*
 136  * handshake - spin reading hc until handshake completes or fails
 137  * @ptr: address of hc register to be read
 138  * @mask: bits to look at in result of read
 139  * @done: value of those bits when handshake succeeds
 140  * @usec: timeout in microseconds
 141  *
 142  * Returns negative errno, or zero on success
 143  *
 144  * Success happens when the "mask" bits have the specified value (hardware
 145  * handshake done).  There are two failure modes:  "usec" have passed (major
 146  * hardware flakeout), or the register reads as all-ones (hardware removed).
 147  *
 148  * That last failure should_only happen in cases like physical cardbus eject
 149  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 150  * bridge shutdown:  shutting down the bridge before the devices using it.
 151  */
 152 static int handshake (u32 *ptr, u32 mask, u32 done, int usec)
 153 {
 154         u32     result;
 155
 156         do {
 157                 result = readl (ptr);
 158                 if (result == ~(u32)0)          /* card removed */
 159                         return -ENODEV;
 160                 result &= mask;
 161                 if (result == done)
 162                         return 0;
 163                 udelay (1);
 164                 usec--;
 165         } while (usec > 0);
 166         return -ETIMEDOUT;
 167 }
 168
 169 /*
 170  * hc states include: unknown, halted, ready, running
 171  * transitional states are messy just now
 172  * trying to avoid "running" unless urbs are active
 173  * a "ready" hc can be finishing prefetched work
 174  */
 175
 176 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 177 static int ehci_halt (struct ehci_hcd *ehci)
 178 {
 179         u32     temp = readl (&ehci->regs->status);
 180
 181         if ((temp & STS_HALT) != 0)
 182                 return 0;
 183
 184         temp = readl (&ehci->regs->command);
 185         temp &= ~CMD_RUN;
 186         writel (temp, &ehci->regs->command);
 187         return handshake (&ehci->regs->status, STS_HALT, STS_HALT, 16 * 125);
 188 }
 189
 190 /* reset a non-running (STS_HALT == 1) controller */
 191 static int ehci_reset (struct ehci_hcd *ehci)
 192 {
 193         u32     command = readl (&ehci->regs->command);
 194
 195         command |= CMD_RESET;
 196         dbg_cmd (ehci, "reset", command);
 197         writel (command, &ehci->regs->command);
 198         ehci->hcd.state = USB_STATE_HALT;
 199         return handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
 200 }
 201
 202 /* idle the controller (from running) */
 203 static void ehci_ready (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 = 0;
 214         if (ehci->async->qh_next.qh)
 215                 temp = STS_ASS;
 216         if (ehci->next_uframe != -1)
 217                 temp |= STS_PSS;
 218         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 219                                 temp, 16 * 125) != 0) {
 220                 ehci->hcd.state = USB_STATE_HALT;
 221                 return;
 222         }
 223
 224         /* then disable anything that's still active */
 225         temp = readl (&ehci->regs->command);
 226         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
 227         writel (temp, &ehci->regs->command);
 228
 229         /* hardware can take 16 microframes to turn off ... */
 230         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
 231                                 0, 16 * 125) != 0) {
 232                 ehci->hcd.state = USB_STATE_HALT;
 233                 return;
 234         }
 235         ehci->hcd.state = USB_STATE_READY;
 236 }
 237
 238 /*-------------------------------------------------------------------------*/
 239
 240 #include "ehci-hub.c"
 241 #include "ehci-mem.c"
 242 #include "ehci-q.c"
 243 #include "ehci-sched.c"
 244
 245 /*-------------------------------------------------------------------------*/
 246
 247 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
 248
 249 static void ehci_watchdog (unsigned long param)
 250 {
 251         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 252         unsigned long           flags;
 253
 254         spin_lock_irqsave (&ehci->lock, flags);
 255
 256         /* lost IAA irqs wedge things badly; seen with a vt8235 */
 257         if (ehci->reclaim) {
 258                 u32             status = readl (&ehci->regs->status);
 259
 260                 if (status & STS_IAA) {
 261                         ehci_vdbg (ehci, "lost IAA\n");
 262                         COUNT (ehci->stats.lost_iaa);
 263                         writel (STS_IAA, &ehci->regs->status);
 264                         ehci->reclaim_ready = 1;
 265                 }
 266         }
 267
 268         /* stop async processing after it's idled a bit */
 269         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 270                 start_unlink_async (ehci, ehci->async);
 271
 272         /* ehci could run by timer, without IRQs ... */
 273         ehci_work (ehci, NULL);
 274
 275         spin_unlock_irqrestore (&ehci->lock, flags);
 276 }
 277
 278 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
 279  * off the controller (maybe it can boot from highspeed USB disks).
 280  */
 281 static int bios_handoff (struct ehci_hcd *ehci, int where, u32 cap)
 282 {
 283         if (cap & (1 << 16)) {
 284                 int msec = 500;
 285
 286                 /* request handoff to OS */
 287                 cap &= 1 << 24;
 288                 pci_write_config_dword (ehci->hcd.pdev, where, cap);
 289
 290                 /* and wait a while for it to happen */
 291                 do {
 292                         wait_ms (10);
 293                         msec -= 10;
 294                         pci_read_config_dword (ehci->hcd.pdev, where, &cap);
 295                 } while ((cap & (1 << 16)) && msec);
 296                 if (cap & (1 << 16)) {
 297                         ehci_err (ehci, "BIOS handoff failed (%d, %04x)\n",
 298                                 where, cap);
 299                         return 1;
 300                 }
 301                 ehci_dbg (ehci, "BIOS handoff succeeded\n");
 302         }
 303         return 0;
 304 }
 305
 306 static int
 307 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
 308 {
 309         struct ehci_hcd         *ehci;
 310
 311         ehci = container_of (self, struct ehci_hcd, reboot_notifier);
 312
 313         /* make BIOS/etc use companion controller during reboot */
 314         writel (0, &ehci->regs->configured_flag);
 315         return 0;
 316 }
 317
 318
 319 /* called by khubd or root hub init threads */
 320
 321 static int ehci_hc_reset (struct usb_hcd *hcd)
 322 {
 323         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 324         u32                     temp;
 325
 326         spin_lock_init (&ehci->lock);
 327
 328         ehci->caps = (struct ehci_caps *) hcd->regs;
 329         ehci->regs = (struct ehci_regs *) (hcd->regs +
 330                                 readb (&ehci->caps->length));
 331         dbg_hcs_params (ehci, "reset");
 332         dbg_hcc_params (ehci, "reset");
 333
 334         /* EHCI 0.96 and later may have "extended capabilities" */
 335         temp = HCC_EXT_CAPS (readl (&ehci->caps->hcc_params));
 336         while (temp) {
 337                 u32             cap;
 338
 339                 pci_read_config_dword (ehci->hcd.pdev, temp, &cap);
 340                 ehci_dbg (ehci, "capability %04x at %02x\n", cap, temp);
 341                 switch (cap & 0xff) {
 342                 case 1:                 /* BIOS/SMM/... handoff */
 343                         if (bios_handoff (ehci, temp, cap) != 0)
 344                                 return -EOPNOTSUPP;
 345                         break;
 346                 case 0:                 /* illegal reserved capability */
 347                         ehci_warn (ehci, "illegal capability!\n");
 348                         cap = 0;
 349                         /* FALLTHROUGH */
 350                 default:                /* unknown */
 351                         break;
 352                 }
 353                 temp = (cap >> 8) & 0xff;
 354         }
 355
 356         /* cache this readonly data; minimize PCI reads */
 357         ehci->hcs_params = readl (&ehci->caps->hcs_params);
 358
 359         /* force HC to halt state */
 360         return ehci_halt (ehci);
 361 }
 362
 363 static int ehci_start (struct usb_hcd *hcd)
 364 {
 365         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 366         u32                     temp;
 367         struct usb_device       *udev;
 368         struct usb_bus          *bus;
 369         int                     retval;
 370         u32                     hcc_params;
 371         u8                      tempbyte;
 372
 373         /*
 374          * hw default: 1K periodic list heads, one per frame.
 375          * periodic_size can shrink by USBCMD update if hcc_params allows.
 376          */
 377         ehci->periodic_size = DEFAULT_I_TDPS;
 378         if ((retval = ehci_mem_init (ehci, SLAB_KERNEL)) < 0)
 379                 return retval;
 380
 381         /* controllers may cache some of the periodic schedule ... */
 382         hcc_params = readl (&ehci->caps->hcc_params);
 383         if (HCC_ISOC_CACHE (hcc_params))        // full frame cache
 384                 ehci->i_thresh = 8;
 385         else                                    // N microframes cached
 386                 ehci->i_thresh = 2 + HCC_ISOC_THRES (hcc_params);
 387
 388         ehci->reclaim = 0;
 389         ehci->next_uframe = -1;
 390
 391         /* controller state:  unknown --> reset */
 392
 393         /* EHCI spec section 4.1 */
 394         if ((retval = ehci_reset (ehci)) != 0) {
 395                 ehci_mem_cleanup (ehci);
 396                 return retval;
 397         }
 398         writel (INTR_MASK, &ehci->regs->intr_enable);
 399         writel (ehci->periodic_dma, &ehci->regs->frame_list);
 400
 401         /*
 402          * dedicate a qh for the async ring head, since we couldn't unlink
 403          * a 'real' qh without stopping the async schedule [4.8].  use it
 404          * as the 'reclamation list head' too.
 405          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 406          * from automatically advancing to the next td after short reads.
 407          */
 408         ehci->async->qh_next.qh = 0;
 409         ehci->async->hw_next = QH_NEXT (ehci->async->qh_dma);
 410         ehci->async->hw_info1 = cpu_to_le32 (QH_HEAD);
 411         ehci->async->hw_token = cpu_to_le32 (QTD_STS_HALT);
 412         ehci->async->hw_qtd_next = EHCI_LIST_END;
 413         ehci->async->qh_state = QH_STATE_LINKED;
 414         ehci->async->hw_alt_next = QTD_NEXT (ehci->async->dummy->qtd_dma);
 415         writel ((u32)ehci->async->qh_dma, &ehci->regs->async_next);
 416
 417         /*
 418          * hcc_params controls whether ehci->regs->segment must (!!!)
 419          * be used; it constrains QH/ITD/SITD and QTD locations.
 420          * pci_pool consistent memory always uses segment zero.
 421          * streaming mappings for I/O buffers, like pci_map_single(),
 422          * can return segments above 4GB, if the device allows.
 423          *
 424          * NOTE:  the dma mask is visible through dma_supported(), so
 425          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 426          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 427          * host side drivers though.
 428          */
 429         if (HCC_64BIT_ADDR (hcc_params)) {
 430                 writel (0, &ehci->regs->segment);
 431                 if (!pci_set_dma_mask (ehci->hcd.pdev, 0xffffffffffffffffULL))
 432                         ehci_info (ehci, "enabled 64bit PCI DMA\n");
 433         }
 434
 435         /* help hc dma work well with cachelines */
 436         pci_set_mwi (ehci->hcd.pdev);
 437
 438         /* clear interrupt enables, set irq latency */
 439         temp = readl (&ehci->regs->command) & 0x0fff;
 440         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 441                 log2_irq_thresh = 0;
 442         temp |= 1 << (16 + log2_irq_thresh);
 443         // if hc can park (ehci >= 0.96), default is 3 packets per async QH
 444         if (HCC_PGM_FRAMELISTLEN (hcc_params)) {
 445                 /* periodic schedule size can be smaller than default */
 446                 temp &= ~(3 << 2);
 447                 temp |= (EHCI_TUNE_FLS << 2);
 448                 switch (EHCI_TUNE_FLS) {
 449                 case 0: ehci->periodic_size = 1024; break;
 450                 case 1: ehci->periodic_size = 512; break;
 451                 case 2: ehci->periodic_size = 256; break;
 452                 default:        BUG ();
 453                 }
 454         }
 455         temp &= ~(CMD_IAAD | CMD_ASE | CMD_PSE),
 456         // Philips, Intel, and maybe others need CMD_RUN before the
 457         // root hub will detect new devices (why?); NEC doesn't
 458         temp |= CMD_RUN;
 459         writel (temp, &ehci->regs->command);
 460         dbg_cmd (ehci, "init", temp);
 461
 462         /* set async sleep time = 10 us ... ? */
 463
 464         init_timer (&ehci->watchdog);
 465         ehci->watchdog.function = ehci_watchdog;
 466         ehci->watchdog.data = (unsigned long) ehci;
 467
 468         /* wire up the root hub */
 469         bus = hcd_to_bus (hcd);
 470         bus->root_hub = udev = usb_alloc_dev (NULL, bus);
 471         if (!udev) {
 472 done2:
 473                 ehci_mem_cleanup (ehci);
 474                 return -ENOMEM;
 475         }
 476
 477         /*
 478          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 479          * are explicitly handed to companion controller(s), so no TT is
 480          * involved with the root hub.
 481          */
 482         ehci->reboot_notifier.notifier_call = ehci_reboot;
 483         register_reboot_notifier (&ehci->reboot_notifier);
 484
 485         ehci->hcd.state = USB_STATE_READY;
 486         writel (FLAG_CF, &ehci->regs->configured_flag);
 487         readl (&ehci->regs->command);   /* unblock posted write */
 488
 489         /* PCI Serial Bus Release Number is at 0x60 offset */
 490         pci_read_config_byte (hcd->pdev, 0x60, &tempbyte);
 491         temp = readw (&ehci->caps->hci_version);
 492         ehci_info (ehci,
 493                 "USB %x.%x enabled, EHCI %x.%02x, driver %s\n",
 494                 ((tempbyte & 0xf0)>>4), (tempbyte & 0x0f),
 495                 temp >> 8, temp & 0xff, DRIVER_VERSION);
 496
 497         /*
 498          * From here on, khubd concurrently accesses the root
 499          * hub; drivers will be talking to enumerated devices.
 500          *
 501          * Before this point the HC was idle/ready.  After, khubd
 502          * and device drivers may start it running.
 503          */
 504         udev->speed = USB_SPEED_HIGH;
 505         if (hcd_register_root (hcd) != 0) {
 506                 if (hcd->state == USB_STATE_RUNNING)
 507                         ehci_ready (ehci);
 508                 ehci_reset (ehci);
 509                 bus->root_hub = 0;
 510                 usb_put_dev (udev);
 511                 retval = -ENODEV;
 512                 goto done2;
 513         }
 514
 515         create_debug_files (ehci);
 516
 517         return 0;
 518 }
 519
 520 /* always called by thread; normally rmmod */
 521
 522 static void ehci_stop (struct usb_hcd *hcd)
 523 {
 524         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 525
 526         ehci_dbg (ehci, "stop\n");
 527
 528         /* no more interrupts ... */
 529         if (hcd->state == USB_STATE_RUNNING)
 530                 ehci_ready (ehci);
 531         if (in_interrupt ()) {          /* must not happen!! */
 532                 ehci_err (ehci, "stopped in_interrupt!\n");
 533                 return;
 534         }
 535         del_timer_sync (&ehci->watchdog);
 536         ehci_reset (ehci);
 537
 538         /* let companion controllers work when we aren't */
 539         writel (0, &ehci->regs->configured_flag);
 540         unregister_reboot_notifier (&ehci->reboot_notifier);
 541
 542         remove_debug_files (ehci);
 543
 544         /* root hub is shut down separately (first, when possible) */
 545         spin_lock_irq (&ehci->lock);
 546         ehci_work (ehci, NULL);
 547         spin_unlock_irq (&ehci->lock);
 548         ehci_mem_cleanup (ehci);
 549
 550 #ifdef  EHCI_STATS
 551         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 552                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 553                 ehci->stats.lost_iaa);
 554         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 555                 ehci->stats.complete, ehci->stats.unlink);
 556 #endif
 557
 558         dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
 559 }
 560
 561 static int ehci_get_frame (struct usb_hcd *hcd)
 562 {
 563         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 564         return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
 565 }
 566
 567 /*-------------------------------------------------------------------------*/
 568
 569 #ifdef  CONFIG_PM
 570
 571 /* suspend/resume, section 4.3 */
 572
 573 static int ehci_suspend (struct usb_hcd *hcd, u32 state)
 574 {
 575         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 576         int                     ports;
 577         int                     i;
 578
 579         ehci_dbg (ehci, "suspend to %d\n", state);
 580
 581         ports = HCS_N_PORTS (ehci->hcs_params);
 582
 583         // FIXME:  This assumes what's probably a D3 level suspend...
 584
 585         // FIXME:  usb wakeup events on this bus should resume the machine.
 586         // pci config register PORTWAKECAP controls which ports can do it;
 587         // bios may have initted the register...
 588
 589         /* suspend each port, then stop the hc */
 590         for (i = 0; i < ports; i++) {
 591                 int     temp = readl (&ehci->regs->port_status [i]);
 592
 593                 if ((temp & PORT_PE) == 0
 594                                 || (temp & PORT_OWNER) != 0)
 595                         continue;
 596                 ehci_dbg (ehci, "suspend port %d", i);
 597                 temp |= PORT_SUSPEND;
 598                 writel (temp, &ehci->regs->port_status [i]);
 599         }
 600
 601         if (hcd->state == USB_STATE_RUNNING)
 602                 ehci_ready (ehci);
 603         writel (readl (&ehci->regs->command) & ~CMD_RUN, &ehci->regs->command);
 604
 605 // save pci FLADJ value
 606
 607         /* who tells PCI to reduce power consumption? */
 608
 609         return 0;
 610 }
 611
 612 static int ehci_resume (struct usb_hcd *hcd)
 613 {
 614         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 615         int                     ports;
 616         int                     i;
 617
 618         ehci_dbg (ehci, "resume\n");
 619
 620         ports = HCS_N_PORTS (ehci->hcs_params);
 621
 622         // FIXME:  if controller didn't retain state,
 623         // return and let generic code clean it up
 624         // test configured_flag ?
 625
 626         /* resume HC and each port */
 627 // restore pci FLADJ value
 628         // khubd and drivers will set HC running, if needed;
 629         hcd->state = USB_STATE_READY;
 630         // FIXME Philips/Intel/... etc don't really have a "READY"
 631         // state ... turn on CMD_RUN too
 632         for (i = 0; i < ports; i++) {
 633                 int     temp = readl (&ehci->regs->port_status [i]);
 634
 635                 if ((temp & PORT_PE) == 0
 636                                 || (temp & PORT_SUSPEND) != 0)
 637                         continue;
 638                 ehci_dbg (ehci, "resume port %d", i);
 639                 temp |= PORT_RESUME;
 640                 writel (temp, &ehci->regs->port_status [i]);
 641                 readl (&ehci->regs->command);   /* unblock posted writes */
 642
 643                 wait_ms (20);
 644                 temp &= ~PORT_RESUME;
 645                 writel (temp, &ehci->regs->port_status [i]);
 646         }
 647         readl (&ehci->regs->command);   /* unblock posted writes */
 648         return 0;
 649 }
 650
 651 #endif
 652
 653 /*-------------------------------------------------------------------------*/
 654
 655 /*
 656  * ehci_work is called from some interrupts, timers, and so on.
 657  * it calls driver completion functions, after dropping ehci->lock.
 658  */
 659 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
 660 {
 661         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 662         if (ehci->reclaim_ready)
 663                 end_unlink_async (ehci, regs);
 664         scan_async (ehci, regs);
 665         if (ehci->next_uframe != -1)
 666                 scan_periodic (ehci, regs);
 667
 668         /* the IO watchdog guards against hardware or driver bugs that
 669          * misplace IRQs, and should let us run completely without IRQs.
 670          */
 671         if ((ehci->async->qh_next.ptr != 0) || (ehci->periodic_sched != 0))
 672                 timer_action (ehci, TIMER_IO_WATCHDOG);
 673 }
 674
 675 /*-------------------------------------------------------------------------*/
 676
 677 static void ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
 678 {
 679         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 680         u32                     status;
 681         int                     bh;
 682
 683         spin_lock (&ehci->lock);
 684
 685         status = readl (&ehci->regs->status);
 686
 687         /* e.g. cardbus physical eject */
 688         if (status == ~(u32) 0) {
 689                 ehci_dbg (ehci, "device removed\n");
 690                 goto dead;
 691         }
 692
 693         status &= INTR_MASK;
 694         if (!status)                    /* irq sharing? */
 695                 goto done;
 696
 697         /* clear (just) interrupts */
 698         writel (status, &ehci->regs->status);
 699         readl (&ehci->regs->command);   /* unblock posted write */
 700         bh = 0;
 701
 702 #ifdef  EHCI_VERBOSE_DEBUG
 703         /* unrequested/ignored: Port Change Detect, Frame List Rollover */
 704         dbg_status (ehci, "irq", status);
 705 #endif
 706
 707         /* INT, ERR, and IAA interrupt rates can be throttled */
 708
 709         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 710         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 711                 if (likely ((status & STS_ERR) == 0))
 712                         COUNT (ehci->stats.normal);
 713                 else
 714                         COUNT (ehci->stats.error);
 715                 bh = 1;
 716         }
 717
 718         /* complete the unlinking of some qh [4.15.2.3] */
 719         if (status & STS_IAA) {
 720                 COUNT (ehci->stats.reclaim);
 721                 ehci->reclaim_ready = 1;
 722                 bh = 1;
 723         }
 724
 725         /* PCI errors [4.15.2.4] */
 726         if (unlikely ((status & STS_FATAL) != 0)) {
 727                 ehci_err (ehci, "fatal error\n");
 728 dead:
 729                 ehci_reset (ehci);
 730                 /* generic layer kills/unlinks all urbs, then
 731                  * uses ehci_stop to clean up the rest
 732                  */
 733                 bh = 1;
 734         }
 735
 736         if (bh)
 737                 ehci_work (ehci, regs);
 738 done:
 739         spin_unlock (&ehci->lock);
 740 }
 741
 742 /*-------------------------------------------------------------------------*/
 743
 744 /*
 745  * non-error returns are a promise to giveback() the urb later
 746  * we drop ownership so next owner (or urb unlink) can get it
 747  *
 748  * urb + dev is in hcd_dev.urb_list
 749  * we're queueing TDs onto software and hardware lists
 750  *
 751  * hcd-specific init for hcpriv hasn't been done yet
 752  *
 753  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 754  * to a (possibly active) QH, and the same QH scanning code.
 755  */
 756 static int ehci_urb_enqueue (
 757         struct usb_hcd  *hcd,
 758         struct urb      *urb,
 759         int             mem_flags
 760 ) {
 761         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 762         struct list_head        qtd_list;
 763
 764         urb->transfer_flags &= ~EHCI_STATE_UNLINK;
 765         INIT_LIST_HEAD (&qtd_list);
 766
 767         switch (usb_pipetype (urb->pipe)) {
 768         // case PIPE_CONTROL:
 769         // case PIPE_BULK:
 770         default:
 771                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 772                         return -ENOMEM;
 773                 return submit_async (ehci, urb, &qtd_list, mem_flags);
 774
 775         case PIPE_INTERRUPT:
 776                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 777                         return -ENOMEM;
 778                 return intr_submit (ehci, urb, &qtd_list, mem_flags);
 779
 780         case PIPE_ISOCHRONOUS:
 781                 if (urb->dev->speed == USB_SPEED_HIGH)
 782                         return itd_submit (ehci, urb, mem_flags);
 783 #ifdef have_split_iso
 784                 else
 785                         return sitd_submit (ehci, urb, mem_flags);
 786 #else
 787                 dbg ("no split iso support yet");
 788                 return -ENOSYS;
 789 #endif /* have_split_iso */
 790         }
 791 }
 792
 793 /* remove from hardware lists
 794  * completions normally happen asynchronously
 795  */
 796
 797 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 798 {
 799         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 800         struct ehci_qh          *qh;
 801         unsigned long           flags;
 802
 803         spin_lock_irqsave (&ehci->lock, flags);
 804         switch (usb_pipetype (urb->pipe)) {
 805         // case PIPE_CONTROL:
 806         // case PIPE_BULK:
 807         default:
 808                 qh = (struct ehci_qh *) urb->hcpriv;
 809                 if (!qh)
 810                         break;
 811
 812                 /* if we need to use IAA and it's busy, defer */
 813                 if (qh->qh_state == QH_STATE_LINKED
 814                                 && ehci->reclaim
 815                                 && HCD_IS_RUNNING (ehci->hcd.state)
 816                                 ) {
 817                         struct ehci_qh          *last;
 818
 819                         for (last = ehci->reclaim;
 820                                         last->reclaim;
 821                                         last = last->reclaim)
 822                                 continue;
 823                         qh->qh_state = QH_STATE_UNLINK_WAIT;
 824                         last->reclaim = qh;
 825
 826                 /* bypass IAA if the hc can't care */
 827                 } else if (!HCD_IS_RUNNING (ehci->hcd.state) && ehci->reclaim)
 828                         end_unlink_async (ehci, NULL);
 829
 830                 /* something else might have unlinked the qh by now */
 831                 if (qh->qh_state == QH_STATE_LINKED)
 832                         start_unlink_async (ehci, qh);
 833                 break;
 834
 835         case PIPE_INTERRUPT:
 836                 qh = (struct ehci_qh *) urb->hcpriv;
 837                 if (!qh)
 838                         break;
 839                 if (qh->qh_state == QH_STATE_LINKED) {
 840                         /* messy, can spin or block a microframe ... */
 841                         intr_deschedule (ehci, qh, 1);
 842                         /* qh_state == IDLE */
 843                 }
 844                 qh_completions (ehci, qh, NULL);
 845
 846                 /* reschedule QH iff another request is queued */
 847                 if (!list_empty (&qh->qtd_list)
 848                                 && HCD_IS_RUNNING (ehci->hcd.state)) {
 849                         int status;
 850
 851                         status = qh_schedule (ehci, qh);
 852                         spin_unlock_irqrestore (&ehci->lock, flags);
 853
 854                         if (status != 0) {
 855                                 // shouldn't happen often, but ...
 856                                 // FIXME kill those tds' urbs
 857                                 err ("can't reschedule qh %p, err %d",
 858                                         qh, status);
 859                         }
 860                         return status;
 861                 }
 862                 break;
 863
 864         case PIPE_ISOCHRONOUS:
 865                 // itd or sitd ...
 866
 867                 // wait till next completion, do it then.
 868                 // completion irqs can wait up to 1024 msec,
 869                 urb->transfer_flags |= EHCI_STATE_UNLINK;
 870                 break;
 871         }
 872         spin_unlock_irqrestore (&ehci->lock, flags);
 873         return 0;
 874 }
 875
 876 /*-------------------------------------------------------------------------*/
 877
 878 // bulk qh holds the data toggle
 879
 880 static void
 881 ehci_endpoint_disable (struct usb_hcd *hcd, struct hcd_dev *dev, int ep)
 882 {
 883         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 884         int                     epnum;
 885         unsigned long           flags;
 886         struct ehci_qh          *qh;
 887
 888         /* ASSERT:  any requests/urbs are being unlinked */
 889         /* ASSERT:  nobody can be submitting urbs for this any more */
 890
 891         epnum = ep & USB_ENDPOINT_NUMBER_MASK;
 892         if (epnum != 0 && (ep & USB_DIR_IN))
 893                 epnum |= 0x10;
 894
 895 rescan:
 896         spin_lock_irqsave (&ehci->lock, flags);
 897         qh = (struct ehci_qh *) dev->ep [epnum];
 898         if (!qh)
 899                 goto done;
 900
 901         if (!HCD_IS_RUNNING (ehci->hcd.state))
 902                 qh->qh_state = QH_STATE_IDLE;
 903         switch (qh->qh_state) {
 904         case QH_STATE_UNLINK:           /* wait for hw to finish? */
 905                 spin_unlock_irqrestore (&ehci->lock, flags);
 906                 set_current_state (TASK_UNINTERRUPTIBLE);
 907                 schedule_timeout (1);
 908                 goto rescan;
 909         case QH_STATE_IDLE:             /* fully unlinked */
 910                 if (list_empty (&qh->qtd_list)) {
 911                         qh_put (ehci, qh);
 912                         break;
 913                 }
 914                 /* else FALL THROUGH */
 915         default:
 916                 /* caller was supposed to have unlinked any requests;
 917                  * that's not our job.  just leak this memory.
 918                  */
 919                 ehci_err (ehci, "qh %p (#%d) state %d%s\n",
 920                         qh, epnum, qh->qh_state,
 921                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
 922                 break;
 923         }
 924         dev->ep [epnum] = 0;
 925 done:
 926         spin_unlock_irqrestore (&ehci->lock, flags);
 927         return;
 928 }
 929
 930 /*-------------------------------------------------------------------------*/
 931
 932 static const struct hc_driver ehci_driver = {
 933         .description =          hcd_name,
 934
 935         /*
 936          * generic hardware linkage
 937          */
 938         .irq =                  ehci_irq,
 939         .flags =                HCD_MEMORY | HCD_USB2,
 940
 941         /*
 942          * basic lifecycle operations
 943          */
 944         .reset =                ehci_hc_reset,
 945         .start =                ehci_start,
 946 #ifdef  CONFIG_PM
 947         .suspend =              ehci_suspend,
 948         .resume =               ehci_resume,
 949 #endif
 950         .stop =                 ehci_stop,
 951
 952         /*
 953          * memory lifecycle (except per-request)
 954          */
 955         .hcd_alloc =            ehci_hcd_alloc,
 956         .hcd_free =             ehci_hcd_free,
 957
 958         /*
 959          * managing i/o requests and associated device resources
 960          */
 961         .urb_enqueue =          ehci_urb_enqueue,
 962         .urb_dequeue =          ehci_urb_dequeue,
 963         .endpoint_disable =     ehci_endpoint_disable,
 964
 965         /*
 966          * scheduling support
 967          */
 968         .get_frame_number =     ehci_get_frame,
 969
 970         /*
 971          * root hub support
 972          */
 973         .hub_status_data =      ehci_hub_status_data,
 974         .hub_control =          ehci_hub_control,
 975 };
 976
 977 /*-------------------------------------------------------------------------*/
 978
 979 /* EHCI spec says PCI is required. */
 980
 981 /* PCI driver selection metadata; PCI hotplugging uses this */
 982 static struct pci_device_id pci_ids [] = { {
 983
 984         /* handle any USB 2.0 EHCI controller */
 985
 986         .class =                ((PCI_CLASS_SERIAL_USB << 8) | 0x20),
 987         .class_mask =   ~0,
 988         .driver_data =  (unsigned long) &ehci_driver,
 989
 990         /* no matter who makes it */
 991         .vendor =       PCI_ANY_ID,
 992         .device =       PCI_ANY_ID,
 993         .subvendor =    PCI_ANY_ID,
 994         .subdevice =    PCI_ANY_ID,
 995
 996 }, { /* end: all zeroes */ }
 997 };
 998 MODULE_DEVICE_TABLE (pci, pci_ids);
 999
1000 /* pci driver glue; this is a "new style" PCI driver module */
1001 static struct pci_driver ehci_pci_driver = {
1002         .name =         (char *) hcd_name,
1003         .id_table =     pci_ids,
1004
1005         .probe =        usb_hcd_pci_probe,
1006         .remove =       usb_hcd_pci_remove,
1007
1008 #ifdef  CONFIG_PM
1009         .suspend =      usb_hcd_pci_suspend,
1010         .resume =       usb_hcd_pci_resume,
1011 #endif
1012 };
1013
1014 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
1015
1016 MODULE_DESCRIPTION (DRIVER_INFO);
1017 MODULE_AUTHOR (DRIVER_AUTHOR);
1018 MODULE_LICENSE ("GPL");
1019
1020 static int __init init (void)
1021 {
1022         if (usb_disabled())
1023                 return -ENODEV;
1024
1025         pr_debug ("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1026                 hcd_name,
1027                 sizeof (struct ehci_qh), sizeof (struct ehci_qtd),
1028                 sizeof (struct ehci_itd), sizeof (struct ehci_sitd));
1029
1030         return pci_module_init (&ehci_pci_driver);
1031 }
1032 module_init (init);
1033
1034 static void __exit cleanup (void)
1035 {
1036         pci_unregister_driver (&ehci_pci_driver);
1037 }
1038 module_exit (cleanup);