1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2001-2004 by David Brownell
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)
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)
39 struct usb_hcd *hcd = ehci_to_hcd(ehci);
41 if (!ehci->owned_ports)
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))
54 /* Make sure the ports are powered */
55 port = HCS_N_PORTS(ehci->hcs_params);
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 */
68 spin_lock_irq(&ehci->lock);
69 port = HCS_N_PORTS(ehci->hcs_params);
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);
81 spin_unlock_irq(&ehci->lock);
82 ehci_hub_control(hcd, SetPortFeature,
83 USB_PORT_FEAT_RESET, port + 1,
85 spin_lock_irq(&ehci->lock);
89 spin_unlock_irq(&ehci->lock);
91 if (!ehci->owned_ports)
93 msleep(90); /* Wait for resets to complete */
95 spin_lock_irq(&ehci->lock);
96 port = HCS_N_PORTS(ehci->hcs_params);
98 if (test_bit(port, &ehci->owned_ports)) {
99 spin_unlock_irq(&ehci->lock);
100 ehci_hub_control(hcd, GetPortStatus,
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
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);
114 ehci_dbg(ehci, "failed handover port %d: %x\n",
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)
135 * Not all controllers appear to update this while going from D3 to D0,
136 * so check the individual port status registers as well
140 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
146 void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
147 bool suspending, bool do_wakeup)
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)
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);
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);
173 spin_lock_irq(&ehci->lock);
176 port = HCS_N_PORTS(ehci->hcs_params);
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.
186 if (t1 & PORT_CONNECT)
187 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
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);
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);
221 ehci_dbg(ehci, "suspend root hub\n");
223 if (time_before (jiffies, ehci->next_statechange))
226 /* stop the schedules */
229 spin_lock_irq (&ehci->lock);
230 if (ehci->rh_state < EHCI_RH_RUNNING)
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");
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;
254 fs_idle_delay = false;
255 port = HCS_N_PORTS(ehci->hcs_params);
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 */
263 set_bit(port, &ehci->owned_ports);
264 else if ((t1 & PORT_PE) && !(t1 & 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;
279 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
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);
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);
319 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
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)
336 /* turn off now-idle HC */
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)
344 ehci->rh_state = EHCI_RH_SUSPENDED;
346 unlink_empty_async_suspended(ehci);
348 /* Some Synopsys controllers mistakenly leave IAA turned on */
349 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
351 /* Any IAA cycle that started before the suspend is now invalid */
353 ehci_handle_start_intr_unlinks(ehci);
354 ehci_handle_intr_unlinks(ehci);
357 /* allow remote wakeup */
359 if (!hcd->self.root_hub->do_remote_wakeup)
361 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
362 ehci_readl(ehci, &ehci->regs->intr_enable);
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);
370 hrtimer_cancel(&ehci->hrtimer);
375 /* caller has locked the root hub, and should reset/reinit on error */
376 static int ehci_bus_resume (struct usb_hcd *hcd)
378 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
382 unsigned long resume_needed = 0;
384 if (time_before (jiffies, ehci->next_statechange))
386 spin_lock_irq (&ehci->lock);
387 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
390 if (unlikely(ehci->debug)) {
391 if (!dbgp_reset_prep(hcd))
394 dbgp_external_startup(hcd);
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.
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");
407 /* at least some APM implementations will try to deliver
408 * IRQs right away, so delay them until we're ready.
410 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
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);
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;
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.
427 i = HCS_N_PORTS(ehci->hcs_params);
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);
435 spin_lock_irq(&ehci->lock);
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);
447 if (test_bit(i, &ehci->bus_suspended)) {
448 u32 __iomem *hostpc_reg =
449 &ehci->regs->hostpc[i];
451 temp = ehci_readl(ehci, hostpc_reg);
452 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
456 spin_unlock_irq(&ehci->lock);
458 spin_lock_irq(&ehci->lock);
463 /* manually resume the ports we suspended during bus_suspend() */
464 i = HCS_N_PORTS (ehci->hcs_params);
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)) {
471 set_bit(i, &resume_needed);
473 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
477 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
481 spin_unlock_irq(&ehci->lock);
482 msleep(USB_RESUME_TIMEOUT);
483 spin_lock_irq(&ehci->lock);
488 i = HCS_N_PORTS (ehci->hcs_params);
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]);
497 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
498 spin_unlock_irq(&ehci->lock);
500 ehci_handover_companion_ports(ehci);
502 /* Now we can safely re-enable irqs */
503 spin_lock_irq(&ehci->lock);
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);
513 spin_unlock_irq(&ehci->lock);
517 static unsigned long ehci_get_resuming_ports(struct usb_hcd *hcd)
519 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
521 return ehci->resuming_ports;
526 #define ehci_bus_suspend NULL
527 #define ehci_bus_resume NULL
528 #define ehci_get_resuming_ports NULL
530 #endif /* CONFIG_PM */
532 /*-------------------------------------------------------------------------*/
535 * Sets the owner of a port
537 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
539 u32 __iomem *status_reg;
543 status_reg = &ehci->regs->port_status[portnum];
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.
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))
558 port_status ^= PORT_OWNER;
559 port_status &= ~(PORT_PE | PORT_RWC_BITS);
560 ehci_writel(ehci, port_status, status_reg);
562 spin_unlock_irq(&ehci->lock);
568 /*-------------------------------------------------------------------------*/
570 static int check_reset_complete (
571 struct ehci_hcd *ehci,
573 u32 __iomem *status_reg,
576 if (!(port_status & PORT_CONNECT))
579 /* if reset finished and it's still not enabled -- handoff */
580 if (!(port_status & PORT_PE)) {
582 /* with integrated TT, there's nobody to hand it to! */
583 if (ehci_is_TDI(ehci)) {
585 "Failed to enable port %d on root hub TT\n",
590 ehci_dbg (ehci, "port %d full speed --> companion\n",
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);
598 /* ensure 440EPX ohci controller state is operational */
599 if (ehci->has_amcc_usb23)
600 set_ohci_hcfs(ehci, 1);
602 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
604 /* ensure 440EPx ohci controller state is suspended */
605 if (ehci->has_amcc_usb23)
606 set_ohci_hcfs(ehci, 0);
612 /*-------------------------------------------------------------------------*/
615 /* build "status change" packet (one or two bytes) from HC registers */
618 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
620 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
623 int ports, i, retval = 1;
627 /* init status to no-changes */
629 ports = HCS_N_PORTS (ehci->hcs_params);
635 /* Inform the core about resumes-in-progress by returning
636 * a non-zero value even if there are no status changes.
638 status = ehci->resuming_ports;
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.
646 if (!ignore_oc && !ehci->spurious_oc)
647 mask = PORT_CSC | PORT_PEC | PORT_OCC;
649 mask = PORT_CSC | PORT_PEC;
650 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
652 /* no hub change reports (bit 0) for now (power, ...) */
654 /* port N changes (bit N)? */
655 spin_lock_irqsave (&ehci->lock, flags);
657 /* get per-port change detect bits */
659 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
661 for (i = 0; i < ports; i++) {
662 /* leverage per-port change bits feature */
664 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
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.
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]))) {
679 buf [0] |= 1 << (i + 1);
681 buf [1] |= 1 << (i - 7);
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));
690 spin_unlock_irqrestore (&ehci->lock, flags);
691 return status ? retval : 0;
694 /*-------------------------------------------------------------------------*/
697 ehci_hub_descriptor (
698 struct ehci_hcd *ehci,
699 struct usb_hub_descriptor *desc
701 int ports = HCS_N_PORTS (ehci->hcs_params);
704 desc->bDescriptorType = USB_DT_HUB;
705 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
706 desc->bHubContrCurrent = 0;
708 desc->bNbrPorts = ports;
709 temp = 1 + (ports / 8);
710 desc->bDescLength = 7 + 2 * temp;
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);
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 */
720 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
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) */
726 desc->wHubCharacteristics = cpu_to_le16(temp);
729 /*-------------------------------------------------------------------------*/
730 #ifdef CONFIG_USB_HCD_TEST_MODE
732 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
734 static void usb_ehset_completion(struct urb *urb)
736 struct completion *done = urb->context;
740 static int submit_single_step_set_feature(
747 * Allocate and initialize a control URB. This request will be used by the
748 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
749 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
750 * Return NULL if failed.
752 static struct urb *request_single_step_set_feature_urb(
753 struct usb_device *udev,
756 struct completion *done
759 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
760 struct usb_host_endpoint *ep;
762 urb = usb_alloc_urb(0, GFP_KERNEL);
766 urb->pipe = usb_rcvctrlpipe(udev, 0);
767 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
768 [usb_pipeendpoint(urb->pipe)];
776 urb->setup_packet = (void *)dr;
777 urb->transfer_buffer = buf;
778 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
779 urb->complete = usb_ehset_completion;
780 urb->status = -EINPROGRESS;
781 urb->actual_length = 0;
782 urb->transfer_flags = URB_DIR_IN;
784 atomic_inc(&urb->use_count);
785 atomic_inc(&urb->dev->urbnum);
786 urb->setup_dma = dma_map_single(
789 sizeof(struct usb_ctrlrequest),
791 urb->transfer_dma = dma_map_single(
793 urb->transfer_buffer,
794 urb->transfer_buffer_length,
800 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
802 int retval = -ENOMEM;
803 struct usb_ctrlrequest *dr;
805 struct usb_device *udev;
806 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
807 struct usb_device_descriptor *buf;
808 DECLARE_COMPLETION_ONSTACK(done);
810 /* Obtain udev of the rhub's child port */
811 udev = usb_hub_find_child(hcd->self.root_hub, port);
813 ehci_err(ehci, "No device attached to the RootHub\n");
816 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
820 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
826 /* Fill Setup packet for GetDescriptor */
827 dr->bRequestType = USB_DIR_IN;
828 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
829 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
831 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
832 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
836 /* Submit just the SETUP stage */
837 retval = submit_single_step_set_feature(hcd, urb, 1);
840 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
843 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
848 /* Complete remaining DATA and STATUS stages using the same URB */
849 urb->status = -EINPROGRESS;
851 atomic_inc(&urb->use_count);
852 atomic_inc(&urb->dev->urbnum);
853 retval = submit_single_step_set_feature(hcd, urb, 0);
854 if (!retval && !wait_for_completion_timeout(&done,
855 msecs_to_jiffies(2000))) {
858 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
867 #endif /* CONFIG_USB_HCD_TEST_MODE */
868 /*-------------------------------------------------------------------------*/
870 int ehci_hub_control(
878 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
879 int ports = HCS_N_PORTS (ehci->hcs_params);
880 u32 __iomem *status_reg, *hostpc_reg;
881 u32 temp, temp1, status;
887 * Avoid underflow while calculating (wIndex & 0xff) - 1.
888 * The compiler might deduce that wIndex can never be 0 and then
889 * optimize away the tests for !wIndex below.
891 temp = wIndex & 0xff;
893 status_reg = &ehci->regs->port_status[temp];
894 hostpc_reg = &ehci->regs->hostpc[temp];
897 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
898 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
899 * (track current state ourselves) ... blink for diagnostics,
900 * power, "this is the one", etc. EHCI spec supports this.
903 spin_lock_irqsave (&ehci->lock, flags);
905 case ClearHubFeature:
907 case C_HUB_LOCAL_POWER:
908 case C_HUB_OVER_CURRENT:
909 /* no hub-wide feature/status flags */
915 case ClearPortFeature:
916 if (!wIndex || wIndex > ports)
919 temp = ehci_readl(ehci, status_reg);
920 temp &= ~PORT_RWC_BITS;
923 * Even if OWNER is set, so the port is owned by the
924 * companion controller, hub_wq needs to be able to clear
925 * the port-change status bits (especially
926 * USB_PORT_STAT_C_CONNECTION).
930 case USB_PORT_FEAT_ENABLE:
931 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
933 case USB_PORT_FEAT_C_ENABLE:
934 ehci_writel(ehci, temp | PORT_PEC, status_reg);
936 case USB_PORT_FEAT_SUSPEND:
937 if (temp & PORT_RESET)
939 if (ehci->no_selective_suspend)
941 #ifdef CONFIG_USB_OTG
942 if ((hcd->self.otg_port == (wIndex + 1))
943 && hcd->self.b_hnp_enable) {
944 otg_start_hnp(hcd->usb_phy->otg);
948 if (!(temp & PORT_SUSPEND))
950 if ((temp & PORT_PE) == 0)
953 /* clear phy low-power mode before resume */
954 if (ehci->has_tdi_phy_lpm) {
955 temp1 = ehci_readl(ehci, hostpc_reg);
956 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
958 spin_unlock_irqrestore(&ehci->lock, flags);
959 msleep(5);/* wait to leave low-power mode */
960 spin_lock_irqsave(&ehci->lock, flags);
962 /* resume signaling for 20 msec */
963 temp &= ~PORT_WAKE_BITS;
964 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
965 ehci->reset_done[wIndex] = jiffies
966 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
967 set_bit(wIndex, &ehci->resuming_ports);
968 usb_hcd_start_port_resume(&hcd->self, wIndex);
970 case USB_PORT_FEAT_C_SUSPEND:
971 clear_bit(wIndex, &ehci->port_c_suspend);
973 case USB_PORT_FEAT_POWER:
974 if (HCS_PPC(ehci->hcs_params)) {
975 spin_unlock_irqrestore(&ehci->lock, flags);
976 ehci_port_power(ehci, wIndex, false);
977 spin_lock_irqsave(&ehci->lock, flags);
980 case USB_PORT_FEAT_C_CONNECTION:
981 ehci_writel(ehci, temp | PORT_CSC, status_reg);
983 case USB_PORT_FEAT_C_OVER_CURRENT:
984 ehci_writel(ehci, temp | PORT_OCC, status_reg);
986 case USB_PORT_FEAT_C_RESET:
987 /* GetPortStatus clears reset */
992 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
994 case GetHubDescriptor:
995 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
999 /* no hub-wide feature/status flags */
1001 //cpu_to_le32s ((u32 *) buf);
1004 if (!wIndex || wIndex > ports)
1008 temp = ehci_readl(ehci, status_reg);
1011 if (temp & PORT_CSC)
1012 status |= USB_PORT_STAT_C_CONNECTION << 16;
1013 if (temp & PORT_PEC)
1014 status |= USB_PORT_STAT_C_ENABLE << 16;
1016 if ((temp & PORT_OCC) && (!ignore_oc && !ehci->spurious_oc)){
1017 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1020 * Hubs should disable port power on over-current.
1021 * However, not all EHCI implementations do this
1022 * automatically, even if they _do_ support per-port
1023 * power switching; they're allowed to just limit the
1024 * current. hub_wq will turn the power back on.
1026 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
1027 && HCS_PPC(ehci->hcs_params)) {
1028 spin_unlock_irqrestore(&ehci->lock, flags);
1029 ehci_port_power(ehci, wIndex, false);
1030 spin_lock_irqsave(&ehci->lock, flags);
1031 temp = ehci_readl(ehci, status_reg);
1035 /* no reset or resume pending */
1036 if (!ehci->reset_done[wIndex]) {
1038 /* Remote Wakeup received? */
1039 if (temp & PORT_RESUME) {
1040 /* resume signaling for 20 msec */
1041 ehci->reset_done[wIndex] = jiffies
1042 + msecs_to_jiffies(20);
1043 usb_hcd_start_port_resume(&hcd->self, wIndex);
1044 set_bit(wIndex, &ehci->resuming_ports);
1045 /* check the port again */
1046 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1047 ehci->reset_done[wIndex]);
1050 /* reset or resume not yet complete */
1051 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
1052 ; /* wait until it is complete */
1054 /* resume completed */
1055 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
1056 clear_bit(wIndex, &ehci->suspended_ports);
1057 set_bit(wIndex, &ehci->port_c_suspend);
1058 ehci->reset_done[wIndex] = 0;
1059 usb_hcd_end_port_resume(&hcd->self, wIndex);
1061 /* stop resume signaling */
1062 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
1063 ehci_writel(ehci, temp, status_reg);
1064 clear_bit(wIndex, &ehci->resuming_ports);
1065 retval = ehci_handshake(ehci, status_reg,
1066 PORT_RESUME, 0, 2000 /* 2msec */);
1068 ehci_err(ehci, "port %d resume error %d\n",
1069 wIndex + 1, retval);
1072 temp = ehci_readl(ehci, status_reg);
1074 /* whoever resets must GetPortStatus to complete it!! */
1076 status |= USB_PORT_STAT_C_RESET << 16;
1077 ehci->reset_done [wIndex] = 0;
1079 /* force reset to complete */
1080 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1082 /* REVISIT: some hardware needs 550+ usec to clear
1083 * this bit; seems too long to spin routinely...
1085 retval = ehci_handshake(ehci, status_reg,
1086 PORT_RESET, 0, 1000);
1088 ehci_err (ehci, "port %d reset error %d\n",
1089 wIndex + 1, retval);
1093 /* see what we found out */
1094 temp = check_reset_complete (ehci, wIndex, status_reg,
1095 ehci_readl(ehci, status_reg));
1098 /* transfer dedicated ports to the companion hc */
1099 if ((temp & PORT_CONNECT) &&
1100 test_bit(wIndex, &ehci->companion_ports)) {
1101 temp &= ~PORT_RWC_BITS;
1103 ehci_writel(ehci, temp, status_reg);
1104 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1105 temp = ehci_readl(ehci, status_reg);
1109 * Even if OWNER is set, there's no harm letting hub_wq
1110 * see the wPortStatus values (they should all be 0 except
1111 * for PORT_POWER anyway).
1114 if (temp & PORT_CONNECT) {
1115 status |= USB_PORT_STAT_CONNECTION;
1116 // status may be from integrated TT
1117 if (ehci->has_hostpc) {
1118 temp1 = ehci_readl(ehci, hostpc_reg);
1119 status |= ehci_port_speed(ehci, temp1);
1121 status |= ehci_port_speed(ehci, temp);
1124 status |= USB_PORT_STAT_ENABLE;
1126 /* maybe the port was unsuspended without our knowledge */
1127 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1128 status |= USB_PORT_STAT_SUSPEND;
1129 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1130 clear_bit(wIndex, &ehci->suspended_ports);
1131 clear_bit(wIndex, &ehci->resuming_ports);
1132 ehci->reset_done[wIndex] = 0;
1134 set_bit(wIndex, &ehci->port_c_suspend);
1135 usb_hcd_end_port_resume(&hcd->self, wIndex);
1139 status |= USB_PORT_STAT_OVERCURRENT;
1140 if (temp & PORT_RESET)
1141 status |= USB_PORT_STAT_RESET;
1142 if (temp & PORT_POWER)
1143 status |= USB_PORT_STAT_POWER;
1144 if (test_bit(wIndex, &ehci->port_c_suspend))
1145 status |= USB_PORT_STAT_C_SUSPEND << 16;
1147 if (status & ~0xffff) /* only if wPortChange is interesting */
1148 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1149 put_unaligned_le32(status, buf);
1153 case C_HUB_LOCAL_POWER:
1154 case C_HUB_OVER_CURRENT:
1155 /* no hub-wide feature/status flags */
1161 case SetPortFeature:
1162 selector = wIndex >> 8;
1164 if (unlikely(ehci->debug)) {
1165 /* If the debug port is active any port
1166 * feature requests should get denied */
1167 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1168 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1173 if (!wIndex || wIndex > ports)
1176 temp = ehci_readl(ehci, status_reg);
1177 if (temp & PORT_OWNER)
1180 temp &= ~PORT_RWC_BITS;
1182 case USB_PORT_FEAT_SUSPEND:
1183 if (ehci->no_selective_suspend)
1185 if ((temp & PORT_PE) == 0
1186 || (temp & PORT_RESET) != 0)
1189 /* After above check the port must be connected.
1190 * Set appropriate bit thus could put phy into low power
1191 * mode if we have tdi_phy_lpm feature
1193 temp &= ~PORT_WKCONN_E;
1194 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1195 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1196 if (ehci->has_tdi_phy_lpm) {
1197 spin_unlock_irqrestore(&ehci->lock, flags);
1198 msleep(5);/* 5ms for HCD enter low pwr mode */
1199 spin_lock_irqsave(&ehci->lock, flags);
1200 temp1 = ehci_readl(ehci, hostpc_reg);
1201 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1203 temp1 = ehci_readl(ehci, hostpc_reg);
1204 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1205 wIndex, (temp1 & HOSTPC_PHCD) ?
1206 "succeeded" : "failed");
1208 if (ehci_has_fsl_susp_errata(ehci)) {
1209 /* 10ms for HCD enter suspend */
1210 spin_unlock_irqrestore(&ehci->lock, flags);
1211 usleep_range(10000, 20000);
1212 spin_lock_irqsave(&ehci->lock, flags);
1214 set_bit(wIndex, &ehci->suspended_ports);
1216 case USB_PORT_FEAT_POWER:
1217 if (HCS_PPC(ehci->hcs_params)) {
1218 spin_unlock_irqrestore(&ehci->lock, flags);
1219 ehci_port_power(ehci, wIndex, true);
1220 spin_lock_irqsave(&ehci->lock, flags);
1223 case USB_PORT_FEAT_RESET:
1224 if (temp & (PORT_SUSPEND|PORT_RESUME))
1226 /* line status bits may report this as low speed,
1227 * which can be fine if this root hub has a
1228 * transaction translator built in.
1230 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1231 && !ehci_is_TDI(ehci)
1232 && PORT_USB11 (temp)) {
1234 "port %d low speed --> companion\n",
1242 * caller must wait, then call GetPortStatus
1243 * usb 2.0 spec says 50 ms resets on root
1245 ehci->reset_done [wIndex] = jiffies
1246 + msecs_to_jiffies (50);
1249 * Force full-speed connect for FSL high-speed
1250 * erratum; disable HS Chirp by setting PFSC bit
1252 if (ehci_has_fsl_hs_errata(ehci))
1253 temp |= (1 << PORTSC_FSL_PFSC);
1255 ehci_writel(ehci, temp, status_reg);
1258 /* For downstream facing ports (these): one hub port is put
1259 * into test mode according to USB2 11.24.2.13, then the hub
1260 * must be reset (which for root hub now means rmmod+modprobe,
1261 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1262 * about the EHCI-specific stuff.
1264 case USB_PORT_FEAT_TEST:
1265 #ifdef CONFIG_USB_HCD_TEST_MODE
1266 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1267 spin_unlock_irqrestore(&ehci->lock, flags);
1268 retval = ehset_single_step_set_feature(hcd,
1270 spin_lock_irqsave(&ehci->lock, flags);
1274 if (!selector || selector > 5)
1276 spin_unlock_irqrestore(&ehci->lock, flags);
1278 spin_lock_irqsave(&ehci->lock, flags);
1280 /* Put all enabled ports into suspend */
1283 &ehci->regs->port_status[ports];
1285 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1287 ehci_writel(ehci, temp | PORT_SUSPEND,
1291 spin_unlock_irqrestore(&ehci->lock, flags);
1293 spin_lock_irqsave(&ehci->lock, flags);
1295 temp = ehci_readl(ehci, status_reg);
1296 temp |= selector << 16;
1297 ehci_writel(ehci, temp, status_reg);
1303 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1308 /* "stall" on error */
1312 spin_unlock_irqrestore (&ehci->lock, flags);
1315 EXPORT_SYMBOL_GPL(ehci_hub_control);
1317 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1319 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1321 if (ehci_is_TDI(ehci))
1323 set_owner(ehci, --portnum, PORT_OWNER);
1326 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1328 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1331 if (ehci_is_TDI(ehci))
1333 reg = &ehci->regs->port_status[portnum - 1];
1334 return ehci_readl(ehci, reg) & PORT_OWNER;
1337 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1339 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1340 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1341 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1344 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1346 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1348 if (hcd->driver->port_power)
1349 hcd->driver->port_power(hcd, portnum, enable);