2 * Copyright (c) 2000-2004 by David Brownell
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.
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
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.
19 #include <linux/config.h>
21 #ifdef CONFIG_USB_DEBUG
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>
46 #include "../core/hcd.h"
48 #include <asm/byteorder.h>
51 #include <asm/system.h>
52 #include <asm/unaligned.h>
55 /*-------------------------------------------------------------------------*/
58 * EHCI hc_driver implementation ... experimental, incomplete.
59 * Based on the final 1.0 register interface specification.
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.
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!
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).
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.
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
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"
104 static const char hcd_name [] = "ehci_hcd";
107 #undef EHCI_VERBOSE_DEBUG
108 #undef EHCI_URB_TRACE
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 */
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 */
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");
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");
137 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
139 /*-------------------------------------------------------------------------*/
142 #include "ehci-dbg.c"
144 /*-------------------------------------------------------------------------*/
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
153 * Returns negative errno, or zero on success
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).
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.
163 static int handshake (void __iomem *ptr, u32 mask, u32 done, int usec)
168 result = readl (ptr);
169 if (result == ~(u32)0) /* card removed */
180 /* force HC to halt state from unknown (EHCI spec section 2.3) */
181 static int ehci_halt (struct ehci_hcd *ehci)
183 u32 temp = readl (&ehci->regs->status);
185 if ((temp & STS_HALT) != 0)
188 temp = readl (&ehci->regs->command);
190 writel (temp, &ehci->regs->command);
191 return handshake (&ehci->regs->status, STS_HALT, STS_HALT, 16 * 125);
194 /* put TDI/ARC silicon into EHCI mode */
195 static void tdi_reset (struct ehci_hcd *ehci)
197 u32 __iomem *reg_ptr;
200 reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + 0x68);
201 tmp = readl (reg_ptr);
203 writel (tmp, reg_ptr);
206 /* reset a non-running (STS_HALT == 1) controller */
207 static int ehci_reset (struct ehci_hcd *ehci)
210 u32 command = readl (&ehci->regs->command);
212 command |= CMD_RESET;
213 dbg_cmd (ehci, "reset", command);
214 writel (command, &ehci->regs->command);
215 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
216 ehci->next_statechange = jiffies;
217 retval = handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
222 if (ehci_is_TDI(ehci))
228 /* idle the controller (from running) */
229 static void ehci_quiesce (struct ehci_hcd *ehci)
234 if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
238 /* wait for any schedule enables/disables to take effect */
239 temp = readl (&ehci->regs->command) << 10;
240 temp &= STS_ASS | STS_PSS;
241 if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
242 temp, 16 * 125) != 0) {
243 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
247 /* then disable anything that's still active */
248 temp = readl (&ehci->regs->command);
249 temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
250 writel (temp, &ehci->regs->command);
252 /* hardware can take 16 microframes to turn off ... */
253 if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
255 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
260 /*-------------------------------------------------------------------------*/
262 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
264 #include "ehci-hub.c"
265 #include "ehci-mem.c"
267 #include "ehci-sched.c"
269 /*-------------------------------------------------------------------------*/
271 static void ehci_watchdog (unsigned long param)
273 struct ehci_hcd *ehci = (struct ehci_hcd *) param;
276 spin_lock_irqsave (&ehci->lock, flags);
278 /* lost IAA irqs wedge things badly; seen with a vt8235 */
280 u32 status = readl (&ehci->regs->status);
282 if (status & STS_IAA) {
283 ehci_vdbg (ehci, "lost IAA\n");
284 COUNT (ehci->stats.lost_iaa);
285 writel (STS_IAA, &ehci->regs->status);
286 ehci->reclaim_ready = 1;
290 /* stop async processing after it's idled a bit */
291 if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
292 start_unlink_async (ehci, ehci->async);
294 /* ehci could run by timer, without IRQs ... */
295 ehci_work (ehci, NULL);
297 spin_unlock_irqrestore (&ehci->lock, flags);
302 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
303 * off the controller (maybe it can boot from highspeed USB disks).
305 static int bios_handoff (struct ehci_hcd *ehci, int where, u32 cap)
307 if (cap & (1 << 16)) {
309 struct pci_dev *pdev =
310 to_pci_dev(ehci_to_hcd(ehci)->self.controller);
312 /* request handoff to OS */
314 pci_write_config_dword(pdev, where, cap);
316 /* and wait a while for it to happen */
320 pci_read_config_dword(pdev, where, &cap);
321 } while ((cap & (1 << 16)) && msec);
322 if (cap & (1 << 16)) {
323 ehci_err (ehci, "BIOS handoff failed (%d, %04x)\n",
325 // some BIOS versions seem buggy...
327 ehci_warn (ehci, "continuing after BIOS bug...\n");
330 ehci_dbg (ehci, "BIOS handoff succeeded\n");
338 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
340 struct ehci_hcd *ehci;
342 ehci = container_of (self, struct ehci_hcd, reboot_notifier);
344 /* make BIOS/etc use companion controller during reboot */
345 writel (0, &ehci->regs->configured_flag);
349 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
353 if (!HCS_PPC (ehci->hcs_params))
356 ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
357 for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
358 (void) ehci_hub_control(ehci_to_hcd(ehci),
359 is_on ? SetPortFeature : ClearPortFeature,
366 /* called by khubd or root hub init threads */
368 static int ehci_hc_reset (struct usb_hcd *hcd)
370 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
372 unsigned count = 256/4;
374 spin_lock_init (&ehci->lock);
376 ehci->caps = hcd->regs;
377 ehci->regs = hcd->regs + HC_LENGTH (readl (&ehci->caps->hc_capbase));
378 dbg_hcs_params (ehci, "reset");
379 dbg_hcc_params (ehci, "reset");
381 /* cache this readonly data; minimize chip reads */
382 ehci->hcs_params = readl (&ehci->caps->hcs_params);
385 if (hcd->self.controller->bus == &pci_bus_type) {
386 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
388 switch (pdev->vendor) {
389 case PCI_VENDOR_ID_TDI:
390 if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
391 ehci->is_tdi_rh_tt = 1;
395 case PCI_VENDOR_ID_AMD:
396 /* AMD8111 EHCI doesn't work, according to AMD errata */
397 if (pdev->device == 0x7463) {
398 ehci_info (ehci, "ignoring AMD8111 (errata)\n");
404 /* optional debug port, normally in the first BAR */
405 temp = pci_find_capability (pdev, 0x0a);
407 pci_read_config_dword(pdev, temp, &temp);
409 if ((temp & (3 << 13)) == (1 << 13)) {
411 ehci->debug = hcd->regs + temp;
412 temp = readl (&ehci->debug->control);
413 ehci_info (ehci, "debug port %d%s\n",
414 HCS_DEBUG_PORT(ehci->hcs_params),
415 (temp & DBGP_ENABLED)
418 if (!(temp & DBGP_ENABLED))
423 temp = HCC_EXT_CAPS (readl (&ehci->caps->hcc_params));
427 /* EHCI 0.96 and later may have "extended capabilities" */
428 while (temp && count--) {
431 pci_read_config_dword (to_pci_dev(hcd->self.controller),
433 ehci_dbg (ehci, "capability %04x at %02x\n", cap, temp);
434 switch (cap & 0xff) {
435 case 1: /* BIOS/SMM/... handoff */
436 if (bios_handoff (ehci, temp, cap) != 0)
439 case 0: /* illegal reserved capability */
440 ehci_warn (ehci, "illegal capability!\n");
443 default: /* unknown */
446 temp = (cap >> 8) & 0xff;
449 ehci_err (ehci, "bogus capabilities ... PCI problems!\n");
452 if (ehci_is_TDI(ehci))
456 ehci_port_power (ehci, 0);
458 /* at least the Genesys GL880S needs fixup here */
459 temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
461 if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
462 ehci_dbg (ehci, "bogus port configuration: "
463 "cc=%d x pcc=%d < ports=%d\n",
464 HCS_N_CC(ehci->hcs_params),
465 HCS_N_PCC(ehci->hcs_params),
466 HCS_N_PORTS(ehci->hcs_params));
469 if (hcd->self.controller->bus == &pci_bus_type) {
470 struct pci_dev *pdev;
472 pdev = to_pci_dev(hcd->self.controller);
473 switch (pdev->vendor) {
474 case 0x17a0: /* GENESYS */
475 /* GL880S: should be PORTS=2 */
476 temp |= (ehci->hcs_params & ~0xf);
477 ehci->hcs_params = temp;
479 case PCI_VENDOR_ID_NVIDIA:
480 /* NF4: should be PCC=10 */
487 /* force HC to halt state */
488 return ehci_halt (ehci);
491 static int ehci_start (struct usb_hcd *hcd)
493 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
495 struct usb_device *udev;
502 /* skip some things on restart paths */
503 first = (ehci->watchdog.data == 0);
505 init_timer (&ehci->watchdog);
506 ehci->watchdog.function = ehci_watchdog;
507 ehci->watchdog.data = (unsigned long) ehci;
511 * hw default: 1K periodic list heads, one per frame.
512 * periodic_size can shrink by USBCMD update if hcc_params allows.
514 ehci->periodic_size = DEFAULT_I_TDPS;
515 if (first && (retval = ehci_mem_init (ehci, GFP_KERNEL)) < 0)
518 /* controllers may cache some of the periodic schedule ... */
519 hcc_params = readl (&ehci->caps->hcc_params);
520 if (HCC_ISOC_CACHE (hcc_params)) // full frame cache
522 else // N microframes cached
523 ehci->i_thresh = 2 + HCC_ISOC_THRES (hcc_params);
525 ehci->reclaim = NULL;
526 ehci->reclaim_ready = 0;
527 ehci->next_uframe = -1;
529 /* controller state: unknown --> reset */
531 /* EHCI spec section 4.1 */
532 if ((retval = ehci_reset (ehci)) != 0) {
533 ehci_mem_cleanup (ehci);
536 writel (ehci->periodic_dma, &ehci->regs->frame_list);
539 if (hcd->self.controller->bus == &pci_bus_type) {
540 struct pci_dev *pdev;
543 pdev = to_pci_dev(hcd->self.controller);
545 /* Serial Bus Release Number is at PCI 0x60 offset */
546 pci_read_config_byte(pdev, 0x60, &sbrn);
548 /* port wake capability, reported by boot firmware */
549 pci_read_config_word(pdev, 0x62, &port_wake);
550 hcd->can_wakeup = (port_wake & 1) != 0;
552 /* help hc dma work well with cachelines */
558 * dedicate a qh for the async ring head, since we couldn't unlink
559 * a 'real' qh without stopping the async schedule [4.8]. use it
560 * as the 'reclamation list head' too.
561 * its dummy is used in hw_alt_next of many tds, to prevent the qh
562 * from automatically advancing to the next td after short reads.
565 ehci->async->qh_next.qh = NULL;
566 ehci->async->hw_next = QH_NEXT (ehci->async->qh_dma);
567 ehci->async->hw_info1 = cpu_to_le32 (QH_HEAD);
568 ehci->async->hw_token = cpu_to_le32 (QTD_STS_HALT);
569 ehci->async->hw_qtd_next = EHCI_LIST_END;
570 ehci->async->qh_state = QH_STATE_LINKED;
571 ehci->async->hw_alt_next = QTD_NEXT (ehci->async->dummy->qtd_dma);
573 writel ((u32)ehci->async->qh_dma, &ehci->regs->async_next);
576 * hcc_params controls whether ehci->regs->segment must (!!!)
577 * be used; it constrains QH/ITD/SITD and QTD locations.
578 * pci_pool consistent memory always uses segment zero.
579 * streaming mappings for I/O buffers, like pci_map_single(),
580 * can return segments above 4GB, if the device allows.
582 * NOTE: the dma mask is visible through dma_supported(), so
583 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
584 * Scsi_Host.highmem_io, and so forth. It's readonly to all
585 * host side drivers though.
587 if (HCC_64BIT_ADDR (hcc_params)) {
588 writel (0, &ehci->regs->segment);
590 // this is deeply broken on almost all architectures
591 if (!pci_set_dma_mask (to_pci_dev(hcd->self.controller), 0xffffffffffffffffULL))
592 ehci_info (ehci, "enabled 64bit PCI DMA\n");
596 /* clear interrupt enables, set irq latency */
597 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
599 temp = 1 << (16 + log2_irq_thresh);
600 if (HCC_CANPARK(hcc_params)) {
601 /* HW default park == 3, on hardware that supports it (like
602 * NVidia and ALI silicon), maximizes throughput on the async
603 * schedule by avoiding QH fetches between transfers.
605 * With fast usb storage devices and NForce2, "park" seems to
606 * make problems: throughput reduction (!), data errors...
609 park = min (park, (unsigned) 3);
613 ehci_info (ehci, "park %d\n", park);
615 if (HCC_PGM_FRAMELISTLEN (hcc_params)) {
616 /* periodic schedule size can be smaller than default */
618 temp |= (EHCI_TUNE_FLS << 2);
619 switch (EHCI_TUNE_FLS) {
620 case 0: ehci->periodic_size = 1024; break;
621 case 1: ehci->periodic_size = 512; break;
622 case 2: ehci->periodic_size = 256; break;
626 // Philips, Intel, and maybe others need CMD_RUN before the
627 // root hub will detect new devices (why?); NEC doesn't
629 writel (temp, &ehci->regs->command);
630 dbg_cmd (ehci, "init", temp);
632 /* set async sleep time = 10 us ... ? */
634 /* wire up the root hub */
635 bus = hcd_to_bus (hcd);
636 udev = first ? usb_alloc_dev (NULL, bus, 0) : bus->root_hub;
639 ehci_mem_cleanup (ehci);
642 udev->speed = USB_SPEED_HIGH;
643 udev->state = first ? USB_STATE_ATTACHED : USB_STATE_CONFIGURED;
646 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
647 * are explicitly handed to companion controller(s), so no TT is
648 * involved with the root hub. (Except where one is integrated,
649 * and there's no companion controller unless maybe for USB OTG.)
652 ehci->reboot_notifier.notifier_call = ehci_reboot;
653 register_reboot_notifier (&ehci->reboot_notifier);
656 hcd->state = HC_STATE_RUNNING;
657 writel (FLAG_CF, &ehci->regs->configured_flag);
658 readl (&ehci->regs->command); /* unblock posted write */
660 temp = HC_VERSION(readl (&ehci->caps->hc_capbase));
662 "USB %x.%x %s, EHCI %x.%02x, driver %s\n",
663 ((sbrn & 0xf0)>>4), (sbrn & 0x0f),
664 first ? "initialized" : "restarted",
665 temp >> 8, temp & 0xff, DRIVER_VERSION);
668 * From here on, khubd concurrently accesses the root
669 * hub; drivers will be talking to enumerated devices.
670 * (On restart paths, khubd already knows about the root
671 * hub and could find work as soon as we wrote FLAG_CF.)
673 * Before this point the HC was idle/ready. After, khubd
674 * and device drivers may start it running.
676 if (first && usb_hcd_register_root_hub (udev, hcd) != 0) {
677 if (hcd->state == HC_STATE_RUNNING)
685 writel (INTR_MASK, &ehci->regs->intr_enable); /* Turn On Interrupts */
688 create_debug_files (ehci);
693 /* always called by thread; normally rmmod */
695 static void ehci_stop (struct usb_hcd *hcd)
697 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
699 ehci_dbg (ehci, "stop\n");
701 /* Turn off port power on all root hub ports. */
702 ehci_port_power (ehci, 0);
704 /* no more interrupts ... */
705 del_timer_sync (&ehci->watchdog);
707 spin_lock_irq(&ehci->lock);
708 if (HC_IS_RUNNING (hcd->state))
712 writel (0, &ehci->regs->intr_enable);
713 spin_unlock_irq(&ehci->lock);
715 /* let companion controllers work when we aren't */
716 writel (0, &ehci->regs->configured_flag);
717 unregister_reboot_notifier (&ehci->reboot_notifier);
719 remove_debug_files (ehci);
721 /* root hub is shut down separately (first, when possible) */
722 spin_lock_irq (&ehci->lock);
724 ehci_work (ehci, NULL);
725 spin_unlock_irq (&ehci->lock);
726 ehci_mem_cleanup (ehci);
729 ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
730 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
731 ehci->stats.lost_iaa);
732 ehci_dbg (ehci, "complete %ld unlink %ld\n",
733 ehci->stats.complete, ehci->stats.unlink);
736 dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
739 static int ehci_get_frame (struct usb_hcd *hcd)
741 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
742 return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
745 /*-------------------------------------------------------------------------*/
749 /* suspend/resume, section 4.3 */
751 /* These routines rely on the bus (pci, platform, etc)
752 * to handle powerdown and wakeup, and currently also on
753 * transceivers that don't need any software attention to set up
754 * the right sort of wakeup.
757 static int ehci_suspend (struct usb_hcd *hcd, pm_message_t message)
759 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
761 if (time_before (jiffies, ehci->next_statechange))
764 #ifdef CONFIG_USB_SUSPEND
765 (void) usb_suspend_device (hcd->self.root_hub, message);
767 usb_lock_device (hcd->self.root_hub);
768 (void) ehci_hub_suspend (hcd);
769 usb_unlock_device (hcd->self.root_hub);
772 // save (PCI) FLADJ in case of Vaux power loss
773 // ... we'd only use it to handle clock skew
778 static int ehci_resume (struct usb_hcd *hcd)
780 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
782 struct usb_device *root = hcd->self.root_hub;
783 int retval = -EINVAL;
785 // maybe restore (PCI) FLADJ
787 if (time_before (jiffies, ehci->next_statechange))
790 /* If any port is suspended, we know we can/must resume the HC. */
791 for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; ) {
794 status = readl (&ehci->regs->port_status [port]);
795 if (status & PORT_SUSPEND) {
796 down (&hcd->self.root_hub->serialize);
797 retval = ehci_hub_resume (hcd);
798 up (&hcd->self.root_hub->serialize);
801 if (!root->children [port])
803 dbg_port (ehci, __FUNCTION__, port + 1, status);
804 usb_set_device_state (root->children[port],
805 USB_STATE_NOTATTACHED);
808 /* Else reset, to cope with power loss or flush-to-storage
809 * style "resume" having activated BIOS during reboot.
812 (void) ehci_halt (ehci);
813 (void) ehci_reset (ehci);
814 (void) ehci_hc_reset (hcd);
816 /* emptying the schedule aborts any urbs */
817 spin_lock_irq (&ehci->lock);
819 ehci->reclaim_ready = 1;
820 ehci_work (ehci, NULL);
821 spin_unlock_irq (&ehci->lock);
823 /* restart; khubd will disconnect devices */
824 retval = ehci_start (hcd);
826 /* here we "know" root ports should always stay powered;
827 * but some controllers may lose all power.
829 ehci_port_power (ehci, 1);
837 /*-------------------------------------------------------------------------*/
840 * ehci_work is called from some interrupts, timers, and so on.
841 * it calls driver completion functions, after dropping ehci->lock.
843 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
845 timer_action_done (ehci, TIMER_IO_WATCHDOG);
846 if (ehci->reclaim_ready)
847 end_unlink_async (ehci, regs);
849 /* another CPU may drop ehci->lock during a schedule scan while
850 * it reports urb completions. this flag guards against bogus
851 * attempts at re-entrant schedule scanning.
856 scan_async (ehci, regs);
857 if (ehci->next_uframe != -1)
858 scan_periodic (ehci, regs);
861 /* the IO watchdog guards against hardware or driver bugs that
862 * misplace IRQs, and should let us run completely without IRQs.
863 * such lossage has been observed on both VT6202 and VT8235.
865 if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
866 (ehci->async->qh_next.ptr != NULL ||
867 ehci->periodic_sched != 0))
868 timer_action (ehci, TIMER_IO_WATCHDOG);
871 /*-------------------------------------------------------------------------*/
873 static irqreturn_t ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
875 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
879 spin_lock (&ehci->lock);
881 status = readl (&ehci->regs->status);
883 /* e.g. cardbus physical eject */
884 if (status == ~(u32) 0) {
885 ehci_dbg (ehci, "device removed\n");
890 if (!status) { /* irq sharing? */
891 spin_unlock(&ehci->lock);
895 /* clear (just) interrupts */
896 writel (status, &ehci->regs->status);
897 readl (&ehci->regs->command); /* unblock posted write */
900 #ifdef EHCI_VERBOSE_DEBUG
901 /* unrequested/ignored: Frame List Rollover */
902 dbg_status (ehci, "irq", status);
905 /* INT, ERR, and IAA interrupt rates can be throttled */
907 /* normal [4.15.1.2] or error [4.15.1.1] completion */
908 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
909 if (likely ((status & STS_ERR) == 0))
910 COUNT (ehci->stats.normal);
912 COUNT (ehci->stats.error);
916 /* complete the unlinking of some qh [4.15.2.3] */
917 if (status & STS_IAA) {
918 COUNT (ehci->stats.reclaim);
919 ehci->reclaim_ready = 1;
923 /* remote wakeup [4.3.1] */
924 if ((status & STS_PCD) && hcd->remote_wakeup) {
925 unsigned i = HCS_N_PORTS (ehci->hcs_params);
927 /* resume root hub? */
928 status = readl (&ehci->regs->command);
929 if (!(status & CMD_RUN))
930 writel (status | CMD_RUN, &ehci->regs->command);
933 status = readl (&ehci->regs->port_status [i]);
934 if (status & PORT_OWNER)
936 if (!(status & PORT_RESUME)
937 || ehci->reset_done [i] != 0)
940 /* start 20 msec resume signaling from this port,
941 * and make khubd collect PORT_STAT_C_SUSPEND to
942 * stop that signaling.
944 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
945 mod_timer (&hcd->rh_timer,
946 ehci->reset_done [i] + 1);
947 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
951 /* PCI errors [4.15.2.4] */
952 if (unlikely ((status & STS_FATAL) != 0)) {
953 /* bogus "fatal" IRQs appear on some chips... why? */
954 status = readl (&ehci->regs->status);
955 dbg_cmd (ehci, "fatal", readl (&ehci->regs->command));
956 dbg_status (ehci, "fatal", status);
957 if (status & STS_HALT) {
958 ehci_err (ehci, "fatal error\n");
961 writel (0, &ehci->regs->configured_flag);
962 /* generic layer kills/unlinks all urbs, then
963 * uses ehci_stop to clean up the rest
970 ehci_work (ehci, regs);
971 spin_unlock (&ehci->lock);
975 /*-------------------------------------------------------------------------*/
978 * non-error returns are a promise to giveback() the urb later
979 * we drop ownership so next owner (or urb unlink) can get it
981 * urb + dev is in hcd.self.controller.urb_list
982 * we're queueing TDs onto software and hardware lists
984 * hcd-specific init for hcpriv hasn't been done yet
986 * NOTE: control, bulk, and interrupt share the same code to append TDs
987 * to a (possibly active) QH, and the same QH scanning code.
989 static int ehci_urb_enqueue (
991 struct usb_host_endpoint *ep,
995 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
996 struct list_head qtd_list;
998 INIT_LIST_HEAD (&qtd_list);
1000 switch (usb_pipetype (urb->pipe)) {
1001 // case PIPE_CONTROL:
1004 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1006 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
1008 case PIPE_INTERRUPT:
1009 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1011 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
1013 case PIPE_ISOCHRONOUS:
1014 if (urb->dev->speed == USB_SPEED_HIGH)
1015 return itd_submit (ehci, urb, mem_flags);
1017 return sitd_submit (ehci, urb, mem_flags);
1021 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
1023 /* if we need to use IAA and it's busy, defer */
1024 if (qh->qh_state == QH_STATE_LINKED
1026 && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
1027 struct ehci_qh *last;
1029 for (last = ehci->reclaim;
1031 last = last->reclaim)
1033 qh->qh_state = QH_STATE_UNLINK_WAIT;
1036 /* bypass IAA if the hc can't care */
1037 } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
1038 end_unlink_async (ehci, NULL);
1040 /* something else might have unlinked the qh by now */
1041 if (qh->qh_state == QH_STATE_LINKED)
1042 start_unlink_async (ehci, qh);
1045 /* remove from hardware lists
1046 * completions normally happen asynchronously
1049 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1051 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1053 unsigned long flags;
1055 spin_lock_irqsave (&ehci->lock, flags);
1056 switch (usb_pipetype (urb->pipe)) {
1057 // case PIPE_CONTROL:
1060 qh = (struct ehci_qh *) urb->hcpriv;
1063 unlink_async (ehci, qh);
1066 case PIPE_INTERRUPT:
1067 qh = (struct ehci_qh *) urb->hcpriv;
1070 switch (qh->qh_state) {
1071 case QH_STATE_LINKED:
1072 intr_deschedule (ehci, qh);
1075 qh_completions (ehci, qh, NULL);
1078 ehci_dbg (ehci, "bogus qh %p state %d\n",
1083 /* reschedule QH iff another request is queued */
1084 if (!list_empty (&qh->qtd_list)
1085 && HC_IS_RUNNING (hcd->state)) {
1088 status = qh_schedule (ehci, qh);
1089 spin_unlock_irqrestore (&ehci->lock, flags);
1092 // shouldn't happen often, but ...
1093 // FIXME kill those tds' urbs
1094 err ("can't reschedule qh %p, err %d",
1101 case PIPE_ISOCHRONOUS:
1104 // wait till next completion, do it then.
1105 // completion irqs can wait up to 1024 msec,
1109 spin_unlock_irqrestore (&ehci->lock, flags);
1113 /*-------------------------------------------------------------------------*/
1115 // bulk qh holds the data toggle
1118 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1120 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1121 unsigned long flags;
1122 struct ehci_qh *qh, *tmp;
1124 /* ASSERT: any requests/urbs are being unlinked */
1125 /* ASSERT: nobody can be submitting urbs for this any more */
1128 spin_lock_irqsave (&ehci->lock, flags);
1133 /* endpoints can be iso streams. for now, we don't
1134 * accelerate iso completions ... so spin a while.
1136 if (qh->hw_info1 == 0) {
1137 ehci_vdbg (ehci, "iso delay\n");
1141 if (!HC_IS_RUNNING (hcd->state))
1142 qh->qh_state = QH_STATE_IDLE;
1143 switch (qh->qh_state) {
1144 case QH_STATE_LINKED:
1145 for (tmp = ehci->async->qh_next.qh;
1147 tmp = tmp->qh_next.qh)
1149 /* periodic qh self-unlinks on empty */
1152 unlink_async (ehci, qh);
1154 case QH_STATE_UNLINK: /* wait for hw to finish? */
1156 spin_unlock_irqrestore (&ehci->lock, flags);
1157 set_current_state (TASK_UNINTERRUPTIBLE);
1158 schedule_timeout (1);
1160 case QH_STATE_IDLE: /* fully unlinked */
1161 if (list_empty (&qh->qtd_list)) {
1165 /* else FALL THROUGH */
1168 /* caller was supposed to have unlinked any requests;
1169 * that's not our job. just leak this memory.
1171 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1172 qh, ep->desc.bEndpointAddress, qh->qh_state,
1173 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1178 spin_unlock_irqrestore (&ehci->lock, flags);
1182 /*-------------------------------------------------------------------------*/
1184 static const struct hc_driver ehci_driver = {
1185 .description = hcd_name,
1186 .product_desc = "EHCI Host Controller",
1187 .hcd_priv_size = sizeof(struct ehci_hcd),
1190 * generic hardware linkage
1193 .flags = HCD_MEMORY | HCD_USB2,
1196 * basic lifecycle operations
1198 .reset = ehci_hc_reset,
1199 .start = ehci_start,
1201 .suspend = ehci_suspend,
1202 .resume = ehci_resume,
1207 * managing i/o requests and associated device resources
1209 .urb_enqueue = ehci_urb_enqueue,
1210 .urb_dequeue = ehci_urb_dequeue,
1211 .endpoint_disable = ehci_endpoint_disable,
1214 * scheduling support
1216 .get_frame_number = ehci_get_frame,
1221 .hub_status_data = ehci_hub_status_data,
1222 .hub_control = ehci_hub_control,
1223 .hub_suspend = ehci_hub_suspend,
1224 .hub_resume = ehci_hub_resume,
1227 /*-------------------------------------------------------------------------*/
1229 /* EHCI 1.0 doesn't require PCI */
1233 /* PCI driver selection metadata; PCI hotplugging uses this */
1234 static const struct pci_device_id pci_ids [] = { {
1235 /* handle any USB 2.0 EHCI controller */
1236 PCI_DEVICE_CLASS(((PCI_CLASS_SERIAL_USB << 8) | 0x20), ~0),
1237 .driver_data = (unsigned long) &ehci_driver,
1239 { /* end: all zeroes */ }
1241 MODULE_DEVICE_TABLE (pci, pci_ids);
1243 /* pci driver glue; this is a "new style" PCI driver module */
1244 static struct pci_driver ehci_pci_driver = {
1245 .name = (char *) hcd_name,
1246 .id_table = pci_ids,
1248 .probe = usb_hcd_pci_probe,
1249 .remove = usb_hcd_pci_remove,
1252 .suspend = usb_hcd_pci_suspend,
1253 .resume = usb_hcd_pci_resume,
1260 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
1262 MODULE_DESCRIPTION (DRIVER_INFO);
1263 MODULE_AUTHOR (DRIVER_AUTHOR);
1264 MODULE_LICENSE ("GPL");
1266 static int __init init (void)
1271 pr_debug ("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1273 sizeof (struct ehci_qh), sizeof (struct ehci_qtd),
1274 sizeof (struct ehci_itd), sizeof (struct ehci_sitd));
1276 return pci_register_driver (&ehci_pci_driver);
1280 static void __exit cleanup (void)
1282 pci_unregister_driver (&ehci_pci_driver);
1284 module_exit (cleanup);