USB: replace remaining __FUNCTION__ occurrences
[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/bitops.h>
42 #include <linux/dmi.h>
43
44 #include <asm/uaccess.h>
45 #include <asm/io.h>
46 #include <asm/irq.h>
47 #include <asm/system.h>
48
49 #include "../core/hcd.h"
50 #include "uhci-hcd.h"
51 #include "pci-quirks.h"
52
53 /*
54  * Version Information
55  */
56 #define DRIVER_VERSION "v3.0"
57 #define DRIVER_AUTHOR "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, \
58 Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, Roman Weissgaerber, \
59 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 /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         uhci_to_hcd(uhci)->poll_rh = 0;
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         /* Set the frame length to the default: 1 ms exactly */
181         outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
182
183         /* Store the frame list base address */
184         outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
185
186         /* Set the current frame number */
187         outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
188                         uhci->io_addr + USBFRNUM);
189
190         /* Mark controller as not halted before we enable interrupts */
191         uhci_to_hcd(uhci)->state = HC_STATE_SUSPENDED;
192         mb();
193
194         /* Enable PIRQ */
195         pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP,
196                         USBLEGSUP_DEFAULT);
197 }
198
199
200 static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
201 {
202         int port;
203
204         /* If we have to ignore overcurrent events then almost by definition
205          * we can't depend on resume-detect interrupts. */
206         if (ignore_oc)
207                 return 1;
208
209         switch (to_pci_dev(uhci_dev(uhci))->vendor) {
210             default:
211                 break;
212
213             case PCI_VENDOR_ID_GENESYS:
214                 /* Genesys Logic's GL880S controllers don't generate
215                  * resume-detect interrupts.
216                  */
217                 return 1;
218
219             case PCI_VENDOR_ID_INTEL:
220                 /* Some of Intel's USB controllers have a bug that causes
221                  * resume-detect interrupts if any port has an over-current
222                  * condition.  To make matters worse, some motherboards
223                  * hardwire unused USB ports' over-current inputs active!
224                  * To prevent problems, we will not enable resume-detect
225                  * interrupts if any ports are OC.
226                  */
227                 for (port = 0; port < uhci->rh_numports; ++port) {
228                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
229                                         USBPORTSC_OC)
230                                 return 1;
231                 }
232                 break;
233         }
234         return 0;
235 }
236
237 static int remote_wakeup_is_broken(struct uhci_hcd *uhci)
238 {
239         int port;
240         const char *sys_info;
241         static char bad_Asus_board[] = "A7V8X";
242
243         /* One of Asus's motherboards has a bug which causes it to
244          * wake up immediately from suspend-to-RAM if any of the ports
245          * are connected.  In such cases we will not set EGSM.
246          */
247         sys_info = dmi_get_system_info(DMI_BOARD_NAME);
248         if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
249                 for (port = 0; port < uhci->rh_numports; ++port) {
250                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
251                                         USBPORTSC_CCS)
252                                 return 1;
253                 }
254         }
255
256         return 0;
257 }
258
259 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
260 __releases(uhci->lock)
261 __acquires(uhci->lock)
262 {
263         int auto_stop;
264         int int_enable, egsm_enable;
265         struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
266
267         auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
268         dev_dbg(&rhdev->dev, "%s%s\n", __func__,
269                         (auto_stop ? " (auto-stop)" : ""));
270
271         /* Enable resume-detect interrupts if they work.
272          * Then enter Global Suspend mode if _it_ works, still configured.
273          */
274         egsm_enable = USBCMD_EGSM;
275         uhci->working_RD = 1;
276         int_enable = USBINTR_RESUME;
277         if (remote_wakeup_is_broken(uhci))
278                 egsm_enable = 0;
279         if (resume_detect_interrupts_are_broken(uhci) || !egsm_enable ||
280 #ifdef CONFIG_PM
281                         (!auto_stop && !rhdev->do_remote_wakeup) ||
282 #endif
283                         (auto_stop && !device_may_wakeup(&rhdev->dev)))
284                 uhci->working_RD = int_enable = 0;
285
286         outw(int_enable, uhci->io_addr + USBINTR);
287         outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
288         mb();
289         udelay(5);
290
291         /* If we're auto-stopping then no devices have been attached
292          * for a while, so there shouldn't be any active URBs and the
293          * controller should stop after a few microseconds.  Otherwise
294          * we will give the controller one frame to stop.
295          */
296         if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
297                 uhci->rh_state = UHCI_RH_SUSPENDING;
298                 spin_unlock_irq(&uhci->lock);
299                 msleep(1);
300                 spin_lock_irq(&uhci->lock);
301                 if (uhci->dead)
302                         return;
303         }
304         if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
305                 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
306
307         uhci_get_current_frame_number(uhci);
308
309         uhci->rh_state = new_state;
310         uhci->is_stopped = UHCI_IS_STOPPED;
311         uhci_to_hcd(uhci)->poll_rh = !int_enable;
312
313         uhci_scan_schedule(uhci);
314         uhci_fsbr_off(uhci);
315 }
316
317 static void start_rh(struct uhci_hcd *uhci)
318 {
319         uhci_to_hcd(uhci)->state = HC_STATE_RUNNING;
320         uhci->is_stopped = 0;
321
322         /* Mark it configured and running with a 64-byte max packet.
323          * All interrupts are enabled, even though RESUME won't do anything.
324          */
325         outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
326         outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
327                         uhci->io_addr + USBINTR);
328         mb();
329         uhci->rh_state = UHCI_RH_RUNNING;
330         uhci_to_hcd(uhci)->poll_rh = 1;
331 }
332
333 static void wakeup_rh(struct uhci_hcd *uhci)
334 __releases(uhci->lock)
335 __acquires(uhci->lock)
336 {
337         dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
338                         "%s%s\n", __func__,
339                         uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
340                                 " (auto-start)" : "");
341
342         /* If we are auto-stopped then no devices are attached so there's
343          * no need for wakeup signals.  Otherwise we send Global Resume
344          * for 20 ms.
345          */
346         if (uhci->rh_state == UHCI_RH_SUSPENDED) {
347                 uhci->rh_state = UHCI_RH_RESUMING;
348                 outw(USBCMD_FGR | USBCMD_EGSM | USBCMD_CF,
349                                 uhci->io_addr + USBCMD);
350                 spin_unlock_irq(&uhci->lock);
351                 msleep(20);
352                 spin_lock_irq(&uhci->lock);
353                 if (uhci->dead)
354                         return;
355
356                 /* End Global Resume and wait for EOP to be sent */
357                 outw(USBCMD_CF, uhci->io_addr + USBCMD);
358                 mb();
359                 udelay(4);
360                 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
361                         dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
362         }
363
364         start_rh(uhci);
365
366         /* Restart root hub polling */
367         mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
368 }
369
370 static irqreturn_t uhci_irq(struct usb_hcd *hcd)
371 {
372         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
373         unsigned short status;
374
375         /*
376          * Read the interrupt status, and write it back to clear the
377          * interrupt cause.  Contrary to the UHCI specification, the
378          * "HC Halted" status bit is persistent: it is RO, not R/WC.
379          */
380         status = inw(uhci->io_addr + USBSTS);
381         if (!(status & ~USBSTS_HCH))    /* shared interrupt, not mine */
382                 return IRQ_NONE;
383         outw(status, uhci->io_addr + USBSTS);           /* Clear it */
384
385         if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
386                 if (status & USBSTS_HSE)
387                         dev_err(uhci_dev(uhci), "host system error, "
388                                         "PCI problems?\n");
389                 if (status & USBSTS_HCPE)
390                         dev_err(uhci_dev(uhci), "host controller process "
391                                         "error, something bad happened!\n");
392                 if (status & USBSTS_HCH) {
393                         spin_lock(&uhci->lock);
394                         if (uhci->rh_state >= UHCI_RH_RUNNING) {
395                                 dev_err(uhci_dev(uhci),
396                                         "host controller halted, "
397                                         "very bad!\n");
398                                 if (debug > 1 && errbuf) {
399                                         /* Print the schedule for debugging */
400                                         uhci_sprint_schedule(uhci,
401                                                         errbuf, ERRBUF_LEN);
402                                         lprintk(errbuf);
403                                 }
404                                 uhci_hc_died(uhci);
405
406                                 /* Force a callback in case there are
407                                  * pending unlinks */
408                                 mod_timer(&hcd->rh_timer, jiffies);
409                         }
410                         spin_unlock(&uhci->lock);
411                 }
412         }
413
414         if (status & USBSTS_RD)
415                 usb_hcd_poll_rh_status(hcd);
416         else {
417                 spin_lock(&uhci->lock);
418                 uhci_scan_schedule(uhci);
419                 spin_unlock(&uhci->lock);
420         }
421
422         return IRQ_HANDLED;
423 }
424
425 /*
426  * Store the current frame number in uhci->frame_number if the controller
427  * is runnning.  Expand from 11 bits (of which we use only 10) to a
428  * full-sized integer.
429  *
430  * Like many other parts of the driver, this code relies on being polled
431  * more than once per second as long as the controller is running.
432  */
433 static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
434 {
435         if (!uhci->is_stopped) {
436                 unsigned delta;
437
438                 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
439                                 (UHCI_NUMFRAMES - 1);
440                 uhci->frame_number += delta;
441         }
442 }
443
444 /*
445  * De-allocate all resources
446  */
447 static void release_uhci(struct uhci_hcd *uhci)
448 {
449         int i;
450
451         if (DEBUG_CONFIGURED) {
452                 spin_lock_irq(&uhci->lock);
453                 uhci->is_initialized = 0;
454                 spin_unlock_irq(&uhci->lock);
455
456                 debugfs_remove(uhci->dentry);
457         }
458
459         for (i = 0; i < UHCI_NUM_SKELQH; i++)
460                 uhci_free_qh(uhci, uhci->skelqh[i]);
461
462         uhci_free_td(uhci, uhci->term_td);
463
464         dma_pool_destroy(uhci->qh_pool);
465
466         dma_pool_destroy(uhci->td_pool);
467
468         kfree(uhci->frame_cpu);
469
470         dma_free_coherent(uhci_dev(uhci),
471                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
472                         uhci->frame, uhci->frame_dma_handle);
473 }
474
475 static int uhci_init(struct usb_hcd *hcd)
476 {
477         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
478         unsigned io_size = (unsigned) hcd->rsrc_len;
479         int port;
480
481         uhci->io_addr = (unsigned long) hcd->rsrc_start;
482
483         /* The UHCI spec says devices must have 2 ports, and goes on to say
484          * they may have more but gives no way to determine how many there
485          * are.  However according to the UHCI spec, Bit 7 of the port
486          * status and control register is always set to 1.  So we try to
487          * use this to our advantage.  Another common failure mode when
488          * a nonexistent register is addressed is to return all ones, so
489          * we test for that also.
490          */
491         for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
492                 unsigned int portstatus;
493
494                 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
495                 if (!(portstatus & 0x0080) || portstatus == 0xffff)
496                         break;
497         }
498         if (debug)
499                 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
500
501         /* Anything greater than 7 is weird so we'll ignore it. */
502         if (port > UHCI_RH_MAXCHILD) {
503                 dev_info(uhci_dev(uhci), "port count misdetected? "
504                                 "forcing to 2 ports\n");
505                 port = 2;
506         }
507         uhci->rh_numports = port;
508
509         /* Kick BIOS off this hardware and reset if the controller
510          * isn't already safely quiescent.
511          */
512         check_and_reset_hc(uhci);
513         return 0;
514 }
515
516 /* Make sure the controller is quiescent and that we're not using it
517  * any more.  This is mainly for the benefit of programs which, like kexec,
518  * expect the hardware to be idle: not doing DMA or generating IRQs.
519  *
520  * This routine may be called in a damaged or failing kernel.  Hence we
521  * do not acquire the spinlock before shutting down the controller.
522  */
523 static void uhci_shutdown(struct pci_dev *pdev)
524 {
525         struct usb_hcd *hcd = (struct usb_hcd *) pci_get_drvdata(pdev);
526
527         uhci_hc_died(hcd_to_uhci(hcd));
528 }
529
530 /*
531  * Allocate a frame list, and then setup the skeleton
532  *
533  * The hardware doesn't really know any difference
534  * in the queues, but the order does matter for the
535  * protocols higher up.  The order in which the queues
536  * are encountered by the hardware is:
537  *
538  *  - All isochronous events are handled before any
539  *    of the queues. We don't do that here, because
540  *    we'll create the actual TD entries on demand.
541  *  - The first queue is the high-period interrupt queue.
542  *  - The second queue is the period-1 interrupt and async
543  *    (low-speed control, full-speed control, then bulk) queue.
544  *  - The third queue is the terminating bandwidth reclamation queue,
545  *    which contains no members, loops back to itself, and is present
546  *    only when FSBR is on and there are no full-speed control or bulk QHs.
547  */
548 static int uhci_start(struct usb_hcd *hcd)
549 {
550         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
551         int retval = -EBUSY;
552         int i;
553         struct dentry *dentry;
554
555         hcd->uses_new_polling = 1;
556
557         spin_lock_init(&uhci->lock);
558         setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
559                         (unsigned long) uhci);
560         INIT_LIST_HEAD(&uhci->idle_qh_list);
561         init_waitqueue_head(&uhci->waitqh);
562
563         if (DEBUG_CONFIGURED) {
564                 dentry = debugfs_create_file(hcd->self.bus_name,
565                                 S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
566                                 uhci, &uhci_debug_operations);
567                 if (!dentry) {
568                         dev_err(uhci_dev(uhci), "couldn't create uhci "
569                                         "debugfs entry\n");
570                         retval = -ENOMEM;
571                         goto err_create_debug_entry;
572                 }
573                 uhci->dentry = dentry;
574         }
575
576         uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
577                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
578                         &uhci->frame_dma_handle, 0);
579         if (!uhci->frame) {
580                 dev_err(uhci_dev(uhci), "unable to allocate "
581                                 "consistent memory for frame list\n");
582                 goto err_alloc_frame;
583         }
584         memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
585
586         uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
587                         GFP_KERNEL);
588         if (!uhci->frame_cpu) {
589                 dev_err(uhci_dev(uhci), "unable to allocate "
590                                 "memory for frame pointers\n");
591                 goto err_alloc_frame_cpu;
592         }
593
594         uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
595                         sizeof(struct uhci_td), 16, 0);
596         if (!uhci->td_pool) {
597                 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
598                 goto err_create_td_pool;
599         }
600
601         uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
602                         sizeof(struct uhci_qh), 16, 0);
603         if (!uhci->qh_pool) {
604                 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
605                 goto err_create_qh_pool;
606         }
607
608         uhci->term_td = uhci_alloc_td(uhci);
609         if (!uhci->term_td) {
610                 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
611                 goto err_alloc_term_td;
612         }
613
614         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
615                 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
616                 if (!uhci->skelqh[i]) {
617                         dev_err(uhci_dev(uhci), "unable to allocate QH\n");
618                         goto err_alloc_skelqh;
619                 }
620         }
621
622         /*
623          * 8 Interrupt queues; link all higher int queues to int1 = async
624          */
625         for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
626                 uhci->skelqh[i]->link = LINK_TO_QH(uhci->skel_async_qh);
627         uhci->skel_async_qh->link = UHCI_PTR_TERM;
628         uhci->skel_term_qh->link = LINK_TO_QH(uhci->skel_term_qh);
629
630         /* This dummy TD is to work around a bug in Intel PIIX controllers */
631         uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
632                         (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
633         uhci->term_td->link = UHCI_PTR_TERM;
634         uhci->skel_async_qh->element = uhci->skel_term_qh->element =
635                         LINK_TO_TD(uhci->term_td);
636
637         /*
638          * Fill the frame list: make all entries point to the proper
639          * interrupt queue.
640          */
641         for (i = 0; i < UHCI_NUMFRAMES; i++) {
642
643                 /* Only place we don't use the frame list routines */
644                 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
645         }
646
647         /*
648          * Some architectures require a full mb() to enforce completion of
649          * the memory writes above before the I/O transfers in configure_hc().
650          */
651         mb();
652
653         configure_hc(uhci);
654         uhci->is_initialized = 1;
655         start_rh(uhci);
656         return 0;
657
658 /*
659  * error exits:
660  */
661 err_alloc_skelqh:
662         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
663                 if (uhci->skelqh[i])
664                         uhci_free_qh(uhci, uhci->skelqh[i]);
665         }
666
667         uhci_free_td(uhci, uhci->term_td);
668
669 err_alloc_term_td:
670         dma_pool_destroy(uhci->qh_pool);
671
672 err_create_qh_pool:
673         dma_pool_destroy(uhci->td_pool);
674
675 err_create_td_pool:
676         kfree(uhci->frame_cpu);
677
678 err_alloc_frame_cpu:
679         dma_free_coherent(uhci_dev(uhci),
680                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
681                         uhci->frame, uhci->frame_dma_handle);
682
683 err_alloc_frame:
684         debugfs_remove(uhci->dentry);
685
686 err_create_debug_entry:
687         return retval;
688 }
689
690 static void uhci_stop(struct usb_hcd *hcd)
691 {
692         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
693
694         spin_lock_irq(&uhci->lock);
695         if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) && !uhci->dead)
696                 uhci_hc_died(uhci);
697         uhci_scan_schedule(uhci);
698         spin_unlock_irq(&uhci->lock);
699
700         del_timer_sync(&uhci->fsbr_timer);
701         release_uhci(uhci);
702 }
703
704 #ifdef CONFIG_PM
705 static int uhci_rh_suspend(struct usb_hcd *hcd)
706 {
707         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
708         int rc = 0;
709
710         spin_lock_irq(&uhci->lock);
711         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
712                 rc = -ESHUTDOWN;
713         else if (!uhci->dead)
714                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
715         spin_unlock_irq(&uhci->lock);
716         return rc;
717 }
718
719 static int uhci_rh_resume(struct usb_hcd *hcd)
720 {
721         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
722         int rc = 0;
723
724         spin_lock_irq(&uhci->lock);
725         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
726                 rc = -ESHUTDOWN;
727         else if (!uhci->dead)
728                 wakeup_rh(uhci);
729         spin_unlock_irq(&uhci->lock);
730         return rc;
731 }
732
733 static int uhci_pci_suspend(struct usb_hcd *hcd, pm_message_t message)
734 {
735         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
736         int rc = 0;
737
738         dev_dbg(uhci_dev(uhci), "%s\n", __func__);
739
740         spin_lock_irq(&uhci->lock);
741         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) || uhci->dead)
742                 goto done_okay;         /* Already suspended or dead */
743
744         if (uhci->rh_state > UHCI_RH_SUSPENDED) {
745                 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
746                 rc = -EBUSY;
747                 goto done;
748         };
749
750         /* All PCI host controllers are required to disable IRQ generation
751          * at the source, so we must turn off PIRQ.
752          */
753         pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP, 0);
754         mb();
755         hcd->poll_rh = 0;
756
757         /* FIXME: Enable non-PME# remote wakeup? */
758
759         /* make sure snapshot being resumed re-enumerates everything */
760         if (message.event == PM_EVENT_PRETHAW)
761                 uhci_hc_died(uhci);
762
763 done_okay:
764         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
765 done:
766         spin_unlock_irq(&uhci->lock);
767         return rc;
768 }
769
770 static int uhci_pci_resume(struct usb_hcd *hcd)
771 {
772         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
773
774         dev_dbg(uhci_dev(uhci), "%s\n", __func__);
775
776         /* Since we aren't in D3 any more, it's safe to set this flag
777          * even if the controller was dead.
778          */
779         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
780         mb();
781
782         spin_lock_irq(&uhci->lock);
783
784         /* FIXME: Disable non-PME# remote wakeup? */
785
786         /* The firmware or a boot kernel may have changed the controller
787          * settings during a system wakeup.  Check it and reconfigure
788          * to avoid problems.
789          */
790         check_and_reset_hc(uhci);
791
792         /* If the controller was dead before, it's back alive now */
793         configure_hc(uhci);
794
795         if (uhci->rh_state == UHCI_RH_RESET) {
796
797                 /* The controller had to be reset */
798                 usb_root_hub_lost_power(hcd->self.root_hub);
799                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
800         }
801
802         spin_unlock_irq(&uhci->lock);
803
804         if (!uhci->working_RD) {
805                 /* Suspended root hub needs to be polled */
806                 hcd->poll_rh = 1;
807                 usb_hcd_poll_rh_status(hcd);
808         }
809         return 0;
810 }
811 #endif
812
813 /* Wait until a particular device/endpoint's QH is idle, and free it */
814 static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
815                 struct usb_host_endpoint *hep)
816 {
817         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
818         struct uhci_qh *qh;
819
820         spin_lock_irq(&uhci->lock);
821         qh = (struct uhci_qh *) hep->hcpriv;
822         if (qh == NULL)
823                 goto done;
824
825         while (qh->state != QH_STATE_IDLE) {
826                 ++uhci->num_waiting;
827                 spin_unlock_irq(&uhci->lock);
828                 wait_event_interruptible(uhci->waitqh,
829                                 qh->state == QH_STATE_IDLE);
830                 spin_lock_irq(&uhci->lock);
831                 --uhci->num_waiting;
832         }
833
834         uhci_free_qh(uhci, qh);
835 done:
836         spin_unlock_irq(&uhci->lock);
837 }
838
839 static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
840 {
841         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
842         unsigned frame_number;
843         unsigned delta;
844
845         /* Minimize latency by avoiding the spinlock */
846         frame_number = uhci->frame_number;
847         barrier();
848         delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
849                         (UHCI_NUMFRAMES - 1);
850         return frame_number + delta;
851 }
852
853 static const char hcd_name[] = "uhci_hcd";
854
855 static const struct hc_driver uhci_driver = {
856         .description =          hcd_name,
857         .product_desc =         "UHCI Host Controller",
858         .hcd_priv_size =        sizeof(struct uhci_hcd),
859
860         /* Generic hardware linkage */
861         .irq =                  uhci_irq,
862         .flags =                HCD_USB11,
863
864         /* Basic lifecycle operations */
865         .reset =                uhci_init,
866         .start =                uhci_start,
867 #ifdef CONFIG_PM
868         .pci_suspend =          uhci_pci_suspend,
869         .pci_resume =           uhci_pci_resume,
870         .bus_suspend =          uhci_rh_suspend,
871         .bus_resume =           uhci_rh_resume,
872 #endif
873         .stop =                 uhci_stop,
874
875         .urb_enqueue =          uhci_urb_enqueue,
876         .urb_dequeue =          uhci_urb_dequeue,
877
878         .endpoint_disable =     uhci_hcd_endpoint_disable,
879         .get_frame_number =     uhci_hcd_get_frame_number,
880
881         .hub_status_data =      uhci_hub_status_data,
882         .hub_control =          uhci_hub_control,
883 };
884
885 static const struct pci_device_id uhci_pci_ids[] = { {
886         /* handle any USB UHCI controller */
887         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
888         .driver_data =  (unsigned long) &uhci_driver,
889         }, { /* end: all zeroes */ }
890 };
891
892 MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
893
894 static struct pci_driver uhci_pci_driver = {
895         .name =         (char *)hcd_name,
896         .id_table =     uhci_pci_ids,
897
898         .probe =        usb_hcd_pci_probe,
899         .remove =       usb_hcd_pci_remove,
900         .shutdown =     uhci_shutdown,
901
902 #ifdef  CONFIG_PM
903         .suspend =      usb_hcd_pci_suspend,
904         .resume =       usb_hcd_pci_resume,
905 #endif  /* PM */
906 };
907  
908 static int __init uhci_hcd_init(void)
909 {
910         int retval = -ENOMEM;
911
912         printk(KERN_INFO DRIVER_DESC " " DRIVER_VERSION "%s\n",
913                         ignore_oc ? ", overcurrent ignored" : "");
914
915         if (usb_disabled())
916                 return -ENODEV;
917
918         if (DEBUG_CONFIGURED) {
919                 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
920                 if (!errbuf)
921                         goto errbuf_failed;
922                 uhci_debugfs_root = debugfs_create_dir("uhci", NULL);
923                 if (!uhci_debugfs_root)
924                         goto debug_failed;
925         }
926
927         uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
928                 sizeof(struct urb_priv), 0, 0, NULL);
929         if (!uhci_up_cachep)
930                 goto up_failed;
931
932         retval = pci_register_driver(&uhci_pci_driver);
933         if (retval)
934                 goto init_failed;
935
936         return 0;
937
938 init_failed:
939         kmem_cache_destroy(uhci_up_cachep);
940
941 up_failed:
942         debugfs_remove(uhci_debugfs_root);
943
944 debug_failed:
945         kfree(errbuf);
946
947 errbuf_failed:
948
949         return retval;
950 }
951
952 static void __exit uhci_hcd_cleanup(void) 
953 {
954         pci_unregister_driver(&uhci_pci_driver);
955         kmem_cache_destroy(uhci_up_cachep);
956         debugfs_remove(uhci_debugfs_root);
957         kfree(errbuf);
958 }
959
960 module_init(uhci_hcd_init);
961 module_exit(uhci_hcd_cleanup);
962
963 MODULE_AUTHOR(DRIVER_AUTHOR);
964 MODULE_DESCRIPTION(DRIVER_DESC);
965 MODULE_LICENSE("GPL");