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 * This file is licenced under GPL
10 /*-------------------------------------------------------------------------*/
13 * OHCI Root Hub ... the nonsharable stuff
16 #define dbg_port(hc,label,num,value) \
18 "%s roothub.portstatus [%d] " \
19 "= 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
21 (temp & RH_PS_PRSC) ? " PRSC" : "", \
22 (temp & RH_PS_OCIC) ? " OCIC" : "", \
23 (temp & RH_PS_PSSC) ? " PSSC" : "", \
24 (temp & RH_PS_PESC) ? " PESC" : "", \
25 (temp & RH_PS_CSC) ? " CSC" : "", \
27 (temp & RH_PS_LSDA) ? " LSDA" : "", \
28 (temp & RH_PS_PPS) ? " PPS" : "", \
29 (temp & RH_PS_PRS) ? " PRS" : "", \
30 (temp & RH_PS_POCI) ? " POCI" : "", \
31 (temp & RH_PS_PSS) ? " PSS" : "", \
33 (temp & RH_PS_PES) ? " PES" : "", \
34 (temp & RH_PS_CCS) ? " CCS" : "" \
37 /*-------------------------------------------------------------------------*/
39 /* hcd->hub_irq_enable() */
40 static void ohci_rhsc_enable (struct usb_hcd *hcd)
42 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
44 spin_lock_irq(&ohci->lock);
46 del_timer(&hcd->rh_timer); /* Prevent next poll */
47 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
48 spin_unlock_irq(&ohci->lock);
51 #define OHCI_SCHED_ENABLES \
52 (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
54 static void dl_done_list (struct ohci_hcd *);
55 static void finish_unlinks (struct ohci_hcd *, u16);
58 static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
59 __releases(ohci->lock)
60 __acquires(ohci->lock)
64 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
65 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
67 ohci_dbg (ohci, "resume/suspend?\n");
68 ohci->hc_control &= ~OHCI_CTRL_HCFS;
69 ohci->hc_control |= OHCI_USB_RESET;
70 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
71 (void) ohci_readl (ohci, &ohci->regs->control);
75 ohci_dbg (ohci, "needs reinit!\n");
77 case OHCI_USB_SUSPEND:
78 if (!ohci->autostop) {
79 ohci_dbg (ohci, "already suspended\n");
83 ohci_dbg (ohci, "%s root hub\n",
84 autostop ? "auto-stop" : "suspend");
86 /* First stop any processing */
87 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
88 ohci->hc_control &= ~OHCI_SCHED_ENABLES;
89 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
90 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
91 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrstatus);
93 /* sched disables take effect on the next frame,
94 * then the last WDH could take 6+ msec
96 ohci_dbg (ohci, "stopping schedules ...\n");
98 spin_unlock_irq (&ohci->lock);
100 spin_lock_irq (&ohci->lock);
103 finish_unlinks (ohci, ohci_frame_no(ohci));
105 /* maybe resume can wake root hub */
106 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
107 ohci->hc_control |= OHCI_CTRL_RWE;
109 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
110 &ohci->regs->intrdisable);
111 ohci->hc_control &= ~OHCI_CTRL_RWE;
114 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
115 * which doesn't imply ports will first be individually suspended.
117 ohci->hc_control &= ~OHCI_CTRL_HCFS;
118 ohci->hc_control |= OHCI_USB_SUSPEND;
119 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
120 (void) ohci_readl (ohci, &ohci->regs->control);
122 /* no resumes until devices finish suspending */
124 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
132 static inline struct ed *find_head (struct ed *ed)
134 /* for bulk and control lists */
140 /* caller has locked the root hub */
141 static int ohci_rh_resume (struct ohci_hcd *ohci)
142 __releases(ohci->lock)
143 __acquires(ohci->lock)
145 struct usb_hcd *hcd = ohci_to_hcd (ohci);
147 int status = -EINPROGRESS;
148 int autostopped = ohci->autostop;
151 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
153 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
154 /* this can happen after resuming a swsusp snapshot */
155 if (hcd->state == HC_STATE_RESUMING) {
156 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
159 /* this happens when pmcore resumes HC then root */
161 ohci_dbg (ohci, "duplicate resume\n");
164 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
165 case OHCI_USB_SUSPEND:
166 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
167 ohci->hc_control |= OHCI_USB_RESUME;
168 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
169 (void) ohci_readl (ohci, &ohci->regs->control);
170 ohci_dbg (ohci, "%s root hub\n",
171 autostopped ? "auto-start" : "resume");
173 case OHCI_USB_RESUME:
174 /* HCFS changes sometime after INTR_RD */
175 ohci_dbg(ohci, "%swakeup root hub\n",
176 autostopped ? "auto-" : "");
179 /* this can happen after resuming a swsusp snapshot */
180 ohci_dbg (ohci, "snapshot resume? reinit\n");
183 default: /* RESET, we lost power */
184 ohci_dbg (ohci, "lost power\n");
187 if (status == -EBUSY) {
189 spin_unlock_irq (&ohci->lock);
190 (void) ohci_init (ohci);
191 status = ohci_restart (ohci);
193 usb_root_hub_lost_power(hcd->self.root_hub);
195 spin_lock_irq (&ohci->lock);
199 if (status != -EINPROGRESS)
203 spin_unlock_irq (&ohci->lock);
205 /* Some controllers (lucent erratum) need extra-long delays */
206 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
208 temp = ohci_readl (ohci, &ohci->regs->control);
209 temp &= OHCI_CTRL_HCFS;
210 if (temp != OHCI_USB_RESUME) {
211 ohci_err (ohci, "controller won't resume\n");
212 spin_lock_irq(&ohci->lock);
216 /* disable old schedule state, reinit from scratch */
217 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
218 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
219 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
220 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
221 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
222 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
224 /* Sometimes PCI D3 suspend trashes frame timings ... */
225 periodic_reinit (ohci);
227 /* the following code is executed with ohci->lock held and
228 * irqs disabled if and only if autostopped is true
232 /* interrupts might have been disabled */
233 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
234 if (ohci->ed_rm_list)
235 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
237 /* Then re-enable operations */
238 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
239 (void) ohci_readl (ohci, &ohci->regs->control);
243 temp = ohci->hc_control;
244 temp &= OHCI_CTRL_RWC;
245 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
246 ohci->hc_control = temp;
247 ohci_writel (ohci, temp, &ohci->regs->control);
248 (void) ohci_readl (ohci, &ohci->regs->control);
253 spin_lock_irq (&ohci->lock);
255 /* now ohci->lock is always held and irqs are always disabled */
257 /* keep it alive for more than ~5x suspend + resume costs */
258 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
260 /* maybe turn schedules back on */
263 if (!ohci->ed_rm_list) {
264 if (ohci->ed_controltail) {
266 find_head (ohci->ed_controltail)->dma,
267 &ohci->regs->ed_controlhead);
268 enables |= OHCI_CTRL_CLE;
271 if (ohci->ed_bulktail) {
272 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
273 &ohci->regs->ed_bulkhead);
274 enables |= OHCI_CTRL_BLE;
278 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
279 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
281 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
282 ohci->hc_control |= enables;
283 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
285 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
286 (void) ohci_readl (ohci, &ohci->regs->control);
292 static int ohci_bus_suspend (struct usb_hcd *hcd)
294 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
297 spin_lock_irq (&ohci->lock);
299 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
302 rc = ohci_rh_suspend (ohci, 0);
303 spin_unlock_irq (&ohci->lock);
307 static int ohci_bus_resume (struct usb_hcd *hcd)
309 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
312 if (time_before (jiffies, ohci->next_statechange))
315 spin_lock_irq (&ohci->lock);
317 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
320 rc = ohci_rh_resume (ohci);
321 spin_unlock_irq (&ohci->lock);
323 /* poll until we know a device is connected or we autostop */
325 usb_hcd_poll_rh_status(hcd);
329 /* Carry out the final steps of resuming the controller device */
330 static void ohci_finish_controller_resume(struct usb_hcd *hcd)
332 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
334 bool need_reinit = false;
336 /* See if the controller is already running or has been reset */
337 ohci->hc_control = ohci_readl(ohci, &ohci->regs->control);
338 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
341 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
348 /* If needed, reinitialize and suspend the root hub */
350 spin_lock_irq(&ohci->lock);
351 hcd->state = HC_STATE_RESUMING;
352 ohci_rh_resume(ohci);
353 hcd->state = HC_STATE_QUIESCING;
354 ohci_rh_suspend(ohci, 0);
355 hcd->state = HC_STATE_SUSPENDED;
356 spin_unlock_irq(&ohci->lock);
359 /* Normally just turn on port power and enable interrupts */
361 ohci_dbg(ohci, "powerup ports\n");
362 for (port = 0; port < ohci->num_ports; port++)
363 ohci_writel(ohci, RH_PS_PPS,
364 &ohci->regs->roothub.portstatus[port]);
366 ohci_writel(ohci, OHCI_INTR_MIE, &ohci->regs->intrenable);
367 ohci_readl(ohci, &ohci->regs->intrenable);
372 /* Carry out polling-, autostop-, and autoresume-related state changes */
373 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
378 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
381 /* keep on polling until we know a device is connected
382 * and RHSC is enabled */
383 if (!ohci->autostop) {
385 !device_may_wakeup(&ohci_to_hcd(ohci)
386 ->self.root_hub->dev)) {
387 if (ohci_readl(ohci, &ohci->regs->intrenable) &
392 ohci->next_statechange = jiffies + HZ;
395 /* if no devices have been attached for one second, autostop */
397 if (changed || any_connected) {
399 ohci->next_statechange = jiffies +
401 } else if (time_after_eq(jiffies,
402 ohci->next_statechange)
404 && !(ohci->hc_control &
405 OHCI_SCHED_ENABLES)) {
406 ohci_rh_suspend(ohci, 1);
411 /* if there is a port change, autostart or ask to be resumed */
412 case OHCI_USB_SUSPEND:
413 case OHCI_USB_RESUME:
416 ohci_rh_resume(ohci);
418 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
420 /* everything is idle, no need for polling */
428 #else /* CONFIG_PM */
430 static inline int ohci_rh_resume(struct ohci_hcd *ohci)
435 /* Carry out polling-related state changes.
436 * autostop isn't used when CONFIG_PM is turned off.
438 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
443 /* keep on polling until RHSC is enabled */
444 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
449 #endif /* CONFIG_PM */
451 /*-------------------------------------------------------------------------*/
453 /* build "status change" packet (one or two bytes) from HC registers */
456 ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
458 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
459 int i, changed = 0, length = 1;
460 int any_connected = 0;
463 spin_lock_irqsave (&ohci->lock, flags);
464 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
467 /* undocumented erratum seen on at least rev D */
468 if ((ohci->flags & OHCI_QUIRK_AMD756)
469 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
470 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
471 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
472 /* retry later; "should not happen" */
477 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
478 buf [0] = changed = 1;
481 if (ohci->num_ports > 7) {
486 /* Some broken controllers never turn off RHCS in the interrupt
487 * status register. For their sake we won't re-enable RHSC
488 * interrupts if the flag is already set.
490 if (ohci_readl(ohci, &ohci->regs->intrstatus) & OHCI_INTR_RHSC)
493 /* look at each port */
494 for (i = 0; i < ohci->num_ports; i++) {
495 u32 status = roothub_portstatus (ohci, i);
497 /* can't autostop if ports are connected */
498 any_connected |= (status & RH_PS_CCS);
500 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
501 | RH_PS_OCIC | RH_PS_PRSC)) {
504 buf [0] |= 1 << (i + 1);
506 buf [1] |= 1 << (i - 7);
510 hcd->poll_rh = ohci_root_hub_state_changes(ohci, changed,
514 spin_unlock_irqrestore (&ohci->lock, flags);
516 return changed ? length : 0;
519 /*-------------------------------------------------------------------------*/
522 ohci_hub_descriptor (
523 struct ohci_hcd *ohci,
524 struct usb_hub_descriptor *desc
526 u32 rh = roothub_a (ohci);
529 desc->bDescriptorType = 0x29;
530 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
531 desc->bHubContrCurrent = 0;
533 desc->bNbrPorts = ohci->num_ports;
534 temp = 1 + (ohci->num_ports / 8);
535 desc->bDescLength = 7 + 2 * temp;
538 if (rh & RH_A_NPS) /* no power switching? */
540 if (rh & RH_A_PSM) /* per-port power switching? */
542 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
544 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
546 desc->wHubCharacteristics = (__force __u16)cpu_to_hc16(ohci, temp);
548 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
549 rh = roothub_b (ohci);
550 memset(desc->bitmap, 0xff, sizeof(desc->bitmap));
551 desc->bitmap [0] = rh & RH_B_DR;
552 if (ohci->num_ports > 7) {
553 desc->bitmap [1] = (rh & RH_B_DR) >> 8;
554 desc->bitmap [2] = 0xff;
556 desc->bitmap [1] = 0xff;
559 /*-------------------------------------------------------------------------*/
561 #ifdef CONFIG_USB_OTG
563 static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
565 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
572 /* start port reset before HNP protocol times out */
573 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
574 if (!(status & RH_PS_CCS))
577 /* khubd will finish the reset later */
578 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
584 #define ohci_start_port_reset NULL
588 /*-------------------------------------------------------------------------*/
591 /* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
592 * not necessarily continuous ... to guard against resume signaling.
593 * The short timeout is safe for non-root hubs, and is backward-compatible
594 * with earlier Linux hosts.
596 #ifdef CONFIG_USB_SUSPEND
597 #define PORT_RESET_MSEC 50
599 #define PORT_RESET_MSEC 10
602 /* this timer value might be vendor-specific ... */
603 #define PORT_RESET_HW_MSEC 10
605 /* wrap-aware logic morphed from <linux/jiffies.h> */
606 #define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
608 /* called from some task, normally khubd */
609 static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
611 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
613 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
614 u16 reset_done = now + PORT_RESET_MSEC;
615 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
617 /* build a "continuous enough" reset signal, with up to
618 * 3msec gap between pulses. scheduler HZ==100 must work;
619 * this might need to be deadline-scheduled.
624 /* spin until any current reset finishes */
625 limit_2 = PORT_RESET_HW_MSEC * 2;
626 while (--limit_2 >= 0) {
627 temp = ohci_readl (ohci, portstat);
628 /* handle e.g. CardBus eject */
631 if (!(temp & RH_PS_PRS))
636 /* timeout (a hardware error) has been observed when
637 * EHCI sets CF while this driver is resetting a port;
638 * presumably other disconnect paths might do it too.
642 "port[%d] reset timeout, stat %08x\n",
647 if (!(temp & RH_PS_CCS))
649 if (temp & RH_PS_PRSC)
650 ohci_writel (ohci, RH_PS_PRSC, portstat);
652 /* start the next reset, sleep till it's probably done */
653 ohci_writel (ohci, RH_PS_PRS, portstat);
654 msleep(PORT_RESET_HW_MSEC);
655 now = ohci_readl(ohci, &ohci->regs->fmnumber);
656 } while (tick_before(now, reset_done) && --limit_1 >= 0);
658 /* caller synchronizes using PRSC ... and handles PRS
659 * still being set when this returns.
665 static int ohci_hub_control (
673 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
674 int ports = hcd_to_bus (hcd)->root_hub->maxchild;
678 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
682 case ClearHubFeature:
684 case C_HUB_OVER_CURRENT:
685 ohci_writel (ohci, RH_HS_OCIC,
686 &ohci->regs->roothub.status);
687 case C_HUB_LOCAL_POWER:
693 case ClearPortFeature:
694 if (!wIndex || wIndex > ports)
699 case USB_PORT_FEAT_ENABLE:
702 case USB_PORT_FEAT_C_ENABLE:
705 case USB_PORT_FEAT_SUSPEND:
708 case USB_PORT_FEAT_C_SUSPEND:
711 case USB_PORT_FEAT_POWER:
714 case USB_PORT_FEAT_C_CONNECTION:
717 case USB_PORT_FEAT_C_OVER_CURRENT:
720 case USB_PORT_FEAT_C_RESET:
726 ohci_writel (ohci, temp,
727 &ohci->regs->roothub.portstatus [wIndex]);
728 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
730 case GetHubDescriptor:
731 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
734 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
735 put_unaligned_le32(temp, buf);
738 if (!wIndex || wIndex > ports)
741 temp = roothub_portstatus (ohci, wIndex);
742 put_unaligned_le32(temp, buf);
744 #ifndef OHCI_VERBOSE_DEBUG
745 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
747 dbg_port (ohci, "GetStatus", wIndex, temp);
751 case C_HUB_OVER_CURRENT:
752 // FIXME: this can be cleared, yes?
753 case C_HUB_LOCAL_POWER:
760 if (!wIndex || wIndex > ports)
764 case USB_PORT_FEAT_SUSPEND:
765 #ifdef CONFIG_USB_OTG
766 if (hcd->self.otg_port == (wIndex + 1)
767 && hcd->self.b_hnp_enable)
768 ohci->start_hnp(ohci);
771 ohci_writel (ohci, RH_PS_PSS,
772 &ohci->regs->roothub.portstatus [wIndex]);
774 case USB_PORT_FEAT_POWER:
775 ohci_writel (ohci, RH_PS_PPS,
776 &ohci->regs->roothub.portstatus [wIndex]);
778 case USB_PORT_FEAT_RESET:
779 retval = root_port_reset (ohci, wIndex);
788 /* "protocol stall" on error */