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