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