blob: cd871b89501325407af3ab3ebf0eb56ab0814a79 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * OHCI HCD (Host Controller Driver) for USB.
David Brownelldd9048a2006-12-05 03:18:31 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
David Brownelldd9048a2006-12-05 03:18:31 -08006 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * This file is licenced under GPL
8 */
9
10/*-------------------------------------------------------------------------*/
11
12/*
13 * OHCI Root Hub ... the nonsharable stuff
14 */
15
16#define dbg_port(hc,label,num,value) \
17 ohci_dbg (hc, \
18 "%s roothub.portstatus [%d] " \
19 "= 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
20 label, num, temp, \
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" : "", \
David Brownelldd9048a2006-12-05 03:18:31 -080026 \
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 (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" : "", \
David Brownelldd9048a2006-12-05 03:18:31 -080032 \
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 (temp & RH_PS_PES) ? " PES" : "", \
34 (temp & RH_PS_CCS) ? " CCS" : "" \
35 );
36
37/*-------------------------------------------------------------------------*/
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define OHCI_SCHED_ENABLES \
40 (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
41
David Howells7d12e782006-10-05 14:55:46 +010042static void dl_done_list (struct ohci_hcd *);
43static void finish_unlinks (struct ohci_hcd *, u16);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Alan Sternb1878442006-10-24 12:02:31 -040045#ifdef CONFIG_PM
Alan Stern8d1a2432006-09-26 14:46:16 -040046static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
47__releases(ohci->lock)
48__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070049{
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 int status = 0;
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +110051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
53 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
54 case OHCI_USB_RESUME:
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);
60 /* FALL THROUGH */
61 case OHCI_USB_RESET:
62 status = -EBUSY;
63 ohci_dbg (ohci, "needs reinit!\n");
64 goto done;
65 case OHCI_USB_SUSPEND:
Alan Stern8d1a2432006-09-26 14:46:16 -040066 if (!ohci->autostop) {
67 ohci_dbg (ohci, "already suspended\n");
68 goto done;
69 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 }
Alan Stern8d1a2432006-09-26 14:46:16 -040071 ohci_dbg (ohci, "%s root hub\n",
72 autostop ? "auto-stop" : "suspend");
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74 /* First stop any processing */
Alan Stern8d1a2432006-09-26 14:46:16 -040075 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 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);
80
81 /* sched disables take effect on the next frame,
82 * then the last WDH could take 6+ msec
83 */
84 ohci_dbg (ohci, "stopping schedules ...\n");
Alan Stern8d1a2432006-09-26 14:46:16 -040085 ohci->autostop = 0;
86 spin_unlock_irq (&ohci->lock);
87 msleep (8);
88 spin_lock_irq (&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 }
David Howells7d12e782006-10-05 14:55:46 +010090 dl_done_list (ohci);
91 finish_unlinks (ohci, ohci_frame_no(ohci));
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Alan Sternc1db30a2014-05-01 15:21:42 -040093 /*
94 * Some controllers don't handle "global" suspend properly if
95 * there are unsuspended ports. For these controllers, put all
96 * the enabled ports into suspend before suspending the root hub.
97 */
98 if (ohci->flags & OHCI_QUIRK_GLOBAL_SUSPEND) {
99 __hc32 __iomem *portstat = ohci->regs->roothub.portstatus;
100 int i;
101 unsigned temp;
102
103 for (i = 0; i < ohci->num_ports; (++i, ++portstat)) {
104 temp = ohci_readl(ohci, portstat);
105 if ((temp & (RH_PS_PES | RH_PS_PSS)) ==
106 RH_PS_PES)
107 ohci_writel(ohci, RH_PS_PSS, portstat);
108 }
109 }
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 /* maybe resume can wake root hub */
Alan Stern58a97ff2008-04-14 12:17:10 -0400112 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 ohci->hc_control |= OHCI_CTRL_RWE;
Alan Stern58a97ff2008-04-14 12:17:10 -0400114 } else {
Alan Stern5f474932008-04-14 12:17:49 -0400115 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
116 &ohci->regs->intrdisable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 ohci->hc_control &= ~OHCI_CTRL_RWE;
Alan Stern1f7e1a32006-09-25 15:41:21 -0400118 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
David Brownellf197b2c2005-09-22 22:42:53 -0700120 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
121 * which doesn't imply ports will first be individually suspended.
122 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 ohci->hc_control &= ~OHCI_CTRL_HCFS;
124 ohci->hc_control |= OHCI_USB_SUSPEND;
125 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
126 (void) ohci_readl (ohci, &ohci->regs->control);
127
128 /* no resumes until devices finish suspending */
Alan Stern8d1a2432006-09-26 14:46:16 -0400129 if (!autostop) {
130 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
131 ohci->autostop = 0;
Alan Sternb7463c72011-11-17 16:41:56 -0500132 ohci->rh_state = OHCI_RH_SUSPENDED;
Alan Stern8d1a2432006-09-26 14:46:16 -0400133 }
David Brownelld4139842006-08-04 11:31:55 -0700134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 return status;
137}
138
139static inline struct ed *find_head (struct ed *ed)
140{
141 /* for bulk and control lists */
142 while (ed->ed_prev)
143 ed = ed->ed_prev;
144 return ed;
145}
146
147/* caller has locked the root hub */
Alan Stern8d1a2432006-09-26 14:46:16 -0400148static int ohci_rh_resume (struct ohci_hcd *ohci)
149__releases(ohci->lock)
150__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
Alan Stern8d1a2432006-09-26 14:46:16 -0400152 struct usb_hcd *hcd = ohci_to_hcd (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 u32 temp, enables;
154 int status = -EINPROGRESS;
Alan Stern8d1a2432006-09-26 14:46:16 -0400155 int autostopped = ohci->autostop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Alan Stern8d1a2432006-09-26 14:46:16 -0400157 ohci->autostop = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
159
160 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
David Brownellf197b2c2005-09-22 22:42:53 -0700161 /* this can happen after resuming a swsusp snapshot */
Alan Sternb7463c72011-11-17 16:41:56 -0500162 if (ohci->rh_state != OHCI_RH_RUNNING) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
164 ohci->hc_control);
165 status = -EBUSY;
166 /* this happens when pmcore resumes HC then root */
167 } else {
168 ohci_dbg (ohci, "duplicate resume\n");
169 status = 0;
170 }
171 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
172 case OHCI_USB_SUSPEND:
173 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
174 ohci->hc_control |= OHCI_USB_RESUME;
175 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
176 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400177 ohci_dbg (ohci, "%s root hub\n",
178 autostopped ? "auto-start" : "resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 break;
180 case OHCI_USB_RESUME:
181 /* HCFS changes sometime after INTR_RD */
Alan Stern1b7be3c2006-11-06 12:05:00 -0500182 ohci_dbg(ohci, "%swakeup root hub\n",
Alan Stern583cead2006-10-24 12:04:22 -0400183 autostopped ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 break;
185 case OHCI_USB_OPER:
David Brownellf197b2c2005-09-22 22:42:53 -0700186 /* this can happen after resuming a swsusp snapshot */
187 ohci_dbg (ohci, "snapshot resume? reinit\n");
188 status = -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 break;
190 default: /* RESET, we lost power */
David Brownellf197b2c2005-09-22 22:42:53 -0700191 ohci_dbg (ohci, "lost power\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 status = -EBUSY;
193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 if (status == -EBUSY) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400195 if (!autostopped) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400196 spin_unlock_irq (&ohci->lock);
Alan Stern8d1a2432006-09-26 14:46:16 -0400197 status = ohci_restart (ohci);
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200198
199 usb_root_hub_lost_power(hcd->self.root_hub);
200
Alan Stern8d1a2432006-09-26 14:46:16 -0400201 spin_lock_irq (&ohci->lock);
202 }
203 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 }
205 if (status != -EINPROGRESS)
206 return status;
Alan Stern8d1a2432006-09-26 14:46:16 -0400207 if (autostopped)
208 goto skip_resume;
209 spin_unlock_irq (&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 /* Some controllers (lucent erratum) need extra-long delays */
David Brownellf197b2c2005-09-22 22:42:53 -0700212 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214 temp = ohci_readl (ohci, &ohci->regs->control);
215 temp &= OHCI_CTRL_HCFS;
216 if (temp != OHCI_USB_RESUME) {
217 ohci_err (ohci, "controller won't resume\n");
Alan Stern565402b2006-10-27 10:35:01 -0400218 spin_lock_irq(&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 return -EBUSY;
220 }
221
222 /* disable old schedule state, reinit from scratch */
223 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
224 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
225 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
226 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
227 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
228 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
229
230 /* Sometimes PCI D3 suspend trashes frame timings ... */
231 periodic_reinit (ohci);
232
Alan Stern7c71c6e2013-10-18 11:16:07 -0400233 /*
234 * The following code is executed with ohci->lock held and
235 * irqs disabled if and only if autostopped is true. This
236 * will cause sparse to warn about a "context imbalance".
Alan Stern8d1a2432006-09-26 14:46:16 -0400237 */
Alan Stern8d1a2432006-09-26 14:46:16 -0400238skip_resume:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 /* interrupts might have been disabled */
240 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
241 if (ohci->ed_rm_list)
242 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244 /* Then re-enable operations */
245 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
246 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400247 if (!autostopped)
248 msleep (3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
David Brownell6a9062f2006-01-23 15:28:07 -0800250 temp = ohci->hc_control;
251 temp &= OHCI_CTRL_RWC;
252 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 ohci->hc_control = temp;
254 ohci_writel (ohci, temp, &ohci->regs->control);
255 (void) ohci_readl (ohci, &ohci->regs->control);
256
257 /* TRSMRCY */
Alan Stern8d1a2432006-09-26 14:46:16 -0400258 if (!autostopped) {
259 msleep (10);
260 spin_lock_irq (&ohci->lock);
261 }
262 /* now ohci->lock is always held and irqs are always disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
David Brownelld4139842006-08-04 11:31:55 -0700264 /* keep it alive for more than ~5x suspend + resume costs */
265 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 /* maybe turn schedules back on */
268 enables = 0;
269 temp = 0;
270 if (!ohci->ed_rm_list) {
271 if (ohci->ed_controltail) {
272 ohci_writel (ohci,
273 find_head (ohci->ed_controltail)->dma,
274 &ohci->regs->ed_controlhead);
275 enables |= OHCI_CTRL_CLE;
276 temp |= OHCI_CLF;
277 }
278 if (ohci->ed_bulktail) {
279 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
280 &ohci->regs->ed_bulkhead);
281 enables |= OHCI_CTRL_BLE;
282 temp |= OHCI_BLF;
283 }
284 }
285 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
286 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
287 if (enables) {
288 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
289 ohci->hc_control |= enables;
290 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
291 if (temp)
292 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
293 (void) ohci_readl (ohci, &ohci->regs->control);
294 }
295
Alan Sternb7463c72011-11-17 16:41:56 -0500296 ohci->rh_state = OHCI_RH_RUNNING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 return 0;
298}
299
Alan Stern8d1a2432006-09-26 14:46:16 -0400300static int ohci_bus_suspend (struct usb_hcd *hcd)
301{
302 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
303 int rc;
304
305 spin_lock_irq (&ohci->lock);
306
Alan Stern541c7d42010-06-22 16:39:10 -0400307 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400308 rc = -ESHUTDOWN;
309 else
310 rc = ohci_rh_suspend (ohci, 0);
311 spin_unlock_irq (&ohci->lock);
312 return rc;
313}
314
315static int ohci_bus_resume (struct usb_hcd *hcd)
316{
317 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
318 int rc;
319
320 if (time_before (jiffies, ohci->next_statechange))
321 msleep(5);
322
323 spin_lock_irq (&ohci->lock);
324
Alan Stern541c7d42010-06-22 16:39:10 -0400325 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400326 rc = -ESHUTDOWN;
327 else
328 rc = ohci_rh_resume (ohci);
329 spin_unlock_irq (&ohci->lock);
330
331 /* poll until we know a device is connected or we autostop */
332 if (rc == 0)
333 usb_hcd_poll_rh_status(hcd);
334 return rc;
335}
336
Alan Stern1f9fc882006-11-20 11:06:59 -0500337/* Carry out polling-, autostop-, and autoresume-related state changes */
338static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400339 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500340{
341 int poll_rh = 1;
Alan Stern71b74972008-10-09 15:40:23 -0400342 int rhsc_enable;
Alan Stern1f9fc882006-11-20 11:06:59 -0500343
Alan Sternee0b9be2010-06-25 14:02:24 -0400344 /* Some broken controllers never turn off RHSC in the interrupt
Alan Stern4a511bc2008-09-03 16:38:32 -0400345 * status register. For their sake we won't re-enable RHSC
346 * interrupts if the interrupt bit is already active.
347 */
Alan Stern4a511bc2008-09-03 16:38:32 -0400348 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
349 OHCI_INTR_RHSC;
350
Alan Stern1f9fc882006-11-20 11:06:59 -0500351 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
Alan Stern1f9fc882006-11-20 11:06:59 -0500352 case OHCI_USB_OPER:
Alan Stern4a511bc2008-09-03 16:38:32 -0400353 /* If no status changes are pending, enable RHSC interrupts. */
354 if (!rhsc_enable && !rhsc_status && !changed) {
355 rhsc_enable = OHCI_INTR_RHSC;
356 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
Alan Sternb5fb4542008-08-20 17:22:05 -0400357 }
358
359 /* Keep on polling until we know a device is connected
360 * and RHSC is enabled, or until we autostop.
361 */
Alan Stern1f9fc882006-11-20 11:06:59 -0500362 if (!ohci->autostop) {
363 if (any_connected ||
364 !device_may_wakeup(&ohci_to_hcd(ohci)
365 ->self.root_hub->dev)) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400366 if (rhsc_enable)
Alan Stern1f9fc882006-11-20 11:06:59 -0500367 poll_rh = 0;
368 } else {
369 ohci->autostop = 1;
370 ohci->next_statechange = jiffies + HZ;
371 }
372
373 /* if no devices have been attached for one second, autostop */
374 } else {
375 if (changed || any_connected) {
376 ohci->autostop = 0;
377 ohci->next_statechange = jiffies +
378 STATECHANGE_DELAY;
Alan Stern4a511bc2008-09-03 16:38:32 -0400379 } else if (time_after_eq(jiffies,
Alan Stern1f9fc882006-11-20 11:06:59 -0500380 ohci->next_statechange)
381 && !ohci->ed_rm_list
382 && !(ohci->hc_control &
383 OHCI_SCHED_ENABLES)) {
384 ohci_rh_suspend(ohci, 1);
Alan Stern4a511bc2008-09-03 16:38:32 -0400385 if (rhsc_enable)
386 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500387 }
388 }
389 break;
390
Alan Stern1f9fc882006-11-20 11:06:59 -0500391 case OHCI_USB_SUSPEND:
392 case OHCI_USB_RESUME:
Alan Stern4a511bc2008-09-03 16:38:32 -0400393 /* if there is a port change, autostart or ask to be resumed */
Alan Stern1f9fc882006-11-20 11:06:59 -0500394 if (changed) {
395 if (ohci->autostop)
396 ohci_rh_resume(ohci);
397 else
398 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
Alan Stern71b74972008-10-09 15:40:23 -0400399
400 /* If remote wakeup is disabled, stop polling */
401 } else if (!ohci->autostop &&
402 !ohci_to_hcd(ohci)->self.root_hub->
403 do_remote_wakeup) {
404 poll_rh = 0;
405
Alan Stern1f9fc882006-11-20 11:06:59 -0500406 } else {
Alan Stern71b74972008-10-09 15:40:23 -0400407 /* If no status changes are pending,
408 * enable RHSC interrupts
409 */
410 if (!rhsc_enable && !rhsc_status) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400411 rhsc_enable = OHCI_INTR_RHSC;
412 ohci_writel(ohci, rhsc_enable,
Alan Sternb5fb4542008-08-20 17:22:05 -0400413 &ohci->regs->intrenable);
Alan Stern4a511bc2008-09-03 16:38:32 -0400414 }
Alan Stern71b74972008-10-09 15:40:23 -0400415 /* Keep polling until RHSC is enabled */
Alan Stern4a511bc2008-09-03 16:38:32 -0400416 if (rhsc_enable)
417 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500418 }
419 break;
420 }
421 return poll_rh;
422}
423
424#else /* CONFIG_PM */
425
426static inline int ohci_rh_resume(struct ohci_hcd *ohci)
427{
428 return 0;
429}
430
431/* Carry out polling-related state changes.
432 * autostop isn't used when CONFIG_PM is turned off.
433 */
434static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400435 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500436{
Alan Sternb5fb4542008-08-20 17:22:05 -0400437 /* If RHSC is enabled, don't poll */
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700438 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
Alan Sternb5fb4542008-08-20 17:22:05 -0400439 return 0;
440
Alan Stern71b74972008-10-09 15:40:23 -0400441 /* If status changes are pending, continue polling.
442 * Conversely, if no status changes are pending but the RHSC
443 * status bit was set, then RHSC may be broken so continue polling.
444 */
445 if (changed || rhsc_status)
446 return 1;
447
448 /* It's safe to re-enable RHSC interrupts */
449 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
450 return 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500451}
452
David Brownell8ad7fe12005-09-13 19:59:11 -0700453#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455/*-------------------------------------------------------------------------*/
456
457/* build "status change" packet (one or two bytes) from HC registers */
458
459static int
460ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
461{
462 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownellfdd13b32005-08-31 11:52:57 -0700463 int i, changed = 0, length = 1;
Alan Stern052ac012006-10-27 10:33:11 -0400464 int any_connected = 0;
Alan Stern71b74972008-10-09 15:40:23 -0400465 int rhsc_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 unsigned long flags;
467
468 spin_lock_irqsave (&ohci->lock, flags);
Alan Stern541c7d42010-06-22 16:39:10 -0400469 if (!HCD_HW_ACCESSIBLE(hcd))
Alan Stern6fd75b12007-05-04 11:57:00 -0400470 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
David Brownellfdd13b32005-08-31 11:52:57 -0700472 /* undocumented erratum seen on at least rev D */
473 if ((ohci->flags & OHCI_QUIRK_AMD756)
474 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
475 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
477 /* retry later; "should not happen" */
478 goto done;
479 }
480
481 /* init status */
482 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
483 buf [0] = changed = 1;
484 else
485 buf [0] = 0;
David Brownellfdd13b32005-08-31 11:52:57 -0700486 if (ohci->num_ports > 7) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 buf [1] = 0;
488 length++;
489 }
490
Alan Stern71b74972008-10-09 15:40:23 -0400491 /* Clear the RHSC status flag before reading the port statuses */
492 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
493 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
494 OHCI_INTR_RHSC;
495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 /* look at each port */
David Brownellfdd13b32005-08-31 11:52:57 -0700497 for (i = 0; i < ohci->num_ports; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 u32 status = roothub_portstatus (ohci, i);
499
Alan Stern8d1a2432006-09-26 14:46:16 -0400500 /* can't autostop if ports are connected */
501 any_connected |= (status & RH_PS_CCS);
502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
504 | RH_PS_OCIC | RH_PS_PRSC)) {
505 changed = 1;
506 if (i < 7)
507 buf [0] |= 1 << (i + 1);
508 else
509 buf [1] |= 1 << (i - 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Alan Stern541c7d42010-06-22 16:39:10 -0400513 if (ohci_root_hub_state_changes(ohci, changed,
514 any_connected, rhsc_status))
515 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
516 else
517 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
518
David Brownelld4139842006-08-04 11:31:55 -0700519
520done:
521 spin_unlock_irqrestore (&ohci->lock, flags);
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 return changed ? length : 0;
524}
525
526/*-------------------------------------------------------------------------*/
527
528static void
529ohci_hub_descriptor (
530 struct ohci_hcd *ohci,
531 struct usb_hub_descriptor *desc
532) {
533 u32 rh = roothub_a (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 u16 temp;
535
536 desc->bDescriptorType = 0x29;
537 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
538 desc->bHubContrCurrent = 0;
539
David Brownellfdd13b32005-08-31 11:52:57 -0700540 desc->bNbrPorts = ohci->num_ports;
541 temp = 1 + (ohci->num_ports / 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 desc->bDescLength = 7 + 2 * temp;
543
544 temp = 0;
545 if (rh & RH_A_NPS) /* no power switching? */
546 temp |= 0x0002;
David Brownelldd9048a2006-12-05 03:18:31 -0800547 if (rh & RH_A_PSM) /* per-port power switching? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 temp |= 0x0001;
549 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
550 temp |= 0x0010;
551 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
552 temp |= 0x0008;
Alan Stern7c71c6e2013-10-18 11:16:07 -0400553 desc->wHubCharacteristics = cpu_to_le16(temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Sarah Sharpda130512010-11-30 15:55:51 -0800555 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 rh = roothub_b (ohci);
John Youndbe79bb2001-09-17 00:00:00 -0700557 memset(desc->u.hs.DeviceRemovable, 0xff,
558 sizeof(desc->u.hs.DeviceRemovable));
559 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
David Brownellfdd13b32005-08-31 11:52:57 -0700560 if (ohci->num_ports > 7) {
John Youndbe79bb2001-09-17 00:00:00 -0700561 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
562 desc->u.hs.DeviceRemovable[2] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 } else
John Youndbe79bb2001-09-17 00:00:00 -0700564 desc->u.hs.DeviceRemovable[1] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
567/*-------------------------------------------------------------------------*/
568
569#ifdef CONFIG_USB_OTG
570
571static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
572{
573 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
574 u32 status;
575
576 if (!port)
577 return -EINVAL;
578 port--;
579
580 /* start port reset before HNP protocol times out */
581 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
582 if (!(status & RH_PS_CCS))
583 return -ENODEV;
584
585 /* khubd will finish the reset later */
586 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
587 return 0;
588}
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590#else
591
592#define ohci_start_port_reset NULL
593
594#endif
595
596/*-------------------------------------------------------------------------*/
597
598
599/* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
600 * not necessarily continuous ... to guard against resume signaling.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602#define PORT_RESET_MSEC 50
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604/* this timer value might be vendor-specific ... */
605#define PORT_RESET_HW_MSEC 10
606
607/* wrap-aware logic morphed from <linux/jiffies.h> */
608#define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
609
610/* called from some task, normally khubd */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800611static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
613 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
Alan Stern1b7b61c2008-04-22 10:50:18 -0400614 u32 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
616 u16 reset_done = now + PORT_RESET_MSEC;
David Brownelle01e7fe2008-02-02 02:42:52 -0800617 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 /* build a "continuous enough" reset signal, with up to
620 * 3msec gap between pulses. scheduler HZ==100 must work;
621 * this might need to be deadline-scheduled.
622 */
623 do {
David Brownelle01e7fe2008-02-02 02:42:52 -0800624 int limit_2;
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 /* spin until any current reset finishes */
David Brownelle01e7fe2008-02-02 02:42:52 -0800627 limit_2 = PORT_RESET_HW_MSEC * 2;
628 while (--limit_2 >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 temp = ohci_readl (ohci, portstat);
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800630 /* handle e.g. CardBus eject */
631 if (temp == ~(u32)0)
632 return -ESHUTDOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 if (!(temp & RH_PS_PRS))
634 break;
635 udelay (500);
David Brownelldd9048a2006-12-05 03:18:31 -0800636 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
David Brownelle01e7fe2008-02-02 02:42:52 -0800638 /* timeout (a hardware error) has been observed when
639 * EHCI sets CF while this driver is resetting a port;
640 * presumably other disconnect paths might do it too.
641 */
642 if (limit_2 < 0) {
643 ohci_dbg(ohci,
644 "port[%d] reset timeout, stat %08x\n",
645 port, temp);
646 break;
647 }
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 if (!(temp & RH_PS_CCS))
650 break;
651 if (temp & RH_PS_PRSC)
652 ohci_writel (ohci, RH_PS_PRSC, portstat);
653
654 /* start the next reset, sleep till it's probably done */
655 ohci_writel (ohci, RH_PS_PRS, portstat);
656 msleep(PORT_RESET_HW_MSEC);
657 now = ohci_readl(ohci, &ohci->regs->fmnumber);
David Brownelle01e7fe2008-02-02 02:42:52 -0800658 } while (tick_before(now, reset_done) && --limit_1 >= 0);
659
660 /* caller synchronizes using PRSC ... and handles PRS
661 * still being set when this returns.
662 */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800663
664 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666
667static int ohci_hub_control (
668 struct usb_hcd *hcd,
669 u16 typeReq,
670 u16 wValue,
671 u16 wIndex,
672 char *buf,
673 u16 wLength
674) {
675 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
Alan Sternfcf7d212010-04-20 10:37:57 -0400676 int ports = ohci->num_ports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 u32 temp;
678 int retval = 0;
679
Alan Stern541c7d42010-06-22 16:39:10 -0400680 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100681 return -ESHUTDOWN;
682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 switch (typeReq) {
684 case ClearHubFeature:
685 switch (wValue) {
686 case C_HUB_OVER_CURRENT:
687 ohci_writel (ohci, RH_HS_OCIC,
688 &ohci->regs->roothub.status);
689 case C_HUB_LOCAL_POWER:
690 break;
691 default:
692 goto error;
693 }
694 break;
695 case ClearPortFeature:
696 if (!wIndex || wIndex > ports)
697 goto error;
698 wIndex--;
699
700 switch (wValue) {
701 case USB_PORT_FEAT_ENABLE:
702 temp = RH_PS_CCS;
703 break;
704 case USB_PORT_FEAT_C_ENABLE:
705 temp = RH_PS_PESC;
706 break;
707 case USB_PORT_FEAT_SUSPEND:
708 temp = RH_PS_POCI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 break;
710 case USB_PORT_FEAT_C_SUSPEND:
711 temp = RH_PS_PSSC;
712 break;
713 case USB_PORT_FEAT_POWER:
714 temp = RH_PS_LSDA;
715 break;
716 case USB_PORT_FEAT_C_CONNECTION:
717 temp = RH_PS_CSC;
718 break;
719 case USB_PORT_FEAT_C_OVER_CURRENT:
720 temp = RH_PS_OCIC;
721 break;
722 case USB_PORT_FEAT_C_RESET:
723 temp = RH_PS_PRSC;
724 break;
725 default:
726 goto error;
727 }
728 ohci_writel (ohci, temp,
729 &ohci->regs->roothub.portstatus [wIndex]);
730 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
731 break;
732 case GetHubDescriptor:
733 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
734 break;
735 case GetHubStatus:
736 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700737 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 break;
739 case GetPortStatus:
740 if (!wIndex || wIndex > ports)
741 goto error;
742 wIndex--;
743 temp = roothub_portstatus (ohci, wIndex);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700744 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Oliver Neukum00b033b2013-11-18 13:23:00 +0100746 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
747 dbg_port(ohci, "GetStatus", wIndex, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 break;
749 case SetHubFeature:
750 switch (wValue) {
751 case C_HUB_OVER_CURRENT:
752 // FIXME: this can be cleared, yes?
753 case C_HUB_LOCAL_POWER:
754 break;
755 default:
756 goto error;
757 }
758 break;
759 case SetPortFeature:
760 if (!wIndex || wIndex > ports)
761 goto error;
762 wIndex--;
763 switch (wValue) {
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)
Dmitry Baryshkove8b24452008-07-06 14:26:30 +0400768 ohci->start_hnp(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 else
770#endif
771 ohci_writel (ohci, RH_PS_PSS,
772 &ohci->regs->roothub.portstatus [wIndex]);
773 break;
774 case USB_PORT_FEAT_POWER:
775 ohci_writel (ohci, RH_PS_PPS,
776 &ohci->regs->roothub.portstatus [wIndex]);
777 break;
778 case USB_PORT_FEAT_RESET:
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800779 retval = root_port_reset (ohci, wIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 break;
781 default:
782 goto error;
783 }
784 break;
785
786 default:
787error:
788 /* "protocol stall" on error */
789 retval = -EPIPE;
790 }
791 return retval;
792}
793