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_restart(struct ohci_hcd *ohci);
60 static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
61 __releases(ohci->lock)
62 __acquires(ohci->lock)
66 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
67 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
69 ohci_dbg (ohci, "resume/suspend?\n");
70 ohci->hc_control &= ~OHCI_CTRL_HCFS;
71 ohci->hc_control |= OHCI_USB_RESET;
72 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
73 (void) ohci_readl (ohci, &ohci->regs->control);
77 ohci_dbg (ohci, "needs reinit!\n");
79 case OHCI_USB_SUSPEND:
80 if (!ohci->autostop) {
81 ohci_dbg (ohci, "already suspended\n");
85 ohci_dbg (ohci, "%s root hub\n",
86 autostop ? "auto-stop" : "suspend");
88 /* First stop any processing */
89 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
90 ohci->hc_control &= ~OHCI_SCHED_ENABLES;
91 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
92 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
93 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrstatus);
95 /* sched disables take effect on the next frame,
96 * then the last WDH could take 6+ msec
98 ohci_dbg (ohci, "stopping schedules ...\n");
100 spin_unlock_irq (&ohci->lock);
102 spin_lock_irq (&ohci->lock);
105 finish_unlinks (ohci, ohci_frame_no(ohci));
107 /* maybe resume can wake root hub */
108 if (device_may_wakeup(&ohci_to_hcd(ohci)->self.root_hub->dev) ||
110 ohci->hc_control |= OHCI_CTRL_RWE;
112 ohci_writel (ohci, OHCI_INTR_RHSC, &ohci->regs->intrdisable);
113 ohci->hc_control &= ~OHCI_CTRL_RWE;
116 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
117 * which doesn't imply ports will first be individually suspended.
119 ohci->hc_control &= ~OHCI_CTRL_HCFS;
120 ohci->hc_control |= OHCI_USB_SUSPEND;
121 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
122 (void) ohci_readl (ohci, &ohci->regs->control);
124 /* no resumes until devices finish suspending */
126 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
134 static inline struct ed *find_head (struct ed *ed)
136 /* for bulk and control lists */
142 /* caller has locked the root hub */
143 static int ohci_rh_resume (struct ohci_hcd *ohci)
144 __releases(ohci->lock)
145 __acquires(ohci->lock)
147 struct usb_hcd *hcd = ohci_to_hcd (ohci);
149 int status = -EINPROGRESS;
150 int autostopped = ohci->autostop;
153 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
155 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
156 /* this can happen after resuming a swsusp snapshot */
157 if (hcd->state == HC_STATE_RESUMING) {
158 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
161 /* this happens when pmcore resumes HC then root */
163 ohci_dbg (ohci, "duplicate resume\n");
166 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
167 case OHCI_USB_SUSPEND:
168 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
169 ohci->hc_control |= OHCI_USB_RESUME;
170 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
171 (void) ohci_readl (ohci, &ohci->regs->control);
172 ohci_dbg (ohci, "%s root hub\n",
173 autostopped ? "auto-start" : "resume");
175 case OHCI_USB_RESUME:
176 /* HCFS changes sometime after INTR_RD */
177 ohci_dbg(ohci, "%swakeup root hub\n",
178 autostopped ? "auto-" : "");
181 /* this can happen after resuming a swsusp snapshot */
182 ohci_dbg (ohci, "snapshot resume? reinit\n");
185 default: /* RESET, we lost power */
186 ohci_dbg (ohci, "lost power\n");
189 if (status == -EBUSY) {
191 spin_unlock_irq (&ohci->lock);
192 (void) ohci_init (ohci);
193 status = ohci_restart (ohci);
194 spin_lock_irq (&ohci->lock);
198 if (status != -EINPROGRESS)
202 spin_unlock_irq (&ohci->lock);
204 /* Some controllers (lucent erratum) need extra-long delays */
205 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
207 temp = ohci_readl (ohci, &ohci->regs->control);
208 temp &= OHCI_CTRL_HCFS;
209 if (temp != OHCI_USB_RESUME) {
210 ohci_err (ohci, "controller won't resume\n");
211 spin_lock_irq(&ohci->lock);
215 /* disable old schedule state, reinit from scratch */
216 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
217 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
218 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
219 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
220 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
221 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
223 /* Sometimes PCI D3 suspend trashes frame timings ... */
224 periodic_reinit (ohci);
226 /* the following code is executed with ohci->lock held and
227 * irqs disabled if and only if autostopped is true
231 /* interrupts might have been disabled */
232 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
233 if (ohci->ed_rm_list)
234 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
236 /* Then re-enable operations */
237 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
238 (void) ohci_readl (ohci, &ohci->regs->control);
242 temp = ohci->hc_control;
243 temp &= OHCI_CTRL_RWC;
244 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
245 ohci->hc_control = temp;
246 ohci_writel (ohci, temp, &ohci->regs->control);
247 (void) ohci_readl (ohci, &ohci->regs->control);
252 spin_lock_irq (&ohci->lock);
254 /* now ohci->lock is always held and irqs are always disabled */
256 /* keep it alive for more than ~5x suspend + resume costs */
257 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
259 /* maybe turn schedules back on */
262 if (!ohci->ed_rm_list) {
263 if (ohci->ed_controltail) {
265 find_head (ohci->ed_controltail)->dma,
266 &ohci->regs->ed_controlhead);
267 enables |= OHCI_CTRL_CLE;
270 if (ohci->ed_bulktail) {
271 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
272 &ohci->regs->ed_bulkhead);
273 enables |= OHCI_CTRL_BLE;
277 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
278 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
280 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
281 ohci->hc_control |= enables;
282 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
284 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
285 (void) ohci_readl (ohci, &ohci->regs->control);
291 static int ohci_bus_suspend (struct usb_hcd *hcd)
293 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
296 spin_lock_irq (&ohci->lock);
298 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
301 rc = ohci_rh_suspend (ohci, 0);
302 spin_unlock_irq (&ohci->lock);
306 static int ohci_bus_resume (struct usb_hcd *hcd)
308 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
311 if (time_before (jiffies, ohci->next_statechange))
314 spin_lock_irq (&ohci->lock);
316 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
319 rc = ohci_rh_resume (ohci);
320 spin_unlock_irq (&ohci->lock);
322 /* poll until we know a device is connected or we autostop */
324 usb_hcd_poll_rh_status(hcd);
328 /* Carry out polling-, autostop-, and autoresume-related state changes */
329 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
334 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
337 /* keep on polling until we know a device is connected
338 * and RHSC is enabled */
339 if (!ohci->autostop) {
341 !device_may_wakeup(&ohci_to_hcd(ohci)
342 ->self.root_hub->dev)) {
343 if (ohci_readl(ohci, &ohci->regs->intrenable) &
348 ohci->next_statechange = jiffies + HZ;
351 /* if no devices have been attached for one second, autostop */
353 if (changed || any_connected) {
355 ohci->next_statechange = jiffies +
357 } else if (time_after_eq(jiffies,
358 ohci->next_statechange)
360 && !(ohci->hc_control &
361 OHCI_SCHED_ENABLES)) {
362 ohci_rh_suspend(ohci, 1);
367 /* if there is a port change, autostart or ask to be resumed */
368 case OHCI_USB_SUSPEND:
369 case OHCI_USB_RESUME:
372 ohci_rh_resume(ohci);
374 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
376 /* everything is idle, no need for polling */
384 #else /* CONFIG_PM */
386 static inline int ohci_rh_resume(struct ohci_hcd *ohci)
391 /* Carry out polling-related state changes.
392 * autostop isn't used when CONFIG_PM is turned off.
394 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
399 /* keep on polling until RHSC is enabled */
400 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
405 #endif /* CONFIG_PM */
407 /*-------------------------------------------------------------------------*/
409 /* build "status change" packet (one or two bytes) from HC registers */
412 ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
414 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
415 int i, changed = 0, length = 1;
416 int any_connected = 0;
419 spin_lock_irqsave (&ohci->lock, flags);
420 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
423 /* undocumented erratum seen on at least rev D */
424 if ((ohci->flags & OHCI_QUIRK_AMD756)
425 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
426 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
427 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
428 /* retry later; "should not happen" */
433 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
434 buf [0] = changed = 1;
437 if (ohci->num_ports > 7) {
442 /* look at each port */
443 for (i = 0; i < ohci->num_ports; i++) {
444 u32 status = roothub_portstatus (ohci, i);
446 /* can't autostop if ports are connected */
447 any_connected |= (status & RH_PS_CCS);
449 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
450 | RH_PS_OCIC | RH_PS_PRSC)) {
453 buf [0] |= 1 << (i + 1);
455 buf [1] |= 1 << (i - 7);
459 hcd->poll_rh = ohci_root_hub_state_changes(ohci, changed,
463 spin_unlock_irqrestore (&ohci->lock, flags);
465 return changed ? length : 0;
468 /*-------------------------------------------------------------------------*/
471 ohci_hub_descriptor (
472 struct ohci_hcd *ohci,
473 struct usb_hub_descriptor *desc
475 u32 rh = roothub_a (ohci);
478 desc->bDescriptorType = 0x29;
479 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
480 desc->bHubContrCurrent = 0;
482 desc->bNbrPorts = ohci->num_ports;
483 temp = 1 + (ohci->num_ports / 8);
484 desc->bDescLength = 7 + 2 * temp;
487 if (rh & RH_A_NPS) /* no power switching? */
489 if (rh & RH_A_PSM) /* per-port power switching? */
491 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
493 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
495 desc->wHubCharacteristics = (__force __u16)cpu_to_hc16(ohci, temp);
497 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
498 rh = roothub_b (ohci);
499 memset(desc->bitmap, 0xff, sizeof(desc->bitmap));
500 desc->bitmap [0] = rh & RH_B_DR;
501 if (ohci->num_ports > 7) {
502 desc->bitmap [1] = (rh & RH_B_DR) >> 8;
503 desc->bitmap [2] = 0xff;
505 desc->bitmap [1] = 0xff;
508 /*-------------------------------------------------------------------------*/
510 #ifdef CONFIG_USB_OTG
512 static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
514 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
521 /* start port reset before HNP protocol times out */
522 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
523 if (!(status & RH_PS_CCS))
526 /* khubd will finish the reset later */
527 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
531 static void start_hnp(struct ohci_hcd *ohci);
535 #define ohci_start_port_reset NULL
539 /*-------------------------------------------------------------------------*/
542 /* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
543 * not necessarily continuous ... to guard against resume signaling.
544 * The short timeout is safe for non-root hubs, and is backward-compatible
545 * with earlier Linux hosts.
547 #ifdef CONFIG_USB_SUSPEND
548 #define PORT_RESET_MSEC 50
550 #define PORT_RESET_MSEC 10
553 /* this timer value might be vendor-specific ... */
554 #define PORT_RESET_HW_MSEC 10
556 /* wrap-aware logic morphed from <linux/jiffies.h> */
557 #define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
559 /* called from some task, normally khubd */
560 static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
562 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
564 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
565 u16 reset_done = now + PORT_RESET_MSEC;
567 /* build a "continuous enough" reset signal, with up to
568 * 3msec gap between pulses. scheduler HZ==100 must work;
569 * this might need to be deadline-scheduled.
572 /* spin until any current reset finishes */
574 temp = ohci_readl (ohci, portstat);
575 /* handle e.g. CardBus eject */
578 if (!(temp & RH_PS_PRS))
583 if (!(temp & RH_PS_CCS))
585 if (temp & RH_PS_PRSC)
586 ohci_writel (ohci, RH_PS_PRSC, portstat);
588 /* start the next reset, sleep till it's probably done */
589 ohci_writel (ohci, RH_PS_PRS, portstat);
590 msleep(PORT_RESET_HW_MSEC);
591 now = ohci_readl(ohci, &ohci->regs->fmnumber);
592 } while (tick_before(now, reset_done));
593 /* caller synchronizes using PRSC */
598 static int ohci_hub_control (
606 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
607 int ports = hcd_to_bus (hcd)->root_hub->maxchild;
611 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
615 case ClearHubFeature:
617 case C_HUB_OVER_CURRENT:
618 ohci_writel (ohci, RH_HS_OCIC,
619 &ohci->regs->roothub.status);
620 case C_HUB_LOCAL_POWER:
626 case ClearPortFeature:
627 if (!wIndex || wIndex > ports)
632 case USB_PORT_FEAT_ENABLE:
635 case USB_PORT_FEAT_C_ENABLE:
638 case USB_PORT_FEAT_SUSPEND:
641 case USB_PORT_FEAT_C_SUSPEND:
644 case USB_PORT_FEAT_POWER:
647 case USB_PORT_FEAT_C_CONNECTION:
650 case USB_PORT_FEAT_C_OVER_CURRENT:
653 case USB_PORT_FEAT_C_RESET:
659 ohci_writel (ohci, temp,
660 &ohci->regs->roothub.portstatus [wIndex]);
661 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
663 case GetHubDescriptor:
664 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
667 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
668 put_unaligned(cpu_to_le32 (temp), (__le32 *) buf);
671 if (!wIndex || wIndex > ports)
674 temp = roothub_portstatus (ohci, wIndex);
675 put_unaligned(cpu_to_le32 (temp), (__le32 *) buf);
677 #ifndef OHCI_VERBOSE_DEBUG
678 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
680 dbg_port (ohci, "GetStatus", wIndex, temp);
684 case C_HUB_OVER_CURRENT:
685 // FIXME: this can be cleared, yes?
686 case C_HUB_LOCAL_POWER:
693 if (!wIndex || wIndex > ports)
697 case USB_PORT_FEAT_SUSPEND:
698 #ifdef CONFIG_USB_OTG
699 if (hcd->self.otg_port == (wIndex + 1)
700 && hcd->self.b_hnp_enable)
704 ohci_writel (ohci, RH_PS_PSS,
705 &ohci->regs->roothub.portstatus [wIndex]);
707 case USB_PORT_FEAT_POWER:
708 ohci_writel (ohci, RH_PS_PPS,
709 &ohci->regs->roothub.portstatus [wIndex]);
711 case USB_PORT_FEAT_RESET:
712 retval = root_port_reset (ohci, wIndex);
721 /* "protocol stall" on error */