2 * Open Host Controller Interface (OHCI) driver for USB.
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
6 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
7 * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
9 * [ Initialisation is based on Linus' ]
10 * [ uhci code and gregs ohci fragments ]
11 * [ (C) Copyright 1999 Linus Torvalds ]
12 * [ (C) Copyright 1999 Gregory P. Smith]
15 * OHCI is the main "non-Intel/VIA" standard for USB 1.1 host controller
16 * interfaces (though some non-x86 Intel chips use it). It supports
17 * smarter hardware than UHCI. A download link for the spec available
18 * through the http://www.usb.org website.
20 * This file is licenced under the GPL.
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/pci.h>
26 #include <linux/kernel.h>
27 #include <linux/delay.h>
28 #include <linux/ioport.h>
29 #include <linux/sched.h>
30 #include <linux/slab.h>
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/timer.h>
34 #include <linux/list.h>
35 #include <linux/usb.h>
36 #include <linux/usb/otg.h>
37 #include <linux/usb/hcd.h>
38 #include <linux/dma-mapping.h>
39 #include <linux/dmapool.h>
40 #include <linux/workqueue.h>
41 #include <linux/debugfs.h>
45 #include <asm/system.h>
46 #include <asm/unaligned.h>
47 #include <asm/byteorder.h>
50 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
51 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
53 /*-------------------------------------------------------------------------*/
55 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
57 /* For initializing controller (mask in an HCFS mode too) */
58 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
59 #define OHCI_INTR_INIT \
60 (OHCI_INTR_MIE | OHCI_INTR_RHSC | OHCI_INTR_UE \
61 | OHCI_INTR_RD | OHCI_INTR_WDH)
64 /* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
68 #ifdef CONFIG_ARCH_OMAP
69 /* OMAP doesn't support IR (no SMM; not needed) */
73 /*-------------------------------------------------------------------------*/
75 static const char hcd_name
[] = "ohci_hcd";
77 #define STATECHANGE_DELAY msecs_to_jiffies(300)
80 #include "pci-quirks.h"
82 static void ohci_dump (struct ohci_hcd
*ohci
, int verbose
);
83 static int ohci_init (struct ohci_hcd
*ohci
);
84 static void ohci_stop (struct usb_hcd
*hcd
);
86 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
87 static int ohci_restart (struct ohci_hcd
*ohci
);
91 static void sb800_prefetch(struct ohci_hcd
*ohci
, int on
);
93 static inline void sb800_prefetch(struct ohci_hcd
*ohci
, int on
)
100 #include "ohci-hub.c"
101 #include "ohci-dbg.c"
102 #include "ohci-mem.c"
107 * On architectures with edge-triggered interrupts we must never return
110 #if defined(CONFIG_SA1111) /* ... or other edge-triggered systems */
111 #define IRQ_NOTMINE IRQ_HANDLED
113 #define IRQ_NOTMINE IRQ_NONE
117 /* Some boards misreport power switching/overcurrent */
118 static int distrust_firmware
= 1;
119 module_param (distrust_firmware
, bool, 0);
120 MODULE_PARM_DESC (distrust_firmware
,
121 "true to distrust firmware power/overcurrent setup");
123 /* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */
124 static int no_handshake
= 0;
125 module_param (no_handshake
, bool, 0);
126 MODULE_PARM_DESC (no_handshake
, "true (not default) disables BIOS handshake");
128 /*-------------------------------------------------------------------------*/
131 * queue up an urb for anything except the root hub
133 static int ohci_urb_enqueue (
138 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
140 urb_priv_t
*urb_priv
;
141 unsigned int pipe
= urb
->pipe
;
146 #ifdef OHCI_VERBOSE_DEBUG
147 urb_print(urb
, "SUB", usb_pipein(pipe
), -EINPROGRESS
);
150 /* every endpoint has a ed, locate and maybe (re)initialize it */
151 if (! (ed
= ed_get (ohci
, urb
->ep
, urb
->dev
, pipe
, urb
->interval
)))
154 /* for the private part of the URB we need the number of TDs (size) */
157 /* td_submit_urb() doesn't yet handle these */
158 if (urb
->transfer_buffer_length
> 4096)
161 /* 1 TD for setup, 1 for ACK, plus ... */
164 // case PIPE_INTERRUPT:
167 /* one TD for every 4096 Bytes (can be up to 8K) */
168 size
+= urb
->transfer_buffer_length
/ 4096;
169 /* ... and for any remaining bytes ... */
170 if ((urb
->transfer_buffer_length
% 4096) != 0)
172 /* ... and maybe a zero length packet to wrap it up */
175 else if ((urb
->transfer_flags
& URB_ZERO_PACKET
) != 0
176 && (urb
->transfer_buffer_length
177 % usb_maxpacket (urb
->dev
, pipe
,
178 usb_pipeout (pipe
))) == 0)
181 case PIPE_ISOCHRONOUS
: /* number of packets from URB */
182 size
= urb
->number_of_packets
;
186 /* allocate the private part of the URB */
187 urb_priv
= kzalloc (sizeof (urb_priv_t
) + size
* sizeof (struct td
*),
191 INIT_LIST_HEAD (&urb_priv
->pending
);
192 urb_priv
->length
= size
;
195 /* allocate the TDs (deferring hash chain updates) */
196 for (i
= 0; i
< size
; i
++) {
197 urb_priv
->td
[i
] = td_alloc (ohci
, mem_flags
);
198 if (!urb_priv
->td
[i
]) {
199 urb_priv
->length
= i
;
200 urb_free_priv (ohci
, urb_priv
);
205 spin_lock_irqsave (&ohci
->lock
, flags
);
207 /* don't submit to a dead HC */
208 if (!HCD_HW_ACCESSIBLE(hcd
)) {
212 if (!HC_IS_RUNNING(hcd
->state
)) {
216 retval
= usb_hcd_link_urb_to_ep(hcd
, urb
);
220 /* schedule the ed if needed */
221 if (ed
->state
== ED_IDLE
) {
222 retval
= ed_schedule (ohci
, ed
);
224 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
227 if (ed
->type
== PIPE_ISOCHRONOUS
) {
228 u16 frame
= ohci_frame_no(ohci
);
230 /* delay a few frames before the first TD */
231 frame
+= max_t (u16
, 8, ed
->interval
);
232 frame
&= ~(ed
->interval
- 1);
234 urb
->start_frame
= frame
;
236 /* yes, only URB_ISO_ASAP is supported, and
237 * urb->start_frame is never used as input.
240 } else if (ed
->type
== PIPE_ISOCHRONOUS
)
241 urb
->start_frame
= ed
->last_iso
+ ed
->interval
;
243 /* fill the TDs and link them to the ed; and
244 * enable that part of the schedule, if needed
245 * and update count of queued periodic urbs
247 urb
->hcpriv
= urb_priv
;
248 td_submit_urb (ohci
, urb
);
252 urb_free_priv (ohci
, urb_priv
);
253 spin_unlock_irqrestore (&ohci
->lock
, flags
);
258 * decouple the URB from the HC queues (TDs, urb_priv).
259 * reporting is always done
260 * asynchronously, and we might be dealing with an urb that's
261 * partially transferred, or an ED with other urbs being unlinked.
263 static int ohci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
265 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
269 #ifdef OHCI_VERBOSE_DEBUG
270 urb_print(urb
, "UNLINK", 1, status
);
273 spin_lock_irqsave (&ohci
->lock
, flags
);
274 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
277 } else if (HC_IS_RUNNING(hcd
->state
)) {
278 urb_priv_t
*urb_priv
;
280 /* Unless an IRQ completed the unlink while it was being
281 * handed to us, flag it for unlink and giveback, and force
282 * some upcoming INTR_SF to call finish_unlinks()
284 urb_priv
= urb
->hcpriv
;
286 if (urb_priv
->ed
->state
== ED_OPER
)
287 start_ed_unlink (ohci
, urb_priv
->ed
);
291 * with HC dead, we won't respect hc queue pointers
292 * any more ... just clean up every urb's memory.
295 finish_urb(ohci
, urb
, status
);
297 spin_unlock_irqrestore (&ohci
->lock
, flags
);
301 /*-------------------------------------------------------------------------*/
303 /* frees config/altsetting state for endpoints,
304 * including ED memory, dummy TD, and bulk/intr data toggle
308 ohci_endpoint_disable (struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
310 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
312 struct ed
*ed
= ep
->hcpriv
;
313 unsigned limit
= 1000;
315 /* ASSERT: any requests/urbs are being unlinked */
316 /* ASSERT: nobody can be submitting urbs for this any more */
322 spin_lock_irqsave (&ohci
->lock
, flags
);
324 if (!HC_IS_RUNNING (hcd
->state
)) {
327 if (quirk_zfmicro(ohci
) && ed
->type
== PIPE_INTERRUPT
)
328 ohci
->eds_scheduled
--;
329 finish_unlinks (ohci
, 0);
333 case ED_UNLINK
: /* wait for hw to finish? */
334 /* major IRQ delivery trouble loses INTR_SF too... */
336 ohci_warn(ohci
, "ED unlink timeout\n");
337 if (quirk_zfmicro(ohci
)) {
338 ohci_warn(ohci
, "Attempting ZF TD recovery\n");
339 ohci
->ed_to_check
= ed
;
344 spin_unlock_irqrestore (&ohci
->lock
, flags
);
345 schedule_timeout_uninterruptible(1);
347 case ED_IDLE
: /* fully unlinked */
348 if (list_empty (&ed
->td_list
)) {
349 td_free (ohci
, ed
->dummy
);
353 /* else FALL THROUGH */
355 /* caller was supposed to have unlinked any requests;
356 * that's not our job. can't recover; must leak ed.
358 ohci_err (ohci
, "leak ed %p (#%02x) state %d%s\n",
359 ed
, ep
->desc
.bEndpointAddress
, ed
->state
,
360 list_empty (&ed
->td_list
) ? "" : " (has tds)");
361 td_free (ohci
, ed
->dummy
);
365 spin_unlock_irqrestore (&ohci
->lock
, flags
);
368 static int ohci_get_frame (struct usb_hcd
*hcd
)
370 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
372 return ohci_frame_no(ohci
);
375 static void ohci_usb_reset (struct ohci_hcd
*ohci
)
377 ohci
->hc_control
= ohci_readl (ohci
, &ohci
->regs
->control
);
378 ohci
->hc_control
&= OHCI_CTRL_RWC
;
379 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
382 /* ohci_shutdown forcibly disables IRQs and DMA, helping kexec and
383 * other cases where the next software may expect clean state from the
384 * "firmware". this is bus-neutral, unlike shutdown() methods.
387 ohci_shutdown (struct usb_hcd
*hcd
)
389 struct ohci_hcd
*ohci
;
391 ohci
= hcd_to_ohci (hcd
);
392 ohci_writel(ohci
, (u32
) ~0, &ohci
->regs
->intrdisable
);
394 /* Software reset, after which the controller goes into SUSPEND */
395 ohci_writel(ohci
, OHCI_HCR
, &ohci
->regs
->cmdstatus
);
396 ohci_readl(ohci
, &ohci
->regs
->cmdstatus
); /* flush the writes */
399 ohci_writel(ohci
, ohci
->fminterval
, &ohci
->regs
->fminterval
);
402 static int check_ed(struct ohci_hcd
*ohci
, struct ed
*ed
)
404 return (hc32_to_cpu(ohci
, ed
->hwINFO
) & ED_IN
) != 0
405 && (hc32_to_cpu(ohci
, ed
->hwHeadP
) & TD_MASK
)
406 == (hc32_to_cpu(ohci
, ed
->hwTailP
) & TD_MASK
)
407 && !list_empty(&ed
->td_list
);
410 /* ZF Micro watchdog timer callback. The ZF Micro chipset sometimes completes
411 * an interrupt TD but neglects to add it to the donelist. On systems with
412 * this chipset, we need to periodically check the state of the queues to look
413 * for such "lost" TDs.
415 static void unlink_watchdog_func(unsigned long _ohci
)
419 unsigned seen_count
= 0;
421 struct ed
**seen
= NULL
;
422 struct ohci_hcd
*ohci
= (struct ohci_hcd
*) _ohci
;
424 spin_lock_irqsave(&ohci
->lock
, flags
);
425 max
= ohci
->eds_scheduled
;
429 if (ohci
->ed_to_check
)
432 seen
= kcalloc(max
, sizeof *seen
, GFP_ATOMIC
);
436 for (i
= 0; i
< NUM_INTS
; i
++) {
437 struct ed
*ed
= ohci
->periodic
[i
];
442 /* scan this branch of the periodic schedule tree */
443 for (temp
= 0; temp
< seen_count
; temp
++) {
444 if (seen
[temp
] == ed
) {
445 /* we've checked it and what's after */
452 seen
[seen_count
++] = ed
;
453 if (!check_ed(ohci
, ed
)) {
458 /* HC's TD list is empty, but HCD sees at least one
459 * TD that's not been sent through the donelist.
461 ohci
->ed_to_check
= ed
;
464 /* The HC may wait until the next frame to report the
465 * TD as done through the donelist and INTR_WDH. (We
466 * just *assume* it's not a multi-TD interrupt URB;
467 * those could defer the IRQ more than one frame, using
468 * DI...) Check again after the next INTR_SF.
470 ohci_writel(ohci
, OHCI_INTR_SF
,
471 &ohci
->regs
->intrstatus
);
472 ohci_writel(ohci
, OHCI_INTR_SF
,
473 &ohci
->regs
->intrenable
);
475 /* flush those writes */
476 (void) ohci_readl(ohci
, &ohci
->regs
->control
);
483 if (ohci
->eds_scheduled
)
484 mod_timer(&ohci
->unlink_watchdog
, round_jiffies(jiffies
+ HZ
));
486 spin_unlock_irqrestore(&ohci
->lock
, flags
);
489 /*-------------------------------------------------------------------------*
491 *-------------------------------------------------------------------------*/
493 /* init memory, and kick BIOS/SMM off */
495 static int ohci_init (struct ohci_hcd
*ohci
)
498 struct usb_hcd
*hcd
= ohci_to_hcd(ohci
);
500 if (distrust_firmware
)
501 ohci
->flags
|= OHCI_QUIRK_HUB_POWER
;
504 ohci
->regs
= hcd
->regs
;
506 /* REVISIT this BIOS handshake is now moved into PCI "quirks", and
507 * was never needed for most non-PCI systems ... remove the code?
511 /* SMM owns the HC? not for long! */
512 if (!no_handshake
&& ohci_readl (ohci
,
513 &ohci
->regs
->control
) & OHCI_CTRL_IR
) {
516 ohci_dbg (ohci
, "USB HC TakeOver from BIOS/SMM\n");
518 /* this timeout is arbitrary. we make it long, so systems
519 * depending on usb keyboards may be usable even if the
520 * BIOS/SMM code seems pretty broken.
522 temp
= 500; /* arbitrary: five seconds */
524 ohci_writel (ohci
, OHCI_INTR_OC
, &ohci
->regs
->intrenable
);
525 ohci_writel (ohci
, OHCI_OCR
, &ohci
->regs
->cmdstatus
);
526 while (ohci_readl (ohci
, &ohci
->regs
->control
) & OHCI_CTRL_IR
) {
529 ohci_err (ohci
, "USB HC takeover failed!"
530 " (BIOS/SMM bug)\n");
534 ohci_usb_reset (ohci
);
538 /* Disable HC interrupts */
539 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
541 /* flush the writes, and save key bits like RWC */
542 if (ohci_readl (ohci
, &ohci
->regs
->control
) & OHCI_CTRL_RWC
)
543 ohci
->hc_control
|= OHCI_CTRL_RWC
;
545 /* Read the number of ports unless overridden */
546 if (ohci
->num_ports
== 0)
547 ohci
->num_ports
= roothub_a(ohci
) & RH_A_NDP
;
552 ohci
->hcca
= dma_alloc_coherent (hcd
->self
.controller
,
553 sizeof *ohci
->hcca
, &ohci
->hcca_dma
, 0);
557 if ((ret
= ohci_mem_init (ohci
)) < 0)
560 create_debug_files (ohci
);
566 /*-------------------------------------------------------------------------*/
568 /* Start an OHCI controller, set the BUS operational
569 * resets USB and controller
572 static int ohci_run (struct ohci_hcd
*ohci
)
575 int first
= ohci
->fminterval
== 0;
576 struct usb_hcd
*hcd
= ohci_to_hcd(ohci
);
580 /* boot firmware should have set this up (5.1.1.3.1) */
583 val
= ohci_readl (ohci
, &ohci
->regs
->fminterval
);
584 ohci
->fminterval
= val
& 0x3fff;
585 if (ohci
->fminterval
!= FI
)
586 ohci_dbg (ohci
, "fminterval delta %d\n",
587 ohci
->fminterval
- FI
);
588 ohci
->fminterval
|= FSMP (ohci
->fminterval
) << 16;
589 /* also: power/overcurrent flags in roothub.a */
592 /* Reset USB nearly "by the book". RemoteWakeupConnected has
593 * to be checked in case boot firmware (BIOS/SMM/...) has set up
594 * wakeup in a way the bus isn't aware of (e.g., legacy PCI PM).
595 * If the bus glue detected wakeup capability then it should
596 * already be enabled; if so we'll just enable it again.
598 if ((ohci
->hc_control
& OHCI_CTRL_RWC
) != 0)
599 device_set_wakeup_capable(hcd
->self
.controller
, 1);
601 switch (ohci
->hc_control
& OHCI_CTRL_HCFS
) {
605 case OHCI_USB_SUSPEND
:
606 case OHCI_USB_RESUME
:
607 ohci
->hc_control
&= OHCI_CTRL_RWC
;
608 ohci
->hc_control
|= OHCI_USB_RESUME
;
609 val
= 10 /* msec wait */;
611 // case OHCI_USB_RESET:
613 ohci
->hc_control
&= OHCI_CTRL_RWC
;
614 ohci
->hc_control
|= OHCI_USB_RESET
;
615 val
= 50 /* msec wait */;
618 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
620 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
623 memset (ohci
->hcca
, 0, sizeof (struct ohci_hcca
));
625 /* 2msec timelimit here means no irqs/preempt */
626 spin_lock_irq (&ohci
->lock
);
629 /* HC Reset requires max 10 us delay */
630 ohci_writel (ohci
, OHCI_HCR
, &ohci
->regs
->cmdstatus
);
631 val
= 30; /* ... allow extra time */
632 while ((ohci_readl (ohci
, &ohci
->regs
->cmdstatus
) & OHCI_HCR
) != 0) {
634 spin_unlock_irq (&ohci
->lock
);
635 ohci_err (ohci
, "USB HC reset timed out!\n");
641 /* now we're in the SUSPEND state ... must go OPERATIONAL
642 * within 2msec else HC enters RESUME
644 * ... but some hardware won't init fmInterval "by the book"
645 * (SiS, OPTi ...), so reset again instead. SiS doesn't need
646 * this if we write fmInterval after we're OPERATIONAL.
647 * Unclear about ALi, ServerWorks, and others ... this could
648 * easily be a longstanding bug in chip init on Linux.
650 if (ohci
->flags
& OHCI_QUIRK_INITRESET
) {
651 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
652 // flush those writes
653 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
656 /* Tell the controller where the control and bulk lists are
657 * The lists are empty now. */
658 ohci_writel (ohci
, 0, &ohci
->regs
->ed_controlhead
);
659 ohci_writel (ohci
, 0, &ohci
->regs
->ed_bulkhead
);
661 /* a reset clears this */
662 ohci_writel (ohci
, (u32
) ohci
->hcca_dma
, &ohci
->regs
->hcca
);
664 periodic_reinit (ohci
);
666 /* some OHCI implementations are finicky about how they init.
667 * bogus values here mean not even enumeration could work.
669 if ((ohci_readl (ohci
, &ohci
->regs
->fminterval
) & 0x3fff0000) == 0
670 || !ohci_readl (ohci
, &ohci
->regs
->periodicstart
)) {
671 if (!(ohci
->flags
& OHCI_QUIRK_INITRESET
)) {
672 ohci
->flags
|= OHCI_QUIRK_INITRESET
;
673 ohci_dbg (ohci
, "enabling initreset quirk\n");
676 spin_unlock_irq (&ohci
->lock
);
677 ohci_err (ohci
, "init err (%08x %04x)\n",
678 ohci_readl (ohci
, &ohci
->regs
->fminterval
),
679 ohci_readl (ohci
, &ohci
->regs
->periodicstart
));
683 /* use rhsc irqs after khubd is fully initialized */
684 set_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
685 hcd
->uses_new_polling
= 1;
687 /* start controller operations */
688 ohci
->hc_control
&= OHCI_CTRL_RWC
;
689 ohci
->hc_control
|= OHCI_CONTROL_INIT
| OHCI_USB_OPER
;
690 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
691 hcd
->state
= HC_STATE_RUNNING
;
693 /* wake on ConnectStatusChange, matching external hubs */
694 ohci_writel (ohci
, RH_HS_DRWE
, &ohci
->regs
->roothub
.status
);
696 /* Choose the interrupts we care about now, others later on demand */
697 mask
= OHCI_INTR_INIT
;
698 ohci_writel (ohci
, ~0, &ohci
->regs
->intrstatus
);
699 ohci_writel (ohci
, mask
, &ohci
->regs
->intrenable
);
701 /* handle root hub init quirks ... */
702 val
= roothub_a (ohci
);
703 val
&= ~(RH_A_PSM
| RH_A_OCPM
);
704 if (ohci
->flags
& OHCI_QUIRK_SUPERIO
) {
705 /* NSC 87560 and maybe others */
707 val
&= ~(RH_A_POTPGT
| RH_A_NPS
);
708 ohci_writel (ohci
, val
, &ohci
->regs
->roothub
.a
);
709 } else if ((ohci
->flags
& OHCI_QUIRK_AMD756
) ||
710 (ohci
->flags
& OHCI_QUIRK_HUB_POWER
)) {
711 /* hub power always on; required for AMD-756 and some
712 * Mac platforms. ganged overcurrent reporting, if any.
715 ohci_writel (ohci
, val
, &ohci
->regs
->roothub
.a
);
717 ohci_writel (ohci
, RH_HS_LPSC
, &ohci
->regs
->roothub
.status
);
718 ohci_writel (ohci
, (val
& RH_A_NPS
) ? 0 : RH_B_PPCM
,
719 &ohci
->regs
->roothub
.b
);
720 // flush those writes
721 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
723 ohci
->next_statechange
= jiffies
+ STATECHANGE_DELAY
;
724 spin_unlock_irq (&ohci
->lock
);
726 // POTPGT delay is bits 24-31, in 2 ms units.
727 mdelay ((val
>> 23) & 0x1fe);
728 hcd
->state
= HC_STATE_RUNNING
;
730 if (quirk_zfmicro(ohci
)) {
731 /* Create timer to watch for bad queue state on ZF Micro */
732 setup_timer(&ohci
->unlink_watchdog
, unlink_watchdog_func
,
733 (unsigned long) ohci
);
735 ohci
->eds_scheduled
= 0;
736 ohci
->ed_to_check
= NULL
;
744 /*-------------------------------------------------------------------------*/
746 /* an interrupt happens */
748 static irqreturn_t
ohci_irq (struct usb_hcd
*hcd
)
750 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
751 struct ohci_regs __iomem
*regs
= ohci
->regs
;
754 /* Read interrupt status (and flush pending writes). We ignore the
755 * optimization of checking the LSB of hcca->done_head; it doesn't
756 * work on all systems (edge triggering for OHCI can be a factor).
758 ints
= ohci_readl(ohci
, ®s
->intrstatus
);
760 /* Check for an all 1's result which is a typical consequence
761 * of dead, unclocked, or unplugged (CardBus...) devices
763 if (ints
== ~(u32
)0) {
765 ohci_dbg (ohci
, "device removed!\n");
770 /* We only care about interrupts that are enabled */
771 ints
&= ohci_readl(ohci
, ®s
->intrenable
);
773 /* interrupt for some other device? */
774 if (ints
== 0 || unlikely(hcd
->state
== HC_STATE_HALT
))
777 if (ints
& OHCI_INTR_UE
) {
778 // e.g. due to PCI Master/Target Abort
779 if (quirk_nec(ohci
)) {
780 /* Workaround for a silicon bug in some NEC chips used
781 * in Apple's PowerBooks. Adapted from Darwin code.
783 ohci_err (ohci
, "OHCI Unrecoverable Error, scheduling NEC chip restart\n");
785 ohci_writel (ohci
, OHCI_INTR_UE
, ®s
->intrdisable
);
787 schedule_work (&ohci
->nec_work
);
790 ohci_err (ohci
, "OHCI Unrecoverable Error, disabled\n");
795 ohci_usb_reset (ohci
);
798 if (ints
& OHCI_INTR_RHSC
) {
799 ohci_vdbg(ohci
, "rhsc\n");
800 ohci
->next_statechange
= jiffies
+ STATECHANGE_DELAY
;
801 ohci_writel(ohci
, OHCI_INTR_RD
| OHCI_INTR_RHSC
,
804 /* NOTE: Vendors didn't always make the same implementation
805 * choices for RHSC. Many followed the spec; RHSC triggers
806 * on an edge, like setting and maybe clearing a port status
807 * change bit. With others it's level-triggered, active
808 * until khubd clears all the port status change bits. We'll
809 * always disable it here and rely on polling until khubd
812 ohci_writel(ohci
, OHCI_INTR_RHSC
, ®s
->intrdisable
);
813 usb_hcd_poll_rh_status(hcd
);
816 /* For connect and disconnect events, we expect the controller
817 * to turn on RHSC along with RD. But for remote wakeup events
818 * this might not happen.
820 else if (ints
& OHCI_INTR_RD
) {
821 ohci_vdbg(ohci
, "resume detect\n");
822 ohci_writel(ohci
, OHCI_INTR_RD
, ®s
->intrstatus
);
823 set_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
824 if (ohci
->autostop
) {
825 spin_lock (&ohci
->lock
);
826 ohci_rh_resume (ohci
);
827 spin_unlock (&ohci
->lock
);
829 usb_hcd_resume_root_hub(hcd
);
832 if (ints
& OHCI_INTR_WDH
) {
833 spin_lock (&ohci
->lock
);
835 spin_unlock (&ohci
->lock
);
838 if (quirk_zfmicro(ohci
) && (ints
& OHCI_INTR_SF
)) {
839 spin_lock(&ohci
->lock
);
840 if (ohci
->ed_to_check
) {
841 struct ed
*ed
= ohci
->ed_to_check
;
843 if (check_ed(ohci
, ed
)) {
844 /* HC thinks the TD list is empty; HCD knows
845 * at least one TD is outstanding
847 if (--ohci
->zf_delay
== 0) {
848 struct td
*td
= list_entry(
852 "Reclaiming orphan TD %p\n",
854 takeback_td(ohci
, td
);
855 ohci
->ed_to_check
= NULL
;
858 ohci
->ed_to_check
= NULL
;
860 spin_unlock(&ohci
->lock
);
863 /* could track INTR_SO to reduce available PCI/... bandwidth */
865 /* handle any pending URB/ED unlinks, leaving INTR_SF enabled
866 * when there's still unlinking to be done (next frame).
868 spin_lock (&ohci
->lock
);
869 if (ohci
->ed_rm_list
)
870 finish_unlinks (ohci
, ohci_frame_no(ohci
));
871 if ((ints
& OHCI_INTR_SF
) != 0
873 && !ohci
->ed_to_check
874 && HC_IS_RUNNING(hcd
->state
))
875 ohci_writel (ohci
, OHCI_INTR_SF
, ®s
->intrdisable
);
876 spin_unlock (&ohci
->lock
);
878 if (HC_IS_RUNNING(hcd
->state
)) {
879 ohci_writel (ohci
, ints
, ®s
->intrstatus
);
880 ohci_writel (ohci
, OHCI_INTR_MIE
, ®s
->intrenable
);
881 // flush those writes
882 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
888 /*-------------------------------------------------------------------------*/
890 static void ohci_stop (struct usb_hcd
*hcd
)
892 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
897 flush_work_sync(&ohci
->nec_work
);
899 ohci_usb_reset (ohci
);
900 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
901 free_irq(hcd
->irq
, hcd
);
904 if (quirk_zfmicro(ohci
))
905 del_timer(&ohci
->unlink_watchdog
);
906 if (quirk_amdiso(ohci
))
909 remove_debug_files (ohci
);
910 ohci_mem_cleanup (ohci
);
912 dma_free_coherent (hcd
->self
.controller
,
914 ohci
->hcca
, ohci
->hcca_dma
);
920 /*-------------------------------------------------------------------------*/
922 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
924 /* must not be called from interrupt context */
925 static int ohci_restart (struct ohci_hcd
*ohci
)
929 struct urb_priv
*priv
;
931 spin_lock_irq(&ohci
->lock
);
934 /* Recycle any "live" eds/tds (and urbs). */
935 if (!list_empty (&ohci
->pending
))
936 ohci_dbg(ohci
, "abort schedule...\n");
937 list_for_each_entry (priv
, &ohci
->pending
, pending
) {
938 struct urb
*urb
= priv
->td
[0]->urb
;
939 struct ed
*ed
= priv
->ed
;
943 ed
->state
= ED_UNLINK
;
944 ed
->hwINFO
|= cpu_to_hc32(ohci
, ED_DEQUEUE
);
945 ed_deschedule (ohci
, ed
);
947 ed
->ed_next
= ohci
->ed_rm_list
;
949 ohci
->ed_rm_list
= ed
;
954 ohci_dbg(ohci
, "bogus ed %p state %d\n",
959 urb
->unlinked
= -ESHUTDOWN
;
961 finish_unlinks (ohci
, 0);
962 spin_unlock_irq(&ohci
->lock
);
964 /* paranoia, in case that didn't work: */
966 /* empty the interrupt branches */
967 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->load
[i
] = 0;
968 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->hcca
->int_table
[i
] = 0;
970 /* no EDs to remove */
971 ohci
->ed_rm_list
= NULL
;
973 /* empty control and bulk lists */
974 ohci
->ed_controltail
= NULL
;
975 ohci
->ed_bulktail
= NULL
;
977 if ((temp
= ohci_run (ohci
)) < 0) {
978 ohci_err (ohci
, "can't restart, %d\n", temp
);
981 ohci_dbg(ohci
, "restart complete\n");
987 /*-------------------------------------------------------------------------*/
989 MODULE_AUTHOR (DRIVER_AUTHOR
);
990 MODULE_DESCRIPTION(DRIVER_DESC
);
991 MODULE_LICENSE ("GPL");
994 #include "ohci-pci.c"
995 #define PCI_DRIVER ohci_pci_driver
998 #if defined(CONFIG_ARCH_SA1100) && defined(CONFIG_SA1111)
999 #include "ohci-sa1111.c"
1000 #define SA1111_DRIVER ohci_hcd_sa1111_driver
1003 #if defined(CONFIG_ARCH_S3C2410) || defined(CONFIG_ARCH_S3C64XX)
1004 #include "ohci-s3c2410.c"
1005 #define PLATFORM_DRIVER ohci_hcd_s3c2410_driver
1008 #ifdef CONFIG_USB_OHCI_HCD_OMAP1
1009 #include "ohci-omap.c"
1010 #define OMAP1_PLATFORM_DRIVER ohci_hcd_omap_driver
1013 #ifdef CONFIG_USB_OHCI_HCD_OMAP3
1014 #include "ohci-omap3.c"
1015 #define OMAP3_PLATFORM_DRIVER ohci_hcd_omap3_driver
1018 #if defined(CONFIG_PXA27x) || defined(CONFIG_PXA3xx)
1019 #include "ohci-pxa27x.c"
1020 #define PLATFORM_DRIVER ohci_hcd_pxa27x_driver
1023 #ifdef CONFIG_ARCH_EP93XX
1024 #include "ohci-ep93xx.c"
1025 #define PLATFORM_DRIVER ohci_hcd_ep93xx_driver
1028 #ifdef CONFIG_MIPS_ALCHEMY
1029 #include "ohci-au1xxx.c"
1030 #define PLATFORM_DRIVER ohci_hcd_au1xxx_driver
1033 #ifdef CONFIG_PNX8550
1034 #include "ohci-pnx8550.c"
1035 #define PLATFORM_DRIVER ohci_hcd_pnx8550_driver
1038 #ifdef CONFIG_USB_OHCI_HCD_PPC_SOC
1039 #include "ohci-ppc-soc.c"
1040 #define PLATFORM_DRIVER ohci_hcd_ppc_soc_driver
1043 #ifdef CONFIG_ARCH_AT91
1044 #include "ohci-at91.c"
1045 #define PLATFORM_DRIVER ohci_hcd_at91_driver
1048 #ifdef CONFIG_ARCH_PNX4008
1049 #include "ohci-pnx4008.c"
1050 #define PLATFORM_DRIVER usb_hcd_pnx4008_driver
1053 #ifdef CONFIG_ARCH_DAVINCI_DA8XX
1054 #include "ohci-da8xx.c"
1055 #define PLATFORM_DRIVER ohci_hcd_da8xx_driver
1058 #ifdef CONFIG_USB_OHCI_SH
1059 #include "ohci-sh.c"
1060 #define PLATFORM_DRIVER ohci_hcd_sh_driver
1064 #ifdef CONFIG_USB_OHCI_HCD_PPC_OF
1065 #include "ohci-ppc-of.c"
1066 #define OF_PLATFORM_DRIVER ohci_hcd_ppc_of_driver
1069 #ifdef CONFIG_PLAT_SPEAR
1070 #include "ohci-spear.c"
1071 #define PLATFORM_DRIVER spear_ohci_hcd_driver
1074 #ifdef CONFIG_PPC_PS3
1075 #include "ohci-ps3.c"
1076 #define PS3_SYSTEM_BUS_DRIVER ps3_ohci_driver
1079 #ifdef CONFIG_USB_OHCI_HCD_SSB
1080 #include "ohci-ssb.c"
1081 #define SSB_OHCI_DRIVER ssb_ohci_driver
1084 #ifdef CONFIG_MFD_SM501
1085 #include "ohci-sm501.c"
1086 #define SM501_OHCI_DRIVER ohci_hcd_sm501_driver
1089 #ifdef CONFIG_MFD_TC6393XB
1090 #include "ohci-tmio.c"
1091 #define TMIO_OHCI_DRIVER ohci_hcd_tmio_driver
1094 #ifdef CONFIG_MACH_JZ4740
1095 #include "ohci-jz4740.c"
1096 #define PLATFORM_DRIVER ohci_hcd_jz4740_driver
1099 #ifdef CONFIG_USB_OCTEON_OHCI
1100 #include "ohci-octeon.c"
1101 #define PLATFORM_DRIVER ohci_octeon_driver
1104 #ifdef CONFIG_USB_CNS3XXX_OHCI
1105 #include "ohci-cns3xxx.c"
1106 #define PLATFORM_DRIVER ohci_hcd_cns3xxx_driver
1109 #ifdef CONFIG_USB_OHCI_ATH79
1110 #include "ohci-ath79.c"
1111 #define PLATFORM_DRIVER ohci_hcd_ath79_driver
1114 #ifdef CONFIG_NLM_XLR
1115 #include "ohci-xls.c"
1116 #define PLATFORM_DRIVER ohci_xls_driver
1119 #if !defined(PCI_DRIVER) && \
1120 !defined(PLATFORM_DRIVER) && \
1121 !defined(OMAP1_PLATFORM_DRIVER) && \
1122 !defined(OMAP3_PLATFORM_DRIVER) && \
1123 !defined(OF_PLATFORM_DRIVER) && \
1124 !defined(SA1111_DRIVER) && \
1125 !defined(PS3_SYSTEM_BUS_DRIVER) && \
1126 !defined(SM501_OHCI_DRIVER) && \
1127 !defined(TMIO_OHCI_DRIVER) && \
1128 !defined(SSB_OHCI_DRIVER)
1129 #error "missing bus glue for ohci-hcd"
1132 static int __init
ohci_hcd_mod_init(void)
1139 printk(KERN_INFO
"%s: " DRIVER_DESC
"\n", hcd_name
);
1140 pr_debug ("%s: block sizes: ed %Zd td %Zd\n", hcd_name
,
1141 sizeof (struct ed
), sizeof (struct td
));
1142 set_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1145 ohci_debug_root
= debugfs_create_dir("ohci", usb_debug_root
);
1146 if (!ohci_debug_root
) {
1152 #ifdef PS3_SYSTEM_BUS_DRIVER
1153 retval
= ps3_ohci_driver_register(&PS3_SYSTEM_BUS_DRIVER
);
1158 #ifdef PLATFORM_DRIVER
1159 retval
= platform_driver_register(&PLATFORM_DRIVER
);
1161 goto error_platform
;
1164 #ifdef OMAP1_PLATFORM_DRIVER
1165 retval
= platform_driver_register(&OMAP1_PLATFORM_DRIVER
);
1167 goto error_omap1_platform
;
1170 #ifdef OMAP3_PLATFORM_DRIVER
1171 retval
= platform_driver_register(&OMAP3_PLATFORM_DRIVER
);
1173 goto error_omap3_platform
;
1176 #ifdef OF_PLATFORM_DRIVER
1177 retval
= platform_driver_register(&OF_PLATFORM_DRIVER
);
1179 goto error_of_platform
;
1182 #ifdef SA1111_DRIVER
1183 retval
= sa1111_driver_register(&SA1111_DRIVER
);
1189 retval
= pci_register_driver(&PCI_DRIVER
);
1194 #ifdef SSB_OHCI_DRIVER
1195 retval
= ssb_driver_register(&SSB_OHCI_DRIVER
);
1200 #ifdef SM501_OHCI_DRIVER
1201 retval
= platform_driver_register(&SM501_OHCI_DRIVER
);
1206 #ifdef TMIO_OHCI_DRIVER
1207 retval
= platform_driver_register(&TMIO_OHCI_DRIVER
);
1215 #ifdef TMIO_OHCI_DRIVER
1216 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1219 #ifdef SM501_OHCI_DRIVER
1220 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1223 #ifdef SSB_OHCI_DRIVER
1224 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1228 pci_unregister_driver(&PCI_DRIVER
);
1231 #ifdef SA1111_DRIVER
1232 sa1111_driver_unregister(&SA1111_DRIVER
);
1235 #ifdef OF_PLATFORM_DRIVER
1236 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1239 #ifdef PLATFORM_DRIVER
1240 platform_driver_unregister(&PLATFORM_DRIVER
);
1243 #ifdef OMAP1_PLATFORM_DRIVER
1244 platform_driver_unregister(&OMAP1_PLATFORM_DRIVER
);
1245 error_omap1_platform
:
1247 #ifdef OMAP3_PLATFORM_DRIVER
1248 platform_driver_unregister(&OMAP3_PLATFORM_DRIVER
);
1249 error_omap3_platform
:
1251 #ifdef PS3_SYSTEM_BUS_DRIVER
1252 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1256 debugfs_remove(ohci_debug_root
);
1257 ohci_debug_root
= NULL
;
1261 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1264 module_init(ohci_hcd_mod_init
);
1266 static void __exit
ohci_hcd_mod_exit(void)
1268 #ifdef TMIO_OHCI_DRIVER
1269 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1271 #ifdef SM501_OHCI_DRIVER
1272 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1274 #ifdef SSB_OHCI_DRIVER
1275 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1278 pci_unregister_driver(&PCI_DRIVER
);
1280 #ifdef SA1111_DRIVER
1281 sa1111_driver_unregister(&SA1111_DRIVER
);
1283 #ifdef OF_PLATFORM_DRIVER
1284 platform_driver_unregister(&OF_PLATFORM_DRIVER
);
1286 #ifdef PLATFORM_DRIVER
1287 platform_driver_unregister(&PLATFORM_DRIVER
);
1289 #ifdef OMAP3_PLATFORM_DRIVER
1290 platform_driver_unregister(&OMAP3_PLATFORM_DRIVER
);
1292 #ifdef PS3_SYSTEM_BUS_DRIVER
1293 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1296 debugfs_remove(ohci_debug_root
);
1298 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1300 module_exit(ohci_hcd_mod_exit
);