2 * Copyright (C) 2001-2004 by David Brownell
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 /* this file is part of ehci-hcd.c */
21 /*-------------------------------------------------------------------------*/
24 * EHCI Root Hub ... the nonsharable stuff
26 * Registers don't need cpu_to_le32, that happens transparently
29 /*-------------------------------------------------------------------------*/
30 #include <linux/usb/otg.h>
32 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
36 static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
38 static int persist_enabled_on_companion(struct usb_device *udev, void *unused)
40 return !udev->maxchild && udev->persist_enabled &&
41 udev->bus->root_hub->speed < USB_SPEED_HIGH;
44 /* After a power loss, ports that were owned by the companion must be
45 * reset so that the companion can still own them.
47 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
53 struct usb_hcd *hcd = ehci_to_hcd(ehci);
55 if (!ehci->owned_ports)
59 * USB 1.1 devices are mostly HIDs, which don't need to persist across
60 * suspends. If we ensure that none of our companion's devices have
61 * persist_enabled (by looking through all USB 1.1 buses in the system),
62 * we can skip this and avoid slowing resume down. Devices without
63 * persist will just get reenumerated shortly after resume anyway.
65 if (!usb_for_each_dev(NULL, persist_enabled_on_companion))
68 /* Make sure the ports are powered */
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;
74 if (!(status & PORT_POWER))
75 ehci_port_power(ehci, port, true);
79 /* Give the connections some time to appear */
82 spin_lock_irq(&ehci->lock);
83 port = HCS_N_PORTS(ehci->hcs_params);
85 if (test_bit(port, &ehci->owned_ports)) {
86 reg = &ehci->regs->port_status[port];
87 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
89 /* Port already owned by companion? */
90 if (status & PORT_OWNER)
91 clear_bit(port, &ehci->owned_ports);
92 else if (test_bit(port, &ehci->companion_ports))
93 ehci_writel(ehci, status & ~PORT_PE, reg);
95 spin_unlock_irq(&ehci->lock);
96 ehci_hub_control(hcd, SetPortFeature,
97 USB_PORT_FEAT_RESET, port + 1,
99 spin_lock_irq(&ehci->lock);
103 spin_unlock_irq(&ehci->lock);
105 if (!ehci->owned_ports)
107 msleep(90); /* Wait for resets to complete */
109 spin_lock_irq(&ehci->lock);
110 port = HCS_N_PORTS(ehci->hcs_params);
112 if (test_bit(port, &ehci->owned_ports)) {
113 spin_unlock_irq(&ehci->lock);
114 ehci_hub_control(hcd, GetPortStatus,
116 (char *) &buf, sizeof(buf));
117 spin_lock_irq(&ehci->lock);
119 /* The companion should now own the port,
120 * but if something went wrong the port must not
123 reg = &ehci->regs->port_status[port];
124 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
125 if (status & PORT_OWNER)
126 ehci_writel(ehci, status | PORT_CSC, reg);
128 ehci_dbg(ehci, "failed handover port %d: %x\n",
130 ehci_writel(ehci, status & ~PORT_PE, reg);
135 ehci->owned_ports = 0;
136 spin_unlock_irq(&ehci->lock);
139 static int ehci_port_change(struct ehci_hcd *ehci)
141 int i = HCS_N_PORTS(ehci->hcs_params);
143 /* First check if the controller indicates a change event */
145 if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
149 * Not all controllers appear to update this while going from D3 to D0,
150 * so check the individual port status registers as well
154 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
160 void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
161 bool suspending, bool do_wakeup)
166 /* If remote wakeup is enabled for the root hub but disabled
167 * for the controller, we must adjust all the port wakeup flags
168 * when the controller is suspended or resumed. In all other
169 * cases they don't need to be changed.
171 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
174 spin_lock_irq(&ehci->lock);
176 /* clear phy low-power mode before changing wakeup flags */
177 if (ehci->has_tdi_phy_lpm) {
178 port = HCS_N_PORTS(ehci->hcs_params);
180 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
182 temp = ehci_readl(ehci, hostpc_reg);
183 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
185 spin_unlock_irq(&ehci->lock);
187 spin_lock_irq(&ehci->lock);
190 port = HCS_N_PORTS(ehci->hcs_params);
192 u32 __iomem *reg = &ehci->regs->port_status[port];
193 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
194 u32 t2 = t1 & ~PORT_WAKE_BITS;
196 /* If we are suspending the controller, clear the flags.
197 * If we are resuming the controller, set the wakeup flags.
200 if (t1 & PORT_CONNECT)
201 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
203 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
205 ehci_writel(ehci, t2, reg);
208 /* enter phy low-power mode again */
209 if (ehci->has_tdi_phy_lpm) {
210 port = HCS_N_PORTS(ehci->hcs_params);
212 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
214 temp = ehci_readl(ehci, hostpc_reg);
215 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
219 /* Does the root hub have a port wakeup pending? */
220 if (!suspending && ehci_port_change(ehci))
221 usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
223 spin_unlock_irq(&ehci->lock);
225 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags);
227 static int ehci_bus_suspend (struct usb_hcd *hcd)
229 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
235 ehci_dbg(ehci, "suspend root hub\n");
237 if (time_before (jiffies, ehci->next_statechange))
240 /* stop the schedules */
243 spin_lock_irq (&ehci->lock);
244 if (ehci->rh_state < EHCI_RH_RUNNING)
247 /* Once the controller is stopped, port resumes that are already
248 * in progress won't complete. Hence if remote wakeup is enabled
249 * for the root hub and any ports are in the middle of a resume or
250 * remote wakeup, we must fail the suspend.
252 if (hcd->self.root_hub->do_remote_wakeup) {
253 if (ehci->resuming_ports) {
254 spin_unlock_irq(&ehci->lock);
255 ehci_dbg(ehci, "suspend failed because a port is resuming\n");
260 /* Unlike other USB host controller types, EHCI doesn't have
261 * any notion of "global" or bus-wide suspend. The driver has
262 * to manually suspend all the active unsuspended ports, and
263 * then manually resume them in the bus_resume() routine.
265 ehci->bus_suspended = 0;
266 ehci->owned_ports = 0;
268 fs_idle_delay = false;
269 port = HCS_N_PORTS(ehci->hcs_params);
271 u32 __iomem *reg = &ehci->regs->port_status [port];
272 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
273 u32 t2 = t1 & ~PORT_WAKE_BITS;
275 /* keep track of which ports we suspend */
277 set_bit(port, &ehci->owned_ports);
278 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
280 set_bit(port, &ehci->bus_suspended);
283 /* enable remote wakeup on all ports, if told to do so */
284 if (hcd->self.root_hub->do_remote_wakeup) {
285 /* only enable appropriate wake bits, otherwise the
286 * hardware can not go phy low power mode. If a race
287 * condition happens here(connection change during bits
288 * set), the port change detection will finally fix it.
290 if (t1 & PORT_CONNECT)
291 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
293 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
298 * On some controllers, Wake-On-Disconnect will
299 * generate false wakeup signals until the bus
300 * switches over to full-speed idle. For their
301 * sake, add a delay if we need one.
303 if ((t2 & PORT_WKDISC_E) &&
304 ehci_port_speed(ehci, t2) ==
305 USB_PORT_STAT_HIGH_SPEED)
306 fs_idle_delay = true;
307 ehci_writel(ehci, t2, reg);
311 spin_unlock_irq(&ehci->lock);
313 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
315 * Wait for HCD to enter low-power mode or for the bus
316 * to switch to full-speed idle.
318 usleep_range(5000, 5500);
321 if (changed && ehci->has_tdi_phy_lpm) {
322 spin_lock_irq(&ehci->lock);
323 port = HCS_N_PORTS(ehci->hcs_params);
325 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
328 t3 = ehci_readl(ehci, hostpc_reg);
329 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
330 t3 = ehci_readl(ehci, hostpc_reg);
331 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
332 port, (t3 & HOSTPC_PHCD) ?
333 "succeeded" : "failed");
335 spin_unlock_irq(&ehci->lock);
338 /* Apparently some devices need a >= 1-uframe delay here */
339 if (ehci->bus_suspended)
342 /* turn off now-idle HC */
345 spin_lock_irq(&ehci->lock);
346 if (ehci->enabled_hrtimer_events & BIT(EHCI_HRTIMER_POLL_DEAD))
347 ehci_handle_controller_death(ehci);
348 if (ehci->rh_state != EHCI_RH_RUNNING)
350 ehci->rh_state = EHCI_RH_SUSPENDED;
352 unlink_empty_async_suspended(ehci);
354 /* Any IAA cycle that started before the suspend is now invalid */
356 ehci_handle_start_intr_unlinks(ehci);
357 ehci_handle_intr_unlinks(ehci);
360 /* allow remote wakeup */
362 if (!hcd->self.root_hub->do_remote_wakeup)
364 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
365 ehci_readl(ehci, &ehci->regs->intr_enable);
368 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
369 ehci->enabled_hrtimer_events = 0;
370 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
371 spin_unlock_irq (&ehci->lock);
373 hrtimer_cancel(&ehci->hrtimer);
378 /* caller has locked the root hub, and should reset/reinit on error */
379 static int ehci_bus_resume (struct usb_hcd *hcd)
381 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
385 unsigned long resume_needed = 0;
387 if (time_before (jiffies, ehci->next_statechange))
389 spin_lock_irq (&ehci->lock);
390 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
393 if (unlikely(ehci->debug)) {
394 if (!dbgp_reset_prep(hcd))
397 dbgp_external_startup(hcd);
400 /* Ideally and we've got a real resume here, and no port's power
401 * was lost. (For PCI, that means Vaux was maintained.) But we
402 * could instead be restoring a swsusp snapshot -- so that BIOS was
403 * the last user of the controller, not reset/pm hardware keeping
404 * state we gave to it.
406 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
407 ehci_dbg(ehci, "resume root hub%s\n",
408 power_okay ? "" : " after power loss");
410 /* at least some APM implementations will try to deliver
411 * IRQs right away, so delay them until we're ready.
413 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
415 /* re-init operational registers */
416 ehci_writel(ehci, 0, &ehci->regs->segment);
417 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
418 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
420 /* restore CMD_RUN, framelist size, and irq threshold */
421 ehci->command |= CMD_RUN;
422 ehci_writel(ehci, ehci->command, &ehci->regs->command);
423 ehci->rh_state = EHCI_RH_RUNNING;
426 * According to Bugzilla #8190, the port status for some controllers
427 * will be wrong without a delay. At their wrong status, the port
428 * is enabled, but not suspended neither resumed.
430 i = HCS_N_PORTS(ehci->hcs_params);
432 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
433 if ((temp & PORT_PE) &&
434 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
435 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
436 spin_unlock_irq(&ehci->lock);
438 spin_lock_irq(&ehci->lock);
446 /* clear phy low-power mode before resume */
447 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
448 i = HCS_N_PORTS(ehci->hcs_params);
450 if (test_bit(i, &ehci->bus_suspended)) {
451 u32 __iomem *hostpc_reg =
452 &ehci->regs->hostpc[i];
454 temp = ehci_readl(ehci, hostpc_reg);
455 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
459 spin_unlock_irq(&ehci->lock);
461 spin_lock_irq(&ehci->lock);
466 /* manually resume the ports we suspended during bus_suspend() */
467 i = HCS_N_PORTS (ehci->hcs_params);
469 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
470 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
471 if (test_bit(i, &ehci->bus_suspended) &&
472 (temp & PORT_SUSPEND)) {
474 set_bit(i, &resume_needed);
476 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
480 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
484 spin_unlock_irq(&ehci->lock);
485 msleep(USB_RESUME_TIMEOUT);
486 spin_lock_irq(&ehci->lock);
491 i = HCS_N_PORTS (ehci->hcs_params);
493 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
494 if (test_bit(i, &resume_needed)) {
495 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
496 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
500 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
501 spin_unlock_irq(&ehci->lock);
503 ehci_handover_companion_ports(ehci);
505 /* Now we can safely re-enable irqs */
506 spin_lock_irq(&ehci->lock);
509 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
510 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
511 spin_unlock_irq(&ehci->lock);
516 spin_unlock_irq(&ehci->lock);
522 #define ehci_bus_suspend NULL
523 #define ehci_bus_resume NULL
525 #endif /* CONFIG_PM */
527 /*-------------------------------------------------------------------------*/
530 * Sets the owner of a port
532 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
534 u32 __iomem *status_reg;
538 status_reg = &ehci->regs->port_status[portnum];
541 * The controller won't set the OWNER bit if the port is
542 * enabled, so this loop will sometimes require at least two
543 * iterations: one to disable the port and one to set OWNER.
545 for (try = 4; try > 0; --try) {
546 spin_lock_irq(&ehci->lock);
547 port_status = ehci_readl(ehci, status_reg);
548 if ((port_status & PORT_OWNER) == new_owner
549 || (port_status & (PORT_OWNER | PORT_CONNECT))
553 port_status ^= PORT_OWNER;
554 port_status &= ~(PORT_PE | PORT_RWC_BITS);
555 ehci_writel(ehci, port_status, status_reg);
557 spin_unlock_irq(&ehci->lock);
563 /*-------------------------------------------------------------------------*/
565 static int check_reset_complete (
566 struct ehci_hcd *ehci,
568 u32 __iomem *status_reg,
571 if (!(port_status & PORT_CONNECT))
574 /* if reset finished and it's still not enabled -- handoff */
575 if (!(port_status & PORT_PE)) {
577 /* with integrated TT, there's nobody to hand it to! */
578 if (ehci_is_TDI(ehci)) {
580 "Failed to enable port %d on root hub TT\n",
585 ehci_dbg (ehci, "port %d full speed --> companion\n",
588 // what happens if HCS_N_CC(params) == 0 ?
589 port_status |= PORT_OWNER;
590 port_status &= ~PORT_RWC_BITS;
591 ehci_writel(ehci, port_status, status_reg);
593 /* ensure 440EPX ohci controller state is operational */
594 if (ehci->has_amcc_usb23)
595 set_ohci_hcfs(ehci, 1);
597 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
599 /* ensure 440EPx ohci controller state is suspended */
600 if (ehci->has_amcc_usb23)
601 set_ohci_hcfs(ehci, 0);
607 /*-------------------------------------------------------------------------*/
610 /* build "status change" packet (one or two bytes) from HC registers */
613 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
615 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
618 int ports, i, retval = 1;
622 /* init status to no-changes */
624 ports = HCS_N_PORTS (ehci->hcs_params);
630 /* Inform the core about resumes-in-progress by returning
631 * a non-zero value even if there are no status changes.
633 status = ehci->resuming_ports;
635 /* Some boards (mostly VIA?) report bogus overcurrent indications,
636 * causing massive log spam unless we completely ignore them. It
637 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
638 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
639 * PORT_POWER; that's surprising, but maybe within-spec.
642 mask = PORT_CSC | PORT_PEC | PORT_OCC;
644 mask = PORT_CSC | PORT_PEC;
645 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
647 /* no hub change reports (bit 0) for now (power, ...) */
649 /* port N changes (bit N)? */
650 spin_lock_irqsave (&ehci->lock, flags);
652 /* get per-port change detect bits */
654 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
656 for (i = 0; i < ports; i++) {
657 /* leverage per-port change bits feature */
659 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
664 * Return status information even for ports with OWNER set.
665 * Otherwise hub_wq wouldn't see the disconnect event when a
666 * high-speed device is switched over to the companion
667 * controller by the user.
670 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
671 || (ehci->reset_done[i] && time_after_eq(
672 jiffies, ehci->reset_done[i]))) {
674 buf [0] |= 1 << (i + 1);
676 buf [1] |= 1 << (i - 7);
681 /* If a resume is in progress, make sure it can finish */
682 if (ehci->resuming_ports)
683 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(25));
685 spin_unlock_irqrestore (&ehci->lock, flags);
686 return status ? retval : 0;
689 /*-------------------------------------------------------------------------*/
692 ehci_hub_descriptor (
693 struct ehci_hcd *ehci,
694 struct usb_hub_descriptor *desc
696 int ports = HCS_N_PORTS (ehci->hcs_params);
699 desc->bDescriptorType = USB_DT_HUB;
700 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
701 desc->bHubContrCurrent = 0;
703 desc->bNbrPorts = ports;
704 temp = 1 + (ports / 8);
705 desc->bDescLength = 7 + 2 * temp;
707 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
708 memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
709 memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
711 temp = HUB_CHAR_INDV_PORT_OCPM; /* per-port overcurrent reporting */
712 if (HCS_PPC (ehci->hcs_params))
713 temp |= HUB_CHAR_INDV_PORT_LPSM; /* per-port power control */
715 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
717 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
718 if (HCS_INDICATOR (ehci->hcs_params))
719 temp |= HUB_CHAR_PORTIND; /* per-port indicators (LEDs) */
721 desc->wHubCharacteristics = cpu_to_le16(temp);
724 /*-------------------------------------------------------------------------*/
725 #ifdef CONFIG_USB_HCD_TEST_MODE
727 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
729 static void usb_ehset_completion(struct urb *urb)
731 struct completion *done = urb->context;
735 static int submit_single_step_set_feature(
742 * Allocate and initialize a control URB. This request will be used by the
743 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
744 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
745 * Return NULL if failed.
747 static struct urb *request_single_step_set_feature_urb(
748 struct usb_device *udev,
751 struct completion *done
754 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
755 struct usb_host_endpoint *ep;
757 urb = usb_alloc_urb(0, GFP_KERNEL);
761 urb->pipe = usb_rcvctrlpipe(udev, 0);
762 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
763 [usb_pipeendpoint(urb->pipe)];
771 urb->setup_packet = (void *)dr;
772 urb->transfer_buffer = buf;
773 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
774 urb->complete = usb_ehset_completion;
775 urb->status = -EINPROGRESS;
776 urb->actual_length = 0;
777 urb->transfer_flags = URB_DIR_IN;
779 atomic_inc(&urb->use_count);
780 atomic_inc(&urb->dev->urbnum);
781 urb->setup_dma = dma_map_single(
782 hcd->self.controller,
784 sizeof(struct usb_ctrlrequest),
786 urb->transfer_dma = dma_map_single(
787 hcd->self.controller,
788 urb->transfer_buffer,
789 urb->transfer_buffer_length,
795 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
797 int retval = -ENOMEM;
798 struct usb_ctrlrequest *dr;
800 struct usb_device *udev;
801 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
802 struct usb_device_descriptor *buf;
803 DECLARE_COMPLETION_ONSTACK(done);
805 /* Obtain udev of the rhub's child port */
806 udev = usb_hub_find_child(hcd->self.root_hub, port);
808 ehci_err(ehci, "No device attached to the RootHub\n");
811 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
815 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
821 /* Fill Setup packet for GetDescriptor */
822 dr->bRequestType = USB_DIR_IN;
823 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
824 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
826 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
827 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
831 /* Submit just the SETUP stage */
832 retval = submit_single_step_set_feature(hcd, urb, 1);
835 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
838 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
843 /* Complete remaining DATA and STATUS stages using the same URB */
844 urb->status = -EINPROGRESS;
846 atomic_inc(&urb->use_count);
847 atomic_inc(&urb->dev->urbnum);
848 retval = submit_single_step_set_feature(hcd, urb, 0);
849 if (!retval && !wait_for_completion_timeout(&done,
850 msecs_to_jiffies(2000))) {
853 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
862 #endif /* CONFIG_USB_HCD_TEST_MODE */
863 /*-------------------------------------------------------------------------*/
865 int ehci_hub_control(
873 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
874 int ports = HCS_N_PORTS (ehci->hcs_params);
875 u32 __iomem *status_reg, *hostpc_reg;
876 u32 temp, temp1, status;
882 * Avoid underflow while calculating (wIndex & 0xff) - 1.
883 * The compiler might deduce that wIndex can never be 0 and then
884 * optimize away the tests for !wIndex below.
886 temp = wIndex & 0xff;
888 status_reg = &ehci->regs->port_status[temp];
889 hostpc_reg = &ehci->regs->hostpc[temp];
892 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
893 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
894 * (track current state ourselves) ... blink for diagnostics,
895 * power, "this is the one", etc. EHCI spec supports this.
898 spin_lock_irqsave (&ehci->lock, flags);
900 case ClearHubFeature:
902 case C_HUB_LOCAL_POWER:
903 case C_HUB_OVER_CURRENT:
904 /* no hub-wide feature/status flags */
910 case ClearPortFeature:
911 if (!wIndex || wIndex > ports)
914 temp = ehci_readl(ehci, status_reg);
915 temp &= ~PORT_RWC_BITS;
918 * Even if OWNER is set, so the port is owned by the
919 * companion controller, hub_wq needs to be able to clear
920 * the port-change status bits (especially
921 * USB_PORT_STAT_C_CONNECTION).
925 case USB_PORT_FEAT_ENABLE:
926 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
928 case USB_PORT_FEAT_C_ENABLE:
929 ehci_writel(ehci, temp | PORT_PEC, status_reg);
931 case USB_PORT_FEAT_SUSPEND:
932 if (temp & PORT_RESET)
934 if (ehci->no_selective_suspend)
936 #ifdef CONFIG_USB_OTG
937 if ((hcd->self.otg_port == (wIndex + 1))
938 && hcd->self.b_hnp_enable) {
939 otg_start_hnp(hcd->usb_phy->otg);
943 if (!(temp & PORT_SUSPEND))
945 if ((temp & PORT_PE) == 0)
948 /* clear phy low-power mode before resume */
949 if (ehci->has_tdi_phy_lpm) {
950 temp1 = ehci_readl(ehci, hostpc_reg);
951 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
953 spin_unlock_irqrestore(&ehci->lock, flags);
954 msleep(5);/* wait to leave low-power mode */
955 spin_lock_irqsave(&ehci->lock, flags);
957 /* resume signaling for 20 msec */
958 temp &= ~PORT_WAKE_BITS;
959 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
960 ehci->reset_done[wIndex] = jiffies
961 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
962 set_bit(wIndex, &ehci->resuming_ports);
963 usb_hcd_start_port_resume(&hcd->self, wIndex);
965 case USB_PORT_FEAT_C_SUSPEND:
966 clear_bit(wIndex, &ehci->port_c_suspend);
968 case USB_PORT_FEAT_POWER:
969 if (HCS_PPC(ehci->hcs_params)) {
970 spin_unlock_irqrestore(&ehci->lock, flags);
971 ehci_port_power(ehci, wIndex, false);
972 spin_lock_irqsave(&ehci->lock, flags);
975 case USB_PORT_FEAT_C_CONNECTION:
976 ehci_writel(ehci, temp | PORT_CSC, status_reg);
978 case USB_PORT_FEAT_C_OVER_CURRENT:
979 ehci_writel(ehci, temp | PORT_OCC, status_reg);
981 case USB_PORT_FEAT_C_RESET:
982 /* GetPortStatus clears reset */
987 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
989 case GetHubDescriptor:
990 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
994 /* no hub-wide feature/status flags */
996 //cpu_to_le32s ((u32 *) buf);
999 if (!wIndex || wIndex > ports)
1003 temp = ehci_readl(ehci, status_reg);
1006 if (temp & PORT_CSC)
1007 status |= USB_PORT_STAT_C_CONNECTION << 16;
1008 if (temp & PORT_PEC)
1009 status |= USB_PORT_STAT_C_ENABLE << 16;
1011 if ((temp & PORT_OCC) && !ignore_oc){
1012 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1015 * Hubs should disable port power on over-current.
1016 * However, not all EHCI implementations do this
1017 * automatically, even if they _do_ support per-port
1018 * power switching; they're allowed to just limit the
1019 * current. hub_wq will turn the power back on.
1021 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
1022 && HCS_PPC(ehci->hcs_params)) {
1023 spin_unlock_irqrestore(&ehci->lock, flags);
1024 ehci_port_power(ehci, wIndex, false);
1025 spin_lock_irqsave(&ehci->lock, flags);
1026 temp = ehci_readl(ehci, status_reg);
1030 /* no reset or resume pending */
1031 if (!ehci->reset_done[wIndex]) {
1033 /* Remote Wakeup received? */
1034 if (temp & PORT_RESUME) {
1035 /* resume signaling for 20 msec */
1036 ehci->reset_done[wIndex] = jiffies
1037 + msecs_to_jiffies(20);
1038 usb_hcd_start_port_resume(&hcd->self, wIndex);
1039 set_bit(wIndex, &ehci->resuming_ports);
1040 /* check the port again */
1041 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1042 ehci->reset_done[wIndex]);
1045 /* reset or resume not yet complete */
1046 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
1047 ; /* wait until it is complete */
1049 /* resume completed */
1050 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
1051 clear_bit(wIndex, &ehci->suspended_ports);
1052 set_bit(wIndex, &ehci->port_c_suspend);
1053 ehci->reset_done[wIndex] = 0;
1054 usb_hcd_end_port_resume(&hcd->self, wIndex);
1056 /* stop resume signaling */
1057 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
1058 ehci_writel(ehci, temp, status_reg);
1059 clear_bit(wIndex, &ehci->resuming_ports);
1060 retval = ehci_handshake(ehci, status_reg,
1061 PORT_RESUME, 0, 2000 /* 2msec */);
1063 ehci_err(ehci, "port %d resume error %d\n",
1064 wIndex + 1, retval);
1067 temp = ehci_readl(ehci, status_reg);
1069 /* whoever resets must GetPortStatus to complete it!! */
1071 status |= USB_PORT_STAT_C_RESET << 16;
1072 ehci->reset_done [wIndex] = 0;
1074 /* force reset to complete */
1075 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1077 /* REVISIT: some hardware needs 550+ usec to clear
1078 * this bit; seems too long to spin routinely...
1080 retval = ehci_handshake(ehci, status_reg,
1081 PORT_RESET, 0, 1000);
1083 ehci_err (ehci, "port %d reset error %d\n",
1084 wIndex + 1, retval);
1088 /* see what we found out */
1089 temp = check_reset_complete (ehci, wIndex, status_reg,
1090 ehci_readl(ehci, status_reg));
1093 /* transfer dedicated ports to the companion hc */
1094 if ((temp & PORT_CONNECT) &&
1095 test_bit(wIndex, &ehci->companion_ports)) {
1096 temp &= ~PORT_RWC_BITS;
1098 ehci_writel(ehci, temp, status_reg);
1099 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1100 temp = ehci_readl(ehci, status_reg);
1104 * Even if OWNER is set, there's no harm letting hub_wq
1105 * see the wPortStatus values (they should all be 0 except
1106 * for PORT_POWER anyway).
1109 if (temp & PORT_CONNECT) {
1110 status |= USB_PORT_STAT_CONNECTION;
1111 // status may be from integrated TT
1112 if (ehci->has_hostpc) {
1113 temp1 = ehci_readl(ehci, hostpc_reg);
1114 status |= ehci_port_speed(ehci, temp1);
1116 status |= ehci_port_speed(ehci, temp);
1119 status |= USB_PORT_STAT_ENABLE;
1121 /* maybe the port was unsuspended without our knowledge */
1122 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1123 status |= USB_PORT_STAT_SUSPEND;
1124 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1125 clear_bit(wIndex, &ehci->suspended_ports);
1126 clear_bit(wIndex, &ehci->resuming_ports);
1127 ehci->reset_done[wIndex] = 0;
1129 set_bit(wIndex, &ehci->port_c_suspend);
1130 usb_hcd_end_port_resume(&hcd->self, wIndex);
1134 status |= USB_PORT_STAT_OVERCURRENT;
1135 if (temp & PORT_RESET)
1136 status |= USB_PORT_STAT_RESET;
1137 if (temp & PORT_POWER)
1138 status |= USB_PORT_STAT_POWER;
1139 if (test_bit(wIndex, &ehci->port_c_suspend))
1140 status |= USB_PORT_STAT_C_SUSPEND << 16;
1142 if (status & ~0xffff) /* only if wPortChange is interesting */
1143 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1144 put_unaligned_le32(status, buf);
1148 case C_HUB_LOCAL_POWER:
1149 case C_HUB_OVER_CURRENT:
1150 /* no hub-wide feature/status flags */
1156 case SetPortFeature:
1157 selector = wIndex >> 8;
1159 if (unlikely(ehci->debug)) {
1160 /* If the debug port is active any port
1161 * feature requests should get denied */
1162 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1163 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1168 if (!wIndex || wIndex > ports)
1171 temp = ehci_readl(ehci, status_reg);
1172 if (temp & PORT_OWNER)
1175 temp &= ~PORT_RWC_BITS;
1177 case USB_PORT_FEAT_SUSPEND:
1178 if (ehci->no_selective_suspend)
1180 if ((temp & PORT_PE) == 0
1181 || (temp & PORT_RESET) != 0)
1184 /* After above check the port must be connected.
1185 * Set appropriate bit thus could put phy into low power
1186 * mode if we have tdi_phy_lpm feature
1188 temp &= ~PORT_WKCONN_E;
1189 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1190 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1191 if (ehci->has_tdi_phy_lpm) {
1192 spin_unlock_irqrestore(&ehci->lock, flags);
1193 msleep(5);/* 5ms for HCD enter low pwr mode */
1194 spin_lock_irqsave(&ehci->lock, flags);
1195 temp1 = ehci_readl(ehci, hostpc_reg);
1196 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1198 temp1 = ehci_readl(ehci, hostpc_reg);
1199 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1200 wIndex, (temp1 & HOSTPC_PHCD) ?
1201 "succeeded" : "failed");
1203 set_bit(wIndex, &ehci->suspended_ports);
1205 case USB_PORT_FEAT_POWER:
1206 if (HCS_PPC(ehci->hcs_params)) {
1207 spin_unlock_irqrestore(&ehci->lock, flags);
1208 ehci_port_power(ehci, wIndex, true);
1209 spin_lock_irqsave(&ehci->lock, flags);
1212 case USB_PORT_FEAT_RESET:
1213 if (temp & (PORT_SUSPEND|PORT_RESUME))
1215 /* line status bits may report this as low speed,
1216 * which can be fine if this root hub has a
1217 * transaction translator built in.
1219 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1220 && !ehci_is_TDI(ehci)
1221 && PORT_USB11 (temp)) {
1223 "port %d low speed --> companion\n",
1231 * caller must wait, then call GetPortStatus
1232 * usb 2.0 spec says 50 ms resets on root
1234 ehci->reset_done [wIndex] = jiffies
1235 + msecs_to_jiffies (50);
1238 * Force full-speed connect for FSL high-speed
1239 * erratum; disable HS Chirp by setting PFSC bit
1241 if (ehci_has_fsl_hs_errata(ehci))
1242 temp |= (1 << PORTSC_FSL_PFSC);
1244 ehci_writel(ehci, temp, status_reg);
1247 /* For downstream facing ports (these): one hub port is put
1248 * into test mode according to USB2 11.24.2.13, then the hub
1249 * must be reset (which for root hub now means rmmod+modprobe,
1250 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1251 * about the EHCI-specific stuff.
1253 case USB_PORT_FEAT_TEST:
1254 #ifdef CONFIG_USB_HCD_TEST_MODE
1255 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1256 spin_unlock_irqrestore(&ehci->lock, flags);
1257 retval = ehset_single_step_set_feature(hcd,
1259 spin_lock_irqsave(&ehci->lock, flags);
1263 if (!selector || selector > 5)
1265 spin_unlock_irqrestore(&ehci->lock, flags);
1267 spin_lock_irqsave(&ehci->lock, flags);
1269 /* Put all enabled ports into suspend */
1272 &ehci->regs->port_status[ports];
1274 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1276 ehci_writel(ehci, temp | PORT_SUSPEND,
1280 spin_unlock_irqrestore(&ehci->lock, flags);
1282 spin_lock_irqsave(&ehci->lock, flags);
1284 temp = ehci_readl(ehci, status_reg);
1285 temp |= selector << 16;
1286 ehci_writel(ehci, temp, status_reg);
1292 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1297 /* "stall" on error */
1301 spin_unlock_irqrestore (&ehci->lock, flags);
1304 EXPORT_SYMBOL_GPL(ehci_hub_control);
1306 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1308 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1310 if (ehci_is_TDI(ehci))
1312 set_owner(ehci, --portnum, PORT_OWNER);
1315 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1317 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1320 if (ehci_is_TDI(ehci))
1322 reg = &ehci->regs->port_status[portnum - 1];
1323 return ehci_readl(ehci, reg) & PORT_OWNER;
1326 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1328 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1329 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1330 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1333 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1335 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1337 if (hcd->driver->port_power)
1338 hcd->driver->port_power(hcd, portnum, enable);