blob: ed678c17c4eaadd4f4ceee99a6161da3e00b3d76 [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
Alan Sternc6fcb852014-07-18 16:25:59 -040042static void update_done_list(struct ohci_hcd *);
Alan Sterncdb4dd12014-07-18 16:26:07 -040043static void ohci_work(struct ohci_hcd *);
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 }
Alan Sternc6fcb852014-07-18 16:25:59 -040090 update_done_list(ohci);
Alan Sterncdb4dd12014-07-18 16:26:07 -040091 ohci_work(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);
Alan Stern81e38332014-07-18 16:26:12 -0400312
313 if (rc == 0)
314 del_timer_sync(&ohci->io_watchdog);
Alan Stern8d1a2432006-09-26 14:46:16 -0400315 return rc;
316}
317
318static int ohci_bus_resume (struct usb_hcd *hcd)
319{
320 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
321 int rc;
322
323 if (time_before (jiffies, ohci->next_statechange))
324 msleep(5);
325
326 spin_lock_irq (&ohci->lock);
327
Alan Stern541c7d42010-06-22 16:39:10 -0400328 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400329 rc = -ESHUTDOWN;
330 else
331 rc = ohci_rh_resume (ohci);
332 spin_unlock_irq (&ohci->lock);
333
334 /* poll until we know a device is connected or we autostop */
335 if (rc == 0)
336 usb_hcd_poll_rh_status(hcd);
337 return rc;
338}
339
Alan Stern1f9fc882006-11-20 11:06:59 -0500340/* Carry out polling-, autostop-, and autoresume-related state changes */
341static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400342 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500343{
344 int poll_rh = 1;
Alan Stern71b74972008-10-09 15:40:23 -0400345 int rhsc_enable;
Alan Stern1f9fc882006-11-20 11:06:59 -0500346
Alan Sternee0b9be2010-06-25 14:02:24 -0400347 /* Some broken controllers never turn off RHSC in the interrupt
Alan Stern4a511bc2008-09-03 16:38:32 -0400348 * status register. For their sake we won't re-enable RHSC
349 * interrupts if the interrupt bit is already active.
350 */
Alan Stern4a511bc2008-09-03 16:38:32 -0400351 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
352 OHCI_INTR_RHSC;
353
Alan Stern1f9fc882006-11-20 11:06:59 -0500354 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
Alan Stern1f9fc882006-11-20 11:06:59 -0500355 case OHCI_USB_OPER:
Alan Stern4a511bc2008-09-03 16:38:32 -0400356 /* If no status changes are pending, enable RHSC interrupts. */
357 if (!rhsc_enable && !rhsc_status && !changed) {
358 rhsc_enable = OHCI_INTR_RHSC;
359 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
Alan Sternb5fb4542008-08-20 17:22:05 -0400360 }
361
362 /* Keep on polling until we know a device is connected
363 * and RHSC is enabled, or until we autostop.
364 */
Alan Stern1f9fc882006-11-20 11:06:59 -0500365 if (!ohci->autostop) {
366 if (any_connected ||
367 !device_may_wakeup(&ohci_to_hcd(ohci)
368 ->self.root_hub->dev)) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400369 if (rhsc_enable)
Alan Stern1f9fc882006-11-20 11:06:59 -0500370 poll_rh = 0;
371 } else {
372 ohci->autostop = 1;
373 ohci->next_statechange = jiffies + HZ;
374 }
375
376 /* if no devices have been attached for one second, autostop */
377 } else {
378 if (changed || any_connected) {
379 ohci->autostop = 0;
380 ohci->next_statechange = jiffies +
381 STATECHANGE_DELAY;
Alan Stern4a511bc2008-09-03 16:38:32 -0400382 } else if (time_after_eq(jiffies,
Alan Stern1f9fc882006-11-20 11:06:59 -0500383 ohci->next_statechange)
384 && !ohci->ed_rm_list
385 && !(ohci->hc_control &
386 OHCI_SCHED_ENABLES)) {
387 ohci_rh_suspend(ohci, 1);
Alan Stern4a511bc2008-09-03 16:38:32 -0400388 if (rhsc_enable)
389 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500390 }
391 }
392 break;
393
Alan Stern1f9fc882006-11-20 11:06:59 -0500394 case OHCI_USB_SUSPEND:
395 case OHCI_USB_RESUME:
Alan Stern4a511bc2008-09-03 16:38:32 -0400396 /* if there is a port change, autostart or ask to be resumed */
Alan Stern1f9fc882006-11-20 11:06:59 -0500397 if (changed) {
398 if (ohci->autostop)
399 ohci_rh_resume(ohci);
400 else
401 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
Alan Stern71b74972008-10-09 15:40:23 -0400402
403 /* If remote wakeup is disabled, stop polling */
404 } else if (!ohci->autostop &&
405 !ohci_to_hcd(ohci)->self.root_hub->
406 do_remote_wakeup) {
407 poll_rh = 0;
408
Alan Stern1f9fc882006-11-20 11:06:59 -0500409 } else {
Alan Stern71b74972008-10-09 15:40:23 -0400410 /* If no status changes are pending,
411 * enable RHSC interrupts
412 */
413 if (!rhsc_enable && !rhsc_status) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400414 rhsc_enable = OHCI_INTR_RHSC;
415 ohci_writel(ohci, rhsc_enable,
Alan Sternb5fb4542008-08-20 17:22:05 -0400416 &ohci->regs->intrenable);
Alan Stern4a511bc2008-09-03 16:38:32 -0400417 }
Alan Stern71b74972008-10-09 15:40:23 -0400418 /* Keep polling until RHSC is enabled */
Alan Stern4a511bc2008-09-03 16:38:32 -0400419 if (rhsc_enable)
420 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500421 }
422 break;
423 }
424 return poll_rh;
425}
426
427#else /* CONFIG_PM */
428
429static inline int ohci_rh_resume(struct ohci_hcd *ohci)
430{
431 return 0;
432}
433
434/* Carry out polling-related state changes.
435 * autostop isn't used when CONFIG_PM is turned off.
436 */
437static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400438 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500439{
Alan Sternb5fb4542008-08-20 17:22:05 -0400440 /* If RHSC is enabled, don't poll */
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700441 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
Alan Sternb5fb4542008-08-20 17:22:05 -0400442 return 0;
443
Alan Stern71b74972008-10-09 15:40:23 -0400444 /* If status changes are pending, continue polling.
445 * Conversely, if no status changes are pending but the RHSC
446 * status bit was set, then RHSC may be broken so continue polling.
447 */
448 if (changed || rhsc_status)
449 return 1;
450
451 /* It's safe to re-enable RHSC interrupts */
452 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
453 return 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500454}
455
David Brownell8ad7fe12005-09-13 19:59:11 -0700456#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458/*-------------------------------------------------------------------------*/
459
460/* build "status change" packet (one or two bytes) from HC registers */
461
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200462int ohci_hub_status_data(struct usb_hcd *hcd, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
464 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownellfdd13b32005-08-31 11:52:57 -0700465 int i, changed = 0, length = 1;
Alan Stern052ac012006-10-27 10:33:11 -0400466 int any_connected = 0;
Alan Stern71b74972008-10-09 15:40:23 -0400467 int rhsc_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 unsigned long flags;
469
470 spin_lock_irqsave (&ohci->lock, flags);
Alan Stern541c7d42010-06-22 16:39:10 -0400471 if (!HCD_HW_ACCESSIBLE(hcd))
Alan Stern6fd75b12007-05-04 11:57:00 -0400472 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
David Brownellfdd13b32005-08-31 11:52:57 -0700474 /* undocumented erratum seen on at least rev D */
475 if ((ohci->flags & OHCI_QUIRK_AMD756)
476 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
477 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
479 /* retry later; "should not happen" */
480 goto done;
481 }
482
483 /* init status */
484 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
485 buf [0] = changed = 1;
486 else
487 buf [0] = 0;
David Brownellfdd13b32005-08-31 11:52:57 -0700488 if (ohci->num_ports > 7) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 buf [1] = 0;
490 length++;
491 }
492
Alan Stern71b74972008-10-09 15:40:23 -0400493 /* Clear the RHSC status flag before reading the port statuses */
494 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
495 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
496 OHCI_INTR_RHSC;
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 /* look at each port */
David Brownellfdd13b32005-08-31 11:52:57 -0700499 for (i = 0; i < ohci->num_ports; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 u32 status = roothub_portstatus (ohci, i);
501
Alan Stern8d1a2432006-09-26 14:46:16 -0400502 /* can't autostop if ports are connected */
503 any_connected |= (status & RH_PS_CCS);
504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
506 | RH_PS_OCIC | RH_PS_PRSC)) {
507 changed = 1;
508 if (i < 7)
509 buf [0] |= 1 << (i + 1);
510 else
511 buf [1] |= 1 << (i - 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Alan Stern541c7d42010-06-22 16:39:10 -0400515 if (ohci_root_hub_state_changes(ohci, changed,
516 any_connected, rhsc_status))
517 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
518 else
519 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
520
David Brownelld4139842006-08-04 11:31:55 -0700521
522done:
523 spin_unlock_irqrestore (&ohci->lock, flags);
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 return changed ? length : 0;
526}
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200527EXPORT_SYMBOL_GPL(ohci_hub_status_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529/*-------------------------------------------------------------------------*/
530
531static void
532ohci_hub_descriptor (
533 struct ohci_hcd *ohci,
534 struct usb_hub_descriptor *desc
535) {
536 u32 rh = roothub_a (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 u16 temp;
538
Sergei Shtylyov7a2d2672015-03-29 01:19:48 +0300539 desc->bDescriptorType = USB_DT_HUB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
541 desc->bHubContrCurrent = 0;
542
David Brownellfdd13b32005-08-31 11:52:57 -0700543 desc->bNbrPorts = ohci->num_ports;
544 temp = 1 + (ohci->num_ports / 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 desc->bDescLength = 7 + 2 * temp;
546
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300547 temp = HUB_CHAR_COMMON_LPSM | HUB_CHAR_COMMON_OCPM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 if (rh & RH_A_NPS) /* no power switching? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300549 temp |= HUB_CHAR_NO_LPSM;
David Brownelldd9048a2006-12-05 03:18:31 -0800550 if (rh & RH_A_PSM) /* per-port power switching? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300551 temp |= HUB_CHAR_INDV_PORT_LPSM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300553 temp |= HUB_CHAR_NO_OCPM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300555 temp |= HUB_CHAR_INDV_PORT_OCPM;
Alan Stern7c71c6e2013-10-18 11:16:07 -0400556 desc->wHubCharacteristics = cpu_to_le16(temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Sarah Sharpda130512010-11-30 15:55:51 -0800558 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 rh = roothub_b (ohci);
John Youndbe79bb2001-09-17 00:00:00 -0700560 memset(desc->u.hs.DeviceRemovable, 0xff,
561 sizeof(desc->u.hs.DeviceRemovable));
562 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
David Brownellfdd13b32005-08-31 11:52:57 -0700563 if (ohci->num_ports > 7) {
John Youndbe79bb2001-09-17 00:00:00 -0700564 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
565 desc->u.hs.DeviceRemovable[2] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 } else
John Youndbe79bb2001-09-17 00:00:00 -0700567 desc->u.hs.DeviceRemovable[1] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
570/*-------------------------------------------------------------------------*/
571
572#ifdef CONFIG_USB_OTG
573
574static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
575{
576 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
577 u32 status;
578
579 if (!port)
580 return -EINVAL;
581 port--;
582
583 /* start port reset before HNP protocol times out */
584 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
585 if (!(status & RH_PS_CCS))
586 return -ENODEV;
587
Petr Mladek37ebb542014-09-19 17:32:23 +0200588 /* hub_wq will finish the reset later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
590 return 0;
591}
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#else
594
595#define ohci_start_port_reset NULL
596
597#endif
598
599/*-------------------------------------------------------------------------*/
600
601
602/* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
603 * not necessarily continuous ... to guard against resume signaling.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605#define PORT_RESET_MSEC 50
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607/* this timer value might be vendor-specific ... */
608#define PORT_RESET_HW_MSEC 10
609
610/* wrap-aware logic morphed from <linux/jiffies.h> */
611#define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
612
Petr Mladek37ebb542014-09-19 17:32:23 +0200613/* called from some task, normally hub_wq */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800614static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
616 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
Alan Stern1b7b61c2008-04-22 10:50:18 -0400617 u32 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
619 u16 reset_done = now + PORT_RESET_MSEC;
David Brownelle01e7fe2008-02-02 02:42:52 -0800620 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
622 /* build a "continuous enough" reset signal, with up to
623 * 3msec gap between pulses. scheduler HZ==100 must work;
624 * this might need to be deadline-scheduled.
625 */
626 do {
David Brownelle01e7fe2008-02-02 02:42:52 -0800627 int limit_2;
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 /* spin until any current reset finishes */
David Brownelle01e7fe2008-02-02 02:42:52 -0800630 limit_2 = PORT_RESET_HW_MSEC * 2;
631 while (--limit_2 >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 temp = ohci_readl (ohci, portstat);
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800633 /* handle e.g. CardBus eject */
634 if (temp == ~(u32)0)
635 return -ESHUTDOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if (!(temp & RH_PS_PRS))
637 break;
638 udelay (500);
David Brownelldd9048a2006-12-05 03:18:31 -0800639 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
David Brownelle01e7fe2008-02-02 02:42:52 -0800641 /* timeout (a hardware error) has been observed when
642 * EHCI sets CF while this driver is resetting a port;
643 * presumably other disconnect paths might do it too.
644 */
645 if (limit_2 < 0) {
646 ohci_dbg(ohci,
647 "port[%d] reset timeout, stat %08x\n",
648 port, temp);
649 break;
650 }
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 if (!(temp & RH_PS_CCS))
653 break;
654 if (temp & RH_PS_PRSC)
655 ohci_writel (ohci, RH_PS_PRSC, portstat);
656
657 /* start the next reset, sleep till it's probably done */
658 ohci_writel (ohci, RH_PS_PRS, portstat);
659 msleep(PORT_RESET_HW_MSEC);
660 now = ohci_readl(ohci, &ohci->regs->fmnumber);
David Brownelle01e7fe2008-02-02 02:42:52 -0800661 } while (tick_before(now, reset_done) && --limit_1 >= 0);
662
663 /* caller synchronizes using PRSC ... and handles PRS
664 * still being set when this returns.
665 */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800666
667 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668}
669
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200670int ohci_hub_control(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 struct usb_hcd *hcd,
672 u16 typeReq,
673 u16 wValue,
674 u16 wIndex,
675 char *buf,
676 u16 wLength
677) {
678 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
Alan Sternfcf7d212010-04-20 10:37:57 -0400679 int ports = ohci->num_ports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 u32 temp;
681 int retval = 0;
682
Alan Stern541c7d42010-06-22 16:39:10 -0400683 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100684 return -ESHUTDOWN;
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 switch (typeReq) {
687 case ClearHubFeature:
688 switch (wValue) {
689 case C_HUB_OVER_CURRENT:
690 ohci_writel (ohci, RH_HS_OCIC,
691 &ohci->regs->roothub.status);
692 case C_HUB_LOCAL_POWER:
693 break;
694 default:
695 goto error;
696 }
697 break;
698 case ClearPortFeature:
699 if (!wIndex || wIndex > ports)
700 goto error;
701 wIndex--;
702
703 switch (wValue) {
704 case USB_PORT_FEAT_ENABLE:
705 temp = RH_PS_CCS;
706 break;
707 case USB_PORT_FEAT_C_ENABLE:
708 temp = RH_PS_PESC;
709 break;
710 case USB_PORT_FEAT_SUSPEND:
711 temp = RH_PS_POCI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 break;
713 case USB_PORT_FEAT_C_SUSPEND:
714 temp = RH_PS_PSSC;
715 break;
716 case USB_PORT_FEAT_POWER:
717 temp = RH_PS_LSDA;
718 break;
719 case USB_PORT_FEAT_C_CONNECTION:
720 temp = RH_PS_CSC;
721 break;
722 case USB_PORT_FEAT_C_OVER_CURRENT:
723 temp = RH_PS_OCIC;
724 break;
725 case USB_PORT_FEAT_C_RESET:
726 temp = RH_PS_PRSC;
727 break;
728 default:
729 goto error;
730 }
731 ohci_writel (ohci, temp,
732 &ohci->regs->roothub.portstatus [wIndex]);
733 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
734 break;
735 case GetHubDescriptor:
736 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
737 break;
738 case GetHubStatus:
739 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700740 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 break;
742 case GetPortStatus:
743 if (!wIndex || wIndex > ports)
744 goto error;
745 wIndex--;
746 temp = roothub_portstatus (ohci, wIndex);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700747 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Oliver Neukum00b033b2013-11-18 13:23:00 +0100749 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
750 dbg_port(ohci, "GetStatus", wIndex, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 break;
752 case SetHubFeature:
753 switch (wValue) {
754 case C_HUB_OVER_CURRENT:
755 // FIXME: this can be cleared, yes?
756 case C_HUB_LOCAL_POWER:
757 break;
758 default:
759 goto error;
760 }
761 break;
762 case SetPortFeature:
763 if (!wIndex || wIndex > ports)
764 goto error;
765 wIndex--;
766 switch (wValue) {
767 case USB_PORT_FEAT_SUSPEND:
768#ifdef CONFIG_USB_OTG
769 if (hcd->self.otg_port == (wIndex + 1)
770 && hcd->self.b_hnp_enable)
Dmitry Baryshkove8b24452008-07-06 14:26:30 +0400771 ohci->start_hnp(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 else
773#endif
774 ohci_writel (ohci, RH_PS_PSS,
775 &ohci->regs->roothub.portstatus [wIndex]);
776 break;
777 case USB_PORT_FEAT_POWER:
778 ohci_writel (ohci, RH_PS_PPS,
779 &ohci->regs->roothub.portstatus [wIndex]);
780 break;
781 case USB_PORT_FEAT_RESET:
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800782 retval = root_port_reset (ohci, wIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 break;
784 default:
785 goto error;
786 }
787 break;
788
789 default:
790error:
791 /* "protocol stall" on error */
792 retval = -EPIPE;
793 }
794 return retval;
795}
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200796EXPORT_SYMBOL_GPL(ohci_hub_control);