blob: 634f3c7bf7748085758635ffe86108c948e0d08e [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-1.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * OHCI HCD (Host Controller Driver) for USB.
David Brownelldd9048a2006-12-05 03:18:31 -08004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
6 * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
David Brownelldd9048a2006-12-05 03:18:31 -08007 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * This file is licenced under GPL
9 */
10
11/*-------------------------------------------------------------------------*/
12
13/*
14 * OHCI Root Hub ... the nonsharable stuff
15 */
16
17#define dbg_port(hc,label,num,value) \
18 ohci_dbg (hc, \
19 "%s roothub.portstatus [%d] " \
20 "= 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
Jelle Martijn Kokbaa42a32017-02-08 16:53:08 +010021 label, num, value, \
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" : "", \
David Brownelldd9048a2006-12-05 03:18:31 -080027 \
Jelle Martijn Kokbaa42a32017-02-08 16:53:08 +010028 (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" : "", \
David Brownelldd9048a2006-12-05 03:18:31 -080033 \
Jelle Martijn Kokbaa42a32017-02-08 16:53:08 +010034 (value & RH_PS_PES) ? " PES" : "", \
35 (value & RH_PS_CCS) ? " CCS" : "" \
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 );
37
38/*-------------------------------------------------------------------------*/
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#define OHCI_SCHED_ENABLES \
41 (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
42
Alan Sternc6fcb852014-07-18 16:25:59 -040043static void update_done_list(struct ohci_hcd *);
Alan Sterncdb4dd12014-07-18 16:26:07 -040044static void ohci_work(struct ohci_hcd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Alan Sternb1878442006-10-24 12:02:31 -040046#ifdef CONFIG_PM
Alan Stern8d1a2432006-09-26 14:46:16 -040047static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
48__releases(ohci->lock)
49__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 int status = 0;
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +110052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
54 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
55 case OHCI_USB_RESUME:
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);
61 /* FALL THROUGH */
62 case OHCI_USB_RESET:
63 status = -EBUSY;
64 ohci_dbg (ohci, "needs reinit!\n");
65 goto done;
66 case OHCI_USB_SUSPEND:
Alan Stern8d1a2432006-09-26 14:46:16 -040067 if (!ohci->autostop) {
68 ohci_dbg (ohci, "already suspended\n");
69 goto done;
70 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 }
Alan Stern8d1a2432006-09-26 14:46:16 -040072 ohci_dbg (ohci, "%s root hub\n",
73 autostop ? "auto-stop" : "suspend");
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 /* First stop any processing */
Alan Stern8d1a2432006-09-26 14:46:16 -040076 if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 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);
81
82 /* sched disables take effect on the next frame,
83 * then the last WDH could take 6+ msec
84 */
85 ohci_dbg (ohci, "stopping schedules ...\n");
Alan Stern8d1a2432006-09-26 14:46:16 -040086 ohci->autostop = 0;
87 spin_unlock_irq (&ohci->lock);
88 msleep (8);
89 spin_lock_irq (&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 }
Alan Sternc6fcb852014-07-18 16:25:59 -040091 update_done_list(ohci);
Alan Sterncdb4dd12014-07-18 16:26:07 -040092 ohci_work(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Alan Sternc1db30a2014-05-01 15:21:42 -040094 /*
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.
98 */
99 if (ohci->flags & OHCI_QUIRK_GLOBAL_SUSPEND) {
100 __hc32 __iomem *portstat = ohci->regs->roothub.portstatus;
101 int i;
102 unsigned temp;
103
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)) ==
107 RH_PS_PES)
108 ohci_writel(ohci, RH_PS_PSS, portstat);
109 }
110 }
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 /* maybe resume can wake root hub */
Alan Stern58a97ff2008-04-14 12:17:10 -0400113 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 ohci->hc_control |= OHCI_CTRL_RWE;
Alan Stern58a97ff2008-04-14 12:17:10 -0400115 } else {
Alan Stern5f474932008-04-14 12:17:49 -0400116 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
117 &ohci->regs->intrdisable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 ohci->hc_control &= ~OHCI_CTRL_RWE;
Alan Stern1f7e1a32006-09-25 15:41:21 -0400119 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
David Brownellf197b2c2005-09-22 22:42:53 -0700121 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
122 * which doesn't imply ports will first be individually suspended.
123 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 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);
128
129 /* no resumes until devices finish suspending */
Alan Stern8d1a2432006-09-26 14:46:16 -0400130 if (!autostop) {
131 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
132 ohci->autostop = 0;
Alan Sternb7463c72011-11-17 16:41:56 -0500133 ohci->rh_state = OHCI_RH_SUSPENDED;
Alan Stern8d1a2432006-09-26 14:46:16 -0400134 }
David Brownelld4139842006-08-04 11:31:55 -0700135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 return status;
138}
139
140static inline struct ed *find_head (struct ed *ed)
141{
142 /* for bulk and control lists */
143 while (ed->ed_prev)
144 ed = ed->ed_prev;
145 return ed;
146}
147
148/* caller has locked the root hub */
Alan Stern8d1a2432006-09-26 14:46:16 -0400149static int ohci_rh_resume (struct ohci_hcd *ohci)
150__releases(ohci->lock)
151__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Alan Stern8d1a2432006-09-26 14:46:16 -0400153 struct usb_hcd *hcd = ohci_to_hcd (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 u32 temp, enables;
155 int status = -EINPROGRESS;
Alan Stern8d1a2432006-09-26 14:46:16 -0400156 int autostopped = ohci->autostop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Alan Stern8d1a2432006-09-26 14:46:16 -0400158 ohci->autostop = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
160
161 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
David Brownellf197b2c2005-09-22 22:42:53 -0700162 /* this can happen after resuming a swsusp snapshot */
Alan Sternb7463c72011-11-17 16:41:56 -0500163 if (ohci->rh_state != OHCI_RH_RUNNING) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
165 ohci->hc_control);
166 status = -EBUSY;
167 /* this happens when pmcore resumes HC then root */
168 } else {
169 ohci_dbg (ohci, "duplicate resume\n");
170 status = 0;
171 }
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);
Alan Stern8d1a2432006-09-26 14:46:16 -0400178 ohci_dbg (ohci, "%s root hub\n",
179 autostopped ? "auto-start" : "resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 break;
181 case OHCI_USB_RESUME:
182 /* HCFS changes sometime after INTR_RD */
Alan Stern1b7be3c2006-11-06 12:05:00 -0500183 ohci_dbg(ohci, "%swakeup root hub\n",
Alan Stern583cead2006-10-24 12:04:22 -0400184 autostopped ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 break;
186 case OHCI_USB_OPER:
David Brownellf197b2c2005-09-22 22:42:53 -0700187 /* this can happen after resuming a swsusp snapshot */
188 ohci_dbg (ohci, "snapshot resume? reinit\n");
189 status = -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 break;
191 default: /* RESET, we lost power */
David Brownellf197b2c2005-09-22 22:42:53 -0700192 ohci_dbg (ohci, "lost power\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 status = -EBUSY;
194 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 if (status == -EBUSY) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400196 if (!autostopped) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400197 spin_unlock_irq (&ohci->lock);
Alan Stern8d1a2432006-09-26 14:46:16 -0400198 status = ohci_restart (ohci);
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200199
200 usb_root_hub_lost_power(hcd->self.root_hub);
201
Alan Stern8d1a2432006-09-26 14:46:16 -0400202 spin_lock_irq (&ohci->lock);
203 }
204 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
206 if (status != -EINPROGRESS)
207 return status;
Alan Stern8d1a2432006-09-26 14:46:16 -0400208 if (autostopped)
209 goto skip_resume;
210 spin_unlock_irq (&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 /* Some controllers (lucent erratum) need extra-long delays */
David Brownellf197b2c2005-09-22 22:42:53 -0700213 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
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");
Alan Stern565402b2006-10-27 10:35:01 -0400219 spin_lock_irq(&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 return -EBUSY;
221 }
222
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);
230
231 /* Sometimes PCI D3 suspend trashes frame timings ... */
232 periodic_reinit (ohci);
233
Alan Stern7c71c6e2013-10-18 11:16:07 -0400234 /*
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".
Alan Stern8d1a2432006-09-26 14:46:16 -0400238 */
Alan Stern8d1a2432006-09-26 14:46:16 -0400239skip_resume:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 /* 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245 /* Then re-enable operations */
246 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
247 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400248 if (!autostopped)
249 msleep (3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
David Brownell6a9062f2006-01-23 15:28:07 -0800251 temp = ohci->hc_control;
252 temp &= OHCI_CTRL_RWC;
253 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 ohci->hc_control = temp;
255 ohci_writel (ohci, temp, &ohci->regs->control);
256 (void) ohci_readl (ohci, &ohci->regs->control);
257
258 /* TRSMRCY */
Alan Stern8d1a2432006-09-26 14:46:16 -0400259 if (!autostopped) {
260 msleep (10);
261 spin_lock_irq (&ohci->lock);
262 }
263 /* now ohci->lock is always held and irqs are always disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
David Brownelld4139842006-08-04 11:31:55 -0700265 /* keep it alive for more than ~5x suspend + resume costs */
266 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 /* maybe turn schedules back on */
269 enables = 0;
270 temp = 0;
271 if (!ohci->ed_rm_list) {
272 if (ohci->ed_controltail) {
273 ohci_writel (ohci,
274 find_head (ohci->ed_controltail)->dma,
275 &ohci->regs->ed_controlhead);
276 enables |= OHCI_CTRL_CLE;
277 temp |= OHCI_CLF;
278 }
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;
283 temp |= OHCI_BLF;
284 }
285 }
286 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
287 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
288 if (enables) {
289 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
290 ohci->hc_control |= enables;
291 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
292 if (temp)
293 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
294 (void) ohci_readl (ohci, &ohci->regs->control);
295 }
296
Alan Sternb7463c72011-11-17 16:41:56 -0500297 ohci->rh_state = OHCI_RH_RUNNING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 return 0;
299}
300
Alan Stern8d1a2432006-09-26 14:46:16 -0400301static int ohci_bus_suspend (struct usb_hcd *hcd)
302{
303 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
304 int rc;
305
306 spin_lock_irq (&ohci->lock);
307
Alan Stern541c7d42010-06-22 16:39:10 -0400308 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400309 rc = -ESHUTDOWN;
310 else
311 rc = ohci_rh_suspend (ohci, 0);
312 spin_unlock_irq (&ohci->lock);
Alan Stern81e38332014-07-18 16:26:12 -0400313
Shigeru Yoshidab2685bd2018-02-02 13:51:39 +0800314 if (rc == 0) {
Alan Stern81e38332014-07-18 16:26:12 -0400315 del_timer_sync(&ohci->io_watchdog);
Shigeru Yoshidab2685bd2018-02-02 13:51:39 +0800316 ohci->prev_frame_no = IO_WATCHDOG_OFF;
317 }
Alan Stern8d1a2432006-09-26 14:46:16 -0400318 return rc;
319}
320
321static int ohci_bus_resume (struct usb_hcd *hcd)
322{
323 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
324 int rc;
325
326 if (time_before (jiffies, ohci->next_statechange))
327 msleep(5);
328
329 spin_lock_irq (&ohci->lock);
330
Alan Stern541c7d42010-06-22 16:39:10 -0400331 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400332 rc = -ESHUTDOWN;
333 else
334 rc = ohci_rh_resume (ohci);
335 spin_unlock_irq (&ohci->lock);
336
337 /* poll until we know a device is connected or we autostop */
338 if (rc == 0)
339 usb_hcd_poll_rh_status(hcd);
340 return rc;
341}
342
Alan Stern1f9fc882006-11-20 11:06:59 -0500343/* Carry out polling-, autostop-, and autoresume-related state changes */
344static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400345 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500346{
347 int poll_rh = 1;
Alan Stern71b74972008-10-09 15:40:23 -0400348 int rhsc_enable;
Alan Stern1f9fc882006-11-20 11:06:59 -0500349
Alan Sternee0b9be2010-06-25 14:02:24 -0400350 /* Some broken controllers never turn off RHSC in the interrupt
Alan Stern4a511bc2008-09-03 16:38:32 -0400351 * status register. For their sake we won't re-enable RHSC
352 * interrupts if the interrupt bit is already active.
353 */
Alan Stern4a511bc2008-09-03 16:38:32 -0400354 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
355 OHCI_INTR_RHSC;
356
Alan Stern1f9fc882006-11-20 11:06:59 -0500357 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
Alan Stern1f9fc882006-11-20 11:06:59 -0500358 case OHCI_USB_OPER:
Alan Stern4a511bc2008-09-03 16:38:32 -0400359 /* 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);
Alan Sternb5fb4542008-08-20 17:22:05 -0400363 }
364
365 /* Keep on polling until we know a device is connected
366 * and RHSC is enabled, or until we autostop.
367 */
Alan Stern1f9fc882006-11-20 11:06:59 -0500368 if (!ohci->autostop) {
369 if (any_connected ||
370 !device_may_wakeup(&ohci_to_hcd(ohci)
371 ->self.root_hub->dev)) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400372 if (rhsc_enable)
Alan Stern1f9fc882006-11-20 11:06:59 -0500373 poll_rh = 0;
374 } else {
375 ohci->autostop = 1;
376 ohci->next_statechange = jiffies + HZ;
377 }
378
379 /* if no devices have been attached for one second, autostop */
380 } else {
381 if (changed || any_connected) {
382 ohci->autostop = 0;
383 ohci->next_statechange = jiffies +
384 STATECHANGE_DELAY;
Alan Stern4a511bc2008-09-03 16:38:32 -0400385 } else if (time_after_eq(jiffies,
Alan Stern1f9fc882006-11-20 11:06:59 -0500386 ohci->next_statechange)
387 && !ohci->ed_rm_list
388 && !(ohci->hc_control &
389 OHCI_SCHED_ENABLES)) {
390 ohci_rh_suspend(ohci, 1);
Alan Stern4a511bc2008-09-03 16:38:32 -0400391 if (rhsc_enable)
392 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500393 }
394 }
395 break;
396
Alan Stern1f9fc882006-11-20 11:06:59 -0500397 case OHCI_USB_SUSPEND:
398 case OHCI_USB_RESUME:
Alan Stern4a511bc2008-09-03 16:38:32 -0400399 /* if there is a port change, autostart or ask to be resumed */
Alan Stern1f9fc882006-11-20 11:06:59 -0500400 if (changed) {
401 if (ohci->autostop)
402 ohci_rh_resume(ohci);
403 else
404 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
Alan Stern71b74972008-10-09 15:40:23 -0400405
406 /* If remote wakeup is disabled, stop polling */
407 } else if (!ohci->autostop &&
408 !ohci_to_hcd(ohci)->self.root_hub->
409 do_remote_wakeup) {
410 poll_rh = 0;
411
Alan Stern1f9fc882006-11-20 11:06:59 -0500412 } else {
Alan Stern71b74972008-10-09 15:40:23 -0400413 /* If no status changes are pending,
414 * enable RHSC interrupts
415 */
416 if (!rhsc_enable && !rhsc_status) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400417 rhsc_enable = OHCI_INTR_RHSC;
418 ohci_writel(ohci, rhsc_enable,
Alan Sternb5fb4542008-08-20 17:22:05 -0400419 &ohci->regs->intrenable);
Alan Stern4a511bc2008-09-03 16:38:32 -0400420 }
Alan Stern71b74972008-10-09 15:40:23 -0400421 /* Keep polling until RHSC is enabled */
Alan Stern4a511bc2008-09-03 16:38:32 -0400422 if (rhsc_enable)
423 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500424 }
425 break;
426 }
427 return poll_rh;
428}
429
430#else /* CONFIG_PM */
431
432static inline int ohci_rh_resume(struct ohci_hcd *ohci)
433{
434 return 0;
435}
436
437/* Carry out polling-related state changes.
438 * autostop isn't used when CONFIG_PM is turned off.
439 */
440static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400441 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500442{
Alan Sternb5fb4542008-08-20 17:22:05 -0400443 /* If RHSC is enabled, don't poll */
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700444 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
Alan Sternb5fb4542008-08-20 17:22:05 -0400445 return 0;
446
Alan Stern71b74972008-10-09 15:40:23 -0400447 /* 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.
450 */
451 if (changed || rhsc_status)
452 return 1;
453
454 /* It's safe to re-enable RHSC interrupts */
455 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
456 return 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500457}
458
David Brownell8ad7fe12005-09-13 19:59:11 -0700459#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461/*-------------------------------------------------------------------------*/
462
463/* build "status change" packet (one or two bytes) from HC registers */
464
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200465int ohci_hub_status_data(struct usb_hcd *hcd, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466{
467 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownellfdd13b32005-08-31 11:52:57 -0700468 int i, changed = 0, length = 1;
Alan Stern052ac012006-10-27 10:33:11 -0400469 int any_connected = 0;
Alan Stern71b74972008-10-09 15:40:23 -0400470 int rhsc_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 unsigned long flags;
472
473 spin_lock_irqsave (&ohci->lock, flags);
Alan Stern541c7d42010-06-22 16:39:10 -0400474 if (!HCD_HW_ACCESSIBLE(hcd))
Alan Stern6fd75b12007-05-04 11:57:00 -0400475 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
David Brownellfdd13b32005-08-31 11:52:57 -0700477 /* 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",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
482 /* retry later; "should not happen" */
483 goto done;
484 }
485
486 /* init status */
487 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
488 buf [0] = changed = 1;
489 else
490 buf [0] = 0;
David Brownellfdd13b32005-08-31 11:52:57 -0700491 if (ohci->num_ports > 7) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 buf [1] = 0;
493 length++;
494 }
495
Alan Stern71b74972008-10-09 15:40:23 -0400496 /* 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) &
499 OHCI_INTR_RHSC;
500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 /* look at each port */
David Brownellfdd13b32005-08-31 11:52:57 -0700502 for (i = 0; i < ohci->num_ports; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 u32 status = roothub_portstatus (ohci, i);
504
Alan Stern8d1a2432006-09-26 14:46:16 -0400505 /* can't autostop if ports are connected */
506 any_connected |= (status & RH_PS_CCS);
507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
509 | RH_PS_OCIC | RH_PS_PRSC)) {
510 changed = 1;
511 if (i < 7)
512 buf [0] |= 1 << (i + 1);
513 else
514 buf [1] |= 1 << (i - 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Alan Stern541c7d42010-06-22 16:39:10 -0400518 if (ohci_root_hub_state_changes(ohci, changed,
519 any_connected, rhsc_status))
520 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
521 else
522 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
523
David Brownelld4139842006-08-04 11:31:55 -0700524
525done:
526 spin_unlock_irqrestore (&ohci->lock, flags);
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 return changed ? length : 0;
529}
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200530EXPORT_SYMBOL_GPL(ohci_hub_status_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532/*-------------------------------------------------------------------------*/
533
534static void
535ohci_hub_descriptor (
536 struct ohci_hcd *ohci,
537 struct usb_hub_descriptor *desc
538) {
539 u32 rh = roothub_a (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 u16 temp;
541
Sergei Shtylyov7a2d2672015-03-29 01:19:48 +0300542 desc->bDescriptorType = USB_DT_HUB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
544 desc->bHubContrCurrent = 0;
545
David Brownellfdd13b32005-08-31 11:52:57 -0700546 desc->bNbrPorts = ohci->num_ports;
547 temp = 1 + (ohci->num_ports / 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 desc->bDescLength = 7 + 2 * temp;
549
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300550 temp = HUB_CHAR_COMMON_LPSM | HUB_CHAR_COMMON_OCPM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 if (rh & RH_A_NPS) /* no power switching? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300552 temp |= HUB_CHAR_NO_LPSM;
David Brownelldd9048a2006-12-05 03:18:31 -0800553 if (rh & RH_A_PSM) /* per-port power switching? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300554 temp |= HUB_CHAR_INDV_PORT_LPSM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300556 temp |= HUB_CHAR_NO_OCPM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
Sergei Shtylyovdb42a4c2015-01-19 01:41:37 +0300558 temp |= HUB_CHAR_INDV_PORT_OCPM;
Alan Stern7c71c6e2013-10-18 11:16:07 -0400559 desc->wHubCharacteristics = cpu_to_le16(temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Sarah Sharpda130512010-11-30 15:55:51 -0800561 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 rh = roothub_b (ohci);
John Youndbe79bb2001-09-17 00:00:00 -0700563 memset(desc->u.hs.DeviceRemovable, 0xff,
564 sizeof(desc->u.hs.DeviceRemovable));
565 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
David Brownellfdd13b32005-08-31 11:52:57 -0700566 if (ohci->num_ports > 7) {
John Youndbe79bb2001-09-17 00:00:00 -0700567 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
568 desc->u.hs.DeviceRemovable[2] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 } else
John Youndbe79bb2001-09-17 00:00:00 -0700570 desc->u.hs.DeviceRemovable[1] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
573/*-------------------------------------------------------------------------*/
574
575#ifdef CONFIG_USB_OTG
576
577static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
578{
579 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
580 u32 status;
581
582 if (!port)
583 return -EINVAL;
584 port--;
585
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))
589 return -ENODEV;
590
Petr Mladek37ebb542014-09-19 17:32:23 +0200591 /* hub_wq will finish the reset later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
593 return 0;
594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596#else
597
598#define ohci_start_port_reset NULL
599
600#endif
601
602/*-------------------------------------------------------------------------*/
603
604
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608#define PORT_RESET_MSEC 50
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
610/* this timer value might be vendor-specific ... */
611#define PORT_RESET_HW_MSEC 10
612
613/* wrap-aware logic morphed from <linux/jiffies.h> */
614#define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
615
Petr Mladek37ebb542014-09-19 17:32:23 +0200616/* called from some task, normally hub_wq */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800617static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
619 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
Alan Stern1b7b61c2008-04-22 10:50:18 -0400620 u32 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
622 u16 reset_done = now + PORT_RESET_MSEC;
David Brownelle01e7fe2008-02-02 02:42:52 -0800623 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
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.
628 */
629 do {
David Brownelle01e7fe2008-02-02 02:42:52 -0800630 int limit_2;
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 /* spin until any current reset finishes */
David Brownelle01e7fe2008-02-02 02:42:52 -0800633 limit_2 = PORT_RESET_HW_MSEC * 2;
634 while (--limit_2 >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 temp = ohci_readl (ohci, portstat);
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800636 /* handle e.g. CardBus eject */
637 if (temp == ~(u32)0)
638 return -ESHUTDOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 if (!(temp & RH_PS_PRS))
640 break;
641 udelay (500);
David Brownelldd9048a2006-12-05 03:18:31 -0800642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
David Brownelle01e7fe2008-02-02 02:42:52 -0800644 /* 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.
647 */
648 if (limit_2 < 0) {
649 ohci_dbg(ohci,
650 "port[%d] reset timeout, stat %08x\n",
651 port, temp);
652 break;
653 }
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (!(temp & RH_PS_CCS))
656 break;
657 if (temp & RH_PS_PRSC)
658 ohci_writel (ohci, RH_PS_PRSC, portstat);
659
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);
David Brownelle01e7fe2008-02-02 02:42:52 -0800664 } while (tick_before(now, reset_done) && --limit_1 >= 0);
665
666 /* caller synchronizes using PRSC ... and handles PRS
667 * still being set when this returns.
668 */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800669
670 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200673int ohci_hub_control(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 struct usb_hcd *hcd,
675 u16 typeReq,
676 u16 wValue,
677 u16 wIndex,
678 char *buf,
679 u16 wLength
680) {
681 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
Alan Sternfcf7d212010-04-20 10:37:57 -0400682 int ports = ohci->num_ports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 u32 temp;
684 int retval = 0;
685
Alan Stern541c7d42010-06-22 16:39:10 -0400686 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100687 return -ESHUTDOWN;
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 switch (typeReq) {
690 case ClearHubFeature:
691 switch (wValue) {
692 case C_HUB_OVER_CURRENT:
693 ohci_writel (ohci, RH_HS_OCIC,
694 &ohci->regs->roothub.status);
695 case C_HUB_LOCAL_POWER:
696 break;
697 default:
698 goto error;
699 }
700 break;
701 case ClearPortFeature:
702 if (!wIndex || wIndex > ports)
703 goto error;
704 wIndex--;
705
706 switch (wValue) {
707 case USB_PORT_FEAT_ENABLE:
708 temp = RH_PS_CCS;
709 break;
710 case USB_PORT_FEAT_C_ENABLE:
711 temp = RH_PS_PESC;
712 break;
713 case USB_PORT_FEAT_SUSPEND:
714 temp = RH_PS_POCI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 break;
716 case USB_PORT_FEAT_C_SUSPEND:
717 temp = RH_PS_PSSC;
718 break;
719 case USB_PORT_FEAT_POWER:
720 temp = RH_PS_LSDA;
721 break;
722 case USB_PORT_FEAT_C_CONNECTION:
723 temp = RH_PS_CSC;
724 break;
725 case USB_PORT_FEAT_C_OVER_CURRENT:
726 temp = RH_PS_OCIC;
727 break;
728 case USB_PORT_FEAT_C_RESET:
729 temp = RH_PS_PRSC;
730 break;
731 default:
732 goto error;
733 }
734 ohci_writel (ohci, temp,
735 &ohci->regs->roothub.portstatus [wIndex]);
736 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
737 break;
738 case GetHubDescriptor:
739 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
740 break;
741 case GetHubStatus:
742 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700743 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 break;
745 case GetPortStatus:
746 if (!wIndex || wIndex > ports)
747 goto error;
748 wIndex--;
749 temp = roothub_portstatus (ohci, wIndex);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700750 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Oliver Neukum00b033b2013-11-18 13:23:00 +0100752 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
753 dbg_port(ohci, "GetStatus", wIndex, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 break;
755 case SetHubFeature:
756 switch (wValue) {
757 case C_HUB_OVER_CURRENT:
758 // FIXME: this can be cleared, yes?
759 case C_HUB_LOCAL_POWER:
760 break;
761 default:
762 goto error;
763 }
764 break;
765 case SetPortFeature:
766 if (!wIndex || wIndex > ports)
767 goto error;
768 wIndex--;
769 switch (wValue) {
770 case USB_PORT_FEAT_SUSPEND:
771#ifdef CONFIG_USB_OTG
772 if (hcd->self.otg_port == (wIndex + 1)
773 && hcd->self.b_hnp_enable)
Dmitry Baryshkove8b24452008-07-06 14:26:30 +0400774 ohci->start_hnp(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 else
776#endif
777 ohci_writel (ohci, RH_PS_PSS,
778 &ohci->regs->roothub.portstatus [wIndex]);
779 break;
780 case USB_PORT_FEAT_POWER:
781 ohci_writel (ohci, RH_PS_PPS,
782 &ohci->regs->roothub.portstatus [wIndex]);
783 break;
784 case USB_PORT_FEAT_RESET:
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800785 retval = root_port_reset (ohci, wIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 break;
787 default:
788 goto error;
789 }
790 break;
791
792 default:
793error:
794 /* "protocol stall" on error */
795 retval = -EPIPE;
796 }
797 return retval;
798}
Laurent Pinchart42b59eb2014-04-16 18:00:09 +0200799EXPORT_SYMBOL_GPL(ohci_hub_control);