2 * OHCI HCD (Host Controller Driver) for USB.
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 #define OHCI_SCHED_ENABLES \
40 (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
42 static void dl_done_list (struct ohci_hcd *);
43 static void finish_unlinks (struct ohci_hcd *, u16);
46 static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
47 __releases(ohci->lock)
48 __acquires(ohci->lock)
52 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
53 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
55 ohci_dbg (ohci, "resume/suspend?\n");
56 ohci->hc_control &= ~OHCI_CTRL_HCFS;
57 ohci->hc_control |= OHCI_USB_RESET;
58 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
59 (void) ohci_readl (ohci, &ohci->regs->control);
63 ohci_dbg (ohci, "needs reinit!\n");
65 case OHCI_USB_SUSPEND:
66 if (!ohci->autostop) {
67 ohci_dbg (ohci, "already suspended\n");
71 ohci_dbg (ohci, "%s root hub\n",
72 autostop ? "auto-stop" : "suspend");
74 /* First stop any processing */
75 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
76 ohci->hc_control &= ~OHCI_SCHED_ENABLES;
77 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
78 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
79 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrstatus);
81 /* sched disables take effect on the next frame,
82 * then the last WDH could take 6+ msec
84 ohci_dbg (ohci, "stopping schedules ...\n");
86 spin_unlock_irq (&ohci->lock);
88 spin_lock_irq (&ohci->lock);
91 finish_unlinks (ohci, ohci_frame_no(ohci));
93 /* maybe resume can wake root hub */
94 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
95 ohci->hc_control |= OHCI_CTRL_RWE;
97 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
98 &ohci->regs->intrdisable);
99 ohci->hc_control &= ~OHCI_CTRL_RWE;
102 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
103 * which doesn't imply ports will first be individually suspended.
105 ohci->hc_control &= ~OHCI_CTRL_HCFS;
106 ohci->hc_control |= OHCI_USB_SUSPEND;
107 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
108 (void) ohci_readl (ohci, &ohci->regs->control);
110 /* no resumes until devices finish suspending */
112 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
114 ohci->rh_state = OHCI_RH_SUSPENDED;
121 static inline struct ed *find_head (struct ed *ed)
123 /* for bulk and control lists */
129 /* caller has locked the root hub */
130 static int ohci_rh_resume (struct ohci_hcd *ohci)
131 __releases(ohci->lock)
132 __acquires(ohci->lock)
134 struct usb_hcd *hcd = ohci_to_hcd (ohci);
136 int status = -EINPROGRESS;
137 int autostopped = ohci->autostop;
140 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
142 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
143 /* this can happen after resuming a swsusp snapshot */
144 if (ohci->rh_state != OHCI_RH_RUNNING) {
145 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
148 /* this happens when pmcore resumes HC then root */
150 ohci_dbg (ohci, "duplicate resume\n");
153 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
154 case OHCI_USB_SUSPEND:
155 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
156 ohci->hc_control |= OHCI_USB_RESUME;
157 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
158 (void) ohci_readl (ohci, &ohci->regs->control);
159 ohci_dbg (ohci, "%s root hub\n",
160 autostopped ? "auto-start" : "resume");
162 case OHCI_USB_RESUME:
163 /* HCFS changes sometime after INTR_RD */
164 ohci_dbg(ohci, "%swakeup root hub\n",
165 autostopped ? "auto-" : "");
168 /* this can happen after resuming a swsusp snapshot */
169 ohci_dbg (ohci, "snapshot resume? reinit\n");
172 default: /* RESET, we lost power */
173 ohci_dbg (ohci, "lost power\n");
176 if (status == -EBUSY) {
178 spin_unlock_irq (&ohci->lock);
179 status = ohci_restart (ohci);
181 usb_root_hub_lost_power(hcd->self.root_hub);
183 spin_lock_irq (&ohci->lock);
187 if (status != -EINPROGRESS)
191 spin_unlock_irq (&ohci->lock);
193 /* Some controllers (lucent erratum) need extra-long delays */
194 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
196 temp = ohci_readl (ohci, &ohci->regs->control);
197 temp &= OHCI_CTRL_HCFS;
198 if (temp != OHCI_USB_RESUME) {
199 ohci_err (ohci, "controller won't resume\n");
200 spin_lock_irq(&ohci->lock);
204 /* disable old schedule state, reinit from scratch */
205 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
206 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
207 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
208 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
209 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
210 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
212 /* Sometimes PCI D3 suspend trashes frame timings ... */
213 periodic_reinit (ohci);
215 /* the following code is executed with ohci->lock held and
216 * irqs disabled if and only if autostopped is true
220 /* interrupts might have been disabled */
221 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
222 if (ohci->ed_rm_list)
223 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
225 /* Then re-enable operations */
226 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
227 (void) ohci_readl (ohci, &ohci->regs->control);
231 temp = ohci->hc_control;
232 temp &= OHCI_CTRL_RWC;
233 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
234 ohci->hc_control = temp;
235 ohci_writel (ohci, temp, &ohci->regs->control);
236 (void) ohci_readl (ohci, &ohci->regs->control);
241 spin_lock_irq (&ohci->lock);
243 /* now ohci->lock is always held and irqs are always disabled */
245 /* keep it alive for more than ~5x suspend + resume costs */
246 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
248 /* maybe turn schedules back on */
251 if (!ohci->ed_rm_list) {
252 if (ohci->ed_controltail) {
254 find_head (ohci->ed_controltail)->dma,
255 &ohci->regs->ed_controlhead);
256 enables |= OHCI_CTRL_CLE;
259 if (ohci->ed_bulktail) {
260 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
261 &ohci->regs->ed_bulkhead);
262 enables |= OHCI_CTRL_BLE;
266 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
267 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
269 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
270 ohci->hc_control |= enables;
271 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
273 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
274 (void) ohci_readl (ohci, &ohci->regs->control);
277 ohci->rh_state = OHCI_RH_RUNNING;
281 static int ohci_bus_suspend (struct usb_hcd *hcd)
283 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
286 spin_lock_irq (&ohci->lock);
288 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
291 rc = ohci_rh_suspend (ohci, 0);
292 spin_unlock_irq (&ohci->lock);
296 static int ohci_bus_resume (struct usb_hcd *hcd)
298 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
301 if (time_before (jiffies, ohci->next_statechange))
304 spin_lock_irq (&ohci->lock);
306 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
309 rc = ohci_rh_resume (ohci);
310 spin_unlock_irq (&ohci->lock);
312 /* poll until we know a device is connected or we autostop */
314 usb_hcd_poll_rh_status(hcd);
318 /* Carry out polling-, autostop-, and autoresume-related state changes */
319 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
320 int any_connected, int rhsc_status)
325 /* Some broken controllers never turn off RHSC in the interrupt
326 * status register. For their sake we won't re-enable RHSC
327 * interrupts if the interrupt bit is already active.
329 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
332 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
334 /* If no status changes are pending, enable RHSC interrupts. */
335 if (!rhsc_enable && !rhsc_status && !changed) {
336 rhsc_enable = OHCI_INTR_RHSC;
337 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
340 /* Keep on polling until we know a device is connected
341 * and RHSC is enabled, or until we autostop.
343 if (!ohci->autostop) {
345 !device_may_wakeup(&ohci_to_hcd(ohci)
346 ->self.root_hub->dev)) {
351 ohci->next_statechange = jiffies + HZ;
354 /* if no devices have been attached for one second, autostop */
356 if (changed || any_connected) {
358 ohci->next_statechange = jiffies +
360 } else if (time_after_eq(jiffies,
361 ohci->next_statechange)
363 && !(ohci->hc_control &
364 OHCI_SCHED_ENABLES)) {
365 ohci_rh_suspend(ohci, 1);
372 case OHCI_USB_SUSPEND:
373 case OHCI_USB_RESUME:
374 /* if there is a port change, autostart or ask to be resumed */
377 ohci_rh_resume(ohci);
379 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
381 /* If remote wakeup is disabled, stop polling */
382 } else if (!ohci->autostop &&
383 !ohci_to_hcd(ohci)->self.root_hub->
388 /* If no status changes are pending,
389 * enable RHSC interrupts
391 if (!rhsc_enable && !rhsc_status) {
392 rhsc_enable = OHCI_INTR_RHSC;
393 ohci_writel(ohci, rhsc_enable,
394 &ohci->regs->intrenable);
396 /* Keep polling until RHSC is enabled */
405 #else /* CONFIG_PM */
407 static inline int ohci_rh_resume(struct ohci_hcd *ohci)
412 /* Carry out polling-related state changes.
413 * autostop isn't used when CONFIG_PM is turned off.
415 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
416 int any_connected, int rhsc_status)
418 /* If RHSC is enabled, don't poll */
419 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
422 /* If status changes are pending, continue polling.
423 * Conversely, if no status changes are pending but the RHSC
424 * status bit was set, then RHSC may be broken so continue polling.
426 if (changed || rhsc_status)
429 /* It's safe to re-enable RHSC interrupts */
430 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
434 #endif /* CONFIG_PM */
436 /*-------------------------------------------------------------------------*/
438 /* build "status change" packet (one or two bytes) from HC registers */
441 ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
443 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
444 int i, changed = 0, length = 1;
445 int any_connected = 0;
449 spin_lock_irqsave (&ohci->lock, flags);
450 if (!HCD_HW_ACCESSIBLE(hcd))
453 /* undocumented erratum seen on at least rev D */
454 if ((ohci->flags & OHCI_QUIRK_AMD756)
455 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
456 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
457 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
458 /* retry later; "should not happen" */
463 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
464 buf [0] = changed = 1;
467 if (ohci->num_ports > 7) {
472 /* Clear the RHSC status flag before reading the port statuses */
473 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
474 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
477 /* look at each port */
478 for (i = 0; i < ohci->num_ports; i++) {
479 u32 status = roothub_portstatus (ohci, i);
481 /* can't autostop if ports are connected */
482 any_connected |= (status & RH_PS_CCS);
484 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
485 | RH_PS_OCIC | RH_PS_PRSC)) {
488 buf [0] |= 1 << (i + 1);
490 buf [1] |= 1 << (i - 7);
494 if (ohci_root_hub_state_changes(ohci, changed,
495 any_connected, rhsc_status))
496 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
498 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
502 spin_unlock_irqrestore (&ohci->lock, flags);
504 return changed ? length : 0;
507 /*-------------------------------------------------------------------------*/
510 ohci_hub_descriptor (
511 struct ohci_hcd *ohci,
512 struct usb_hub_descriptor *desc
514 u32 rh = roothub_a (ohci);
517 desc->bDescriptorType = 0x29;
518 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
519 desc->bHubContrCurrent = 0;
521 desc->bNbrPorts = ohci->num_ports;
522 temp = 1 + (ohci->num_ports / 8);
523 desc->bDescLength = 7 + 2 * temp;
526 if (rh & RH_A_NPS) /* no power switching? */
528 if (rh & RH_A_PSM) /* per-port power switching? */
530 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
532 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
534 desc->wHubCharacteristics = (__force __u16)cpu_to_hc16(ohci, temp);
536 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
537 rh = roothub_b (ohci);
538 memset(desc->u.hs.DeviceRemovable, 0xff,
539 sizeof(desc->u.hs.DeviceRemovable));
540 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
541 if (ohci->num_ports > 7) {
542 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
543 desc->u.hs.DeviceRemovable[2] = 0xff;
545 desc->u.hs.DeviceRemovable[1] = 0xff;
548 /*-------------------------------------------------------------------------*/
550 #ifdef CONFIG_USB_OTG
552 static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
554 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
561 /* start port reset before HNP protocol times out */
562 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
563 if (!(status & RH_PS_CCS))
566 /* khubd will finish the reset later */
567 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
573 #define ohci_start_port_reset NULL
577 /*-------------------------------------------------------------------------*/
580 /* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
581 * not necessarily continuous ... to guard against resume signaling.
583 #define PORT_RESET_MSEC 50
585 /* this timer value might be vendor-specific ... */
586 #define PORT_RESET_HW_MSEC 10
588 /* wrap-aware logic morphed from <linux/jiffies.h> */
589 #define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
591 /* called from some task, normally khubd */
592 static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
594 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
596 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
597 u16 reset_done = now + PORT_RESET_MSEC;
598 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
600 /* build a "continuous enough" reset signal, with up to
601 * 3msec gap between pulses. scheduler HZ==100 must work;
602 * this might need to be deadline-scheduled.
607 /* spin until any current reset finishes */
608 limit_2 = PORT_RESET_HW_MSEC * 2;
609 while (--limit_2 >= 0) {
610 temp = ohci_readl (ohci, portstat);
611 /* handle e.g. CardBus eject */
614 if (!(temp & RH_PS_PRS))
619 /* timeout (a hardware error) has been observed when
620 * EHCI sets CF while this driver is resetting a port;
621 * presumably other disconnect paths might do it too.
625 "port[%d] reset timeout, stat %08x\n",
630 if (!(temp & RH_PS_CCS))
632 if (temp & RH_PS_PRSC)
633 ohci_writel (ohci, RH_PS_PRSC, portstat);
635 /* start the next reset, sleep till it's probably done */
636 ohci_writel (ohci, RH_PS_PRS, portstat);
637 msleep(PORT_RESET_HW_MSEC);
638 now = ohci_readl(ohci, &ohci->regs->fmnumber);
639 } while (tick_before(now, reset_done) && --limit_1 >= 0);
641 /* caller synchronizes using PRSC ... and handles PRS
642 * still being set when this returns.
648 static int ohci_hub_control (
656 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
657 int ports = ohci->num_ports;
661 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
665 case ClearHubFeature:
667 case C_HUB_OVER_CURRENT:
668 ohci_writel (ohci, RH_HS_OCIC,
669 &ohci->regs->roothub.status);
670 case C_HUB_LOCAL_POWER:
676 case ClearPortFeature:
677 if (!wIndex || wIndex > ports)
682 case USB_PORT_FEAT_ENABLE:
685 case USB_PORT_FEAT_C_ENABLE:
688 case USB_PORT_FEAT_SUSPEND:
691 case USB_PORT_FEAT_C_SUSPEND:
694 case USB_PORT_FEAT_POWER:
697 case USB_PORT_FEAT_C_CONNECTION:
700 case USB_PORT_FEAT_C_OVER_CURRENT:
703 case USB_PORT_FEAT_C_RESET:
709 ohci_writel (ohci, temp,
710 &ohci->regs->roothub.portstatus [wIndex]);
711 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
713 case GetHubDescriptor:
714 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
717 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
718 put_unaligned_le32(temp, buf);
721 if (!wIndex || wIndex > ports)
724 temp = roothub_portstatus (ohci, wIndex);
725 put_unaligned_le32(temp, buf);
727 #ifndef OHCI_VERBOSE_DEBUG
728 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
730 dbg_port (ohci, "GetStatus", wIndex, temp);
734 case C_HUB_OVER_CURRENT:
735 // FIXME: this can be cleared, yes?
736 case C_HUB_LOCAL_POWER:
743 if (!wIndex || wIndex > ports)
747 case USB_PORT_FEAT_SUSPEND:
748 #ifdef CONFIG_USB_OTG
749 if (hcd->self.otg_port == (wIndex + 1)
750 && hcd->self.b_hnp_enable)
751 ohci->start_hnp(ohci);
754 ohci_writel (ohci, RH_PS_PSS,
755 &ohci->regs->roothub.portstatus [wIndex]);
757 case USB_PORT_FEAT_POWER:
758 ohci_writel (ohci, RH_PS_PPS,
759 &ohci->regs->roothub.portstatus [wIndex]);
761 case USB_PORT_FEAT_RESET:
762 retval = root_port_reset (ohci, wIndex);
771 /* "protocol stall" on error */