blob: 13ead00aecd503280dc2e29852c5fc1e17fe8c73 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (c) 2000-2004 by David Brownell
David Brownell53bd6a62006-08-30 14:50:06 -07003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/module.h>
20#include <linux/pci.h>
21#include <linux/dmapool.h>
22#include <linux/kernel.h>
23#include <linux/delay.h>
24#include <linux/ioport.h>
25#include <linux/sched.h>
Ming Lei3c04e202008-09-18 23:06:21 +080026#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/errno.h>
28#include <linux/init.h>
29#include <linux/timer.h>
Oliver Neukumee4ecb82009-11-27 15:17:59 +010030#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/list.h>
32#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/usb.h>
34#include <linux/moduleparam.h>
35#include <linux/dma-mapping.h>
Tony Jones694cc202007-09-11 14:07:31 -070036#include <linux/debugfs.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090037#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#include "../core/hcd.h"
40
41#include <asm/byteorder.h>
42#include <asm/io.h>
43#include <asm/irq.h>
44#include <asm/system.h>
45#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47/*-------------------------------------------------------------------------*/
48
49/*
50 * EHCI hc_driver implementation ... experimental, incomplete.
51 * Based on the final 1.0 register interface specification.
52 *
53 * USB 2.0 shows up in upcoming www.pcmcia.org technology.
54 * First was PCMCIA, like ISA; then CardBus, which is PCI.
55 * Next comes "CardBay", using USB 2.0 signals.
56 *
57 * Contains additional contributions by Brad Hards, Rory Bolt, and others.
58 * Special thanks to Intel and VIA for providing host controllers to
59 * test this driver on, and Cypress (including In-System Design) for
60 * providing early devices for those host controllers to talk to!
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 */
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define DRIVER_AUTHOR "David Brownell"
64#define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
65
66static const char hcd_name [] = "ehci_hcd";
67
68
David Brownell9776afc2008-02-01 11:42:05 -080069#undef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#undef EHCI_URB_TRACE
71
72#ifdef DEBUG
73#define EHCI_STATS
74#endif
75
76/* magic numbers that can affect system performance */
77#define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */
78#define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */
79#define EHCI_TUNE_RL_TT 0
80#define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */
81#define EHCI_TUNE_MULT_TT 1
82#define EHCI_TUNE_FLS 2 /* (small) 256 frame schedule */
83
Alan Stern07d29b62007-12-11 16:05:30 -050084#define EHCI_IAA_MSECS 10 /* arbitrary */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085#define EHCI_IO_JIFFIES (HZ/10) /* io watchdog > irq_thresh */
86#define EHCI_ASYNC_JIFFIES (HZ/20) /* async idle timeout */
David Brownellb9638012008-06-03 22:21:55 -070087#define EHCI_SHRINK_FRAMES 5 /* async qh unlink delay */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89/* Initial IRQ latency: faster than hw default */
90static int log2_irq_thresh = 0; // 0 to 6
91module_param (log2_irq_thresh, int, S_IRUGO);
92MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
93
94/* initial park setting: slower than hw default */
95static unsigned park = 0;
96module_param (park, uint, S_IRUGO);
97MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
98
David Brownell93f1a472006-11-16 23:34:58 -080099/* for flakey hardware, ignore overcurrent indicators */
100static int ignore_oc = 0;
101module_param (ignore_oc, bool, S_IRUGO);
102MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
105
106/*-------------------------------------------------------------------------*/
107
108#include "ehci.h"
109#include "ehci-dbg.c"
110
111/*-------------------------------------------------------------------------*/
112
Alan Sternbc298472009-02-11 14:26:38 -0500113static void
114timer_action(struct ehci_hcd *ehci, enum ehci_timer_action action)
115{
116 /* Don't override timeouts which shrink or (later) disable
117 * the async ring; just the I/O watchdog. Note that if a
118 * SHRINK were pending, OFF would never be requested.
119 */
120 if (timer_pending(&ehci->watchdog)
121 && ((BIT(TIMER_ASYNC_SHRINK) | BIT(TIMER_ASYNC_OFF))
122 & ehci->actions))
123 return;
124
125 if (!test_and_set_bit(action, &ehci->actions)) {
126 unsigned long t;
127
128 switch (action) {
129 case TIMER_IO_WATCHDOG:
Alek Du403dbd32009-07-13 17:30:41 +0800130 if (!ehci->need_io_watchdog)
131 return;
Alan Sternbc298472009-02-11 14:26:38 -0500132 t = EHCI_IO_JIFFIES;
133 break;
134 case TIMER_ASYNC_OFF:
135 t = EHCI_ASYNC_JIFFIES;
136 break;
137 /* case TIMER_ASYNC_SHRINK: */
138 default:
139 /* add a jiffie since we synch against the
140 * 8 KHz uframe counter.
141 */
142 t = DIV_ROUND_UP(EHCI_SHRINK_FRAMES * HZ, 1000) + 1;
143 break;
144 }
145 mod_timer(&ehci->watchdog, t + jiffies);
146 }
147}
148
149/*-------------------------------------------------------------------------*/
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/*
152 * handshake - spin reading hc until handshake completes or fails
153 * @ptr: address of hc register to be read
154 * @mask: bits to look at in result of read
155 * @done: value of those bits when handshake succeeds
156 * @usec: timeout in microseconds
157 *
158 * Returns negative errno, or zero on success
159 *
160 * Success happens when the "mask" bits have the specified value (hardware
161 * handshake done). There are two failure modes: "usec" have passed (major
162 * hardware flakeout), or the register reads as all-ones (hardware removed).
163 *
164 * That last failure should_only happen in cases like physical cardbus eject
165 * before driver shutdown. But it also seems to be caused by bugs in cardbus
166 * bridge shutdown: shutting down the bridge before the devices using it.
167 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100168static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
169 u32 mask, u32 done, int usec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
171 u32 result;
172
173 do {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100174 result = ehci_readl(ehci, ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 if (result == ~(u32)0) /* card removed */
176 return -ENODEV;
177 result &= mask;
178 if (result == done)
179 return 0;
180 udelay (1);
181 usec--;
182 } while (usec > 0);
183 return -ETIMEDOUT;
184}
185
186/* force HC to halt state from unknown (EHCI spec section 2.3) */
187static int ehci_halt (struct ehci_hcd *ehci)
188{
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100189 u32 temp = ehci_readl(ehci, &ehci->regs->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
David Brownell72f30b62005-09-27 10:19:39 -0700191 /* disable any irqs left enabled by previous code */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100192 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
David Brownell72f30b62005-09-27 10:19:39 -0700193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 if ((temp & STS_HALT) != 0)
195 return 0;
196
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100197 temp = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 temp &= ~CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100199 ehci_writel(ehci, temp, &ehci->regs->command);
200 return handshake (ehci, &ehci->regs->status,
201 STS_HALT, STS_HALT, 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
David Brownell0bcfeb32008-08-26 14:43:46 -0700204static int handshake_on_error_set_halt(struct ehci_hcd *ehci, void __iomem *ptr,
205 u32 mask, u32 done, int usec)
206{
207 int error;
208
209 error = handshake(ehci, ptr, mask, done, usec);
210 if (error) {
211 ehci_halt(ehci);
212 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
Ozan Çağlayan65cb76b2009-10-13 08:37:09 +0300213 ehci_err(ehci, "force halt; handshake %p %08x %08x -> %d\n",
David Brownell0bcfeb32008-08-26 14:43:46 -0700214 ptr, mask, done, error);
215 }
216
217 return error;
218}
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220/* put TDI/ARC silicon into EHCI mode */
221static void tdi_reset (struct ehci_hcd *ehci)
222{
223 u32 __iomem *reg_ptr;
224 u32 tmp;
225
Vladimir Barinovd23a1372007-05-23 20:07:48 +0400226 reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100227 tmp = ehci_readl(ehci, reg_ptr);
Vladimir Barinovd23a1372007-05-23 20:07:48 +0400228 tmp |= USBMODE_CM_HC;
229 /* The default byte access to MMR space is LE after
230 * controller reset. Set the required endian mode
231 * for transfer buffers to match the host microprocessor
232 */
233 if (ehci_big_endian_mmio(ehci))
234 tmp |= USBMODE_BE;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100235 ehci_writel(ehci, tmp, reg_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236}
237
238/* reset a non-running (STS_HALT == 1) controller */
239static int ehci_reset (struct ehci_hcd *ehci)
240{
241 int retval;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100242 u32 command = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Jason Wessel8d053c72009-08-20 15:39:54 -0500244 /* If the EHCI debug controller is active, special care must be
245 * taken before and after a host controller reset */
246 if (ehci->debug && !dbgp_reset_prep())
247 ehci->debug = NULL;
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 command |= CMD_RESET;
250 dbg_cmd (ehci, "reset", command);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100251 ehci_writel(ehci, command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
253 ehci->next_statechange = jiffies;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100254 retval = handshake (ehci, &ehci->regs->command,
255 CMD_RESET, 0, 250 * 1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Alek Du331ac6b2009-07-13 12:41:20 +0800257 if (ehci->has_hostpc) {
258 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
259 (u32 __iomem *)(((u8 *)ehci->regs) + USBMODE_EX));
260 ehci_writel(ehci, TXFIFO_DEFAULT,
261 (u32 __iomem *)(((u8 *)ehci->regs) + TXFILLTUNING));
262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 if (retval)
264 return retval;
265
266 if (ehci_is_TDI(ehci))
267 tdi_reset (ehci);
268
Jason Wessel8d053c72009-08-20 15:39:54 -0500269 if (ehci->debug)
270 dbgp_external_startup();
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 return retval;
273}
274
275/* idle the controller (from running) */
276static void ehci_quiesce (struct ehci_hcd *ehci)
277{
278 u32 temp;
279
280#ifdef DEBUG
281 if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
282 BUG ();
283#endif
284
285 /* wait for any schedule enables/disables to take effect */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100286 temp = ehci_readl(ehci, &ehci->regs->command) << 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 temp &= STS_ASS | STS_PSS;
Karsten Wiesec765d4c2008-02-16 13:44:42 -0800288 if (handshake_on_error_set_halt(ehci, &ehci->regs->status,
289 STS_ASS | STS_PSS, temp, 16 * 125))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 /* then disable anything that's still active */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100293 temp = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100295 ehci_writel(ehci, temp, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297 /* hardware can take 16 microframes to turn off ... */
Karsten Wiesec765d4c2008-02-16 13:44:42 -0800298 handshake_on_error_set_halt(ehci, &ehci->regs->status,
299 STS_ASS | STS_PSS, 0, 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300}
301
302/*-------------------------------------------------------------------------*/
303
Alan Stern07d29b62007-12-11 16:05:30 -0500304static void end_unlink_async(struct ehci_hcd *ehci);
David Howells7d12e782006-10-05 14:55:46 +0100305static void ehci_work(struct ehci_hcd *ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307#include "ehci-hub.c"
308#include "ehci-mem.c"
309#include "ehci-q.c"
310#include "ehci-sched.c"
311
312/*-------------------------------------------------------------------------*/
313
Alan Stern07d29b62007-12-11 16:05:30 -0500314static void ehci_iaa_watchdog(unsigned long param)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315{
316 struct ehci_hcd *ehci = (struct ehci_hcd *) param;
317 unsigned long flags;
318
319 spin_lock_irqsave (&ehci->lock, flags);
320
David Brownelle82cc122008-03-07 13:49:42 -0800321 /* Lost IAA irqs wedge things badly; seen first with a vt8235.
322 * So we need this watchdog, but must protect it against both
323 * (a) SMP races against real IAA firing and retriggering, and
324 * (b) clean HC shutdown, when IAA watchdog was pending.
325 */
326 if (ehci->reclaim
327 && !timer_pending(&ehci->iaa_watchdog)
328 && HC_IS_RUNNING(ehci_to_hcd(ehci)->state)) {
329 u32 cmd, status;
Alan Stern07d29b62007-12-11 16:05:30 -0500330
David Brownelle82cc122008-03-07 13:49:42 -0800331 /* If we get here, IAA is *REALLY* late. It's barely
332 * conceivable that the system is so busy that CMD_IAAD
333 * is still legitimately set, so let's be sure it's
334 * clear before we read STS_IAA. (The HC should clear
335 * CMD_IAAD when it sets STS_IAA.)
336 */
337 cmd = ehci_readl(ehci, &ehci->regs->command);
338 if (cmd & CMD_IAAD)
339 ehci_writel(ehci, cmd & ~CMD_IAAD,
340 &ehci->regs->command);
341
342 /* If IAA is set here it either legitimately triggered
343 * before we cleared IAAD above (but _way_ late, so we'll
344 * still count it as lost) ... or a silicon erratum:
345 * - VIA seems to set IAA without triggering the IRQ;
346 * - IAAD potentially cleared without setting IAA.
347 */
348 status = ehci_readl(ehci, &ehci->regs->status);
349 if ((status & STS_IAA) || !(cmd & CMD_IAAD)) {
Greg Kroah-Hartman64f89792006-10-17 13:57:18 -0700350 COUNT (ehci->stats.lost_iaa);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100351 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
Greg Kroah-Hartman64f89792006-10-17 13:57:18 -0700352 }
David Brownelle82cc122008-03-07 13:49:42 -0800353
354 ehci_vdbg(ehci, "IAA watchdog: status %x cmd %x\n",
355 status, cmd);
Alan Stern07d29b62007-12-11 16:05:30 -0500356 end_unlink_async(ehci);
Greg Kroah-Hartman64f89792006-10-17 13:57:18 -0700357 }
358
Alan Stern07d29b62007-12-11 16:05:30 -0500359 spin_unlock_irqrestore(&ehci->lock, flags);
360}
361
362static void ehci_watchdog(unsigned long param)
363{
364 struct ehci_hcd *ehci = (struct ehci_hcd *) param;
365 unsigned long flags;
366
367 spin_lock_irqsave(&ehci->lock, flags);
368
369 /* stop async processing after it's idled a bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
David Brownell26f953f2006-09-18 17:03:16 -0700371 start_unlink_async (ehci, ehci->async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 /* ehci could run by timer, without IRQs ... */
David Howells7d12e782006-10-05 14:55:46 +0100374 ehci_work (ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 spin_unlock_irqrestore (&ehci->lock, flags);
377}
378
Alan Stern89037952007-02-13 14:55:27 -0500379/* On some systems, leaving remote wakeup enabled prevents system shutdown.
380 * The firmware seems to think that powering off is a wakeup event!
381 * This routine turns off remote wakeup and everything else, on all ports.
382 */
383static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
384{
385 int port = HCS_N_PORTS(ehci->hcs_params);
386
387 while (port--)
388 ehci_writel(ehci, PORT_RWC_BITS,
389 &ehci->regs->port_status[port]);
390}
391
Sarah Sharp21da84a2008-04-08 14:30:18 -0700392/*
393 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
394 * Should be called with ehci->lock held.
David Brownell72f30b62005-09-27 10:19:39 -0700395 */
Sarah Sharp21da84a2008-04-08 14:30:18 -0700396static void ehci_silence_controller(struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
Sarah Sharp21da84a2008-04-08 14:30:18 -0700398 ehci_halt(ehci);
Alan Stern89037952007-02-13 14:55:27 -0500399 ehci_turn_off_all_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 /* make BIOS/etc use companion controller during reboot */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100402 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
Alan Stern89037952007-02-13 14:55:27 -0500403
404 /* unblock posted writes */
405 ehci_readl(ehci, &ehci->regs->configured_flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
Sarah Sharp21da84a2008-04-08 14:30:18 -0700408/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
409 * This forcibly disables dma and IRQs, helping kexec and other cases
410 * where the next system software may expect clean state.
411 */
412static void ehci_shutdown(struct usb_hcd *hcd)
413{
414 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
415
416 del_timer_sync(&ehci->watchdog);
417 del_timer_sync(&ehci->iaa_watchdog);
418
419 spin_lock_irq(&ehci->lock);
420 ehci_silence_controller(ehci);
421 spin_unlock_irq(&ehci->lock);
422}
423
David Brownell56c1e262005-04-09 09:00:29 -0700424static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
425{
426 unsigned port;
427
428 if (!HCS_PPC (ehci->hcs_params))
429 return;
430
431 ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
432 for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
433 (void) ehci_hub_control(ehci_to_hcd(ehci),
434 is_on ? SetPortFeature : ClearPortFeature,
435 USB_PORT_FEAT_POWER,
436 port--, NULL, 0);
Alan Stern383975d2007-05-04 11:52:40 -0400437 /* Flush those writes */
438 ehci_readl(ehci, &ehci->regs->command);
David Brownell56c1e262005-04-09 09:00:29 -0700439 msleep(20);
440}
441
Matt Porter7ff71d62005-09-22 22:31:15 -0700442/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Matt Porter7ff71d62005-09-22 22:31:15 -0700444/*
445 * ehci_work is called from some interrupts, timers, and so on.
446 * it calls driver completion functions, after dropping ehci->lock.
447 */
David Howells7d12e782006-10-05 14:55:46 +0100448static void ehci_work (struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Matt Porter7ff71d62005-09-22 22:31:15 -0700450 timer_action_done (ehci, TIMER_IO_WATCHDOG);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Matt Porter7ff71d62005-09-22 22:31:15 -0700452 /* another CPU may drop ehci->lock during a schedule scan while
453 * it reports urb completions. this flag guards against bogus
454 * attempts at re-entrant schedule scanning.
455 */
456 if (ehci->scanning)
457 return;
458 ehci->scanning = 1;
David Howells7d12e782006-10-05 14:55:46 +0100459 scan_async (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700460 if (ehci->next_uframe != -1)
David Howells7d12e782006-10-05 14:55:46 +0100461 scan_periodic (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700462 ehci->scanning = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Matt Porter7ff71d62005-09-22 22:31:15 -0700464 /* the IO watchdog guards against hardware or driver bugs that
465 * misplace IRQs, and should let us run completely without IRQs.
466 * such lossage has been observed on both VT6202 and VT8235.
467 */
468 if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
469 (ehci->async->qh_next.ptr != NULL ||
470 ehci->periodic_sched != 0))
471 timer_action (ehci, TIMER_IO_WATCHDOG);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
Sarah Sharp21da84a2008-04-08 14:30:18 -0700474/*
475 * Called when the ehci_hcd module is removed.
476 */
Matt Porter7ff71d62005-09-22 22:31:15 -0700477static void ehci_stop (struct usb_hcd *hcd)
478{
479 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
480
481 ehci_dbg (ehci, "stop\n");
482
Matt Porter7ff71d62005-09-22 22:31:15 -0700483 /* no more interrupts ... */
484 del_timer_sync (&ehci->watchdog);
Alan Stern07d29b62007-12-11 16:05:30 -0500485 del_timer_sync(&ehci->iaa_watchdog);
Matt Porter7ff71d62005-09-22 22:31:15 -0700486
487 spin_lock_irq(&ehci->lock);
488 if (HC_IS_RUNNING (hcd->state))
489 ehci_quiesce (ehci);
490
Sarah Sharp21da84a2008-04-08 14:30:18 -0700491 ehci_silence_controller(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700492 ehci_reset (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700493 spin_unlock_irq(&ehci->lock);
494
Alan Stern57e06c12007-01-16 11:59:45 -0500495 remove_companion_file(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700496 remove_debug_files (ehci);
497
498 /* root hub is shut down separately (first, when possible) */
499 spin_lock_irq (&ehci->lock);
500 if (ehci->async)
David Howells7d12e782006-10-05 14:55:46 +0100501 ehci_work (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700502 spin_unlock_irq (&ehci->lock);
503 ehci_mem_cleanup (ehci);
504
505#ifdef EHCI_STATS
506 ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
507 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
508 ehci->stats.lost_iaa);
509 ehci_dbg (ehci, "complete %ld unlink %ld\n",
510 ehci->stats.complete, ehci->stats.unlink);
511#endif
512
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100513 dbg_status (ehci, "ehci_stop completed",
514 ehci_readl(ehci, &ehci->regs->status));
Matt Porter7ff71d62005-09-22 22:31:15 -0700515}
516
David Brownell18807522005-11-23 15:45:37 -0800517/* one-time init, only for memory state */
518static int ehci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
David Brownell18807522005-11-23 15:45:37 -0800520 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 u32 temp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 int retval;
523 u32 hcc_params;
Alek Du3807e262009-07-14 07:23:29 +0800524 struct ehci_qh_hw *hw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
David Brownell18807522005-11-23 15:45:37 -0800526 spin_lock_init(&ehci->lock);
527
Alek Du403dbd32009-07-13 17:30:41 +0800528 /*
529 * keep io watchdog by default, those good HCDs could turn off it later
530 */
531 ehci->need_io_watchdog = 1;
David Brownell18807522005-11-23 15:45:37 -0800532 init_timer(&ehci->watchdog);
533 ehci->watchdog.function = ehci_watchdog;
534 ehci->watchdog.data = (unsigned long) ehci;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Alan Stern07d29b62007-12-11 16:05:30 -0500536 init_timer(&ehci->iaa_watchdog);
537 ehci->iaa_watchdog.function = ehci_iaa_watchdog;
538 ehci->iaa_watchdog.data = (unsigned long) ehci;
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 /*
541 * hw default: 1K periodic list heads, one per frame.
542 * periodic_size can shrink by USBCMD update if hcc_params allows.
543 */
544 ehci->periodic_size = DEFAULT_I_TDPS;
Karsten Wiese9aa09d22009-02-08 16:07:58 -0800545 INIT_LIST_HEAD(&ehci->cached_itd_list);
Alan Stern0e5f2312010-04-08 16:56:37 -0400546 INIT_LIST_HEAD(&ehci->cached_sitd_list);
David Brownell18807522005-11-23 15:45:37 -0800547 if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return retval;
549
550 /* controllers may cache some of the periodic schedule ... */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100551 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
David Brownell53bd6a62006-08-30 14:50:06 -0700552 if (HCC_ISOC_CACHE(hcc_params)) // full frame cache
Sarah Sharpdccd5742009-10-27 10:55:05 -0700553 ehci->i_thresh = 2 + 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 else // N microframes cached
David Brownell18807522005-11-23 15:45:37 -0800555 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557 ehci->reclaim = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 ehci->next_uframe = -1;
Karsten Wiese9aa09d22009-02-08 16:07:58 -0800559 ehci->clock_frame = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 /*
562 * dedicate a qh for the async ring head, since we couldn't unlink
563 * a 'real' qh without stopping the async schedule [4.8]. use it
564 * as the 'reclamation list head' too.
565 * its dummy is used in hw_alt_next of many tds, to prevent the qh
566 * from automatically advancing to the next td after short reads.
567 */
David Brownell18807522005-11-23 15:45:37 -0800568 ehci->async->qh_next.qh = NULL;
Alek Du3807e262009-07-14 07:23:29 +0800569 hw = ehci->async->hw;
570 hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
571 hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
572 hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
573 hw->hw_qtd_next = EHCI_LIST_END(ehci);
David Brownell18807522005-11-23 15:45:37 -0800574 ehci->async->qh_state = QH_STATE_LINKED;
Alek Du3807e262009-07-14 07:23:29 +0800575 hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577 /* clear interrupt enables, set irq latency */
578 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
579 log2_irq_thresh = 0;
580 temp = 1 << (16 + log2_irq_thresh);
581 if (HCC_CANPARK(hcc_params)) {
582 /* HW default park == 3, on hardware that supports it (like
583 * NVidia and ALI silicon), maximizes throughput on the async
584 * schedule by avoiding QH fetches between transfers.
585 *
586 * With fast usb storage devices and NForce2, "park" seems to
587 * make problems: throughput reduction (!), data errors...
588 */
589 if (park) {
David Brownell18807522005-11-23 15:45:37 -0800590 park = min(park, (unsigned) 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 temp |= CMD_PARK;
592 temp |= park << 8;
593 }
David Brownell18807522005-11-23 15:45:37 -0800594 ehci_dbg(ehci, "park %d\n", park);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 }
David Brownell18807522005-11-23 15:45:37 -0800596 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 /* periodic schedule size can be smaller than default */
598 temp &= ~(3 << 2);
599 temp |= (EHCI_TUNE_FLS << 2);
600 switch (EHCI_TUNE_FLS) {
601 case 0: ehci->periodic_size = 1024; break;
602 case 1: ehci->periodic_size = 512; break;
603 case 2: ehci->periodic_size = 256; break;
David Brownell18807522005-11-23 15:45:37 -0800604 default: BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 }
606 }
David Brownell18807522005-11-23 15:45:37 -0800607 ehci->command = temp;
608
Alan Stern40f8db82009-11-06 12:29:40 -0500609 /* Accept arbitrarily long scatter-gather lists */
610 hcd->self.sg_tablesize = ~0;
David Brownell18807522005-11-23 15:45:37 -0800611 return 0;
612}
613
614/* start HC running; it's halted, ehci_init() has been run (once) */
615static int ehci_run (struct usb_hcd *hcd)
616{
617 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
618 int retval;
619 u32 temp;
620 u32 hcc_params;
621
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200622 hcd->uses_new_polling = 1;
623 hcd->poll_rh = 0;
624
David Brownell18807522005-11-23 15:45:37 -0800625 /* EHCI spec section 4.1 */
626 if ((retval = ehci_reset(ehci)) != 0) {
David Brownell18807522005-11-23 15:45:37 -0800627 ehci_mem_cleanup(ehci);
628 return retval;
629 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100630 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
631 ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
David Brownell18807522005-11-23 15:45:37 -0800632
633 /*
634 * hcc_params controls whether ehci->regs->segment must (!!!)
635 * be used; it constrains QH/ITD/SITD and QTD locations.
636 * pci_pool consistent memory always uses segment zero.
637 * streaming mappings for I/O buffers, like pci_map_single(),
638 * can return segments above 4GB, if the device allows.
639 *
640 * NOTE: the dma mask is visible through dma_supported(), so
641 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
642 * Scsi_Host.highmem_io, and so forth. It's readonly to all
643 * host side drivers though.
644 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100645 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
David Brownell18807522005-11-23 15:45:37 -0800646 if (HCC_64BIT_ADDR(hcc_params)) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100647 ehci_writel(ehci, 0, &ehci->regs->segment);
David Brownell18807522005-11-23 15:45:37 -0800648#if 0
649// this is deeply broken on almost all architectures
Yang Hongyang6a355282009-04-06 19:01:13 -0700650 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
David Brownell18807522005-11-23 15:45:37 -0800651 ehci_info(ehci, "enabled 64bit DMA\n");
652#endif
653 }
654
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 // Philips, Intel, and maybe others need CMD_RUN before the
657 // root hub will detect new devices (why?); NEC doesn't
David Brownell18807522005-11-23 15:45:37 -0800658 ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
659 ehci->command |= CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100660 ehci_writel(ehci, ehci->command, &ehci->regs->command);
David Brownell18807522005-11-23 15:45:37 -0800661 dbg_cmd (ehci, "init", ehci->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 /*
664 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
665 * are explicitly handed to companion controller(s), so no TT is
666 * involved with the root hub. (Except where one is integrated,
667 * and there's no companion controller unless maybe for USB OTG.)
Alan Stern32fe0192007-10-10 16:27:07 -0400668 *
669 * Turning on the CF flag will transfer ownership of all ports
670 * from the companions to the EHCI controller. If any of the
671 * companions are in the middle of a port reset at the time, it
672 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
David Brownell1cb52652007-11-13 16:22:30 -0800673 * guarantees that no resets are in progress. After we set CF,
674 * a short delay lets the hardware catch up; new resets shouldn't
675 * be started before the port switching actions could complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
Alan Stern32fe0192007-10-10 16:27:07 -0400677 down_write(&ehci_cf_port_reset_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 hcd->state = HC_STATE_RUNNING;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100679 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
680 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
David Brownell1cb52652007-11-13 16:22:30 -0800681 msleep(5);
Alan Stern32fe0192007-10-10 16:27:07 -0400682 up_write(&ehci_cf_port_reset_rwsem);
Oliver Neukumee4ecb82009-11-27 15:17:59 +0100683 ehci->last_periodic_enable = ktime_get_real();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100685 temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 ehci_info (ehci,
Alan Stern2b70f072008-10-02 11:47:15 -0400687 "USB %x.%x started, EHCI %x.%02x%s\n",
Matt Porter7ff71d62005-09-22 22:31:15 -0700688 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
Alan Stern2b70f072008-10-02 11:47:15 -0400689 temp >> 8, temp & 0xff,
David Brownell93f1a472006-11-16 23:34:58 -0800690 ignore_oc ? ", overcurrent ignored" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100692 ehci_writel(ehci, INTR_MASK,
693 &ehci->regs->intr_enable); /* Turn On Interrupts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
David Brownell18807522005-11-23 15:45:37 -0800695 /* GRR this is run-once init(), being done every time the HC starts.
696 * So long as they're part of class devices, we can't do it init()
697 * since the class device isn't created that early.
698 */
699 create_debug_files(ehci);
Alan Stern57e06c12007-01-16 11:59:45 -0500700 create_companion_file(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 return 0;
703}
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705/*-------------------------------------------------------------------------*/
706
David Howells7d12e782006-10-05 14:55:46 +0100707static irqreturn_t ehci_irq (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708{
709 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern67b2e022008-11-12 17:04:53 -0500710 u32 status, masked_status, pcd_status = 0, cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 int bh;
712
713 spin_lock (&ehci->lock);
714
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100715 status = ehci_readl(ehci, &ehci->regs->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 /* e.g. cardbus physical eject */
718 if (status == ~(u32) 0) {
719 ehci_dbg (ehci, "device removed\n");
720 goto dead;
721 }
722
Alan Stern67b2e022008-11-12 17:04:53 -0500723 masked_status = status & INTR_MASK;
724 if (!masked_status) { /* irq sharing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 spin_unlock(&ehci->lock);
726 return IRQ_NONE;
727 }
728
729 /* clear (just) interrupts */
Alan Stern67b2e022008-11-12 17:04:53 -0500730 ehci_writel(ehci, masked_status, &ehci->regs->status);
David Brownelle82cc122008-03-07 13:49:42 -0800731 cmd = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 bh = 0;
733
David Brownell9776afc2008-02-01 11:42:05 -0800734#ifdef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 /* unrequested/ignored: Frame List Rollover */
736 dbg_status (ehci, "irq", status);
737#endif
738
739 /* INT, ERR, and IAA interrupt rates can be throttled */
740
741 /* normal [4.15.1.2] or error [4.15.1.1] completion */
742 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
743 if (likely ((status & STS_ERR) == 0))
744 COUNT (ehci->stats.normal);
745 else
746 COUNT (ehci->stats.error);
747 bh = 1;
748 }
749
750 /* complete the unlinking of some qh [4.15.2.3] */
751 if (status & STS_IAA) {
David Brownelle82cc122008-03-07 13:49:42 -0800752 /* guard against (alleged) silicon errata */
753 if (cmd & CMD_IAAD) {
754 ehci_writel(ehci, cmd & ~CMD_IAAD,
755 &ehci->regs->command);
756 ehci_dbg(ehci, "IAA with IAAD still set?\n");
757 }
758 if (ehci->reclaim) {
759 COUNT(ehci->stats.reclaim);
760 end_unlink_async(ehci);
761 } else
762 ehci_dbg(ehci, "IAA with nothing to reclaim?\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 }
764
765 /* remote wakeup [4.3.1] */
David Brownelld97cc2f2005-12-22 17:05:18 -0800766 if (status & STS_PCD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 unsigned i = HCS_N_PORTS (ehci->hcs_params);
David Brownelld1b18422008-03-05 23:37:52 -0800768
769 /* kick root hub later */
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200770 pcd_status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772 /* resume root hub? */
Alan Sterneafe5b92008-10-06 11:25:53 -0400773 if (!(cmd & CMD_RUN))
Alan Stern8c033562006-11-09 14:42:16 -0500774 usb_hcd_resume_root_hub(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
776 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100777 int pstatus = ehci_readl(ehci,
778 &ehci->regs->port_status [i]);
David Brownellb972b682006-06-30 02:34:42 -0700779
780 if (pstatus & PORT_OWNER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 continue;
Alan Sterneafe5b92008-10-06 11:25:53 -0400782 if (!(test_bit(i, &ehci->suspended_ports) &&
783 ((pstatus & PORT_RESUME) ||
784 !(pstatus & PORT_SUSPEND)) &&
785 (pstatus & PORT_PE) &&
786 ehci->reset_done[i] == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 continue;
788
789 /* start 20 msec resume signaling from this port,
790 * and make khubd collect PORT_STAT_C_SUSPEND to
Alan Stern49d0f072010-01-08 11:18:38 -0500791 * stop that signaling. Use 5 ms extra for safety,
792 * like usb_port_resume() does.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 */
Alan Stern49d0f072010-01-08 11:18:38 -0500794 ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
Alan Stern61e8b852007-04-09 11:52:31 -0400796 mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 }
798 }
799
800 /* PCI errors [4.15.2.4] */
801 if (unlikely ((status & STS_FATAL) != 0)) {
Alan Stern67b2e022008-11-12 17:04:53 -0500802 ehci_err(ehci, "fatal error\n");
Alan Sterneafe5b92008-10-06 11:25:53 -0400803 dbg_cmd(ehci, "fatal", cmd);
804 dbg_status(ehci, "fatal", status);
Alan Stern67b2e022008-11-12 17:04:53 -0500805 ehci_halt(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806dead:
Alan Stern67b2e022008-11-12 17:04:53 -0500807 ehci_reset(ehci);
808 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
809 /* generic layer kills/unlinks all urbs, then
810 * uses ehci_stop to clean up the rest
811 */
812 bh = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
814
815 if (bh)
David Howells7d12e782006-10-05 14:55:46 +0100816 ehci_work (ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 spin_unlock (&ehci->lock);
David Brownelld1b18422008-03-05 23:37:52 -0800818 if (pcd_status)
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200819 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return IRQ_HANDLED;
821}
822
823/*-------------------------------------------------------------------------*/
824
825/*
826 * non-error returns are a promise to giveback() the urb later
827 * we drop ownership so next owner (or urb unlink) can get it
828 *
829 * urb + dev is in hcd.self.controller.urb_list
830 * we're queueing TDs onto software and hardware lists
831 *
832 * hcd-specific init for hcpriv hasn't been done yet
833 *
834 * NOTE: control, bulk, and interrupt share the same code to append TDs
835 * to a (possibly active) QH, and the same QH scanning code.
836 */
837static int ehci_urb_enqueue (
838 struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 struct urb *urb,
Al Viro55016f12005-10-21 03:21:58 -0400840 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841) {
842 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
843 struct list_head qtd_list;
844
845 INIT_LIST_HEAD (&qtd_list);
846
847 switch (usb_pipetype (urb->pipe)) {
David Brownell25b70a82008-03-04 15:11:07 -0800848 case PIPE_CONTROL:
849 /* qh_completions() code doesn't handle all the fault cases
850 * in multi-TD control transfers. Even 1KB is rare anyway.
851 */
852 if (urb->transfer_buffer_length > (16 * 1024))
853 return -EMSGSIZE;
854 /* FALLTHROUGH */
855 /* case PIPE_BULK: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 default:
857 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
858 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400859 return submit_async(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
861 case PIPE_INTERRUPT:
862 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
863 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400864 return intr_submit(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866 case PIPE_ISOCHRONOUS:
867 if (urb->dev->speed == USB_SPEED_HIGH)
868 return itd_submit (ehci, urb, mem_flags);
869 else
870 return sitd_submit (ehci, urb, mem_flags);
871 }
872}
873
874static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
875{
Alan Stern07d29b62007-12-11 16:05:30 -0500876 /* failfast */
David Brownelle82cc122008-03-07 13:49:42 -0800877 if (!HC_IS_RUNNING(ehci_to_hcd(ehci)->state) && ehci->reclaim)
Alan Stern07d29b62007-12-11 16:05:30 -0500878 end_unlink_async(ehci);
879
Alan Stern3a444942009-08-19 12:22:06 -0400880 /* If the QH isn't linked then there's nothing we can do
881 * unless we were called during a giveback, in which case
882 * qh_completions() has to deal with it.
883 */
884 if (qh->qh_state != QH_STATE_LINKED) {
885 if (qh->qh_state == QH_STATE_COMPLETING)
886 qh->needs_rescan = 1;
887 return;
888 }
Alan Stern07d29b62007-12-11 16:05:30 -0500889
890 /* defer till later if busy */
Alan Stern3a444942009-08-19 12:22:06 -0400891 if (ehci->reclaim) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 struct ehci_qh *last;
893
894 for (last = ehci->reclaim;
895 last->reclaim;
896 last = last->reclaim)
897 continue;
898 qh->qh_state = QH_STATE_UNLINK_WAIT;
899 last->reclaim = qh;
900
Alan Stern07d29b62007-12-11 16:05:30 -0500901 /* start IAA cycle */
902 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 start_unlink_async (ehci, qh);
904}
905
906/* remove from hardware lists
907 * completions normally happen asynchronously
908 */
909
Alan Sterne9df41c2007-08-08 11:48:02 -0400910static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
912 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
913 struct ehci_qh *qh;
914 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400915 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
917 spin_lock_irqsave (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400918 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
919 if (rc)
920 goto done;
921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 switch (usb_pipetype (urb->pipe)) {
923 // case PIPE_CONTROL:
924 // case PIPE_BULK:
925 default:
926 qh = (struct ehci_qh *) urb->hcpriv;
927 if (!qh)
928 break;
Alan Stern07d29b62007-12-11 16:05:30 -0500929 switch (qh->qh_state) {
930 case QH_STATE_LINKED:
931 case QH_STATE_COMPLETING:
932 unlink_async(ehci, qh);
933 break;
934 case QH_STATE_UNLINK:
935 case QH_STATE_UNLINK_WAIT:
936 /* already started */
937 break;
938 case QH_STATE_IDLE:
Alan Stern7a0f0d92009-07-31 10:40:22 -0400939 /* QH might be waiting for a Clear-TT-Buffer */
940 qh_completions(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500941 break;
942 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 break;
944
945 case PIPE_INTERRUPT:
946 qh = (struct ehci_qh *) urb->hcpriv;
947 if (!qh)
948 break;
949 switch (qh->qh_state) {
950 case QH_STATE_LINKED:
Alan Sterna448c9d2009-08-19 12:22:44 -0400951 case QH_STATE_COMPLETING:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 intr_deschedule (ehci, qh);
Alan Sterna448c9d2009-08-19 12:22:44 -0400953 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 case QH_STATE_IDLE:
David Howells7d12e782006-10-05 14:55:46 +0100955 qh_completions (ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 break;
957 default:
958 ehci_dbg (ehci, "bogus qh %p state %d\n",
959 qh, qh->qh_state);
960 goto done;
961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 break;
963
964 case PIPE_ISOCHRONOUS:
965 // itd or sitd ...
966
967 // wait till next completion, do it then.
968 // completion irqs can wait up to 1024 msec,
969 break;
970 }
971done:
972 spin_unlock_irqrestore (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400973 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974}
975
976/*-------------------------------------------------------------------------*/
977
978// bulk qh holds the data toggle
979
980static void
981ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
982{
983 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
984 unsigned long flags;
985 struct ehci_qh *qh, *tmp;
986
987 /* ASSERT: any requests/urbs are being unlinked */
988 /* ASSERT: nobody can be submitting urbs for this any more */
989
990rescan:
991 spin_lock_irqsave (&ehci->lock, flags);
992 qh = ep->hcpriv;
993 if (!qh)
994 goto done;
995
996 /* endpoints can be iso streams. for now, we don't
997 * accelerate iso completions ... so spin a while.
998 */
Clemens Ladisch1082f572010-03-01 17:18:56 +0100999 if (qh->hw == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 ehci_vdbg (ehci, "iso delay\n");
1001 goto idle_timeout;
1002 }
1003
1004 if (!HC_IS_RUNNING (hcd->state))
1005 qh->qh_state = QH_STATE_IDLE;
1006 switch (qh->qh_state) {
1007 case QH_STATE_LINKED:
Alan Stern3a444942009-08-19 12:22:06 -04001008 case QH_STATE_COMPLETING:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 for (tmp = ehci->async->qh_next.qh;
1010 tmp && tmp != qh;
1011 tmp = tmp->qh_next.qh)
1012 continue;
1013 /* periodic qh self-unlinks on empty */
1014 if (!tmp)
1015 goto nogood;
1016 unlink_async (ehci, qh);
1017 /* FALL THROUGH */
1018 case QH_STATE_UNLINK: /* wait for hw to finish? */
Alan Stern07d29b62007-12-11 16:05:30 -05001019 case QH_STATE_UNLINK_WAIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020idle_timeout:
1021 spin_unlock_irqrestore (&ehci->lock, flags);
Nishanth Aravamudan22c43862005-08-15 11:30:11 -07001022 schedule_timeout_uninterruptible(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 goto rescan;
1024 case QH_STATE_IDLE: /* fully unlinked */
Alan Stern914b7012009-06-29 10:47:30 -04001025 if (qh->clearing_tt)
1026 goto idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 if (list_empty (&qh->qtd_list)) {
1028 qh_put (qh);
1029 break;
1030 }
1031 /* else FALL THROUGH */
1032 default:
1033nogood:
1034 /* caller was supposed to have unlinked any requests;
1035 * that's not our job. just leak this memory.
1036 */
1037 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1038 qh, ep->desc.bEndpointAddress, qh->qh_state,
1039 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1040 break;
1041 }
1042 ep->hcpriv = NULL;
1043done:
1044 spin_unlock_irqrestore (&ehci->lock, flags);
1045 return;
1046}
1047
Alan Sternb18ffd42009-05-27 18:21:56 -04001048static void
1049ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1050{
1051 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1052 struct ehci_qh *qh;
1053 int eptype = usb_endpoint_type(&ep->desc);
Alan Sterna455212d2009-06-11 14:56:22 -04001054 int epnum = usb_endpoint_num(&ep->desc);
1055 int is_out = usb_endpoint_dir_out(&ep->desc);
1056 unsigned long flags;
Alan Sternb18ffd42009-05-27 18:21:56 -04001057
1058 if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1059 return;
1060
Alan Sterna455212d2009-06-11 14:56:22 -04001061 spin_lock_irqsave(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001062 qh = ep->hcpriv;
1063
1064 /* For Bulk and Interrupt endpoints we maintain the toggle state
1065 * in the hardware; the toggle bits in udev aren't used at all.
1066 * When an endpoint is reset by usb_clear_halt() we must reset
1067 * the toggle bit in the QH.
1068 */
1069 if (qh) {
Alan Sterna455212d2009-06-11 14:56:22 -04001070 usb_settoggle(qh->dev, epnum, is_out, 0);
Alan Sternb18ffd42009-05-27 18:21:56 -04001071 if (!list_empty(&qh->qtd_list)) {
1072 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
Alan Stern3a444942009-08-19 12:22:06 -04001073 } else if (qh->qh_state == QH_STATE_LINKED ||
1074 qh->qh_state == QH_STATE_COMPLETING) {
Alan Sterna455212d2009-06-11 14:56:22 -04001075
1076 /* The toggle value in the QH can't be updated
1077 * while the QH is active. Unlink it now;
1078 * re-linking will call qh_refresh().
Alan Sternb18ffd42009-05-27 18:21:56 -04001079 */
Alan Sterna448c9d2009-08-19 12:22:44 -04001080 if (eptype == USB_ENDPOINT_XFER_BULK)
Alan Sterna455212d2009-06-11 14:56:22 -04001081 unlink_async(ehci, qh);
Alan Sterna448c9d2009-08-19 12:22:44 -04001082 else
Alan Sterna455212d2009-06-11 14:56:22 -04001083 intr_deschedule(ehci, qh);
Alan Sternb18ffd42009-05-27 18:21:56 -04001084 }
1085 }
Alan Sterna455212d2009-06-11 14:56:22 -04001086 spin_unlock_irqrestore(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001087}
1088
Matt Porter7ff71d62005-09-22 22:31:15 -07001089static int ehci_get_frame (struct usb_hcd *hcd)
1090{
1091 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +11001092 return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
1093 ehci->periodic_size;
Matt Porter7ff71d62005-09-22 22:31:15 -07001094}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
1096/*-------------------------------------------------------------------------*/
1097
Alan Stern2b70f072008-10-02 11:47:15 -04001098MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099MODULE_AUTHOR (DRIVER_AUTHOR);
1100MODULE_LICENSE ("GPL");
1101
Matt Porter7ff71d62005-09-22 22:31:15 -07001102#ifdef CONFIG_PCI
1103#include "ehci-pci.c"
Kumar Gala01cced22006-04-11 10:07:16 -05001104#define PCI_DRIVER ehci_pci_driver
Matt Porter7ff71d62005-09-22 22:31:15 -07001105#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
Li Yangba029782007-05-11 17:09:55 +08001107#ifdef CONFIG_USB_EHCI_FSL
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001108#include "ehci-fsl.c"
Kumar Gala01cced22006-04-11 10:07:16 -05001109#define PLATFORM_DRIVER ehci_fsl_driver
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001110#endif
1111
Daniel Mack7e8d5cd2009-10-28 01:14:59 +01001112#ifdef CONFIG_USB_EHCI_MXC
1113#include "ehci-mxc.c"
1114#define PLATFORM_DRIVER ehci_mxc_driver
1115#endif
1116
Ralf Baechledfbaa7d2006-06-03 23:58:55 +01001117#ifdef CONFIG_SOC_AU1200
Jordan Crouse76fa9a22006-01-20 14:06:09 -08001118#include "ehci-au1xxx.c"
Kumar Gala01cced22006-04-11 10:07:16 -05001119#define PLATFORM_DRIVER ehci_hcd_au1xxx_driver
Jordan Crouse76fa9a22006-01-20 14:06:09 -08001120#endif
1121
Tony Lindgrena8eb7ca2010-02-12 12:26:48 -08001122#ifdef CONFIG_ARCH_OMAP3
Felipe Balbi54ab2b02009-10-14 11:44:14 +03001123#include "ehci-omap.c"
1124#define PLATFORM_DRIVER ehci_hcd_omap_driver
1125#endif
1126
Geoff Levandad75a412007-01-15 20:11:47 -08001127#ifdef CONFIG_PPC_PS3
1128#include "ehci-ps3.c"
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001129#define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
Geoff Levandad75a412007-01-15 20:11:47 -08001130#endif
1131
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001132#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1133#include "ehci-ppc-of.c"
1134#define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1135#endif
1136
Julie Zhu08d3c182009-09-21 16:08:19 -06001137#ifdef CONFIG_XPS_USB_HCD_XILINX
1138#include "ehci-xilinx-of.c"
1139#define OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
1140#endif
1141
Lennert Buytenhek705a7522008-03-27 14:51:40 -04001142#ifdef CONFIG_PLAT_ORION
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -05001143#include "ehci-orion.c"
1144#define PLATFORM_DRIVER ehci_orion_driver
1145#endif
1146
Vladimir Barinov91bc4d32007-12-30 15:21:11 -08001147#ifdef CONFIG_ARCH_IXP4XX
1148#include "ehci-ixp4xx.c"
1149#define PLATFORM_DRIVER ixp4xx_ehci_driver
1150#endif
1151
Wan ZongShun586dfc82009-06-13 09:14:28 +08001152#ifdef CONFIG_USB_W90X900_EHCI
1153#include "ehci-w90x900.c"
1154#define PLATFORM_DRIVER ehci_hcd_w90x900_driver
1155#endif
1156
Nicolas Ferre501c9c02009-07-27 14:47:40 -07001157#ifdef CONFIG_ARCH_AT91
1158#include "ehci-atmel.c"
1159#define PLATFORM_DRIVER ehci_atmel_driver
1160#endif
1161
Geoff Levandad75a412007-01-15 20:11:47 -08001162#if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
Anton Vorontsovc6dd2e62008-02-21 22:49:13 +03001163 !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER)
Matt Porter7ff71d62005-09-22 22:31:15 -07001164#error "missing bus glue for ehci-hcd"
1165#endif
Kumar Gala01cced22006-04-11 10:07:16 -05001166
1167static int __init ehci_hcd_init(void)
1168{
1169 int retval = 0;
1170
Alan Stern2b70f072008-10-02 11:47:15 -04001171 if (usb_disabled())
1172 return -ENODEV;
1173
1174 printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
Alan Stern9beeee62008-10-02 11:48:13 -04001175 set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1176 if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1177 test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1178 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1179 " before uhci_hcd and ohci_hcd, not after\n");
1180
Kumar Gala01cced22006-04-11 10:07:16 -05001181 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1182 hcd_name,
1183 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1184 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1185
Tony Jones694cc202007-09-11 14:07:31 -07001186#ifdef DEBUG
Greg Kroah-Hartman08f4e582009-04-24 15:13:18 -07001187 ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
Alan Stern9beeee62008-10-02 11:48:13 -04001188 if (!ehci_debug_root) {
1189 retval = -ENOENT;
1190 goto err_debug;
1191 }
Tony Jones694cc202007-09-11 14:07:31 -07001192#endif
1193
Kumar Gala01cced22006-04-11 10:07:16 -05001194#ifdef PLATFORM_DRIVER
1195 retval = platform_driver_register(&PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001196 if (retval < 0)
1197 goto clean0;
Kumar Gala01cced22006-04-11 10:07:16 -05001198#endif
1199
1200#ifdef PCI_DRIVER
1201 retval = pci_register_driver(&PCI_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001202 if (retval < 0)
1203 goto clean1;
Geoff Levandad75a412007-01-15 20:11:47 -08001204#endif
1205
1206#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001207 retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001208 if (retval < 0)
1209 goto clean2;
Kumar Gala01cced22006-04-11 10:07:16 -05001210#endif
1211
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001212#ifdef OF_PLATFORM_DRIVER
1213 retval = of_register_platform_driver(&OF_PLATFORM_DRIVER);
1214 if (retval < 0)
1215 goto clean3;
1216#endif
1217 return retval;
1218
1219#ifdef OF_PLATFORM_DRIVER
1220 /* of_unregister_platform_driver(&OF_PLATFORM_DRIVER); */
1221clean3:
1222#endif
1223#ifdef PS3_SYSTEM_BUS_DRIVER
1224 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1225clean2:
1226#endif
1227#ifdef PCI_DRIVER
1228 pci_unregister_driver(&PCI_DRIVER);
1229clean1:
1230#endif
1231#ifdef PLATFORM_DRIVER
1232 platform_driver_unregister(&PLATFORM_DRIVER);
1233clean0:
1234#endif
1235#ifdef DEBUG
1236 debugfs_remove(ehci_debug_root);
1237 ehci_debug_root = NULL;
Alan Stern9beeee62008-10-02 11:48:13 -04001238err_debug:
Linus Torvaldsa9b61482008-10-20 14:23:29 -07001239#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001240 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001241 return retval;
1242}
1243module_init(ehci_hcd_init);
1244
1245static void __exit ehci_hcd_cleanup(void)
1246{
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001247#ifdef OF_PLATFORM_DRIVER
1248 of_unregister_platform_driver(&OF_PLATFORM_DRIVER);
1249#endif
Kumar Gala01cced22006-04-11 10:07:16 -05001250#ifdef PLATFORM_DRIVER
1251 platform_driver_unregister(&PLATFORM_DRIVER);
1252#endif
1253#ifdef PCI_DRIVER
1254 pci_unregister_driver(&PCI_DRIVER);
1255#endif
Geoff Levandad75a412007-01-15 20:11:47 -08001256#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001257 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
Geoff Levandad75a412007-01-15 20:11:47 -08001258#endif
Tony Jones694cc202007-09-11 14:07:31 -07001259#ifdef DEBUG
1260 debugfs_remove(ehci_debug_root);
1261#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001262 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001263}
1264module_exit(ehci_hcd_cleanup);
1265