2 * Copyright (c) 2000-2004 by David Brownell
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.
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
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.
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/vmalloc.h>
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/timer.h>
30 #include <linux/ktime.h>
31 #include <linux/list.h>
32 #include <linux/interrupt.h>
33 #include <linux/usb.h>
34 #include <linux/usb/hcd.h>
35 #include <linux/moduleparam.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/debugfs.h>
38 #include <linux/slab.h>
39 #include <linux/uaccess.h>
41 #include <asm/byteorder.h>
44 #include <asm/system.h>
45 #include <asm/unaligned.h>
47 /*-------------------------------------------------------------------------*/
50 * EHCI hc_driver implementation ... experimental, incomplete.
51 * Based on the final 1.0 register interface specification.
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.
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!
63 #define DRIVER_AUTHOR "David Brownell"
64 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
66 static const char hcd_name
[] = "ehci_hcd";
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
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.
88 #define EHCI_TUNE_FLS 1 /* (medium) 512-frame schedule */
90 #define EHCI_IAA_MSECS 10 /* arbitrary */
91 #define EHCI_IO_JIFFIES (HZ/10) /* io watchdog > irq_thresh */
92 #define EHCI_ASYNC_JIFFIES (HZ/20) /* async idle timeout */
93 #define EHCI_SHRINK_FRAMES 5 /* async qh unlink delay */
95 /* Initial IRQ latency: faster than hw default */
96 static int log2_irq_thresh
= 0; // 0 to 6
97 module_param (log2_irq_thresh
, int, S_IRUGO
);
98 MODULE_PARM_DESC (log2_irq_thresh
, "log2 IRQ latency, 1-64 microframes");
100 /* initial park setting: slower than hw default */
101 static unsigned park
= 0;
102 module_param (park
, uint
, S_IRUGO
);
103 MODULE_PARM_DESC (park
, "park setting; 1-3 back-to-back async packets");
105 /* for flakey hardware, ignore overcurrent indicators */
106 static int ignore_oc
= 0;
107 module_param (ignore_oc
, bool, S_IRUGO
);
108 MODULE_PARM_DESC (ignore_oc
, "ignore bogus hardware overcurrent indications");
110 /* for link power management(LPM) feature */
111 static unsigned int hird
;
112 module_param(hird
, int, S_IRUGO
);
113 MODULE_PARM_DESC(hird
, "host initiated resume duration, +1 for each 75us\n");
115 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
117 /*-------------------------------------------------------------------------*/
120 #include "ehci-dbg.c"
121 #include "pci-quirks.h"
123 /*-------------------------------------------------------------------------*/
126 timer_action(struct ehci_hcd
*ehci
, enum ehci_timer_action action
)
128 /* Don't override timeouts which shrink or (later) disable
129 * the async ring; just the I/O watchdog. Note that if a
130 * SHRINK were pending, OFF would never be requested.
132 if (timer_pending(&ehci
->watchdog
)
133 && ((BIT(TIMER_ASYNC_SHRINK
) | BIT(TIMER_ASYNC_OFF
))
137 if (!test_and_set_bit(action
, &ehci
->actions
)) {
141 case TIMER_IO_WATCHDOG
:
142 if (!ehci
->need_io_watchdog
)
146 case TIMER_ASYNC_OFF
:
147 t
= EHCI_ASYNC_JIFFIES
;
149 /* case TIMER_ASYNC_SHRINK: */
151 /* add a jiffie since we synch against the
152 * 8 KHz uframe counter.
154 t
= DIV_ROUND_UP(EHCI_SHRINK_FRAMES
* HZ
, 1000) + 1;
157 mod_timer(&ehci
->watchdog
, t
+ jiffies
);
161 /*-------------------------------------------------------------------------*/
164 * handshake - spin reading hc until handshake completes or fails
165 * @ptr: address of hc register to be read
166 * @mask: bits to look at in result of read
167 * @done: value of those bits when handshake succeeds
168 * @usec: timeout in microseconds
170 * Returns negative errno, or zero on success
172 * Success happens when the "mask" bits have the specified value (hardware
173 * handshake done). There are two failure modes: "usec" have passed (major
174 * hardware flakeout), or the register reads as all-ones (hardware removed).
176 * That last failure should_only happen in cases like physical cardbus eject
177 * before driver shutdown. But it also seems to be caused by bugs in cardbus
178 * bridge shutdown: shutting down the bridge before the devices using it.
180 static int handshake (struct ehci_hcd
*ehci
, void __iomem
*ptr
,
181 u32 mask
, u32 done
, int usec
)
186 result
= ehci_readl(ehci
, ptr
);
187 if (result
== ~(u32
)0) /* card removed */
198 /* check TDI/ARC silicon is in host mode */
199 static int tdi_in_host_mode (struct ehci_hcd
*ehci
)
201 u32 __iomem
*reg_ptr
;
204 reg_ptr
= (u32 __iomem
*)(((u8 __iomem
*)ehci
->regs
) + USBMODE
);
205 tmp
= ehci_readl(ehci
, reg_ptr
);
206 return (tmp
& 3) == USBMODE_CM_HC
;
209 /* force HC to halt state from unknown (EHCI spec section 2.3) */
210 static int ehci_halt (struct ehci_hcd
*ehci
)
212 u32 temp
= ehci_readl(ehci
, &ehci
->regs
->status
);
214 /* disable any irqs left enabled by previous code */
215 ehci_writel(ehci
, 0, &ehci
->regs
->intr_enable
);
217 if (ehci_is_TDI(ehci
) && tdi_in_host_mode(ehci
) == 0) {
221 if ((temp
& STS_HALT
) != 0)
224 temp
= ehci_readl(ehci
, &ehci
->regs
->command
);
226 ehci_writel(ehci
, temp
, &ehci
->regs
->command
);
227 return handshake (ehci
, &ehci
->regs
->status
,
228 STS_HALT
, STS_HALT
, 16 * 125);
231 static int handshake_on_error_set_halt(struct ehci_hcd
*ehci
, void __iomem
*ptr
,
232 u32 mask
, u32 done
, int usec
)
236 error
= handshake(ehci
, ptr
, mask
, done
, usec
);
239 ehci_to_hcd(ehci
)->state
= HC_STATE_HALT
;
240 ehci_err(ehci
, "force halt; handshake %p %08x %08x -> %d\n",
241 ptr
, mask
, done
, error
);
247 /* put TDI/ARC silicon into EHCI mode */
248 static void tdi_reset (struct ehci_hcd
*ehci
)
250 u32 __iomem
*reg_ptr
;
253 reg_ptr
= (u32 __iomem
*)(((u8 __iomem
*)ehci
->regs
) + USBMODE
);
254 tmp
= ehci_readl(ehci
, reg_ptr
);
255 tmp
|= USBMODE_CM_HC
;
256 /* The default byte access to MMR space is LE after
257 * controller reset. Set the required endian mode
258 * for transfer buffers to match the host microprocessor
260 if (ehci_big_endian_mmio(ehci
))
262 ehci_writel(ehci
, tmp
, reg_ptr
);
265 /* reset a non-running (STS_HALT == 1) controller */
266 static int ehci_reset (struct ehci_hcd
*ehci
)
269 u32 command
= ehci_readl(ehci
, &ehci
->regs
->command
);
271 /* If the EHCI debug controller is active, special care must be
272 * taken before and after a host controller reset */
273 if (ehci
->debug
&& !dbgp_reset_prep())
276 command
|= CMD_RESET
;
277 dbg_cmd (ehci
, "reset", command
);
278 ehci_writel(ehci
, command
, &ehci
->regs
->command
);
279 ehci_to_hcd(ehci
)->state
= HC_STATE_HALT
;
280 ehci
->next_statechange
= jiffies
;
281 retval
= handshake (ehci
, &ehci
->regs
->command
,
282 CMD_RESET
, 0, 250 * 1000);
284 if (ehci
->has_hostpc
) {
285 ehci_writel(ehci
, USBMODE_EX_HC
| USBMODE_EX_VBPS
,
286 (u32 __iomem
*)(((u8
*)ehci
->regs
) + USBMODE_EX
));
287 ehci_writel(ehci
, TXFIFO_DEFAULT
,
288 (u32 __iomem
*)(((u8
*)ehci
->regs
) + TXFILLTUNING
));
293 if (ehci_is_TDI(ehci
))
297 dbgp_external_startup();
302 /* idle the controller (from running) */
303 static void ehci_quiesce (struct ehci_hcd
*ehci
)
308 if (!HC_IS_RUNNING (ehci_to_hcd(ehci
)->state
))
312 /* wait for any schedule enables/disables to take effect */
313 temp
= ehci_readl(ehci
, &ehci
->regs
->command
) << 10;
314 temp
&= STS_ASS
| STS_PSS
;
315 if (handshake_on_error_set_halt(ehci
, &ehci
->regs
->status
,
316 STS_ASS
| STS_PSS
, temp
, 16 * 125))
319 /* then disable anything that's still active */
320 temp
= ehci_readl(ehci
, &ehci
->regs
->command
);
321 temp
&= ~(CMD_ASE
| CMD_IAAD
| CMD_PSE
);
322 ehci_writel(ehci
, temp
, &ehci
->regs
->command
);
324 /* hardware can take 16 microframes to turn off ... */
325 handshake_on_error_set_halt(ehci
, &ehci
->regs
->status
,
326 STS_ASS
| STS_PSS
, 0, 16 * 125);
329 /*-------------------------------------------------------------------------*/
331 static void end_unlink_async(struct ehci_hcd
*ehci
);
332 static void ehci_work(struct ehci_hcd
*ehci
);
334 #include "ehci-hub.c"
335 #include "ehci-lpm.c"
336 #include "ehci-mem.c"
338 #include "ehci-sched.c"
340 /*-------------------------------------------------------------------------*/
342 static void ehci_iaa_watchdog(unsigned long param
)
344 struct ehci_hcd
*ehci
= (struct ehci_hcd
*) param
;
347 spin_lock_irqsave (&ehci
->lock
, flags
);
349 /* Lost IAA irqs wedge things badly; seen first with a vt8235.
350 * So we need this watchdog, but must protect it against both
351 * (a) SMP races against real IAA firing and retriggering, and
352 * (b) clean HC shutdown, when IAA watchdog was pending.
355 && !timer_pending(&ehci
->iaa_watchdog
)
356 && HC_IS_RUNNING(ehci_to_hcd(ehci
)->state
)) {
359 /* If we get here, IAA is *REALLY* late. It's barely
360 * conceivable that the system is so busy that CMD_IAAD
361 * is still legitimately set, so let's be sure it's
362 * clear before we read STS_IAA. (The HC should clear
363 * CMD_IAAD when it sets STS_IAA.)
365 cmd
= ehci_readl(ehci
, &ehci
->regs
->command
);
367 ehci_writel(ehci
, cmd
& ~CMD_IAAD
,
368 &ehci
->regs
->command
);
370 /* If IAA is set here it either legitimately triggered
371 * before we cleared IAAD above (but _way_ late, so we'll
372 * still count it as lost) ... or a silicon erratum:
373 * - VIA seems to set IAA without triggering the IRQ;
374 * - IAAD potentially cleared without setting IAA.
376 status
= ehci_readl(ehci
, &ehci
->regs
->status
);
377 if ((status
& STS_IAA
) || !(cmd
& CMD_IAAD
)) {
378 COUNT (ehci
->stats
.lost_iaa
);
379 ehci_writel(ehci
, STS_IAA
, &ehci
->regs
->status
);
382 ehci_vdbg(ehci
, "IAA watchdog: status %x cmd %x\n",
384 end_unlink_async(ehci
);
387 spin_unlock_irqrestore(&ehci
->lock
, flags
);
390 static void ehci_watchdog(unsigned long param
)
392 struct ehci_hcd
*ehci
= (struct ehci_hcd
*) param
;
395 spin_lock_irqsave(&ehci
->lock
, flags
);
397 /* stop async processing after it's idled a bit */
398 if (test_bit (TIMER_ASYNC_OFF
, &ehci
->actions
))
399 start_unlink_async (ehci
, ehci
->async
);
401 /* ehci could run by timer, without IRQs ... */
404 spin_unlock_irqrestore (&ehci
->lock
, flags
);
407 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
408 * The firmware seems to think that powering off is a wakeup event!
409 * This routine turns off remote wakeup and everything else, on all ports.
411 static void ehci_turn_off_all_ports(struct ehci_hcd
*ehci
)
413 int port
= HCS_N_PORTS(ehci
->hcs_params
);
416 ehci_writel(ehci
, PORT_RWC_BITS
,
417 &ehci
->regs
->port_status
[port
]);
421 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
422 * Should be called with ehci->lock held.
424 static void ehci_silence_controller(struct ehci_hcd
*ehci
)
427 ehci_turn_off_all_ports(ehci
);
429 /* make BIOS/etc use companion controller during reboot */
430 ehci_writel(ehci
, 0, &ehci
->regs
->configured_flag
);
432 /* unblock posted writes */
433 ehci_readl(ehci
, &ehci
->regs
->configured_flag
);
436 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
437 * This forcibly disables dma and IRQs, helping kexec and other cases
438 * where the next system software may expect clean state.
440 static void ehci_shutdown(struct usb_hcd
*hcd
)
442 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
444 del_timer_sync(&ehci
->watchdog
);
445 del_timer_sync(&ehci
->iaa_watchdog
);
447 spin_lock_irq(&ehci
->lock
);
448 ehci_silence_controller(ehci
);
449 spin_unlock_irq(&ehci
->lock
);
452 static void ehci_port_power (struct ehci_hcd
*ehci
, int is_on
)
456 if (!HCS_PPC (ehci
->hcs_params
))
459 ehci_dbg (ehci
, "...power%s ports...\n", is_on
? "up" : "down");
460 for (port
= HCS_N_PORTS (ehci
->hcs_params
); port
> 0; )
461 (void) ehci_hub_control(ehci_to_hcd(ehci
),
462 is_on
? SetPortFeature
: ClearPortFeature
,
465 /* Flush those writes */
466 ehci_readl(ehci
, &ehci
->regs
->command
);
470 /*-------------------------------------------------------------------------*/
473 * ehci_work is called from some interrupts, timers, and so on.
474 * it calls driver completion functions, after dropping ehci->lock.
476 static void ehci_work (struct ehci_hcd
*ehci
)
478 timer_action_done (ehci
, TIMER_IO_WATCHDOG
);
480 /* another CPU may drop ehci->lock during a schedule scan while
481 * it reports urb completions. this flag guards against bogus
482 * attempts at re-entrant schedule scanning.
488 if (ehci
->next_uframe
!= -1)
489 scan_periodic (ehci
);
492 /* the IO watchdog guards against hardware or driver bugs that
493 * misplace IRQs, and should let us run completely without IRQs.
494 * such lossage has been observed on both VT6202 and VT8235.
496 if (HC_IS_RUNNING (ehci_to_hcd(ehci
)->state
) &&
497 (ehci
->async
->qh_next
.ptr
!= NULL
||
498 ehci
->periodic_sched
!= 0))
499 timer_action (ehci
, TIMER_IO_WATCHDOG
);
503 * Called when the ehci_hcd module is removed.
505 static void ehci_stop (struct usb_hcd
*hcd
)
507 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
509 ehci_dbg (ehci
, "stop\n");
511 /* no more interrupts ... */
512 del_timer_sync (&ehci
->watchdog
);
513 del_timer_sync(&ehci
->iaa_watchdog
);
515 spin_lock_irq(&ehci
->lock
);
516 if (HC_IS_RUNNING (hcd
->state
))
519 ehci_silence_controller(ehci
);
521 spin_unlock_irq(&ehci
->lock
);
523 remove_companion_file(ehci
);
524 remove_debug_files (ehci
);
526 /* root hub is shut down separately (first, when possible) */
527 spin_lock_irq (&ehci
->lock
);
530 spin_unlock_irq (&ehci
->lock
);
531 ehci_mem_cleanup (ehci
);
533 if (ehci
->amd_pll_fix
== 1)
537 ehci_dbg (ehci
, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
538 ehci
->stats
.normal
, ehci
->stats
.error
, ehci
->stats
.reclaim
,
539 ehci
->stats
.lost_iaa
);
540 ehci_dbg (ehci
, "complete %ld unlink %ld\n",
541 ehci
->stats
.complete
, ehci
->stats
.unlink
);
544 dbg_status (ehci
, "ehci_stop completed",
545 ehci_readl(ehci
, &ehci
->regs
->status
));
548 /* one-time init, only for memory state */
549 static int ehci_init(struct usb_hcd
*hcd
)
551 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
555 struct ehci_qh_hw
*hw
;
557 spin_lock_init(&ehci
->lock
);
560 * keep io watchdog by default, those good HCDs could turn off it later
562 ehci
->need_io_watchdog
= 1;
563 init_timer(&ehci
->watchdog
);
564 ehci
->watchdog
.function
= ehci_watchdog
;
565 ehci
->watchdog
.data
= (unsigned long) ehci
;
567 init_timer(&ehci
->iaa_watchdog
);
568 ehci
->iaa_watchdog
.function
= ehci_iaa_watchdog
;
569 ehci
->iaa_watchdog
.data
= (unsigned long) ehci
;
571 hcc_params
= ehci_readl(ehci
, &ehci
->caps
->hcc_params
);
574 * hw default: 1K periodic list heads, one per frame.
575 * periodic_size can shrink by USBCMD update if hcc_params allows.
577 ehci
->periodic_size
= DEFAULT_I_TDPS
;
578 INIT_LIST_HEAD(&ehci
->cached_itd_list
);
579 INIT_LIST_HEAD(&ehci
->cached_sitd_list
);
581 if (HCC_PGM_FRAMELISTLEN(hcc_params
)) {
582 /* periodic schedule size can be smaller than default */
583 switch (EHCI_TUNE_FLS
) {
584 case 0: ehci
->periodic_size
= 1024; break;
585 case 1: ehci
->periodic_size
= 512; break;
586 case 2: ehci
->periodic_size
= 256; break;
590 if ((retval
= ehci_mem_init(ehci
, GFP_KERNEL
)) < 0)
593 /* controllers may cache some of the periodic schedule ... */
594 if (HCC_ISOC_CACHE(hcc_params
)) // full frame cache
595 ehci
->i_thresh
= 2 + 8;
596 else // N microframes cached
597 ehci
->i_thresh
= 2 + HCC_ISOC_THRES(hcc_params
);
599 ehci
->reclaim
= NULL
;
600 ehci
->next_uframe
= -1;
601 ehci
->clock_frame
= -1;
604 * dedicate a qh for the async ring head, since we couldn't unlink
605 * a 'real' qh without stopping the async schedule [4.8]. use it
606 * as the 'reclamation list head' too.
607 * its dummy is used in hw_alt_next of many tds, to prevent the qh
608 * from automatically advancing to the next td after short reads.
610 ehci
->async
->qh_next
.qh
= NULL
;
611 hw
= ehci
->async
->hw
;
612 hw
->hw_next
= QH_NEXT(ehci
, ehci
->async
->qh_dma
);
613 hw
->hw_info1
= cpu_to_hc32(ehci
, QH_HEAD
);
614 hw
->hw_token
= cpu_to_hc32(ehci
, QTD_STS_HALT
);
615 hw
->hw_qtd_next
= EHCI_LIST_END(ehci
);
616 ehci
->async
->qh_state
= QH_STATE_LINKED
;
617 hw
->hw_alt_next
= QTD_NEXT(ehci
, ehci
->async
->dummy
->qtd_dma
);
619 /* clear interrupt enables, set irq latency */
620 if (log2_irq_thresh
< 0 || log2_irq_thresh
> 6)
622 temp
= 1 << (16 + log2_irq_thresh
);
623 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params
)) {
625 ehci_dbg(ehci
, "enable per-port change event\n");
628 if (HCC_CANPARK(hcc_params
)) {
629 /* HW default park == 3, on hardware that supports it (like
630 * NVidia and ALI silicon), maximizes throughput on the async
631 * schedule by avoiding QH fetches between transfers.
633 * With fast usb storage devices and NForce2, "park" seems to
634 * make problems: throughput reduction (!), data errors...
637 park
= min(park
, (unsigned) 3);
641 ehci_dbg(ehci
, "park %d\n", park
);
643 if (HCC_PGM_FRAMELISTLEN(hcc_params
)) {
644 /* periodic schedule size can be smaller than default */
646 temp
|= (EHCI_TUNE_FLS
<< 2);
648 if (HCC_LPM(hcc_params
)) {
649 /* support link power management EHCI 1.1 addendum */
650 ehci_dbg(ehci
, "support lpm\n");
653 ehci_dbg(ehci
, "hird %d invalid, use default 0",
659 ehci
->command
= temp
;
661 /* Accept arbitrarily long scatter-gather lists */
662 if (!(hcd
->driver
->flags
& HCD_LOCAL_MEM
))
663 hcd
->self
.sg_tablesize
= ~0;
667 /* start HC running; it's halted, ehci_init() has been run (once) */
668 static int ehci_run (struct usb_hcd
*hcd
)
670 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
675 hcd
->uses_new_polling
= 1;
677 /* EHCI spec section 4.1 */
679 * TDI driver does the ehci_reset in their reset callback.
680 * Don't reset here, because configuration settings will
683 if (!ehci_is_TDI(ehci
) && (retval
= ehci_reset(ehci
)) != 0) {
684 ehci_mem_cleanup(ehci
);
687 ehci_writel(ehci
, ehci
->periodic_dma
, &ehci
->regs
->frame_list
);
688 ehci_writel(ehci
, (u32
)ehci
->async
->qh_dma
, &ehci
->regs
->async_next
);
691 * hcc_params controls whether ehci->regs->segment must (!!!)
692 * be used; it constrains QH/ITD/SITD and QTD locations.
693 * pci_pool consistent memory always uses segment zero.
694 * streaming mappings for I/O buffers, like pci_map_single(),
695 * can return segments above 4GB, if the device allows.
697 * NOTE: the dma mask is visible through dma_supported(), so
698 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
699 * Scsi_Host.highmem_io, and so forth. It's readonly to all
700 * host side drivers though.
702 hcc_params
= ehci_readl(ehci
, &ehci
->caps
->hcc_params
);
703 if (HCC_64BIT_ADDR(hcc_params
)) {
704 ehci_writel(ehci
, 0, &ehci
->regs
->segment
);
706 // this is deeply broken on almost all architectures
707 if (!dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64)))
708 ehci_info(ehci
, "enabled 64bit DMA\n");
713 // Philips, Intel, and maybe others need CMD_RUN before the
714 // root hub will detect new devices (why?); NEC doesn't
715 ehci
->command
&= ~(CMD_LRESET
|CMD_IAAD
|CMD_PSE
|CMD_ASE
|CMD_RESET
);
716 ehci
->command
|= CMD_RUN
;
717 ehci_writel(ehci
, ehci
->command
, &ehci
->regs
->command
);
718 dbg_cmd (ehci
, "init", ehci
->command
);
721 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
722 * are explicitly handed to companion controller(s), so no TT is
723 * involved with the root hub. (Except where one is integrated,
724 * and there's no companion controller unless maybe for USB OTG.)
726 * Turning on the CF flag will transfer ownership of all ports
727 * from the companions to the EHCI controller. If any of the
728 * companions are in the middle of a port reset at the time, it
729 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
730 * guarantees that no resets are in progress. After we set CF,
731 * a short delay lets the hardware catch up; new resets shouldn't
732 * be started before the port switching actions could complete.
734 down_write(&ehci_cf_port_reset_rwsem
);
735 hcd
->state
= HC_STATE_RUNNING
;
736 ehci_writel(ehci
, FLAG_CF
, &ehci
->regs
->configured_flag
);
737 ehci_readl(ehci
, &ehci
->regs
->command
); /* unblock posted writes */
739 up_write(&ehci_cf_port_reset_rwsem
);
740 ehci
->last_periodic_enable
= ktime_get_real();
742 temp
= HC_VERSION(ehci_readl(ehci
, &ehci
->caps
->hc_capbase
));
744 "USB %x.%x started, EHCI %x.%02x%s\n",
745 ((ehci
->sbrn
& 0xf0)>>4), (ehci
->sbrn
& 0x0f),
746 temp
>> 8, temp
& 0xff,
747 ignore_oc
? ", overcurrent ignored" : "");
749 ehci_writel(ehci
, INTR_MASK
,
750 &ehci
->regs
->intr_enable
); /* Turn On Interrupts */
752 /* GRR this is run-once init(), being done every time the HC starts.
753 * So long as they're part of class devices, we can't do it init()
754 * since the class device isn't created that early.
756 create_debug_files(ehci
);
757 create_companion_file(ehci
);
762 /*-------------------------------------------------------------------------*/
764 static irqreturn_t
ehci_irq (struct usb_hcd
*hcd
)
766 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
767 u32 status
, masked_status
, pcd_status
= 0, cmd
;
770 spin_lock (&ehci
->lock
);
772 status
= ehci_readl(ehci
, &ehci
->regs
->status
);
774 /* e.g. cardbus physical eject */
775 if (status
== ~(u32
) 0) {
776 ehci_dbg (ehci
, "device removed\n");
780 masked_status
= status
& INTR_MASK
;
781 if (!masked_status
) { /* irq sharing? */
782 spin_unlock(&ehci
->lock
);
786 /* clear (just) interrupts */
787 ehci_writel(ehci
, masked_status
, &ehci
->regs
->status
);
788 cmd
= ehci_readl(ehci
, &ehci
->regs
->command
);
792 /* unrequested/ignored: Frame List Rollover */
793 dbg_status (ehci
, "irq", status
);
796 /* INT, ERR, and IAA interrupt rates can be throttled */
798 /* normal [4.15.1.2] or error [4.15.1.1] completion */
799 if (likely ((status
& (STS_INT
|STS_ERR
)) != 0)) {
800 if (likely ((status
& STS_ERR
) == 0))
801 COUNT (ehci
->stats
.normal
);
803 COUNT (ehci
->stats
.error
);
807 /* complete the unlinking of some qh [4.15.2.3] */
808 if (status
& STS_IAA
) {
809 /* guard against (alleged) silicon errata */
810 if (cmd
& CMD_IAAD
) {
811 ehci_writel(ehci
, cmd
& ~CMD_IAAD
,
812 &ehci
->regs
->command
);
813 ehci_dbg(ehci
, "IAA with IAAD still set?\n");
816 COUNT(ehci
->stats
.reclaim
);
817 end_unlink_async(ehci
);
819 ehci_dbg(ehci
, "IAA with nothing to reclaim?\n");
822 /* remote wakeup [4.3.1] */
823 if (status
& STS_PCD
) {
824 unsigned i
= HCS_N_PORTS (ehci
->hcs_params
);
827 /* kick root hub later */
830 /* resume root hub? */
831 if (!(cmd
& CMD_RUN
))
832 usb_hcd_resume_root_hub(hcd
);
834 /* get per-port change detect bits */
841 /* leverage per-port change bits feature */
842 if (ehci
->has_ppcd
&& !(ppcd
& (1 << i
)))
844 pstatus
= ehci_readl(ehci
,
845 &ehci
->regs
->port_status
[i
]);
847 if (pstatus
& PORT_OWNER
)
849 if (!(test_bit(i
, &ehci
->suspended_ports
) &&
850 ((pstatus
& PORT_RESUME
) ||
851 !(pstatus
& PORT_SUSPEND
)) &&
852 (pstatus
& PORT_PE
) &&
853 ehci
->reset_done
[i
] == 0))
856 /* start 20 msec resume signaling from this port,
857 * and make khubd collect PORT_STAT_C_SUSPEND to
858 * stop that signaling. Use 5 ms extra for safety,
859 * like usb_port_resume() does.
861 ehci
->reset_done
[i
] = jiffies
+ msecs_to_jiffies(25);
862 ehci_dbg (ehci
, "port %d remote wakeup\n", i
+ 1);
863 mod_timer(&hcd
->rh_timer
, ehci
->reset_done
[i
]);
867 /* PCI errors [4.15.2.4] */
868 if (unlikely ((status
& STS_FATAL
) != 0)) {
869 ehci_err(ehci
, "fatal error\n");
870 dbg_cmd(ehci
, "fatal", cmd
);
871 dbg_status(ehci
, "fatal", status
);
875 ehci_writel(ehci
, 0, &ehci
->regs
->configured_flag
);
876 /* generic layer kills/unlinks all urbs, then
877 * uses ehci_stop to clean up the rest
884 spin_unlock (&ehci
->lock
);
886 usb_hcd_poll_rh_status(hcd
);
890 /*-------------------------------------------------------------------------*/
893 * non-error returns are a promise to giveback() the urb later
894 * we drop ownership so next owner (or urb unlink) can get it
896 * urb + dev is in hcd.self.controller.urb_list
897 * we're queueing TDs onto software and hardware lists
899 * hcd-specific init for hcpriv hasn't been done yet
901 * NOTE: control, bulk, and interrupt share the same code to append TDs
902 * to a (possibly active) QH, and the same QH scanning code.
904 static int ehci_urb_enqueue (
909 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
910 struct list_head qtd_list
;
912 INIT_LIST_HEAD (&qtd_list
);
914 switch (usb_pipetype (urb
->pipe
)) {
916 /* qh_completions() code doesn't handle all the fault cases
917 * in multi-TD control transfers. Even 1KB is rare anyway.
919 if (urb
->transfer_buffer_length
> (16 * 1024))
922 /* case PIPE_BULK: */
924 if (!qh_urb_transaction (ehci
, urb
, &qtd_list
, mem_flags
))
926 return submit_async(ehci
, urb
, &qtd_list
, mem_flags
);
929 if (!qh_urb_transaction (ehci
, urb
, &qtd_list
, mem_flags
))
931 return intr_submit(ehci
, urb
, &qtd_list
, mem_flags
);
933 case PIPE_ISOCHRONOUS
:
934 if (urb
->dev
->speed
== USB_SPEED_HIGH
)
935 return itd_submit (ehci
, urb
, mem_flags
);
937 return sitd_submit (ehci
, urb
, mem_flags
);
941 static void unlink_async (struct ehci_hcd
*ehci
, struct ehci_qh
*qh
)
944 if (!HC_IS_RUNNING(ehci_to_hcd(ehci
)->state
) && ehci
->reclaim
)
945 end_unlink_async(ehci
);
947 /* If the QH isn't linked then there's nothing we can do
948 * unless we were called during a giveback, in which case
949 * qh_completions() has to deal with it.
951 if (qh
->qh_state
!= QH_STATE_LINKED
) {
952 if (qh
->qh_state
== QH_STATE_COMPLETING
)
953 qh
->needs_rescan
= 1;
957 /* defer till later if busy */
959 struct ehci_qh
*last
;
961 for (last
= ehci
->reclaim
;
963 last
= last
->reclaim
)
965 qh
->qh_state
= QH_STATE_UNLINK_WAIT
;
968 /* start IAA cycle */
970 start_unlink_async (ehci
, qh
);
973 /* remove from hardware lists
974 * completions normally happen asynchronously
977 static int ehci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
979 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
984 spin_lock_irqsave (&ehci
->lock
, flags
);
985 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
989 switch (usb_pipetype (urb
->pipe
)) {
990 // case PIPE_CONTROL:
993 qh
= (struct ehci_qh
*) urb
->hcpriv
;
996 switch (qh
->qh_state
) {
997 case QH_STATE_LINKED
:
998 case QH_STATE_COMPLETING
:
999 unlink_async(ehci
, qh
);
1001 case QH_STATE_UNLINK
:
1002 case QH_STATE_UNLINK_WAIT
:
1003 /* already started */
1006 /* QH might be waiting for a Clear-TT-Buffer */
1007 qh_completions(ehci
, qh
);
1012 case PIPE_INTERRUPT
:
1013 qh
= (struct ehci_qh
*) urb
->hcpriv
;
1016 switch (qh
->qh_state
) {
1017 case QH_STATE_LINKED
:
1018 case QH_STATE_COMPLETING
:
1019 intr_deschedule (ehci
, qh
);
1022 qh_completions (ehci
, qh
);
1025 ehci_dbg (ehci
, "bogus qh %p state %d\n",
1031 case PIPE_ISOCHRONOUS
:
1034 // wait till next completion, do it then.
1035 // completion irqs can wait up to 1024 msec,
1039 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1043 /*-------------------------------------------------------------------------*/
1045 // bulk qh holds the data toggle
1048 ehci_endpoint_disable (struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
1050 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
1051 unsigned long flags
;
1052 struct ehci_qh
*qh
, *tmp
;
1054 /* ASSERT: any requests/urbs are being unlinked */
1055 /* ASSERT: nobody can be submitting urbs for this any more */
1058 spin_lock_irqsave (&ehci
->lock
, flags
);
1063 /* endpoints can be iso streams. for now, we don't
1064 * accelerate iso completions ... so spin a while.
1066 if (qh
->hw
== NULL
) {
1067 ehci_vdbg (ehci
, "iso delay\n");
1071 if (!HC_IS_RUNNING (hcd
->state
))
1072 qh
->qh_state
= QH_STATE_IDLE
;
1073 switch (qh
->qh_state
) {
1074 case QH_STATE_LINKED
:
1075 case QH_STATE_COMPLETING
:
1076 for (tmp
= ehci
->async
->qh_next
.qh
;
1078 tmp
= tmp
->qh_next
.qh
)
1080 /* periodic qh self-unlinks on empty, and a COMPLETING qh
1081 * may already be unlinked.
1084 unlink_async(ehci
, qh
);
1086 case QH_STATE_UNLINK
: /* wait for hw to finish? */
1087 case QH_STATE_UNLINK_WAIT
:
1089 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1090 schedule_timeout_uninterruptible(1);
1092 case QH_STATE_IDLE
: /* fully unlinked */
1093 if (qh
->clearing_tt
)
1095 if (list_empty (&qh
->qtd_list
)) {
1099 /* else FALL THROUGH */
1101 /* caller was supposed to have unlinked any requests;
1102 * that's not our job. just leak this memory.
1104 ehci_err (ehci
, "qh %p (#%02x) state %d%s\n",
1105 qh
, ep
->desc
.bEndpointAddress
, qh
->qh_state
,
1106 list_empty (&qh
->qtd_list
) ? "" : "(has tds)");
1111 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1115 ehci_endpoint_reset(struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
1117 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1119 int eptype
= usb_endpoint_type(&ep
->desc
);
1120 int epnum
= usb_endpoint_num(&ep
->desc
);
1121 int is_out
= usb_endpoint_dir_out(&ep
->desc
);
1122 unsigned long flags
;
1124 if (eptype
!= USB_ENDPOINT_XFER_BULK
&& eptype
!= USB_ENDPOINT_XFER_INT
)
1127 spin_lock_irqsave(&ehci
->lock
, flags
);
1130 /* For Bulk and Interrupt endpoints we maintain the toggle state
1131 * in the hardware; the toggle bits in udev aren't used at all.
1132 * When an endpoint is reset by usb_clear_halt() we must reset
1133 * the toggle bit in the QH.
1136 usb_settoggle(qh
->dev
, epnum
, is_out
, 0);
1137 if (!list_empty(&qh
->qtd_list
)) {
1138 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1139 } else if (qh
->qh_state
== QH_STATE_LINKED
||
1140 qh
->qh_state
== QH_STATE_COMPLETING
) {
1142 /* The toggle value in the QH can't be updated
1143 * while the QH is active. Unlink it now;
1144 * re-linking will call qh_refresh().
1146 if (eptype
== USB_ENDPOINT_XFER_BULK
)
1147 unlink_async(ehci
, qh
);
1149 intr_deschedule(ehci
, qh
);
1152 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1155 static int ehci_get_frame (struct usb_hcd
*hcd
)
1157 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
1158 return (ehci_readl(ehci
, &ehci
->regs
->frame_index
) >> 3) %
1159 ehci
->periodic_size
;
1162 /*-------------------------------------------------------------------------*/
1164 MODULE_DESCRIPTION(DRIVER_DESC
);
1165 MODULE_AUTHOR (DRIVER_AUTHOR
);
1166 MODULE_LICENSE ("GPL");
1169 #include "ehci-pci.c"
1170 #define PCI_DRIVER ehci_pci_driver
1173 #ifdef CONFIG_USB_EHCI_FSL
1174 #include "ehci-fsl.c"
1175 #define PLATFORM_DRIVER ehci_fsl_driver
1178 #ifdef CONFIG_USB_EHCI_MXC
1179 #include "ehci-mxc.c"
1180 #define PLATFORM_DRIVER ehci_mxc_driver
1183 #ifdef CONFIG_USB_EHCI_SH
1184 #include "ehci-sh.c"
1185 #define PLATFORM_DRIVER ehci_hcd_sh_driver
1188 #ifdef CONFIG_SOC_AU1200
1189 #include "ehci-au1xxx.c"
1190 #define PLATFORM_DRIVER ehci_hcd_au1xxx_driver
1193 #ifdef CONFIG_USB_EHCI_HCD_OMAP
1194 #include "ehci-omap.c"
1195 #define PLATFORM_DRIVER ehci_hcd_omap_driver
1198 #ifdef CONFIG_PPC_PS3
1199 #include "ehci-ps3.c"
1200 #define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
1203 #ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1204 #include "ehci-ppc-of.c"
1205 #define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1208 #ifdef CONFIG_XPS_USB_HCD_XILINX
1209 #include "ehci-xilinx-of.c"
1210 #define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
1213 #ifdef CONFIG_PLAT_ORION
1214 #include "ehci-orion.c"
1215 #define PLATFORM_DRIVER ehci_orion_driver
1218 #ifdef CONFIG_ARCH_IXP4XX
1219 #include "ehci-ixp4xx.c"
1220 #define PLATFORM_DRIVER ixp4xx_ehci_driver
1223 #ifdef CONFIG_USB_W90X900_EHCI
1224 #include "ehci-w90x900.c"
1225 #define PLATFORM_DRIVER ehci_hcd_w90x900_driver
1228 #ifdef CONFIG_ARCH_AT91
1229 #include "ehci-atmel.c"
1230 #define PLATFORM_DRIVER ehci_atmel_driver
1233 #ifdef CONFIG_USB_OCTEON_EHCI
1234 #include "ehci-octeon.c"
1235 #define PLATFORM_DRIVER ehci_octeon_driver
1238 #ifdef CONFIG_USB_CNS3XXX_EHCI
1239 #include "ehci-cns3xxx.c"
1240 #define PLATFORM_DRIVER cns3xxx_ehci_driver
1243 #ifdef CONFIG_ARCH_VT8500
1244 #include "ehci-vt8500.c"
1245 #define PLATFORM_DRIVER vt8500_ehci_driver
1248 #ifdef CONFIG_PLAT_SPEAR
1249 #include "ehci-spear.c"
1250 #define PLATFORM_DRIVER spear_ehci_hcd_driver
1253 #ifdef CONFIG_USB_EHCI_MSM
1254 #include "ehci-msm.c"
1255 #define PLATFORM_DRIVER ehci_msm_driver
1258 #ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1259 #include "ehci-pmcmsp.c"
1260 #define PLATFORM_DRIVER ehci_hcd_msp_driver
1263 #ifdef CONFIG_USB_EHCI_TEGRA
1264 #include "ehci-tegra.c"
1265 #define PLATFORM_DRIVER tegra_ehci_driver
1268 #ifdef CONFIG_USB_EHCI_S5P
1269 #include "ehci-s5p.c"
1270 #define PLATFORM_DRIVER s5p_ehci_driver
1273 #ifdef CONFIG_USB_EHCI_ATH79
1274 #include "ehci-ath79.c"
1275 #define PLATFORM_DRIVER ehci_ath79_driver
1278 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1279 !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
1280 !defined(XILINX_OF_PLATFORM_DRIVER)
1281 #error "missing bus glue for ehci-hcd"
1284 static int __init
ehci_hcd_init(void)
1291 printk(KERN_INFO
"%s: " DRIVER_DESC
"\n", hcd_name
);
1292 set_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1293 if (test_bit(USB_UHCI_LOADED
, &usb_hcds_loaded
) ||
1294 test_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
))
1295 printk(KERN_WARNING
"Warning! ehci_hcd should always be loaded"
1296 " before uhci_hcd and ohci_hcd, not after\n");
1298 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1300 sizeof(struct ehci_qh
), sizeof(struct ehci_qtd
),
1301 sizeof(struct ehci_itd
), sizeof(struct ehci_sitd
));
1304 ehci_debug_root
= debugfs_create_dir("ehci", usb_debug_root
);
1305 if (!ehci_debug_root
) {
1311 #ifdef PLATFORM_DRIVER
1312 retval
= platform_driver_register(&PLATFORM_DRIVER
);
1318 retval
= pci_register_driver(&PCI_DRIVER
);
1323 #ifdef PS3_SYSTEM_BUS_DRIVER
1324 retval
= ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER
);
1329 #ifdef OF_PLATFORM_DRIVER
1330 retval
= platform_driver_register(&OF_PLATFORM_DRIVER
);
1335 #ifdef XILINX_OF_PLATFORM_DRIVER
1336 retval
= platform_driver_register(&XILINX_OF_PLATFORM_DRIVER
);
1342 #ifdef XILINX_OF_PLATFORM_DRIVER
1343 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1346 #ifdef OF_PLATFORM_DRIVER
1347 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1350 #ifdef PS3_SYSTEM_BUS_DRIVER
1351 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1355 pci_unregister_driver(&PCI_DRIVER
);
1358 #ifdef PLATFORM_DRIVER
1359 platform_driver_unregister(&PLATFORM_DRIVER
);
1363 debugfs_remove(ehci_debug_root
);
1364 ehci_debug_root
= NULL
;
1367 clear_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1370 module_init(ehci_hcd_init
);
1372 static void __exit
ehci_hcd_cleanup(void)
1374 #ifdef XILINX_OF_PLATFORM_DRIVER
1375 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER
);
1377 #ifdef OF_PLATFORM_DRIVER
1378 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1380 #ifdef PLATFORM_DRIVER
1381 platform_driver_unregister(&PLATFORM_DRIVER
);
1384 pci_unregister_driver(&PCI_DRIVER
);
1386 #ifdef PS3_SYSTEM_BUS_DRIVER
1387 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1390 debugfs_remove(ehci_debug_root
);
1392 clear_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1394 module_exit(ehci_hcd_cleanup
);