]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/host/ehci-hcd.c
usb: gadget: file_storage: fix race on unloading
[mirror_ubuntu-bionic-kernel.git] / drivers / usb / host / ehci-hcd.c
CommitLineData
1da177e4 1/*
578333ab
AS
2 * Enhanced Host Controller Interface (EHCI) driver for USB.
3 *
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5 *
1da177e4 6 * Copyright (c) 2000-2004 by David Brownell
53bd6a60 7 *
1da177e4
LT
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
1da177e4
LT
23#include <linux/module.h>
24#include <linux/pci.h>
25#include <linux/dmapool.h>
26#include <linux/kernel.h>
27#include <linux/delay.h>
28#include <linux/ioport.h>
29#include <linux/sched.h>
3c04e20e 30#include <linux/vmalloc.h>
1da177e4
LT
31#include <linux/errno.h>
32#include <linux/init.h>
33#include <linux/timer.h>
ee4ecb8a 34#include <linux/ktime.h>
1da177e4
LT
35#include <linux/list.h>
36#include <linux/interrupt.h>
1da177e4 37#include <linux/usb.h>
27729aad 38#include <linux/usb/hcd.h>
1da177e4
LT
39#include <linux/moduleparam.h>
40#include <linux/dma-mapping.h>
694cc208 41#include <linux/debugfs.h>
5a0e3ad6 42#include <linux/slab.h>
aa4d8342 43#include <linux/uaccess.h>
1da177e4 44
1da177e4
LT
45#include <asm/byteorder.h>
46#include <asm/io.h>
47#include <asm/irq.h>
48#include <asm/system.h>
49#include <asm/unaligned.h>
1da177e4
LT
50
51/*-------------------------------------------------------------------------*/
52
53/*
54 * EHCI hc_driver implementation ... experimental, incomplete.
55 * Based on the final 1.0 register interface specification.
56 *
57 * USB 2.0 shows up in upcoming www.pcmcia.org technology.
58 * First was PCMCIA, like ISA; then CardBus, which is PCI.
59 * Next comes "CardBay", using USB 2.0 signals.
60 *
61 * Contains additional contributions by Brad Hards, Rory Bolt, and others.
62 * Special thanks to Intel and VIA for providing host controllers to
63 * test this driver on, and Cypress (including In-System Design) for
64 * providing early devices for those host controllers to talk to!
1da177e4
LT
65 */
66
1da177e4
LT
67#define DRIVER_AUTHOR "David Brownell"
68#define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
69
70static const char hcd_name [] = "ehci_hcd";
71
72
9776afc8 73#undef VERBOSE_DEBUG
1da177e4
LT
74#undef EHCI_URB_TRACE
75
76#ifdef DEBUG
77#define EHCI_STATS
78#endif
79
80/* magic numbers that can affect system performance */
81#define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */
82#define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */
83#define EHCI_TUNE_RL_TT 0
84#define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */
85#define EHCI_TUNE_MULT_TT 1
ffda0803
AS
86/*
87 * Some drivers think it's safe to schedule isochronous transfers more than
88 * 256 ms into the future (partly as a result of an old bug in the scheduling
89 * code). In an attempt to avoid trouble, we will use a minimum scheduling
90 * length of 512 frames instead of 256.
91 */
92#define EHCI_TUNE_FLS 1 /* (medium) 512-frame schedule */
1da177e4 93
07d29b63 94#define EHCI_IAA_MSECS 10 /* arbitrary */
1da177e4
LT
95#define EHCI_IO_JIFFIES (HZ/10) /* io watchdog > irq_thresh */
96#define EHCI_ASYNC_JIFFIES (HZ/20) /* async idle timeout */
004c1968 97#define EHCI_SHRINK_JIFFIES (DIV_ROUND_UP(HZ, 200) + 1)
fcda37cb 98 /* 5-ms async qh unlink delay */
1da177e4
LT
99
100/* Initial IRQ latency: faster than hw default */
101static int log2_irq_thresh = 0; // 0 to 6
102module_param (log2_irq_thresh, int, S_IRUGO);
103MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
104
105/* initial park setting: slower than hw default */
106static unsigned park = 0;
107module_param (park, uint, S_IRUGO);
108MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
109
93f1a47c
DB
110/* for flakey hardware, ignore overcurrent indicators */
111static int ignore_oc = 0;
112module_param (ignore_oc, bool, S_IRUGO);
113MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
114
48f24970
AD
115/* for link power management(LPM) feature */
116static unsigned int hird;
117module_param(hird, int, S_IRUGO);
cc556871 118MODULE_PARM_DESC(hird, "host initiated resume duration, +1 for each 75us");
48f24970 119
1da177e4
LT
120#define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
121
122/*-------------------------------------------------------------------------*/
123
124#include "ehci.h"
125#include "ehci-dbg.c"
ad93562b 126#include "pci-quirks.h"
1da177e4
LT
127
128/*-------------------------------------------------------------------------*/
129
bc29847e
AS
130static void
131timer_action(struct ehci_hcd *ehci, enum ehci_timer_action action)
132{
133 /* Don't override timeouts which shrink or (later) disable
134 * the async ring; just the I/O watchdog. Note that if a
135 * SHRINK were pending, OFF would never be requested.
136 */
137 if (timer_pending(&ehci->watchdog)
138 && ((BIT(TIMER_ASYNC_SHRINK) | BIT(TIMER_ASYNC_OFF))
139 & ehci->actions))
140 return;
141
142 if (!test_and_set_bit(action, &ehci->actions)) {
143 unsigned long t;
144
145 switch (action) {
146 case TIMER_IO_WATCHDOG:
403dbd36
AD
147 if (!ehci->need_io_watchdog)
148 return;
bc29847e
AS
149 t = EHCI_IO_JIFFIES;
150 break;
151 case TIMER_ASYNC_OFF:
152 t = EHCI_ASYNC_JIFFIES;
153 break;
154 /* case TIMER_ASYNC_SHRINK: */
155 default:
004c1968 156 t = EHCI_SHRINK_JIFFIES;
bc29847e
AS
157 break;
158 }
159 mod_timer(&ehci->watchdog, t + jiffies);
160 }
161}
162
163/*-------------------------------------------------------------------------*/
164
1da177e4
LT
165/*
166 * handshake - spin reading hc until handshake completes or fails
167 * @ptr: address of hc register to be read
168 * @mask: bits to look at in result of read
169 * @done: value of those bits when handshake succeeds
170 * @usec: timeout in microseconds
171 *
172 * Returns negative errno, or zero on success
173 *
174 * Success happens when the "mask" bits have the specified value (hardware
175 * handshake done). There are two failure modes: "usec" have passed (major
176 * hardware flakeout), or the register reads as all-ones (hardware removed).
177 *
178 * That last failure should_only happen in cases like physical cardbus eject
179 * before driver shutdown. But it also seems to be caused by bugs in cardbus
180 * bridge shutdown: shutting down the bridge before the devices using it.
181 */
083522d7
BH
182static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
183 u32 mask, u32 done, int usec)
1da177e4
LT
184{
185 u32 result;
186
187 do {
083522d7 188 result = ehci_readl(ehci, ptr);
1da177e4
LT
189 if (result == ~(u32)0) /* card removed */
190 return -ENODEV;
191 result &= mask;
192 if (result == done)
193 return 0;
194 udelay (1);
195 usec--;
196 } while (usec > 0);
197 return -ETIMEDOUT;
198}
199
65fd4272
MC
200/* check TDI/ARC silicon is in host mode */
201static int tdi_in_host_mode (struct ehci_hcd *ehci)
202{
203 u32 __iomem *reg_ptr;
204 u32 tmp;
205
206 reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
207 tmp = ehci_readl(ehci, reg_ptr);
208 return (tmp & 3) == USBMODE_CM_HC;
209}
210
1da177e4
LT
211/* force HC to halt state from unknown (EHCI spec section 2.3) */
212static int ehci_halt (struct ehci_hcd *ehci)
213{
083522d7 214 u32 temp = ehci_readl(ehci, &ehci->regs->status);
1da177e4 215
72f30b6f 216 /* disable any irqs left enabled by previous code */
083522d7 217 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
72f30b6f 218
65fd4272
MC
219 if (ehci_is_TDI(ehci) && tdi_in_host_mode(ehci) == 0) {
220 return 0;
221 }
222
1da177e4
LT
223 if ((temp & STS_HALT) != 0)
224 return 0;
225
083522d7 226 temp = ehci_readl(ehci, &ehci->regs->command);
1da177e4 227 temp &= ~CMD_RUN;
083522d7
BH
228 ehci_writel(ehci, temp, &ehci->regs->command);
229 return handshake (ehci, &ehci->regs->status,
230 STS_HALT, STS_HALT, 16 * 125);
1da177e4
LT
231}
232
0bcfeb3e
DB
233static int handshake_on_error_set_halt(struct ehci_hcd *ehci, void __iomem *ptr,
234 u32 mask, u32 done, int usec)
235{
236 int error;
237
238 error = handshake(ehci, ptr, mask, done, usec);
239 if (error) {
240 ehci_halt(ehci);
e8799906 241 ehci->rh_state = EHCI_RH_HALTED;
65cb76ba 242 ehci_err(ehci, "force halt; handshake %p %08x %08x -> %d\n",
0bcfeb3e
DB
243 ptr, mask, done, error);
244 }
245
246 return error;
247}
248
1da177e4
LT
249/* put TDI/ARC silicon into EHCI mode */
250static void tdi_reset (struct ehci_hcd *ehci)
251{
252 u32 __iomem *reg_ptr;
253 u32 tmp;
254
d23a1377 255 reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
083522d7 256 tmp = ehci_readl(ehci, reg_ptr);
d23a1377
VB
257 tmp |= USBMODE_CM_HC;
258 /* The default byte access to MMR space is LE after
259 * controller reset. Set the required endian mode
260 * for transfer buffers to match the host microprocessor
261 */
262 if (ehci_big_endian_mmio(ehci))
263 tmp |= USBMODE_BE;
083522d7 264 ehci_writel(ehci, tmp, reg_ptr);
1da177e4
LT
265}
266
267/* reset a non-running (STS_HALT == 1) controller */
268static int ehci_reset (struct ehci_hcd *ehci)
269{
270 int retval;
083522d7 271 u32 command = ehci_readl(ehci, &ehci->regs->command);
1da177e4 272
8d053c79
JW
273 /* If the EHCI debug controller is active, special care must be
274 * taken before and after a host controller reset */
275 if (ehci->debug && !dbgp_reset_prep())
276 ehci->debug = NULL;
277
1da177e4
LT
278 command |= CMD_RESET;
279 dbg_cmd (ehci, "reset", command);
083522d7 280 ehci_writel(ehci, command, &ehci->regs->command);
e8799906 281 ehci->rh_state = EHCI_RH_HALTED;
1da177e4 282 ehci->next_statechange = jiffies;
083522d7
BH
283 retval = handshake (ehci, &ehci->regs->command,
284 CMD_RESET, 0, 250 * 1000);
1da177e4 285
331ac6b2
AD
286 if (ehci->has_hostpc) {
287 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
288 (u32 __iomem *)(((u8 *)ehci->regs) + USBMODE_EX));
289 ehci_writel(ehci, TXFIFO_DEFAULT,
290 (u32 __iomem *)(((u8 *)ehci->regs) + TXFILLTUNING));
291 }
1da177e4
LT
292 if (retval)
293 return retval;
294
295 if (ehci_is_TDI(ehci))
296 tdi_reset (ehci);
297
8d053c79
JW
298 if (ehci->debug)
299 dbgp_external_startup();
300
1da177e4
LT
301 return retval;
302}
303
304/* idle the controller (from running) */
305static void ehci_quiesce (struct ehci_hcd *ehci)
306{
307 u32 temp;
308
309#ifdef DEBUG
e8799906 310 if (ehci->rh_state != EHCI_RH_RUNNING)
1da177e4
LT
311 BUG ();
312#endif
313
314 /* wait for any schedule enables/disables to take effect */
083522d7 315 temp = ehci_readl(ehci, &ehci->regs->command) << 10;
1da177e4 316 temp &= STS_ASS | STS_PSS;
c765d4ca
KW
317 if (handshake_on_error_set_halt(ehci, &ehci->regs->status,
318 STS_ASS | STS_PSS, temp, 16 * 125))
1da177e4 319 return;
1da177e4
LT
320
321 /* then disable anything that's still active */
083522d7 322 temp = ehci_readl(ehci, &ehci->regs->command);
1da177e4 323 temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
083522d7 324 ehci_writel(ehci, temp, &ehci->regs->command);
1da177e4
LT
325
326 /* hardware can take 16 microframes to turn off ... */
c765d4ca
KW
327 handshake_on_error_set_halt(ehci, &ehci->regs->status,
328 STS_ASS | STS_PSS, 0, 16 * 125);
1da177e4
LT
329}
330
331/*-------------------------------------------------------------------------*/
332
07d29b63 333static void end_unlink_async(struct ehci_hcd *ehci);
7d12e780 334static void ehci_work(struct ehci_hcd *ehci);
1da177e4
LT
335
336#include "ehci-hub.c"
48f24970 337#include "ehci-lpm.c"
1da177e4
LT
338#include "ehci-mem.c"
339#include "ehci-q.c"
340#include "ehci-sched.c"
4c67045b 341#include "ehci-sysfs.c"
1da177e4
LT
342
343/*-------------------------------------------------------------------------*/
344
07d29b63 345static void ehci_iaa_watchdog(unsigned long param)
1da177e4
LT
346{
347 struct ehci_hcd *ehci = (struct ehci_hcd *) param;
348 unsigned long flags;
349
350 spin_lock_irqsave (&ehci->lock, flags);
351
e82cc128
DB
352 /* Lost IAA irqs wedge things badly; seen first with a vt8235.
353 * So we need this watchdog, but must protect it against both
354 * (a) SMP races against real IAA firing and retriggering, and
355 * (b) clean HC shutdown, when IAA watchdog was pending.
356 */
357 if (ehci->reclaim
358 && !timer_pending(&ehci->iaa_watchdog)
e8799906 359 && ehci->rh_state == EHCI_RH_RUNNING) {
e82cc128
DB
360 u32 cmd, status;
361
362 /* If we get here, IAA is *REALLY* late. It's barely
363 * conceivable that the system is so busy that CMD_IAAD
364 * is still legitimately set, so let's be sure it's
365 * clear before we read STS_IAA. (The HC should clear
366 * CMD_IAAD when it sets STS_IAA.)
367 */
368 cmd = ehci_readl(ehci, &ehci->regs->command);
369 if (cmd & CMD_IAAD)
370 ehci_writel(ehci, cmd & ~CMD_IAAD,
371 &ehci->regs->command);
372
373 /* If IAA is set here it either legitimately triggered
374 * before we cleared IAAD above (but _way_ late, so we'll
375 * still count it as lost) ... or a silicon erratum:
376 * - VIA seems to set IAA without triggering the IRQ;
377 * - IAAD potentially cleared without setting IAA.
378 */
379 status = ehci_readl(ehci, &ehci->regs->status);
380 if ((status & STS_IAA) || !(cmd & CMD_IAAD)) {
1da177e4 381 COUNT (ehci->stats.lost_iaa);
083522d7 382 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
1da177e4 383 }
e82cc128
DB
384
385 ehci_vdbg(ehci, "IAA watchdog: status %x cmd %x\n",
386 status, cmd);
07d29b63 387 end_unlink_async(ehci);
1da177e4
LT
388 }
389
07d29b63
AS
390 spin_unlock_irqrestore(&ehci->lock, flags);
391}
392
393static void ehci_watchdog(unsigned long param)
394{
395 struct ehci_hcd *ehci = (struct ehci_hcd *) param;
396 unsigned long flags;
397
398 spin_lock_irqsave(&ehci->lock, flags);
399
400 /* stop async processing after it's idled a bit */
1da177e4 401 if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
26f953fd 402 start_unlink_async (ehci, ehci->async);
1da177e4
LT
403
404 /* ehci could run by timer, without IRQs ... */
7d12e780 405 ehci_work (ehci);
1da177e4
LT
406
407 spin_unlock_irqrestore (&ehci->lock, flags);
408}
409
8903795a
AS
410/* On some systems, leaving remote wakeup enabled prevents system shutdown.
411 * The firmware seems to think that powering off is a wakeup event!
412 * This routine turns off remote wakeup and everything else, on all ports.
413 */
414static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
415{
416 int port = HCS_N_PORTS(ehci->hcs_params);
417
418 while (port--)
419 ehci_writel(ehci, PORT_RWC_BITS,
420 &ehci->regs->port_status[port]);
421}
422
21da84a8
SS
423/*
424 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
425 * Should be called with ehci->lock held.
72f30b6f 426 */
21da84a8 427static void ehci_silence_controller(struct ehci_hcd *ehci)
1da177e4 428{
21da84a8 429 ehci_halt(ehci);
8903795a 430 ehci_turn_off_all_ports(ehci);
1da177e4
LT
431
432 /* make BIOS/etc use companion controller during reboot */
083522d7 433 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
8903795a
AS
434
435 /* unblock posted writes */
436 ehci_readl(ehci, &ehci->regs->configured_flag);
1da177e4
LT
437}
438
21da84a8
SS
439/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
440 * This forcibly disables dma and IRQs, helping kexec and other cases
441 * where the next system software may expect clean state.
442 */
443static void ehci_shutdown(struct usb_hcd *hcd)
444{
445 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
446
447 del_timer_sync(&ehci->watchdog);
448 del_timer_sync(&ehci->iaa_watchdog);
449
450 spin_lock_irq(&ehci->lock);
451 ehci_silence_controller(ehci);
452 spin_unlock_irq(&ehci->lock);
453}
454
56c1e26d
DB
455static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
456{
457 unsigned port;
458
459 if (!HCS_PPC (ehci->hcs_params))
460 return;
461
462 ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
463 for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
464 (void) ehci_hub_control(ehci_to_hcd(ehci),
465 is_on ? SetPortFeature : ClearPortFeature,
466 USB_PORT_FEAT_POWER,
467 port--, NULL, 0);
383975d7
AS
468 /* Flush those writes */
469 ehci_readl(ehci, &ehci->regs->command);
56c1e26d
DB
470 msleep(20);
471}
472
7ff71d6a 473/*-------------------------------------------------------------------------*/
1da177e4 474
7ff71d6a
MP
475/*
476 * ehci_work is called from some interrupts, timers, and so on.
477 * it calls driver completion functions, after dropping ehci->lock.
478 */
7d12e780 479static void ehci_work (struct ehci_hcd *ehci)
7ff71d6a
MP
480{
481 timer_action_done (ehci, TIMER_IO_WATCHDOG);
7ff71d6a
MP
482
483 /* another CPU may drop ehci->lock during a schedule scan while
484 * it reports urb completions. this flag guards against bogus
485 * attempts at re-entrant schedule scanning.
486 */
487 if (ehci->scanning)
488 return;
489 ehci->scanning = 1;
7d12e780 490 scan_async (ehci);
7ff71d6a 491 if (ehci->next_uframe != -1)
7d12e780 492 scan_periodic (ehci);
7ff71d6a
MP
493 ehci->scanning = 0;
494
495 /* the IO watchdog guards against hardware or driver bugs that
496 * misplace IRQs, and should let us run completely without IRQs.
497 * such lossage has been observed on both VT6202 and VT8235.
498 */
e8799906 499 if (ehci->rh_state == EHCI_RH_RUNNING &&
7ff71d6a
MP
500 (ehci->async->qh_next.ptr != NULL ||
501 ehci->periodic_sched != 0))
502 timer_action (ehci, TIMER_IO_WATCHDOG);
503}
1da177e4 504
21da84a8
SS
505/*
506 * Called when the ehci_hcd module is removed.
507 */
7ff71d6a 508static void ehci_stop (struct usb_hcd *hcd)
1da177e4
LT
509{
510 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1da177e4 511
7ff71d6a 512 ehci_dbg (ehci, "stop\n");
1da177e4 513
7ff71d6a
MP
514 /* no more interrupts ... */
515 del_timer_sync (&ehci->watchdog);
07d29b63 516 del_timer_sync(&ehci->iaa_watchdog);
56c1e26d 517
7ff71d6a 518 spin_lock_irq(&ehci->lock);
e8799906 519 if (ehci->rh_state == EHCI_RH_RUNNING)
7ff71d6a 520 ehci_quiesce (ehci);
1da177e4 521
21da84a8 522 ehci_silence_controller(ehci);
7ff71d6a 523 ehci_reset (ehci);
7ff71d6a 524 spin_unlock_irq(&ehci->lock);
1da177e4 525
4c67045b 526 remove_sysfs_files(ehci);
7ff71d6a 527 remove_debug_files (ehci);
1da177e4 528
7ff71d6a
MP
529 /* root hub is shut down separately (first, when possible) */
530 spin_lock_irq (&ehci->lock);
531 if (ehci->async)
7d12e780 532 ehci_work (ehci);
7ff71d6a
MP
533 spin_unlock_irq (&ehci->lock);
534 ehci_mem_cleanup (ehci);
1da177e4 535
ad93562b
AX
536 if (ehci->amd_pll_fix == 1)
537 usb_amd_dev_put();
05570297 538
7ff71d6a
MP
539#ifdef EHCI_STATS
540 ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
541 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
542 ehci->stats.lost_iaa);
543 ehci_dbg (ehci, "complete %ld unlink %ld\n",
544 ehci->stats.complete, ehci->stats.unlink);
1da177e4 545#endif
1da177e4 546
083522d7
BH
547 dbg_status (ehci, "ehci_stop completed",
548 ehci_readl(ehci, &ehci->regs->status));
1da177e4
LT
549}
550
18807521
DB
551/* one-time init, only for memory state */
552static int ehci_init(struct usb_hcd *hcd)
1da177e4 553{
18807521 554 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1da177e4 555 u32 temp;
1da177e4
LT
556 int retval;
557 u32 hcc_params;
3807e26d 558 struct ehci_qh_hw *hw;
18807521
DB
559
560 spin_lock_init(&ehci->lock);
561
403dbd36
AD
562 /*
563 * keep io watchdog by default, those good HCDs could turn off it later
564 */
565 ehci->need_io_watchdog = 1;
18807521
DB
566 init_timer(&ehci->watchdog);
567 ehci->watchdog.function = ehci_watchdog;
568 ehci->watchdog.data = (unsigned long) ehci;
1da177e4 569
07d29b63
AS
570 init_timer(&ehci->iaa_watchdog);
571 ehci->iaa_watchdog.function = ehci_iaa_watchdog;
572 ehci->iaa_watchdog.data = (unsigned long) ehci;
573
f75593ce
AS
574 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
575
cc62a7eb
KS
576 /*
577 * by default set standard 80% (== 100 usec/uframe) max periodic
578 * bandwidth as required by USB 2.0
579 */
580 ehci->uframe_periodic_max = 100;
581
1da177e4
LT
582 /*
583 * hw default: 1K periodic list heads, one per frame.
584 * periodic_size can shrink by USBCMD update if hcc_params allows.
585 */
586 ehci->periodic_size = DEFAULT_I_TDPS;
9aa09d2f 587 INIT_LIST_HEAD(&ehci->cached_itd_list);
0e5f231b 588 INIT_LIST_HEAD(&ehci->cached_sitd_list);
f75593ce
AS
589
590 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
591 /* periodic schedule size can be smaller than default */
592 switch (EHCI_TUNE_FLS) {
593 case 0: ehci->periodic_size = 1024; break;
594 case 1: ehci->periodic_size = 512; break;
595 case 2: ehci->periodic_size = 256; break;
596 default: BUG();
597 }
598 }
18807521 599 if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
1da177e4
LT
600 return retval;
601
602 /* controllers may cache some of the periodic schedule ... */
53bd6a60 603 if (HCC_ISOC_CACHE(hcc_params)) // full frame cache
dccd574c 604 ehci->i_thresh = 2 + 8;
1da177e4 605 else // N microframes cached
18807521 606 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
1da177e4
LT
607
608 ehci->reclaim = NULL;
1da177e4 609 ehci->next_uframe = -1;
9aa09d2f 610 ehci->clock_frame = -1;
1da177e4 611
1da177e4
LT
612 /*
613 * dedicate a qh for the async ring head, since we couldn't unlink
614 * a 'real' qh without stopping the async schedule [4.8]. use it
615 * as the 'reclamation list head' too.
616 * its dummy is used in hw_alt_next of many tds, to prevent the qh
617 * from automatically advancing to the next td after short reads.
618 */
18807521 619 ehci->async->qh_next.qh = NULL;
3807e26d
AD
620 hw = ehci->async->hw;
621 hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
622 hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
623 hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
624 hw->hw_qtd_next = EHCI_LIST_END(ehci);
18807521 625 ehci->async->qh_state = QH_STATE_LINKED;
3807e26d 626 hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
1da177e4
LT
627
628 /* clear interrupt enables, set irq latency */
629 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
630 log2_irq_thresh = 0;
631 temp = 1 << (16 + log2_irq_thresh);
5a9cdf33
AD
632 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
633 ehci->has_ppcd = 1;
634 ehci_dbg(ehci, "enable per-port change event\n");
635 temp |= CMD_PPCEE;
636 }
1da177e4
LT
637 if (HCC_CANPARK(hcc_params)) {
638 /* HW default park == 3, on hardware that supports it (like
639 * NVidia and ALI silicon), maximizes throughput on the async
640 * schedule by avoiding QH fetches between transfers.
641 *
642 * With fast usb storage devices and NForce2, "park" seems to
643 * make problems: throughput reduction (!), data errors...
644 */
645 if (park) {
18807521 646 park = min(park, (unsigned) 3);
1da177e4
LT
647 temp |= CMD_PARK;
648 temp |= park << 8;
649 }
18807521 650 ehci_dbg(ehci, "park %d\n", park);
1da177e4 651 }
18807521 652 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
1da177e4
LT
653 /* periodic schedule size can be smaller than default */
654 temp &= ~(3 << 2);
655 temp |= (EHCI_TUNE_FLS << 2);
1da177e4 656 }
48f24970
AD
657 if (HCC_LPM(hcc_params)) {
658 /* support link power management EHCI 1.1 addendum */
659 ehci_dbg(ehci, "support lpm\n");
660 ehci->has_lpm = 1;
661 if (hird > 0xf) {
662 ehci_dbg(ehci, "hird %d invalid, use default 0",
663 hird);
664 hird = 0;
665 }
666 temp |= hird << 24;
667 }
18807521
DB
668 ehci->command = temp;
669
40f8db8f 670 /* Accept arbitrarily long scatter-gather lists */
4307a28e
AR
671 if (!(hcd->driver->flags & HCD_LOCAL_MEM))
672 hcd->self.sg_tablesize = ~0;
18807521
DB
673 return 0;
674}
675
676/* start HC running; it's halted, ehci_init() has been run (once) */
677static int ehci_run (struct usb_hcd *hcd)
678{
679 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
680 int retval;
681 u32 temp;
682 u32 hcc_params;
683
1d619f12 684 hcd->uses_new_polling = 1;
1d619f12 685
18807521 686 /* EHCI spec section 4.1 */
bcf40815
MC
687 /*
688 * TDI driver does the ehci_reset in their reset callback.
689 * Don't reset here, because configuration settings will
690 * vanish.
691 */
692 if (!ehci_is_TDI(ehci) && (retval = ehci_reset(ehci)) != 0) {
18807521
DB
693 ehci_mem_cleanup(ehci);
694 return retval;
695 }
083522d7
BH
696 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
697 ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
18807521
DB
698
699 /*
700 * hcc_params controls whether ehci->regs->segment must (!!!)
701 * be used; it constrains QH/ITD/SITD and QTD locations.
702 * pci_pool consistent memory always uses segment zero.
703 * streaming mappings for I/O buffers, like pci_map_single(),
704 * can return segments above 4GB, if the device allows.
705 *
706 * NOTE: the dma mask is visible through dma_supported(), so
707 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
708 * Scsi_Host.highmem_io, and so forth. It's readonly to all
709 * host side drivers though.
710 */
083522d7 711 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
18807521 712 if (HCC_64BIT_ADDR(hcc_params)) {
083522d7 713 ehci_writel(ehci, 0, &ehci->regs->segment);
18807521
DB
714#if 0
715// this is deeply broken on almost all architectures
6a35528a 716 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
18807521
DB
717 ehci_info(ehci, "enabled 64bit DMA\n");
718#endif
719 }
720
721
1da177e4
LT
722 // Philips, Intel, and maybe others need CMD_RUN before the
723 // root hub will detect new devices (why?); NEC doesn't
18807521
DB
724 ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
725 ehci->command |= CMD_RUN;
083522d7 726 ehci_writel(ehci, ehci->command, &ehci->regs->command);
18807521 727 dbg_cmd (ehci, "init", ehci->command);
1da177e4 728
1da177e4
LT
729 /*
730 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
731 * are explicitly handed to companion controller(s), so no TT is
732 * involved with the root hub. (Except where one is integrated,
733 * and there's no companion controller unless maybe for USB OTG.)
32fe0198
AS
734 *
735 * Turning on the CF flag will transfer ownership of all ports
736 * from the companions to the EHCI controller. If any of the
737 * companions are in the middle of a port reset at the time, it
738 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
1cb52658
DB
739 * guarantees that no resets are in progress. After we set CF,
740 * a short delay lets the hardware catch up; new resets shouldn't
741 * be started before the port switching actions could complete.
1da177e4 742 */
32fe0198 743 down_write(&ehci_cf_port_reset_rwsem);
e8799906 744 ehci->rh_state = EHCI_RH_RUNNING;
083522d7
BH
745 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
746 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1cb52658 747 msleep(5);
32fe0198 748 up_write(&ehci_cf_port_reset_rwsem);
ee4ecb8a 749 ehci->last_periodic_enable = ktime_get_real();
1da177e4 750
c430131a 751 temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
1da177e4 752 ehci_info (ehci,
2b70f073 753 "USB %x.%x started, EHCI %x.%02x%s\n",
7ff71d6a 754 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
2b70f073 755 temp >> 8, temp & 0xff,
93f1a47c 756 ignore_oc ? ", overcurrent ignored" : "");
1da177e4 757
083522d7
BH
758 ehci_writel(ehci, INTR_MASK,
759 &ehci->regs->intr_enable); /* Turn On Interrupts */
1da177e4 760
18807521
DB
761 /* GRR this is run-once init(), being done every time the HC starts.
762 * So long as they're part of class devices, we can't do it init()
763 * since the class device isn't created that early.
764 */
765 create_debug_files(ehci);
4c67045b 766 create_sysfs_files(ehci);
1da177e4
LT
767
768 return 0;
769}
770
2093c6b4
MC
771static int __maybe_unused ehci_setup (struct usb_hcd *hcd)
772{
773 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
774 int retval;
775
776 ehci->regs = (void __iomem *)ehci->caps +
777 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
778 dbg_hcs_params(ehci, "reset");
779 dbg_hcc_params(ehci, "reset");
780
781 /* cache this readonly data; minimize chip reads */
782 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
783
784 ehci->sbrn = HCD_USB2;
785
786 retval = ehci_halt(ehci);
787 if (retval)
788 return retval;
789
790 /* data structure init */
791 retval = ehci_init(hcd);
792 if (retval)
793 return retval;
794
795 ehci_reset(ehci);
796
797 return 0;
798}
799
1da177e4
LT
800/*-------------------------------------------------------------------------*/
801
7d12e780 802static irqreturn_t ehci_irq (struct usb_hcd *hcd)
1da177e4
LT
803{
804 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
67b2e029 805 u32 status, masked_status, pcd_status = 0, cmd;
1da177e4
LT
806 int bh;
807
808 spin_lock (&ehci->lock);
809
083522d7 810 status = ehci_readl(ehci, &ehci->regs->status);
1da177e4
LT
811
812 /* e.g. cardbus physical eject */
813 if (status == ~(u32) 0) {
814 ehci_dbg (ehci, "device removed\n");
815 goto dead;
816 }
817
69fff59d 818 /* Shared IRQ? */
67b2e029 819 masked_status = status & INTR_MASK;
e8799906 820 if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
1da177e4
LT
821 spin_unlock(&ehci->lock);
822 return IRQ_NONE;
823 }
824
825 /* clear (just) interrupts */
67b2e029 826 ehci_writel(ehci, masked_status, &ehci->regs->status);
e82cc128 827 cmd = ehci_readl(ehci, &ehci->regs->command);
1da177e4
LT
828 bh = 0;
829
9776afc8 830#ifdef VERBOSE_DEBUG
1da177e4
LT
831 /* unrequested/ignored: Frame List Rollover */
832 dbg_status (ehci, "irq", status);
833#endif
834
835 /* INT, ERR, and IAA interrupt rates can be throttled */
836
837 /* normal [4.15.1.2] or error [4.15.1.1] completion */
838 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
839 if (likely ((status & STS_ERR) == 0))
840 COUNT (ehci->stats.normal);
841 else
842 COUNT (ehci->stats.error);
843 bh = 1;
844 }
845
846 /* complete the unlinking of some qh [4.15.2.3] */
847 if (status & STS_IAA) {
e82cc128
DB
848 /* guard against (alleged) silicon errata */
849 if (cmd & CMD_IAAD) {
850 ehci_writel(ehci, cmd & ~CMD_IAAD,
851 &ehci->regs->command);
852 ehci_dbg(ehci, "IAA with IAAD still set?\n");
853 }
854 if (ehci->reclaim) {
855 COUNT(ehci->stats.reclaim);
856 end_unlink_async(ehci);
857 } else
858 ehci_dbg(ehci, "IAA with nothing to reclaim?\n");
1da177e4
LT
859 }
860
861 /* remote wakeup [4.3.1] */
d97cc2f2 862 if (status & STS_PCD) {
1da177e4 863 unsigned i = HCS_N_PORTS (ehci->hcs_params);
5a9cdf33 864 u32 ppcd = 0;
d1b1842c
DB
865
866 /* kick root hub later */
1d619f12 867 pcd_status = status;
1da177e4
LT
868
869 /* resume root hub? */
eafe5b99 870 if (!(cmd & CMD_RUN))
8c03356a 871 usb_hcd_resume_root_hub(hcd);
1da177e4 872
5a9cdf33
AD
873 /* get per-port change detect bits */
874 if (ehci->has_ppcd)
875 ppcd = status >> 16;
876
1da177e4 877 while (i--) {
5a9cdf33
AD
878 int pstatus;
879
880 /* leverage per-port change bits feature */
881 if (ehci->has_ppcd && !(ppcd & (1 << i)))
882 continue;
883 pstatus = ehci_readl(ehci,
884 &ehci->regs->port_status[i]);
b972b68c
DB
885
886 if (pstatus & PORT_OWNER)
1da177e4 887 continue;
eafe5b99
AS
888 if (!(test_bit(i, &ehci->suspended_ports) &&
889 ((pstatus & PORT_RESUME) ||
890 !(pstatus & PORT_SUSPEND)) &&
891 (pstatus & PORT_PE) &&
892 ehci->reset_done[i] == 0))
1da177e4
LT
893 continue;
894
895 /* start 20 msec resume signaling from this port,
896 * and make khubd collect PORT_STAT_C_SUSPEND to
49d0f078
AS
897 * stop that signaling. Use 5 ms extra for safety,
898 * like usb_port_resume() does.
1da177e4 899 */
49d0f078 900 ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
1da177e4 901 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
61e8b858 902 mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
1da177e4
LT
903 }
904 }
905
906 /* PCI errors [4.15.2.4] */
907 if (unlikely ((status & STS_FATAL) != 0)) {
67b2e029 908 ehci_err(ehci, "fatal error\n");
eafe5b99
AS
909 dbg_cmd(ehci, "fatal", cmd);
910 dbg_status(ehci, "fatal", status);
67b2e029 911 ehci_halt(ehci);
1da177e4 912dead:
67b2e029
AS
913 ehci_reset(ehci);
914 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
69fff59d 915 usb_hc_died(hcd);
67b2e029
AS
916 /* generic layer kills/unlinks all urbs, then
917 * uses ehci_stop to clean up the rest
918 */
919 bh = 1;
1da177e4
LT
920 }
921
922 if (bh)
7d12e780 923 ehci_work (ehci);
1da177e4 924 spin_unlock (&ehci->lock);
d1b1842c 925 if (pcd_status)
1d619f12 926 usb_hcd_poll_rh_status(hcd);
1da177e4
LT
927 return IRQ_HANDLED;
928}
929
930/*-------------------------------------------------------------------------*/
931
932/*
933 * non-error returns are a promise to giveback() the urb later
934 * we drop ownership so next owner (or urb unlink) can get it
935 *
936 * urb + dev is in hcd.self.controller.urb_list
937 * we're queueing TDs onto software and hardware lists
938 *
939 * hcd-specific init for hcpriv hasn't been done yet
940 *
941 * NOTE: control, bulk, and interrupt share the same code to append TDs
942 * to a (possibly active) QH, and the same QH scanning code.
943 */
944static int ehci_urb_enqueue (
945 struct usb_hcd *hcd,
1da177e4 946 struct urb *urb,
55016f10 947 gfp_t mem_flags
1da177e4
LT
948) {
949 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
950 struct list_head qtd_list;
951
952 INIT_LIST_HEAD (&qtd_list);
953
954 switch (usb_pipetype (urb->pipe)) {
25b70a86
DB
955 case PIPE_CONTROL:
956 /* qh_completions() code doesn't handle all the fault cases
957 * in multi-TD control transfers. Even 1KB is rare anyway.
958 */
959 if (urb->transfer_buffer_length > (16 * 1024))
960 return -EMSGSIZE;
961 /* FALLTHROUGH */
962 /* case PIPE_BULK: */
1da177e4
LT
963 default:
964 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
965 return -ENOMEM;
e9df41c5 966 return submit_async(ehci, urb, &qtd_list, mem_flags);
1da177e4
LT
967
968 case PIPE_INTERRUPT:
969 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
970 return -ENOMEM;
e9df41c5 971 return intr_submit(ehci, urb, &qtd_list, mem_flags);
1da177e4
LT
972
973 case PIPE_ISOCHRONOUS:
974 if (urb->dev->speed == USB_SPEED_HIGH)
975 return itd_submit (ehci, urb, mem_flags);
976 else
977 return sitd_submit (ehci, urb, mem_flags);
978 }
979}
980
981static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
982{
07d29b63 983 /* failfast */
e8799906 984 if (ehci->rh_state != EHCI_RH_RUNNING && ehci->reclaim)
07d29b63
AS
985 end_unlink_async(ehci);
986
3a44494e
AS
987 /* If the QH isn't linked then there's nothing we can do
988 * unless we were called during a giveback, in which case
989 * qh_completions() has to deal with it.
990 */
991 if (qh->qh_state != QH_STATE_LINKED) {
992 if (qh->qh_state == QH_STATE_COMPLETING)
993 qh->needs_rescan = 1;
994 return;
995 }
07d29b63
AS
996
997 /* defer till later if busy */
3a44494e 998 if (ehci->reclaim) {
1da177e4
LT
999 struct ehci_qh *last;
1000
1001 for (last = ehci->reclaim;
1002 last->reclaim;
1003 last = last->reclaim)
1004 continue;
1005 qh->qh_state = QH_STATE_UNLINK_WAIT;
1006 last->reclaim = qh;
1007
07d29b63
AS
1008 /* start IAA cycle */
1009 } else
1da177e4
LT
1010 start_unlink_async (ehci, qh);
1011}
1012
1013/* remove from hardware lists
1014 * completions normally happen asynchronously
1015 */
1016
e9df41c5 1017static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4
LT
1018{
1019 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1020 struct ehci_qh *qh;
1021 unsigned long flags;
e9df41c5 1022 int rc;
1da177e4
LT
1023
1024 spin_lock_irqsave (&ehci->lock, flags);
e9df41c5
AS
1025 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1026 if (rc)
1027 goto done;
1028
1da177e4
LT
1029 switch (usb_pipetype (urb->pipe)) {
1030 // case PIPE_CONTROL:
1031 // case PIPE_BULK:
1032 default:
1033 qh = (struct ehci_qh *) urb->hcpriv;
1034 if (!qh)
1035 break;
07d29b63
AS
1036 switch (qh->qh_state) {
1037 case QH_STATE_LINKED:
1038 case QH_STATE_COMPLETING:
1039 unlink_async(ehci, qh);
1040 break;
1041 case QH_STATE_UNLINK:
1042 case QH_STATE_UNLINK_WAIT:
1043 /* already started */
1044 break;
1045 case QH_STATE_IDLE:
7a0f0d95
AS
1046 /* QH might be waiting for a Clear-TT-Buffer */
1047 qh_completions(ehci, qh);
07d29b63
AS
1048 break;
1049 }
1da177e4
LT
1050 break;
1051
1052 case PIPE_INTERRUPT:
1053 qh = (struct ehci_qh *) urb->hcpriv;
1054 if (!qh)
1055 break;
1056 switch (qh->qh_state) {
1057 case QH_STATE_LINKED:
a448c9d8 1058 case QH_STATE_COMPLETING:
1da177e4 1059 intr_deschedule (ehci, qh);
a448c9d8 1060 break;
1da177e4 1061 case QH_STATE_IDLE:
7d12e780 1062 qh_completions (ehci, qh);
1da177e4
LT
1063 break;
1064 default:
1065 ehci_dbg (ehci, "bogus qh %p state %d\n",
1066 qh, qh->qh_state);
1067 goto done;
1068 }
1da177e4
LT
1069 break;
1070
1071 case PIPE_ISOCHRONOUS:
1072 // itd or sitd ...
1073
1074 // wait till next completion, do it then.
1075 // completion irqs can wait up to 1024 msec,
1076 break;
1077 }
1078done:
1079 spin_unlock_irqrestore (&ehci->lock, flags);
e9df41c5 1080 return rc;
1da177e4
LT
1081}
1082
1083/*-------------------------------------------------------------------------*/
1084
1085// bulk qh holds the data toggle
1086
1087static void
1088ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1089{
1090 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1091 unsigned long flags;
1092 struct ehci_qh *qh, *tmp;
1093
1094 /* ASSERT: any requests/urbs are being unlinked */
1095 /* ASSERT: nobody can be submitting urbs for this any more */
1096
1097rescan:
1098 spin_lock_irqsave (&ehci->lock, flags);
1099 qh = ep->hcpriv;
1100 if (!qh)
1101 goto done;
1102
1103 /* endpoints can be iso streams. for now, we don't
1104 * accelerate iso completions ... so spin a while.
1105 */
1082f57a 1106 if (qh->hw == NULL) {
1da177e4
LT
1107 ehci_vdbg (ehci, "iso delay\n");
1108 goto idle_timeout;
1109 }
1110
e8799906 1111 if (ehci->rh_state != EHCI_RH_RUNNING)
1da177e4
LT
1112 qh->qh_state = QH_STATE_IDLE;
1113 switch (qh->qh_state) {
1114 case QH_STATE_LINKED:
3a44494e 1115 case QH_STATE_COMPLETING:
1da177e4
LT
1116 for (tmp = ehci->async->qh_next.qh;
1117 tmp && tmp != qh;
1118 tmp = tmp->qh_next.qh)
1119 continue;
02e2c51b
AS
1120 /* periodic qh self-unlinks on empty, and a COMPLETING qh
1121 * may already be unlinked.
1122 */
1123 if (tmp)
1124 unlink_async(ehci, qh);
1da177e4
LT
1125 /* FALL THROUGH */
1126 case QH_STATE_UNLINK: /* wait for hw to finish? */
07d29b63 1127 case QH_STATE_UNLINK_WAIT:
1da177e4
LT
1128idle_timeout:
1129 spin_unlock_irqrestore (&ehci->lock, flags);
22c43863 1130 schedule_timeout_uninterruptible(1);
1da177e4
LT
1131 goto rescan;
1132 case QH_STATE_IDLE: /* fully unlinked */
914b7012
AS
1133 if (qh->clearing_tt)
1134 goto idle_timeout;
1da177e4
LT
1135 if (list_empty (&qh->qtd_list)) {
1136 qh_put (qh);
1137 break;
1138 }
1139 /* else FALL THROUGH */
1140 default:
1da177e4
LT
1141 /* caller was supposed to have unlinked any requests;
1142 * that's not our job. just leak this memory.
1143 */
1144 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1145 qh, ep->desc.bEndpointAddress, qh->qh_state,
1146 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1147 break;
1148 }
1149 ep->hcpriv = NULL;
1150done:
1151 spin_unlock_irqrestore (&ehci->lock, flags);
1da177e4
LT
1152}
1153
b18ffd49
AS
1154static void
1155ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1156{
1157 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1158 struct ehci_qh *qh;
1159 int eptype = usb_endpoint_type(&ep->desc);
a455212d
AS
1160 int epnum = usb_endpoint_num(&ep->desc);
1161 int is_out = usb_endpoint_dir_out(&ep->desc);
1162 unsigned long flags;
b18ffd49
AS
1163
1164 if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1165 return;
1166
a455212d 1167 spin_lock_irqsave(&ehci->lock, flags);
b18ffd49
AS
1168 qh = ep->hcpriv;
1169
1170 /* For Bulk and Interrupt endpoints we maintain the toggle state
1171 * in the hardware; the toggle bits in udev aren't used at all.
1172 * When an endpoint is reset by usb_clear_halt() we must reset
1173 * the toggle bit in the QH.
1174 */
1175 if (qh) {
a455212d 1176 usb_settoggle(qh->dev, epnum, is_out, 0);
b18ffd49
AS
1177 if (!list_empty(&qh->qtd_list)) {
1178 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
3a44494e
AS
1179 } else if (qh->qh_state == QH_STATE_LINKED ||
1180 qh->qh_state == QH_STATE_COMPLETING) {
a455212d
AS
1181
1182 /* The toggle value in the QH can't be updated
1183 * while the QH is active. Unlink it now;
1184 * re-linking will call qh_refresh().
b18ffd49 1185 */
a448c9d8 1186 if (eptype == USB_ENDPOINT_XFER_BULK)
a455212d 1187 unlink_async(ehci, qh);
a448c9d8 1188 else
a455212d 1189 intr_deschedule(ehci, qh);
b18ffd49
AS
1190 }
1191 }
a455212d 1192 spin_unlock_irqrestore(&ehci->lock, flags);
b18ffd49
AS
1193}
1194
7ff71d6a
MP
1195static int ehci_get_frame (struct usb_hcd *hcd)
1196{
1197 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
083522d7
BH
1198 return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
1199 ehci->periodic_size;
7ff71d6a 1200}
1da177e4
LT
1201
1202/*-------------------------------------------------------------------------*/
1203
2b70f073 1204MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4
LT
1205MODULE_AUTHOR (DRIVER_AUTHOR);
1206MODULE_LICENSE ("GPL");
1207
7ff71d6a
MP
1208#ifdef CONFIG_PCI
1209#include "ehci-pci.c"
01cced25 1210#define PCI_DRIVER ehci_pci_driver
7ff71d6a 1211#endif
1da177e4 1212
ba02978a 1213#ifdef CONFIG_USB_EHCI_FSL
80cb9aee 1214#include "ehci-fsl.c"
01cced25 1215#define PLATFORM_DRIVER ehci_fsl_driver
80cb9aee
RV
1216#endif
1217
7e8d5cd9
DM
1218#ifdef CONFIG_USB_EHCI_MXC
1219#include "ehci-mxc.c"
1220#define PLATFORM_DRIVER ehci_mxc_driver
1221#endif
1222
60b0bf0f 1223#ifdef CONFIG_USB_EHCI_SH
63c84552
PM
1224#include "ehci-sh.c"
1225#define PLATFORM_DRIVER ehci_hcd_sh_driver
1226#endif
1227
dfbaa7d8 1228#ifdef CONFIG_SOC_AU1200
76fa9a24 1229#include "ehci-au1xxx.c"
01cced25 1230#define PLATFORM_DRIVER ehci_hcd_au1xxx_driver
76fa9a24
JC
1231#endif
1232
7f124f4b 1233#ifdef CONFIG_USB_EHCI_HCD_OMAP
54ab2b02
FB
1234#include "ehci-omap.c"
1235#define PLATFORM_DRIVER ehci_hcd_omap_driver
1236#endif
1237
ad75a410
GL
1238#ifdef CONFIG_PPC_PS3
1239#include "ehci-ps3.c"
7a4eb7fd 1240#define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
ad75a410
GL
1241#endif
1242
da0e8fb0
VB
1243#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1244#include "ehci-ppc-of.c"
1245#define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1246#endif
1247
08d3c18e
JZ
1248#ifdef CONFIG_XPS_USB_HCD_XILINX
1249#include "ehci-xilinx-of.c"
1f23b2d9 1250#define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
08d3c18e
JZ
1251#endif
1252
705a7521 1253#ifdef CONFIG_PLAT_ORION
e96ffe2f
TP
1254#include "ehci-orion.c"
1255#define PLATFORM_DRIVER ehci_orion_driver
1256#endif
1257
91bc4d31
VB
1258#ifdef CONFIG_ARCH_IXP4XX
1259#include "ehci-ixp4xx.c"
1260#define PLATFORM_DRIVER ixp4xx_ehci_driver
1261#endif
1262
586dfc8c
WZ
1263#ifdef CONFIG_USB_W90X900_EHCI
1264#include "ehci-w90x900.c"
1265#define PLATFORM_DRIVER ehci_hcd_w90x900_driver
1266#endif
1267
501c9c08
NF
1268#ifdef CONFIG_ARCH_AT91
1269#include "ehci-atmel.c"
1270#define PLATFORM_DRIVER ehci_atmel_driver
1271#endif
1272
1643accd
DD
1273#ifdef CONFIG_USB_OCTEON_EHCI
1274#include "ehci-octeon.c"
1275#define PLATFORM_DRIVER ehci_octeon_driver
1276#endif
1277
760efe69
ML
1278#ifdef CONFIG_USB_CNS3XXX_EHCI
1279#include "ehci-cns3xxx.c"
1280#define PLATFORM_DRIVER cns3xxx_ehci_driver
1281#endif
1282
ad78acaf
AC
1283#ifdef CONFIG_ARCH_VT8500
1284#include "ehci-vt8500.c"
1285#define PLATFORM_DRIVER vt8500_ehci_driver
1286#endif
1287
c8c38de9
DS
1288#ifdef CONFIG_PLAT_SPEAR
1289#include "ehci-spear.c"
1290#define PLATFORM_DRIVER spear_ehci_hcd_driver
1291#endif
1292
b0848aea
PK
1293#ifdef CONFIG_USB_EHCI_MSM
1294#include "ehci-msm.c"
1295#define PLATFORM_DRIVER ehci_msm_driver
1296#endif
1297
22ced687
A
1298#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1299#include "ehci-pmcmsp.c"
1300#define PLATFORM_DRIVER ehci_hcd_msp_driver
1301#endif
1302
79ad3b5a
BG
1303#ifdef CONFIG_USB_EHCI_TEGRA
1304#include "ehci-tegra.c"
1305#define PLATFORM_DRIVER tegra_ehci_driver
1306#endif
1307
1bcc5aa8
JS
1308#ifdef CONFIG_USB_EHCI_S5P
1309#include "ehci-s5p.c"
1310#define PLATFORM_DRIVER s5p_ehci_driver
1311#endif
1312
502fa841
GJ
1313#ifdef CONFIG_USB_EHCI_ATH79
1314#include "ehci-ath79.c"
1315#define PLATFORM_DRIVER ehci_ath79_driver
1316#endif
1317
9be03929
JA
1318#ifdef CONFIG_SPARC_LEON
1319#include "ehci-grlib.c"
1320#define PLATFORM_DRIVER ehci_grlib_driver
1321#endif
1322
3abd7f68
TU
1323#ifdef CONFIG_USB_PXA168_EHCI
1324#include "ehci-pxa168.c"
1325#define PLATFORM_DRIVER ehci_pxa168_driver
1326#endif
1327
23106343
J
1328#ifdef CONFIG_NLM_XLR
1329#include "ehci-xls.c"
1330#define PLATFORM_DRIVER ehci_xls_driver
1331#endif
1332
ad75a410 1333#if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1f23b2d9
GL
1334 !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
1335 !defined(XILINX_OF_PLATFORM_DRIVER)
7ff71d6a
MP
1336#error "missing bus glue for ehci-hcd"
1337#endif
01cced25
KG
1338
1339static int __init ehci_hcd_init(void)
1340{
1341 int retval = 0;
1342
2b70f073
AS
1343 if (usb_disabled())
1344 return -ENODEV;
1345
1346 printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
9beeee65
AS
1347 set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1348 if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1349 test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1350 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1351 " before uhci_hcd and ohci_hcd, not after\n");
1352
01cced25
KG
1353 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1354 hcd_name,
1355 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1356 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1357
694cc208 1358#ifdef DEBUG
08f4e586 1359 ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
9beeee65
AS
1360 if (!ehci_debug_root) {
1361 retval = -ENOENT;
1362 goto err_debug;
1363 }
694cc208
TJ
1364#endif
1365
01cced25
KG
1366#ifdef PLATFORM_DRIVER
1367 retval = platform_driver_register(&PLATFORM_DRIVER);
da0e8fb0
VB
1368 if (retval < 0)
1369 goto clean0;
01cced25
KG
1370#endif
1371
1372#ifdef PCI_DRIVER
1373 retval = pci_register_driver(&PCI_DRIVER);
da0e8fb0
VB
1374 if (retval < 0)
1375 goto clean1;
ad75a410
GL
1376#endif
1377
1378#ifdef PS3_SYSTEM_BUS_DRIVER
7a4eb7fd 1379 retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
da0e8fb0
VB
1380 if (retval < 0)
1381 goto clean2;
694cc208 1382#endif
da0e8fb0
VB
1383
1384#ifdef OF_PLATFORM_DRIVER
d35fb641 1385 retval = platform_driver_register(&OF_PLATFORM_DRIVER);
da0e8fb0
VB
1386 if (retval < 0)
1387 goto clean3;
1388#endif
1f23b2d9
GL
1389
1390#ifdef XILINX_OF_PLATFORM_DRIVER
d35fb641 1391 retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
1f23b2d9
GL
1392 if (retval < 0)
1393 goto clean4;
1394#endif
da0e8fb0
VB
1395 return retval;
1396
1f23b2d9 1397#ifdef XILINX_OF_PLATFORM_DRIVER
d35fb641 1398 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1f23b2d9
GL
1399clean4:
1400#endif
da0e8fb0 1401#ifdef OF_PLATFORM_DRIVER
d35fb641 1402 platform_driver_unregister(&OF_PLATFORM_DRIVER);
da0e8fb0
VB
1403clean3:
1404#endif
1405#ifdef PS3_SYSTEM_BUS_DRIVER
1406 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1407clean2:
ad75a410
GL
1408#endif
1409#ifdef PCI_DRIVER
da0e8fb0
VB
1410 pci_unregister_driver(&PCI_DRIVER);
1411clean1:
ad75a410 1412#endif
da0e8fb0
VB
1413#ifdef PLATFORM_DRIVER
1414 platform_driver_unregister(&PLATFORM_DRIVER);
1415clean0:
1416#endif
1417#ifdef DEBUG
1418 debugfs_remove(ehci_debug_root);
1419 ehci_debug_root = NULL;
9beeee65 1420err_debug:
a9b6148d 1421#endif
9beeee65 1422 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
01cced25
KG
1423 return retval;
1424}
1425module_init(ehci_hcd_init);
1426
1427static void __exit ehci_hcd_cleanup(void)
1428{
1f23b2d9 1429#ifdef XILINX_OF_PLATFORM_DRIVER
d35fb641 1430 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
1f23b2d9 1431#endif
da0e8fb0 1432#ifdef OF_PLATFORM_DRIVER
d35fb641 1433 platform_driver_unregister(&OF_PLATFORM_DRIVER);
da0e8fb0 1434#endif
01cced25
KG
1435#ifdef PLATFORM_DRIVER
1436 platform_driver_unregister(&PLATFORM_DRIVER);
1437#endif
1438#ifdef PCI_DRIVER
1439 pci_unregister_driver(&PCI_DRIVER);
1440#endif
ad75a410 1441#ifdef PS3_SYSTEM_BUS_DRIVER
7a4eb7fd 1442 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
ad75a410 1443#endif
694cc208
TJ
1444#ifdef DEBUG
1445 debugfs_remove(ehci_debug_root);
1446#endif
9beeee65 1447 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
01cced25
KG
1448}
1449module_exit(ehci_hcd_cleanup);
1450