Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (c) 2000-2004 by David Brownell | |
53bd6a60 | 3 | * |
1da177e4 LT |
4 | * 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 | ||
1da177e4 LT |
19 | #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> | |
26 | #include <linux/slab.h> | |
27 | #include <linux/smp_lock.h> | |
28 | #include <linux/errno.h> | |
29 | #include <linux/init.h> | |
30 | #include <linux/timer.h> | |
31 | #include <linux/list.h> | |
32 | #include <linux/interrupt.h> | |
33 | #include <linux/reboot.h> | |
34 | #include <linux/usb.h> | |
35 | #include <linux/moduleparam.h> | |
36 | #include <linux/dma-mapping.h> | |
37 | ||
38 | #include "../core/hcd.h" | |
39 | ||
40 | #include <asm/byteorder.h> | |
41 | #include <asm/io.h> | |
42 | #include <asm/irq.h> | |
43 | #include <asm/system.h> | |
44 | #include <asm/unaligned.h> | |
45 | ||
46 | ||
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! | |
61 | * | |
62 | * HISTORY: | |
63 | * | |
64 | * 2004-05-10 Root hub and PCI suspend/resume support; remote wakeup. (db) | |
65 | * 2004-02-24 Replace pci_* with generic dma_* API calls (dsaxena@plexity.net) | |
66 | * 2003-12-29 Rewritten high speed iso transfer support (by Michal Sojka, | |
67 | * <sojkam@centrum.cz>, updates by DB). | |
68 | * | |
69 | * 2002-11-29 Correct handling for hw async_next register. | |
70 | * 2002-08-06 Handling for bulk and interrupt transfers is mostly shared; | |
71 | * only scheduling is different, no arbitrary limitations. | |
72 | * 2002-07-25 Sanity check PCI reads, mostly for better cardbus support, | |
53bd6a60 | 73 | * clean up HC run state handshaking. |
1da177e4 LT |
74 | * 2002-05-24 Preliminary FS/LS interrupts, using scheduling shortcuts |
75 | * 2002-05-11 Clear TT errors for FS/LS ctrl/bulk. Fill in some other | |
76 | * missing pieces: enabling 64bit dma, handoff from BIOS/SMM. | |
77 | * 2002-05-07 Some error path cleanups to report better errors; wmb(); | |
78 | * use non-CVS version id; better iso bandwidth claim. | |
79 | * 2002-04-19 Control/bulk/interrupt submit no longer uses giveback() on | |
80 | * errors in submit path. Bugfixes to interrupt scheduling/processing. | |
81 | * 2002-03-05 Initial high-speed ISO support; reduce ITD memory; shift | |
82 | * more checking to generic hcd framework (db). Make it work with | |
83 | * Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt). | |
84 | * 2002-01-14 Minor cleanup; version synch. | |
85 | * 2002-01-08 Fix roothub handoff of FS/LS to companion controllers. | |
86 | * 2002-01-04 Control/Bulk queuing behaves. | |
87 | * | |
88 | * 2001-12-12 Initial patch version for Linux 2.5.1 kernel. | |
89 | * 2001-June Works with usb-storage and NEC EHCI on 2.4 | |
90 | */ | |
91 | ||
92 | #define DRIVER_VERSION "10 Dec 2004" | |
93 | #define DRIVER_AUTHOR "David Brownell" | |
94 | #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver" | |
95 | ||
96 | static const char hcd_name [] = "ehci_hcd"; | |
97 | ||
98 | ||
99 | #undef EHCI_VERBOSE_DEBUG | |
100 | #undef EHCI_URB_TRACE | |
101 | ||
102 | #ifdef DEBUG | |
103 | #define EHCI_STATS | |
104 | #endif | |
105 | ||
106 | /* magic numbers that can affect system performance */ | |
107 | #define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */ | |
108 | #define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */ | |
109 | #define EHCI_TUNE_RL_TT 0 | |
110 | #define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */ | |
111 | #define EHCI_TUNE_MULT_TT 1 | |
112 | #define EHCI_TUNE_FLS 2 /* (small) 256 frame schedule */ | |
113 | ||
64f89798 | 114 | #define EHCI_IAA_JIFFIES (HZ/100) /* arbitrary; ~10 msec */ |
1da177e4 LT |
115 | #define EHCI_IO_JIFFIES (HZ/10) /* io watchdog > irq_thresh */ |
116 | #define EHCI_ASYNC_JIFFIES (HZ/20) /* async idle timeout */ | |
117 | #define EHCI_SHRINK_JIFFIES (HZ/200) /* async qh unlink delay */ | |
118 | ||
119 | /* Initial IRQ latency: faster than hw default */ | |
120 | static int log2_irq_thresh = 0; // 0 to 6 | |
121 | module_param (log2_irq_thresh, int, S_IRUGO); | |
122 | MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes"); | |
123 | ||
124 | /* initial park setting: slower than hw default */ | |
125 | static unsigned park = 0; | |
126 | module_param (park, uint, S_IRUGO); | |
127 | MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets"); | |
128 | ||
93f1a47c DB |
129 | /* for flakey hardware, ignore overcurrent indicators */ |
130 | static int ignore_oc = 0; | |
131 | module_param (ignore_oc, bool, S_IRUGO); | |
132 | MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications"); | |
133 | ||
1da177e4 LT |
134 | #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT) |
135 | ||
136 | /*-------------------------------------------------------------------------*/ | |
137 | ||
138 | #include "ehci.h" | |
139 | #include "ehci-dbg.c" | |
140 | ||
141 | /*-------------------------------------------------------------------------*/ | |
142 | ||
143 | /* | |
144 | * handshake - spin reading hc until handshake completes or fails | |
145 | * @ptr: address of hc register to be read | |
146 | * @mask: bits to look at in result of read | |
147 | * @done: value of those bits when handshake succeeds | |
148 | * @usec: timeout in microseconds | |
149 | * | |
150 | * Returns negative errno, or zero on success | |
151 | * | |
152 | * Success happens when the "mask" bits have the specified value (hardware | |
153 | * handshake done). There are two failure modes: "usec" have passed (major | |
154 | * hardware flakeout), or the register reads as all-ones (hardware removed). | |
155 | * | |
156 | * That last failure should_only happen in cases like physical cardbus eject | |
157 | * before driver shutdown. But it also seems to be caused by bugs in cardbus | |
158 | * bridge shutdown: shutting down the bridge before the devices using it. | |
159 | */ | |
083522d7 BH |
160 | static int handshake (struct ehci_hcd *ehci, void __iomem *ptr, |
161 | u32 mask, u32 done, int usec) | |
1da177e4 LT |
162 | { |
163 | u32 result; | |
164 | ||
165 | do { | |
083522d7 | 166 | result = ehci_readl(ehci, ptr); |
1da177e4 LT |
167 | if (result == ~(u32)0) /* card removed */ |
168 | return -ENODEV; | |
169 | result &= mask; | |
170 | if (result == done) | |
171 | return 0; | |
172 | udelay (1); | |
173 | usec--; | |
174 | } while (usec > 0); | |
175 | return -ETIMEDOUT; | |
176 | } | |
177 | ||
178 | /* force HC to halt state from unknown (EHCI spec section 2.3) */ | |
179 | static int ehci_halt (struct ehci_hcd *ehci) | |
180 | { | |
083522d7 | 181 | u32 temp = ehci_readl(ehci, &ehci->regs->status); |
1da177e4 | 182 | |
72f30b6f | 183 | /* disable any irqs left enabled by previous code */ |
083522d7 | 184 | ehci_writel(ehci, 0, &ehci->regs->intr_enable); |
72f30b6f | 185 | |
1da177e4 LT |
186 | if ((temp & STS_HALT) != 0) |
187 | return 0; | |
188 | ||
083522d7 | 189 | temp = ehci_readl(ehci, &ehci->regs->command); |
1da177e4 | 190 | temp &= ~CMD_RUN; |
083522d7 BH |
191 | ehci_writel(ehci, temp, &ehci->regs->command); |
192 | return handshake (ehci, &ehci->regs->status, | |
193 | STS_HALT, STS_HALT, 16 * 125); | |
1da177e4 LT |
194 | } |
195 | ||
196 | /* put TDI/ARC silicon into EHCI mode */ | |
197 | static void tdi_reset (struct ehci_hcd *ehci) | |
198 | { | |
199 | u32 __iomem *reg_ptr; | |
200 | u32 tmp; | |
201 | ||
202 | reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + 0x68); | |
083522d7 | 203 | tmp = ehci_readl(ehci, reg_ptr); |
1da177e4 | 204 | tmp |= 0x3; |
083522d7 | 205 | ehci_writel(ehci, tmp, reg_ptr); |
1da177e4 LT |
206 | } |
207 | ||
208 | /* reset a non-running (STS_HALT == 1) controller */ | |
209 | static int ehci_reset (struct ehci_hcd *ehci) | |
210 | { | |
211 | int retval; | |
083522d7 | 212 | u32 command = ehci_readl(ehci, &ehci->regs->command); |
1da177e4 LT |
213 | |
214 | command |= CMD_RESET; | |
215 | dbg_cmd (ehci, "reset", command); | |
083522d7 | 216 | ehci_writel(ehci, command, &ehci->regs->command); |
1da177e4 LT |
217 | ehci_to_hcd(ehci)->state = HC_STATE_HALT; |
218 | ehci->next_statechange = jiffies; | |
083522d7 BH |
219 | retval = handshake (ehci, &ehci->regs->command, |
220 | CMD_RESET, 0, 250 * 1000); | |
1da177e4 LT |
221 | |
222 | if (retval) | |
223 | return retval; | |
224 | ||
225 | if (ehci_is_TDI(ehci)) | |
226 | tdi_reset (ehci); | |
227 | ||
228 | return retval; | |
229 | } | |
230 | ||
231 | /* idle the controller (from running) */ | |
232 | static void ehci_quiesce (struct ehci_hcd *ehci) | |
233 | { | |
234 | u32 temp; | |
235 | ||
236 | #ifdef DEBUG | |
237 | if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) | |
238 | BUG (); | |
239 | #endif | |
240 | ||
241 | /* wait for any schedule enables/disables to take effect */ | |
083522d7 | 242 | temp = ehci_readl(ehci, &ehci->regs->command) << 10; |
1da177e4 | 243 | temp &= STS_ASS | STS_PSS; |
083522d7 | 244 | if (handshake (ehci, &ehci->regs->status, STS_ASS | STS_PSS, |
1da177e4 LT |
245 | temp, 16 * 125) != 0) { |
246 | ehci_to_hcd(ehci)->state = HC_STATE_HALT; | |
247 | return; | |
248 | } | |
249 | ||
250 | /* then disable anything that's still active */ | |
083522d7 | 251 | temp = ehci_readl(ehci, &ehci->regs->command); |
1da177e4 | 252 | temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE); |
083522d7 | 253 | ehci_writel(ehci, temp, &ehci->regs->command); |
1da177e4 LT |
254 | |
255 | /* hardware can take 16 microframes to turn off ... */ | |
083522d7 | 256 | if (handshake (ehci, &ehci->regs->status, STS_ASS | STS_PSS, |
1da177e4 LT |
257 | 0, 16 * 125) != 0) { |
258 | ehci_to_hcd(ehci)->state = HC_STATE_HALT; | |
259 | return; | |
260 | } | |
261 | } | |
262 | ||
263 | /*-------------------------------------------------------------------------*/ | |
264 | ||
7d12e780 | 265 | static void ehci_work(struct ehci_hcd *ehci); |
1da177e4 LT |
266 | |
267 | #include "ehci-hub.c" | |
268 | #include "ehci-mem.c" | |
269 | #include "ehci-q.c" | |
270 | #include "ehci-sched.c" | |
271 | ||
272 | /*-------------------------------------------------------------------------*/ | |
273 | ||
64f89798 | 274 | static void ehci_watchdog (unsigned long param) |
1da177e4 LT |
275 | { |
276 | struct ehci_hcd *ehci = (struct ehci_hcd *) param; | |
277 | unsigned long flags; | |
278 | ||
279 | spin_lock_irqsave (&ehci->lock, flags); | |
280 | ||
64f89798 | 281 | /* lost IAA irqs wedge things badly; seen with a vt8235 */ |
1da177e4 | 282 | if (ehci->reclaim) { |
083522d7 | 283 | u32 status = ehci_readl(ehci, &ehci->regs->status); |
1da177e4 LT |
284 | if (status & STS_IAA) { |
285 | ehci_vdbg (ehci, "lost IAA\n"); | |
286 | COUNT (ehci->stats.lost_iaa); | |
083522d7 | 287 | ehci_writel(ehci, STS_IAA, &ehci->regs->status); |
64f89798 | 288 | ehci->reclaim_ready = 1; |
1da177e4 LT |
289 | } |
290 | } | |
291 | ||
64f89798 | 292 | /* stop async processing after it's idled a bit */ |
1da177e4 | 293 | if (test_bit (TIMER_ASYNC_OFF, &ehci->actions)) |
26f953fd | 294 | start_unlink_async (ehci, ehci->async); |
1da177e4 LT |
295 | |
296 | /* ehci could run by timer, without IRQs ... */ | |
7d12e780 | 297 | ehci_work (ehci); |
1da177e4 LT |
298 | |
299 | spin_unlock_irqrestore (&ehci->lock, flags); | |
300 | } | |
301 | ||
64a21d02 | 302 | /* ehci_shutdown kick in for silicon on any bus (not just pci, etc). |
72f30b6f DB |
303 | * This forcibly disables dma and IRQs, helping kexec and other cases |
304 | * where the next system software may expect clean state. | |
305 | */ | |
64a21d02 AG |
306 | static void |
307 | ehci_shutdown (struct usb_hcd *hcd) | |
1da177e4 | 308 | { |
64a21d02 | 309 | struct ehci_hcd *ehci; |
1da177e4 | 310 | |
64a21d02 | 311 | ehci = hcd_to_ehci (hcd); |
72f30b6f | 312 | (void) ehci_halt (ehci); |
1da177e4 LT |
313 | |
314 | /* make BIOS/etc use companion controller during reboot */ | |
083522d7 | 315 | ehci_writel(ehci, 0, &ehci->regs->configured_flag); |
1da177e4 LT |
316 | } |
317 | ||
56c1e26d DB |
318 | static void ehci_port_power (struct ehci_hcd *ehci, int is_on) |
319 | { | |
320 | unsigned port; | |
321 | ||
322 | if (!HCS_PPC (ehci->hcs_params)) | |
323 | return; | |
324 | ||
325 | ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down"); | |
326 | for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; ) | |
327 | (void) ehci_hub_control(ehci_to_hcd(ehci), | |
328 | is_on ? SetPortFeature : ClearPortFeature, | |
329 | USB_PORT_FEAT_POWER, | |
330 | port--, NULL, 0); | |
331 | msleep(20); | |
332 | } | |
333 | ||
7ff71d6a | 334 | /*-------------------------------------------------------------------------*/ |
1da177e4 | 335 | |
7ff71d6a MP |
336 | /* |
337 | * ehci_work is called from some interrupts, timers, and so on. | |
338 | * it calls driver completion functions, after dropping ehci->lock. | |
339 | */ | |
7d12e780 | 340 | static void ehci_work (struct ehci_hcd *ehci) |
7ff71d6a MP |
341 | { |
342 | timer_action_done (ehci, TIMER_IO_WATCHDOG); | |
64f89798 GKH |
343 | if (ehci->reclaim_ready) |
344 | end_unlink_async (ehci); | |
7ff71d6a MP |
345 | |
346 | /* another CPU may drop ehci->lock during a schedule scan while | |
347 | * it reports urb completions. this flag guards against bogus | |
348 | * attempts at re-entrant schedule scanning. | |
349 | */ | |
350 | if (ehci->scanning) | |
351 | return; | |
352 | ehci->scanning = 1; | |
7d12e780 | 353 | scan_async (ehci); |
7ff71d6a | 354 | if (ehci->next_uframe != -1) |
7d12e780 | 355 | scan_periodic (ehci); |
7ff71d6a MP |
356 | ehci->scanning = 0; |
357 | ||
358 | /* the IO watchdog guards against hardware or driver bugs that | |
359 | * misplace IRQs, and should let us run completely without IRQs. | |
360 | * such lossage has been observed on both VT6202 and VT8235. | |
361 | */ | |
362 | if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && | |
363 | (ehci->async->qh_next.ptr != NULL || | |
364 | ehci->periodic_sched != 0)) | |
365 | timer_action (ehci, TIMER_IO_WATCHDOG); | |
366 | } | |
1da177e4 | 367 | |
7ff71d6a | 368 | static void ehci_stop (struct usb_hcd *hcd) |
1da177e4 LT |
369 | { |
370 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
1da177e4 | 371 | |
7ff71d6a | 372 | ehci_dbg (ehci, "stop\n"); |
1da177e4 | 373 | |
7ff71d6a MP |
374 | /* Turn off port power on all root hub ports. */ |
375 | ehci_port_power (ehci, 0); | |
1da177e4 | 376 | |
7ff71d6a MP |
377 | /* no more interrupts ... */ |
378 | del_timer_sync (&ehci->watchdog); | |
56c1e26d | 379 | |
7ff71d6a MP |
380 | spin_lock_irq(&ehci->lock); |
381 | if (HC_IS_RUNNING (hcd->state)) | |
382 | ehci_quiesce (ehci); | |
1da177e4 | 383 | |
7ff71d6a | 384 | ehci_reset (ehci); |
083522d7 | 385 | ehci_writel(ehci, 0, &ehci->regs->intr_enable); |
7ff71d6a | 386 | spin_unlock_irq(&ehci->lock); |
1da177e4 | 387 | |
7ff71d6a | 388 | /* let companion controllers work when we aren't */ |
083522d7 | 389 | ehci_writel(ehci, 0, &ehci->regs->configured_flag); |
56c1e26d | 390 | |
7ff71d6a | 391 | remove_debug_files (ehci); |
1da177e4 | 392 | |
7ff71d6a MP |
393 | /* root hub is shut down separately (first, when possible) */ |
394 | spin_lock_irq (&ehci->lock); | |
395 | if (ehci->async) | |
7d12e780 | 396 | ehci_work (ehci); |
7ff71d6a MP |
397 | spin_unlock_irq (&ehci->lock); |
398 | ehci_mem_cleanup (ehci); | |
1da177e4 | 399 | |
7ff71d6a MP |
400 | #ifdef EHCI_STATS |
401 | ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n", | |
402 | ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim, | |
403 | ehci->stats.lost_iaa); | |
404 | ehci_dbg (ehci, "complete %ld unlink %ld\n", | |
405 | ehci->stats.complete, ehci->stats.unlink); | |
1da177e4 | 406 | #endif |
1da177e4 | 407 | |
083522d7 BH |
408 | dbg_status (ehci, "ehci_stop completed", |
409 | ehci_readl(ehci, &ehci->regs->status)); | |
1da177e4 LT |
410 | } |
411 | ||
18807521 DB |
412 | /* one-time init, only for memory state */ |
413 | static int ehci_init(struct usb_hcd *hcd) | |
1da177e4 | 414 | { |
18807521 | 415 | struct ehci_hcd *ehci = hcd_to_ehci(hcd); |
1da177e4 | 416 | u32 temp; |
1da177e4 LT |
417 | int retval; |
418 | u32 hcc_params; | |
18807521 DB |
419 | |
420 | spin_lock_init(&ehci->lock); | |
421 | ||
422 | init_timer(&ehci->watchdog); | |
423 | ehci->watchdog.function = ehci_watchdog; | |
424 | ehci->watchdog.data = (unsigned long) ehci; | |
1da177e4 LT |
425 | |
426 | /* | |
427 | * hw default: 1K periodic list heads, one per frame. | |
428 | * periodic_size can shrink by USBCMD update if hcc_params allows. | |
429 | */ | |
430 | ehci->periodic_size = DEFAULT_I_TDPS; | |
18807521 | 431 | if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0) |
1da177e4 LT |
432 | return retval; |
433 | ||
434 | /* controllers may cache some of the periodic schedule ... */ | |
083522d7 | 435 | hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params); |
53bd6a60 | 436 | if (HCC_ISOC_CACHE(hcc_params)) // full frame cache |
1da177e4 LT |
437 | ehci->i_thresh = 8; |
438 | else // N microframes cached | |
18807521 | 439 | ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params); |
1da177e4 LT |
440 | |
441 | ehci->reclaim = NULL; | |
64f89798 | 442 | ehci->reclaim_ready = 0; |
1da177e4 LT |
443 | ehci->next_uframe = -1; |
444 | ||
1da177e4 LT |
445 | /* |
446 | * dedicate a qh for the async ring head, since we couldn't unlink | |
447 | * a 'real' qh without stopping the async schedule [4.8]. use it | |
448 | * as the 'reclamation list head' too. | |
449 | * its dummy is used in hw_alt_next of many tds, to prevent the qh | |
450 | * from automatically advancing to the next td after short reads. | |
451 | */ | |
18807521 DB |
452 | ehci->async->qh_next.qh = NULL; |
453 | ehci->async->hw_next = QH_NEXT(ehci->async->qh_dma); | |
454 | ehci->async->hw_info1 = cpu_to_le32(QH_HEAD); | |
455 | ehci->async->hw_token = cpu_to_le32(QTD_STS_HALT); | |
456 | ehci->async->hw_qtd_next = EHCI_LIST_END; | |
457 | ehci->async->qh_state = QH_STATE_LINKED; | |
458 | ehci->async->hw_alt_next = QTD_NEXT(ehci->async->dummy->qtd_dma); | |
1da177e4 LT |
459 | |
460 | /* clear interrupt enables, set irq latency */ | |
461 | if (log2_irq_thresh < 0 || log2_irq_thresh > 6) | |
462 | log2_irq_thresh = 0; | |
463 | temp = 1 << (16 + log2_irq_thresh); | |
464 | if (HCC_CANPARK(hcc_params)) { | |
465 | /* HW default park == 3, on hardware that supports it (like | |
466 | * NVidia and ALI silicon), maximizes throughput on the async | |
467 | * schedule by avoiding QH fetches between transfers. | |
468 | * | |
469 | * With fast usb storage devices and NForce2, "park" seems to | |
470 | * make problems: throughput reduction (!), data errors... | |
471 | */ | |
472 | if (park) { | |
18807521 | 473 | park = min(park, (unsigned) 3); |
1da177e4 LT |
474 | temp |= CMD_PARK; |
475 | temp |= park << 8; | |
476 | } | |
18807521 | 477 | ehci_dbg(ehci, "park %d\n", park); |
1da177e4 | 478 | } |
18807521 | 479 | if (HCC_PGM_FRAMELISTLEN(hcc_params)) { |
1da177e4 LT |
480 | /* periodic schedule size can be smaller than default */ |
481 | temp &= ~(3 << 2); | |
482 | temp |= (EHCI_TUNE_FLS << 2); | |
483 | switch (EHCI_TUNE_FLS) { | |
484 | case 0: ehci->periodic_size = 1024; break; | |
485 | case 1: ehci->periodic_size = 512; break; | |
486 | case 2: ehci->periodic_size = 256; break; | |
18807521 | 487 | default: BUG(); |
1da177e4 LT |
488 | } |
489 | } | |
18807521 DB |
490 | ehci->command = temp; |
491 | ||
18807521 DB |
492 | return 0; |
493 | } | |
494 | ||
495 | /* start HC running; it's halted, ehci_init() has been run (once) */ | |
496 | static int ehci_run (struct usb_hcd *hcd) | |
497 | { | |
498 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
499 | int retval; | |
500 | u32 temp; | |
501 | u32 hcc_params; | |
502 | ||
503 | /* EHCI spec section 4.1 */ | |
504 | if ((retval = ehci_reset(ehci)) != 0) { | |
18807521 DB |
505 | ehci_mem_cleanup(ehci); |
506 | return retval; | |
507 | } | |
083522d7 BH |
508 | ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list); |
509 | ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next); | |
18807521 DB |
510 | |
511 | /* | |
512 | * hcc_params controls whether ehci->regs->segment must (!!!) | |
513 | * be used; it constrains QH/ITD/SITD and QTD locations. | |
514 | * pci_pool consistent memory always uses segment zero. | |
515 | * streaming mappings for I/O buffers, like pci_map_single(), | |
516 | * can return segments above 4GB, if the device allows. | |
517 | * | |
518 | * NOTE: the dma mask is visible through dma_supported(), so | |
519 | * drivers can pass this info along ... like NETIF_F_HIGHDMA, | |
520 | * Scsi_Host.highmem_io, and so forth. It's readonly to all | |
521 | * host side drivers though. | |
522 | */ | |
083522d7 | 523 | hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params); |
18807521 | 524 | if (HCC_64BIT_ADDR(hcc_params)) { |
083522d7 | 525 | ehci_writel(ehci, 0, &ehci->regs->segment); |
18807521 DB |
526 | #if 0 |
527 | // this is deeply broken on almost all architectures | |
528 | if (!dma_set_mask(hcd->self.controller, DMA_64BIT_MASK)) | |
529 | ehci_info(ehci, "enabled 64bit DMA\n"); | |
530 | #endif | |
531 | } | |
532 | ||
533 | ||
1da177e4 LT |
534 | // Philips, Intel, and maybe others need CMD_RUN before the |
535 | // root hub will detect new devices (why?); NEC doesn't | |
18807521 DB |
536 | ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET); |
537 | ehci->command |= CMD_RUN; | |
083522d7 | 538 | ehci_writel(ehci, ehci->command, &ehci->regs->command); |
18807521 | 539 | dbg_cmd (ehci, "init", ehci->command); |
1da177e4 | 540 | |
1da177e4 LT |
541 | /* |
542 | * Start, enabling full USB 2.0 functionality ... usb 1.1 devices | |
543 | * are explicitly handed to companion controller(s), so no TT is | |
544 | * involved with the root hub. (Except where one is integrated, | |
545 | * and there's no companion controller unless maybe for USB OTG.) | |
546 | */ | |
1da177e4 | 547 | hcd->state = HC_STATE_RUNNING; |
083522d7 BH |
548 | ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag); |
549 | ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */ | |
1da177e4 | 550 | |
083522d7 | 551 | temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase)); |
1da177e4 | 552 | ehci_info (ehci, |
93f1a47c | 553 | "USB %x.%x started, EHCI %x.%02x, driver %s%s\n", |
7ff71d6a | 554 | ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f), |
93f1a47c DB |
555 | temp >> 8, temp & 0xff, DRIVER_VERSION, |
556 | ignore_oc ? ", overcurrent ignored" : ""); | |
1da177e4 | 557 | |
083522d7 BH |
558 | ehci_writel(ehci, INTR_MASK, |
559 | &ehci->regs->intr_enable); /* Turn On Interrupts */ | |
1da177e4 | 560 | |
18807521 DB |
561 | /* GRR this is run-once init(), being done every time the HC starts. |
562 | * So long as they're part of class devices, we can't do it init() | |
563 | * since the class device isn't created that early. | |
564 | */ | |
565 | create_debug_files(ehci); | |
1da177e4 LT |
566 | |
567 | return 0; | |
568 | } | |
569 | ||
1da177e4 LT |
570 | /*-------------------------------------------------------------------------*/ |
571 | ||
7d12e780 | 572 | static irqreturn_t ehci_irq (struct usb_hcd *hcd) |
1da177e4 LT |
573 | { |
574 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
575 | u32 status; | |
576 | int bh; | |
577 | ||
578 | spin_lock (&ehci->lock); | |
579 | ||
083522d7 | 580 | status = ehci_readl(ehci, &ehci->regs->status); |
1da177e4 LT |
581 | |
582 | /* e.g. cardbus physical eject */ | |
583 | if (status == ~(u32) 0) { | |
584 | ehci_dbg (ehci, "device removed\n"); | |
585 | goto dead; | |
586 | } | |
587 | ||
588 | status &= INTR_MASK; | |
589 | if (!status) { /* irq sharing? */ | |
590 | spin_unlock(&ehci->lock); | |
591 | return IRQ_NONE; | |
592 | } | |
593 | ||
594 | /* clear (just) interrupts */ | |
083522d7 BH |
595 | ehci_writel(ehci, status, &ehci->regs->status); |
596 | ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */ | |
1da177e4 LT |
597 | bh = 0; |
598 | ||
599 | #ifdef EHCI_VERBOSE_DEBUG | |
600 | /* unrequested/ignored: Frame List Rollover */ | |
601 | dbg_status (ehci, "irq", status); | |
602 | #endif | |
603 | ||
604 | /* INT, ERR, and IAA interrupt rates can be throttled */ | |
605 | ||
606 | /* normal [4.15.1.2] or error [4.15.1.1] completion */ | |
607 | if (likely ((status & (STS_INT|STS_ERR)) != 0)) { | |
608 | if (likely ((status & STS_ERR) == 0)) | |
609 | COUNT (ehci->stats.normal); | |
610 | else | |
611 | COUNT (ehci->stats.error); | |
612 | bh = 1; | |
613 | } | |
614 | ||
615 | /* complete the unlinking of some qh [4.15.2.3] */ | |
616 | if (status & STS_IAA) { | |
617 | COUNT (ehci->stats.reclaim); | |
64f89798 | 618 | ehci->reclaim_ready = 1; |
1da177e4 LT |
619 | bh = 1; |
620 | } | |
621 | ||
622 | /* remote wakeup [4.3.1] */ | |
d97cc2f2 | 623 | if (status & STS_PCD) { |
1da177e4 LT |
624 | unsigned i = HCS_N_PORTS (ehci->hcs_params); |
625 | ||
626 | /* resume root hub? */ | |
083522d7 | 627 | if (!(ehci_readl(ehci, &ehci->regs->command) & CMD_RUN)) |
8c03356a | 628 | usb_hcd_resume_root_hub(hcd); |
1da177e4 LT |
629 | |
630 | while (i--) { | |
083522d7 BH |
631 | int pstatus = ehci_readl(ehci, |
632 | &ehci->regs->port_status [i]); | |
b972b68c DB |
633 | |
634 | if (pstatus & PORT_OWNER) | |
1da177e4 | 635 | continue; |
b972b68c | 636 | if (!(pstatus & PORT_RESUME) |
1da177e4 LT |
637 | || ehci->reset_done [i] != 0) |
638 | continue; | |
639 | ||
640 | /* start 20 msec resume signaling from this port, | |
641 | * and make khubd collect PORT_STAT_C_SUSPEND to | |
642 | * stop that signaling. | |
643 | */ | |
644 | ehci->reset_done [i] = jiffies + msecs_to_jiffies (20); | |
1da177e4 LT |
645 | ehci_dbg (ehci, "port %d remote wakeup\n", i + 1); |
646 | } | |
647 | } | |
648 | ||
649 | /* PCI errors [4.15.2.4] */ | |
650 | if (unlikely ((status & STS_FATAL) != 0)) { | |
651 | /* bogus "fatal" IRQs appear on some chips... why? */ | |
083522d7 BH |
652 | status = ehci_readl(ehci, &ehci->regs->status); |
653 | dbg_cmd (ehci, "fatal", ehci_readl(ehci, | |
654 | &ehci->regs->command)); | |
1da177e4 LT |
655 | dbg_status (ehci, "fatal", status); |
656 | if (status & STS_HALT) { | |
657 | ehci_err (ehci, "fatal error\n"); | |
658 | dead: | |
659 | ehci_reset (ehci); | |
083522d7 | 660 | ehci_writel(ehci, 0, &ehci->regs->configured_flag); |
1da177e4 LT |
661 | /* generic layer kills/unlinks all urbs, then |
662 | * uses ehci_stop to clean up the rest | |
663 | */ | |
664 | bh = 1; | |
665 | } | |
666 | } | |
667 | ||
668 | if (bh) | |
7d12e780 | 669 | ehci_work (ehci); |
1da177e4 LT |
670 | spin_unlock (&ehci->lock); |
671 | return IRQ_HANDLED; | |
672 | } | |
673 | ||
674 | /*-------------------------------------------------------------------------*/ | |
675 | ||
676 | /* | |
677 | * non-error returns are a promise to giveback() the urb later | |
678 | * we drop ownership so next owner (or urb unlink) can get it | |
679 | * | |
680 | * urb + dev is in hcd.self.controller.urb_list | |
681 | * we're queueing TDs onto software and hardware lists | |
682 | * | |
683 | * hcd-specific init for hcpriv hasn't been done yet | |
684 | * | |
685 | * NOTE: control, bulk, and interrupt share the same code to append TDs | |
686 | * to a (possibly active) QH, and the same QH scanning code. | |
687 | */ | |
688 | static int ehci_urb_enqueue ( | |
689 | struct usb_hcd *hcd, | |
690 | struct usb_host_endpoint *ep, | |
691 | struct urb *urb, | |
55016f10 | 692 | gfp_t mem_flags |
1da177e4 LT |
693 | ) { |
694 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
695 | struct list_head qtd_list; | |
696 | ||
697 | INIT_LIST_HEAD (&qtd_list); | |
698 | ||
699 | switch (usb_pipetype (urb->pipe)) { | |
700 | // case PIPE_CONTROL: | |
701 | // case PIPE_BULK: | |
702 | default: | |
703 | if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags)) | |
704 | return -ENOMEM; | |
705 | return submit_async (ehci, ep, urb, &qtd_list, mem_flags); | |
706 | ||
707 | case PIPE_INTERRUPT: | |
708 | if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags)) | |
709 | return -ENOMEM; | |
710 | return intr_submit (ehci, ep, urb, &qtd_list, mem_flags); | |
711 | ||
712 | case PIPE_ISOCHRONOUS: | |
713 | if (urb->dev->speed == USB_SPEED_HIGH) | |
714 | return itd_submit (ehci, urb, mem_flags); | |
715 | else | |
716 | return sitd_submit (ehci, urb, mem_flags); | |
717 | } | |
718 | } | |
719 | ||
720 | static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh) | |
721 | { | |
64f89798 GKH |
722 | /* if we need to use IAA and it's busy, defer */ |
723 | if (qh->qh_state == QH_STATE_LINKED | |
724 | && ehci->reclaim | |
725 | && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) { | |
1da177e4 LT |
726 | struct ehci_qh *last; |
727 | ||
728 | for (last = ehci->reclaim; | |
729 | last->reclaim; | |
730 | last = last->reclaim) | |
731 | continue; | |
732 | qh->qh_state = QH_STATE_UNLINK_WAIT; | |
733 | last->reclaim = qh; | |
734 | ||
64f89798 GKH |
735 | /* bypass IAA if the hc can't care */ |
736 | } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim) | |
737 | end_unlink_async (ehci); | |
738 | ||
739 | /* something else might have unlinked the qh by now */ | |
740 | if (qh->qh_state == QH_STATE_LINKED) | |
1da177e4 LT |
741 | start_unlink_async (ehci, qh); |
742 | } | |
743 | ||
744 | /* remove from hardware lists | |
745 | * completions normally happen asynchronously | |
746 | */ | |
747 | ||
748 | static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb) | |
749 | { | |
750 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
751 | struct ehci_qh *qh; | |
752 | unsigned long flags; | |
753 | ||
754 | spin_lock_irqsave (&ehci->lock, flags); | |
755 | switch (usb_pipetype (urb->pipe)) { | |
756 | // case PIPE_CONTROL: | |
757 | // case PIPE_BULK: | |
758 | default: | |
759 | qh = (struct ehci_qh *) urb->hcpriv; | |
760 | if (!qh) | |
761 | break; | |
64f89798 | 762 | unlink_async (ehci, qh); |
1da177e4 LT |
763 | break; |
764 | ||
765 | case PIPE_INTERRUPT: | |
766 | qh = (struct ehci_qh *) urb->hcpriv; | |
767 | if (!qh) | |
768 | break; | |
769 | switch (qh->qh_state) { | |
770 | case QH_STATE_LINKED: | |
771 | intr_deschedule (ehci, qh); | |
772 | /* FALL THROUGH */ | |
773 | case QH_STATE_IDLE: | |
7d12e780 | 774 | qh_completions (ehci, qh); |
1da177e4 LT |
775 | break; |
776 | default: | |
777 | ehci_dbg (ehci, "bogus qh %p state %d\n", | |
778 | qh, qh->qh_state); | |
779 | goto done; | |
780 | } | |
781 | ||
782 | /* reschedule QH iff another request is queued */ | |
783 | if (!list_empty (&qh->qtd_list) | |
784 | && HC_IS_RUNNING (hcd->state)) { | |
785 | int status; | |
786 | ||
787 | status = qh_schedule (ehci, qh); | |
788 | spin_unlock_irqrestore (&ehci->lock, flags); | |
789 | ||
790 | if (status != 0) { | |
791 | // shouldn't happen often, but ... | |
792 | // FIXME kill those tds' urbs | |
793 | err ("can't reschedule qh %p, err %d", | |
794 | qh, status); | |
795 | } | |
796 | return status; | |
797 | } | |
798 | break; | |
799 | ||
800 | case PIPE_ISOCHRONOUS: | |
801 | // itd or sitd ... | |
802 | ||
803 | // wait till next completion, do it then. | |
804 | // completion irqs can wait up to 1024 msec, | |
805 | break; | |
806 | } | |
807 | done: | |
808 | spin_unlock_irqrestore (&ehci->lock, flags); | |
809 | return 0; | |
810 | } | |
811 | ||
812 | /*-------------------------------------------------------------------------*/ | |
813 | ||
814 | // bulk qh holds the data toggle | |
815 | ||
816 | static void | |
817 | ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep) | |
818 | { | |
819 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
820 | unsigned long flags; | |
821 | struct ehci_qh *qh, *tmp; | |
822 | ||
823 | /* ASSERT: any requests/urbs are being unlinked */ | |
824 | /* ASSERT: nobody can be submitting urbs for this any more */ | |
825 | ||
826 | rescan: | |
827 | spin_lock_irqsave (&ehci->lock, flags); | |
828 | qh = ep->hcpriv; | |
829 | if (!qh) | |
830 | goto done; | |
831 | ||
832 | /* endpoints can be iso streams. for now, we don't | |
833 | * accelerate iso completions ... so spin a while. | |
834 | */ | |
835 | if (qh->hw_info1 == 0) { | |
836 | ehci_vdbg (ehci, "iso delay\n"); | |
837 | goto idle_timeout; | |
838 | } | |
839 | ||
840 | if (!HC_IS_RUNNING (hcd->state)) | |
841 | qh->qh_state = QH_STATE_IDLE; | |
842 | switch (qh->qh_state) { | |
843 | case QH_STATE_LINKED: | |
844 | for (tmp = ehci->async->qh_next.qh; | |
845 | tmp && tmp != qh; | |
846 | tmp = tmp->qh_next.qh) | |
847 | continue; | |
848 | /* periodic qh self-unlinks on empty */ | |
849 | if (!tmp) | |
850 | goto nogood; | |
851 | unlink_async (ehci, qh); | |
852 | /* FALL THROUGH */ | |
853 | case QH_STATE_UNLINK: /* wait for hw to finish? */ | |
854 | idle_timeout: | |
855 | spin_unlock_irqrestore (&ehci->lock, flags); | |
22c43863 | 856 | schedule_timeout_uninterruptible(1); |
1da177e4 LT |
857 | goto rescan; |
858 | case QH_STATE_IDLE: /* fully unlinked */ | |
859 | if (list_empty (&qh->qtd_list)) { | |
860 | qh_put (qh); | |
861 | break; | |
862 | } | |
863 | /* else FALL THROUGH */ | |
864 | default: | |
865 | nogood: | |
866 | /* caller was supposed to have unlinked any requests; | |
867 | * that's not our job. just leak this memory. | |
868 | */ | |
869 | ehci_err (ehci, "qh %p (#%02x) state %d%s\n", | |
870 | qh, ep->desc.bEndpointAddress, qh->qh_state, | |
871 | list_empty (&qh->qtd_list) ? "" : "(has tds)"); | |
872 | break; | |
873 | } | |
874 | ep->hcpriv = NULL; | |
875 | done: | |
876 | spin_unlock_irqrestore (&ehci->lock, flags); | |
877 | return; | |
878 | } | |
879 | ||
7ff71d6a MP |
880 | static int ehci_get_frame (struct usb_hcd *hcd) |
881 | { | |
882 | struct ehci_hcd *ehci = hcd_to_ehci (hcd); | |
083522d7 BH |
883 | return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) % |
884 | ehci->periodic_size; | |
7ff71d6a | 885 | } |
1da177e4 LT |
886 | |
887 | /*-------------------------------------------------------------------------*/ | |
888 | ||
1da177e4 LT |
889 | #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC |
890 | ||
891 | MODULE_DESCRIPTION (DRIVER_INFO); | |
892 | MODULE_AUTHOR (DRIVER_AUTHOR); | |
893 | MODULE_LICENSE ("GPL"); | |
894 | ||
7ff71d6a MP |
895 | #ifdef CONFIG_PCI |
896 | #include "ehci-pci.c" | |
01cced25 | 897 | #define PCI_DRIVER ehci_pci_driver |
7ff71d6a | 898 | #endif |
1da177e4 | 899 | |
a11570f2 | 900 | #ifdef CONFIG_MPC834x |
80cb9aee | 901 | #include "ehci-fsl.c" |
01cced25 | 902 | #define PLATFORM_DRIVER ehci_fsl_driver |
80cb9aee RV |
903 | #endif |
904 | ||
dfbaa7d8 | 905 | #ifdef CONFIG_SOC_AU1200 |
76fa9a24 | 906 | #include "ehci-au1xxx.c" |
01cced25 | 907 | #define PLATFORM_DRIVER ehci_hcd_au1xxx_driver |
76fa9a24 JC |
908 | #endif |
909 | ||
01cced25 | 910 | #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) |
7ff71d6a MP |
911 | #error "missing bus glue for ehci-hcd" |
912 | #endif | |
01cced25 KG |
913 | |
914 | static int __init ehci_hcd_init(void) | |
915 | { | |
916 | int retval = 0; | |
917 | ||
918 | pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n", | |
919 | hcd_name, | |
920 | sizeof(struct ehci_qh), sizeof(struct ehci_qtd), | |
921 | sizeof(struct ehci_itd), sizeof(struct ehci_sitd)); | |
922 | ||
923 | #ifdef PLATFORM_DRIVER | |
924 | retval = platform_driver_register(&PLATFORM_DRIVER); | |
925 | if (retval < 0) | |
926 | return retval; | |
927 | #endif | |
928 | ||
929 | #ifdef PCI_DRIVER | |
930 | retval = pci_register_driver(&PCI_DRIVER); | |
931 | if (retval < 0) { | |
932 | #ifdef PLATFORM_DRIVER | |
933 | platform_driver_unregister(&PLATFORM_DRIVER); | |
934 | #endif | |
935 | } | |
936 | #endif | |
937 | ||
938 | return retval; | |
939 | } | |
940 | module_init(ehci_hcd_init); | |
941 | ||
942 | static void __exit ehci_hcd_cleanup(void) | |
943 | { | |
944 | #ifdef PLATFORM_DRIVER | |
945 | platform_driver_unregister(&PLATFORM_DRIVER); | |
946 | #endif | |
947 | #ifdef PCI_DRIVER | |
948 | pci_unregister_driver(&PCI_DRIVER); | |
949 | #endif | |
950 | } | |
951 | module_exit(ehci_hcd_cleanup); | |
952 |