1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2001-2004 by David Brownell
4 */
5
6 /* this file is part of ehci-hcd.c */
7
8 /*-------------------------------------------------------------------------*/
9
10 /*
11 * EHCI Root Hub ... the nonsharable stuff
12 *
13 * Registers don't need cpu_to_le32, that happens transparently
14 */
15
16 /*-------------------------------------------------------------------------*/
17
18 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
19
20 #ifdef CONFIG_PM
21
22 static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
23
persist_enabled_on_companion(struct usb_device * udev,void * unused)24 static int persist_enabled_on_companion(struct usb_device *udev, void *unused)
25 {
26 return !udev->maxchild && udev->persist_enabled &&
27 udev->bus->root_hub->speed < USB_SPEED_HIGH;
28 }
29
30 /* After a power loss, ports that were owned by the companion must be
31 * reset so that the companion can still own them.
32 */
ehci_handover_companion_ports(struct ehci_hcd * ehci)33 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
34 {
35 u32 __iomem *reg;
36 u32 status;
37 int port;
38 __le32 buf;
39 struct usb_hcd *hcd = ehci_to_hcd(ehci);
40
41 if (!ehci->owned_ports)
42 return;
43
44 /*
45 * USB 1.1 devices are mostly HIDs, which don't need to persist across
46 * suspends. If we ensure that none of our companion's devices have
47 * persist_enabled (by looking through all USB 1.1 buses in the system),
48 * we can skip this and avoid slowing resume down. Devices without
49 * persist will just get reenumerated shortly after resume anyway.
50 */
51 if (!usb_for_each_dev(NULL, persist_enabled_on_companion))
52 return;
53
54 /* Make sure the ports are powered */
55 port = HCS_N_PORTS(ehci->hcs_params);
56 while (port--) {
57 if (test_bit(port, &ehci->owned_ports)) {
58 reg = &ehci->regs->port_status[port];
59 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
60 if (!(status & PORT_POWER))
61 ehci_port_power(ehci, port, true);
62 }
63 }
64
65 /* Give the connections some time to appear */
66 msleep(20);
67
68 spin_lock_irq(&ehci->lock);
69 port = HCS_N_PORTS(ehci->hcs_params);
70 while (port--) {
71 if (test_bit(port, &ehci->owned_ports)) {
72 reg = &ehci->regs->port_status[port];
73 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
74
75 /* Port already owned by companion? */
76 if (status & PORT_OWNER)
77 clear_bit(port, &ehci->owned_ports);
78 else if (test_bit(port, &ehci->companion_ports))
79 ehci_writel(ehci, status & ~PORT_PE, reg);
80 else {
81 spin_unlock_irq(&ehci->lock);
82 ehci_hub_control(hcd, SetPortFeature,
83 USB_PORT_FEAT_RESET, port + 1,
84 NULL, 0);
85 spin_lock_irq(&ehci->lock);
86 }
87 }
88 }
89 spin_unlock_irq(&ehci->lock);
90
91 if (!ehci->owned_ports)
92 return;
93 msleep(90); /* Wait for resets to complete */
94
95 spin_lock_irq(&ehci->lock);
96 port = HCS_N_PORTS(ehci->hcs_params);
97 while (port--) {
98 if (test_bit(port, &ehci->owned_ports)) {
99 spin_unlock_irq(&ehci->lock);
100 ehci_hub_control(hcd, GetPortStatus,
101 0, port + 1,
102 (char *) &buf, sizeof(buf));
103 spin_lock_irq(&ehci->lock);
104
105 /* The companion should now own the port,
106 * but if something went wrong the port must not
107 * remain enabled.
108 */
109 reg = &ehci->regs->port_status[port];
110 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
111 if (status & PORT_OWNER)
112 ehci_writel(ehci, status | PORT_CSC, reg);
113 else {
114 ehci_dbg(ehci, "failed handover port %d: %x\n",
115 port + 1, status);
116 ehci_writel(ehci, status & ~PORT_PE, reg);
117 }
118 }
119 }
120
121 ehci->owned_ports = 0;
122 spin_unlock_irq(&ehci->lock);
123 }
124
ehci_port_change(struct ehci_hcd * ehci)125 static int ehci_port_change(struct ehci_hcd *ehci)
126 {
127 int i = HCS_N_PORTS(ehci->hcs_params);
128
129 /* First check if the controller indicates a change event */
130
131 if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
132 return 1;
133
134 /*
135 * Not all controllers appear to update this while going from D3 to D0,
136 * so check the individual port status registers as well
137 */
138
139 while (i--)
140 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
141 return 1;
142
143 return 0;
144 }
145
ehci_adjust_port_wakeup_flags(struct ehci_hcd * ehci,bool suspending,bool do_wakeup)146 void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
147 bool suspending, bool do_wakeup)
148 {
149 int port;
150 u32 temp;
151
152 /* If remote wakeup is enabled for the root hub but disabled
153 * for the controller, we must adjust all the port wakeup flags
154 * when the controller is suspended or resumed. In all other
155 * cases they don't need to be changed.
156 */
157 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
158 return;
159
160 spin_lock_irq(&ehci->lock);
161
162 /* clear phy low-power mode before changing wakeup flags */
163 if (ehci->has_tdi_phy_lpm) {
164 port = HCS_N_PORTS(ehci->hcs_params);
165 while (port--) {
166 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
167
168 temp = ehci_readl(ehci, hostpc_reg);
169 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
170 }
171 spin_unlock_irq(&ehci->lock);
172 msleep(5);
173 spin_lock_irq(&ehci->lock);
174 }
175
176 port = HCS_N_PORTS(ehci->hcs_params);
177 while (port--) {
178 u32 __iomem *reg = &ehci->regs->port_status[port];
179 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
180 u32 t2 = t1 & ~PORT_WAKE_BITS;
181
182 /* If we are suspending the controller, clear the flags.
183 * If we are resuming the controller, set the wakeup flags.
184 */
185 if (!suspending) {
186 if (t1 & PORT_CONNECT)
187 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
188 else
189 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
190 }
191 ehci_writel(ehci, t2, reg);
192 }
193
194 /* enter phy low-power mode again */
195 if (ehci->has_tdi_phy_lpm) {
196 port = HCS_N_PORTS(ehci->hcs_params);
197 while (port--) {
198 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
199
200 temp = ehci_readl(ehci, hostpc_reg);
201 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
202 }
203 }
204
205 /* Does the root hub have a port wakeup pending? */
206 if (!suspending && ehci_port_change(ehci))
207 usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
208
209 spin_unlock_irq(&ehci->lock);
210 }
211 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags);
212
ehci_bus_suspend(struct usb_hcd * hcd)213 static int ehci_bus_suspend (struct usb_hcd *hcd)
214 {
215 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
216 int port;
217 int mask;
218 int changed;
219 bool fs_idle_delay;
220
221 ehci_dbg(ehci, "suspend root hub\n");
222
223 if (time_before (jiffies, ehci->next_statechange))
224 msleep(5);
225
226 /* stop the schedules */
227 ehci_quiesce(ehci);
228
229 spin_lock_irq (&ehci->lock);
230 if (ehci->rh_state < EHCI_RH_RUNNING)
231 goto done;
232
233 /* Once the controller is stopped, port resumes that are already
234 * in progress won't complete. Hence if remote wakeup is enabled
235 * for the root hub and any ports are in the middle of a resume or
236 * remote wakeup, we must fail the suspend.
237 */
238 if (hcd->self.root_hub->do_remote_wakeup) {
239 if (ehci->resuming_ports) {
240 spin_unlock_irq(&ehci->lock);
241 ehci_dbg(ehci, "suspend failed because a port is resuming\n");
242 return -EBUSY;
243 }
244 }
245
246 /* Unlike other USB host controller types, EHCI doesn't have
247 * any notion of "global" or bus-wide suspend. The driver has
248 * to manually suspend all the active unsuspended ports, and
249 * then manually resume them in the bus_resume() routine.
250 */
251 ehci->bus_suspended = 0;
252 ehci->owned_ports = 0;
253 changed = 0;
254 fs_idle_delay = false;
255 port = HCS_N_PORTS(ehci->hcs_params);
256 while (port--) {
257 u32 __iomem *reg = &ehci->regs->port_status [port];
258 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
259 u32 t2 = t1 & ~PORT_WAKE_BITS;
260
261 /* keep track of which ports we suspend */
262 if (t1 & PORT_OWNER)
263 set_bit(port, &ehci->owned_ports);
264 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
265 t2 |= PORT_SUSPEND;
266 set_bit(port, &ehci->bus_suspended);
267 }
268
269 /* enable remote wakeup on all ports, if told to do so */
270 if (hcd->self.root_hub->do_remote_wakeup) {
271 /* only enable appropriate wake bits, otherwise the
272 * hardware can not go phy low power mode. If a race
273 * condition happens here(connection change during bits
274 * set), the port change detection will finally fix it.
275 */
276 if (t1 & PORT_CONNECT)
277 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
278 else
279 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
280 }
281
282 if (t1 != t2) {
283 /*
284 * On some controllers, Wake-On-Disconnect will
285 * generate false wakeup signals until the bus
286 * switches over to full-speed idle. For their
287 * sake, add a delay if we need one.
288 */
289 if ((t2 & PORT_WKDISC_E) &&
290 ehci_port_speed(ehci, t2) ==
291 USB_PORT_STAT_HIGH_SPEED)
292 fs_idle_delay = true;
293 ehci_writel(ehci, t2, reg);
294 changed = 1;
295 }
296 }
297 spin_unlock_irq(&ehci->lock);
298
299 if (changed && ehci_has_fsl_susp_errata(ehci))
300 /*
301 * Wait for at least 10 millisecondes to ensure the controller
302 * enter the suspend status before initiating a port resume
303 * using the Force Port Resume bit (Not-EHCI compatible).
304 */
305 usleep_range(10000, 20000);
306
307 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
308 /*
309 * Wait for HCD to enter low-power mode or for the bus
310 * to switch to full-speed idle.
311 */
312 usleep_range(5000, 5500);
313 }
314
315 if (changed && ehci->has_tdi_phy_lpm) {
316 spin_lock_irq(&ehci->lock);
317 port = HCS_N_PORTS(ehci->hcs_params);
318 while (port--) {
319 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
320 u32 t3;
321
322 t3 = ehci_readl(ehci, hostpc_reg);
323 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
324 t3 = ehci_readl(ehci, hostpc_reg);
325 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
326 port, (t3 & HOSTPC_PHCD) ?
327 "succeeded" : "failed");
328 }
329 spin_unlock_irq(&ehci->lock);
330 }
331
332 /* Apparently some devices need a >= 1-uframe delay here */
333 if (ehci->bus_suspended)
334 udelay(150);
335
336 /* turn off now-idle HC */
337 ehci_halt (ehci);
338
339 spin_lock_irq(&ehci->lock);
340 if (ehci->enabled_hrtimer_events & BIT(EHCI_HRTIMER_POLL_DEAD))
341 ehci_handle_controller_death(ehci);
342 if (ehci->rh_state != EHCI_RH_RUNNING)
343 goto done;
344 ehci->rh_state = EHCI_RH_SUSPENDED;
345
346 unlink_empty_async_suspended(ehci);
347
348 /* Some Synopsys controllers mistakenly leave IAA turned on */
349 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
350
351 /* Any IAA cycle that started before the suspend is now invalid */
352 end_iaa_cycle(ehci);
353 ehci_handle_start_intr_unlinks(ehci);
354 ehci_handle_intr_unlinks(ehci);
355 end_free_itds(ehci);
356
357 /* allow remote wakeup */
358 mask = INTR_MASK;
359 if (!hcd->self.root_hub->do_remote_wakeup)
360 mask &= ~STS_PCD;
361 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
362 ehci_readl(ehci, &ehci->regs->intr_enable);
363
364 done:
365 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
366 ehci->enabled_hrtimer_events = 0;
367 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
368 spin_unlock_irq (&ehci->lock);
369
370 hrtimer_cancel(&ehci->hrtimer);
371 return 0;
372 }
373
374
375 /* caller has locked the root hub, and should reset/reinit on error */
ehci_bus_resume(struct usb_hcd * hcd)376 static int ehci_bus_resume (struct usb_hcd *hcd)
377 {
378 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
379 u32 temp;
380 u32 power_okay;
381 int i;
382 unsigned long resume_needed = 0;
383
384 if (time_before (jiffies, ehci->next_statechange))
385 msleep(5);
386 spin_lock_irq (&ehci->lock);
387 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
388 goto shutdown;
389
390 if (unlikely(ehci->debug)) {
391 if (!dbgp_reset_prep(hcd))
392 ehci->debug = NULL;
393 else
394 dbgp_external_startup(hcd);
395 }
396
397 /* Ideally and we've got a real resume here, and no port's power
398 * was lost. (For PCI, that means Vaux was maintained.) But we
399 * could instead be restoring a swsusp snapshot -- so that BIOS was
400 * the last user of the controller, not reset/pm hardware keeping
401 * state we gave to it.
402 */
403 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
404 ehci_dbg(ehci, "resume root hub%s\n",
405 power_okay ? "" : " after power loss");
406
407 /* at least some APM implementations will try to deliver
408 * IRQs right away, so delay them until we're ready.
409 */
410 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
411
412 /* re-init operational registers */
413 ehci_writel(ehci, 0, &ehci->regs->segment);
414 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
415 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
416
417 /* restore CMD_RUN, framelist size, and irq threshold */
418 ehci->command |= CMD_RUN;
419 ehci_writel(ehci, ehci->command, &ehci->regs->command);
420 ehci->rh_state = EHCI_RH_RUNNING;
421
422 /*
423 * According to Bugzilla #8190, the port status for some controllers
424 * will be wrong without a delay. At their wrong status, the port
425 * is enabled, but not suspended neither resumed.
426 */
427 i = HCS_N_PORTS(ehci->hcs_params);
428 while (i--) {
429 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
430 if ((temp & PORT_PE) &&
431 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
432 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
433 spin_unlock_irq(&ehci->lock);
434 msleep(8);
435 spin_lock_irq(&ehci->lock);
436 break;
437 }
438 }
439
440 if (ehci->shutdown)
441 goto shutdown;
442
443 /* clear phy low-power mode before resume */
444 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
445 i = HCS_N_PORTS(ehci->hcs_params);
446 while (i--) {
447 if (test_bit(i, &ehci->bus_suspended)) {
448 u32 __iomem *hostpc_reg =
449 &ehci->regs->hostpc[i];
450
451 temp = ehci_readl(ehci, hostpc_reg);
452 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
453 hostpc_reg);
454 }
455 }
456 spin_unlock_irq(&ehci->lock);
457 msleep(5);
458 spin_lock_irq(&ehci->lock);
459 if (ehci->shutdown)
460 goto shutdown;
461 }
462
463 /* manually resume the ports we suspended during bus_suspend() */
464 i = HCS_N_PORTS (ehci->hcs_params);
465 while (i--) {
466 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
467 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
468 if (test_bit(i, &ehci->bus_suspended) &&
469 (temp & PORT_SUSPEND)) {
470 temp |= PORT_RESUME;
471 set_bit(i, &resume_needed);
472 }
473 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
474 }
475
476 /*
477 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
478 * port
479 */
480 if (resume_needed) {
481 spin_unlock_irq(&ehci->lock);
482 msleep(USB_RESUME_TIMEOUT);
483 spin_lock_irq(&ehci->lock);
484 if (ehci->shutdown)
485 goto shutdown;
486 }
487
488 i = HCS_N_PORTS (ehci->hcs_params);
489 while (i--) {
490 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
491 if (test_bit(i, &resume_needed)) {
492 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
493 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
494 }
495 }
496
497 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
498 spin_unlock_irq(&ehci->lock);
499
500 ehci_handover_companion_ports(ehci);
501
502 /* Now we can safely re-enable irqs */
503 spin_lock_irq(&ehci->lock);
504 if (ehci->shutdown)
505 goto shutdown;
506 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
507 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
508 spin_unlock_irq(&ehci->lock);
509
510 return 0;
511
512 shutdown:
513 spin_unlock_irq(&ehci->lock);
514 return -ESHUTDOWN;
515 }
516
ehci_get_resuming_ports(struct usb_hcd * hcd)517 static unsigned long ehci_get_resuming_ports(struct usb_hcd *hcd)
518 {
519 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
520
521 return ehci->resuming_ports;
522 }
523
524 #else
525
526 #define ehci_bus_suspend NULL
527 #define ehci_bus_resume NULL
528 #define ehci_get_resuming_ports NULL
529
530 #endif /* CONFIG_PM */
531
532 /*-------------------------------------------------------------------------*/
533
534 /*
535 * Sets the owner of a port
536 */
set_owner(struct ehci_hcd * ehci,int portnum,int new_owner)537 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
538 {
539 u32 __iomem *status_reg;
540 u32 port_status;
541 int try;
542
543 status_reg = &ehci->regs->port_status[portnum];
544
545 /*
546 * The controller won't set the OWNER bit if the port is
547 * enabled, so this loop will sometimes require at least two
548 * iterations: one to disable the port and one to set OWNER.
549 */
550 for (try = 4; try > 0; --try) {
551 spin_lock_irq(&ehci->lock);
552 port_status = ehci_readl(ehci, status_reg);
553 if ((port_status & PORT_OWNER) == new_owner
554 || (port_status & (PORT_OWNER | PORT_CONNECT))
555 == 0)
556 try = 0;
557 else {
558 port_status ^= PORT_OWNER;
559 port_status &= ~(PORT_PE | PORT_RWC_BITS);
560 ehci_writel(ehci, port_status, status_reg);
561 }
562 spin_unlock_irq(&ehci->lock);
563 if (try > 1)
564 msleep(5);
565 }
566 }
567
568 /*-------------------------------------------------------------------------*/
569
check_reset_complete(struct ehci_hcd * ehci,int index,u32 __iomem * status_reg,int port_status)570 static int check_reset_complete (
571 struct ehci_hcd *ehci,
572 int index,
573 u32 __iomem *status_reg,
574 int port_status
575 ) {
576 if (!(port_status & PORT_CONNECT))
577 return port_status;
578
579 /* if reset finished and it's still not enabled -- handoff */
580 if (!(port_status & PORT_PE)) {
581
582 /* with integrated TT, there's nobody to hand it to! */
583 if (ehci_is_TDI(ehci)) {
584 ehci_dbg (ehci,
585 "Failed to enable port %d on root hub TT\n",
586 index+1);
587 return port_status;
588 }
589
590 ehci_dbg (ehci, "port %d full speed --> companion\n",
591 index + 1);
592
593 // what happens if HCS_N_CC(params) == 0 ?
594 port_status |= PORT_OWNER;
595 port_status &= ~PORT_RWC_BITS;
596 ehci_writel(ehci, port_status, status_reg);
597
598 /* ensure 440EPX ohci controller state is operational */
599 if (ehci->has_amcc_usb23)
600 set_ohci_hcfs(ehci, 1);
601 } else {
602 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
603 index + 1);
604 /* ensure 440EPx ohci controller state is suspended */
605 if (ehci->has_amcc_usb23)
606 set_ohci_hcfs(ehci, 0);
607 }
608
609 return port_status;
610 }
611
612 /*-------------------------------------------------------------------------*/
613
614
615 /* build "status change" packet (one or two bytes) from HC registers */
616
617 static int
ehci_hub_status_data(struct usb_hcd * hcd,char * buf)618 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
619 {
620 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
621 u32 temp, status;
622 u32 mask;
623 int ports, i, retval = 1;
624 unsigned long flags;
625 u32 ppcd = ~0;
626
627 /* init status to no-changes */
628 buf [0] = 0;
629 ports = HCS_N_PORTS (ehci->hcs_params);
630 if (ports > 7) {
631 buf [1] = 0;
632 retval++;
633 }
634
635 /* Inform the core about resumes-in-progress by returning
636 * a non-zero value even if there are no status changes.
637 */
638 status = ehci->resuming_ports;
639
640 /* Some boards (mostly VIA?) report bogus overcurrent indications,
641 * causing massive log spam unless we completely ignore them. It
642 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
643 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
644 * PORT_POWER; that's surprising, but maybe within-spec.
645 */
646 if (!ignore_oc && !ehci->spurious_oc)
647 mask = PORT_CSC | PORT_PEC | PORT_OCC;
648 else
649 mask = PORT_CSC | PORT_PEC;
650 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
651
652 /* no hub change reports (bit 0) for now (power, ...) */
653
654 /* port N changes (bit N)? */
655 spin_lock_irqsave (&ehci->lock, flags);
656
657 /* get per-port change detect bits */
658 if (ehci->has_ppcd)
659 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
660
661 for (i = 0; i < ports; i++) {
662 /* leverage per-port change bits feature */
663 if (ppcd & (1 << i))
664 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
665 else
666 temp = 0;
667
668 /*
669 * Return status information even for ports with OWNER set.
670 * Otherwise hub_wq wouldn't see the disconnect event when a
671 * high-speed device is switched over to the companion
672 * controller by the user.
673 */
674
675 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
676 || (ehci->reset_done[i] && time_after_eq(
677 jiffies, ehci->reset_done[i]))) {
678 if (i < 7)
679 buf [0] |= 1 << (i + 1);
680 else
681 buf [1] |= 1 << (i - 7);
682 status = STS_PCD;
683 }
684 }
685
686 /* If a resume is in progress, make sure it can finish */
687 if (ehci->resuming_ports)
688 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(25));
689
690 spin_unlock_irqrestore (&ehci->lock, flags);
691 return status ? retval : 0;
692 }
693
694 /*-------------------------------------------------------------------------*/
695
696 static void
ehci_hub_descriptor(struct ehci_hcd * ehci,struct usb_hub_descriptor * desc)697 ehci_hub_descriptor (
698 struct ehci_hcd *ehci,
699 struct usb_hub_descriptor *desc
700 ) {
701 int ports = HCS_N_PORTS (ehci->hcs_params);
702 u16 temp;
703
704 desc->bDescriptorType = USB_DT_HUB;
705 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
706 desc->bHubContrCurrent = 0;
707
708 desc->bNbrPorts = ports;
709 temp = 1 + (ports / 8);
710 desc->bDescLength = 7 + 2 * temp;
711
712 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
713 memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
714 memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
715
716 temp = HUB_CHAR_INDV_PORT_OCPM; /* per-port overcurrent reporting */
717 if (HCS_PPC (ehci->hcs_params))
718 temp |= HUB_CHAR_INDV_PORT_LPSM; /* per-port power control */
719 else
720 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
721 #if 0
722 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
723 if (HCS_INDICATOR (ehci->hcs_params))
724 temp |= HUB_CHAR_PORTIND; /* per-port indicators (LEDs) */
725 #endif
726 desc->wHubCharacteristics = cpu_to_le16(temp);
727 }
728
729 /*-------------------------------------------------------------------------*/
730
ehci_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)731 int ehci_hub_control(
732 struct usb_hcd *hcd,
733 u16 typeReq,
734 u16 wValue,
735 u16 wIndex,
736 char *buf,
737 u16 wLength
738 ) {
739 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
740 int ports = HCS_N_PORTS (ehci->hcs_params);
741 u32 __iomem *status_reg, *hostpc_reg;
742 u32 temp, temp1, status;
743 unsigned long flags;
744 int retval = 0;
745 unsigned selector;
746
747 /*
748 * Avoid underflow while calculating (wIndex & 0xff) - 1.
749 * The compiler might deduce that wIndex can never be 0 and then
750 * optimize away the tests for !wIndex below.
751 */
752 temp = wIndex & 0xff;
753 temp -= (temp > 0);
754 status_reg = &ehci->regs->port_status[temp];
755 hostpc_reg = &ehci->regs->hostpc[temp];
756
757 /*
758 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
759 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
760 * (track current state ourselves) ... blink for diagnostics,
761 * power, "this is the one", etc. EHCI spec supports this.
762 */
763
764 spin_lock_irqsave (&ehci->lock, flags);
765 switch (typeReq) {
766 case ClearHubFeature:
767 switch (wValue) {
768 case C_HUB_LOCAL_POWER:
769 case C_HUB_OVER_CURRENT:
770 /* no hub-wide feature/status flags */
771 break;
772 default:
773 goto error;
774 }
775 break;
776 case ClearPortFeature:
777 if (!wIndex || wIndex > ports)
778 goto error;
779 wIndex--;
780 temp = ehci_readl(ehci, status_reg);
781 temp &= ~PORT_RWC_BITS;
782
783 /*
784 * Even if OWNER is set, so the port is owned by the
785 * companion controller, hub_wq needs to be able to clear
786 * the port-change status bits (especially
787 * USB_PORT_STAT_C_CONNECTION).
788 */
789
790 switch (wValue) {
791 case USB_PORT_FEAT_ENABLE:
792 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
793 break;
794 case USB_PORT_FEAT_C_ENABLE:
795 ehci_writel(ehci, temp | PORT_PEC, status_reg);
796 break;
797 case USB_PORT_FEAT_SUSPEND:
798 if (temp & PORT_RESET)
799 goto error;
800 if (ehci->no_selective_suspend)
801 break;
802 #ifdef CONFIG_USB_OTG
803 if ((hcd->self.otg_port == (wIndex + 1))
804 && hcd->self.b_hnp_enable) {
805 otg_start_hnp(hcd->usb_phy->otg);
806 break;
807 }
808 #endif
809 if (!(temp & PORT_SUSPEND))
810 break;
811 if ((temp & PORT_PE) == 0)
812 goto error;
813
814 /* clear phy low-power mode before resume */
815 if (ehci->has_tdi_phy_lpm) {
816 temp1 = ehci_readl(ehci, hostpc_reg);
817 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
818 hostpc_reg);
819 spin_unlock_irqrestore(&ehci->lock, flags);
820 msleep(5);/* wait to leave low-power mode */
821 spin_lock_irqsave(&ehci->lock, flags);
822 }
823 /* resume signaling for 20 msec */
824 temp &= ~PORT_WAKE_BITS;
825 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
826 ehci->reset_done[wIndex] = jiffies
827 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
828 set_bit(wIndex, &ehci->resuming_ports);
829 usb_hcd_start_port_resume(&hcd->self, wIndex);
830 break;
831 case USB_PORT_FEAT_C_SUSPEND:
832 clear_bit(wIndex, &ehci->port_c_suspend);
833 break;
834 case USB_PORT_FEAT_POWER:
835 if (HCS_PPC(ehci->hcs_params)) {
836 spin_unlock_irqrestore(&ehci->lock, flags);
837 ehci_port_power(ehci, wIndex, false);
838 spin_lock_irqsave(&ehci->lock, flags);
839 }
840 break;
841 case USB_PORT_FEAT_C_CONNECTION:
842 ehci_writel(ehci, temp | PORT_CSC, status_reg);
843 break;
844 case USB_PORT_FEAT_C_OVER_CURRENT:
845 ehci_writel(ehci, temp | PORT_OCC, status_reg);
846 break;
847 case USB_PORT_FEAT_C_RESET:
848 /* GetPortStatus clears reset */
849 break;
850 default:
851 goto error;
852 }
853 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
854 break;
855 case GetHubDescriptor:
856 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
857 buf);
858 break;
859 case GetHubStatus:
860 /* no hub-wide feature/status flags */
861 memset (buf, 0, 4);
862 //cpu_to_le32s ((u32 *) buf);
863 break;
864 case GetPortStatus:
865 if (!wIndex || wIndex > ports)
866 goto error;
867 wIndex--;
868 status = 0;
869 temp = ehci_readl(ehci, status_reg);
870
871 // wPortChange bits
872 if (temp & PORT_CSC)
873 status |= USB_PORT_STAT_C_CONNECTION << 16;
874 if (temp & PORT_PEC)
875 status |= USB_PORT_STAT_C_ENABLE << 16;
876
877 if ((temp & PORT_OCC) && (!ignore_oc && !ehci->spurious_oc)){
878 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
879
880 /*
881 * Hubs should disable port power on over-current.
882 * However, not all EHCI implementations do this
883 * automatically, even if they _do_ support per-port
884 * power switching; they're allowed to just limit the
885 * current. hub_wq will turn the power back on.
886 */
887 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
888 && HCS_PPC(ehci->hcs_params)) {
889 spin_unlock_irqrestore(&ehci->lock, flags);
890 ehci_port_power(ehci, wIndex, false);
891 spin_lock_irqsave(&ehci->lock, flags);
892 temp = ehci_readl(ehci, status_reg);
893 }
894 }
895
896 /* no reset or resume pending */
897 if (!ehci->reset_done[wIndex]) {
898
899 /* Remote Wakeup received? */
900 if (temp & PORT_RESUME) {
901 /* resume signaling for 20 msec */
902 ehci->reset_done[wIndex] = jiffies
903 + msecs_to_jiffies(20);
904 usb_hcd_start_port_resume(&hcd->self, wIndex);
905 set_bit(wIndex, &ehci->resuming_ports);
906 /* check the port again */
907 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
908 ehci->reset_done[wIndex]);
909 }
910
911 /* reset or resume not yet complete */
912 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
913 ; /* wait until it is complete */
914
915 /* resume completed */
916 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
917 clear_bit(wIndex, &ehci->suspended_ports);
918 set_bit(wIndex, &ehci->port_c_suspend);
919 ehci->reset_done[wIndex] = 0;
920 usb_hcd_end_port_resume(&hcd->self, wIndex);
921
922 /* stop resume signaling */
923 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
924 ehci_writel(ehci, temp, status_reg);
925 clear_bit(wIndex, &ehci->resuming_ports);
926 retval = ehci_handshake(ehci, status_reg,
927 PORT_RESUME, 0, 2000 /* 2msec */);
928 if (retval != 0) {
929 ehci_err(ehci, "port %d resume error %d\n",
930 wIndex + 1, retval);
931 goto error;
932 }
933 temp = ehci_readl(ehci, status_reg);
934
935 /* whoever resets must GetPortStatus to complete it!! */
936 } else {
937 status |= USB_PORT_STAT_C_RESET << 16;
938 ehci->reset_done [wIndex] = 0;
939
940 /* force reset to complete */
941 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
942 status_reg);
943 /* REVISIT: some hardware needs 550+ usec to clear
944 * this bit; seems too long to spin routinely...
945 */
946 retval = ehci_handshake(ehci, status_reg,
947 PORT_RESET, 0, 1000);
948 if (retval != 0) {
949 ehci_err (ehci, "port %d reset error %d\n",
950 wIndex + 1, retval);
951 goto error;
952 }
953
954 /* see what we found out */
955 temp = check_reset_complete (ehci, wIndex, status_reg,
956 ehci_readl(ehci, status_reg));
957 }
958
959 /* transfer dedicated ports to the companion hc */
960 if ((temp & PORT_CONNECT) &&
961 test_bit(wIndex, &ehci->companion_ports)) {
962 temp &= ~PORT_RWC_BITS;
963 temp |= PORT_OWNER;
964 ehci_writel(ehci, temp, status_reg);
965 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
966 temp = ehci_readl(ehci, status_reg);
967 }
968
969 /*
970 * Even if OWNER is set, there's no harm letting hub_wq
971 * see the wPortStatus values (they should all be 0 except
972 * for PORT_POWER anyway).
973 */
974
975 if (temp & PORT_CONNECT) {
976 status |= USB_PORT_STAT_CONNECTION;
977 // status may be from integrated TT
978 if (ehci->has_hostpc) {
979 temp1 = ehci_readl(ehci, hostpc_reg);
980 status |= ehci_port_speed(ehci, temp1);
981 } else
982 status |= ehci_port_speed(ehci, temp);
983 }
984 if (temp & PORT_PE)
985 status |= USB_PORT_STAT_ENABLE;
986
987 /* maybe the port was unsuspended without our knowledge */
988 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
989 status |= USB_PORT_STAT_SUSPEND;
990 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
991 clear_bit(wIndex, &ehci->suspended_ports);
992 clear_bit(wIndex, &ehci->resuming_ports);
993 ehci->reset_done[wIndex] = 0;
994 if (temp & PORT_PE)
995 set_bit(wIndex, &ehci->port_c_suspend);
996 usb_hcd_end_port_resume(&hcd->self, wIndex);
997 }
998
999 if (temp & PORT_OC)
1000 status |= USB_PORT_STAT_OVERCURRENT;
1001 if (temp & PORT_RESET)
1002 status |= USB_PORT_STAT_RESET;
1003 if (temp & PORT_POWER)
1004 status |= USB_PORT_STAT_POWER;
1005 if (test_bit(wIndex, &ehci->port_c_suspend))
1006 status |= USB_PORT_STAT_C_SUSPEND << 16;
1007
1008 if (status & ~0xffff) /* only if wPortChange is interesting */
1009 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1010 put_unaligned_le32(status, buf);
1011 break;
1012 case SetHubFeature:
1013 switch (wValue) {
1014 case C_HUB_LOCAL_POWER:
1015 case C_HUB_OVER_CURRENT:
1016 /* no hub-wide feature/status flags */
1017 break;
1018 default:
1019 goto error;
1020 }
1021 break;
1022 case SetPortFeature:
1023 selector = wIndex >> 8;
1024 wIndex &= 0xff;
1025 if (unlikely(ehci->debug)) {
1026 /* If the debug port is active any port
1027 * feature requests should get denied */
1028 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1029 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1030 retval = -ENODEV;
1031 goto error_exit;
1032 }
1033 }
1034 if (!wIndex || wIndex > ports)
1035 goto error;
1036 wIndex--;
1037 temp = ehci_readl(ehci, status_reg);
1038 if (temp & PORT_OWNER)
1039 break;
1040
1041 temp &= ~PORT_RWC_BITS;
1042 switch (wValue) {
1043 case USB_PORT_FEAT_SUSPEND:
1044 if (ehci->no_selective_suspend)
1045 break;
1046 if ((temp & PORT_PE) == 0
1047 || (temp & PORT_RESET) != 0)
1048 goto error;
1049
1050 /* After above check the port must be connected.
1051 * Set appropriate bit thus could put phy into low power
1052 * mode if we have tdi_phy_lpm feature
1053 */
1054 temp &= ~PORT_WKCONN_E;
1055 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1056 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1057 if (ehci->has_tdi_phy_lpm) {
1058 spin_unlock_irqrestore(&ehci->lock, flags);
1059 msleep(5);/* 5ms for HCD enter low pwr mode */
1060 spin_lock_irqsave(&ehci->lock, flags);
1061 temp1 = ehci_readl(ehci, hostpc_reg);
1062 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1063 hostpc_reg);
1064 temp1 = ehci_readl(ehci, hostpc_reg);
1065 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1066 wIndex, (temp1 & HOSTPC_PHCD) ?
1067 "succeeded" : "failed");
1068 }
1069 if (ehci_has_fsl_susp_errata(ehci)) {
1070 /* 10ms for HCD enter suspend */
1071 spin_unlock_irqrestore(&ehci->lock, flags);
1072 usleep_range(10000, 20000);
1073 spin_lock_irqsave(&ehci->lock, flags);
1074 }
1075 set_bit(wIndex, &ehci->suspended_ports);
1076 break;
1077 case USB_PORT_FEAT_POWER:
1078 if (HCS_PPC(ehci->hcs_params)) {
1079 spin_unlock_irqrestore(&ehci->lock, flags);
1080 ehci_port_power(ehci, wIndex, true);
1081 spin_lock_irqsave(&ehci->lock, flags);
1082 }
1083 break;
1084 case USB_PORT_FEAT_RESET:
1085 if (temp & (PORT_SUSPEND|PORT_RESUME))
1086 goto error;
1087 /* line status bits may report this as low speed,
1088 * which can be fine if this root hub has a
1089 * transaction translator built in.
1090 */
1091 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1092 && !ehci_is_TDI(ehci)
1093 && PORT_USB11 (temp)) {
1094 ehci_dbg (ehci,
1095 "port %d low speed --> companion\n",
1096 wIndex + 1);
1097 temp |= PORT_OWNER;
1098 } else {
1099 temp |= PORT_RESET;
1100 temp &= ~PORT_PE;
1101
1102 /*
1103 * caller must wait, then call GetPortStatus
1104 * usb 2.0 spec says 50 ms resets on root
1105 */
1106 ehci->reset_done [wIndex] = jiffies
1107 + msecs_to_jiffies (50);
1108
1109 /*
1110 * Force full-speed connect for FSL high-speed
1111 * erratum; disable HS Chirp by setting PFSC bit
1112 */
1113 if (ehci_has_fsl_hs_errata(ehci))
1114 temp |= (1 << PORTSC_FSL_PFSC);
1115 }
1116 ehci_writel(ehci, temp, status_reg);
1117 break;
1118
1119 /* For downstream facing ports (these): one hub port is put
1120 * into test mode according to USB2 11.24.2.13, then the hub
1121 * must be reset (which for root hub now means rmmod+modprobe,
1122 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1123 * about the EHCI-specific stuff.
1124 */
1125 case USB_PORT_FEAT_TEST:
1126 #ifdef CONFIG_USB_HCD_TEST_MODE
1127 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1128 spin_unlock_irqrestore(&ehci->lock, flags);
1129 retval = ehset_single_step_set_feature(hcd,
1130 wIndex + 1);
1131 spin_lock_irqsave(&ehci->lock, flags);
1132 break;
1133 }
1134 #endif
1135 if (!selector || selector > 5)
1136 goto error;
1137 spin_unlock_irqrestore(&ehci->lock, flags);
1138 ehci_quiesce(ehci);
1139 spin_lock_irqsave(&ehci->lock, flags);
1140
1141 /* Put all enabled ports into suspend */
1142 while (ports--) {
1143 u32 __iomem *sreg =
1144 &ehci->regs->port_status[ports];
1145
1146 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1147 if (temp & PORT_PE)
1148 ehci_writel(ehci, temp | PORT_SUSPEND,
1149 sreg);
1150 }
1151
1152 spin_unlock_irqrestore(&ehci->lock, flags);
1153 ehci_halt(ehci);
1154 spin_lock_irqsave(&ehci->lock, flags);
1155
1156 temp = ehci_readl(ehci, status_reg);
1157 temp |= selector << 16;
1158 ehci_writel(ehci, temp, status_reg);
1159 break;
1160
1161 default:
1162 goto error;
1163 }
1164 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1165 break;
1166
1167 default:
1168 error:
1169 /* "stall" on error */
1170 retval = -EPIPE;
1171 }
1172 error_exit:
1173 spin_unlock_irqrestore (&ehci->lock, flags);
1174 return retval;
1175 }
1176 EXPORT_SYMBOL_GPL(ehci_hub_control);
1177
ehci_relinquish_port(struct usb_hcd * hcd,int portnum)1178 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1179 {
1180 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1181
1182 if (ehci_is_TDI(ehci))
1183 return;
1184 set_owner(ehci, --portnum, PORT_OWNER);
1185 }
1186
ehci_port_handed_over(struct usb_hcd * hcd,int portnum)1187 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1188 {
1189 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1190 u32 __iomem *reg;
1191
1192 if (ehci_is_TDI(ehci))
1193 return 0;
1194 reg = &ehci->regs->port_status[portnum - 1];
1195 return ehci_readl(ehci, reg) & PORT_OWNER;
1196 }
1197
ehci_port_power(struct ehci_hcd * ehci,int portnum,bool enable)1198 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1199 {
1200 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1201 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1202 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1203
1204 if (enable)
1205 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1206 else
1207 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1208
1209 if (hcd->driver->port_power)
1210 hcd->driver->port_power(hcd, portnum, enable);
1211
1212 return 0;
1213 }
1214