blob: c81c8721cc5a9e3d07e20c29d9d40e540136409e [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
93 /* maybe resume can wake root hub */
Alan Stern58a97ff2008-04-14 12:17:10 -040094 if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 ohci->hc_control |= OHCI_CTRL_RWE;
Alan Stern58a97ff2008-04-14 12:17:10 -040096 } else {
Alan Stern5f474932008-04-14 12:17:49 -040097 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
98 &ohci->regs->intrdisable);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 ohci->hc_control &= ~OHCI_CTRL_RWE;
Alan Stern1f7e1a32006-09-25 15:41:21 -0400100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
David Brownellf197b2c2005-09-22 22:42:53 -0700102 /* Suspend hub ... this is the "global (to this bus) suspend" mode,
103 * which doesn't imply ports will first be individually suspended.
104 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 ohci->hc_control &= ~OHCI_CTRL_HCFS;
106 ohci->hc_control |= OHCI_USB_SUSPEND;
107 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
108 (void) ohci_readl (ohci, &ohci->regs->control);
109
110 /* no resumes until devices finish suspending */
Alan Stern8d1a2432006-09-26 14:46:16 -0400111 if (!autostop) {
112 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
113 ohci->autostop = 0;
Alan Sternb7463c72011-11-17 16:41:56 -0500114 ohci->rh_state = OHCI_RH_SUSPENDED;
Alan Stern8d1a2432006-09-26 14:46:16 -0400115 }
David Brownelld4139842006-08-04 11:31:55 -0700116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 return status;
119}
120
121static inline struct ed *find_head (struct ed *ed)
122{
123 /* for bulk and control lists */
124 while (ed->ed_prev)
125 ed = ed->ed_prev;
126 return ed;
127}
128
129/* caller has locked the root hub */
Alan Stern8d1a2432006-09-26 14:46:16 -0400130static int ohci_rh_resume (struct ohci_hcd *ohci)
131__releases(ohci->lock)
132__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Alan Stern8d1a2432006-09-26 14:46:16 -0400134 struct usb_hcd *hcd = ohci_to_hcd (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 u32 temp, enables;
136 int status = -EINPROGRESS;
Alan Stern8d1a2432006-09-26 14:46:16 -0400137 int autostopped = ohci->autostop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Alan Stern8d1a2432006-09-26 14:46:16 -0400139 ohci->autostop = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
141
142 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
David Brownellf197b2c2005-09-22 22:42:53 -0700143 /* this can happen after resuming a swsusp snapshot */
Alan Sternb7463c72011-11-17 16:41:56 -0500144 if (ohci->rh_state != OHCI_RH_RUNNING) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
146 ohci->hc_control);
147 status = -EBUSY;
148 /* this happens when pmcore resumes HC then root */
149 } else {
150 ohci_dbg (ohci, "duplicate resume\n");
151 status = 0;
152 }
153 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
154 case OHCI_USB_SUSPEND:
155 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
156 ohci->hc_control |= OHCI_USB_RESUME;
157 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
158 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400159 ohci_dbg (ohci, "%s root hub\n",
160 autostopped ? "auto-start" : "resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 break;
162 case OHCI_USB_RESUME:
163 /* HCFS changes sometime after INTR_RD */
Alan Stern1b7be3c2006-11-06 12:05:00 -0500164 ohci_dbg(ohci, "%swakeup root hub\n",
Alan Stern583cead2006-10-24 12:04:22 -0400165 autostopped ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 break;
167 case OHCI_USB_OPER:
David Brownellf197b2c2005-09-22 22:42:53 -0700168 /* this can happen after resuming a swsusp snapshot */
169 ohci_dbg (ohci, "snapshot resume? reinit\n");
170 status = -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 break;
172 default: /* RESET, we lost power */
David Brownellf197b2c2005-09-22 22:42:53 -0700173 ohci_dbg (ohci, "lost power\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 status = -EBUSY;
175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 if (status == -EBUSY) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400177 if (!autostopped) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400178 spin_unlock_irq (&ohci->lock);
Alan Stern8d1a2432006-09-26 14:46:16 -0400179 status = ohci_restart (ohci);
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200180
181 usb_root_hub_lost_power(hcd->self.root_hub);
182
Alan Stern8d1a2432006-09-26 14:46:16 -0400183 spin_lock_irq (&ohci->lock);
184 }
185 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
187 if (status != -EINPROGRESS)
188 return status;
Alan Stern8d1a2432006-09-26 14:46:16 -0400189 if (autostopped)
190 goto skip_resume;
191 spin_unlock_irq (&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 /* Some controllers (lucent erratum) need extra-long delays */
David Brownellf197b2c2005-09-22 22:42:53 -0700194 msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 temp = ohci_readl (ohci, &ohci->regs->control);
197 temp &= OHCI_CTRL_HCFS;
198 if (temp != OHCI_USB_RESUME) {
199 ohci_err (ohci, "controller won't resume\n");
Alan Stern565402b2006-10-27 10:35:01 -0400200 spin_lock_irq(&ohci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 return -EBUSY;
202 }
203
204 /* disable old schedule state, reinit from scratch */
205 ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
206 ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
207 ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
208 ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
209 ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
210 ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
211
212 /* Sometimes PCI D3 suspend trashes frame timings ... */
213 periodic_reinit (ohci);
214
Alan Stern7c71c6e2013-10-18 11:16:07 -0400215 /*
216 * The following code is executed with ohci->lock held and
217 * irqs disabled if and only if autostopped is true. This
218 * will cause sparse to warn about a "context imbalance".
Alan Stern8d1a2432006-09-26 14:46:16 -0400219 */
Alan Stern8d1a2432006-09-26 14:46:16 -0400220skip_resume:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 /* interrupts might have been disabled */
222 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
223 if (ohci->ed_rm_list)
224 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226 /* Then re-enable operations */
227 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
228 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400229 if (!autostopped)
230 msleep (3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
David Brownell6a9062f2006-01-23 15:28:07 -0800232 temp = ohci->hc_control;
233 temp &= OHCI_CTRL_RWC;
234 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 ohci->hc_control = temp;
236 ohci_writel (ohci, temp, &ohci->regs->control);
237 (void) ohci_readl (ohci, &ohci->regs->control);
238
239 /* TRSMRCY */
Alan Stern8d1a2432006-09-26 14:46:16 -0400240 if (!autostopped) {
241 msleep (10);
242 spin_lock_irq (&ohci->lock);
243 }
244 /* now ohci->lock is always held and irqs are always disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
David Brownelld4139842006-08-04 11:31:55 -0700246 /* keep it alive for more than ~5x suspend + resume costs */
247 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 /* maybe turn schedules back on */
250 enables = 0;
251 temp = 0;
252 if (!ohci->ed_rm_list) {
253 if (ohci->ed_controltail) {
254 ohci_writel (ohci,
255 find_head (ohci->ed_controltail)->dma,
256 &ohci->regs->ed_controlhead);
257 enables |= OHCI_CTRL_CLE;
258 temp |= OHCI_CLF;
259 }
260 if (ohci->ed_bulktail) {
261 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
262 &ohci->regs->ed_bulkhead);
263 enables |= OHCI_CTRL_BLE;
264 temp |= OHCI_BLF;
265 }
266 }
267 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
268 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
269 if (enables) {
270 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
271 ohci->hc_control |= enables;
272 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
273 if (temp)
274 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
275 (void) ohci_readl (ohci, &ohci->regs->control);
276 }
277
Alan Sternb7463c72011-11-17 16:41:56 -0500278 ohci->rh_state = OHCI_RH_RUNNING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 return 0;
280}
281
Alan Stern8d1a2432006-09-26 14:46:16 -0400282static int ohci_bus_suspend (struct usb_hcd *hcd)
283{
284 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
285 int rc;
286
287 spin_lock_irq (&ohci->lock);
288
Alan Stern541c7d42010-06-22 16:39:10 -0400289 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400290 rc = -ESHUTDOWN;
291 else
292 rc = ohci_rh_suspend (ohci, 0);
293 spin_unlock_irq (&ohci->lock);
294 return rc;
295}
296
297static int ohci_bus_resume (struct usb_hcd *hcd)
298{
299 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
300 int rc;
301
302 if (time_before (jiffies, ohci->next_statechange))
303 msleep(5);
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_resume (ohci);
311 spin_unlock_irq (&ohci->lock);
312
313 /* poll until we know a device is connected or we autostop */
314 if (rc == 0)
315 usb_hcd_poll_rh_status(hcd);
316 return rc;
317}
318
Alan Stern1f9fc882006-11-20 11:06:59 -0500319/* Carry out polling-, autostop-, and autoresume-related state changes */
320static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400321 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500322{
323 int poll_rh = 1;
Alan Stern71b74972008-10-09 15:40:23 -0400324 int rhsc_enable;
Alan Stern1f9fc882006-11-20 11:06:59 -0500325
Alan Sternee0b9be2010-06-25 14:02:24 -0400326 /* Some broken controllers never turn off RHSC in the interrupt
Alan Stern4a511bc2008-09-03 16:38:32 -0400327 * status register. For their sake we won't re-enable RHSC
328 * interrupts if the interrupt bit is already active.
329 */
Alan Stern4a511bc2008-09-03 16:38:32 -0400330 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
331 OHCI_INTR_RHSC;
332
Alan Stern1f9fc882006-11-20 11:06:59 -0500333 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
Alan Stern1f9fc882006-11-20 11:06:59 -0500334 case OHCI_USB_OPER:
Alan Stern4a511bc2008-09-03 16:38:32 -0400335 /* If no status changes are pending, enable RHSC interrupts. */
336 if (!rhsc_enable && !rhsc_status && !changed) {
337 rhsc_enable = OHCI_INTR_RHSC;
338 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
Alan Sternb5fb4542008-08-20 17:22:05 -0400339 }
340
341 /* Keep on polling until we know a device is connected
342 * and RHSC is enabled, or until we autostop.
343 */
Alan Stern1f9fc882006-11-20 11:06:59 -0500344 if (!ohci->autostop) {
345 if (any_connected ||
346 !device_may_wakeup(&ohci_to_hcd(ohci)
347 ->self.root_hub->dev)) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400348 if (rhsc_enable)
Alan Stern1f9fc882006-11-20 11:06:59 -0500349 poll_rh = 0;
350 } else {
351 ohci->autostop = 1;
352 ohci->next_statechange = jiffies + HZ;
353 }
354
355 /* if no devices have been attached for one second, autostop */
356 } else {
357 if (changed || any_connected) {
358 ohci->autostop = 0;
359 ohci->next_statechange = jiffies +
360 STATECHANGE_DELAY;
Alan Stern4a511bc2008-09-03 16:38:32 -0400361 } else if (time_after_eq(jiffies,
Alan Stern1f9fc882006-11-20 11:06:59 -0500362 ohci->next_statechange)
363 && !ohci->ed_rm_list
364 && !(ohci->hc_control &
365 OHCI_SCHED_ENABLES)) {
366 ohci_rh_suspend(ohci, 1);
Alan Stern4a511bc2008-09-03 16:38:32 -0400367 if (rhsc_enable)
368 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500369 }
370 }
371 break;
372
Alan Stern1f9fc882006-11-20 11:06:59 -0500373 case OHCI_USB_SUSPEND:
374 case OHCI_USB_RESUME:
Alan Stern4a511bc2008-09-03 16:38:32 -0400375 /* if there is a port change, autostart or ask to be resumed */
Alan Stern1f9fc882006-11-20 11:06:59 -0500376 if (changed) {
377 if (ohci->autostop)
378 ohci_rh_resume(ohci);
379 else
380 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
Alan Stern71b74972008-10-09 15:40:23 -0400381
382 /* If remote wakeup is disabled, stop polling */
383 } else if (!ohci->autostop &&
384 !ohci_to_hcd(ohci)->self.root_hub->
385 do_remote_wakeup) {
386 poll_rh = 0;
387
Alan Stern1f9fc882006-11-20 11:06:59 -0500388 } else {
Alan Stern71b74972008-10-09 15:40:23 -0400389 /* If no status changes are pending,
390 * enable RHSC interrupts
391 */
392 if (!rhsc_enable && !rhsc_status) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400393 rhsc_enable = OHCI_INTR_RHSC;
394 ohci_writel(ohci, rhsc_enable,
Alan Sternb5fb4542008-08-20 17:22:05 -0400395 &ohci->regs->intrenable);
Alan Stern4a511bc2008-09-03 16:38:32 -0400396 }
Alan Stern71b74972008-10-09 15:40:23 -0400397 /* Keep polling until RHSC is enabled */
Alan Stern4a511bc2008-09-03 16:38:32 -0400398 if (rhsc_enable)
399 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500400 }
401 break;
402 }
403 return poll_rh;
404}
405
406#else /* CONFIG_PM */
407
408static inline int ohci_rh_resume(struct ohci_hcd *ohci)
409{
410 return 0;
411}
412
413/* Carry out polling-related state changes.
414 * autostop isn't used when CONFIG_PM is turned off.
415 */
416static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400417 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500418{
Alan Sternb5fb4542008-08-20 17:22:05 -0400419 /* If RHSC is enabled, don't poll */
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700420 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
Alan Sternb5fb4542008-08-20 17:22:05 -0400421 return 0;
422
Alan Stern71b74972008-10-09 15:40:23 -0400423 /* If status changes are pending, continue polling.
424 * Conversely, if no status changes are pending but the RHSC
425 * status bit was set, then RHSC may be broken so continue polling.
426 */
427 if (changed || rhsc_status)
428 return 1;
429
430 /* It's safe to re-enable RHSC interrupts */
431 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
432 return 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500433}
434
David Brownell8ad7fe12005-09-13 19:59:11 -0700435#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437/*-------------------------------------------------------------------------*/
438
439/* build "status change" packet (one or two bytes) from HC registers */
440
441static int
442ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
443{
444 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownellfdd13b32005-08-31 11:52:57 -0700445 int i, changed = 0, length = 1;
Alan Stern052ac012006-10-27 10:33:11 -0400446 int any_connected = 0;
Alan Stern71b74972008-10-09 15:40:23 -0400447 int rhsc_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 unsigned long flags;
449
450 spin_lock_irqsave (&ohci->lock, flags);
Alan Stern541c7d42010-06-22 16:39:10 -0400451 if (!HCD_HW_ACCESSIBLE(hcd))
Alan Stern6fd75b12007-05-04 11:57:00 -0400452 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
David Brownellfdd13b32005-08-31 11:52:57 -0700454 /* undocumented erratum seen on at least rev D */
455 if ((ohci->flags & OHCI_QUIRK_AMD756)
456 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
457 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
459 /* retry later; "should not happen" */
460 goto done;
461 }
462
463 /* init status */
464 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
465 buf [0] = changed = 1;
466 else
467 buf [0] = 0;
David Brownellfdd13b32005-08-31 11:52:57 -0700468 if (ohci->num_ports > 7) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 buf [1] = 0;
470 length++;
471 }
472
Alan Stern71b74972008-10-09 15:40:23 -0400473 /* Clear the RHSC status flag before reading the port statuses */
474 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
475 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
476 OHCI_INTR_RHSC;
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 /* look at each port */
David Brownellfdd13b32005-08-31 11:52:57 -0700479 for (i = 0; i < ohci->num_ports; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 u32 status = roothub_portstatus (ohci, i);
481
Alan Stern8d1a2432006-09-26 14:46:16 -0400482 /* can't autostop if ports are connected */
483 any_connected |= (status & RH_PS_CCS);
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
486 | RH_PS_OCIC | RH_PS_PRSC)) {
487 changed = 1;
488 if (i < 7)
489 buf [0] |= 1 << (i + 1);
490 else
491 buf [1] |= 1 << (i - 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
Alan Stern541c7d42010-06-22 16:39:10 -0400495 if (ohci_root_hub_state_changes(ohci, changed,
496 any_connected, rhsc_status))
497 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
498 else
499 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
500
David Brownelld4139842006-08-04 11:31:55 -0700501
502done:
503 spin_unlock_irqrestore (&ohci->lock, flags);
504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 return changed ? length : 0;
506}
507
508/*-------------------------------------------------------------------------*/
509
510static void
511ohci_hub_descriptor (
512 struct ohci_hcd *ohci,
513 struct usb_hub_descriptor *desc
514) {
515 u32 rh = roothub_a (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 u16 temp;
517
518 desc->bDescriptorType = 0x29;
519 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
520 desc->bHubContrCurrent = 0;
521
David Brownellfdd13b32005-08-31 11:52:57 -0700522 desc->bNbrPorts = ohci->num_ports;
523 temp = 1 + (ohci->num_ports / 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 desc->bDescLength = 7 + 2 * temp;
525
526 temp = 0;
527 if (rh & RH_A_NPS) /* no power switching? */
528 temp |= 0x0002;
David Brownelldd9048a2006-12-05 03:18:31 -0800529 if (rh & RH_A_PSM) /* per-port power switching? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 temp |= 0x0001;
531 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
532 temp |= 0x0010;
533 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
534 temp |= 0x0008;
Alan Stern7c71c6e2013-10-18 11:16:07 -0400535 desc->wHubCharacteristics = cpu_to_le16(temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Sarah Sharpda130512010-11-30 15:55:51 -0800537 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 rh = roothub_b (ohci);
John Youndbe79bb2001-09-17 00:00:00 -0700539 memset(desc->u.hs.DeviceRemovable, 0xff,
540 sizeof(desc->u.hs.DeviceRemovable));
541 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
David Brownellfdd13b32005-08-31 11:52:57 -0700542 if (ohci->num_ports > 7) {
John Youndbe79bb2001-09-17 00:00:00 -0700543 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
544 desc->u.hs.DeviceRemovable[2] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 } else
John Youndbe79bb2001-09-17 00:00:00 -0700546 desc->u.hs.DeviceRemovable[1] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
548
549/*-------------------------------------------------------------------------*/
550
551#ifdef CONFIG_USB_OTG
552
553static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
554{
555 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
556 u32 status;
557
558 if (!port)
559 return -EINVAL;
560 port--;
561
562 /* start port reset before HNP protocol times out */
563 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
564 if (!(status & RH_PS_CCS))
565 return -ENODEV;
566
567 /* khubd will finish the reset later */
568 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
569 return 0;
570}
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572#else
573
574#define ohci_start_port_reset NULL
575
576#endif
577
578/*-------------------------------------------------------------------------*/
579
580
581/* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
582 * not necessarily continuous ... to guard against resume signaling.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#define PORT_RESET_MSEC 50
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
586/* this timer value might be vendor-specific ... */
587#define PORT_RESET_HW_MSEC 10
588
589/* wrap-aware logic morphed from <linux/jiffies.h> */
590#define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
591
592/* called from some task, normally khubd */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800593static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
595 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
Alan Stern1b7b61c2008-04-22 10:50:18 -0400596 u32 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
598 u16 reset_done = now + PORT_RESET_MSEC;
David Brownelle01e7fe2008-02-02 02:42:52 -0800599 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601 /* build a "continuous enough" reset signal, with up to
602 * 3msec gap between pulses. scheduler HZ==100 must work;
603 * this might need to be deadline-scheduled.
604 */
605 do {
David Brownelle01e7fe2008-02-02 02:42:52 -0800606 int limit_2;
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 /* spin until any current reset finishes */
David Brownelle01e7fe2008-02-02 02:42:52 -0800609 limit_2 = PORT_RESET_HW_MSEC * 2;
610 while (--limit_2 >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 temp = ohci_readl (ohci, portstat);
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800612 /* handle e.g. CardBus eject */
613 if (temp == ~(u32)0)
614 return -ESHUTDOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if (!(temp & RH_PS_PRS))
616 break;
617 udelay (500);
David Brownelldd9048a2006-12-05 03:18:31 -0800618 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
David Brownelle01e7fe2008-02-02 02:42:52 -0800620 /* timeout (a hardware error) has been observed when
621 * EHCI sets CF while this driver is resetting a port;
622 * presumably other disconnect paths might do it too.
623 */
624 if (limit_2 < 0) {
625 ohci_dbg(ohci,
626 "port[%d] reset timeout, stat %08x\n",
627 port, temp);
628 break;
629 }
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 if (!(temp & RH_PS_CCS))
632 break;
633 if (temp & RH_PS_PRSC)
634 ohci_writel (ohci, RH_PS_PRSC, portstat);
635
636 /* start the next reset, sleep till it's probably done */
637 ohci_writel (ohci, RH_PS_PRS, portstat);
638 msleep(PORT_RESET_HW_MSEC);
639 now = ohci_readl(ohci, &ohci->regs->fmnumber);
David Brownelle01e7fe2008-02-02 02:42:52 -0800640 } while (tick_before(now, reset_done) && --limit_1 >= 0);
641
642 /* caller synchronizes using PRSC ... and handles PRS
643 * still being set when this returns.
644 */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800645
646 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
649static int ohci_hub_control (
650 struct usb_hcd *hcd,
651 u16 typeReq,
652 u16 wValue,
653 u16 wIndex,
654 char *buf,
655 u16 wLength
656) {
657 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
Alan Sternfcf7d212010-04-20 10:37:57 -0400658 int ports = ohci->num_ports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 u32 temp;
660 int retval = 0;
661
Alan Stern541c7d42010-06-22 16:39:10 -0400662 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100663 return -ESHUTDOWN;
664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 switch (typeReq) {
666 case ClearHubFeature:
667 switch (wValue) {
668 case C_HUB_OVER_CURRENT:
669 ohci_writel (ohci, RH_HS_OCIC,
670 &ohci->regs->roothub.status);
671 case C_HUB_LOCAL_POWER:
672 break;
673 default:
674 goto error;
675 }
676 break;
677 case ClearPortFeature:
678 if (!wIndex || wIndex > ports)
679 goto error;
680 wIndex--;
681
682 switch (wValue) {
683 case USB_PORT_FEAT_ENABLE:
684 temp = RH_PS_CCS;
685 break;
686 case USB_PORT_FEAT_C_ENABLE:
687 temp = RH_PS_PESC;
688 break;
689 case USB_PORT_FEAT_SUSPEND:
690 temp = RH_PS_POCI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 break;
692 case USB_PORT_FEAT_C_SUSPEND:
693 temp = RH_PS_PSSC;
694 break;
695 case USB_PORT_FEAT_POWER:
696 temp = RH_PS_LSDA;
697 break;
698 case USB_PORT_FEAT_C_CONNECTION:
699 temp = RH_PS_CSC;
700 break;
701 case USB_PORT_FEAT_C_OVER_CURRENT:
702 temp = RH_PS_OCIC;
703 break;
704 case USB_PORT_FEAT_C_RESET:
705 temp = RH_PS_PRSC;
706 break;
707 default:
708 goto error;
709 }
710 ohci_writel (ohci, temp,
711 &ohci->regs->roothub.portstatus [wIndex]);
712 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
713 break;
714 case GetHubDescriptor:
715 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
716 break;
717 case GetHubStatus:
718 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700719 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 break;
721 case GetPortStatus:
722 if (!wIndex || wIndex > ports)
723 goto error;
724 wIndex--;
725 temp = roothub_portstatus (ohci, wIndex);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700726 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Oliver Neukum00b033b2013-11-18 13:23:00 +0100728 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
729 dbg_port(ohci, "GetStatus", wIndex, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 break;
731 case SetHubFeature:
732 switch (wValue) {
733 case C_HUB_OVER_CURRENT:
734 // FIXME: this can be cleared, yes?
735 case C_HUB_LOCAL_POWER:
736 break;
737 default:
738 goto error;
739 }
740 break;
741 case SetPortFeature:
742 if (!wIndex || wIndex > ports)
743 goto error;
744 wIndex--;
745 switch (wValue) {
746 case USB_PORT_FEAT_SUSPEND:
747#ifdef CONFIG_USB_OTG
748 if (hcd->self.otg_port == (wIndex + 1)
749 && hcd->self.b_hnp_enable)
Dmitry Baryshkove8b24452008-07-06 14:26:30 +0400750 ohci->start_hnp(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 else
752#endif
753 ohci_writel (ohci, RH_PS_PSS,
754 &ohci->regs->roothub.portstatus [wIndex]);
755 break;
756 case USB_PORT_FEAT_POWER:
757 ohci_writel (ohci, RH_PS_PPS,
758 &ohci->regs->roothub.portstatus [wIndex]);
759 break;
760 case USB_PORT_FEAT_RESET:
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800761 retval = root_port_reset (ohci, wIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 break;
763 default:
764 goto error;
765 }
766 break;
767
768 default:
769error:
770 /* "protocol stall" on error */
771 retval = -EPIPE;
772 }
773 return retval;
774}
775