treewide: cleanup continuations and remove logging message whitespace
[linux-2.6.git] / drivers / usb / host / uhci-hcd.c
1 /*
2  * Universal Host Controller Interface driver for USB.
3  *
4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5  *
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
17  *
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.
22  *
23  */
24
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>
37 #include <linux/pm.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>
44
45 #include <asm/uaccess.h>
46 #include <asm/io.h>
47 #include <asm/irq.h>
48 #include <asm/system.h>
49
50 #include "uhci-hcd.h"
51 #include "pci-quirks.h"
52
53 /*
54  * Version Information
55  */
56 #define DRIVER_AUTHOR                                                   \
57         "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, "             \
58         "Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, "       \
59         "Roman Weissgaerber, Alan Stern"
60 #define DRIVER_DESC "USB Universal Host Controller Interface driver"
61
62 /* for flakey hardware, ignore overcurrent indicators */
63 static int ignore_oc;
64 module_param(ignore_oc, bool, S_IRUGO);
65 MODULE_PARM_DESC(ignore_oc, "ignore hardware overcurrent indications");
66
67 /*
68  * debug = 0, no debugging messages
69  * debug = 1, dump failed URBs except for stalls
70  * debug = 2, dump all failed URBs (including stalls)
71  *            show all queues in /sys/kernel/debug/uhci/[pci_addr]
72  * debug = 3, show all TDs in URBs when dumping
73  */
74 #ifdef DEBUG
75 #define DEBUG_CONFIGURED        1
76 static int debug = 1;
77 module_param(debug, int, S_IRUGO | S_IWUSR);
78 MODULE_PARM_DESC(debug, "Debug level");
79
80 #else
81 #define DEBUG_CONFIGURED        0
82 #define debug                   0
83 #endif
84
85 static char *errbuf;
86 #define ERRBUF_LEN    (32 * 1024)
87
88 static struct kmem_cache *uhci_up_cachep;       /* urb_priv */
89
90 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state);
91 static void wakeup_rh(struct uhci_hcd *uhci);
92 static void uhci_get_current_frame_number(struct uhci_hcd *uhci);
93
94 /*
95  * Calculate the link pointer DMA value for the first Skeleton QH in a frame.
96  */
97 static __le32 uhci_frame_skel_link(struct uhci_hcd *uhci, int frame)
98 {
99         int skelnum;
100
101         /*
102          * The interrupt queues will be interleaved as evenly as possible.
103          * There's not much to be done about period-1 interrupts; they have
104          * to occur in every frame.  But we can schedule period-2 interrupts
105          * in odd-numbered frames, period-4 interrupts in frames congruent
106          * to 2 (mod 4), and so on.  This way each frame only has two
107          * interrupt QHs, which will help spread out bandwidth utilization.
108          *
109          * ffs (Find First bit Set) does exactly what we need:
110          * 1,3,5,...  => ffs = 0 => use period-2 QH = skelqh[8],
111          * 2,6,10,... => ffs = 1 => use period-4 QH = skelqh[7], etc.
112          * ffs >= 7 => not on any high-period queue, so use
113          *      period-1 QH = skelqh[9].
114          * Add in UHCI_NUMFRAMES to insure at least one bit is set.
115          */
116         skelnum = 8 - (int) __ffs(frame | UHCI_NUMFRAMES);
117         if (skelnum <= 1)
118                 skelnum = 9;
119         return LINK_TO_QH(uhci->skelqh[skelnum]);
120 }
121
122 #include "uhci-debug.c"
123 #include "uhci-q.c"
124 #include "uhci-hub.c"
125
126 /*
127  * Finish up a host controller reset and update the recorded state.
128  */
129 static void finish_reset(struct uhci_hcd *uhci)
130 {
131         int port;
132
133         /* HCRESET doesn't affect the Suspend, Reset, and Resume Detect
134          * bits in the port status and control registers.
135          * We have to clear them by hand.
136          */
137         for (port = 0; port < uhci->rh_numports; ++port)
138                 outw(0, uhci->io_addr + USBPORTSC1 + (port * 2));
139
140         uhci->port_c_suspend = uhci->resuming_ports = 0;
141         uhci->rh_state = UHCI_RH_RESET;
142         uhci->is_stopped = UHCI_IS_STOPPED;
143         uhci_to_hcd(uhci)->state = HC_STATE_HALT;
144         clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
145
146         uhci->dead = 0;         /* Full reset resurrects the controller */
147 }
148
149 /*
150  * Last rites for a defunct/nonfunctional controller
151  * or one we don't want to use any more.
152  */
153 static void uhci_hc_died(struct uhci_hcd *uhci)
154 {
155         uhci_get_current_frame_number(uhci);
156         uhci_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr);
157         finish_reset(uhci);
158         uhci->dead = 1;
159
160         /* The current frame may already be partway finished */
161         ++uhci->frame_number;
162 }
163
164 /*
165  * Initialize a controller that was newly discovered or has lost power
166  * or otherwise been reset while it was suspended.  In none of these cases
167  * can we be sure of its previous state.
168  */
169 static void check_and_reset_hc(struct uhci_hcd *uhci)
170 {
171         if (uhci_check_and_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr))
172                 finish_reset(uhci);
173 }
174
175 /*
176  * Store the basic register settings needed by the controller.
177  */
178 static void configure_hc(struct uhci_hcd *uhci)
179 {
180         struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
181
182         /* Set the frame length to the default: 1 ms exactly */
183         outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
184
185         /* Store the frame list base address */
186         outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
187
188         /* Set the current frame number */
189         outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
190                         uhci->io_addr + USBFRNUM);
191
192         /* Mark controller as not halted before we enable interrupts */
193         uhci_to_hcd(uhci)->state = HC_STATE_SUSPENDED;
194         mb();
195
196         /* Enable PIRQ */
197         pci_write_config_word(pdev, USBLEGSUP, USBLEGSUP_DEFAULT);
198
199         /* Disable platform-specific non-PME# wakeup */
200         if (pdev->vendor == PCI_VENDOR_ID_INTEL)
201                 pci_write_config_byte(pdev, USBRES_INTEL, 0);
202 }
203
204
205 static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
206 {
207         int port;
208
209         /* If we have to ignore overcurrent events then almost by definition
210          * we can't depend on resume-detect interrupts. */
211         if (ignore_oc)
212                 return 1;
213
214         switch (to_pci_dev(uhci_dev(uhci))->vendor) {
215             default:
216                 break;
217
218             case PCI_VENDOR_ID_GENESYS:
219                 /* Genesys Logic's GL880S controllers don't generate
220                  * resume-detect interrupts.
221                  */
222                 return 1;
223
224             case PCI_VENDOR_ID_INTEL:
225                 /* Some of Intel's USB controllers have a bug that causes
226                  * resume-detect interrupts if any port has an over-current
227                  * condition.  To make matters worse, some motherboards
228                  * hardwire unused USB ports' over-current inputs active!
229                  * To prevent problems, we will not enable resume-detect
230                  * interrupts if any ports are OC.
231                  */
232                 for (port = 0; port < uhci->rh_numports; ++port) {
233                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
234                                         USBPORTSC_OC)
235                                 return 1;
236                 }
237                 break;
238         }
239         return 0;
240 }
241
242 static int global_suspend_mode_is_broken(struct uhci_hcd *uhci)
243 {
244         int port;
245         const char *sys_info;
246         static char bad_Asus_board[] = "A7V8X";
247
248         /* One of Asus's motherboards has a bug which causes it to
249          * wake up immediately from suspend-to-RAM if any of the ports
250          * are connected.  In such cases we will not set EGSM.
251          */
252         sys_info = dmi_get_system_info(DMI_BOARD_NAME);
253         if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
254                 for (port = 0; port < uhci->rh_numports; ++port) {
255                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
256                                         USBPORTSC_CCS)
257                                 return 1;
258                 }
259         }
260
261         return 0;
262 }
263
264 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
265 __releases(uhci->lock)
266 __acquires(uhci->lock)
267 {
268         int auto_stop;
269         int int_enable, egsm_enable, wakeup_enable;
270         struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
271
272         auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
273         dev_dbg(&rhdev->dev, "%s%s\n", __func__,
274                         (auto_stop ? " (auto-stop)" : ""));
275
276         /* Start off by assuming Resume-Detect interrupts and EGSM work
277          * and that remote wakeups should be enabled.
278          */
279         egsm_enable = USBCMD_EGSM;
280         uhci->RD_enable = 1;
281         int_enable = USBINTR_RESUME;
282         wakeup_enable = 1;
283
284         /* In auto-stop mode wakeups must always be detected, but
285          * Resume-Detect interrupts may be prohibited.  (In the absence
286          * of CONFIG_PM, they are always disallowed.)
287          */
288         if (auto_stop) {
289                 if (!device_may_wakeup(&rhdev->dev))
290                         int_enable = 0;
291
292         /* In bus-suspend mode wakeups may be disabled, but if they are
293          * allowed then so are Resume-Detect interrupts.
294          */
295         } else {
296 #ifdef CONFIG_PM
297                 if (!rhdev->do_remote_wakeup)
298                         wakeup_enable = 0;
299 #endif
300         }
301
302         /* EGSM causes the root hub to echo a 'K' signal (resume) out any
303          * port which requests a remote wakeup.  According to the USB spec,
304          * every hub is supposed to do this.  But if we are ignoring
305          * remote-wakeup requests anyway then there's no point to it.
306          * We also shouldn't enable EGSM if it's broken.
307          */
308         if (!wakeup_enable || global_suspend_mode_is_broken(uhci))
309                 egsm_enable = 0;
310
311         /* If we're ignoring wakeup events then there's no reason to
312          * enable Resume-Detect interrupts.  We also shouldn't enable
313          * them if they are broken or disallowed.
314          *
315          * This logic may lead us to enabling RD but not EGSM.  The UHCI
316          * spec foolishly says that RD works only when EGSM is on, but
317          * there's no harm in enabling it anyway -- perhaps some chips
318          * will implement it!
319          */
320         if (!wakeup_enable || resume_detect_interrupts_are_broken(uhci) ||
321                         !int_enable)
322                 uhci->RD_enable = int_enable = 0;
323
324         outw(int_enable, uhci->io_addr + USBINTR);
325         outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
326         mb();
327         udelay(5);
328
329         /* If we're auto-stopping then no devices have been attached
330          * for a while, so there shouldn't be any active URBs and the
331          * controller should stop after a few microseconds.  Otherwise
332          * we will give the controller one frame to stop.
333          */
334         if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
335                 uhci->rh_state = UHCI_RH_SUSPENDING;
336                 spin_unlock_irq(&uhci->lock);
337                 msleep(1);
338                 spin_lock_irq(&uhci->lock);
339                 if (uhci->dead)
340                         return;
341         }
342         if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
343                 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
344
345         uhci_get_current_frame_number(uhci);
346
347         uhci->rh_state = new_state;
348         uhci->is_stopped = UHCI_IS_STOPPED;
349
350         /* If interrupts don't work and remote wakeup is enabled then
351          * the suspended root hub needs to be polled.
352          */
353         if (!int_enable && wakeup_enable)
354                 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
355         else
356                 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
357
358         uhci_scan_schedule(uhci);
359         uhci_fsbr_off(uhci);
360 }
361
362 static void start_rh(struct uhci_hcd *uhci)
363 {
364         uhci_to_hcd(uhci)->state = HC_STATE_RUNNING;
365         uhci->is_stopped = 0;
366
367         /* Mark it configured and running with a 64-byte max packet.
368          * All interrupts are enabled, even though RESUME won't do anything.
369          */
370         outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
371         outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
372                         uhci->io_addr + USBINTR);
373         mb();
374         uhci->rh_state = UHCI_RH_RUNNING;
375         set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
376 }
377
378 static void wakeup_rh(struct uhci_hcd *uhci)
379 __releases(uhci->lock)
380 __acquires(uhci->lock)
381 {
382         dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
383                         "%s%s\n", __func__,
384                         uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
385                                 " (auto-start)" : "");
386
387         /* If we are auto-stopped then no devices are attached so there's
388          * no need for wakeup signals.  Otherwise we send Global Resume
389          * for 20 ms.
390          */
391         if (uhci->rh_state == UHCI_RH_SUSPENDED) {
392                 unsigned egsm;
393
394                 /* Keep EGSM on if it was set before */
395                 egsm = inw(uhci->io_addr + USBCMD) & USBCMD_EGSM;
396                 uhci->rh_state = UHCI_RH_RESUMING;
397                 outw(USBCMD_FGR | USBCMD_CF | egsm, uhci->io_addr + USBCMD);
398                 spin_unlock_irq(&uhci->lock);
399                 msleep(20);
400                 spin_lock_irq(&uhci->lock);
401                 if (uhci->dead)
402                         return;
403
404                 /* End Global Resume and wait for EOP to be sent */
405                 outw(USBCMD_CF, uhci->io_addr + USBCMD);
406                 mb();
407                 udelay(4);
408                 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
409                         dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
410         }
411
412         start_rh(uhci);
413
414         /* Restart root hub polling */
415         mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
416 }
417
418 static irqreturn_t uhci_irq(struct usb_hcd *hcd)
419 {
420         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
421         unsigned short status;
422
423         /*
424          * Read the interrupt status, and write it back to clear the
425          * interrupt cause.  Contrary to the UHCI specification, the
426          * "HC Halted" status bit is persistent: it is RO, not R/WC.
427          */
428         status = inw(uhci->io_addr + USBSTS);
429         if (!(status & ~USBSTS_HCH))    /* shared interrupt, not mine */
430                 return IRQ_NONE;
431         outw(status, uhci->io_addr + USBSTS);           /* Clear it */
432
433         if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
434                 if (status & USBSTS_HSE)
435                         dev_err(uhci_dev(uhci), "host system error, "
436                                         "PCI problems?\n");
437                 if (status & USBSTS_HCPE)
438                         dev_err(uhci_dev(uhci), "host controller process "
439                                         "error, something bad happened!\n");
440                 if (status & USBSTS_HCH) {
441                         spin_lock(&uhci->lock);
442                         if (uhci->rh_state >= UHCI_RH_RUNNING) {
443                                 dev_err(uhci_dev(uhci),
444                                         "host controller halted, "
445                                         "very bad!\n");
446                                 if (debug > 1 && errbuf) {
447                                         /* Print the schedule for debugging */
448                                         uhci_sprint_schedule(uhci,
449                                                         errbuf, ERRBUF_LEN);
450                                         lprintk(errbuf);
451                                 }
452                                 uhci_hc_died(uhci);
453
454                                 /* Force a callback in case there are
455                                  * pending unlinks */
456                                 mod_timer(&hcd->rh_timer, jiffies);
457                         }
458                         spin_unlock(&uhci->lock);
459                 }
460         }
461
462         if (status & USBSTS_RD)
463                 usb_hcd_poll_rh_status(hcd);
464         else {
465                 spin_lock(&uhci->lock);
466                 uhci_scan_schedule(uhci);
467                 spin_unlock(&uhci->lock);
468         }
469
470         return IRQ_HANDLED;
471 }
472
473 /*
474  * Store the current frame number in uhci->frame_number if the controller
475  * is running.  Expand from 11 bits (of which we use only 10) to a
476  * full-sized integer.
477  *
478  * Like many other parts of the driver, this code relies on being polled
479  * more than once per second as long as the controller is running.
480  */
481 static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
482 {
483         if (!uhci->is_stopped) {
484                 unsigned delta;
485
486                 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
487                                 (UHCI_NUMFRAMES - 1);
488                 uhci->frame_number += delta;
489         }
490 }
491
492 /*
493  * De-allocate all resources
494  */
495 static void release_uhci(struct uhci_hcd *uhci)
496 {
497         int i;
498
499         if (DEBUG_CONFIGURED) {
500                 spin_lock_irq(&uhci->lock);
501                 uhci->is_initialized = 0;
502                 spin_unlock_irq(&uhci->lock);
503
504                 debugfs_remove(uhci->dentry);
505         }
506
507         for (i = 0; i < UHCI_NUM_SKELQH; i++)
508                 uhci_free_qh(uhci, uhci->skelqh[i]);
509
510         uhci_free_td(uhci, uhci->term_td);
511
512         dma_pool_destroy(uhci->qh_pool);
513
514         dma_pool_destroy(uhci->td_pool);
515
516         kfree(uhci->frame_cpu);
517
518         dma_free_coherent(uhci_dev(uhci),
519                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
520                         uhci->frame, uhci->frame_dma_handle);
521 }
522
523 static int uhci_init(struct usb_hcd *hcd)
524 {
525         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
526         unsigned io_size = (unsigned) hcd->rsrc_len;
527         int port;
528
529         uhci->io_addr = (unsigned long) hcd->rsrc_start;
530
531         /* The UHCI spec says devices must have 2 ports, and goes on to say
532          * they may have more but gives no way to determine how many there
533          * are.  However according to the UHCI spec, Bit 7 of the port
534          * status and control register is always set to 1.  So we try to
535          * use this to our advantage.  Another common failure mode when
536          * a nonexistent register is addressed is to return all ones, so
537          * we test for that also.
538          */
539         for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
540                 unsigned int portstatus;
541
542                 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
543                 if (!(portstatus & 0x0080) || portstatus == 0xffff)
544                         break;
545         }
546         if (debug)
547                 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
548
549         /* Anything greater than 7 is weird so we'll ignore it. */
550         if (port > UHCI_RH_MAXCHILD) {
551                 dev_info(uhci_dev(uhci), "port count misdetected? "
552                                 "forcing to 2 ports\n");
553                 port = 2;
554         }
555         uhci->rh_numports = port;
556
557         /* Kick BIOS off this hardware and reset if the controller
558          * isn't already safely quiescent.
559          */
560         check_and_reset_hc(uhci);
561         return 0;
562 }
563
564 /* Make sure the controller is quiescent and that we're not using it
565  * any more.  This is mainly for the benefit of programs which, like kexec,
566  * expect the hardware to be idle: not doing DMA or generating IRQs.
567  *
568  * This routine may be called in a damaged or failing kernel.  Hence we
569  * do not acquire the spinlock before shutting down the controller.
570  */
571 static void uhci_shutdown(struct pci_dev *pdev)
572 {
573         struct usb_hcd *hcd = pci_get_drvdata(pdev);
574
575         uhci_hc_died(hcd_to_uhci(hcd));
576 }
577
578 /*
579  * Allocate a frame list, and then setup the skeleton
580  *
581  * The hardware doesn't really know any difference
582  * in the queues, but the order does matter for the
583  * protocols higher up.  The order in which the queues
584  * are encountered by the hardware is:
585  *
586  *  - All isochronous events are handled before any
587  *    of the queues. We don't do that here, because
588  *    we'll create the actual TD entries on demand.
589  *  - The first queue is the high-period interrupt queue.
590  *  - The second queue is the period-1 interrupt and async
591  *    (low-speed control, full-speed control, then bulk) queue.
592  *  - The third queue is the terminating bandwidth reclamation queue,
593  *    which contains no members, loops back to itself, and is present
594  *    only when FSBR is on and there are no full-speed control or bulk QHs.
595  */
596 static int uhci_start(struct usb_hcd *hcd)
597 {
598         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
599         int retval = -EBUSY;
600         int i;
601         struct dentry __maybe_unused *dentry;
602
603         hcd->uses_new_polling = 1;
604
605         spin_lock_init(&uhci->lock);
606         setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
607                         (unsigned long) uhci);
608         INIT_LIST_HEAD(&uhci->idle_qh_list);
609         init_waitqueue_head(&uhci->waitqh);
610
611 #ifdef UHCI_DEBUG_OPS
612         dentry = debugfs_create_file(hcd->self.bus_name,
613                         S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
614                         uhci, &uhci_debug_operations);
615         if (!dentry) {
616                 dev_err(uhci_dev(uhci), "couldn't create uhci debugfs entry\n");
617                 return -ENOMEM;
618         }
619         uhci->dentry = dentry;
620 #endif
621
622         uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
623                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
624                         &uhci->frame_dma_handle, 0);
625         if (!uhci->frame) {
626                 dev_err(uhci_dev(uhci), "unable to allocate "
627                                 "consistent memory for frame list\n");
628                 goto err_alloc_frame;
629         }
630         memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
631
632         uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
633                         GFP_KERNEL);
634         if (!uhci->frame_cpu) {
635                 dev_err(uhci_dev(uhci), "unable to allocate "
636                                 "memory for frame pointers\n");
637                 goto err_alloc_frame_cpu;
638         }
639
640         uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
641                         sizeof(struct uhci_td), 16, 0);
642         if (!uhci->td_pool) {
643                 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
644                 goto err_create_td_pool;
645         }
646
647         uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
648                         sizeof(struct uhci_qh), 16, 0);
649         if (!uhci->qh_pool) {
650                 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
651                 goto err_create_qh_pool;
652         }
653
654         uhci->term_td = uhci_alloc_td(uhci);
655         if (!uhci->term_td) {
656                 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
657                 goto err_alloc_term_td;
658         }
659
660         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
661                 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
662                 if (!uhci->skelqh[i]) {
663                         dev_err(uhci_dev(uhci), "unable to allocate QH\n");
664                         goto err_alloc_skelqh;
665                 }
666         }
667
668         /*
669          * 8 Interrupt queues; link all higher int queues to int1 = async
670          */
671         for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
672                 uhci->skelqh[i]->link = LINK_TO_QH(uhci->skel_async_qh);
673         uhci->skel_async_qh->link = UHCI_PTR_TERM;
674         uhci->skel_term_qh->link = LINK_TO_QH(uhci->skel_term_qh);
675
676         /* This dummy TD is to work around a bug in Intel PIIX controllers */
677         uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
678                         (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
679         uhci->term_td->link = UHCI_PTR_TERM;
680         uhci->skel_async_qh->element = uhci->skel_term_qh->element =
681                         LINK_TO_TD(uhci->term_td);
682
683         /*
684          * Fill the frame list: make all entries point to the proper
685          * interrupt queue.
686          */
687         for (i = 0; i < UHCI_NUMFRAMES; i++) {
688
689                 /* Only place we don't use the frame list routines */
690                 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
691         }
692
693         /*
694          * Some architectures require a full mb() to enforce completion of
695          * the memory writes above before the I/O transfers in configure_hc().
696          */
697         mb();
698
699         configure_hc(uhci);
700         uhci->is_initialized = 1;
701         spin_lock_irq(&uhci->lock);
702         start_rh(uhci);
703         spin_unlock_irq(&uhci->lock);
704         return 0;
705
706 /*
707  * error exits:
708  */
709 err_alloc_skelqh:
710         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
711                 if (uhci->skelqh[i])
712                         uhci_free_qh(uhci, uhci->skelqh[i]);
713         }
714
715         uhci_free_td(uhci, uhci->term_td);
716
717 err_alloc_term_td:
718         dma_pool_destroy(uhci->qh_pool);
719
720 err_create_qh_pool:
721         dma_pool_destroy(uhci->td_pool);
722
723 err_create_td_pool:
724         kfree(uhci->frame_cpu);
725
726 err_alloc_frame_cpu:
727         dma_free_coherent(uhci_dev(uhci),
728                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
729                         uhci->frame, uhci->frame_dma_handle);
730
731 err_alloc_frame:
732         debugfs_remove(uhci->dentry);
733
734         return retval;
735 }
736
737 static void uhci_stop(struct usb_hcd *hcd)
738 {
739         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
740
741         spin_lock_irq(&uhci->lock);
742         if (HCD_HW_ACCESSIBLE(hcd) && !uhci->dead)
743                 uhci_hc_died(uhci);
744         uhci_scan_schedule(uhci);
745         spin_unlock_irq(&uhci->lock);
746         synchronize_irq(hcd->irq);
747
748         del_timer_sync(&uhci->fsbr_timer);
749         release_uhci(uhci);
750 }
751
752 #ifdef CONFIG_PM
753 static int uhci_rh_suspend(struct usb_hcd *hcd)
754 {
755         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
756         int rc = 0;
757
758         spin_lock_irq(&uhci->lock);
759         if (!HCD_HW_ACCESSIBLE(hcd))
760                 rc = -ESHUTDOWN;
761         else if (uhci->dead)
762                 ;               /* Dead controllers tell no tales */
763
764         /* Once the controller is stopped, port resumes that are already
765          * in progress won't complete.  Hence if remote wakeup is enabled
766          * for the root hub and any ports are in the middle of a resume or
767          * remote wakeup, we must fail the suspend.
768          */
769         else if (hcd->self.root_hub->do_remote_wakeup &&
770                         uhci->resuming_ports) {
771                 dev_dbg(uhci_dev(uhci), "suspend failed because a port "
772                                 "is resuming\n");
773                 rc = -EBUSY;
774         } else
775                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
776         spin_unlock_irq(&uhci->lock);
777         return rc;
778 }
779
780 static int uhci_rh_resume(struct usb_hcd *hcd)
781 {
782         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
783         int rc = 0;
784
785         spin_lock_irq(&uhci->lock);
786         if (!HCD_HW_ACCESSIBLE(hcd))
787                 rc = -ESHUTDOWN;
788         else if (!uhci->dead)
789                 wakeup_rh(uhci);
790         spin_unlock_irq(&uhci->lock);
791         return rc;
792 }
793
794 static int uhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
795 {
796         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
797         struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
798         int rc = 0;
799
800         dev_dbg(uhci_dev(uhci), "%s\n", __func__);
801
802         spin_lock_irq(&uhci->lock);
803         if (!HCD_HW_ACCESSIBLE(hcd) || uhci->dead)
804                 goto done_okay;         /* Already suspended or dead */
805
806         if (uhci->rh_state > UHCI_RH_SUSPENDED) {
807                 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
808                 rc = -EBUSY;
809                 goto done;
810         };
811
812         /* All PCI host controllers are required to disable IRQ generation
813          * at the source, so we must turn off PIRQ.
814          */
815         pci_write_config_word(pdev, USBLEGSUP, 0);
816         clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
817
818         /* Enable platform-specific non-PME# wakeup */
819         if (do_wakeup) {
820                 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
821                         pci_write_config_byte(pdev, USBRES_INTEL,
822                                         USBPORT1EN | USBPORT2EN);
823         }
824
825 done_okay:
826         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
827 done:
828         spin_unlock_irq(&uhci->lock);
829         return rc;
830 }
831
832 static int uhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
833 {
834         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
835
836         dev_dbg(uhci_dev(uhci), "%s\n", __func__);
837
838         /* Since we aren't in D3 any more, it's safe to set this flag
839          * even if the controller was dead.
840          */
841         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
842
843         spin_lock_irq(&uhci->lock);
844
845         /* Make sure resume from hibernation re-enumerates everything */
846         if (hibernated)
847                 uhci_hc_died(uhci);
848
849         /* The firmware or a boot kernel may have changed the controller
850          * settings during a system wakeup.  Check it and reconfigure
851          * to avoid problems.
852          */
853         check_and_reset_hc(uhci);
854
855         /* If the controller was dead before, it's back alive now */
856         configure_hc(uhci);
857
858         /* Tell the core if the controller had to be reset */
859         if (uhci->rh_state == UHCI_RH_RESET)
860                 usb_root_hub_lost_power(hcd->self.root_hub);
861
862         spin_unlock_irq(&uhci->lock);
863
864         /* If interrupts don't work and remote wakeup is enabled then
865          * the suspended root hub needs to be polled.
866          */
867         if (!uhci->RD_enable && hcd->self.root_hub->do_remote_wakeup)
868                 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
869
870         /* Does the root hub have a port wakeup pending? */
871         usb_hcd_poll_rh_status(hcd);
872         return 0;
873 }
874 #endif
875
876 /* Wait until a particular device/endpoint's QH is idle, and free it */
877 static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
878                 struct usb_host_endpoint *hep)
879 {
880         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
881         struct uhci_qh *qh;
882
883         spin_lock_irq(&uhci->lock);
884         qh = (struct uhci_qh *) hep->hcpriv;
885         if (qh == NULL)
886                 goto done;
887
888         while (qh->state != QH_STATE_IDLE) {
889                 ++uhci->num_waiting;
890                 spin_unlock_irq(&uhci->lock);
891                 wait_event_interruptible(uhci->waitqh,
892                                 qh->state == QH_STATE_IDLE);
893                 spin_lock_irq(&uhci->lock);
894                 --uhci->num_waiting;
895         }
896
897         uhci_free_qh(uhci, qh);
898 done:
899         spin_unlock_irq(&uhci->lock);
900 }
901
902 static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
903 {
904         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
905         unsigned frame_number;
906         unsigned delta;
907
908         /* Minimize latency by avoiding the spinlock */
909         frame_number = uhci->frame_number;
910         barrier();
911         delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
912                         (UHCI_NUMFRAMES - 1);
913         return frame_number + delta;
914 }
915
916 static const char hcd_name[] = "uhci_hcd";
917
918 static const struct hc_driver uhci_driver = {
919         .description =          hcd_name,
920         .product_desc =         "UHCI Host Controller",
921         .hcd_priv_size =        sizeof(struct uhci_hcd),
922
923         /* Generic hardware linkage */
924         .irq =                  uhci_irq,
925         .flags =                HCD_USB11,
926
927         /* Basic lifecycle operations */
928         .reset =                uhci_init,
929         .start =                uhci_start,
930 #ifdef CONFIG_PM
931         .pci_suspend =          uhci_pci_suspend,
932         .pci_resume =           uhci_pci_resume,
933         .bus_suspend =          uhci_rh_suspend,
934         .bus_resume =           uhci_rh_resume,
935 #endif
936         .stop =                 uhci_stop,
937
938         .urb_enqueue =          uhci_urb_enqueue,
939         .urb_dequeue =          uhci_urb_dequeue,
940
941         .endpoint_disable =     uhci_hcd_endpoint_disable,
942         .get_frame_number =     uhci_hcd_get_frame_number,
943
944         .hub_status_data =      uhci_hub_status_data,
945         .hub_control =          uhci_hub_control,
946 };
947
948 static const struct pci_device_id uhci_pci_ids[] = { {
949         /* handle any USB UHCI controller */
950         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
951         .driver_data =  (unsigned long) &uhci_driver,
952         }, { /* end: all zeroes */ }
953 };
954
955 MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
956
957 static struct pci_driver uhci_pci_driver = {
958         .name =         (char *)hcd_name,
959         .id_table =     uhci_pci_ids,
960
961         .probe =        usb_hcd_pci_probe,
962         .remove =       usb_hcd_pci_remove,
963         .shutdown =     uhci_shutdown,
964
965 #ifdef CONFIG_PM_SLEEP
966         .driver =       {
967                 .pm =   &usb_hcd_pci_pm_ops
968         },
969 #endif
970 };
971  
972 static int __init uhci_hcd_init(void)
973 {
974         int retval = -ENOMEM;
975
976         if (usb_disabled())
977                 return -ENODEV;
978
979         printk(KERN_INFO "uhci_hcd: " DRIVER_DESC "%s\n",
980                         ignore_oc ? ", overcurrent ignored" : "");
981         set_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
982
983         if (DEBUG_CONFIGURED) {
984                 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
985                 if (!errbuf)
986                         goto errbuf_failed;
987                 uhci_debugfs_root = debugfs_create_dir("uhci", usb_debug_root);
988                 if (!uhci_debugfs_root)
989                         goto debug_failed;
990         }
991
992         uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
993                 sizeof(struct urb_priv), 0, 0, NULL);
994         if (!uhci_up_cachep)
995                 goto up_failed;
996
997         retval = pci_register_driver(&uhci_pci_driver);
998         if (retval)
999                 goto init_failed;
1000
1001         return 0;
1002
1003 init_failed:
1004         kmem_cache_destroy(uhci_up_cachep);
1005
1006 up_failed:
1007         debugfs_remove(uhci_debugfs_root);
1008
1009 debug_failed:
1010         kfree(errbuf);
1011
1012 errbuf_failed:
1013
1014         clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
1015         return retval;
1016 }
1017
1018 static void __exit uhci_hcd_cleanup(void) 
1019 {
1020         pci_unregister_driver(&uhci_pci_driver);
1021         kmem_cache_destroy(uhci_up_cachep);
1022         debugfs_remove(uhci_debugfs_root);
1023         kfree(errbuf);
1024         clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
1025 }
1026
1027 module_init(uhci_hcd_init);
1028 module_exit(uhci_hcd_cleanup);
1029
1030 MODULE_AUTHOR(DRIVER_AUTHOR);
1031 MODULE_DESCRIPTION(DRIVER_DESC);
1032 MODULE_LICENSE("GPL");