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");
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"
339 #include "ehci-sysfs.c"
341 /*-------------------------------------------------------------------------*/
343 static void ehci_iaa_watchdog(unsigned long param
)
345 struct ehci_hcd
*ehci
= (struct ehci_hcd
*) param
;
348 spin_lock_irqsave (&ehci
->lock
, flags
);
350 /* Lost IAA irqs wedge things badly; seen first with a vt8235.
351 * So we need this watchdog, but must protect it against both
352 * (a) SMP races against real IAA firing and retriggering, and
353 * (b) clean HC shutdown, when IAA watchdog was pending.
356 && !timer_pending(&ehci
->iaa_watchdog
)
357 && HC_IS_RUNNING(ehci_to_hcd(ehci
)->state
)) {
360 /* If we get here, IAA is *REALLY* late. It's barely
361 * conceivable that the system is so busy that CMD_IAAD
362 * is still legitimately set, so let's be sure it's
363 * clear before we read STS_IAA. (The HC should clear
364 * CMD_IAAD when it sets STS_IAA.)
366 cmd
= ehci_readl(ehci
, &ehci
->regs
->command
);
368 ehci_writel(ehci
, cmd
& ~CMD_IAAD
,
369 &ehci
->regs
->command
);
371 /* If IAA is set here it either legitimately triggered
372 * before we cleared IAAD above (but _way_ late, so we'll
373 * still count it as lost) ... or a silicon erratum:
374 * - VIA seems to set IAA without triggering the IRQ;
375 * - IAAD potentially cleared without setting IAA.
377 status
= ehci_readl(ehci
, &ehci
->regs
->status
);
378 if ((status
& STS_IAA
) || !(cmd
& CMD_IAAD
)) {
379 COUNT (ehci
->stats
.lost_iaa
);
380 ehci_writel(ehci
, STS_IAA
, &ehci
->regs
->status
);
383 ehci_vdbg(ehci
, "IAA watchdog: status %x cmd %x\n",
385 end_unlink_async(ehci
);
388 spin_unlock_irqrestore(&ehci
->lock
, flags
);
391 static void ehci_watchdog(unsigned long param
)
393 struct ehci_hcd
*ehci
= (struct ehci_hcd
*) param
;
396 spin_lock_irqsave(&ehci
->lock
, flags
);
398 /* stop async processing after it's idled a bit */
399 if (test_bit (TIMER_ASYNC_OFF
, &ehci
->actions
))
400 start_unlink_async (ehci
, ehci
->async
);
402 /* ehci could run by timer, without IRQs ... */
405 spin_unlock_irqrestore (&ehci
->lock
, flags
);
408 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
409 * The firmware seems to think that powering off is a wakeup event!
410 * This routine turns off remote wakeup and everything else, on all ports.
412 static void ehci_turn_off_all_ports(struct ehci_hcd
*ehci
)
414 int port
= HCS_N_PORTS(ehci
->hcs_params
);
417 ehci_writel(ehci
, PORT_RWC_BITS
,
418 &ehci
->regs
->port_status
[port
]);
422 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
423 * Should be called with ehci->lock held.
425 static void ehci_silence_controller(struct ehci_hcd
*ehci
)
428 ehci_turn_off_all_ports(ehci
);
430 /* make BIOS/etc use companion controller during reboot */
431 ehci_writel(ehci
, 0, &ehci
->regs
->configured_flag
);
433 /* unblock posted writes */
434 ehci_readl(ehci
, &ehci
->regs
->configured_flag
);
437 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
438 * This forcibly disables dma and IRQs, helping kexec and other cases
439 * where the next system software may expect clean state.
441 static void ehci_shutdown(struct usb_hcd
*hcd
)
443 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
445 del_timer_sync(&ehci
->watchdog
);
446 del_timer_sync(&ehci
->iaa_watchdog
);
448 spin_lock_irq(&ehci
->lock
);
449 ehci_silence_controller(ehci
);
450 spin_unlock_irq(&ehci
->lock
);
453 static void ehci_port_power (struct ehci_hcd
*ehci
, int is_on
)
457 if (!HCS_PPC (ehci
->hcs_params
))
460 ehci_dbg (ehci
, "...power%s ports...\n", is_on
? "up" : "down");
461 for (port
= HCS_N_PORTS (ehci
->hcs_params
); port
> 0; )
462 (void) ehci_hub_control(ehci_to_hcd(ehci
),
463 is_on
? SetPortFeature
: ClearPortFeature
,
466 /* Flush those writes */
467 ehci_readl(ehci
, &ehci
->regs
->command
);
471 /*-------------------------------------------------------------------------*/
474 * ehci_work is called from some interrupts, timers, and so on.
475 * it calls driver completion functions, after dropping ehci->lock.
477 static void ehci_work (struct ehci_hcd
*ehci
)
479 timer_action_done (ehci
, TIMER_IO_WATCHDOG
);
481 /* another CPU may drop ehci->lock during a schedule scan while
482 * it reports urb completions. this flag guards against bogus
483 * attempts at re-entrant schedule scanning.
489 if (ehci
->next_uframe
!= -1)
490 scan_periodic (ehci
);
493 /* the IO watchdog guards against hardware or driver bugs that
494 * misplace IRQs, and should let us run completely without IRQs.
495 * such lossage has been observed on both VT6202 and VT8235.
497 if (HC_IS_RUNNING (ehci_to_hcd(ehci
)->state
) &&
498 (ehci
->async
->qh_next
.ptr
!= NULL
||
499 ehci
->periodic_sched
!= 0))
500 timer_action (ehci
, TIMER_IO_WATCHDOG
);
504 * Called when the ehci_hcd module is removed.
506 static void ehci_stop (struct usb_hcd
*hcd
)
508 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
510 ehci_dbg (ehci
, "stop\n");
512 /* no more interrupts ... */
513 del_timer_sync (&ehci
->watchdog
);
514 del_timer_sync(&ehci
->iaa_watchdog
);
516 spin_lock_irq(&ehci
->lock
);
517 if (HC_IS_RUNNING (hcd
->state
))
520 ehci_silence_controller(ehci
);
522 spin_unlock_irq(&ehci
->lock
);
524 remove_sysfs_files(ehci
);
525 remove_debug_files (ehci
);
527 /* root hub is shut down separately (first, when possible) */
528 spin_lock_irq (&ehci
->lock
);
531 spin_unlock_irq (&ehci
->lock
);
532 ehci_mem_cleanup (ehci
);
534 if (ehci
->amd_pll_fix
== 1)
538 ehci_dbg (ehci
, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
539 ehci
->stats
.normal
, ehci
->stats
.error
, ehci
->stats
.reclaim
,
540 ehci
->stats
.lost_iaa
);
541 ehci_dbg (ehci
, "complete %ld unlink %ld\n",
542 ehci
->stats
.complete
, ehci
->stats
.unlink
);
545 dbg_status (ehci
, "ehci_stop completed",
546 ehci_readl(ehci
, &ehci
->regs
->status
));
549 /* one-time init, only for memory state */
550 static int ehci_init(struct usb_hcd
*hcd
)
552 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
556 struct ehci_qh_hw
*hw
;
558 spin_lock_init(&ehci
->lock
);
561 * keep io watchdog by default, those good HCDs could turn off it later
563 ehci
->need_io_watchdog
= 1;
564 init_timer(&ehci
->watchdog
);
565 ehci
->watchdog
.function
= ehci_watchdog
;
566 ehci
->watchdog
.data
= (unsigned long) ehci
;
568 init_timer(&ehci
->iaa_watchdog
);
569 ehci
->iaa_watchdog
.function
= ehci_iaa_watchdog
;
570 ehci
->iaa_watchdog
.data
= (unsigned long) ehci
;
572 hcc_params
= ehci_readl(ehci
, &ehci
->caps
->hcc_params
);
575 * hw default: 1K periodic list heads, one per frame.
576 * periodic_size can shrink by USBCMD update if hcc_params allows.
578 ehci
->periodic_size
= DEFAULT_I_TDPS
;
579 INIT_LIST_HEAD(&ehci
->cached_itd_list
);
580 INIT_LIST_HEAD(&ehci
->cached_sitd_list
);
582 if (HCC_PGM_FRAMELISTLEN(hcc_params
)) {
583 /* periodic schedule size can be smaller than default */
584 switch (EHCI_TUNE_FLS
) {
585 case 0: ehci
->periodic_size
= 1024; break;
586 case 1: ehci
->periodic_size
= 512; break;
587 case 2: ehci
->periodic_size
= 256; break;
591 if ((retval
= ehci_mem_init(ehci
, GFP_KERNEL
)) < 0)
594 /* controllers may cache some of the periodic schedule ... */
595 if (HCC_ISOC_CACHE(hcc_params
)) // full frame cache
596 ehci
->i_thresh
= 2 + 8;
597 else // N microframes cached
598 ehci
->i_thresh
= 2 + HCC_ISOC_THRES(hcc_params
);
600 ehci
->reclaim
= NULL
;
601 ehci
->next_uframe
= -1;
602 ehci
->clock_frame
= -1;
605 * dedicate a qh for the async ring head, since we couldn't unlink
606 * a 'real' qh without stopping the async schedule [4.8]. use it
607 * as the 'reclamation list head' too.
608 * its dummy is used in hw_alt_next of many tds, to prevent the qh
609 * from automatically advancing to the next td after short reads.
611 ehci
->async
->qh_next
.qh
= NULL
;
612 hw
= ehci
->async
->hw
;
613 hw
->hw_next
= QH_NEXT(ehci
, ehci
->async
->qh_dma
);
614 hw
->hw_info1
= cpu_to_hc32(ehci
, QH_HEAD
);
615 hw
->hw_token
= cpu_to_hc32(ehci
, QTD_STS_HALT
);
616 hw
->hw_qtd_next
= EHCI_LIST_END(ehci
);
617 ehci
->async
->qh_state
= QH_STATE_LINKED
;
618 hw
->hw_alt_next
= QTD_NEXT(ehci
, ehci
->async
->dummy
->qtd_dma
);
620 /* clear interrupt enables, set irq latency */
621 if (log2_irq_thresh
< 0 || log2_irq_thresh
> 6)
623 temp
= 1 << (16 + log2_irq_thresh
);
624 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params
)) {
626 ehci_dbg(ehci
, "enable per-port change event\n");
629 if (HCC_CANPARK(hcc_params
)) {
630 /* HW default park == 3, on hardware that supports it (like
631 * NVidia and ALI silicon), maximizes throughput on the async
632 * schedule by avoiding QH fetches between transfers.
634 * With fast usb storage devices and NForce2, "park" seems to
635 * make problems: throughput reduction (!), data errors...
638 park
= min(park
, (unsigned) 3);
642 ehci_dbg(ehci
, "park %d\n", park
);
644 if (HCC_PGM_FRAMELISTLEN(hcc_params
)) {
645 /* periodic schedule size can be smaller than default */
647 temp
|= (EHCI_TUNE_FLS
<< 2);
649 if (HCC_LPM(hcc_params
)) {
650 /* support link power management EHCI 1.1 addendum */
651 ehci_dbg(ehci
, "support lpm\n");
654 ehci_dbg(ehci
, "hird %d invalid, use default 0",
660 ehci
->command
= temp
;
662 /* Accept arbitrarily long scatter-gather lists */
663 if (!(hcd
->driver
->flags
& HCD_LOCAL_MEM
))
664 hcd
->self
.sg_tablesize
= ~0;
668 /* start HC running; it's halted, ehci_init() has been run (once) */
669 static int ehci_run (struct usb_hcd
*hcd
)
671 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
676 hcd
->uses_new_polling
= 1;
678 /* EHCI spec section 4.1 */
680 * TDI driver does the ehci_reset in their reset callback.
681 * Don't reset here, because configuration settings will
684 if (!ehci_is_TDI(ehci
) && (retval
= ehci_reset(ehci
)) != 0) {
685 ehci_mem_cleanup(ehci
);
688 ehci_writel(ehci
, ehci
->periodic_dma
, &ehci
->regs
->frame_list
);
689 ehci_writel(ehci
, (u32
)ehci
->async
->qh_dma
, &ehci
->regs
->async_next
);
692 * hcc_params controls whether ehci->regs->segment must (!!!)
693 * be used; it constrains QH/ITD/SITD and QTD locations.
694 * pci_pool consistent memory always uses segment zero.
695 * streaming mappings for I/O buffers, like pci_map_single(),
696 * can return segments above 4GB, if the device allows.
698 * NOTE: the dma mask is visible through dma_supported(), so
699 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
700 * Scsi_Host.highmem_io, and so forth. It's readonly to all
701 * host side drivers though.
703 hcc_params
= ehci_readl(ehci
, &ehci
->caps
->hcc_params
);
704 if (HCC_64BIT_ADDR(hcc_params
)) {
705 ehci_writel(ehci
, 0, &ehci
->regs
->segment
);
707 // this is deeply broken on almost all architectures
708 if (!dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64)))
709 ehci_info(ehci
, "enabled 64bit DMA\n");
714 // Philips, Intel, and maybe others need CMD_RUN before the
715 // root hub will detect new devices (why?); NEC doesn't
716 ehci
->command
&= ~(CMD_LRESET
|CMD_IAAD
|CMD_PSE
|CMD_ASE
|CMD_RESET
);
717 ehci
->command
|= CMD_RUN
;
718 ehci_writel(ehci
, ehci
->command
, &ehci
->regs
->command
);
719 dbg_cmd (ehci
, "init", ehci
->command
);
722 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
723 * are explicitly handed to companion controller(s), so no TT is
724 * involved with the root hub. (Except where one is integrated,
725 * and there's no companion controller unless maybe for USB OTG.)
727 * Turning on the CF flag will transfer ownership of all ports
728 * from the companions to the EHCI controller. If any of the
729 * companions are in the middle of a port reset at the time, it
730 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
731 * guarantees that no resets are in progress. After we set CF,
732 * a short delay lets the hardware catch up; new resets shouldn't
733 * be started before the port switching actions could complete.
735 down_write(&ehci_cf_port_reset_rwsem
);
736 hcd
->state
= HC_STATE_RUNNING
;
737 ehci_writel(ehci
, FLAG_CF
, &ehci
->regs
->configured_flag
);
738 ehci_readl(ehci
, &ehci
->regs
->command
); /* unblock posted writes */
740 up_write(&ehci_cf_port_reset_rwsem
);
741 ehci
->last_periodic_enable
= ktime_get_real();
743 temp
= HC_VERSION(ehci
, ehci_readl(ehci
, &ehci
->caps
->hc_capbase
));
745 "USB %x.%x started, EHCI %x.%02x%s\n",
746 ((ehci
->sbrn
& 0xf0)>>4), (ehci
->sbrn
& 0x0f),
747 temp
>> 8, temp
& 0xff,
748 ignore_oc
? ", overcurrent ignored" : "");
750 ehci_writel(ehci
, INTR_MASK
,
751 &ehci
->regs
->intr_enable
); /* Turn On Interrupts */
753 /* GRR this is run-once init(), being done every time the HC starts.
754 * So long as they're part of class devices, we can't do it init()
755 * since the class device isn't created that early.
757 create_debug_files(ehci
);
758 create_sysfs_files(ehci
);
763 /*-------------------------------------------------------------------------*/
765 static irqreturn_t
ehci_irq (struct usb_hcd
*hcd
)
767 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
768 u32 status
, masked_status
, pcd_status
= 0, cmd
;
771 spin_lock (&ehci
->lock
);
773 status
= ehci_readl(ehci
, &ehci
->regs
->status
);
775 /* e.g. cardbus physical eject */
776 if (status
== ~(u32
) 0) {
777 ehci_dbg (ehci
, "device removed\n");
782 masked_status
= status
& INTR_MASK
;
783 if (!masked_status
|| unlikely(hcd
->state
== HC_STATE_HALT
)) {
784 spin_unlock(&ehci
->lock
);
788 /* clear (just) interrupts */
789 ehci_writel(ehci
, masked_status
, &ehci
->regs
->status
);
790 cmd
= ehci_readl(ehci
, &ehci
->regs
->command
);
794 /* unrequested/ignored: Frame List Rollover */
795 dbg_status (ehci
, "irq", status
);
798 /* INT, ERR, and IAA interrupt rates can be throttled */
800 /* normal [4.15.1.2] or error [4.15.1.1] completion */
801 if (likely ((status
& (STS_INT
|STS_ERR
)) != 0)) {
802 if (likely ((status
& STS_ERR
) == 0))
803 COUNT (ehci
->stats
.normal
);
805 COUNT (ehci
->stats
.error
);
809 /* complete the unlinking of some qh [4.15.2.3] */
810 if (status
& STS_IAA
) {
811 /* guard against (alleged) silicon errata */
812 if (cmd
& CMD_IAAD
) {
813 ehci_writel(ehci
, cmd
& ~CMD_IAAD
,
814 &ehci
->regs
->command
);
815 ehci_dbg(ehci
, "IAA with IAAD still set?\n");
818 COUNT(ehci
->stats
.reclaim
);
819 end_unlink_async(ehci
);
821 ehci_dbg(ehci
, "IAA with nothing to reclaim?\n");
824 /* remote wakeup [4.3.1] */
825 if (status
& STS_PCD
) {
826 unsigned i
= HCS_N_PORTS (ehci
->hcs_params
);
829 /* kick root hub later */
832 /* resume root hub? */
833 if (!(cmd
& CMD_RUN
))
834 usb_hcd_resume_root_hub(hcd
);
836 /* get per-port change detect bits */
843 /* leverage per-port change bits feature */
844 if (ehci
->has_ppcd
&& !(ppcd
& (1 << i
)))
846 pstatus
= ehci_readl(ehci
,
847 &ehci
->regs
->port_status
[i
]);
849 if (pstatus
& PORT_OWNER
)
851 if (!(test_bit(i
, &ehci
->suspended_ports
) &&
852 ((pstatus
& PORT_RESUME
) ||
853 !(pstatus
& PORT_SUSPEND
)) &&
854 (pstatus
& PORT_PE
) &&
855 ehci
->reset_done
[i
] == 0))
858 /* start 20 msec resume signaling from this port,
859 * and make khubd collect PORT_STAT_C_SUSPEND to
860 * stop that signaling. Use 5 ms extra for safety,
861 * like usb_port_resume() does.
863 ehci
->reset_done
[i
] = jiffies
+ msecs_to_jiffies(25);
864 ehci_dbg (ehci
, "port %d remote wakeup\n", i
+ 1);
865 mod_timer(&hcd
->rh_timer
, ehci
->reset_done
[i
]);
869 /* PCI errors [4.15.2.4] */
870 if (unlikely ((status
& STS_FATAL
) != 0)) {
871 ehci_err(ehci
, "fatal error\n");
872 dbg_cmd(ehci
, "fatal", cmd
);
873 dbg_status(ehci
, "fatal", status
);
877 ehci_writel(ehci
, 0, &ehci
->regs
->configured_flag
);
879 /* generic layer kills/unlinks all urbs, then
880 * uses ehci_stop to clean up the rest
887 spin_unlock (&ehci
->lock
);
889 usb_hcd_poll_rh_status(hcd
);
893 /*-------------------------------------------------------------------------*/
896 * non-error returns are a promise to giveback() the urb later
897 * we drop ownership so next owner (or urb unlink) can get it
899 * urb + dev is in hcd.self.controller.urb_list
900 * we're queueing TDs onto software and hardware lists
902 * hcd-specific init for hcpriv hasn't been done yet
904 * NOTE: control, bulk, and interrupt share the same code to append TDs
905 * to a (possibly active) QH, and the same QH scanning code.
907 static int ehci_urb_enqueue (
912 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
913 struct list_head qtd_list
;
915 INIT_LIST_HEAD (&qtd_list
);
917 switch (usb_pipetype (urb
->pipe
)) {
919 /* qh_completions() code doesn't handle all the fault cases
920 * in multi-TD control transfers. Even 1KB is rare anyway.
922 if (urb
->transfer_buffer_length
> (16 * 1024))
925 /* case PIPE_BULK: */
927 if (!qh_urb_transaction (ehci
, urb
, &qtd_list
, mem_flags
))
929 return submit_async(ehci
, urb
, &qtd_list
, mem_flags
);
932 if (!qh_urb_transaction (ehci
, urb
, &qtd_list
, mem_flags
))
934 return intr_submit(ehci
, urb
, &qtd_list
, mem_flags
);
936 case PIPE_ISOCHRONOUS
:
937 if (urb
->dev
->speed
== USB_SPEED_HIGH
)
938 return itd_submit (ehci
, urb
, mem_flags
);
940 return sitd_submit (ehci
, urb
, mem_flags
);
944 static void unlink_async (struct ehci_hcd
*ehci
, struct ehci_qh
*qh
)
947 if (!HC_IS_RUNNING(ehci_to_hcd(ehci
)->state
) && ehci
->reclaim
)
948 end_unlink_async(ehci
);
950 /* If the QH isn't linked then there's nothing we can do
951 * unless we were called during a giveback, in which case
952 * qh_completions() has to deal with it.
954 if (qh
->qh_state
!= QH_STATE_LINKED
) {
955 if (qh
->qh_state
== QH_STATE_COMPLETING
)
956 qh
->needs_rescan
= 1;
960 /* defer till later if busy */
962 struct ehci_qh
*last
;
964 for (last
= ehci
->reclaim
;
966 last
= last
->reclaim
)
968 qh
->qh_state
= QH_STATE_UNLINK_WAIT
;
971 /* start IAA cycle */
973 start_unlink_async (ehci
, qh
);
976 /* remove from hardware lists
977 * completions normally happen asynchronously
980 static int ehci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
982 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
987 spin_lock_irqsave (&ehci
->lock
, flags
);
988 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
992 switch (usb_pipetype (urb
->pipe
)) {
993 // case PIPE_CONTROL:
996 qh
= (struct ehci_qh
*) urb
->hcpriv
;
999 switch (qh
->qh_state
) {
1000 case QH_STATE_LINKED
:
1001 case QH_STATE_COMPLETING
:
1002 unlink_async(ehci
, qh
);
1004 case QH_STATE_UNLINK
:
1005 case QH_STATE_UNLINK_WAIT
:
1006 /* already started */
1009 /* QH might be waiting for a Clear-TT-Buffer */
1010 qh_completions(ehci
, qh
);
1015 case PIPE_INTERRUPT
:
1016 qh
= (struct ehci_qh
*) urb
->hcpriv
;
1019 switch (qh
->qh_state
) {
1020 case QH_STATE_LINKED
:
1021 case QH_STATE_COMPLETING
:
1022 intr_deschedule (ehci
, qh
);
1025 qh_completions (ehci
, qh
);
1028 ehci_dbg (ehci
, "bogus qh %p state %d\n",
1034 case PIPE_ISOCHRONOUS
:
1037 // wait till next completion, do it then.
1038 // completion irqs can wait up to 1024 msec,
1042 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1046 /*-------------------------------------------------------------------------*/
1048 // bulk qh holds the data toggle
1051 ehci_endpoint_disable (struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
1053 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
1054 unsigned long flags
;
1055 struct ehci_qh
*qh
, *tmp
;
1057 /* ASSERT: any requests/urbs are being unlinked */
1058 /* ASSERT: nobody can be submitting urbs for this any more */
1061 spin_lock_irqsave (&ehci
->lock
, flags
);
1066 /* endpoints can be iso streams. for now, we don't
1067 * accelerate iso completions ... so spin a while.
1069 if (qh
->hw
== NULL
) {
1070 ehci_vdbg (ehci
, "iso delay\n");
1074 if (!HC_IS_RUNNING (hcd
->state
))
1075 qh
->qh_state
= QH_STATE_IDLE
;
1076 switch (qh
->qh_state
) {
1077 case QH_STATE_LINKED
:
1078 case QH_STATE_COMPLETING
:
1079 for (tmp
= ehci
->async
->qh_next
.qh
;
1081 tmp
= tmp
->qh_next
.qh
)
1083 /* periodic qh self-unlinks on empty, and a COMPLETING qh
1084 * may already be unlinked.
1087 unlink_async(ehci
, qh
);
1089 case QH_STATE_UNLINK
: /* wait for hw to finish? */
1090 case QH_STATE_UNLINK_WAIT
:
1092 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1093 schedule_timeout_uninterruptible(1);
1095 case QH_STATE_IDLE
: /* fully unlinked */
1096 if (qh
->clearing_tt
)
1098 if (list_empty (&qh
->qtd_list
)) {
1102 /* else FALL THROUGH */
1104 /* caller was supposed to have unlinked any requests;
1105 * that's not our job. just leak this memory.
1107 ehci_err (ehci
, "qh %p (#%02x) state %d%s\n",
1108 qh
, ep
->desc
.bEndpointAddress
, qh
->qh_state
,
1109 list_empty (&qh
->qtd_list
) ? "" : "(has tds)");
1114 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1118 ehci_endpoint_reset(struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
1120 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1122 int eptype
= usb_endpoint_type(&ep
->desc
);
1123 int epnum
= usb_endpoint_num(&ep
->desc
);
1124 int is_out
= usb_endpoint_dir_out(&ep
->desc
);
1125 unsigned long flags
;
1127 if (eptype
!= USB_ENDPOINT_XFER_BULK
&& eptype
!= USB_ENDPOINT_XFER_INT
)
1130 spin_lock_irqsave(&ehci
->lock
, flags
);
1133 /* For Bulk and Interrupt endpoints we maintain the toggle state
1134 * in the hardware; the toggle bits in udev aren't used at all.
1135 * When an endpoint is reset by usb_clear_halt() we must reset
1136 * the toggle bit in the QH.
1139 usb_settoggle(qh
->dev
, epnum
, is_out
, 0);
1140 if (!list_empty(&qh
->qtd_list
)) {
1141 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1142 } else if (qh
->qh_state
== QH_STATE_LINKED
||
1143 qh
->qh_state
== QH_STATE_COMPLETING
) {
1145 /* The toggle value in the QH can't be updated
1146 * while the QH is active. Unlink it now;
1147 * re-linking will call qh_refresh().
1149 if (eptype
== USB_ENDPOINT_XFER_BULK
)
1150 unlink_async(ehci
, qh
);
1152 intr_deschedule(ehci
, qh
);
1155 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1158 static int ehci_get_frame (struct usb_hcd
*hcd
)
1160 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
1161 return (ehci_readl(ehci
, &ehci
->regs
->frame_index
) >> 3) %
1162 ehci
->periodic_size
;
1165 /*-------------------------------------------------------------------------*/
1167 MODULE_DESCRIPTION(DRIVER_DESC
);
1168 MODULE_AUTHOR (DRIVER_AUTHOR
);
1169 MODULE_LICENSE ("GPL");
1172 #include "ehci-pci.c"
1173 #define PCI_DRIVER ehci_pci_driver
1176 #ifdef CONFIG_USB_EHCI_FSL
1177 #include "ehci-fsl.c"
1178 #define PLATFORM_DRIVER ehci_fsl_driver
1181 #ifdef CONFIG_USB_EHCI_MXC
1182 #include "ehci-mxc.c"
1183 #define PLATFORM_DRIVER ehci_mxc_driver
1186 #ifdef CONFIG_USB_EHCI_SH
1187 #include "ehci-sh.c"
1188 #define PLATFORM_DRIVER ehci_hcd_sh_driver
1191 #ifdef CONFIG_SOC_AU1200
1192 #include "ehci-au1xxx.c"
1193 #define PLATFORM_DRIVER ehci_hcd_au1xxx_driver
1196 #ifdef CONFIG_USB_EHCI_HCD_OMAP
1197 #include "ehci-omap.c"
1198 #define PLATFORM_DRIVER ehci_hcd_omap_driver
1201 #ifdef CONFIG_PPC_PS3
1202 #include "ehci-ps3.c"
1203 #define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
1206 #ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1207 #include "ehci-ppc-of.c"
1208 #define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1211 #ifdef CONFIG_XPS_USB_HCD_XILINX
1212 #include "ehci-xilinx-of.c"
1213 #define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
1216 #ifdef CONFIG_PLAT_ORION
1217 #include "ehci-orion.c"
1218 #define PLATFORM_DRIVER ehci_orion_driver
1221 #ifdef CONFIG_ARCH_IXP4XX
1222 #include "ehci-ixp4xx.c"
1223 #define PLATFORM_DRIVER ixp4xx_ehci_driver
1226 #ifdef CONFIG_USB_W90X900_EHCI
1227 #include "ehci-w90x900.c"
1228 #define PLATFORM_DRIVER ehci_hcd_w90x900_driver
1231 #ifdef CONFIG_ARCH_AT91
1232 #include "ehci-atmel.c"
1233 #define PLATFORM_DRIVER ehci_atmel_driver
1236 #ifdef CONFIG_USB_OCTEON_EHCI
1237 #include "ehci-octeon.c"
1238 #define PLATFORM_DRIVER ehci_octeon_driver
1241 #ifdef CONFIG_USB_CNS3XXX_EHCI
1242 #include "ehci-cns3xxx.c"
1243 #define PLATFORM_DRIVER cns3xxx_ehci_driver
1246 #ifdef CONFIG_ARCH_VT8500
1247 #include "ehci-vt8500.c"
1248 #define PLATFORM_DRIVER vt8500_ehci_driver
1251 #ifdef CONFIG_PLAT_SPEAR
1252 #include "ehci-spear.c"
1253 #define PLATFORM_DRIVER spear_ehci_hcd_driver
1256 #ifdef CONFIG_USB_EHCI_MSM
1257 #include "ehci-msm.c"
1258 #define PLATFORM_DRIVER ehci_msm_driver
1261 #ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1262 #include "ehci-pmcmsp.c"
1263 #define PLATFORM_DRIVER ehci_hcd_msp_driver
1266 #ifdef CONFIG_USB_EHCI_TEGRA
1267 #include "ehci-tegra.c"
1268 #define PLATFORM_DRIVER tegra_ehci_driver
1271 #ifdef CONFIG_USB_EHCI_S5P
1272 #include "ehci-s5p.c"
1273 #define PLATFORM_DRIVER s5p_ehci_driver
1276 #ifdef CONFIG_USB_EHCI_ATH79
1277 #include "ehci-ath79.c"
1278 #define PLATFORM_DRIVER ehci_ath79_driver
1281 #ifdef CONFIG_SPARC_LEON
1282 #include "ehci-grlib.c"
1283 #define PLATFORM_DRIVER ehci_grlib_driver
1286 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1287 !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
1288 !defined(XILINX_OF_PLATFORM_DRIVER)
1289 #error "missing bus glue for ehci-hcd"
1292 static int __init
ehci_hcd_init(void)
1299 printk(KERN_INFO
"%s: " DRIVER_DESC
"\n", hcd_name
);
1300 set_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1301 if (test_bit(USB_UHCI_LOADED
, &usb_hcds_loaded
) ||
1302 test_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
))
1303 printk(KERN_WARNING
"Warning! ehci_hcd should always be loaded"
1304 " before uhci_hcd and ohci_hcd, not after\n");
1306 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1308 sizeof(struct ehci_qh
), sizeof(struct ehci_qtd
),
1309 sizeof(struct ehci_itd
), sizeof(struct ehci_sitd
));
1312 ehci_debug_root
= debugfs_create_dir("ehci", usb_debug_root
);
1313 if (!ehci_debug_root
) {
1319 #ifdef PLATFORM_DRIVER
1320 retval
= platform_driver_register(&PLATFORM_DRIVER
);
1326 retval
= pci_register_driver(&PCI_DRIVER
);
1331 #ifdef PS3_SYSTEM_BUS_DRIVER
1332 retval
= ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER
);
1337 #ifdef OF_PLATFORM_DRIVER
1338 retval
= platform_driver_register(&OF_PLATFORM_DRIVER
);
1343 #ifdef XILINX_OF_PLATFORM_DRIVER
1344 retval
= platform_driver_register(&XILINX_OF_PLATFORM_DRIVER
);
1350 #ifdef XILINX_OF_PLATFORM_DRIVER
1351 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1354 #ifdef OF_PLATFORM_DRIVER
1355 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1358 #ifdef PS3_SYSTEM_BUS_DRIVER
1359 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1363 pci_unregister_driver(&PCI_DRIVER
);
1366 #ifdef PLATFORM_DRIVER
1367 platform_driver_unregister(&PLATFORM_DRIVER
);
1371 debugfs_remove(ehci_debug_root
);
1372 ehci_debug_root
= NULL
;
1375 clear_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1378 module_init(ehci_hcd_init
);
1380 static void __exit
ehci_hcd_cleanup(void)
1382 #ifdef XILINX_OF_PLATFORM_DRIVER
1383 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER
);
1385 #ifdef OF_PLATFORM_DRIVER
1386 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1388 #ifdef PLATFORM_DRIVER
1389 platform_driver_unregister(&PLATFORM_DRIVER
);
1392 pci_unregister_driver(&PCI_DRIVER
);
1394 #ifdef PS3_SYSTEM_BUS_DRIVER
1395 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1398 debugfs_remove(ehci_debug_root
);
1400 clear_bit(USB_EHCI_LOADED
, &usb_hcds_loaded
);
1402 module_exit(ehci_hcd_cleanup
);