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/reboot.h>
38 #include <linux/workqueue.h>
39 #include <linux/debugfs.h>
43 #include <asm/system.h>
44 #include <asm/unaligned.h>
45 #include <asm/byteorder.h>
47 #include "../core/hcd.h"
49 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
50 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
52 /*-------------------------------------------------------------------------*/
54 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
56 /* For initializing controller (mask in an HCFS mode too) */
57 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
58 #define OHCI_INTR_INIT \
59 (OHCI_INTR_MIE | OHCI_INTR_RHSC | OHCI_INTR_UE \
60 | OHCI_INTR_RD | OHCI_INTR_WDH)
63 /* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
67 #ifdef CONFIG_ARCH_OMAP
68 /* OMAP doesn't support IR (no SMM; not needed) */
72 /*-------------------------------------------------------------------------*/
74 static const char hcd_name
[] = "ohci_hcd";
76 #define STATECHANGE_DELAY msecs_to_jiffies(300)
80 static void ohci_dump (struct ohci_hcd
*ohci
, int verbose
);
81 static int ohci_init (struct ohci_hcd
*ohci
);
82 static void ohci_stop (struct usb_hcd
*hcd
);
84 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
85 static int ohci_restart (struct ohci_hcd
*ohci
);
89 static void quirk_amd_pll(int state
);
90 static void amd_iso_dev_put(void);
92 static inline void quirk_amd_pll(int state
)
96 static inline void amd_iso_dev_put(void)
103 #include "ohci-hub.c"
104 #include "ohci-dbg.c"
105 #include "ohci-mem.c"
110 * On architectures with edge-triggered interrupts we must never return
113 #if defined(CONFIG_SA1111) /* ... or other edge-triggered systems */
114 #define IRQ_NOTMINE IRQ_HANDLED
116 #define IRQ_NOTMINE IRQ_NONE
120 /* Some boards misreport power switching/overcurrent */
121 static int distrust_firmware
= 1;
122 module_param (distrust_firmware
, bool, 0);
123 MODULE_PARM_DESC (distrust_firmware
,
124 "true to distrust firmware power/overcurrent setup");
126 /* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */
127 static int no_handshake
= 0;
128 module_param (no_handshake
, bool, 0);
129 MODULE_PARM_DESC (no_handshake
, "true (not default) disables BIOS handshake");
131 /*-------------------------------------------------------------------------*/
134 * queue up an urb for anything except the root hub
136 static int ohci_urb_enqueue (
141 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
143 urb_priv_t
*urb_priv
;
144 unsigned int pipe
= urb
->pipe
;
149 #ifdef OHCI_VERBOSE_DEBUG
150 urb_print(urb
, "SUB", usb_pipein(pipe
), -EINPROGRESS
);
153 /* every endpoint has a ed, locate and maybe (re)initialize it */
154 if (! (ed
= ed_get (ohci
, urb
->ep
, urb
->dev
, pipe
, urb
->interval
)))
157 /* for the private part of the URB we need the number of TDs (size) */
160 /* td_submit_urb() doesn't yet handle these */
161 if (urb
->transfer_buffer_length
> 4096)
164 /* 1 TD for setup, 1 for ACK, plus ... */
167 // case PIPE_INTERRUPT:
170 /* one TD for every 4096 Bytes (can be upto 8K) */
171 size
+= urb
->transfer_buffer_length
/ 4096;
172 /* ... and for any remaining bytes ... */
173 if ((urb
->transfer_buffer_length
% 4096) != 0)
175 /* ... and maybe a zero length packet to wrap it up */
178 else if ((urb
->transfer_flags
& URB_ZERO_PACKET
) != 0
179 && (urb
->transfer_buffer_length
180 % usb_maxpacket (urb
->dev
, pipe
,
181 usb_pipeout (pipe
))) == 0)
184 case PIPE_ISOCHRONOUS
: /* number of packets from URB */
185 size
= urb
->number_of_packets
;
189 /* allocate the private part of the URB */
190 urb_priv
= kzalloc (sizeof (urb_priv_t
) + size
* sizeof (struct td
*),
194 INIT_LIST_HEAD (&urb_priv
->pending
);
195 urb_priv
->length
= size
;
198 /* allocate the TDs (deferring hash chain updates) */
199 for (i
= 0; i
< size
; i
++) {
200 urb_priv
->td
[i
] = td_alloc (ohci
, mem_flags
);
201 if (!urb_priv
->td
[i
]) {
202 urb_priv
->length
= i
;
203 urb_free_priv (ohci
, urb_priv
);
208 spin_lock_irqsave (&ohci
->lock
, flags
);
210 /* don't submit to a dead HC */
211 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)) {
215 if (!HC_IS_RUNNING(hcd
->state
)) {
219 retval
= usb_hcd_link_urb_to_ep(hcd
, urb
);
223 /* schedule the ed if needed */
224 if (ed
->state
== ED_IDLE
) {
225 retval
= ed_schedule (ohci
, ed
);
227 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
230 if (ed
->type
== PIPE_ISOCHRONOUS
) {
231 u16 frame
= ohci_frame_no(ohci
);
233 /* delay a few frames before the first TD */
234 frame
+= max_t (u16
, 8, ed
->interval
);
235 frame
&= ~(ed
->interval
- 1);
237 urb
->start_frame
= frame
;
239 /* yes, only URB_ISO_ASAP is supported, and
240 * urb->start_frame is never used as input.
243 } else if (ed
->type
== PIPE_ISOCHRONOUS
)
244 urb
->start_frame
= ed
->last_iso
+ ed
->interval
;
246 /* fill the TDs and link them to the ed; and
247 * enable that part of the schedule, if needed
248 * and update count of queued periodic urbs
250 urb
->hcpriv
= urb_priv
;
251 td_submit_urb (ohci
, urb
);
255 urb_free_priv (ohci
, urb_priv
);
256 spin_unlock_irqrestore (&ohci
->lock
, flags
);
261 * decouple the URB from the HC queues (TDs, urb_priv).
262 * reporting is always done
263 * asynchronously, and we might be dealing with an urb that's
264 * partially transferred, or an ED with other urbs being unlinked.
266 static int ohci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
268 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
272 #ifdef OHCI_VERBOSE_DEBUG
273 urb_print(urb
, "UNLINK", 1, status
);
276 spin_lock_irqsave (&ohci
->lock
, flags
);
277 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
280 } else if (HC_IS_RUNNING(hcd
->state
)) {
281 urb_priv_t
*urb_priv
;
283 /* Unless an IRQ completed the unlink while it was being
284 * handed to us, flag it for unlink and giveback, and force
285 * some upcoming INTR_SF to call finish_unlinks()
287 urb_priv
= urb
->hcpriv
;
289 if (urb_priv
->ed
->state
== ED_OPER
)
290 start_ed_unlink (ohci
, urb_priv
->ed
);
294 * with HC dead, we won't respect hc queue pointers
295 * any more ... just clean up every urb's memory.
298 finish_urb(ohci
, urb
, status
);
300 spin_unlock_irqrestore (&ohci
->lock
, flags
);
304 /*-------------------------------------------------------------------------*/
306 /* frees config/altsetting state for endpoints,
307 * including ED memory, dummy TD, and bulk/intr data toggle
311 ohci_endpoint_disable (struct usb_hcd
*hcd
, struct usb_host_endpoint
*ep
)
313 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
315 struct ed
*ed
= ep
->hcpriv
;
316 unsigned limit
= 1000;
318 /* ASSERT: any requests/urbs are being unlinked */
319 /* ASSERT: nobody can be submitting urbs for this any more */
325 spin_lock_irqsave (&ohci
->lock
, flags
);
327 if (!HC_IS_RUNNING (hcd
->state
)) {
330 if (quirk_zfmicro(ohci
) && ed
->type
== PIPE_INTERRUPT
)
331 ohci
->eds_scheduled
--;
332 finish_unlinks (ohci
, 0);
336 case ED_UNLINK
: /* wait for hw to finish? */
337 /* major IRQ delivery trouble loses INTR_SF too... */
339 ohci_warn(ohci
, "ED unlink timeout\n");
340 if (quirk_zfmicro(ohci
)) {
341 ohci_warn(ohci
, "Attempting ZF TD recovery\n");
342 ohci
->ed_to_check
= ed
;
347 spin_unlock_irqrestore (&ohci
->lock
, flags
);
348 schedule_timeout_uninterruptible(1);
350 case ED_IDLE
: /* fully unlinked */
351 if (list_empty (&ed
->td_list
)) {
352 td_free (ohci
, ed
->dummy
);
356 /* else FALL THROUGH */
358 /* caller was supposed to have unlinked any requests;
359 * that's not our job. can't recover; must leak ed.
361 ohci_err (ohci
, "leak ed %p (#%02x) state %d%s\n",
362 ed
, ep
->desc
.bEndpointAddress
, ed
->state
,
363 list_empty (&ed
->td_list
) ? "" : " (has tds)");
364 td_free (ohci
, ed
->dummy
);
368 spin_unlock_irqrestore (&ohci
->lock
, flags
);
372 static int ohci_get_frame (struct usb_hcd
*hcd
)
374 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
376 return ohci_frame_no(ohci
);
379 static void ohci_usb_reset (struct ohci_hcd
*ohci
)
381 ohci
->hc_control
= ohci_readl (ohci
, &ohci
->regs
->control
);
382 ohci
->hc_control
&= OHCI_CTRL_RWC
;
383 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
386 /* ohci_shutdown forcibly disables IRQs and DMA, helping kexec and
387 * other cases where the next software may expect clean state from the
388 * "firmware". this is bus-neutral, unlike shutdown() methods.
391 ohci_shutdown (struct usb_hcd
*hcd
)
393 struct ohci_hcd
*ohci
;
395 ohci
= hcd_to_ohci (hcd
);
396 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
397 ohci_usb_reset (ohci
);
398 /* flush the writes */
399 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
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 temp
= ohci_readl (ohci
, &ohci
->regs
->fminterval
);
584 ohci
->fminterval
= temp
& 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. Either way, if wakeup should be enabled
597 * but isn't, we'll enable it now.
599 if ((ohci
->hc_control
& OHCI_CTRL_RWC
) != 0
600 && !device_can_wakeup(hcd
->self
.controller
))
601 device_init_wakeup(hcd
->self
.controller
, 1);
603 switch (ohci
->hc_control
& OHCI_CTRL_HCFS
) {
607 case OHCI_USB_SUSPEND
:
608 case OHCI_USB_RESUME
:
609 ohci
->hc_control
&= OHCI_CTRL_RWC
;
610 ohci
->hc_control
|= OHCI_USB_RESUME
;
611 temp
= 10 /* msec wait */;
613 // case OHCI_USB_RESET:
615 ohci
->hc_control
&= OHCI_CTRL_RWC
;
616 ohci
->hc_control
|= OHCI_USB_RESET
;
617 temp
= 50 /* msec wait */;
620 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
622 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
625 memset (ohci
->hcca
, 0, sizeof (struct ohci_hcca
));
627 /* 2msec timelimit here means no irqs/preempt */
628 spin_lock_irq (&ohci
->lock
);
631 /* HC Reset requires max 10 us delay */
632 ohci_writel (ohci
, OHCI_HCR
, &ohci
->regs
->cmdstatus
);
633 temp
= 30; /* ... allow extra time */
634 while ((ohci_readl (ohci
, &ohci
->regs
->cmdstatus
) & OHCI_HCR
) != 0) {
636 spin_unlock_irq (&ohci
->lock
);
637 ohci_err (ohci
, "USB HC reset timed out!\n");
643 /* now we're in the SUSPEND state ... must go OPERATIONAL
644 * within 2msec else HC enters RESUME
646 * ... but some hardware won't init fmInterval "by the book"
647 * (SiS, OPTi ...), so reset again instead. SiS doesn't need
648 * this if we write fmInterval after we're OPERATIONAL.
649 * Unclear about ALi, ServerWorks, and others ... this could
650 * easily be a longstanding bug in chip init on Linux.
652 if (ohci
->flags
& OHCI_QUIRK_INITRESET
) {
653 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
654 // flush those writes
655 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
658 /* Tell the controller where the control and bulk lists are
659 * The lists are empty now. */
660 ohci_writel (ohci
, 0, &ohci
->regs
->ed_controlhead
);
661 ohci_writel (ohci
, 0, &ohci
->regs
->ed_bulkhead
);
663 /* a reset clears this */
664 ohci_writel (ohci
, (u32
) ohci
->hcca_dma
, &ohci
->regs
->hcca
);
666 periodic_reinit (ohci
);
668 /* some OHCI implementations are finicky about how they init.
669 * bogus values here mean not even enumeration could work.
671 if ((ohci_readl (ohci
, &ohci
->regs
->fminterval
) & 0x3fff0000) == 0
672 || !ohci_readl (ohci
, &ohci
->regs
->periodicstart
)) {
673 if (!(ohci
->flags
& OHCI_QUIRK_INITRESET
)) {
674 ohci
->flags
|= OHCI_QUIRK_INITRESET
;
675 ohci_dbg (ohci
, "enabling initreset quirk\n");
678 spin_unlock_irq (&ohci
->lock
);
679 ohci_err (ohci
, "init err (%08x %04x)\n",
680 ohci_readl (ohci
, &ohci
->regs
->fminterval
),
681 ohci_readl (ohci
, &ohci
->regs
->periodicstart
));
685 /* use rhsc irqs after khubd is fully initialized */
687 hcd
->uses_new_polling
= 1;
689 /* start controller operations */
690 ohci
->hc_control
&= OHCI_CTRL_RWC
;
691 ohci
->hc_control
|= OHCI_CONTROL_INIT
| OHCI_USB_OPER
;
692 ohci_writel (ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
693 hcd
->state
= HC_STATE_RUNNING
;
695 /* wake on ConnectStatusChange, matching external hubs */
696 ohci_writel (ohci
, RH_HS_DRWE
, &ohci
->regs
->roothub
.status
);
698 /* Choose the interrupts we care about now, others later on demand */
699 mask
= OHCI_INTR_INIT
;
700 ohci_writel (ohci
, ~0, &ohci
->regs
->intrstatus
);
701 ohci_writel (ohci
, mask
, &ohci
->regs
->intrenable
);
703 /* handle root hub init quirks ... */
704 temp
= roothub_a (ohci
);
705 temp
&= ~(RH_A_PSM
| RH_A_OCPM
);
706 if (ohci
->flags
& OHCI_QUIRK_SUPERIO
) {
707 /* NSC 87560 and maybe others */
709 temp
&= ~(RH_A_POTPGT
| RH_A_NPS
);
710 ohci_writel (ohci
, temp
, &ohci
->regs
->roothub
.a
);
711 } else if ((ohci
->flags
& OHCI_QUIRK_AMD756
) ||
712 (ohci
->flags
& OHCI_QUIRK_HUB_POWER
)) {
713 /* hub power always on; required for AMD-756 and some
714 * Mac platforms. ganged overcurrent reporting, if any.
717 ohci_writel (ohci
, temp
, &ohci
->regs
->roothub
.a
);
719 ohci_writel (ohci
, RH_HS_LPSC
, &ohci
->regs
->roothub
.status
);
720 ohci_writel (ohci
, (temp
& RH_A_NPS
) ? 0 : RH_B_PPCM
,
721 &ohci
->regs
->roothub
.b
);
722 // flush those writes
723 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
725 ohci
->next_statechange
= jiffies
+ STATECHANGE_DELAY
;
726 spin_unlock_irq (&ohci
->lock
);
728 // POTPGT delay is bits 24-31, in 2 ms units.
729 mdelay ((temp
>> 23) & 0x1fe);
730 hcd
->state
= HC_STATE_RUNNING
;
732 if (quirk_zfmicro(ohci
)) {
733 /* Create timer to watch for bad queue state on ZF Micro */
734 setup_timer(&ohci
->unlink_watchdog
, unlink_watchdog_func
,
735 (unsigned long) ohci
);
737 ohci
->eds_scheduled
= 0;
738 ohci
->ed_to_check
= NULL
;
746 /*-------------------------------------------------------------------------*/
748 /* an interrupt happens */
750 static irqreturn_t
ohci_irq (struct usb_hcd
*hcd
)
752 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
753 struct ohci_regs __iomem
*regs
= ohci
->regs
;
756 /* Read interrupt status (and flush pending writes). We ignore the
757 * optimization of checking the LSB of hcca->done_head; it doesn't
758 * work on all systems (edge triggering for OHCI can be a factor).
760 ints
= ohci_readl(ohci
, ®s
->intrstatus
);
762 /* Check for an all 1's result which is a typical consequence
763 * of dead, unclocked, or unplugged (CardBus...) devices
765 if (ints
== ~(u32
)0) {
767 ohci_dbg (ohci
, "device removed!\n");
771 /* We only care about interrupts that are enabled */
772 ints
&= ohci_readl(ohci
, ®s
->intrenable
);
774 /* interrupt for some other device? */
778 if (ints
& OHCI_INTR_UE
) {
779 // e.g. due to PCI Master/Target Abort
780 if (quirk_nec(ohci
)) {
781 /* Workaround for a silicon bug in some NEC chips used
782 * in Apple's PowerBooks. Adapted from Darwin code.
784 ohci_err (ohci
, "OHCI Unrecoverable Error, scheduling NEC chip restart\n");
786 ohci_writel (ohci
, OHCI_INTR_UE
, ®s
->intrdisable
);
788 schedule_work (&ohci
->nec_work
);
791 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
);
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
);
896 flush_scheduled_work();
898 ohci_usb_reset (ohci
);
899 ohci_writel (ohci
, OHCI_INTR_MIE
, &ohci
->regs
->intrdisable
);
900 free_irq(hcd
->irq
, hcd
);
903 if (quirk_zfmicro(ohci
))
904 del_timer(&ohci
->unlink_watchdog
);
905 if (quirk_amdiso(ohci
))
908 remove_debug_files (ohci
);
909 ohci_mem_cleanup (ohci
);
911 dma_free_coherent (hcd
->self
.controller
,
913 ohci
->hcca
, ohci
->hcca_dma
);
919 /*-------------------------------------------------------------------------*/
921 #if defined(CONFIG_PM) || defined(CONFIG_PCI)
923 /* must not be called from interrupt context */
924 static int ohci_restart (struct ohci_hcd
*ohci
)
928 struct urb_priv
*priv
;
930 spin_lock_irq(&ohci
->lock
);
933 /* Recycle any "live" eds/tds (and urbs). */
934 if (!list_empty (&ohci
->pending
))
935 ohci_dbg(ohci
, "abort schedule...\n");
936 list_for_each_entry (priv
, &ohci
->pending
, pending
) {
937 struct urb
*urb
= priv
->td
[0]->urb
;
938 struct ed
*ed
= priv
->ed
;
942 ed
->state
= ED_UNLINK
;
943 ed
->hwINFO
|= cpu_to_hc32(ohci
, ED_DEQUEUE
);
944 ed_deschedule (ohci
, ed
);
946 ed
->ed_next
= ohci
->ed_rm_list
;
948 ohci
->ed_rm_list
= ed
;
953 ohci_dbg(ohci
, "bogus ed %p state %d\n",
958 urb
->unlinked
= -ESHUTDOWN
;
960 finish_unlinks (ohci
, 0);
961 spin_unlock_irq(&ohci
->lock
);
963 /* paranoia, in case that didn't work: */
965 /* empty the interrupt branches */
966 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->load
[i
] = 0;
967 for (i
= 0; i
< NUM_INTS
; i
++) ohci
->hcca
->int_table
[i
] = 0;
969 /* no EDs to remove */
970 ohci
->ed_rm_list
= NULL
;
972 /* empty control and bulk lists */
973 ohci
->ed_controltail
= NULL
;
974 ohci
->ed_bulktail
= NULL
;
976 if ((temp
= ohci_run (ohci
)) < 0) {
977 ohci_err (ohci
, "can't restart, %d\n", temp
);
980 ohci_dbg(ohci
, "restart complete\n");
986 /*-------------------------------------------------------------------------*/
988 MODULE_AUTHOR (DRIVER_AUTHOR
);
989 MODULE_DESCRIPTION(DRIVER_DESC
);
990 MODULE_LICENSE ("GPL");
993 #include "ohci-pci.c"
994 #define PCI_DRIVER ohci_pci_driver
997 #if defined(CONFIG_ARCH_SA1100) && defined(CONFIG_SA1111)
998 #include "ohci-sa1111.c"
999 #define SA1111_DRIVER ohci_hcd_sa1111_driver
1002 #ifdef CONFIG_ARCH_S3C2410
1003 #include "ohci-s3c2410.c"
1004 #define PLATFORM_DRIVER ohci_hcd_s3c2410_driver
1007 #ifdef CONFIG_ARCH_OMAP
1008 #include "ohci-omap.c"
1009 #define PLATFORM_DRIVER ohci_hcd_omap_driver
1012 #ifdef CONFIG_ARCH_LH7A404
1013 #include "ohci-lh7a404.c"
1014 #define PLATFORM_DRIVER ohci_hcd_lh7a404_driver
1017 #if defined(CONFIG_PXA27x) || defined(CONFIG_PXA3xx)
1018 #include "ohci-pxa27x.c"
1019 #define PLATFORM_DRIVER ohci_hcd_pxa27x_driver
1022 #ifdef CONFIG_ARCH_EP93XX
1023 #include "ohci-ep93xx.c"
1024 #define PLATFORM_DRIVER ohci_hcd_ep93xx_driver
1027 #ifdef CONFIG_SOC_AU1X00
1028 #include "ohci-au1xxx.c"
1029 #define PLATFORM_DRIVER ohci_hcd_au1xxx_driver
1032 #ifdef CONFIG_PNX8550
1033 #include "ohci-pnx8550.c"
1034 #define PLATFORM_DRIVER ohci_hcd_pnx8550_driver
1037 #ifdef CONFIG_USB_OHCI_HCD_PPC_SOC
1038 #include "ohci-ppc-soc.c"
1039 #define PLATFORM_DRIVER ohci_hcd_ppc_soc_driver
1042 #ifdef CONFIG_ARCH_AT91
1043 #include "ohci-at91.c"
1044 #define PLATFORM_DRIVER ohci_hcd_at91_driver
1047 #ifdef CONFIG_ARCH_PNX4008
1048 #include "ohci-pnx4008.c"
1049 #define PLATFORM_DRIVER usb_hcd_pnx4008_driver
1052 #if defined(CONFIG_CPU_SUBTYPE_SH7720) || \
1053 defined(CONFIG_CPU_SUBTYPE_SH7721) || \
1054 defined(CONFIG_CPU_SUBTYPE_SH7763)
1055 #include "ohci-sh.c"
1056 #define PLATFORM_DRIVER ohci_hcd_sh_driver
1060 #ifdef CONFIG_USB_OHCI_HCD_PPC_OF
1061 #include "ohci-ppc-of.c"
1062 #define OF_PLATFORM_DRIVER ohci_hcd_ppc_of_driver
1065 #ifdef CONFIG_PPC_PS3
1066 #include "ohci-ps3.c"
1067 #define PS3_SYSTEM_BUS_DRIVER ps3_ohci_driver
1070 #ifdef CONFIG_USB_OHCI_HCD_SSB
1071 #include "ohci-ssb.c"
1072 #define SSB_OHCI_DRIVER ssb_ohci_driver
1075 #ifdef CONFIG_MFD_SM501
1076 #include "ohci-sm501.c"
1077 #define SM501_OHCI_DRIVER ohci_hcd_sm501_driver
1080 #ifdef CONFIG_MFD_TC6393XB
1081 #include "ohci-tmio.c"
1082 #define TMIO_OHCI_DRIVER ohci_hcd_tmio_driver
1085 #if !defined(PCI_DRIVER) && \
1086 !defined(PLATFORM_DRIVER) && \
1087 !defined(OF_PLATFORM_DRIVER) && \
1088 !defined(SA1111_DRIVER) && \
1089 !defined(PS3_SYSTEM_BUS_DRIVER) && \
1090 !defined(SM501_OHCI_DRIVER) && \
1091 !defined(TMIO_OHCI_DRIVER) && \
1092 !defined(SSB_OHCI_DRIVER)
1093 #error "missing bus glue for ohci-hcd"
1096 static int __init
ohci_hcd_mod_init(void)
1103 printk(KERN_INFO
"%s: " DRIVER_DESC
"\n", hcd_name
);
1104 pr_debug ("%s: block sizes: ed %Zd td %Zd\n", hcd_name
,
1105 sizeof (struct ed
), sizeof (struct td
));
1106 set_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1109 ohci_debug_root
= debugfs_create_dir("ohci", NULL
);
1110 if (!ohci_debug_root
) {
1116 #ifdef PS3_SYSTEM_BUS_DRIVER
1117 retval
= ps3_ohci_driver_register(&PS3_SYSTEM_BUS_DRIVER
);
1122 #ifdef PLATFORM_DRIVER
1123 retval
= platform_driver_register(&PLATFORM_DRIVER
);
1125 goto error_platform
;
1128 #ifdef OF_PLATFORM_DRIVER
1129 retval
= of_register_platform_driver(&OF_PLATFORM_DRIVER
);
1131 goto error_of_platform
;
1134 #ifdef SA1111_DRIVER
1135 retval
= sa1111_driver_register(&SA1111_DRIVER
);
1141 retval
= pci_register_driver(&PCI_DRIVER
);
1146 #ifdef SSB_OHCI_DRIVER
1147 retval
= ssb_driver_register(&SSB_OHCI_DRIVER
);
1152 #ifdef SM501_OHCI_DRIVER
1153 retval
= platform_driver_register(&SM501_OHCI_DRIVER
);
1158 #ifdef TMIO_OHCI_DRIVER
1159 retval
= platform_driver_register(&TMIO_OHCI_DRIVER
);
1167 #ifdef TMIO_OHCI_DRIVER
1168 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1171 #ifdef SM501_OHCI_DRIVER
1172 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1175 #ifdef SSB_OHCI_DRIVER
1176 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1180 pci_unregister_driver(&PCI_DRIVER
);
1183 #ifdef SA1111_DRIVER
1184 sa1111_driver_unregister(&SA1111_DRIVER
);
1187 #ifdef OF_PLATFORM_DRIVER
1188 of_unregister_platform_driver(&OF_PLATFORM_DRIVER
);
1191 #ifdef PLATFORM_DRIVER
1192 platform_driver_unregister(&PLATFORM_DRIVER
);
1195 #ifdef PS3_SYSTEM_BUS_DRIVER
1196 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1200 debugfs_remove(ohci_debug_root
);
1201 ohci_debug_root
= NULL
;
1205 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1208 module_init(ohci_hcd_mod_init
);
1210 static void __exit
ohci_hcd_mod_exit(void)
1212 #ifdef TMIO_OHCI_DRIVER
1213 platform_driver_unregister(&TMIO_OHCI_DRIVER
);
1215 #ifdef SM501_OHCI_DRIVER
1216 platform_driver_unregister(&SM501_OHCI_DRIVER
);
1218 #ifdef SSB_OHCI_DRIVER
1219 ssb_driver_unregister(&SSB_OHCI_DRIVER
);
1222 pci_unregister_driver(&PCI_DRIVER
);
1224 #ifdef SA1111_DRIVER
1225 sa1111_driver_unregister(&SA1111_DRIVER
);
1227 #ifdef OF_PLATFORM_DRIVER
1228 of_unregister_platform_driver(&OF_PLATFORM_DRIVER
);
1230 #ifdef PLATFORM_DRIVER
1231 platform_driver_unregister(&PLATFORM_DRIVER
);
1233 #ifdef PS3_SYSTEM_BUS_DRIVER
1234 ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER
);
1237 debugfs_remove(ohci_debug_root
);
1239 clear_bit(USB_OHCI_LOADED
, &usb_hcds_loaded
);
1241 module_exit(ohci_hcd_mod_exit
);