1 // SPDX-License-Identifier: GPL-1.0+
3 * OHCI HCD (Host Controller Driver) for USB.
5 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
6 * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
8 * This file is licenced under GPL
11 /*-------------------------------------------------------------------------*/
14 * OHCI Root Hub ... the nonsharable stuff
17 #define dbg_port(hc,label,num,value) \
19 "%s roothub.portstatus [%d] " \
20 "= 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
22 (value & RH_PS_PRSC) ? " PRSC" : "", \
23 (value & RH_PS_OCIC) ? " OCIC" : "", \
24 (value & RH_PS_PSSC) ? " PSSC" : "", \
25 (value & RH_PS_PESC) ? " PESC" : "", \
26 (value & RH_PS_CSC) ? " CSC" : "", \
28 (value & RH_PS_LSDA) ? " LSDA" : "", \
29 (value & RH_PS_PPS) ? " PPS" : "", \
30 (value & RH_PS_PRS) ? " PRS" : "", \
31 (value & RH_PS_POCI) ? " POCI" : "", \
32 (value & RH_PS_PSS) ? " PSS" : "", \
34 (value & RH_PS_PES) ? " PES" : "", \
35 (value & RH_PS_CCS) ? " CCS" : "" \
38 /*-------------------------------------------------------------------------*/
40 #define OHCI_SCHED_ENABLES \
41 (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
43 static void update_done_list(struct ohci_hcd *);
44 static void ohci_work(struct ohci_hcd *);
47 static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
48 __releases(ohci->lock)
49 __acquires(ohci->lock)
53 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
54 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
56 ohci_dbg (ohci, "resume/suspend?\n");
57 ohci->hc_control &= ~OHCI_CTRL_HCFS;
58 ohci->hc_control |= OHCI_USB_RESET;
59 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
60 (void) ohci_readl (ohci, &ohci->regs->control);
64 ohci_dbg (ohci, "needs reinit!\n");
66 case OHCI_USB_SUSPEND:
67 if (!ohci->autostop) {
68 ohci_dbg (ohci, "already suspended\n");
72 ohci_dbg (ohci, "%s root hub\n",
73 autostop ? "auto-stop" : "suspend");
75 /* First stop any processing */
76 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
77 ohci->hc_control &= ~OHCI_SCHED_ENABLES;
78 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
79 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
80 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrstatus);
82 /* sched disables take effect on the next frame,
83 * then the last WDH could take 6+ msec
85 ohci_dbg (ohci, "stopping schedules ...\n");
87 spin_unlock_irq (&ohci->lock);
89 spin_lock_irq (&ohci->lock);
91 update_done_list(ohci);
95 * Some controllers don't handle "global" suspend properly if
96 * there are unsuspended ports. For these controllers, put all
97 * the enabled ports into suspend before suspending the root hub.
99 if (ohci->flags & OHCI_QUIRK_GLOBAL_SUSPEND) {
100 __hc32 __iomem *portstat = ohci->regs->roothub.portstatus;
104 for (i = 0; i < ohci->num_ports; (++i, ++portstat)) {
105 temp = ohci_readl(ohci, portstat);
106 if ((temp & (RH_PS_PES | RH_PS_PSS)) ==
108 ohci_writel(ohci, RH_PS_PSS, portstat);
112 /* maybe resume can wake root hub */
113 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
114 ohci->hc_control |= OHCI_CTRL_RWE;
116 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
117 &ohci->regs->intrdisable);
118 ohci->hc_control &= ~OHCI_CTRL_RWE;
121 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
122 * which doesn't imply ports will first be individually suspended.
124 ohci->hc_control &= ~OHCI_CTRL_HCFS;
125 ohci->hc_control |= OHCI_USB_SUSPEND;
126 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
127 (void) ohci_readl (ohci, &ohci->regs->control);
129 /* no resumes until devices finish suspending */
131 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
133 ohci->rh_state = OHCI_RH_SUSPENDED;
140 static inline struct ed *find_head (struct ed *ed)
142 /* for bulk and control lists */
148 /* caller has locked the root hub */
149 static int ohci_rh_resume (struct ohci_hcd *ohci)
150 __releases(ohci->lock)
151 __acquires(ohci->lock)
153 struct usb_hcd *hcd = ohci_to_hcd (ohci);
155 int status = -EINPROGRESS;
156 int autostopped = ohci->autostop;
159 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
161 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
162 /* this can happen after resuming a swsusp snapshot */
163 if (ohci->rh_state != OHCI_RH_RUNNING) {
164 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
167 /* this happens when pmcore resumes HC then root */
169 ohci_dbg (ohci, "duplicate resume\n");
172 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
173 case OHCI_USB_SUSPEND:
174 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
175 ohci->hc_control |= OHCI_USB_RESUME;
176 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
177 (void) ohci_readl (ohci, &ohci->regs->control);
178 ohci_dbg (ohci, "%s root hub\n",
179 autostopped ? "auto-start" : "resume");
181 case OHCI_USB_RESUME:
182 /* HCFS changes sometime after INTR_RD */
183 ohci_dbg(ohci, "%swakeup root hub\n",
184 autostopped ? "auto-" : "");
187 /* this can happen after resuming a swsusp snapshot */
188 ohci_dbg (ohci, "snapshot resume? reinit\n");
191 default: /* RESET, we lost power */
192 ohci_dbg (ohci, "lost power\n");
195 if (status == -EBUSY) {
197 spin_unlock_irq (&ohci->lock);
198 status = ohci_restart (ohci);
200 usb_root_hub_lost_power(hcd->self.root_hub);
202 spin_lock_irq (&ohci->lock);
206 if (status != -EINPROGRESS)
210 spin_unlock_irq (&ohci->lock);
212 /* Some controllers (lucent erratum) need extra-long delays */
213 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
215 temp = ohci_readl (ohci, &ohci->regs->control);
216 temp &= OHCI_CTRL_HCFS;
217 if (temp != OHCI_USB_RESUME) {
218 ohci_err (ohci, "controller won't resume\n");
219 spin_lock_irq(&ohci->lock);
223 /* disable old schedule state, reinit from scratch */
224 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
225 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
226 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
227 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
228 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
229 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
231 /* Sometimes PCI D3 suspend trashes frame timings ... */
232 periodic_reinit (ohci);
235 * The following code is executed with ohci->lock held and
236 * irqs disabled if and only if autostopped is true. This
237 * will cause sparse to warn about a "context imbalance".
240 /* interrupts might have been disabled */
241 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
242 if (ohci->ed_rm_list)
243 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
245 /* Then re-enable operations */
246 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
247 (void) ohci_readl (ohci, &ohci->regs->control);
251 temp = ohci->hc_control;
252 temp &= OHCI_CTRL_RWC;
253 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
254 ohci->hc_control = temp;
255 ohci_writel (ohci, temp, &ohci->regs->control);
256 (void) ohci_readl (ohci, &ohci->regs->control);
261 spin_lock_irq (&ohci->lock);
263 /* now ohci->lock is always held and irqs are always disabled */
265 /* keep it alive for more than ~5x suspend + resume costs */
266 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
268 /* maybe turn schedules back on */
271 if (!ohci->ed_rm_list) {
272 if (ohci->ed_controltail) {
274 find_head (ohci->ed_controltail)->dma,
275 &ohci->regs->ed_controlhead);
276 enables |= OHCI_CTRL_CLE;
279 if (ohci->ed_bulktail) {
280 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
281 &ohci->regs->ed_bulkhead);
282 enables |= OHCI_CTRL_BLE;
286 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
287 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
289 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
290 ohci->hc_control |= enables;
291 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
293 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
294 (void) ohci_readl (ohci, &ohci->regs->control);
297 ohci->rh_state = OHCI_RH_RUNNING;
301 static int ohci_bus_suspend (struct usb_hcd *hcd)
303 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
306 spin_lock_irq (&ohci->lock);
308 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
311 rc = ohci_rh_suspend (ohci, 0);
312 spin_unlock_irq (&ohci->lock);
315 del_timer_sync(&ohci->io_watchdog);
316 ohci->prev_frame_no = IO_WATCHDOG_OFF;
321 static int ohci_bus_resume (struct usb_hcd *hcd)
323 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
326 if (time_before (jiffies, ohci->next_statechange))
329 spin_lock_irq (&ohci->lock);
331 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
334 rc = ohci_rh_resume (ohci);
335 spin_unlock_irq (&ohci->lock);
337 /* poll until we know a device is connected or we autostop */
339 usb_hcd_poll_rh_status(hcd);
343 /* Carry out polling-, autostop-, and autoresume-related state changes */
344 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
345 int any_connected, int rhsc_status)
350 /* Some broken controllers never turn off RHSC in the interrupt
351 * status register. For their sake we won't re-enable RHSC
352 * interrupts if the interrupt bit is already active.
354 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
357 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
359 /* If no status changes are pending, enable RHSC interrupts. */
360 if (!rhsc_enable && !rhsc_status && !changed) {
361 rhsc_enable = OHCI_INTR_RHSC;
362 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
365 /* Keep on polling until we know a device is connected
366 * and RHSC is enabled, or until we autostop.
368 if (!ohci->autostop) {
370 !device_may_wakeup(&ohci_to_hcd(ohci)
371 ->self.root_hub->dev)) {
376 ohci->next_statechange = jiffies + HZ;
379 /* if no devices have been attached for one second, autostop */
381 if (changed || any_connected) {
383 ohci->next_statechange = jiffies +
385 } else if (time_after_eq(jiffies,
386 ohci->next_statechange)
388 && !(ohci->hc_control &
389 OHCI_SCHED_ENABLES)) {
390 ohci_rh_suspend(ohci, 1);
397 case OHCI_USB_SUSPEND:
398 case OHCI_USB_RESUME:
399 /* if there is a port change, autostart or ask to be resumed */
402 ohci_rh_resume(ohci);
404 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
406 /* If remote wakeup is disabled, stop polling */
407 } else if (!ohci->autostop &&
408 !ohci_to_hcd(ohci)->self.root_hub->
413 /* If no status changes are pending,
414 * enable RHSC interrupts
416 if (!rhsc_enable && !rhsc_status) {
417 rhsc_enable = OHCI_INTR_RHSC;
418 ohci_writel(ohci, rhsc_enable,
419 &ohci->regs->intrenable);
421 /* Keep polling until RHSC is enabled */
430 #else /* CONFIG_PM */
432 static inline int ohci_rh_resume(struct ohci_hcd *ohci)
437 /* Carry out polling-related state changes.
438 * autostop isn't used when CONFIG_PM is turned off.
440 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
441 int any_connected, int rhsc_status)
443 /* If RHSC is enabled, don't poll */
444 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
447 /* If status changes are pending, continue polling.
448 * Conversely, if no status changes are pending but the RHSC
449 * status bit was set, then RHSC may be broken so continue polling.
451 if (changed || rhsc_status)
454 /* It's safe to re-enable RHSC interrupts */
455 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
459 #endif /* CONFIG_PM */
461 /*-------------------------------------------------------------------------*/
463 /* build "status change" packet (one or two bytes) from HC registers */
465 int ohci_hub_status_data(struct usb_hcd *hcd, char *buf)
467 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
468 int i, changed = 0, length = 1;
469 int any_connected = 0;
473 spin_lock_irqsave (&ohci->lock, flags);
474 if (!HCD_HW_ACCESSIBLE(hcd))
477 /* undocumented erratum seen on at least rev D */
478 if ((ohci->flags & OHCI_QUIRK_AMD756)
479 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
480 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
481 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
482 /* retry later; "should not happen" */
487 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
488 buf [0] = changed = 1;
491 if (ohci->num_ports > 7) {
496 /* Clear the RHSC status flag before reading the port statuses */
497 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
498 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
501 /* look at each port */
502 for (i = 0; i < ohci->num_ports; i++) {
503 u32 status = roothub_portstatus (ohci, i);
505 /* can't autostop if ports are connected */
506 any_connected |= (status & RH_PS_CCS);
508 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
509 | RH_PS_OCIC | RH_PS_PRSC)) {
512 buf [0] |= 1 << (i + 1);
514 buf [1] |= 1 << (i - 7);
518 if (ohci_root_hub_state_changes(ohci, changed,
519 any_connected, rhsc_status))
520 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
522 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
526 spin_unlock_irqrestore (&ohci->lock, flags);
528 return changed ? length : 0;
530 EXPORT_SYMBOL_GPL(ohci_hub_status_data);
532 /*-------------------------------------------------------------------------*/
535 ohci_hub_descriptor (
536 struct ohci_hcd *ohci,
537 struct usb_hub_descriptor *desc
539 u32 rh = roothub_a (ohci);
542 desc->bDescriptorType = USB_DT_HUB;
543 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
544 desc->bHubContrCurrent = 0;
546 desc->bNbrPorts = ohci->num_ports;
547 temp = 1 + (ohci->num_ports / 8);
548 desc->bDescLength = 7 + 2 * temp;
550 temp = HUB_CHAR_COMMON_LPSM | HUB_CHAR_COMMON_OCPM;
551 if (rh & RH_A_NPS) /* no power switching? */
552 temp |= HUB_CHAR_NO_LPSM;
553 if (rh & RH_A_PSM) /* per-port power switching? */
554 temp |= HUB_CHAR_INDV_PORT_LPSM;
555 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
556 temp |= HUB_CHAR_NO_OCPM;
557 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
558 temp |= HUB_CHAR_INDV_PORT_OCPM;
559 desc->wHubCharacteristics = cpu_to_le16(temp);
561 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
562 rh = roothub_b (ohci);
563 memset(desc->u.hs.DeviceRemovable, 0xff,
564 sizeof(desc->u.hs.DeviceRemovable));
565 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
566 if (ohci->num_ports > 7) {
567 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
568 desc->u.hs.DeviceRemovable[2] = 0xff;
570 desc->u.hs.DeviceRemovable[1] = 0xff;
573 /*-------------------------------------------------------------------------*/
575 #ifdef CONFIG_USB_OTG
577 static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
579 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
586 /* start port reset before HNP protocol times out */
587 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
588 if (!(status & RH_PS_CCS))
591 /* hub_wq will finish the reset later */
592 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
598 #define ohci_start_port_reset NULL
602 /*-------------------------------------------------------------------------*/
605 /* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
606 * not necessarily continuous ... to guard against resume signaling.
608 #define PORT_RESET_MSEC 50
610 /* this timer value might be vendor-specific ... */
611 #define PORT_RESET_HW_MSEC 10
613 /* wrap-aware logic morphed from <linux/jiffies.h> */
614 #define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
616 /* called from some task, normally hub_wq */
617 static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
619 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
621 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
622 u16 reset_done = now + PORT_RESET_MSEC;
623 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
625 /* build a "continuous enough" reset signal, with up to
626 * 3msec gap between pulses. scheduler HZ==100 must work;
627 * this might need to be deadline-scheduled.
632 /* spin until any current reset finishes */
633 limit_2 = PORT_RESET_HW_MSEC * 2;
634 while (--limit_2 >= 0) {
635 temp = ohci_readl (ohci, portstat);
636 /* handle e.g. CardBus eject */
639 if (!(temp & RH_PS_PRS))
644 /* timeout (a hardware error) has been observed when
645 * EHCI sets CF while this driver is resetting a port;
646 * presumably other disconnect paths might do it too.
650 "port[%d] reset timeout, stat %08x\n",
655 if (!(temp & RH_PS_CCS))
657 if (temp & RH_PS_PRSC)
658 ohci_writel (ohci, RH_PS_PRSC, portstat);
660 /* start the next reset, sleep till it's probably done */
661 ohci_writel (ohci, RH_PS_PRS, portstat);
662 msleep(PORT_RESET_HW_MSEC);
663 now = ohci_readl(ohci, &ohci->regs->fmnumber);
664 } while (tick_before(now, reset_done) && --limit_1 >= 0);
666 /* caller synchronizes using PRSC ... and handles PRS
667 * still being set when this returns.
673 int ohci_hub_control(
681 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
682 int ports = ohci->num_ports;
686 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
690 case ClearHubFeature:
692 case C_HUB_OVER_CURRENT:
693 ohci_writel (ohci, RH_HS_OCIC,
694 &ohci->regs->roothub.status);
696 case C_HUB_LOCAL_POWER:
702 case ClearPortFeature:
703 if (!wIndex || wIndex > ports)
708 case USB_PORT_FEAT_ENABLE:
711 case USB_PORT_FEAT_C_ENABLE:
714 case USB_PORT_FEAT_SUSPEND:
717 case USB_PORT_FEAT_C_SUSPEND:
720 case USB_PORT_FEAT_POWER:
723 case USB_PORT_FEAT_C_CONNECTION:
726 case USB_PORT_FEAT_C_OVER_CURRENT:
729 case USB_PORT_FEAT_C_RESET:
735 ohci_writel (ohci, temp,
736 &ohci->regs->roothub.portstatus [wIndex]);
737 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
739 case GetHubDescriptor:
740 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
743 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
744 put_unaligned_le32(temp, buf);
747 if (!wIndex || wIndex > ports)
750 temp = roothub_portstatus (ohci, wIndex);
751 put_unaligned_le32(temp, buf);
753 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
754 dbg_port(ohci, "GetStatus", wIndex, temp);
758 case C_HUB_OVER_CURRENT:
759 // FIXME: this can be cleared, yes?
760 case C_HUB_LOCAL_POWER:
767 if (!wIndex || wIndex > ports)
771 case USB_PORT_FEAT_SUSPEND:
772 #ifdef CONFIG_USB_OTG
773 if (hcd->self.otg_port == (wIndex + 1)
774 && hcd->self.b_hnp_enable)
775 ohci->start_hnp(ohci);
778 ohci_writel (ohci, RH_PS_PSS,
779 &ohci->regs->roothub.portstatus [wIndex]);
781 case USB_PORT_FEAT_POWER:
782 ohci_writel (ohci, RH_PS_PPS,
783 &ohci->regs->roothub.portstatus [wIndex]);
785 case USB_PORT_FEAT_RESET:
786 retval = root_port_reset (ohci, wIndex);
795 /* "protocol stall" on error */
800 EXPORT_SYMBOL_GPL(ohci_hub_control);