2 * OHCI HCD (Host Controller Driver) for USB.
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 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.
20 * 2003/02/24 show registers in sysfs (Kevin Brosius)
22 * 2002/09/03 get rid of ed hashtables, rework periodic scheduling and
23 * bandwidth accounting; if debugging, show schedules in driverfs
24 * 2002/07/19 fixes to management of ED and schedule state.
25 * 2002/06/09 SA-1111 support (Christopher Hoover)
26 * 2002/06/01 remember frame when HC won't see EDs any more; use that info
27 * to fix urb unlink races caused by interrupt latency assumptions;
28 * minor ED field and function naming updates
29 * 2002/01/18 package as a patch for 2.5.3; this should match the
30 * 2.4.17 kernel modulo some bugs being fixed.
32 * 2001/10/18 merge pmac cleanup (Benjamin Herrenschmidt) and bugfixes
33 * from post-2.4.5 patches.
34 * 2001/09/20 URB_ZERO_PACKET support; hcca_dma portability, OPTi warning
35 * 2001/09/07 match PCI PM changes, errnos from Linus' tree
36 * 2001/05/05 fork 2.4.5 version into "hcd" framework, cleanup, simplify;
37 * pbook pci quirks gone (please fix pbook pci sw!) (db)
39 * 2001/04/08 Identify version on module load (gb)
40 * 2001/03/24 td/ed hashing to remove bus_to_virt (Steve Longerbeam);
42 * 2001/03/21 td and dev/ed allocation uses new pci_pool API (db)
43 * 2001/03/07 hcca allocation uses pci_alloc_consistent (Steve Longerbeam)
45 * 2000/09/26 fixed races in removing the private portion of the urb
46 * 2000/09/07 disable bulk and control lists when unlinking the last
47 * endpoint descriptor in order to avoid unrecoverable errors on
48 * the Lucent chips. (rwc@sgi)
49 * 2000/08/29 use bandwidth claiming hooks (thanks Randy!), fix some
50 * urb unlink probs, indentation fixes
51 * 2000/08/11 various oops fixes mostly affecting iso and cleanup from
53 * 2000/06/28 use PCI hotplug framework, for better power management
54 * and for Cardbus support (David Brownell)
55 * 2000/earlier: fixes for NEC/Lucent chips; suspend/resume handling
56 * when the controller loses power; handle UE; cleanup; ...
58 * v5.2 1999/12/07 URB 3rd preview,
59 * v5.1 1999/11/30 URB 2nd preview, cpia, (usb-scsi)
60 * v5.0 1999/11/22 URB Technical preview, Paul Mackerras powerbook susp/resume
61 * i386: HUB, Keyboard, Mouse, Printer
63 * v4.3 1999/10/27 multiple HCs, bulk_request
64 * v4.2 1999/09/05 ISO API alpha, new dev alloc, neg Error-codes
65 * v4.1 1999/08/27 Randy Dunlap's - ISO API first impl.
68 * v2.1 1999/05/09 code clean up
70 * v1.0 1999/04/27 initial release
72 * This file is licenced under the GPL.
75 #include <linux/config.h>
77 #ifdef CONFIG_USB_DEBUG
83 #include <linux/module.h>
84 #include <linux/pci.h>
85 #include <linux/kernel.h>
86 #include <linux/delay.h>
87 #include <linux/ioport.h>
88 #include <linux/sched.h>
89 #include <linux/slab.h>
90 #include <linux/smp_lock.h>
91 #include <linux/errno.h>
92 #include <linux/init.h>
93 #include <linux/timer.h>
94 #include <linux/list.h>
95 #include <linux/interrupt.h> /* for in_interrupt () */
96 #include <linux/usb.h>
97 #include "../core/hcd.h"
101 #include <asm/system.h>
102 #include <asm/unaligned.h>
103 #include <asm/byteorder.h>
108 * - "disabled" and "sleeping" should be in hcd->state
109 * - lots more testing!!
112 #define DRIVER_VERSION "2003 Feb 24"
113 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
114 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
116 /*-------------------------------------------------------------------------*/
118 // #define OHCI_VERBOSE_DEBUG /* not always helpful */
120 /* For initializing controller (mask in an HCFS mode too) */
121 #define OHCI_CONTROL_INIT \
122 (OHCI_CTRL_CBSR & 0x3) | OHCI_CTRL_IE | OHCI_CTRL_PLE
124 #define OHCI_UNLINK_TIMEOUT (HZ / 10)
126 /*-------------------------------------------------------------------------*/
128 static const char hcd_name [] = "ohci-hcd";
132 static inline void disable (struct ohci_hcd *ohci)
135 ohci->hcd.state = USB_STATE_HALT;
138 #include "ohci-hub.c"
139 #include "ohci-dbg.c"
140 #include "ohci-mem.c"
143 /*-------------------------------------------------------------------------*/
146 * queue up an urb for anything except the root hub
148 static int ohci_urb_enqueue (
153 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
155 urb_priv_t *urb_priv;
156 unsigned int pipe = urb->pipe;
161 #ifdef OHCI_VERBOSE_DEBUG
162 urb_print (urb, "SUB", usb_pipein (pipe));
165 /* every endpoint has a ed, locate and maybe (re)initialize it */
166 if (! (ed = ed_get (ohci, urb->dev, pipe, urb->interval)))
169 /* for the private part of the URB we need the number of TDs (size) */
172 /* td_submit_urb() doesn't yet handle these */
173 if (urb->transfer_buffer_length > 4096)
176 /* 1 TD for setup, 1 for ACK, plus ... */
179 // case PIPE_INTERRUPT:
182 /* one TD for every 4096 Bytes (can be upto 8K) */
183 size += urb->transfer_buffer_length / 4096;
184 /* ... and for any remaining bytes ... */
185 if ((urb->transfer_buffer_length % 4096) != 0)
187 /* ... and maybe a zero length packet to wrap it up */
190 else if ((urb->transfer_flags & URB_ZERO_PACKET) != 0
191 && (urb->transfer_buffer_length
192 % usb_maxpacket (urb->dev, pipe,
193 usb_pipeout (pipe))) == 0)
196 case PIPE_ISOCHRONOUS: /* number of packets from URB */
197 size = urb->number_of_packets;
201 /* allocate the private part of the URB */
202 urb_priv = kmalloc (sizeof (urb_priv_t) + size * sizeof (struct td *),
206 memset (urb_priv, 0, sizeof (urb_priv_t) + size * sizeof (struct td *));
208 /* fill the private part of the URB */
209 urb_priv->length = size;
212 /* allocate the TDs (deferring hash chain updates) */
213 for (i = 0; i < size; i++) {
214 urb_priv->td [i] = td_alloc (ohci, mem_flags);
215 if (!urb_priv->td [i]) {
216 urb_priv->length = i;
217 urb_free_priv (ohci, urb_priv);
222 spin_lock_irqsave (&ohci->lock, flags);
224 /* don't submit to a dead HC */
225 if (ohci->disabled || ohci->sleeping) {
230 /* schedule the ed if needed */
231 if (ed->state == ED_IDLE) {
232 retval = ed_schedule (ohci, ed);
235 if (ed->type == PIPE_ISOCHRONOUS) {
236 u16 frame = le16_to_cpu (ohci->hcca->frame_no);
238 /* delay a few frames before the first TD */
239 frame += max_t (u16, 8, ed->interval);
240 frame &= ~(ed->interval - 1);
242 urb->start_frame = frame;
244 /* yes, only URB_ISO_ASAP is supported, and
245 * urb->start_frame is never used as input.
248 } else if (ed->type == PIPE_ISOCHRONOUS)
249 urb->start_frame = ed->last_iso + ed->interval;
251 /* fill the TDs and link them to the ed; and
252 * enable that part of the schedule, if needed
253 * and update count of queued periodic urbs
255 urb->hcpriv = urb_priv;
256 td_submit_urb (ohci, urb);
260 urb_free_priv (ohci, urb_priv);
261 spin_unlock_irqrestore (&ohci->lock, flags);
266 * decouple the URB from the HC queues (TDs, urb_priv); it's
267 * already marked using urb->status. reporting is always done
268 * asynchronously, and we might be dealing with an urb that's
269 * partially transferred, or an ED with other urbs being unlinked.
271 static int ohci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
273 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
276 #ifdef OHCI_VERBOSE_DEBUG
277 urb_print (urb, "UNLINK", 1);
280 spin_lock_irqsave (&ohci->lock, flags);
281 if (!ohci->disabled) {
282 urb_priv_t *urb_priv;
284 /* Unless an IRQ completed the unlink while it was being
285 * handed to us, flag it for unlink and giveback, and force
286 * some upcoming INTR_SF to call finish_unlinks()
288 urb_priv = urb->hcpriv;
290 urb_priv->state = URB_DEL;
291 if (urb_priv->ed->state == ED_OPER)
292 start_urb_unlink (ohci, urb_priv->ed);
296 * with HC dead, we won't respect hc queue pointers
297 * any more ... just clean up every urb's memory.
300 spin_unlock (&ohci->lock);
301 finish_urb (ohci, urb, NULL);
302 spin_lock (&ohci->lock);
305 spin_unlock_irqrestore (&ohci->lock, flags);
309 /*-------------------------------------------------------------------------*/
311 /* frees config/altsetting state for endpoints,
312 * including ED memory, dummy TD, and bulk/intr data toggle
316 ohci_endpoint_disable (struct usb_hcd *hcd, struct hcd_dev *dev, int ep)
318 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
319 int epnum = ep & USB_ENDPOINT_NUMBER_MASK;
322 unsigned limit = 1000;
324 /* ASSERT: any requests/urbs are being unlinked */
325 /* ASSERT: nobody can be submitting urbs for this any more */
328 if (epnum != 0 && !(ep & USB_DIR_IN))
332 spin_lock_irqsave (&ohci->lock, flags);
333 ed = dev->ep [epnum];
337 if (!HCD_IS_RUNNING (ohci->hcd.state) || ohci->disabled)
340 case ED_UNLINK: /* wait for hw to finish? */
341 /* major IRQ delivery trouble loses INTR_SF too... */
342 WARN_ON (limit-- == 0);
343 spin_unlock_irqrestore (&ohci->lock, flags);
344 set_current_state (TASK_UNINTERRUPTIBLE);
345 schedule_timeout (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, "ed %p (#%d) state %d%s\n",
359 ed, epnum, ed->state,
360 list_empty (&ed->td_list) ? "" : "(has tds)");
361 td_free (ohci, ed->dummy);
366 spin_unlock_irqrestore (&ohci->lock, flags);
370 static int ohci_get_frame (struct usb_hcd *hcd)
372 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
374 return le16_to_cpu (ohci->hcca->frame_no);
377 /*-------------------------------------------------------------------------*
379 *-------------------------------------------------------------------------*/
381 /* reset the HC and BUS */
383 static int hc_reset (struct ohci_hcd *ohci)
387 /* SMM owns the HC? not for long!
388 * On PA-RISC, PDC can leave IR set incorrectly; ignore it there.
391 if (readl (&ohci->regs->control) & OHCI_CTRL_IR) {
392 ohci_dbg (ohci, "USB HC TakeOver from BIOS/SMM\n");
394 /* this timeout is arbitrary. we make it long, so systems
395 * depending on usb keyboards may be usable even if the
396 * BIOS/SMM code seems pretty broken.
398 temp = 500; /* arbitrary: five seconds */
400 writel (OHCI_INTR_OC, &ohci->regs->intrenable);
401 writel (OHCI_OCR, &ohci->regs->cmdstatus);
402 while (readl (&ohci->regs->control) & OHCI_CTRL_IR) {
405 ohci_err (ohci, "USB HC TakeOver failed!\n");
412 /* Disable HC interrupts */
413 writel (OHCI_INTR_MIE, &ohci->regs->intrdisable);
415 ohci_dbg (ohci, "reset, control = 0x%x\n",
416 readl (&ohci->regs->control));
418 /* Reset USB (needed by some controllers); RemoteWakeupConnected
419 * saved if boot firmware (BIOS/SMM/...) told us it's connected
421 ohci->hc_control = readl (&ohci->regs->control);
422 ohci->hc_control &= OHCI_CTRL_RWC; /* hcfs 0 = RESET */
423 writel (ohci->hc_control, &ohci->regs->control);
424 // flush those pci writes
425 (void) readl (&ohci->regs->control);
428 /* HC Reset requires max 10 us delay */
429 writel (OHCI_HCR, &ohci->regs->cmdstatus);
430 temp = 30; /* ... allow extra time */
431 while ((readl (&ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
433 ohci_err (ohci, "USB HC reset timed out!\n");
439 /* now we're in the SUSPEND state ... must go OPERATIONAL
440 * within 2msec else HC enters RESUME
442 * ... but some hardware won't init fmInterval "by the book"
443 * (SiS, OPTi ...), so reset again instead. SiS doesn't need
444 * this if we write fmInterval after we're OPERATIONAL.
446 writel (ohci->hc_control, &ohci->regs->control);
447 // flush those pci writes
448 (void) readl (&ohci->regs->control);
453 /*-------------------------------------------------------------------------*/
455 #define FI 0x2edf /* 12000 bits per frame (-1) */
456 #define LSTHRESH 0x628 /* lowspeed bit threshold */
458 /* Start an OHCI controller, set the BUS operational
460 * connect the virtual root hub
462 static int hc_start (struct ohci_hcd *ohci)
465 struct usb_device *udev;
468 spin_lock_init (&ohci->lock);
472 /* Tell the controller where the control and bulk lists are
473 * The lists are empty now. */
474 writel (0, &ohci->regs->ed_controlhead);
475 writel (0, &ohci->regs->ed_bulkhead);
477 /* a reset clears this */
478 writel ((u32) ohci->hcca_dma, &ohci->regs->hcca);
480 /* force default fmInterval (we won't adjust it); init thresholds
481 * for last FS and LS packets, reserve 90% for periodic.
483 writel ((((6 * (FI - 210)) / 7) << 16) | FI, &ohci->regs->fminterval);
484 writel (((9 * FI) / 10) & 0x3fff, &ohci->regs->periodicstart);
485 writel (LSTHRESH, &ohci->regs->lsthresh);
487 /* some OHCI implementations are finicky about how they init.
488 * bogus values here mean not even enumeration could work.
490 if ((readl (&ohci->regs->fminterval) & 0x3fff0000) == 0
491 || !readl (&ohci->regs->periodicstart)) {
492 ohci_err (ohci, "init err\n");
496 /* start controller operations */
497 ohci->hc_control &= OHCI_CTRL_RWC;
498 ohci->hc_control |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
500 writel (ohci->hc_control, &ohci->regs->control);
502 /* Choose the interrupts we care about now, others later on demand */
503 mask = OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_WDH;
504 writel (mask, &ohci->regs->intrstatus);
505 writel (mask, &ohci->regs->intrenable);
507 /* handle root hub init quirks ... */
508 tmp = roothub_a (ohci);
509 tmp &= ~(RH_A_PSM | RH_A_OCPM);
510 if (ohci->flags & OHCI_QUIRK_SUPERIO) {
511 /* NSC 87560 and maybe others */
513 tmp &= ~(RH_A_POTPGT | RH_A_NPS);
515 /* hub power always on; required for AMD-756 and some
516 * Mac platforms, use this mode everywhere by default
520 writel (tmp, &ohci->regs->roothub.a);
521 writel (RH_HS_LPSC, &ohci->regs->roothub.status);
522 writel (0, &ohci->regs->roothub.b);
523 // flush those pci writes
524 (void) readl (&ohci->regs->control);
526 // POTPGT delay is bits 24-31, in 2 ms units.
527 mdelay ((roothub_a (ohci) >> 23) & 0x1fe);
529 /* connect the virtual root hub */
530 bus = hcd_to_bus (&ohci->hcd);
531 bus->root_hub = udev = usb_alloc_dev (NULL, bus);
532 ohci->hcd.state = USB_STATE_READY;
535 ohci->hc_control &= ~OHCI_CTRL_HCFS;
536 writel (ohci->hc_control, &ohci->regs->control);
540 udev->speed = USB_SPEED_FULL;
541 if (hcd_register_root (&ohci->hcd) != 0) {
543 bus->root_hub = NULL;
545 ohci->hc_control &= ~OHCI_CTRL_HCFS;
546 writel (ohci->hc_control, &ohci->regs->control);
553 /*-------------------------------------------------------------------------*/
555 /* an interrupt happens */
557 static void ohci_irq (struct usb_hcd *hcd, struct pt_regs *ptregs)
559 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
560 struct ohci_regs *regs = ohci->regs;
563 /* we can eliminate a (slow) readl() if _only_ WDH caused this irq */
564 if ((ohci->hcca->done_head != 0)
565 && ! (le32_to_cpup (&ohci->hcca->done_head) & 0x01)) {
566 ints = OHCI_INTR_WDH;
568 /* cardbus/... hardware gone before remove() */
569 } else if ((ints = readl (®s->intrstatus)) == ~(u32)0) {
571 ohci_dbg (ohci, "device removed!\n");
574 /* interrupt for some other device? */
575 } else if ((ints &= readl (®s->intrenable)) == 0) {
579 if (ints & OHCI_INTR_UE) {
581 ohci_err (ohci, "OHCI Unrecoverable Error, disabled\n");
582 // e.g. due to PCI Master/Target Abort
588 if (ints & OHCI_INTR_WDH) {
589 writel (OHCI_INTR_WDH, ®s->intrdisable);
590 dl_done_list (ohci, dl_reverse_done_list (ohci), ptregs);
591 writel (OHCI_INTR_WDH, ®s->intrenable);
594 /* could track INTR_SO to reduce available PCI/... bandwidth */
596 /* handle any pending URB/ED unlinks, leaving INTR_SF enabled
597 * when there's still unlinking to be done (next frame).
599 spin_lock (&ohci->lock);
600 if (ohci->ed_rm_list)
601 finish_unlinks (ohci, le16_to_cpu (ohci->hcca->frame_no),
603 if ((ints & OHCI_INTR_SF) != 0 && !ohci->ed_rm_list)
604 writel (OHCI_INTR_SF, ®s->intrdisable);
605 spin_unlock (&ohci->lock);
607 writel (ints, ®s->intrstatus);
608 writel (OHCI_INTR_MIE, ®s->intrenable);
609 // flush those pci writes
610 (void) readl (&ohci->regs->control);
613 /*-------------------------------------------------------------------------*/
615 static void ohci_stop (struct usb_hcd *hcd)
617 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
619 ohci_dbg (ohci, "stop %s controller%s\n",
620 hcfs2string (ohci->hc_control & OHCI_CTRL_HCFS),
621 ohci->disabled ? " (disabled)" : ""
628 remove_debug_files (ohci);
629 ohci_mem_cleanup (ohci);
631 pci_free_consistent (ohci->hcd.pdev, sizeof *ohci->hcca,
632 ohci->hcca, ohci->hcca_dma);
638 /*-------------------------------------------------------------------------*/
640 // FIXME: this restart logic should be generic,
641 // and handle full hcd state cleanup
643 /* controller died; cleanup debris, then restart */
644 /* must not be called from interrupt context */
647 static int hc_restart (struct ohci_hcd *ohci)
654 if (hcd_to_bus (&ohci->hcd)->root_hub)
655 usb_disconnect (&hcd_to_bus (&ohci->hcd)->root_hub);
657 /* empty the interrupt branches */
658 for (i = 0; i < NUM_INTS; i++) ohci->load [i] = 0;
659 for (i = 0; i < NUM_INTS; i++) ohci->hcca->int_table [i] = 0;
661 /* no EDs to remove */
662 ohci->ed_rm_list = NULL;
664 /* empty control and bulk lists */
665 ohci->ed_controltail = NULL;
666 ohci->ed_bulktail = NULL;
668 if ((temp = hc_reset (ohci)) < 0 || (temp = hc_start (ohci)) < 0) {
669 ohci_err (ohci, "can't restart, %d\n", temp);
672 ohci_dbg (ohci, "restart complete\n");
677 /*-------------------------------------------------------------------------*/
679 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
681 MODULE_AUTHOR (DRIVER_AUTHOR);
682 MODULE_DESCRIPTION (DRIVER_INFO);
683 MODULE_LICENSE ("GPL");
686 #include "ohci-pci.c"
690 #include "ohci-sa1111.c"
693 #if !(defined(CONFIG_PCI) || defined(CONFIG_SA1111))
694 #error "missing bus glue for ohci-hcd"