Merge tag 'trace-v5.11-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux/fpc-iii.git] / drivers / usb / host / ehci-hub.c
blob087402aec5cbeb43ab851364d6a99fff96a2b53a
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2001-2004 by David Brownell
4 */
6 /* this file is part of ehci-hcd.c */
8 /*-------------------------------------------------------------------------*/
11 * EHCI Root Hub ... the nonsharable stuff
13 * Registers don't need cpu_to_le32, that happens transparently
16 /*-------------------------------------------------------------------------*/
18 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
20 #ifdef CONFIG_PM
22 static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
24 static int persist_enabled_on_companion(struct usb_device *udev, void *unused)
26 return !udev->maxchild && udev->persist_enabled &&
27 udev->bus->root_hub->speed < USB_SPEED_HIGH;
30 /* After a power loss, ports that were owned by the companion must be
31 * reset so that the companion can still own them.
33 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
35 u32 __iomem *reg;
36 u32 status;
37 int port;
38 __le32 buf;
39 struct usb_hcd *hcd = ehci_to_hcd(ehci);
41 if (!ehci->owned_ports)
42 return;
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.
51 if (!usb_for_each_dev(NULL, persist_enabled_on_companion))
52 return;
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);
65 /* Give the connections some time to appear */
66 msleep(20);
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;
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);
89 spin_unlock_irq(&ehci->lock);
91 if (!ehci->owned_ports)
92 return;
93 msleep(90); /* Wait for resets to complete */
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);
105 /* The companion should now own the port,
106 * but if something went wrong the port must not
107 * remain enabled.
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);
121 ehci->owned_ports = 0;
122 spin_unlock_irq(&ehci->lock);
125 static int ehci_port_change(struct ehci_hcd *ehci)
127 int i = HCS_N_PORTS(ehci->hcs_params);
129 /* First check if the controller indicates a change event */
131 if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
132 return 1;
135 * Not all controllers appear to update this while going from D3 to D0,
136 * so check the individual port status registers as well
139 while (i--)
140 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
141 return 1;
143 return 0;
146 void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
147 bool suspending, bool do_wakeup)
149 int port;
150 u32 temp;
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.
157 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
158 return;
160 spin_lock_irq(&ehci->lock);
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];
168 temp = ehci_readl(ehci, hostpc_reg);
169 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
171 spin_unlock_irq(&ehci->lock);
172 msleep(5);
173 spin_lock_irq(&ehci->lock);
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;
182 /* If we are suspending the controller, clear the flags.
183 * If we are resuming the controller, set the wakeup flags.
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;
191 ehci_writel(ehci, t2, reg);
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];
200 temp = ehci_readl(ehci, hostpc_reg);
201 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
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));
209 spin_unlock_irq(&ehci->lock);
211 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags);
213 static int ehci_bus_suspend (struct usb_hcd *hcd)
215 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
216 int port;
217 int mask;
218 int changed;
219 bool fs_idle_delay;
221 ehci_dbg(ehci, "suspend root hub\n");
223 if (time_before (jiffies, ehci->next_statechange))
224 msleep(5);
226 /* stop the schedules */
227 ehci_quiesce(ehci);
229 spin_lock_irq (&ehci->lock);
230 if (ehci->rh_state < EHCI_RH_RUNNING)
231 goto done;
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.
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;
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.
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;
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);
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.
276 if (t1 & PORT_CONNECT)
277 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
278 else
279 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
282 if (t1 != t2) {
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.
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;
297 spin_unlock_irq(&ehci->lock);
299 if (changed && ehci_has_fsl_susp_errata(ehci))
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).
305 usleep_range(10000, 20000);
307 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
309 * Wait for HCD to enter low-power mode or for the bus
310 * to switch to full-speed idle.
312 usleep_range(5000, 5500);
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;
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");
329 spin_unlock_irq(&ehci->lock);
332 /* Apparently some devices need a >= 1-uframe delay here */
333 if (ehci->bus_suspended)
334 udelay(150);
336 /* turn off now-idle HC */
337 ehci_halt (ehci);
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;
346 unlink_empty_async_suspended(ehci);
348 /* Any IAA cycle that started before the suspend is now invalid */
349 end_iaa_cycle(ehci);
350 ehci_handle_start_intr_unlinks(ehci);
351 ehci_handle_intr_unlinks(ehci);
352 end_free_itds(ehci);
354 /* allow remote wakeup */
355 mask = INTR_MASK;
356 if (!hcd->self.root_hub->do_remote_wakeup)
357 mask &= ~STS_PCD;
358 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
359 ehci_readl(ehci, &ehci->regs->intr_enable);
361 done:
362 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
363 ehci->enabled_hrtimer_events = 0;
364 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
365 spin_unlock_irq (&ehci->lock);
367 hrtimer_cancel(&ehci->hrtimer);
368 return 0;
372 /* caller has locked the root hub, and should reset/reinit on error */
373 static int ehci_bus_resume (struct usb_hcd *hcd)
375 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
376 u32 temp;
377 u32 power_okay;
378 int i;
379 unsigned long resume_needed = 0;
381 if (time_before (jiffies, ehci->next_statechange))
382 msleep(5);
383 spin_lock_irq (&ehci->lock);
384 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
385 goto shutdown;
387 if (unlikely(ehci->debug)) {
388 if (!dbgp_reset_prep(hcd))
389 ehci->debug = NULL;
390 else
391 dbgp_external_startup(hcd);
394 /* Ideally and we've got a real resume here, and no port's power
395 * was lost. (For PCI, that means Vaux was maintained.) But we
396 * could instead be restoring a swsusp snapshot -- so that BIOS was
397 * the last user of the controller, not reset/pm hardware keeping
398 * state we gave to it.
400 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
401 ehci_dbg(ehci, "resume root hub%s\n",
402 power_okay ? "" : " after power loss");
404 /* at least some APM implementations will try to deliver
405 * IRQs right away, so delay them until we're ready.
407 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
409 /* re-init operational registers */
410 ehci_writel(ehci, 0, &ehci->regs->segment);
411 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
412 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
414 /* restore CMD_RUN, framelist size, and irq threshold */
415 ehci->command |= CMD_RUN;
416 ehci_writel(ehci, ehci->command, &ehci->regs->command);
417 ehci->rh_state = EHCI_RH_RUNNING;
420 * According to Bugzilla #8190, the port status for some controllers
421 * will be wrong without a delay. At their wrong status, the port
422 * is enabled, but not suspended neither resumed.
424 i = HCS_N_PORTS(ehci->hcs_params);
425 while (i--) {
426 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
427 if ((temp & PORT_PE) &&
428 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
429 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
430 spin_unlock_irq(&ehci->lock);
431 msleep(8);
432 spin_lock_irq(&ehci->lock);
433 break;
437 if (ehci->shutdown)
438 goto shutdown;
440 /* clear phy low-power mode before resume */
441 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
442 i = HCS_N_PORTS(ehci->hcs_params);
443 while (i--) {
444 if (test_bit(i, &ehci->bus_suspended)) {
445 u32 __iomem *hostpc_reg =
446 &ehci->regs->hostpc[i];
448 temp = ehci_readl(ehci, hostpc_reg);
449 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
450 hostpc_reg);
453 spin_unlock_irq(&ehci->lock);
454 msleep(5);
455 spin_lock_irq(&ehci->lock);
456 if (ehci->shutdown)
457 goto shutdown;
460 /* manually resume the ports we suspended during bus_suspend() */
461 i = HCS_N_PORTS (ehci->hcs_params);
462 while (i--) {
463 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
464 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
465 if (test_bit(i, &ehci->bus_suspended) &&
466 (temp & PORT_SUSPEND)) {
467 temp |= PORT_RESUME;
468 set_bit(i, &resume_needed);
470 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
474 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
475 * port
477 if (resume_needed) {
478 spin_unlock_irq(&ehci->lock);
479 msleep(USB_RESUME_TIMEOUT);
480 spin_lock_irq(&ehci->lock);
481 if (ehci->shutdown)
482 goto shutdown;
485 i = HCS_N_PORTS (ehci->hcs_params);
486 while (i--) {
487 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
488 if (test_bit(i, &resume_needed)) {
489 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
490 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
494 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
495 spin_unlock_irq(&ehci->lock);
497 ehci_handover_companion_ports(ehci);
499 /* Now we can safely re-enable irqs */
500 spin_lock_irq(&ehci->lock);
501 if (ehci->shutdown)
502 goto shutdown;
503 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
504 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
505 spin_unlock_irq(&ehci->lock);
507 return 0;
509 shutdown:
510 spin_unlock_irq(&ehci->lock);
511 return -ESHUTDOWN;
514 static unsigned long ehci_get_resuming_ports(struct usb_hcd *hcd)
516 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
518 return ehci->resuming_ports;
521 #else
523 #define ehci_bus_suspend NULL
524 #define ehci_bus_resume NULL
525 #define ehci_get_resuming_ports NULL
527 #endif /* CONFIG_PM */
529 /*-------------------------------------------------------------------------*/
532 * Sets the owner of a port
534 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
536 u32 __iomem *status_reg;
537 u32 port_status;
538 int try;
540 status_reg = &ehci->regs->port_status[portnum];
543 * The controller won't set the OWNER bit if the port is
544 * enabled, so this loop will sometimes require at least two
545 * iterations: one to disable the port and one to set OWNER.
547 for (try = 4; try > 0; --try) {
548 spin_lock_irq(&ehci->lock);
549 port_status = ehci_readl(ehci, status_reg);
550 if ((port_status & PORT_OWNER) == new_owner
551 || (port_status & (PORT_OWNER | PORT_CONNECT))
552 == 0)
553 try = 0;
554 else {
555 port_status ^= PORT_OWNER;
556 port_status &= ~(PORT_PE | PORT_RWC_BITS);
557 ehci_writel(ehci, port_status, status_reg);
559 spin_unlock_irq(&ehci->lock);
560 if (try > 1)
561 msleep(5);
565 /*-------------------------------------------------------------------------*/
567 static int check_reset_complete (
568 struct ehci_hcd *ehci,
569 int index,
570 u32 __iomem *status_reg,
571 int port_status
573 if (!(port_status & PORT_CONNECT))
574 return port_status;
576 /* if reset finished and it's still not enabled -- handoff */
577 if (!(port_status & PORT_PE)) {
579 /* with integrated TT, there's nobody to hand it to! */
580 if (ehci_is_TDI(ehci)) {
581 ehci_dbg (ehci,
582 "Failed to enable port %d on root hub TT\n",
583 index+1);
584 return port_status;
587 ehci_dbg (ehci, "port %d full speed --> companion\n",
588 index + 1);
590 // what happens if HCS_N_CC(params) == 0 ?
591 port_status |= PORT_OWNER;
592 port_status &= ~PORT_RWC_BITS;
593 ehci_writel(ehci, port_status, status_reg);
595 /* ensure 440EPX ohci controller state is operational */
596 if (ehci->has_amcc_usb23)
597 set_ohci_hcfs(ehci, 1);
598 } else {
599 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
600 index + 1);
601 /* ensure 440EPx ohci controller state is suspended */
602 if (ehci->has_amcc_usb23)
603 set_ohci_hcfs(ehci, 0);
606 return port_status;
609 /*-------------------------------------------------------------------------*/
612 /* build "status change" packet (one or two bytes) from HC registers */
614 static int
615 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
617 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
618 u32 temp, status;
619 u32 mask;
620 int ports, i, retval = 1;
621 unsigned long flags;
622 u32 ppcd = ~0;
624 /* init status to no-changes */
625 buf [0] = 0;
626 ports = HCS_N_PORTS (ehci->hcs_params);
627 if (ports > 7) {
628 buf [1] = 0;
629 retval++;
632 /* Inform the core about resumes-in-progress by returning
633 * a non-zero value even if there are no status changes.
635 status = ehci->resuming_ports;
637 /* Some boards (mostly VIA?) report bogus overcurrent indications,
638 * causing massive log spam unless we completely ignore them. It
639 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
640 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
641 * PORT_POWER; that's surprising, but maybe within-spec.
643 if (!ignore_oc)
644 mask = PORT_CSC | PORT_PEC | PORT_OCC;
645 else
646 mask = PORT_CSC | PORT_PEC;
647 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
649 /* no hub change reports (bit 0) for now (power, ...) */
651 /* port N changes (bit N)? */
652 spin_lock_irqsave (&ehci->lock, flags);
654 /* get per-port change detect bits */
655 if (ehci->has_ppcd)
656 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
658 for (i = 0; i < ports; i++) {
659 /* leverage per-port change bits feature */
660 if (ppcd & (1 << i))
661 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
662 else
663 temp = 0;
666 * Return status information even for ports with OWNER set.
667 * Otherwise hub_wq wouldn't see the disconnect event when a
668 * high-speed device is switched over to the companion
669 * controller by the user.
672 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
673 || (ehci->reset_done[i] && time_after_eq(
674 jiffies, ehci->reset_done[i]))) {
675 if (i < 7)
676 buf [0] |= 1 << (i + 1);
677 else
678 buf [1] |= 1 << (i - 7);
679 status = STS_PCD;
683 /* If a resume is in progress, make sure it can finish */
684 if (ehci->resuming_ports)
685 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(25));
687 spin_unlock_irqrestore (&ehci->lock, flags);
688 return status ? retval : 0;
691 /*-------------------------------------------------------------------------*/
693 static void
694 ehci_hub_descriptor (
695 struct ehci_hcd *ehci,
696 struct usb_hub_descriptor *desc
698 int ports = HCS_N_PORTS (ehci->hcs_params);
699 u16 temp;
701 desc->bDescriptorType = USB_DT_HUB;
702 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
703 desc->bHubContrCurrent = 0;
705 desc->bNbrPorts = ports;
706 temp = 1 + (ports / 8);
707 desc->bDescLength = 7 + 2 * temp;
709 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
710 memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
711 memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
713 temp = HUB_CHAR_INDV_PORT_OCPM; /* per-port overcurrent reporting */
714 if (HCS_PPC (ehci->hcs_params))
715 temp |= HUB_CHAR_INDV_PORT_LPSM; /* per-port power control */
716 else
717 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
718 #if 0
719 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
720 if (HCS_INDICATOR (ehci->hcs_params))
721 temp |= HUB_CHAR_PORTIND; /* per-port indicators (LEDs) */
722 #endif
723 desc->wHubCharacteristics = cpu_to_le16(temp);
726 /*-------------------------------------------------------------------------*/
727 #ifdef CONFIG_USB_HCD_TEST_MODE
729 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
731 static void usb_ehset_completion(struct urb *urb)
733 struct completion *done = urb->context;
735 complete(done);
737 static int submit_single_step_set_feature(
738 struct usb_hcd *hcd,
739 struct urb *urb,
740 int is_setup
744 * Allocate and initialize a control URB. This request will be used by the
745 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
746 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
747 * Return NULL if failed.
749 static struct urb *request_single_step_set_feature_urb(
750 struct usb_device *udev,
751 void *dr,
752 void *buf,
753 struct completion *done
755 struct urb *urb;
756 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
757 struct usb_host_endpoint *ep;
759 urb = usb_alloc_urb(0, GFP_KERNEL);
760 if (!urb)
761 return NULL;
763 urb->pipe = usb_rcvctrlpipe(udev, 0);
764 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
765 [usb_pipeendpoint(urb->pipe)];
766 if (!ep) {
767 usb_free_urb(urb);
768 return NULL;
771 urb->ep = ep;
772 urb->dev = udev;
773 urb->setup_packet = (void *)dr;
774 urb->transfer_buffer = buf;
775 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
776 urb->complete = usb_ehset_completion;
777 urb->status = -EINPROGRESS;
778 urb->actual_length = 0;
779 urb->transfer_flags = URB_DIR_IN;
780 usb_get_urb(urb);
781 atomic_inc(&urb->use_count);
782 atomic_inc(&urb->dev->urbnum);
783 urb->setup_dma = dma_map_single(
784 hcd->self.sysdev,
785 urb->setup_packet,
786 sizeof(struct usb_ctrlrequest),
787 DMA_TO_DEVICE);
788 urb->transfer_dma = dma_map_single(
789 hcd->self.sysdev,
790 urb->transfer_buffer,
791 urb->transfer_buffer_length,
792 DMA_FROM_DEVICE);
793 urb->context = done;
794 return urb;
797 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
799 int retval = -ENOMEM;
800 struct usb_ctrlrequest *dr;
801 struct urb *urb;
802 struct usb_device *udev;
803 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
804 struct usb_device_descriptor *buf;
805 DECLARE_COMPLETION_ONSTACK(done);
807 /* Obtain udev of the rhub's child port */
808 udev = usb_hub_find_child(hcd->self.root_hub, port);
809 if (!udev) {
810 ehci_err(ehci, "No device attached to the RootHub\n");
811 return -ENODEV;
813 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
814 if (!buf)
815 return -ENOMEM;
817 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
818 if (!dr) {
819 kfree(buf);
820 return -ENOMEM;
823 /* Fill Setup packet for GetDescriptor */
824 dr->bRequestType = USB_DIR_IN;
825 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
826 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
827 dr->wIndex = 0;
828 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
829 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
830 if (!urb)
831 goto cleanup;
833 /* Submit just the SETUP stage */
834 retval = submit_single_step_set_feature(hcd, urb, 1);
835 if (retval)
836 goto out1;
837 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
838 usb_kill_urb(urb);
839 retval = -ETIMEDOUT;
840 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
841 goto out1;
843 msleep(15 * 1000);
845 /* Complete remaining DATA and STATUS stages using the same URB */
846 urb->status = -EINPROGRESS;
847 usb_get_urb(urb);
848 atomic_inc(&urb->use_count);
849 atomic_inc(&urb->dev->urbnum);
850 retval = submit_single_step_set_feature(hcd, urb, 0);
851 if (!retval && !wait_for_completion_timeout(&done,
852 msecs_to_jiffies(2000))) {
853 usb_kill_urb(urb);
854 retval = -ETIMEDOUT;
855 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
857 out1:
858 usb_free_urb(urb);
859 cleanup:
860 kfree(dr);
861 kfree(buf);
862 return retval;
864 #endif /* CONFIG_USB_HCD_TEST_MODE */
865 /*-------------------------------------------------------------------------*/
867 int ehci_hub_control(
868 struct usb_hcd *hcd,
869 u16 typeReq,
870 u16 wValue,
871 u16 wIndex,
872 char *buf,
873 u16 wLength
875 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
876 int ports = HCS_N_PORTS (ehci->hcs_params);
877 u32 __iomem *status_reg, *hostpc_reg;
878 u32 temp, temp1, status;
879 unsigned long flags;
880 int retval = 0;
881 unsigned selector;
884 * Avoid underflow while calculating (wIndex & 0xff) - 1.
885 * The compiler might deduce that wIndex can never be 0 and then
886 * optimize away the tests for !wIndex below.
888 temp = wIndex & 0xff;
889 temp -= (temp > 0);
890 status_reg = &ehci->regs->port_status[temp];
891 hostpc_reg = &ehci->regs->hostpc[temp];
894 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
895 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
896 * (track current state ourselves) ... blink for diagnostics,
897 * power, "this is the one", etc. EHCI spec supports this.
900 spin_lock_irqsave (&ehci->lock, flags);
901 switch (typeReq) {
902 case ClearHubFeature:
903 switch (wValue) {
904 case C_HUB_LOCAL_POWER:
905 case C_HUB_OVER_CURRENT:
906 /* no hub-wide feature/status flags */
907 break;
908 default:
909 goto error;
911 break;
912 case ClearPortFeature:
913 if (!wIndex || wIndex > ports)
914 goto error;
915 wIndex--;
916 temp = ehci_readl(ehci, status_reg);
917 temp &= ~PORT_RWC_BITS;
920 * Even if OWNER is set, so the port is owned by the
921 * companion controller, hub_wq needs to be able to clear
922 * the port-change status bits (especially
923 * USB_PORT_STAT_C_CONNECTION).
926 switch (wValue) {
927 case USB_PORT_FEAT_ENABLE:
928 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
929 break;
930 case USB_PORT_FEAT_C_ENABLE:
931 ehci_writel(ehci, temp | PORT_PEC, status_reg);
932 break;
933 case USB_PORT_FEAT_SUSPEND:
934 if (temp & PORT_RESET)
935 goto error;
936 if (ehci->no_selective_suspend)
937 break;
938 #ifdef CONFIG_USB_OTG
939 if ((hcd->self.otg_port == (wIndex + 1))
940 && hcd->self.b_hnp_enable) {
941 otg_start_hnp(hcd->usb_phy->otg);
942 break;
944 #endif
945 if (!(temp & PORT_SUSPEND))
946 break;
947 if ((temp & PORT_PE) == 0)
948 goto error;
950 /* clear phy low-power mode before resume */
951 if (ehci->has_tdi_phy_lpm) {
952 temp1 = ehci_readl(ehci, hostpc_reg);
953 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
954 hostpc_reg);
955 spin_unlock_irqrestore(&ehci->lock, flags);
956 msleep(5);/* wait to leave low-power mode */
957 spin_lock_irqsave(&ehci->lock, flags);
959 /* resume signaling for 20 msec */
960 temp &= ~PORT_WAKE_BITS;
961 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
962 ehci->reset_done[wIndex] = jiffies
963 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
964 set_bit(wIndex, &ehci->resuming_ports);
965 usb_hcd_start_port_resume(&hcd->self, wIndex);
966 break;
967 case USB_PORT_FEAT_C_SUSPEND:
968 clear_bit(wIndex, &ehci->port_c_suspend);
969 break;
970 case USB_PORT_FEAT_POWER:
971 if (HCS_PPC(ehci->hcs_params)) {
972 spin_unlock_irqrestore(&ehci->lock, flags);
973 ehci_port_power(ehci, wIndex, false);
974 spin_lock_irqsave(&ehci->lock, flags);
976 break;
977 case USB_PORT_FEAT_C_CONNECTION:
978 ehci_writel(ehci, temp | PORT_CSC, status_reg);
979 break;
980 case USB_PORT_FEAT_C_OVER_CURRENT:
981 ehci_writel(ehci, temp | PORT_OCC, status_reg);
982 break;
983 case USB_PORT_FEAT_C_RESET:
984 /* GetPortStatus clears reset */
985 break;
986 default:
987 goto error;
989 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
990 break;
991 case GetHubDescriptor:
992 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
993 buf);
994 break;
995 case GetHubStatus:
996 /* no hub-wide feature/status flags */
997 memset (buf, 0, 4);
998 //cpu_to_le32s ((u32 *) buf);
999 break;
1000 case GetPortStatus:
1001 if (!wIndex || wIndex > ports)
1002 goto error;
1003 wIndex--;
1004 status = 0;
1005 temp = ehci_readl(ehci, status_reg);
1007 // wPortChange bits
1008 if (temp & PORT_CSC)
1009 status |= USB_PORT_STAT_C_CONNECTION << 16;
1010 if (temp & PORT_PEC)
1011 status |= USB_PORT_STAT_C_ENABLE << 16;
1013 if ((temp & PORT_OCC) && !ignore_oc){
1014 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1017 * Hubs should disable port power on over-current.
1018 * However, not all EHCI implementations do this
1019 * automatically, even if they _do_ support per-port
1020 * power switching; they're allowed to just limit the
1021 * current. hub_wq will turn the power back on.
1023 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
1024 && HCS_PPC(ehci->hcs_params)) {
1025 spin_unlock_irqrestore(&ehci->lock, flags);
1026 ehci_port_power(ehci, wIndex, false);
1027 spin_lock_irqsave(&ehci->lock, flags);
1028 temp = ehci_readl(ehci, status_reg);
1032 /* no reset or resume pending */
1033 if (!ehci->reset_done[wIndex]) {
1035 /* Remote Wakeup received? */
1036 if (temp & PORT_RESUME) {
1037 /* resume signaling for 20 msec */
1038 ehci->reset_done[wIndex] = jiffies
1039 + msecs_to_jiffies(20);
1040 usb_hcd_start_port_resume(&hcd->self, wIndex);
1041 set_bit(wIndex, &ehci->resuming_ports);
1042 /* check the port again */
1043 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1044 ehci->reset_done[wIndex]);
1047 /* reset or resume not yet complete */
1048 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
1049 ; /* wait until it is complete */
1051 /* resume completed */
1052 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
1053 clear_bit(wIndex, &ehci->suspended_ports);
1054 set_bit(wIndex, &ehci->port_c_suspend);
1055 ehci->reset_done[wIndex] = 0;
1056 usb_hcd_end_port_resume(&hcd->self, wIndex);
1058 /* stop resume signaling */
1059 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
1060 ehci_writel(ehci, temp, status_reg);
1061 clear_bit(wIndex, &ehci->resuming_ports);
1062 retval = ehci_handshake(ehci, status_reg,
1063 PORT_RESUME, 0, 2000 /* 2msec */);
1064 if (retval != 0) {
1065 ehci_err(ehci, "port %d resume error %d\n",
1066 wIndex + 1, retval);
1067 goto error;
1069 temp = ehci_readl(ehci, status_reg);
1071 /* whoever resets must GetPortStatus to complete it!! */
1072 } else {
1073 status |= USB_PORT_STAT_C_RESET << 16;
1074 ehci->reset_done [wIndex] = 0;
1076 /* force reset to complete */
1077 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1078 status_reg);
1079 /* REVISIT: some hardware needs 550+ usec to clear
1080 * this bit; seems too long to spin routinely...
1082 retval = ehci_handshake(ehci, status_reg,
1083 PORT_RESET, 0, 1000);
1084 if (retval != 0) {
1085 ehci_err (ehci, "port %d reset error %d\n",
1086 wIndex + 1, retval);
1087 goto error;
1090 /* see what we found out */
1091 temp = check_reset_complete (ehci, wIndex, status_reg,
1092 ehci_readl(ehci, status_reg));
1095 /* transfer dedicated ports to the companion hc */
1096 if ((temp & PORT_CONNECT) &&
1097 test_bit(wIndex, &ehci->companion_ports)) {
1098 temp &= ~PORT_RWC_BITS;
1099 temp |= PORT_OWNER;
1100 ehci_writel(ehci, temp, status_reg);
1101 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1102 temp = ehci_readl(ehci, status_reg);
1106 * Even if OWNER is set, there's no harm letting hub_wq
1107 * see the wPortStatus values (they should all be 0 except
1108 * for PORT_POWER anyway).
1111 if (temp & PORT_CONNECT) {
1112 status |= USB_PORT_STAT_CONNECTION;
1113 // status may be from integrated TT
1114 if (ehci->has_hostpc) {
1115 temp1 = ehci_readl(ehci, hostpc_reg);
1116 status |= ehci_port_speed(ehci, temp1);
1117 } else
1118 status |= ehci_port_speed(ehci, temp);
1120 if (temp & PORT_PE)
1121 status |= USB_PORT_STAT_ENABLE;
1123 /* maybe the port was unsuspended without our knowledge */
1124 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1125 status |= USB_PORT_STAT_SUSPEND;
1126 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1127 clear_bit(wIndex, &ehci->suspended_ports);
1128 clear_bit(wIndex, &ehci->resuming_ports);
1129 ehci->reset_done[wIndex] = 0;
1130 if (temp & PORT_PE)
1131 set_bit(wIndex, &ehci->port_c_suspend);
1132 usb_hcd_end_port_resume(&hcd->self, wIndex);
1135 if (temp & PORT_OC)
1136 status |= USB_PORT_STAT_OVERCURRENT;
1137 if (temp & PORT_RESET)
1138 status |= USB_PORT_STAT_RESET;
1139 if (temp & PORT_POWER)
1140 status |= USB_PORT_STAT_POWER;
1141 if (test_bit(wIndex, &ehci->port_c_suspend))
1142 status |= USB_PORT_STAT_C_SUSPEND << 16;
1144 if (status & ~0xffff) /* only if wPortChange is interesting */
1145 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1146 put_unaligned_le32(status, buf);
1147 break;
1148 case SetHubFeature:
1149 switch (wValue) {
1150 case C_HUB_LOCAL_POWER:
1151 case C_HUB_OVER_CURRENT:
1152 /* no hub-wide feature/status flags */
1153 break;
1154 default:
1155 goto error;
1157 break;
1158 case SetPortFeature:
1159 selector = wIndex >> 8;
1160 wIndex &= 0xff;
1161 if (unlikely(ehci->debug)) {
1162 /* If the debug port is active any port
1163 * feature requests should get denied */
1164 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1165 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1166 retval = -ENODEV;
1167 goto error_exit;
1170 if (!wIndex || wIndex > ports)
1171 goto error;
1172 wIndex--;
1173 temp = ehci_readl(ehci, status_reg);
1174 if (temp & PORT_OWNER)
1175 break;
1177 temp &= ~PORT_RWC_BITS;
1178 switch (wValue) {
1179 case USB_PORT_FEAT_SUSPEND:
1180 if (ehci->no_selective_suspend)
1181 break;
1182 if ((temp & PORT_PE) == 0
1183 || (temp & PORT_RESET) != 0)
1184 goto error;
1186 /* After above check the port must be connected.
1187 * Set appropriate bit thus could put phy into low power
1188 * mode if we have tdi_phy_lpm feature
1190 temp &= ~PORT_WKCONN_E;
1191 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1192 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1193 if (ehci->has_tdi_phy_lpm) {
1194 spin_unlock_irqrestore(&ehci->lock, flags);
1195 msleep(5);/* 5ms for HCD enter low pwr mode */
1196 spin_lock_irqsave(&ehci->lock, flags);
1197 temp1 = ehci_readl(ehci, hostpc_reg);
1198 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1199 hostpc_reg);
1200 temp1 = ehci_readl(ehci, hostpc_reg);
1201 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1202 wIndex, (temp1 & HOSTPC_PHCD) ?
1203 "succeeded" : "failed");
1205 if (ehci_has_fsl_susp_errata(ehci)) {
1206 /* 10ms for HCD enter suspend */
1207 spin_unlock_irqrestore(&ehci->lock, flags);
1208 usleep_range(10000, 20000);
1209 spin_lock_irqsave(&ehci->lock, flags);
1211 set_bit(wIndex, &ehci->suspended_ports);
1212 break;
1213 case USB_PORT_FEAT_POWER:
1214 if (HCS_PPC(ehci->hcs_params)) {
1215 spin_unlock_irqrestore(&ehci->lock, flags);
1216 ehci_port_power(ehci, wIndex, true);
1217 spin_lock_irqsave(&ehci->lock, flags);
1219 break;
1220 case USB_PORT_FEAT_RESET:
1221 if (temp & (PORT_SUSPEND|PORT_RESUME))
1222 goto error;
1223 /* line status bits may report this as low speed,
1224 * which can be fine if this root hub has a
1225 * transaction translator built in.
1227 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1228 && !ehci_is_TDI(ehci)
1229 && PORT_USB11 (temp)) {
1230 ehci_dbg (ehci,
1231 "port %d low speed --> companion\n",
1232 wIndex + 1);
1233 temp |= PORT_OWNER;
1234 } else {
1235 temp |= PORT_RESET;
1236 temp &= ~PORT_PE;
1239 * caller must wait, then call GetPortStatus
1240 * usb 2.0 spec says 50 ms resets on root
1242 ehci->reset_done [wIndex] = jiffies
1243 + msecs_to_jiffies (50);
1246 * Force full-speed connect for FSL high-speed
1247 * erratum; disable HS Chirp by setting PFSC bit
1249 if (ehci_has_fsl_hs_errata(ehci))
1250 temp |= (1 << PORTSC_FSL_PFSC);
1252 ehci_writel(ehci, temp, status_reg);
1253 break;
1255 /* For downstream facing ports (these): one hub port is put
1256 * into test mode according to USB2 11.24.2.13, then the hub
1257 * must be reset (which for root hub now means rmmod+modprobe,
1258 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1259 * about the EHCI-specific stuff.
1261 case USB_PORT_FEAT_TEST:
1262 #ifdef CONFIG_USB_HCD_TEST_MODE
1263 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1264 spin_unlock_irqrestore(&ehci->lock, flags);
1265 retval = ehset_single_step_set_feature(hcd,
1266 wIndex + 1);
1267 spin_lock_irqsave(&ehci->lock, flags);
1268 break;
1270 #endif
1271 if (!selector || selector > 5)
1272 goto error;
1273 spin_unlock_irqrestore(&ehci->lock, flags);
1274 ehci_quiesce(ehci);
1275 spin_lock_irqsave(&ehci->lock, flags);
1277 /* Put all enabled ports into suspend */
1278 while (ports--) {
1279 u32 __iomem *sreg =
1280 &ehci->regs->port_status[ports];
1282 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1283 if (temp & PORT_PE)
1284 ehci_writel(ehci, temp | PORT_SUSPEND,
1285 sreg);
1288 spin_unlock_irqrestore(&ehci->lock, flags);
1289 ehci_halt(ehci);
1290 spin_lock_irqsave(&ehci->lock, flags);
1292 temp = ehci_readl(ehci, status_reg);
1293 temp |= selector << 16;
1294 ehci_writel(ehci, temp, status_reg);
1295 break;
1297 default:
1298 goto error;
1300 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1301 break;
1303 default:
1304 error:
1305 /* "stall" on error */
1306 retval = -EPIPE;
1308 error_exit:
1309 spin_unlock_irqrestore (&ehci->lock, flags);
1310 return retval;
1312 EXPORT_SYMBOL_GPL(ehci_hub_control);
1314 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1316 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1318 if (ehci_is_TDI(ehci))
1319 return;
1320 set_owner(ehci, --portnum, PORT_OWNER);
1323 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1325 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1326 u32 __iomem *reg;
1328 if (ehci_is_TDI(ehci))
1329 return 0;
1330 reg = &ehci->regs->port_status[portnum - 1];
1331 return ehci_readl(ehci, reg) & PORT_OWNER;
1334 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1336 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1337 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1338 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1340 if (enable)
1341 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1342 else
1343 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1345 if (hcd->driver->port_power)
1346 hcd->driver->port_power(hcd, portnum, enable);
1348 return 0;