2 * Universal Host Controller Interface driver for USB.
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
6 * (C) Copyright 1999 Linus Torvalds
7 * (C) Copyright 1999-2002 Johannes Erdfelt, johannes@erdfelt.com
8 * (C) Copyright 1999 Randy Dunlap
9 * (C) Copyright 1999 Georg Acher, acher@in.tum.de
10 * (C) Copyright 1999 Deti Fliegl, deti@fliegl.de
11 * (C) Copyright 1999 Thomas Sailer, sailer@ife.ee.ethz.ch
12 * (C) Copyright 1999 Roman Weissgaerber, weissg@vienna.at
13 * (C) Copyright 2000 Yggdrasil Computing, Inc. (port of new PCI interface
14 * support from usb-ohci.c by Adam Richter, adam@yggdrasil.com).
15 * (C) Copyright 1999 Gregory P. Smith (from usb-ohci.c)
16 * (C) Copyright 2004-2007 Alan Stern, stern@rowland.harvard.edu
18 * Intel documents this fairly well, and as far as I know there
19 * are no royalties or anything like that, but even so there are
20 * people who decided that they want to do the same thing in a
21 * completely different way.
25 #include <linux/module.h>
26 #include <linux/pci.h>
27 #include <linux/kernel.h>
28 #include <linux/init.h>
29 #include <linux/delay.h>
30 #include <linux/ioport.h>
31 #include <linux/slab.h>
32 #include <linux/errno.h>
33 #include <linux/unistd.h>
34 #include <linux/interrupt.h>
35 #include <linux/spinlock.h>
36 #include <linux/debugfs.h>
38 #include <linux/dmapool.h>
39 #include <linux/dma-mapping.h>
40 #include <linux/usb.h>
41 #include <linux/usb/hcd.h>
42 #include <linux/bitops.h>
43 #include <linux/dmi.h>
45 #include <asm/uaccess.h>
48 #include <asm/system.h>
51 #include "pci-quirks.h"
56 #define DRIVER_AUTHOR "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, \
57 Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, Roman Weissgaerber, \
59 #define DRIVER_DESC "USB Universal Host Controller Interface driver"
61 /* for flakey hardware, ignore overcurrent indicators */
63 module_param(ignore_oc, bool, S_IRUGO);
64 MODULE_PARM_DESC(ignore_oc, "ignore hardware overcurrent indications");
67 * debug = 0, no debugging messages
68 * debug = 1, dump failed URBs except for stalls
69 * debug = 2, dump all failed URBs (including stalls)
70 * show all queues in /sys/kernel/debug/uhci/[pci_addr]
71 * debug = 3, show all TDs in URBs when dumping
74 #define DEBUG_CONFIGURED 1
76 module_param(debug, int, S_IRUGO | S_IWUSR);
77 MODULE_PARM_DESC(debug, "Debug level");
80 #define DEBUG_CONFIGURED 0
85 #define ERRBUF_LEN (32 * 1024)
87 static struct kmem_cache *uhci_up_cachep; /* urb_priv */
89 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state);
90 static void wakeup_rh(struct uhci_hcd *uhci);
91 static void uhci_get_current_frame_number(struct uhci_hcd *uhci);
94 * Calculate the link pointer DMA value for the first Skeleton QH in a frame.
96 static __le32 uhci_frame_skel_link(struct uhci_hcd *uhci, int frame)
101 * The interrupt queues will be interleaved as evenly as possible.
102 * There's not much to be done about period-1 interrupts; they have
103 * to occur in every frame. But we can schedule period-2 interrupts
104 * in odd-numbered frames, period-4 interrupts in frames congruent
105 * to 2 (mod 4), and so on. This way each frame only has two
106 * interrupt QHs, which will help spread out bandwidth utilization.
108 * ffs (Find First bit Set) does exactly what we need:
109 * 1,3,5,... => ffs = 0 => use period-2 QH = skelqh[8],
110 * 2,6,10,... => ffs = 1 => use period-4 QH = skelqh[7], etc.
111 * ffs >= 7 => not on any high-period queue, so use
112 * period-1 QH = skelqh[9].
113 * Add in UHCI_NUMFRAMES to insure at least one bit is set.
115 skelnum = 8 - (int) __ffs(frame | UHCI_NUMFRAMES);
118 return LINK_TO_QH(uhci->skelqh[skelnum]);
121 #include "uhci-debug.c"
123 #include "uhci-hub.c"
126 * Finish up a host controller reset and update the recorded state.
128 static void finish_reset(struct uhci_hcd *uhci)
132 /* HCRESET doesn't affect the Suspend, Reset, and Resume Detect
133 * bits in the port status and control registers.
134 * We have to clear them by hand.
136 for (port = 0; port < uhci->rh_numports; ++port)
137 outw(0, uhci->io_addr + USBPORTSC1 + (port * 2));
139 uhci->port_c_suspend = uhci->resuming_ports = 0;
140 uhci->rh_state = UHCI_RH_RESET;
141 uhci->is_stopped = UHCI_IS_STOPPED;
142 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
146 * Last rites for a defunct/nonfunctional controller
147 * or one we don't want to use any more.
149 static void uhci_hc_died(struct uhci_hcd *uhci)
151 uhci_get_current_frame_number(uhci);
152 uhci_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr);
156 /* The current frame may already be partway finished */
157 ++uhci->frame_number;
161 * Initialize a controller that was newly discovered or has lost power
162 * or otherwise been reset while it was suspended. In none of these cases
163 * can we be sure of its previous state.
165 static void check_and_reset_hc(struct uhci_hcd *uhci)
167 if (uhci_check_and_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr))
172 * Store the basic register settings needed by the controller.
174 static void configure_hc(struct uhci_hcd *uhci)
176 struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
178 /* Set the frame length to the default: 1 ms exactly */
179 outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
181 /* Store the frame list base address */
182 outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
184 /* Set the current frame number */
185 outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
186 uhci->io_addr + USBFRNUM);
189 pci_write_config_word(pdev, USBLEGSUP, USBLEGSUP_DEFAULT);
191 /* Disable platform-specific non-PME# wakeup */
192 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
193 pci_write_config_byte(pdev, USBRES_INTEL, 0);
197 static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
201 /* If we have to ignore overcurrent events then almost by definition
202 * we can't depend on resume-detect interrupts. */
206 switch (to_pci_dev(uhci_dev(uhci))->vendor) {
210 case PCI_VENDOR_ID_GENESYS:
211 /* Genesys Logic's GL880S controllers don't generate
212 * resume-detect interrupts.
216 case PCI_VENDOR_ID_INTEL:
217 /* Some of Intel's USB controllers have a bug that causes
218 * resume-detect interrupts if any port has an over-current
219 * condition. To make matters worse, some motherboards
220 * hardwire unused USB ports' over-current inputs active!
221 * To prevent problems, we will not enable resume-detect
222 * interrupts if any ports are OC.
224 for (port = 0; port < uhci->rh_numports; ++port) {
225 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
234 static int global_suspend_mode_is_broken(struct uhci_hcd *uhci)
237 const char *sys_info;
238 static char bad_Asus_board[] = "A7V8X";
240 /* One of Asus's motherboards has a bug which causes it to
241 * wake up immediately from suspend-to-RAM if any of the ports
242 * are connected. In such cases we will not set EGSM.
244 sys_info = dmi_get_system_info(DMI_BOARD_NAME);
245 if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
246 for (port = 0; port < uhci->rh_numports; ++port) {
247 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
256 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
257 __releases(uhci->lock)
258 __acquires(uhci->lock)
261 int int_enable, egsm_enable, wakeup_enable;
262 struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
264 auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
265 dev_dbg(&rhdev->dev, "%s%s\n", __func__,
266 (auto_stop ? " (auto-stop)" : ""));
268 /* Start off by assuming Resume-Detect interrupts and EGSM work
269 * and that remote wakeups should be enabled.
271 egsm_enable = USBCMD_EGSM;
273 int_enable = USBINTR_RESUME;
276 /* In auto-stop mode wakeups must always be detected, but
277 * Resume-Detect interrupts may be prohibited. (In the absence
278 * of CONFIG_PM, they are always disallowed.)
281 if (!device_may_wakeup(&rhdev->dev))
284 /* In bus-suspend mode wakeups may be disabled, but if they are
285 * allowed then so are Resume-Detect interrupts.
289 if (!rhdev->do_remote_wakeup)
294 /* EGSM causes the root hub to echo a 'K' signal (resume) out any
295 * port which requests a remote wakeup. According to the USB spec,
296 * every hub is supposed to do this. But if we are ignoring
297 * remote-wakeup requests anyway then there's no point to it.
298 * We also shouldn't enable EGSM if it's broken.
300 if (!wakeup_enable || global_suspend_mode_is_broken(uhci))
303 /* If we're ignoring wakeup events then there's no reason to
304 * enable Resume-Detect interrupts. We also shouldn't enable
305 * them if they are broken or disallowed.
307 * This logic may lead us to enabling RD but not EGSM. The UHCI
308 * spec foolishly says that RD works only when EGSM is on, but
309 * there's no harm in enabling it anyway -- perhaps some chips
312 if (!wakeup_enable || resume_detect_interrupts_are_broken(uhci) ||
314 uhci->RD_enable = int_enable = 0;
316 outw(int_enable, uhci->io_addr + USBINTR);
317 outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
321 /* If we're auto-stopping then no devices have been attached
322 * for a while, so there shouldn't be any active URBs and the
323 * controller should stop after a few microseconds. Otherwise
324 * we will give the controller one frame to stop.
326 if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
327 uhci->rh_state = UHCI_RH_SUSPENDING;
328 spin_unlock_irq(&uhci->lock);
330 spin_lock_irq(&uhci->lock);
334 if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
335 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
337 uhci_get_current_frame_number(uhci);
339 uhci->rh_state = new_state;
340 uhci->is_stopped = UHCI_IS_STOPPED;
342 /* If interrupts don't work and remote wakeup is enabled then
343 * the suspended root hub needs to be polled.
345 if (!int_enable && wakeup_enable)
346 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
348 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
350 uhci_scan_schedule(uhci);
354 static void start_rh(struct uhci_hcd *uhci)
356 uhci->is_stopped = 0;
358 /* Mark it configured and running with a 64-byte max packet.
359 * All interrupts are enabled, even though RESUME won't do anything.
361 outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
362 outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
363 uhci->io_addr + USBINTR);
365 uhci->rh_state = UHCI_RH_RUNNING;
366 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
369 static void wakeup_rh(struct uhci_hcd *uhci)
370 __releases(uhci->lock)
371 __acquires(uhci->lock)
373 dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
375 uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
376 " (auto-start)" : "");
378 /* If we are auto-stopped then no devices are attached so there's
379 * no need for wakeup signals. Otherwise we send Global Resume
382 if (uhci->rh_state == UHCI_RH_SUSPENDED) {
385 /* Keep EGSM on if it was set before */
386 egsm = inw(uhci->io_addr + USBCMD) & USBCMD_EGSM;
387 uhci->rh_state = UHCI_RH_RESUMING;
388 outw(USBCMD_FGR | USBCMD_CF | egsm, uhci->io_addr + USBCMD);
389 spin_unlock_irq(&uhci->lock);
391 spin_lock_irq(&uhci->lock);
395 /* End Global Resume and wait for EOP to be sent */
396 outw(USBCMD_CF, uhci->io_addr + USBCMD);
399 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
400 dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
405 /* Restart root hub polling */
406 mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
409 static irqreturn_t uhci_irq(struct usb_hcd *hcd)
411 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
412 unsigned short status;
415 * Read the interrupt status, and write it back to clear the
416 * interrupt cause. Contrary to the UHCI specification, the
417 * "HC Halted" status bit is persistent: it is RO, not R/WC.
419 status = inw(uhci->io_addr + USBSTS);
420 if (!(status & ~USBSTS_HCH)) /* shared interrupt, not mine */
422 outw(status, uhci->io_addr + USBSTS); /* Clear it */
424 if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
425 if (status & USBSTS_HSE)
426 dev_err(uhci_dev(uhci), "host system error, "
428 if (status & USBSTS_HCPE)
429 dev_err(uhci_dev(uhci), "host controller process "
430 "error, something bad happened!\n");
431 if (status & USBSTS_HCH) {
432 spin_lock(&uhci->lock);
433 if (uhci->rh_state >= UHCI_RH_RUNNING) {
434 dev_err(uhci_dev(uhci),
435 "host controller halted, "
437 if (debug > 1 && errbuf) {
438 /* Print the schedule for debugging */
439 uhci_sprint_schedule(uhci,
446 /* Force a callback in case there are
448 mod_timer(&hcd->rh_timer, jiffies);
450 spin_unlock(&uhci->lock);
454 if (status & USBSTS_RD)
455 usb_hcd_poll_rh_status(hcd);
457 spin_lock(&uhci->lock);
458 uhci_scan_schedule(uhci);
459 spin_unlock(&uhci->lock);
466 * Store the current frame number in uhci->frame_number if the controller
467 * is running. Expand from 11 bits (of which we use only 10) to a
468 * full-sized integer.
470 * Like many other parts of the driver, this code relies on being polled
471 * more than once per second as long as the controller is running.
473 static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
475 if (!uhci->is_stopped) {
478 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
479 (UHCI_NUMFRAMES - 1);
480 uhci->frame_number += delta;
485 * De-allocate all resources
487 static void release_uhci(struct uhci_hcd *uhci)
491 if (DEBUG_CONFIGURED) {
492 spin_lock_irq(&uhci->lock);
493 uhci->is_initialized = 0;
494 spin_unlock_irq(&uhci->lock);
496 debugfs_remove(uhci->dentry);
499 for (i = 0; i < UHCI_NUM_SKELQH; i++)
500 uhci_free_qh(uhci, uhci->skelqh[i]);
502 uhci_free_td(uhci, uhci->term_td);
504 dma_pool_destroy(uhci->qh_pool);
506 dma_pool_destroy(uhci->td_pool);
508 kfree(uhci->frame_cpu);
510 dma_free_coherent(uhci_dev(uhci),
511 UHCI_NUMFRAMES * sizeof(*uhci->frame),
512 uhci->frame, uhci->frame_dma_handle);
515 static int uhci_init(struct usb_hcd *hcd)
517 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
518 unsigned io_size = (unsigned) hcd->rsrc_len;
521 uhci->io_addr = (unsigned long) hcd->rsrc_start;
523 /* The UHCI spec says devices must have 2 ports, and goes on to say
524 * they may have more but gives no way to determine how many there
525 * are. However according to the UHCI spec, Bit 7 of the port
526 * status and control register is always set to 1. So we try to
527 * use this to our advantage. Another common failure mode when
528 * a nonexistent register is addressed is to return all ones, so
529 * we test for that also.
531 for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
532 unsigned int portstatus;
534 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
535 if (!(portstatus & 0x0080) || portstatus == 0xffff)
539 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
541 /* Anything greater than 7 is weird so we'll ignore it. */
542 if (port > UHCI_RH_MAXCHILD) {
543 dev_info(uhci_dev(uhci), "port count misdetected? "
544 "forcing to 2 ports\n");
547 uhci->rh_numports = port;
549 /* Intel controllers report the OverCurrent bit active on.
550 * VIA controllers report it active off, so we'll adjust the
551 * bit value. (It's not standardized in the UHCI spec.)
553 if (to_pci_dev(uhci_dev(uhci))->vendor == PCI_VENDOR_ID_VIA)
556 /* HP's server management chip requires a longer port reset delay. */
557 if (to_pci_dev(uhci_dev(uhci))->vendor == PCI_VENDOR_ID_HP)
558 uhci->wait_for_hp = 1;
560 /* Kick BIOS off this hardware and reset if the controller
561 * isn't already safely quiescent.
563 check_and_reset_hc(uhci);
567 /* Make sure the controller is quiescent and that we're not using it
568 * any more. This is mainly for the benefit of programs which, like kexec,
569 * expect the hardware to be idle: not doing DMA or generating IRQs.
571 * This routine may be called in a damaged or failing kernel. Hence we
572 * do not acquire the spinlock before shutting down the controller.
574 static void uhci_shutdown(struct pci_dev *pdev)
576 struct usb_hcd *hcd = pci_get_drvdata(pdev);
578 uhci_hc_died(hcd_to_uhci(hcd));
582 * Allocate a frame list, and then setup the skeleton
584 * The hardware doesn't really know any difference
585 * in the queues, but the order does matter for the
586 * protocols higher up. The order in which the queues
587 * are encountered by the hardware is:
589 * - All isochronous events are handled before any
590 * of the queues. We don't do that here, because
591 * we'll create the actual TD entries on demand.
592 * - The first queue is the high-period interrupt queue.
593 * - The second queue is the period-1 interrupt and async
594 * (low-speed control, full-speed control, then bulk) queue.
595 * - The third queue is the terminating bandwidth reclamation queue,
596 * which contains no members, loops back to itself, and is present
597 * only when FSBR is on and there are no full-speed control or bulk QHs.
599 static int uhci_start(struct usb_hcd *hcd)
601 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
604 struct dentry __maybe_unused *dentry;
606 hcd->uses_new_polling = 1;
608 spin_lock_init(&uhci->lock);
609 setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
610 (unsigned long) uhci);
611 INIT_LIST_HEAD(&uhci->idle_qh_list);
612 init_waitqueue_head(&uhci->waitqh);
614 #ifdef UHCI_DEBUG_OPS
615 dentry = debugfs_create_file(hcd->self.bus_name,
616 S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
617 uhci, &uhci_debug_operations);
619 dev_err(uhci_dev(uhci), "couldn't create uhci debugfs entry\n");
622 uhci->dentry = dentry;
625 uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
626 UHCI_NUMFRAMES * sizeof(*uhci->frame),
627 &uhci->frame_dma_handle, 0);
629 dev_err(uhci_dev(uhci), "unable to allocate "
630 "consistent memory for frame list\n");
631 goto err_alloc_frame;
633 memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
635 uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
637 if (!uhci->frame_cpu) {
638 dev_err(uhci_dev(uhci), "unable to allocate "
639 "memory for frame pointers\n");
640 goto err_alloc_frame_cpu;
643 uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
644 sizeof(struct uhci_td), 16, 0);
645 if (!uhci->td_pool) {
646 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
647 goto err_create_td_pool;
650 uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
651 sizeof(struct uhci_qh), 16, 0);
652 if (!uhci->qh_pool) {
653 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
654 goto err_create_qh_pool;
657 uhci->term_td = uhci_alloc_td(uhci);
658 if (!uhci->term_td) {
659 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
660 goto err_alloc_term_td;
663 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
664 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
665 if (!uhci->skelqh[i]) {
666 dev_err(uhci_dev(uhci), "unable to allocate QH\n");
667 goto err_alloc_skelqh;
672 * 8 Interrupt queues; link all higher int queues to int1 = async
674 for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
675 uhci->skelqh[i]->link = LINK_TO_QH(uhci->skel_async_qh);
676 uhci->skel_async_qh->link = UHCI_PTR_TERM;
677 uhci->skel_term_qh->link = LINK_TO_QH(uhci->skel_term_qh);
679 /* This dummy TD is to work around a bug in Intel PIIX controllers */
680 uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
681 (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
682 uhci->term_td->link = UHCI_PTR_TERM;
683 uhci->skel_async_qh->element = uhci->skel_term_qh->element =
684 LINK_TO_TD(uhci->term_td);
687 * Fill the frame list: make all entries point to the proper
690 for (i = 0; i < UHCI_NUMFRAMES; i++) {
692 /* Only place we don't use the frame list routines */
693 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
697 * Some architectures require a full mb() to enforce completion of
698 * the memory writes above before the I/O transfers in configure_hc().
703 uhci->is_initialized = 1;
704 spin_lock_irq(&uhci->lock);
706 spin_unlock_irq(&uhci->lock);
713 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
715 uhci_free_qh(uhci, uhci->skelqh[i]);
718 uhci_free_td(uhci, uhci->term_td);
721 dma_pool_destroy(uhci->qh_pool);
724 dma_pool_destroy(uhci->td_pool);
727 kfree(uhci->frame_cpu);
730 dma_free_coherent(uhci_dev(uhci),
731 UHCI_NUMFRAMES * sizeof(*uhci->frame),
732 uhci->frame, uhci->frame_dma_handle);
735 debugfs_remove(uhci->dentry);
740 static void uhci_stop(struct usb_hcd *hcd)
742 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
744 spin_lock_irq(&uhci->lock);
745 if (HCD_HW_ACCESSIBLE(hcd) && !uhci->dead)
747 uhci_scan_schedule(uhci);
748 spin_unlock_irq(&uhci->lock);
749 synchronize_irq(hcd->irq);
751 del_timer_sync(&uhci->fsbr_timer);
756 static int uhci_rh_suspend(struct usb_hcd *hcd)
758 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
761 spin_lock_irq(&uhci->lock);
762 if (!HCD_HW_ACCESSIBLE(hcd))
765 ; /* Dead controllers tell no tales */
767 /* Once the controller is stopped, port resumes that are already
768 * in progress won't complete. Hence if remote wakeup is enabled
769 * for the root hub and any ports are in the middle of a resume or
770 * remote wakeup, we must fail the suspend.
772 else if (hcd->self.root_hub->do_remote_wakeup &&
773 uhci->resuming_ports) {
774 dev_dbg(uhci_dev(uhci), "suspend failed because a port "
778 suspend_rh(uhci, UHCI_RH_SUSPENDED);
779 spin_unlock_irq(&uhci->lock);
783 static int uhci_rh_resume(struct usb_hcd *hcd)
785 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
788 spin_lock_irq(&uhci->lock);
789 if (!HCD_HW_ACCESSIBLE(hcd))
791 else if (!uhci->dead)
793 spin_unlock_irq(&uhci->lock);
797 static int uhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
799 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
800 struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
803 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
805 spin_lock_irq(&uhci->lock);
806 if (!HCD_HW_ACCESSIBLE(hcd) || uhci->dead)
807 goto done_okay; /* Already suspended or dead */
809 if (uhci->rh_state > UHCI_RH_SUSPENDED) {
810 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
815 /* All PCI host controllers are required to disable IRQ generation
816 * at the source, so we must turn off PIRQ.
818 pci_write_config_word(pdev, USBLEGSUP, 0);
819 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
821 /* Enable platform-specific non-PME# wakeup */
823 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
824 pci_write_config_byte(pdev, USBRES_INTEL,
825 USBPORT1EN | USBPORT2EN);
829 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
831 spin_unlock_irq(&uhci->lock);
835 static int uhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
837 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
839 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
841 /* Since we aren't in D3 any more, it's safe to set this flag
842 * even if the controller was dead.
844 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
846 spin_lock_irq(&uhci->lock);
848 /* Make sure resume from hibernation re-enumerates everything */
850 uhci_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr);
854 /* The firmware may have changed the controller settings during
855 * a system wakeup. Check it and reconfigure to avoid problems.
858 check_and_reset_hc(uhci);
862 /* Tell the core if the controller had to be reset */
863 if (uhci->rh_state == UHCI_RH_RESET)
864 usb_root_hub_lost_power(hcd->self.root_hub);
866 spin_unlock_irq(&uhci->lock);
868 /* If interrupts don't work and remote wakeup is enabled then
869 * the suspended root hub needs to be polled.
871 if (!uhci->RD_enable && hcd->self.root_hub->do_remote_wakeup)
872 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
874 /* Does the root hub have a port wakeup pending? */
875 usb_hcd_poll_rh_status(hcd);
880 /* Wait until a particular device/endpoint's QH is idle, and free it */
881 static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
882 struct usb_host_endpoint *hep)
884 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
887 spin_lock_irq(&uhci->lock);
888 qh = (struct uhci_qh *) hep->hcpriv;
892 while (qh->state != QH_STATE_IDLE) {
894 spin_unlock_irq(&uhci->lock);
895 wait_event_interruptible(uhci->waitqh,
896 qh->state == QH_STATE_IDLE);
897 spin_lock_irq(&uhci->lock);
901 uhci_free_qh(uhci, qh);
903 spin_unlock_irq(&uhci->lock);
906 static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
908 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
909 unsigned frame_number;
912 /* Minimize latency by avoiding the spinlock */
913 frame_number = uhci->frame_number;
915 delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
916 (UHCI_NUMFRAMES - 1);
917 return frame_number + delta;
920 static const char hcd_name[] = "uhci_hcd";
922 static const struct hc_driver uhci_driver = {
923 .description = hcd_name,
924 .product_desc = "UHCI Host Controller",
925 .hcd_priv_size = sizeof(struct uhci_hcd),
927 /* Generic hardware linkage */
931 /* Basic lifecycle operations */
935 .pci_suspend = uhci_pci_suspend,
936 .pci_resume = uhci_pci_resume,
937 .bus_suspend = uhci_rh_suspend,
938 .bus_resume = uhci_rh_resume,
942 .urb_enqueue = uhci_urb_enqueue,
943 .urb_dequeue = uhci_urb_dequeue,
945 .endpoint_disable = uhci_hcd_endpoint_disable,
946 .get_frame_number = uhci_hcd_get_frame_number,
948 .hub_status_data = uhci_hub_status_data,
949 .hub_control = uhci_hub_control,
952 static const struct pci_device_id uhci_pci_ids[] = { {
953 /* handle any USB UHCI controller */
954 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
955 .driver_data = (unsigned long) &uhci_driver,
956 }, { /* end: all zeroes */ }
959 MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
961 static struct pci_driver uhci_pci_driver = {
962 .name = (char *)hcd_name,
963 .id_table = uhci_pci_ids,
965 .probe = usb_hcd_pci_probe,
966 .remove = usb_hcd_pci_remove,
967 .shutdown = uhci_shutdown,
969 #ifdef CONFIG_PM_SLEEP
971 .pm = &usb_hcd_pci_pm_ops
976 static int __init uhci_hcd_init(void)
978 int retval = -ENOMEM;
983 printk(KERN_INFO "uhci_hcd: " DRIVER_DESC "%s\n",
984 ignore_oc ? ", overcurrent ignored" : "");
985 set_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
987 if (DEBUG_CONFIGURED) {
988 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
991 uhci_debugfs_root = debugfs_create_dir("uhci", usb_debug_root);
992 if (!uhci_debugfs_root)
996 uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
997 sizeof(struct urb_priv), 0, 0, NULL);
1001 retval = pci_register_driver(&uhci_pci_driver);
1008 kmem_cache_destroy(uhci_up_cachep);
1011 debugfs_remove(uhci_debugfs_root);
1018 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
1022 static void __exit uhci_hcd_cleanup(void)
1024 pci_unregister_driver(&uhci_pci_driver);
1025 kmem_cache_destroy(uhci_up_cachep);
1026 debugfs_remove(uhci_debugfs_root);
1028 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
1031 module_init(uhci_hcd_init);
1032 module_exit(uhci_hcd_cleanup);
1034 MODULE_AUTHOR(DRIVER_AUTHOR);
1035 MODULE_DESCRIPTION(DRIVER_DESC);
1036 MODULE_LICENSE("GPL");