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