2 * OHCI HCD (Host Controller Driver) for USB.
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
7 * [ Initialisation is based on Linus' ]
8 * [ uhci code and gregs ohci fragments ]
9 * [ (C) Copyright 1999 Linus Torvalds ]
10 * [ (C) Copyright 1999 Gregory P. Smith]
13 * OHCI is the main "non-Intel/VIA" standard for USB 1.1 host controller
14 * interfaces (though some non-x86 Intel chips use it). It supports
15 * smarter hardware than UHCI. A download link for the spec available
16 * through the http://www.usb.org website.
18 * This file is licenced under the GPL.
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/pci.h>
24 #include <linux/kernel.h>
25 #include <linux/delay.h>
26 #include <linux/ioport.h>
27 #include <linux/sched.h>
28 #include <linux/slab.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/timer.h>
32 #include <linux/list.h>
33 #include <linux/usb.h>
34 #include <linux/usb/otg.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/dmapool.h>
37 #include <linux/workqueue.h>
38 #include <linux/debugfs.h>
42 #include <asm/system.h>
43 #include <asm/unaligned.h>
44 #include <asm/byteorder.h>
46 #include "../core/hcd.h"
48 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
49 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
51 /*-------------------------------------------------------------------------*/
53 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
55 /* For initializing controller (mask in an HCFS mode too) */
56 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
57 #define OHCI_INTR_INIT \
58 (OHCI_INTR_MIE | OHCI_INTR_RHSC | OHCI_INTR_UE \
59 | OHCI_INTR_RD | OHCI_INTR_WDH)
62 /* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
66 #ifdef CONFIG_ARCH_OMAP
67 /* OMAP doesn't support IR (no SMM; not needed) */
71 /*-------------------------------------------------------------------------*/
73 static const char hcd_name
[] = "ohci_hcd";
75 #define STATECHANGE_DELAY msecs_to_jiffies(300)
79 static void ohci_dump (struct ohci_hcd
*ohci
, int verbose
);
80 static int ohci_init (struct ohci_hcd
*ohci
);
81 static void ohci_stop (struct usb_hcd
*hcd
);
83 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
84 static int ohci_restart (struct ohci_hcd
*ohci
);
88 static void quirk_amd_pll(int state
);
89 static void amd_iso_dev_put(void);
91 static inline void quirk_amd_pll(int state
)
95 static inline void amd_iso_dev_put(void)
102 #include "ohci-hub.c"
103 #include "ohci-dbg.c"
104 #include "ohci-mem.c"
109 * On architectures with edge-triggered interrupts we must never return
112 #if defined(CONFIG_SA1111) /* ... or other edge-triggered systems */
113 #define IRQ_NOTMINE IRQ_HANDLED
115 #define IRQ_NOTMINE IRQ_NONE
119 /* Some boards misreport power switching/overcurrent */
120 static int distrust_firmware
= 1;
121 module_param (distrust_firmware
, bool, 0);
122 MODULE_PARM_DESC (distrust_firmware
,
123 "true to distrust firmware power/overcurrent setup");
125 /* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */
126 static int no_handshake
= 0;
127 module_param (no_handshake
, bool, 0);
128 MODULE_PARM_DESC (no_handshake
, "true (not default) disables BIOS handshake");
130 /*-------------------------------------------------------------------------*/
133 * queue up an urb for anything except the root hub
135 static int ohci_urb_enqueue (
140 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
142 urb_priv_t
*urb_priv
;
143 unsigned int pipe
= urb
->pipe
;
148 #ifdef OHCI_VERBOSE_DEBUG
149 urb_print(urb
, "SUB", usb_pipein(pipe
), -EINPROGRESS
);
152 /* every endpoint has a ed, locate and maybe (re)initialize it */
153 if (! (ed
= ed_get (ohci
, urb
->ep
, urb
->dev
, pipe
, urb
->interval
)))
156 /* for the private part of the URB we need the number of TDs (size) */
159 /* td_submit_urb() doesn't yet handle these */
160 if (urb
->transfer_buffer_length
> 4096)
163 /* 1 TD for setup, 1 for ACK, plus ... */
166 // case PIPE_INTERRUPT:
169 /* one TD for every 4096 Bytes (can be upto 8K) */
170 size
+= urb
->transfer_buffer_length
/ 4096;
171 /* ... and for any remaining bytes ... */
172 if ((urb
->transfer_buffer_length
% 4096) != 0)
174 /* ... and maybe a zero length packet to wrap it up */
177 else if ((urb
->transfer_flags
& URB_ZERO_PACKET
) != 0
178 && (urb
->transfer_buffer_length
179 % usb_maxpacket (urb
->dev
, pipe
,
180 usb_pipeout (pipe
))) == 0)
183 case PIPE_ISOCHRONOUS
: /* number of packets from URB */
184 size
= urb
->number_of_packets
;
188 /* allocate the private part of the URB */
189 urb_priv
= kzalloc (sizeof (urb_priv_t
) + size
* sizeof (struct td
*),
193 INIT_LIST_HEAD (&urb_priv
->pending
);
194 urb_priv
->length
= size
;
197 /* allocate the TDs (deferring hash chain updates) */
198 for (i
= 0; i
< size
; i
++) {
199 urb_priv
->td
[i
] = td_alloc (ohci
, mem_flags
);
200 if (!urb_priv
->td
[i
]) {
201 urb_priv
->length
= i
;
202 urb_free_priv (ohci
, urb_priv
);
207 spin_lock_irqsave (&ohci
->lock
, flags
);
209 /* don't submit to a dead HC */
210 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)) {
214 if (!HC_IS_RUNNING(hcd
->state
)) {
218 retval
= usb_hcd_link_urb_to_ep(hcd
, urb
);
222 /* schedule the ed if needed */
223 if (ed
->state
== ED_IDLE
) {
224 retval
= ed_schedule (ohci
, ed
);
226 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
229 if (ed
->type
== PIPE_ISOCHRONOUS
) {
230 u16 frame
= ohci_frame_no(ohci
);
232 /* delay a few frames before the first TD */
233 frame
+= max_t (u16
, 8, ed
->interval
);
234 frame
&= ~(ed
->interval
- 1);
236 urb
->start_frame
= frame
;
238 /* yes, only URB_ISO_ASAP is supported, and
239 * urb->start_frame is never used as input.
242 } else if (ed
->type
== PIPE_ISOCHRONOUS
)
243 urb
->start_frame
= ed
->last_iso
+ ed
->interval
;
245 /* fill the TDs and link them to the ed; and
246 * enable that part of the schedule, if needed
247 * and update count of queued periodic urbs
249 urb
->hcpriv
= urb_priv
;
250 td_submit_urb (ohci
, urb
);
254 urb_free_priv (ohci
, urb_priv
);
255 spin_unlock_irqrestore (&ohci
->lock
, flags
);
260 * decouple the URB from the HC queues (TDs, urb_priv).
261 * reporting is always done
262 * asynchronously, and we might be dealing with an urb that's
263 * partially transferred, or an ED with other urbs being unlinked.
265 static int ohci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
267 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
271 #ifdef OHCI_VERBOSE_DEBUG
272 urb_print(urb
, "UNLINK", 1, status
);
275 spin_lock_irqsave (&ohci
->lock
, flags
);
276 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
279 } else if (HC_IS_RUNNING(hcd
->state
)) {
280 urb_priv_t
*urb_priv
;
282 /* Unless an IRQ completed the unlink while it was being
283 * handed to us, flag it for unlink and giveback, and force
284 * some upcoming INTR_SF to call finish_unlinks()
286 urb_priv
= urb
->hcpriv
;
288 if (urb_priv
->ed
->state
== ED_OPER
)
289 start_ed_unlink (ohci
, urb_priv
->ed
);
293 * with HC dead, we won't respect hc queue pointers
294 * any more ... just clean up every urb's memory.
297 finish_urb(ohci
, urb
, status
);
299 spin_unlock_irqrestore (&ohci
->lock
, flags
);
303 /*-------------------------------------------------------------------------*/
305 /* frees config/altsetting state for endpoints,
306 * including ED memory, dummy TD, and bulk/intr data toggle
310 ohci_endpoint_disable (struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
312 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
314 struct ed
*ed
= ep
->hcpriv
;
315 unsigned limit
= 1000;
317 /* ASSERT: any requests/urbs are being unlinked */
318 /* ASSERT: nobody can be submitting urbs for this any more */
324 spin_lock_irqsave (&ohci
->lock
, flags
);
326 if (!HC_IS_RUNNING (hcd
->state
)) {
329 if (quirk_zfmicro(ohci
) && ed
->type
== PIPE_INTERRUPT
)
330 ohci
->eds_scheduled
--;
331 finish_unlinks (ohci
, 0);
335 case ED_UNLINK
: /* wait for hw to finish? */
336 /* major IRQ delivery trouble loses INTR_SF too... */
338 ohci_warn(ohci
, "ED unlink timeout\n");
339 if (quirk_zfmicro(ohci
)) {
340 ohci_warn(ohci
, "Attempting ZF TD recovery\n");
341 ohci
->ed_to_check
= ed
;
346 spin_unlock_irqrestore (&ohci
->lock
, flags
);
347 schedule_timeout_uninterruptible(1);
349 case ED_IDLE
: /* fully unlinked */
350 if (list_empty (&ed
->td_list
)) {
351 td_free (ohci
, ed
->dummy
);
355 /* else FALL THROUGH */
357 /* caller was supposed to have unlinked any requests;
358 * that's not our job. can't recover; must leak ed.
360 ohci_err (ohci
, "leak ed %p (#%02x) state %d%s\n",
361 ed
, ep
->desc
.bEndpointAddress
, ed
->state
,
362 list_empty (&ed
->td_list
) ? "" : " (has tds)");
363 td_free (ohci
, ed
->dummy
);
367 spin_unlock_irqrestore (&ohci
->lock
, flags
);
371 static int ohci_get_frame (struct usb_hcd
*hcd
)
373 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
375 return ohci_frame_no(ohci
);
378 static void ohci_usb_reset (struct ohci_hcd
*ohci
)
380 ohci
->hc_control
= ohci_readl (ohci
, &ohci
->regs
->control
);
381 ohci
->hc_control
&= OHCI_CTRL_RWC
;
382 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
385 /* ohci_shutdown forcibly disables IRQs and DMA, helping kexec and
386 * other cases where the next software may expect clean state from the
387 * "firmware". this is bus-neutral, unlike shutdown() methods.
390 ohci_shutdown (struct usb_hcd
*hcd
)
392 struct ohci_hcd
*ohci
;
394 ohci
= hcd_to_ohci (hcd
);
395 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
396 ohci_usb_reset (ohci
);
397 /* flush the writes */
398 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
401 static int check_ed(struct ohci_hcd
*ohci
, struct ed
*ed
)
403 return (hc32_to_cpu(ohci
, ed
->hwINFO
) & ED_IN
) != 0
404 && (hc32_to_cpu(ohci
, ed
->hwHeadP
) & TD_MASK
)
405 == (hc32_to_cpu(ohci
, ed
->hwTailP
) & TD_MASK
)
406 && !list_empty(&ed
->td_list
);
409 /* ZF Micro watchdog timer callback. The ZF Micro chipset sometimes completes
410 * an interrupt TD but neglects to add it to the donelist. On systems with
411 * this chipset, we need to periodically check the state of the queues to look
412 * for such "lost" TDs.
414 static void unlink_watchdog_func(unsigned long _ohci
)
418 unsigned seen_count
= 0;
420 struct ed
**seen
= NULL
;
421 struct ohci_hcd
*ohci
= (struct ohci_hcd
*) _ohci
;
423 spin_lock_irqsave(&ohci
->lock
, flags
);
424 max
= ohci
->eds_scheduled
;
428 if (ohci
->ed_to_check
)
431 seen
= kcalloc(max
, sizeof *seen
, GFP_ATOMIC
);
435 for (i
= 0; i
< NUM_INTS
; i
++) {
436 struct ed
*ed
= ohci
->periodic
[i
];
441 /* scan this branch of the periodic schedule tree */
442 for (temp
= 0; temp
< seen_count
; temp
++) {
443 if (seen
[temp
] == ed
) {
444 /* we've checked it and what's after */
451 seen
[seen_count
++] = ed
;
452 if (!check_ed(ohci
, ed
)) {
457 /* HC's TD list is empty, but HCD sees at least one
458 * TD that's not been sent through the donelist.
460 ohci
->ed_to_check
= ed
;
463 /* The HC may wait until the next frame to report the
464 * TD as done through the donelist and INTR_WDH. (We
465 * just *assume* it's not a multi-TD interrupt URB;
466 * those could defer the IRQ more than one frame, using
467 * DI...) Check again after the next INTR_SF.
469 ohci_writel(ohci
, OHCI_INTR_SF
,
470 &ohci
->regs
->intrstatus
);
471 ohci_writel(ohci
, OHCI_INTR_SF
,
472 &ohci
->regs
->intrenable
);
474 /* flush those writes */
475 (void) ohci_readl(ohci
, &ohci
->regs
->control
);
482 if (ohci
->eds_scheduled
)
483 mod_timer(&ohci
->unlink_watchdog
, round_jiffies(jiffies
+ HZ
));
485 spin_unlock_irqrestore(&ohci
->lock
, flags
);
488 /*-------------------------------------------------------------------------*
490 *-------------------------------------------------------------------------*/
492 /* init memory, and kick BIOS/SMM off */
494 static int ohci_init (struct ohci_hcd
*ohci
)
497 struct usb_hcd
*hcd
= ohci_to_hcd(ohci
);
499 if (distrust_firmware
)
500 ohci
->flags
|= OHCI_QUIRK_HUB_POWER
;
503 ohci
->regs
= hcd
->regs
;
505 /* REVISIT this BIOS handshake is now moved into PCI "quirks", and
506 * was never needed for most non-PCI systems ... remove the code?
510 /* SMM owns the HC? not for long! */
511 if (!no_handshake
&& ohci_readl (ohci
,
512 &ohci
->regs
->control
) & OHCI_CTRL_IR
) {
515 ohci_dbg (ohci
, "USB HC TakeOver from BIOS/SMM\n");
517 /* this timeout is arbitrary. we make it long, so systems
518 * depending on usb keyboards may be usable even if the
519 * BIOS/SMM code seems pretty broken.
521 temp
= 500; /* arbitrary: five seconds */
523 ohci_writel (ohci
, OHCI_INTR_OC
, &ohci
->regs
->intrenable
);
524 ohci_writel (ohci
, OHCI_OCR
, &ohci
->regs
->cmdstatus
);
525 while (ohci_readl (ohci
, &ohci
->regs
->control
) & OHCI_CTRL_IR
) {
528 ohci_err (ohci
, "USB HC takeover failed!"
529 " (BIOS/SMM bug)\n");
533 ohci_usb_reset (ohci
);
537 /* Disable HC interrupts */
538 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
540 /* flush the writes, and save key bits like RWC */
541 if (ohci_readl (ohci
, &ohci
->regs
->control
) & OHCI_CTRL_RWC
)
542 ohci
->hc_control
|= OHCI_CTRL_RWC
;
544 /* Read the number of ports unless overridden */
545 if (ohci
->num_ports
== 0)
546 ohci
->num_ports
= roothub_a(ohci
) & RH_A_NDP
;
551 ohci
->hcca
= dma_alloc_coherent (hcd
->self
.controller
,
552 sizeof *ohci
->hcca
, &ohci
->hcca_dma
, 0);
556 if ((ret
= ohci_mem_init (ohci
)) < 0)
559 create_debug_files (ohci
);
565 /*-------------------------------------------------------------------------*/
567 /* Start an OHCI controller, set the BUS operational
568 * resets USB and controller
571 static int ohci_run (struct ohci_hcd
*ohci
)
574 int first
= ohci
->fminterval
== 0;
575 struct usb_hcd
*hcd
= ohci_to_hcd(ohci
);
579 /* boot firmware should have set this up (5.1.1.3.1) */
582 val
= ohci_readl (ohci
, &ohci
->regs
->fminterval
);
583 ohci
->fminterval
= val
& 0x3fff;
584 if (ohci
->fminterval
!= FI
)
585 ohci_dbg (ohci
, "fminterval delta %d\n",
586 ohci
->fminterval
- FI
);
587 ohci
->fminterval
|= FSMP (ohci
->fminterval
) << 16;
588 /* also: power/overcurrent flags in roothub.a */
591 /* Reset USB nearly "by the book". RemoteWakeupConnected has
592 * to be checked in case boot firmware (BIOS/SMM/...) has set up
593 * wakeup in a way the bus isn't aware of (e.g., legacy PCI PM).
594 * If the bus glue detected wakeup capability then it should
595 * already be enabled; if so we'll just enable it again.
597 if ((ohci
->hc_control
& OHCI_CTRL_RWC
) != 0)
598 device_set_wakeup_capable(hcd
->self
.controller
, 1);
600 switch (ohci
->hc_control
& OHCI_CTRL_HCFS
) {
604 case OHCI_USB_SUSPEND
:
605 case OHCI_USB_RESUME
:
606 ohci
->hc_control
&= OHCI_CTRL_RWC
;
607 ohci
->hc_control
|= OHCI_USB_RESUME
;
608 val
= 10 /* msec wait */;
610 // case OHCI_USB_RESET:
612 ohci
->hc_control
&= OHCI_CTRL_RWC
;
613 ohci
->hc_control
|= OHCI_USB_RESET
;
614 val
= 50 /* msec wait */;
617 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
619 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
622 memset (ohci
->hcca
, 0, sizeof (struct ohci_hcca
));
624 /* 2msec timelimit here means no irqs/preempt */
625 spin_lock_irq (&ohci
->lock
);
628 /* HC Reset requires max 10 us delay */
629 ohci_writel (ohci
, OHCI_HCR
, &ohci
->regs
->cmdstatus
);
630 val
= 30; /* ... allow extra time */
631 while ((ohci_readl (ohci
, &ohci
->regs
->cmdstatus
) & OHCI_HCR
) != 0) {
633 spin_unlock_irq (&ohci
->lock
);
634 ohci_err (ohci
, "USB HC reset timed out!\n");
640 /* now we're in the SUSPEND state ... must go OPERATIONAL
641 * within 2msec else HC enters RESUME
643 * ... but some hardware won't init fmInterval "by the book"
644 * (SiS, OPTi ...), so reset again instead. SiS doesn't need
645 * this if we write fmInterval after we're OPERATIONAL.
646 * Unclear about ALi, ServerWorks, and others ... this could
647 * easily be a longstanding bug in chip init on Linux.
649 if (ohci
->flags
& OHCI_QUIRK_INITRESET
) {
650 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
651 // flush those writes
652 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
655 /* Tell the controller where the control and bulk lists are
656 * The lists are empty now. */
657 ohci_writel (ohci
, 0, &ohci
->regs
->ed_controlhead
);
658 ohci_writel (ohci
, 0, &ohci
->regs
->ed_bulkhead
);
660 /* a reset clears this */
661 ohci_writel (ohci
, (u32
) ohci
->hcca_dma
, &ohci
->regs
->hcca
);
663 periodic_reinit (ohci
);
665 /* some OHCI implementations are finicky about how they init.
666 * bogus values here mean not even enumeration could work.
668 if ((ohci_readl (ohci
, &ohci
->regs
->fminterval
) & 0x3fff0000) == 0
669 || !ohci_readl (ohci
, &ohci
->regs
->periodicstart
)) {
670 if (!(ohci
->flags
& OHCI_QUIRK_INITRESET
)) {
671 ohci
->flags
|= OHCI_QUIRK_INITRESET
;
672 ohci_dbg (ohci
, "enabling initreset quirk\n");
675 spin_unlock_irq (&ohci
->lock
);
676 ohci_err (ohci
, "init err (%08x %04x)\n",
677 ohci_readl (ohci
, &ohci
->regs
->fminterval
),
678 ohci_readl (ohci
, &ohci
->regs
->periodicstart
));
682 /* use rhsc irqs after khubd is fully initialized */
684 hcd
->uses_new_polling
= 1;
686 /* start controller operations */
687 ohci
->hc_control
&= OHCI_CTRL_RWC
;
688 ohci
->hc_control
|= OHCI_CONTROL_INIT
| OHCI_USB_OPER
;
689 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
690 hcd
->state
= HC_STATE_RUNNING
;
692 /* wake on ConnectStatusChange, matching external hubs */
693 ohci_writel (ohci
, RH_HS_DRWE
, &ohci
->regs
->roothub
.status
);
695 /* Choose the interrupts we care about now, others later on demand */
696 mask
= OHCI_INTR_INIT
;
697 ohci_writel (ohci
, ~0, &ohci
->regs
->intrstatus
);
698 ohci_writel (ohci
, mask
, &ohci
->regs
->intrenable
);
700 /* handle root hub init quirks ... */
701 val
= roothub_a (ohci
);
702 val
&= ~(RH_A_PSM
| RH_A_OCPM
);
703 if (ohci
->flags
& OHCI_QUIRK_SUPERIO
) {
704 /* NSC 87560 and maybe others */
706 val
&= ~(RH_A_POTPGT
| RH_A_NPS
);
707 ohci_writel (ohci
, val
, &ohci
->regs
->roothub
.a
);
708 } else if ((ohci
->flags
& OHCI_QUIRK_AMD756
) ||
709 (ohci
->flags
& OHCI_QUIRK_HUB_POWER
)) {
710 /* hub power always on; required for AMD-756 and some
711 * Mac platforms. ganged overcurrent reporting, if any.
714 ohci_writel (ohci
, val
, &ohci
->regs
->roothub
.a
);
716 ohci_writel (ohci
, RH_HS_LPSC
, &ohci
->regs
->roothub
.status
);
717 ohci_writel (ohci
, (val
& RH_A_NPS
) ? 0 : RH_B_PPCM
,
718 &ohci
->regs
->roothub
.b
);
719 // flush those writes
720 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
722 ohci
->next_statechange
= jiffies
+ STATECHANGE_DELAY
;
723 spin_unlock_irq (&ohci
->lock
);
725 // POTPGT delay is bits 24-31, in 2 ms units.
726 mdelay ((val
>> 23) & 0x1fe);
727 hcd
->state
= HC_STATE_RUNNING
;
729 if (quirk_zfmicro(ohci
)) {
730 /* Create timer to watch for bad queue state on ZF Micro */
731 setup_timer(&ohci
->unlink_watchdog
, unlink_watchdog_func
,
732 (unsigned long) ohci
);
734 ohci
->eds_scheduled
= 0;
735 ohci
->ed_to_check
= NULL
;
743 /*-------------------------------------------------------------------------*/
745 /* an interrupt happens */
747 static irqreturn_t
ohci_irq (struct usb_hcd
*hcd
)
749 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
750 struct ohci_regs __iomem
*regs
= ohci
->regs
;
753 /* Read interrupt status (and flush pending writes). We ignore the
754 * optimization of checking the LSB of hcca->done_head; it doesn't
755 * work on all systems (edge triggering for OHCI can be a factor).
757 ints
= ohci_readl(ohci
, ®s
->intrstatus
);
759 /* Check for an all 1's result which is a typical consequence
760 * of dead, unclocked, or unplugged (CardBus...) devices
762 if (ints
== ~(u32
)0) {
764 ohci_dbg (ohci
, "device removed!\n");
768 /* We only care about interrupts that are enabled */
769 ints
&= ohci_readl(ohci
, ®s
->intrenable
);
771 /* interrupt for some other device? */
775 if (ints
& OHCI_INTR_UE
) {
776 // e.g. due to PCI Master/Target Abort
777 if (quirk_nec(ohci
)) {
778 /* Workaround for a silicon bug in some NEC chips used
779 * in Apple's PowerBooks. Adapted from Darwin code.
781 ohci_err (ohci
, "OHCI Unrecoverable Error, scheduling NEC chip restart\n");
783 ohci_writel (ohci
, OHCI_INTR_UE
, ®s
->intrdisable
);
785 schedule_work (&ohci
->nec_work
);
788 ohci_err (ohci
, "OHCI Unrecoverable Error, disabled\n");
792 ohci_usb_reset (ohci
);
795 if (ints
& OHCI_INTR_RHSC
) {
796 ohci_vdbg(ohci
, "rhsc\n");
797 ohci
->next_statechange
= jiffies
+ STATECHANGE_DELAY
;
798 ohci_writel(ohci
, OHCI_INTR_RD
| OHCI_INTR_RHSC
,
801 /* NOTE: Vendors didn't always make the same implementation
802 * choices for RHSC. Many followed the spec; RHSC triggers
803 * on an edge, like setting and maybe clearing a port status
804 * change bit. With others it's level-triggered, active
805 * until khubd clears all the port status change bits. We'll
806 * always disable it here and rely on polling until khubd
809 ohci_writel(ohci
, OHCI_INTR_RHSC
, ®s
->intrdisable
);
810 usb_hcd_poll_rh_status(hcd
);
813 /* For connect and disconnect events, we expect the controller
814 * to turn on RHSC along with RD. But for remote wakeup events
815 * this might not happen.
817 else if (ints
& OHCI_INTR_RD
) {
818 ohci_vdbg(ohci
, "resume detect\n");
819 ohci_writel(ohci
, OHCI_INTR_RD
, ®s
->intrstatus
);
821 if (ohci
->autostop
) {
822 spin_lock (&ohci
->lock
);
823 ohci_rh_resume (ohci
);
824 spin_unlock (&ohci
->lock
);
826 usb_hcd_resume_root_hub(hcd
);
829 if (ints
& OHCI_INTR_WDH
) {
830 spin_lock (&ohci
->lock
);
832 spin_unlock (&ohci
->lock
);
835 if (quirk_zfmicro(ohci
) && (ints
& OHCI_INTR_SF
)) {
836 spin_lock(&ohci
->lock
);
837 if (ohci
->ed_to_check
) {
838 struct ed
*ed
= ohci
->ed_to_check
;
840 if (check_ed(ohci
, ed
)) {
841 /* HC thinks the TD list is empty; HCD knows
842 * at least one TD is outstanding
844 if (--ohci
->zf_delay
== 0) {
845 struct td
*td
= list_entry(
849 "Reclaiming orphan TD %p\n",
851 takeback_td(ohci
, td
);
852 ohci
->ed_to_check
= NULL
;
855 ohci
->ed_to_check
= NULL
;
857 spin_unlock(&ohci
->lock
);
860 /* could track INTR_SO to reduce available PCI/... bandwidth */
862 /* handle any pending URB/ED unlinks, leaving INTR_SF enabled
863 * when there's still unlinking to be done (next frame).
865 spin_lock (&ohci
->lock
);
866 if (ohci
->ed_rm_list
)
867 finish_unlinks (ohci
, ohci_frame_no(ohci
));
868 if ((ints
& OHCI_INTR_SF
) != 0
870 && !ohci
->ed_to_check
871 && HC_IS_RUNNING(hcd
->state
))
872 ohci_writel (ohci
, OHCI_INTR_SF
, ®s
->intrdisable
);
873 spin_unlock (&ohci
->lock
);
875 if (HC_IS_RUNNING(hcd
->state
)) {
876 ohci_writel (ohci
, ints
, ®s
->intrstatus
);
877 ohci_writel (ohci
, OHCI_INTR_MIE
, ®s
->intrenable
);
878 // flush those writes
879 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
885 /*-------------------------------------------------------------------------*/
887 static void ohci_stop (struct usb_hcd
*hcd
)
889 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
893 flush_scheduled_work();
895 ohci_usb_reset (ohci
);
896 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
897 free_irq(hcd
->irq
, hcd
);
900 if (quirk_zfmicro(ohci
))
901 del_timer(&ohci
->unlink_watchdog
);
902 if (quirk_amdiso(ohci
))
905 remove_debug_files (ohci
);
906 ohci_mem_cleanup (ohci
);
908 dma_free_coherent (hcd
->self
.controller
,
910 ohci
->hcca
, ohci
->hcca_dma
);
916 /*-------------------------------------------------------------------------*/
918 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
920 /* must not be called from interrupt context */
921 static int ohci_restart (struct ohci_hcd
*ohci
)
925 struct urb_priv
*priv
;
927 spin_lock_irq(&ohci
->lock
);
930 /* Recycle any "live" eds/tds (and urbs). */
931 if (!list_empty (&ohci
->pending
))
932 ohci_dbg(ohci
, "abort schedule...\n");
933 list_for_each_entry (priv
, &ohci
->pending
, pending
) {
934 struct urb
*urb
= priv
->td
[0]->urb
;
935 struct ed
*ed
= priv
->ed
;
939 ed
->state
= ED_UNLINK
;
940 ed
->hwINFO
|= cpu_to_hc32(ohci
, ED_DEQUEUE
);
941 ed_deschedule (ohci
, ed
);
943 ed
->ed_next
= ohci
->ed_rm_list
;
945 ohci
->ed_rm_list
= ed
;
950 ohci_dbg(ohci
, "bogus ed %p state %d\n",
955 urb
->unlinked
= -ESHUTDOWN
;
957 finish_unlinks (ohci
, 0);
958 spin_unlock_irq(&ohci
->lock
);
960 /* paranoia, in case that didn't work: */
962 /* empty the interrupt branches */
963 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->load
[i
] = 0;
964 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->hcca
->int_table
[i
] = 0;
966 /* no EDs to remove */
967 ohci
->ed_rm_list
= NULL
;
969 /* empty control and bulk lists */
970 ohci
->ed_controltail
= NULL
;
971 ohci
->ed_bulktail
= NULL
;
973 if ((temp
= ohci_run (ohci
)) < 0) {
974 ohci_err (ohci
, "can't restart, %d\n", temp
);
977 ohci_dbg(ohci
, "restart complete\n");
983 /*-------------------------------------------------------------------------*/
985 MODULE_AUTHOR (DRIVER_AUTHOR
);
986 MODULE_DESCRIPTION(DRIVER_DESC
);
987 MODULE_LICENSE ("GPL");
990 #include "ohci-pci.c"
991 #define PCI_DRIVER ohci_pci_driver
994 #if defined(CONFIG_ARCH_SA1100) && defined(CONFIG_SA1111)
995 #include "ohci-sa1111.c"
996 #define SA1111_DRIVER ohci_hcd_sa1111_driver
999 #if defined(CONFIG_ARCH_S3C2410) || defined(CONFIG_ARCH_S3C64XX)
1000 #include "ohci-s3c2410.c"
1001 #define PLATFORM_DRIVER ohci_hcd_s3c2410_driver
1004 #ifdef CONFIG_ARCH_OMAP
1005 #include "ohci-omap.c"
1006 #define PLATFORM_DRIVER ohci_hcd_omap_driver
1009 #ifdef CONFIG_ARCH_LH7A404
1010 #include "ohci-lh7a404.c"
1011 #define PLATFORM_DRIVER ohci_hcd_lh7a404_driver
1014 #if defined(CONFIG_PXA27x) || defined(CONFIG_PXA3xx)
1015 #include "ohci-pxa27x.c"
1016 #define PLATFORM_DRIVER ohci_hcd_pxa27x_driver
1019 #ifdef CONFIG_ARCH_EP93XX
1020 #include "ohci-ep93xx.c"
1021 #define PLATFORM_DRIVER ohci_hcd_ep93xx_driver
1024 #ifdef CONFIG_SOC_AU1X00
1025 #include "ohci-au1xxx.c"
1026 #define PLATFORM_DRIVER ohci_hcd_au1xxx_driver
1029 #ifdef CONFIG_PNX8550
1030 #include "ohci-pnx8550.c"
1031 #define PLATFORM_DRIVER ohci_hcd_pnx8550_driver
1034 #ifdef CONFIG_USB_OHCI_HCD_PPC_SOC
1035 #include "ohci-ppc-soc.c"
1036 #define PLATFORM_DRIVER ohci_hcd_ppc_soc_driver
1039 #ifdef CONFIG_ARCH_AT91
1040 #include "ohci-at91.c"
1041 #define PLATFORM_DRIVER ohci_hcd_at91_driver
1044 #ifdef CONFIG_ARCH_PNX4008
1045 #include "ohci-pnx4008.c"
1046 #define PLATFORM_DRIVER usb_hcd_pnx4008_driver
1049 #if defined(CONFIG_CPU_SUBTYPE_SH7720) || \
1050 defined(CONFIG_CPU_SUBTYPE_SH7721) || \
1051 defined(CONFIG_CPU_SUBTYPE_SH7763) || \
1052 defined(CONFIG_CPU_SUBTYPE_SH7786)
1053 #include "ohci-sh.c"
1054 #define PLATFORM_DRIVER ohci_hcd_sh_driver
1058 #ifdef CONFIG_USB_OHCI_HCD_PPC_OF
1059 #include "ohci-ppc-of.c"
1060 #define OF_PLATFORM_DRIVER ohci_hcd_ppc_of_driver
1063 #ifdef CONFIG_PPC_PS3
1064 #include "ohci-ps3.c"
1065 #define PS3_SYSTEM_BUS_DRIVER ps3_ohci_driver
1068 #ifdef CONFIG_USB_OHCI_HCD_SSB
1069 #include "ohci-ssb.c"
1070 #define SSB_OHCI_DRIVER ssb_ohci_driver
1073 #ifdef CONFIG_MFD_SM501
1074 #include "ohci-sm501.c"
1075 #define SM501_OHCI_DRIVER ohci_hcd_sm501_driver
1078 #ifdef CONFIG_MFD_TC6393XB
1079 #include "ohci-tmio.c"
1080 #define TMIO_OHCI_DRIVER ohci_hcd_tmio_driver
1083 #if !defined(PCI_DRIVER) && \
1084 !defined(PLATFORM_DRIVER) && \
1085 !defined(OF_PLATFORM_DRIVER) && \
1086 !defined(SA1111_DRIVER) && \
1087 !defined(PS3_SYSTEM_BUS_DRIVER) && \
1088 !defined(SM501_OHCI_DRIVER) && \
1089 !defined(TMIO_OHCI_DRIVER) && \
1090 !defined(SSB_OHCI_DRIVER)
1091 #error "missing bus glue for ohci-hcd"
1094 static int __init
ohci_hcd_mod_init(void)
1101 printk(KERN_INFO
"%s: " DRIVER_DESC
"\n", hcd_name
);
1102 pr_debug ("%s: block sizes: ed %Zd td %Zd\n", hcd_name
,
1103 sizeof (struct ed
), sizeof (struct td
));
1104 set_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1107 ohci_debug_root
= debugfs_create_dir("ohci", usb_debug_root
);
1108 if (!ohci_debug_root
) {
1114 #ifdef PS3_SYSTEM_BUS_DRIVER
1115 retval
= ps3_ohci_driver_register(&PS3_SYSTEM_BUS_DRIVER
);
1120 #ifdef PLATFORM_DRIVER
1121 retval
= platform_driver_register(&PLATFORM_DRIVER
);
1123 goto error_platform
;
1126 #ifdef OF_PLATFORM_DRIVER
1127 retval
= of_register_platform_driver(&OF_PLATFORM_DRIVER
);
1129 goto error_of_platform
;
1132 #ifdef SA1111_DRIVER
1133 retval
= sa1111_driver_register(&SA1111_DRIVER
);
1139 retval
= pci_register_driver(&PCI_DRIVER
);
1144 #ifdef SSB_OHCI_DRIVER
1145 retval
= ssb_driver_register(&SSB_OHCI_DRIVER
);
1150 #ifdef SM501_OHCI_DRIVER
1151 retval
= platform_driver_register(&SM501_OHCI_DRIVER
);
1156 #ifdef TMIO_OHCI_DRIVER
1157 retval
= platform_driver_register(&TMIO_OHCI_DRIVER
);
1165 #ifdef TMIO_OHCI_DRIVER
1166 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1169 #ifdef SM501_OHCI_DRIVER
1170 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1173 #ifdef SSB_OHCI_DRIVER
1174 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1178 pci_unregister_driver(&PCI_DRIVER
);
1181 #ifdef SA1111_DRIVER
1182 sa1111_driver_unregister(&SA1111_DRIVER
);
1185 #ifdef OF_PLATFORM_DRIVER
1186 of_unregister_platform_driver(&OF_PLATFORM_DRIVER
);
1189 #ifdef PLATFORM_DRIVER
1190 platform_driver_unregister(&PLATFORM_DRIVER
);
1193 #ifdef PS3_SYSTEM_BUS_DRIVER
1194 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1198 debugfs_remove(ohci_debug_root
);
1199 ohci_debug_root
= NULL
;
1203 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1206 module_init(ohci_hcd_mod_init
);
1208 static void __exit
ohci_hcd_mod_exit(void)
1210 #ifdef TMIO_OHCI_DRIVER
1211 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1213 #ifdef SM501_OHCI_DRIVER
1214 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1216 #ifdef SSB_OHCI_DRIVER
1217 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1220 pci_unregister_driver(&PCI_DRIVER
);
1222 #ifdef SA1111_DRIVER
1223 sa1111_driver_unregister(&SA1111_DRIVER
);
1225 #ifdef OF_PLATFORM_DRIVER
1226 of_unregister_platform_driver(&OF_PLATFORM_DRIVER
);
1228 #ifdef PLATFORM_DRIVER
1229 platform_driver_unregister(&PLATFORM_DRIVER
);
1231 #ifdef PS3_SYSTEM_BUS_DRIVER
1232 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1235 debugfs_remove(ohci_debug_root
);
1237 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1239 module_exit(ohci_hcd_mod_exit
);