blob: 2f00040fc408c78a4ef1e9bdab138344249d1fa5 [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;
114 }
David Brownelld4139842006-08-04 11:31:55 -0700115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 return status;
118}
119
120static inline struct ed *find_head (struct ed *ed)
121{
122 /* for bulk and control lists */
123 while (ed->ed_prev)
124 ed = ed->ed_prev;
125 return ed;
126}
127
128/* caller has locked the root hub */
Alan Stern8d1a2432006-09-26 14:46:16 -0400129static int ohci_rh_resume (struct ohci_hcd *ohci)
130__releases(ohci->lock)
131__acquires(ohci->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Alan Stern8d1a2432006-09-26 14:46:16 -0400133 struct usb_hcd *hcd = ohci_to_hcd (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 u32 temp, enables;
135 int status = -EINPROGRESS;
Alan Stern8d1a2432006-09-26 14:46:16 -0400136 int autostopped = ohci->autostop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Alan Stern8d1a2432006-09-26 14:46:16 -0400138 ohci->autostop = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
140
141 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
David Brownellf197b2c2005-09-22 22:42:53 -0700142 /* this can happen after resuming a swsusp snapshot */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 if (hcd->state == HC_STATE_RESUMING) {
144 ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
145 ohci->hc_control);
146 status = -EBUSY;
147 /* this happens when pmcore resumes HC then root */
148 } else {
149 ohci_dbg (ohci, "duplicate resume\n");
150 status = 0;
151 }
152 } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
153 case OHCI_USB_SUSPEND:
154 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
155 ohci->hc_control |= OHCI_USB_RESUME;
156 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
157 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400158 ohci_dbg (ohci, "%s root hub\n",
159 autostopped ? "auto-start" : "resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 break;
161 case OHCI_USB_RESUME:
162 /* HCFS changes sometime after INTR_RD */
Alan Stern1b7be3c2006-11-06 12:05:00 -0500163 ohci_dbg(ohci, "%swakeup root hub\n",
Alan Stern583cead2006-10-24 12:04:22 -0400164 autostopped ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 break;
166 case OHCI_USB_OPER:
David Brownellf197b2c2005-09-22 22:42:53 -0700167 /* this can happen after resuming a swsusp snapshot */
168 ohci_dbg (ohci, "snapshot resume? reinit\n");
169 status = -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 break;
171 default: /* RESET, we lost power */
David Brownellf197b2c2005-09-22 22:42:53 -0700172 ohci_dbg (ohci, "lost power\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 status = -EBUSY;
174 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 if (status == -EBUSY) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400176 if (!autostopped) {
Alan Stern8d1a2432006-09-26 14:46:16 -0400177 spin_unlock_irq (&ohci->lock);
178 (void) ohci_init (ohci);
179 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 Stern8d1a2432006-09-26 14:46:16 -0400215 /* the following code is executed with ohci->lock held and
216 * irqs disabled if and only if autostopped is true
217 */
218
219skip_resume:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 /* interrupts might have been disabled */
221 ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
222 if (ohci->ed_rm_list)
223 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225 /* Then re-enable operations */
226 ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
227 (void) ohci_readl (ohci, &ohci->regs->control);
Alan Stern8d1a2432006-09-26 14:46:16 -0400228 if (!autostopped)
229 msleep (3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
David Brownell6a9062f2006-01-23 15:28:07 -0800231 temp = ohci->hc_control;
232 temp &= OHCI_CTRL_RWC;
233 temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 ohci->hc_control = temp;
235 ohci_writel (ohci, temp, &ohci->regs->control);
236 (void) ohci_readl (ohci, &ohci->regs->control);
237
238 /* TRSMRCY */
Alan Stern8d1a2432006-09-26 14:46:16 -0400239 if (!autostopped) {
240 msleep (10);
241 spin_lock_irq (&ohci->lock);
242 }
243 /* now ohci->lock is always held and irqs are always disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
David Brownelld4139842006-08-04 11:31:55 -0700245 /* keep it alive for more than ~5x suspend + resume costs */
246 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 /* maybe turn schedules back on */
249 enables = 0;
250 temp = 0;
251 if (!ohci->ed_rm_list) {
252 if (ohci->ed_controltail) {
253 ohci_writel (ohci,
254 find_head (ohci->ed_controltail)->dma,
255 &ohci->regs->ed_controlhead);
256 enables |= OHCI_CTRL_CLE;
257 temp |= OHCI_CLF;
258 }
259 if (ohci->ed_bulktail) {
260 ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
261 &ohci->regs->ed_bulkhead);
262 enables |= OHCI_CTRL_BLE;
263 temp |= OHCI_BLF;
264 }
265 }
266 if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
267 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
268 if (enables) {
269 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
270 ohci->hc_control |= enables;
271 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
272 if (temp)
273 ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
274 (void) ohci_readl (ohci, &ohci->regs->control);
275 }
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return 0;
278}
279
Alan Stern8d1a2432006-09-26 14:46:16 -0400280static int ohci_bus_suspend (struct usb_hcd *hcd)
281{
282 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
283 int rc;
284
285 spin_lock_irq (&ohci->lock);
286
Alan Stern541c7d42010-06-22 16:39:10 -0400287 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400288 rc = -ESHUTDOWN;
289 else
290 rc = ohci_rh_suspend (ohci, 0);
291 spin_unlock_irq (&ohci->lock);
292 return rc;
293}
294
295static int ohci_bus_resume (struct usb_hcd *hcd)
296{
297 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
298 int rc;
299
300 if (time_before (jiffies, ohci->next_statechange))
301 msleep(5);
302
303 spin_lock_irq (&ohci->lock);
304
Alan Stern541c7d42010-06-22 16:39:10 -0400305 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Alan Stern8d1a2432006-09-26 14:46:16 -0400306 rc = -ESHUTDOWN;
307 else
308 rc = ohci_rh_resume (ohci);
309 spin_unlock_irq (&ohci->lock);
310
311 /* poll until we know a device is connected or we autostop */
312 if (rc == 0)
313 usb_hcd_poll_rh_status(hcd);
314 return rc;
315}
316
Alan Stern43bbb7e2008-04-03 18:03:17 -0400317/* Carry out the final steps of resuming the controller device */
318static void ohci_finish_controller_resume(struct usb_hcd *hcd)
319{
320 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
321 int port;
322 bool need_reinit = false;
323
324 /* See if the controller is already running or has been reset */
325 ohci->hc_control = ohci_readl(ohci, &ohci->regs->control);
326 if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
327 need_reinit = true;
328 } else {
329 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
330 case OHCI_USB_OPER:
331 case OHCI_USB_RESET:
332 need_reinit = true;
333 }
334 }
335
336 /* If needed, reinitialize and suspend the root hub */
337 if (need_reinit) {
338 spin_lock_irq(&ohci->lock);
339 hcd->state = HC_STATE_RESUMING;
340 ohci_rh_resume(ohci);
341 hcd->state = HC_STATE_QUIESCING;
342 ohci_rh_suspend(ohci, 0);
343 hcd->state = HC_STATE_SUSPENDED;
344 spin_unlock_irq(&ohci->lock);
345 }
346
347 /* Normally just turn on port power and enable interrupts */
348 else {
349 ohci_dbg(ohci, "powerup ports\n");
350 for (port = 0; port < ohci->num_ports; port++)
351 ohci_writel(ohci, RH_PS_PPS,
352 &ohci->regs->roothub.portstatus[port]);
353
354 ohci_writel(ohci, OHCI_INTR_MIE, &ohci->regs->intrenable);
355 ohci_readl(ohci, &ohci->regs->intrenable);
356 msleep(20);
357 }
Alan Sternee0b9be2010-06-25 14:02:24 -0400358
Matthew Garretta8b43c02011-10-06 15:35:43 -0400359 usb_hcd_resume_root_hub(hcd);
Alan Stern43bbb7e2008-04-03 18:03:17 -0400360}
361
Alan Stern1f9fc882006-11-20 11:06:59 -0500362/* Carry out polling-, autostop-, and autoresume-related state changes */
363static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400364 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500365{
366 int poll_rh = 1;
Alan Stern71b74972008-10-09 15:40:23 -0400367 int rhsc_enable;
Alan Stern1f9fc882006-11-20 11:06:59 -0500368
Alan Sternee0b9be2010-06-25 14:02:24 -0400369 /* Some broken controllers never turn off RHSC in the interrupt
Alan Stern4a511bc2008-09-03 16:38:32 -0400370 * status register. For their sake we won't re-enable RHSC
371 * interrupts if the interrupt bit is already active.
372 */
Alan Stern4a511bc2008-09-03 16:38:32 -0400373 rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
374 OHCI_INTR_RHSC;
375
Alan Stern1f9fc882006-11-20 11:06:59 -0500376 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
Alan Stern1f9fc882006-11-20 11:06:59 -0500377 case OHCI_USB_OPER:
Alan Stern4a511bc2008-09-03 16:38:32 -0400378 /* If no status changes are pending, enable RHSC interrupts. */
379 if (!rhsc_enable && !rhsc_status && !changed) {
380 rhsc_enable = OHCI_INTR_RHSC;
381 ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
Alan Sternb5fb4542008-08-20 17:22:05 -0400382 }
383
384 /* Keep on polling until we know a device is connected
385 * and RHSC is enabled, or until we autostop.
386 */
Alan Stern1f9fc882006-11-20 11:06:59 -0500387 if (!ohci->autostop) {
388 if (any_connected ||
389 !device_may_wakeup(&ohci_to_hcd(ohci)
390 ->self.root_hub->dev)) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400391 if (rhsc_enable)
Alan Stern1f9fc882006-11-20 11:06:59 -0500392 poll_rh = 0;
393 } else {
394 ohci->autostop = 1;
395 ohci->next_statechange = jiffies + HZ;
396 }
397
398 /* if no devices have been attached for one second, autostop */
399 } else {
400 if (changed || any_connected) {
401 ohci->autostop = 0;
402 ohci->next_statechange = jiffies +
403 STATECHANGE_DELAY;
Alan Stern4a511bc2008-09-03 16:38:32 -0400404 } else if (time_after_eq(jiffies,
Alan Stern1f9fc882006-11-20 11:06:59 -0500405 ohci->next_statechange)
406 && !ohci->ed_rm_list
407 && !(ohci->hc_control &
408 OHCI_SCHED_ENABLES)) {
409 ohci_rh_suspend(ohci, 1);
Alan Stern4a511bc2008-09-03 16:38:32 -0400410 if (rhsc_enable)
411 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500412 }
413 }
414 break;
415
Alan Stern1f9fc882006-11-20 11:06:59 -0500416 case OHCI_USB_SUSPEND:
417 case OHCI_USB_RESUME:
Alan Stern4a511bc2008-09-03 16:38:32 -0400418 /* if there is a port change, autostart or ask to be resumed */
Alan Stern1f9fc882006-11-20 11:06:59 -0500419 if (changed) {
420 if (ohci->autostop)
421 ohci_rh_resume(ohci);
422 else
423 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
Alan Stern71b74972008-10-09 15:40:23 -0400424
425 /* If remote wakeup is disabled, stop polling */
426 } else if (!ohci->autostop &&
427 !ohci_to_hcd(ohci)->self.root_hub->
428 do_remote_wakeup) {
429 poll_rh = 0;
430
Alan Stern1f9fc882006-11-20 11:06:59 -0500431 } else {
Alan Stern71b74972008-10-09 15:40:23 -0400432 /* If no status changes are pending,
433 * enable RHSC interrupts
434 */
435 if (!rhsc_enable && !rhsc_status) {
Alan Stern4a511bc2008-09-03 16:38:32 -0400436 rhsc_enable = OHCI_INTR_RHSC;
437 ohci_writel(ohci, rhsc_enable,
Alan Sternb5fb4542008-08-20 17:22:05 -0400438 &ohci->regs->intrenable);
Alan Stern4a511bc2008-09-03 16:38:32 -0400439 }
Alan Stern71b74972008-10-09 15:40:23 -0400440 /* Keep polling until RHSC is enabled */
Alan Stern4a511bc2008-09-03 16:38:32 -0400441 if (rhsc_enable)
442 poll_rh = 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500443 }
444 break;
445 }
446 return poll_rh;
447}
448
449#else /* CONFIG_PM */
450
451static inline int ohci_rh_resume(struct ohci_hcd *ohci)
452{
453 return 0;
454}
455
456/* Carry out polling-related state changes.
457 * autostop isn't used when CONFIG_PM is turned off.
458 */
459static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
Alan Stern71b74972008-10-09 15:40:23 -0400460 int any_connected, int rhsc_status)
Alan Stern1f9fc882006-11-20 11:06:59 -0500461{
Alan Sternb5fb4542008-08-20 17:22:05 -0400462 /* If RHSC is enabled, don't poll */
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700463 if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
Alan Sternb5fb4542008-08-20 17:22:05 -0400464 return 0;
465
Alan Stern71b74972008-10-09 15:40:23 -0400466 /* If status changes are pending, continue polling.
467 * Conversely, if no status changes are pending but the RHSC
468 * status bit was set, then RHSC may be broken so continue polling.
469 */
470 if (changed || rhsc_status)
471 return 1;
472
473 /* It's safe to re-enable RHSC interrupts */
474 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
475 return 0;
Alan Stern1f9fc882006-11-20 11:06:59 -0500476}
477
David Brownell8ad7fe12005-09-13 19:59:11 -0700478#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
480/*-------------------------------------------------------------------------*/
481
482/* build "status change" packet (one or two bytes) from HC registers */
483
484static int
485ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
486{
487 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownellfdd13b32005-08-31 11:52:57 -0700488 int i, changed = 0, length = 1;
Alan Stern052ac012006-10-27 10:33:11 -0400489 int any_connected = 0;
Alan Stern71b74972008-10-09 15:40:23 -0400490 int rhsc_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 unsigned long flags;
492
493 spin_lock_irqsave (&ohci->lock, flags);
Alan Stern541c7d42010-06-22 16:39:10 -0400494 if (!HCD_HW_ACCESSIBLE(hcd))
Alan Stern6fd75b12007-05-04 11:57:00 -0400495 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
David Brownellfdd13b32005-08-31 11:52:57 -0700497 /* undocumented erratum seen on at least rev D */
498 if ((ohci->flags & OHCI_QUIRK_AMD756)
499 && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
500 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
502 /* retry later; "should not happen" */
503 goto done;
504 }
505
506 /* init status */
507 if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
508 buf [0] = changed = 1;
509 else
510 buf [0] = 0;
David Brownellfdd13b32005-08-31 11:52:57 -0700511 if (ohci->num_ports > 7) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 buf [1] = 0;
513 length++;
514 }
515
Alan Stern71b74972008-10-09 15:40:23 -0400516 /* Clear the RHSC status flag before reading the port statuses */
517 ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
518 rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
519 OHCI_INTR_RHSC;
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 /* look at each port */
David Brownellfdd13b32005-08-31 11:52:57 -0700522 for (i = 0; i < ohci->num_ports; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 u32 status = roothub_portstatus (ohci, i);
524
Alan Stern8d1a2432006-09-26 14:46:16 -0400525 /* can't autostop if ports are connected */
526 any_connected |= (status & RH_PS_CCS);
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
529 | RH_PS_OCIC | RH_PS_PRSC)) {
530 changed = 1;
531 if (i < 7)
532 buf [0] |= 1 << (i + 1);
533 else
534 buf [1] |= 1 << (i - 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Alan Stern541c7d42010-06-22 16:39:10 -0400538 if (ohci_root_hub_state_changes(ohci, changed,
539 any_connected, rhsc_status))
540 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
541 else
542 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
543
David Brownelld4139842006-08-04 11:31:55 -0700544
545done:
546 spin_unlock_irqrestore (&ohci->lock, flags);
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return changed ? length : 0;
549}
550
551/*-------------------------------------------------------------------------*/
552
553static void
554ohci_hub_descriptor (
555 struct ohci_hcd *ohci,
556 struct usb_hub_descriptor *desc
557) {
558 u32 rh = roothub_a (ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 u16 temp;
560
561 desc->bDescriptorType = 0x29;
562 desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
563 desc->bHubContrCurrent = 0;
564
David Brownellfdd13b32005-08-31 11:52:57 -0700565 desc->bNbrPorts = ohci->num_ports;
566 temp = 1 + (ohci->num_ports / 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 desc->bDescLength = 7 + 2 * temp;
568
569 temp = 0;
570 if (rh & RH_A_NPS) /* no power switching? */
571 temp |= 0x0002;
David Brownelldd9048a2006-12-05 03:18:31 -0800572 if (rh & RH_A_PSM) /* per-port power switching? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 temp |= 0x0001;
574 if (rh & RH_A_NOCP) /* no overcurrent reporting? */
575 temp |= 0x0010;
576 else if (rh & RH_A_OCPM) /* per-port overcurrent reporting? */
577 temp |= 0x0008;
578 desc->wHubCharacteristics = (__force __u16)cpu_to_hc16(ohci, temp);
579
Sarah Sharpda130512010-11-30 15:55:51 -0800580 /* ports removable, and usb 1.0 legacy PortPwrCtrlMask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 rh = roothub_b (ohci);
John Youndbe79bb2001-09-17 00:00:00 -0700582 memset(desc->u.hs.DeviceRemovable, 0xff,
583 sizeof(desc->u.hs.DeviceRemovable));
584 desc->u.hs.DeviceRemovable[0] = rh & RH_B_DR;
David Brownellfdd13b32005-08-31 11:52:57 -0700585 if (ohci->num_ports > 7) {
John Youndbe79bb2001-09-17 00:00:00 -0700586 desc->u.hs.DeviceRemovable[1] = (rh & RH_B_DR) >> 8;
587 desc->u.hs.DeviceRemovable[2] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 } else
John Youndbe79bb2001-09-17 00:00:00 -0700589 desc->u.hs.DeviceRemovable[1] = 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
592/*-------------------------------------------------------------------------*/
593
594#ifdef CONFIG_USB_OTG
595
596static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
597{
598 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
599 u32 status;
600
601 if (!port)
602 return -EINVAL;
603 port--;
604
605 /* start port reset before HNP protocol times out */
606 status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
607 if (!(status & RH_PS_CCS))
608 return -ENODEV;
609
610 /* khubd will finish the reset later */
611 ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
612 return 0;
613}
614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615#else
616
617#define ohci_start_port_reset NULL
618
619#endif
620
621/*-------------------------------------------------------------------------*/
622
623
624/* See usb 7.1.7.5: root hubs must issue at least 50 msec reset signaling,
625 * not necessarily continuous ... to guard against resume signaling.
626 * The short timeout is safe for non-root hubs, and is backward-compatible
627 * with earlier Linux hosts.
628 */
629#ifdef CONFIG_USB_SUSPEND
630#define PORT_RESET_MSEC 50
631#else
632#define PORT_RESET_MSEC 10
633#endif
634
635/* this timer value might be vendor-specific ... */
636#define PORT_RESET_HW_MSEC 10
637
638/* wrap-aware logic morphed from <linux/jiffies.h> */
639#define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
640
641/* called from some task, normally khubd */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800642static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
Alan Stern1b7b61c2008-04-22 10:50:18 -0400645 u32 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 u16 now = ohci_readl(ohci, &ohci->regs->fmnumber);
647 u16 reset_done = now + PORT_RESET_MSEC;
David Brownelle01e7fe2008-02-02 02:42:52 -0800648 int limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
650 /* build a "continuous enough" reset signal, with up to
651 * 3msec gap between pulses. scheduler HZ==100 must work;
652 * this might need to be deadline-scheduled.
653 */
654 do {
David Brownelle01e7fe2008-02-02 02:42:52 -0800655 int limit_2;
656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 /* spin until any current reset finishes */
David Brownelle01e7fe2008-02-02 02:42:52 -0800658 limit_2 = PORT_RESET_HW_MSEC * 2;
659 while (--limit_2 >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 temp = ohci_readl (ohci, portstat);
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800661 /* handle e.g. CardBus eject */
662 if (temp == ~(u32)0)
663 return -ESHUTDOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 if (!(temp & RH_PS_PRS))
665 break;
666 udelay (500);
David Brownelldd9048a2006-12-05 03:18:31 -0800667 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
David Brownelle01e7fe2008-02-02 02:42:52 -0800669 /* timeout (a hardware error) has been observed when
670 * EHCI sets CF while this driver is resetting a port;
671 * presumably other disconnect paths might do it too.
672 */
673 if (limit_2 < 0) {
674 ohci_dbg(ohci,
675 "port[%d] reset timeout, stat %08x\n",
676 port, temp);
677 break;
678 }
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 if (!(temp & RH_PS_CCS))
681 break;
682 if (temp & RH_PS_PRSC)
683 ohci_writel (ohci, RH_PS_PRSC, portstat);
684
685 /* start the next reset, sleep till it's probably done */
686 ohci_writel (ohci, RH_PS_PRS, portstat);
687 msleep(PORT_RESET_HW_MSEC);
688 now = ohci_readl(ohci, &ohci->regs->fmnumber);
David Brownelle01e7fe2008-02-02 02:42:52 -0800689 } while (tick_before(now, reset_done) && --limit_1 >= 0);
690
691 /* caller synchronizes using PRSC ... and handles PRS
692 * still being set when this returns.
693 */
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800694
695 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696}
697
698static int ohci_hub_control (
699 struct usb_hcd *hcd,
700 u16 typeReq,
701 u16 wValue,
702 u16 wIndex,
703 char *buf,
704 u16 wLength
705) {
706 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
Alan Sternfcf7d212010-04-20 10:37:57 -0400707 int ports = ohci->num_ports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 u32 temp;
709 int retval = 0;
710
Alan Stern541c7d42010-06-22 16:39:10 -0400711 if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100712 return -ESHUTDOWN;
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 switch (typeReq) {
715 case ClearHubFeature:
716 switch (wValue) {
717 case C_HUB_OVER_CURRENT:
718 ohci_writel (ohci, RH_HS_OCIC,
719 &ohci->regs->roothub.status);
720 case C_HUB_LOCAL_POWER:
721 break;
722 default:
723 goto error;
724 }
725 break;
726 case ClearPortFeature:
727 if (!wIndex || wIndex > ports)
728 goto error;
729 wIndex--;
730
731 switch (wValue) {
732 case USB_PORT_FEAT_ENABLE:
733 temp = RH_PS_CCS;
734 break;
735 case USB_PORT_FEAT_C_ENABLE:
736 temp = RH_PS_PESC;
737 break;
738 case USB_PORT_FEAT_SUSPEND:
739 temp = RH_PS_POCI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 break;
741 case USB_PORT_FEAT_C_SUSPEND:
742 temp = RH_PS_PSSC;
743 break;
744 case USB_PORT_FEAT_POWER:
745 temp = RH_PS_LSDA;
746 break;
747 case USB_PORT_FEAT_C_CONNECTION:
748 temp = RH_PS_CSC;
749 break;
750 case USB_PORT_FEAT_C_OVER_CURRENT:
751 temp = RH_PS_OCIC;
752 break;
753 case USB_PORT_FEAT_C_RESET:
754 temp = RH_PS_PRSC;
755 break;
756 default:
757 goto error;
758 }
759 ohci_writel (ohci, temp,
760 &ohci->regs->roothub.portstatus [wIndex]);
761 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
762 break;
763 case GetHubDescriptor:
764 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
765 break;
766 case GetHubStatus:
767 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700768 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 break;
770 case GetPortStatus:
771 if (!wIndex || wIndex > ports)
772 goto error;
773 wIndex--;
774 temp = roothub_portstatus (ohci, wIndex);
Harvey Harrisona5abdea2008-04-29 01:03:40 -0700775 put_unaligned_le32(temp, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
777#ifndef OHCI_VERBOSE_DEBUG
778 if (*(u16*)(buf+2)) /* only if wPortChange is interesting */
779#endif
780 dbg_port (ohci, "GetStatus", wIndex, temp);
781 break;
782 case SetHubFeature:
783 switch (wValue) {
784 case C_HUB_OVER_CURRENT:
785 // FIXME: this can be cleared, yes?
786 case C_HUB_LOCAL_POWER:
787 break;
788 default:
789 goto error;
790 }
791 break;
792 case SetPortFeature:
793 if (!wIndex || wIndex > ports)
794 goto error;
795 wIndex--;
796 switch (wValue) {
797 case USB_PORT_FEAT_SUSPEND:
798#ifdef CONFIG_USB_OTG
799 if (hcd->self.otg_port == (wIndex + 1)
800 && hcd->self.b_hnp_enable)
Dmitry Baryshkove8b24452008-07-06 14:26:30 +0400801 ohci->start_hnp(ohci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 else
803#endif
804 ohci_writel (ohci, RH_PS_PSS,
805 &ohci->regs->roothub.portstatus [wIndex]);
806 break;
807 case USB_PORT_FEAT_POWER:
808 ohci_writel (ohci, RH_PS_PPS,
809 &ohci->regs->roothub.portstatus [wIndex]);
810 break;
811 case USB_PORT_FEAT_RESET:
Takamasa Ohtake23d10a92006-12-06 17:04:15 -0800812 retval = root_port_reset (ohci, wIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 break;
814 default:
815 goto error;
816 }
817 break;
818
819 default:
820error:
821 /* "protocol stall" on error */
822 retval = -EPIPE;
823 }
824 return retval;
825}
826