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 /*-------------------------------------------------------------------------*/
31 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
35 static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
37 static int persist_enabled_on_companion(struct usb_device *udev, void *unused)
39 return !udev->maxchild && udev->persist_enabled &&
40 udev->bus->root_hub->speed < USB_SPEED_HIGH;
43 /* After a power loss, ports that were owned by the companion must be
44 * reset so that the companion can still own them.
46 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
52 struct usb_hcd *hcd = ehci_to_hcd(ehci);
54 if (!ehci->owned_ports)
58 * USB 1.1 devices are mostly HIDs, which don't need to persist across
59 * suspends. If we ensure that none of our companion's devices have
60 * persist_enabled (by looking through all USB 1.1 buses in the system),
61 * we can skip this and avoid slowing resume down. Devices without
62 * persist will just get reenumerated shortly after resume anyway.
64 if (!usb_for_each_dev(NULL, persist_enabled_on_companion))
67 /* Make sure the ports are powered */
68 port = HCS_N_PORTS(ehci->hcs_params);
70 if (test_bit(port, &ehci->owned_ports)) {
71 reg = &ehci->regs->port_status[port];
72 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
73 if (!(status & PORT_POWER))
74 ehci_port_power(ehci, port, true);
78 /* Give the connections some time to appear */
81 spin_lock_irq(&ehci->lock);
82 port = HCS_N_PORTS(ehci->hcs_params);
84 if (test_bit(port, &ehci->owned_ports)) {
85 reg = &ehci->regs->port_status[port];
86 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
88 /* Port already owned by companion? */
89 if (status & PORT_OWNER)
90 clear_bit(port, &ehci->owned_ports);
91 else if (test_bit(port, &ehci->companion_ports))
92 ehci_writel(ehci, status & ~PORT_PE, reg);
94 spin_unlock_irq(&ehci->lock);
95 ehci_hub_control(hcd, SetPortFeature,
96 USB_PORT_FEAT_RESET, port + 1,
98 spin_lock_irq(&ehci->lock);
102 spin_unlock_irq(&ehci->lock);
104 if (!ehci->owned_ports)
106 msleep(90); /* Wait for resets to complete */
108 spin_lock_irq(&ehci->lock);
109 port = HCS_N_PORTS(ehci->hcs_params);
111 if (test_bit(port, &ehci->owned_ports)) {
112 spin_unlock_irq(&ehci->lock);
113 ehci_hub_control(hcd, GetPortStatus,
115 (char *) &buf, sizeof(buf));
116 spin_lock_irq(&ehci->lock);
118 /* The companion should now own the port,
119 * but if something went wrong the port must not
122 reg = &ehci->regs->port_status[port];
123 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
124 if (status & PORT_OWNER)
125 ehci_writel(ehci, status | PORT_CSC, reg);
127 ehci_dbg(ehci, "failed handover port %d: %x\n",
129 ehci_writel(ehci, status & ~PORT_PE, reg);
134 ehci->owned_ports = 0;
135 spin_unlock_irq(&ehci->lock);
138 static int ehci_port_change(struct ehci_hcd *ehci)
140 int i = HCS_N_PORTS(ehci->hcs_params);
142 /* First check if the controller indicates a change event */
144 if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
148 * Not all controllers appear to update this while going from D3 to D0,
149 * so check the individual port status registers as well
153 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
159 void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
160 bool suspending, bool do_wakeup)
165 /* If remote wakeup is enabled for the root hub but disabled
166 * for the controller, we must adjust all the port wakeup flags
167 * when the controller is suspended or resumed. In all other
168 * cases they don't need to be changed.
170 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
173 spin_lock_irq(&ehci->lock);
175 /* clear phy low-power mode before changing wakeup flags */
176 if (ehci->has_tdi_phy_lpm) {
177 port = HCS_N_PORTS(ehci->hcs_params);
179 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
181 temp = ehci_readl(ehci, hostpc_reg);
182 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
184 spin_unlock_irq(&ehci->lock);
186 spin_lock_irq(&ehci->lock);
189 port = HCS_N_PORTS(ehci->hcs_params);
191 u32 __iomem *reg = &ehci->regs->port_status[port];
192 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
193 u32 t2 = t1 & ~PORT_WAKE_BITS;
195 /* If we are suspending the controller, clear the flags.
196 * If we are resuming the controller, set the wakeup flags.
199 if (t1 & PORT_CONNECT)
200 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
202 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
204 ehci_writel(ehci, t2, reg);
207 /* enter phy low-power mode again */
208 if (ehci->has_tdi_phy_lpm) {
209 port = HCS_N_PORTS(ehci->hcs_params);
211 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
213 temp = ehci_readl(ehci, hostpc_reg);
214 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
218 /* Does the root hub have a port wakeup pending? */
219 if (!suspending && ehci_port_change(ehci))
220 usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
222 spin_unlock_irq(&ehci->lock);
224 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags);
226 static int ehci_bus_suspend (struct usb_hcd *hcd)
228 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
234 ehci_dbg(ehci, "suspend root hub\n");
236 if (time_before (jiffies, ehci->next_statechange))
239 /* stop the schedules */
242 spin_lock_irq (&ehci->lock);
243 if (ehci->rh_state < EHCI_RH_RUNNING)
246 /* Once the controller is stopped, port resumes that are already
247 * in progress won't complete. Hence if remote wakeup is enabled
248 * for the root hub and any ports are in the middle of a resume or
249 * remote wakeup, we must fail the suspend.
251 if (hcd->self.root_hub->do_remote_wakeup) {
252 if (ehci->resuming_ports) {
253 spin_unlock_irq(&ehci->lock);
254 ehci_dbg(ehci, "suspend failed because a port is resuming\n");
259 /* Unlike other USB host controller types, EHCI doesn't have
260 * any notion of "global" or bus-wide suspend. The driver has
261 * to manually suspend all the active unsuspended ports, and
262 * then manually resume them in the bus_resume() routine.
264 ehci->bus_suspended = 0;
265 ehci->owned_ports = 0;
267 fs_idle_delay = false;
268 port = HCS_N_PORTS(ehci->hcs_params);
270 u32 __iomem *reg = &ehci->regs->port_status [port];
271 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
272 u32 t2 = t1 & ~PORT_WAKE_BITS;
274 /* keep track of which ports we suspend */
276 set_bit(port, &ehci->owned_ports);
277 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
279 set_bit(port, &ehci->bus_suspended);
282 /* enable remote wakeup on all ports, if told to do so */
283 if (hcd->self.root_hub->do_remote_wakeup) {
284 /* only enable appropriate wake bits, otherwise the
285 * hardware can not go phy low power mode. If a race
286 * condition happens here(connection change during bits
287 * set), the port change detection will finally fix it.
289 if (t1 & PORT_CONNECT)
290 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
292 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
297 * On some controllers, Wake-On-Disconnect will
298 * generate false wakeup signals until the bus
299 * switches over to full-speed idle. For their
300 * sake, add a delay if we need one.
302 if ((t2 & PORT_WKDISC_E) &&
303 ehci_port_speed(ehci, t2) ==
304 USB_PORT_STAT_HIGH_SPEED)
305 fs_idle_delay = true;
306 ehci_writel(ehci, t2, reg);
310 spin_unlock_irq(&ehci->lock);
312 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
314 * Wait for HCD to enter low-power mode or for the bus
315 * to switch to full-speed idle.
317 usleep_range(5000, 5500);
320 if (changed && ehci->has_tdi_phy_lpm) {
321 spin_lock_irq(&ehci->lock);
322 port = HCS_N_PORTS(ehci->hcs_params);
324 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
327 t3 = ehci_readl(ehci, hostpc_reg);
328 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
329 t3 = ehci_readl(ehci, hostpc_reg);
330 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
331 port, (t3 & HOSTPC_PHCD) ?
332 "succeeded" : "failed");
334 spin_unlock_irq(&ehci->lock);
337 /* Apparently some devices need a >= 1-uframe delay here */
338 if (ehci->bus_suspended)
341 /* turn off now-idle HC */
344 spin_lock_irq(&ehci->lock);
345 if (ehci->enabled_hrtimer_events & BIT(EHCI_HRTIMER_POLL_DEAD))
346 ehci_handle_controller_death(ehci);
347 if (ehci->rh_state != EHCI_RH_RUNNING)
349 ehci->rh_state = EHCI_RH_SUSPENDED;
351 unlink_empty_async_suspended(ehci);
353 /* Some Synopsys controllers mistakenly leave IAA turned on */
354 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
356 /* Any IAA cycle that started before the suspend is now invalid */
358 ehci_handle_start_intr_unlinks(ehci);
359 ehci_handle_intr_unlinks(ehci);
362 /* allow remote wakeup */
364 if (!hcd->self.root_hub->do_remote_wakeup)
366 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
367 ehci_readl(ehci, &ehci->regs->intr_enable);
370 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
371 ehci->enabled_hrtimer_events = 0;
372 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
373 spin_unlock_irq (&ehci->lock);
375 hrtimer_cancel(&ehci->hrtimer);
380 /* caller has locked the root hub, and should reset/reinit on error */
381 static int ehci_bus_resume (struct usb_hcd *hcd)
383 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
387 unsigned long resume_needed = 0;
389 if (time_before (jiffies, ehci->next_statechange))
391 spin_lock_irq (&ehci->lock);
392 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
395 if (unlikely(ehci->debug)) {
396 if (!dbgp_reset_prep(hcd))
399 dbgp_external_startup(hcd);
402 /* Ideally and we've got a real resume here, and no port's power
403 * was lost. (For PCI, that means Vaux was maintained.) But we
404 * could instead be restoring a swsusp snapshot -- so that BIOS was
405 * the last user of the controller, not reset/pm hardware keeping
406 * state we gave to it.
408 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
409 ehci_dbg(ehci, "resume root hub%s\n",
410 power_okay ? "" : " after power loss");
412 /* at least some APM implementations will try to deliver
413 * IRQs right away, so delay them until we're ready.
415 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
417 /* re-init operational registers */
418 ehci_writel(ehci, 0, &ehci->regs->segment);
419 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
420 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
422 /* restore CMD_RUN, framelist size, and irq threshold */
423 ehci->command |= CMD_RUN;
424 ehci_writel(ehci, ehci->command, &ehci->regs->command);
425 ehci->rh_state = EHCI_RH_RUNNING;
428 * According to Bugzilla #8190, the port status for some controllers
429 * will be wrong without a delay. At their wrong status, the port
430 * is enabled, but not suspended neither resumed.
432 i = HCS_N_PORTS(ehci->hcs_params);
434 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
435 if ((temp & PORT_PE) &&
436 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
437 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
438 spin_unlock_irq(&ehci->lock);
440 spin_lock_irq(&ehci->lock);
448 /* clear phy low-power mode before resume */
449 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
450 i = HCS_N_PORTS(ehci->hcs_params);
452 if (test_bit(i, &ehci->bus_suspended)) {
453 u32 __iomem *hostpc_reg =
454 &ehci->regs->hostpc[i];
456 temp = ehci_readl(ehci, hostpc_reg);
457 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
461 spin_unlock_irq(&ehci->lock);
463 spin_lock_irq(&ehci->lock);
468 /* manually resume the ports we suspended during bus_suspend() */
469 i = HCS_N_PORTS (ehci->hcs_params);
471 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
472 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
473 if (test_bit(i, &ehci->bus_suspended) &&
474 (temp & PORT_SUSPEND)) {
476 set_bit(i, &resume_needed);
478 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
482 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
486 spin_unlock_irq(&ehci->lock);
487 msleep(USB_RESUME_TIMEOUT);
488 spin_lock_irq(&ehci->lock);
493 i = HCS_N_PORTS (ehci->hcs_params);
495 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
496 if (test_bit(i, &resume_needed)) {
497 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
498 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
502 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
503 spin_unlock_irq(&ehci->lock);
505 ehci_handover_companion_ports(ehci);
507 /* Now we can safely re-enable irqs */
508 spin_lock_irq(&ehci->lock);
511 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
512 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
513 spin_unlock_irq(&ehci->lock);
518 spin_unlock_irq(&ehci->lock);
524 #define ehci_bus_suspend NULL
525 #define ehci_bus_resume 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;
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))
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);
565 /*-------------------------------------------------------------------------*/
567 static int check_reset_complete (
568 struct ehci_hcd *ehci,
570 u32 __iomem *status_reg,
573 if (!(port_status & PORT_CONNECT))
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)) {
582 "Failed to enable port %d on root hub TT\n",
587 ehci_dbg (ehci, "port %d full speed --> companion\n",
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);
599 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
601 /* ensure 440EPx ohci controller state is suspended */
602 if (ehci->has_amcc_usb23)
603 set_ohci_hcfs(ehci, 0);
609 /*-------------------------------------------------------------------------*/
612 /* build "status change" packet (one or two bytes) from HC registers */
615 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
617 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
620 int ports, i, retval = 1;
624 /* init status to no-changes */
626 ports = HCS_N_PORTS (ehci->hcs_params);
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.
644 mask = PORT_CSC | PORT_PEC | PORT_OCC;
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 */
656 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
658 for (i = 0; i < ports; i++) {
659 /* leverage per-port change bits feature */
661 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
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]))) {
676 buf [0] |= 1 << (i + 1);
678 buf [1] |= 1 << (i - 7);
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 /*-------------------------------------------------------------------------*/
694 ehci_hub_descriptor (
695 struct ehci_hcd *ehci,
696 struct usb_hub_descriptor *desc
698 int ports = HCS_N_PORTS (ehci->hcs_params);
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 */
717 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
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) */
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;
737 static int submit_single_step_set_feature(
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,
753 struct completion *done
756 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
757 struct usb_host_endpoint *ep;
759 urb = usb_alloc_urb(0, GFP_KERNEL);
763 urb->pipe = usb_rcvctrlpipe(udev, 0);
764 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
765 [usb_pipeendpoint(urb->pipe)];
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;
781 atomic_inc(&urb->use_count);
782 atomic_inc(&urb->dev->urbnum);
783 urb->setup_dma = dma_map_single(
784 hcd->self.controller,
786 sizeof(struct usb_ctrlrequest),
788 urb->transfer_dma = dma_map_single(
789 hcd->self.controller,
790 urb->transfer_buffer,
791 urb->transfer_buffer_length,
797 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
799 int retval = -ENOMEM;
800 struct usb_ctrlrequest *dr;
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);
810 ehci_err(ehci, "No device attached to the RootHub\n");
813 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
817 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
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);
828 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
829 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
833 /* Submit just the SETUP stage */
834 retval = submit_single_step_set_feature(hcd, urb, 1);
837 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
840 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
845 /* Complete remaining DATA and STATUS stages using the same URB */
846 urb->status = -EINPROGRESS;
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))) {
855 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
864 #endif /* CONFIG_USB_HCD_TEST_MODE */
865 /*-------------------------------------------------------------------------*/
867 int ehci_hub_control(
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;
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;
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);
902 case ClearHubFeature:
904 case C_HUB_LOCAL_POWER:
905 case C_HUB_OVER_CURRENT:
906 /* no hub-wide feature/status flags */
912 case ClearPortFeature:
913 if (!wIndex || wIndex > ports)
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).
927 case USB_PORT_FEAT_ENABLE:
928 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
930 case USB_PORT_FEAT_C_ENABLE:
931 ehci_writel(ehci, temp | PORT_PEC, status_reg);
933 case USB_PORT_FEAT_SUSPEND:
934 if (temp & PORT_RESET)
936 if (ehci->no_selective_suspend)
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);
945 if (!(temp & PORT_SUSPEND))
947 if ((temp & PORT_PE) == 0)
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,
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);
967 case USB_PORT_FEAT_C_SUSPEND:
968 clear_bit(wIndex, &ehci->port_c_suspend);
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);
977 case USB_PORT_FEAT_C_CONNECTION:
978 ehci_writel(ehci, temp | PORT_CSC, status_reg);
980 case USB_PORT_FEAT_C_OVER_CURRENT:
981 ehci_writel(ehci, temp | PORT_OCC, status_reg);
983 case USB_PORT_FEAT_C_RESET:
984 /* GetPortStatus clears reset */
989 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
991 case GetHubDescriptor:
992 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
996 /* no hub-wide feature/status flags */
998 //cpu_to_le32s ((u32 *) buf);
1001 if (!wIndex || wIndex > ports)
1005 temp = ehci_readl(ehci, status_reg);
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 */);
1065 ehci_err(ehci, "port %d resume error %d\n",
1066 wIndex + 1, retval);
1069 temp = ehci_readl(ehci, status_reg);
1071 /* whoever resets must GetPortStatus to complete it!! */
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),
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);
1085 ehci_err (ehci, "port %d reset error %d\n",
1086 wIndex + 1, retval);
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;
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);
1118 status |= ehci_port_speed(ehci, temp);
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;
1131 set_bit(wIndex, &ehci->port_c_suspend);
1132 usb_hcd_end_port_resume(&hcd->self, wIndex);
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);
1150 case C_HUB_LOCAL_POWER:
1151 case C_HUB_OVER_CURRENT:
1152 /* no hub-wide feature/status flags */
1158 case SetPortFeature:
1159 selector = wIndex >> 8;
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)) {
1170 if (!wIndex || wIndex > ports)
1173 temp = ehci_readl(ehci, status_reg);
1174 if (temp & PORT_OWNER)
1177 temp &= ~PORT_RWC_BITS;
1179 case USB_PORT_FEAT_SUSPEND:
1180 if (ehci->no_selective_suspend)
1182 if ((temp & PORT_PE) == 0
1183 || (temp & PORT_RESET) != 0)
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,
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 set_bit(wIndex, &ehci->suspended_ports);
1207 case USB_PORT_FEAT_POWER:
1208 if (HCS_PPC(ehci->hcs_params)) {
1209 spin_unlock_irqrestore(&ehci->lock, flags);
1210 ehci_port_power(ehci, wIndex, true);
1211 spin_lock_irqsave(&ehci->lock, flags);
1214 case USB_PORT_FEAT_RESET:
1215 if (temp & (PORT_SUSPEND|PORT_RESUME))
1217 /* line status bits may report this as low speed,
1218 * which can be fine if this root hub has a
1219 * transaction translator built in.
1221 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1222 && !ehci_is_TDI(ehci)
1223 && PORT_USB11 (temp)) {
1225 "port %d low speed --> companion\n",
1233 * caller must wait, then call GetPortStatus
1234 * usb 2.0 spec says 50 ms resets on root
1236 ehci->reset_done [wIndex] = jiffies
1237 + msecs_to_jiffies (50);
1240 * Force full-speed connect for FSL high-speed
1241 * erratum; disable HS Chirp by setting PFSC bit
1243 if (ehci_has_fsl_hs_errata(ehci))
1244 temp |= (1 << PORTSC_FSL_PFSC);
1246 ehci_writel(ehci, temp, status_reg);
1249 /* For downstream facing ports (these): one hub port is put
1250 * into test mode according to USB2 11.24.2.13, then the hub
1251 * must be reset (which for root hub now means rmmod+modprobe,
1252 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1253 * about the EHCI-specific stuff.
1255 case USB_PORT_FEAT_TEST:
1256 #ifdef CONFIG_USB_HCD_TEST_MODE
1257 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1258 spin_unlock_irqrestore(&ehci->lock, flags);
1259 retval = ehset_single_step_set_feature(hcd,
1261 spin_lock_irqsave(&ehci->lock, flags);
1265 if (!selector || selector > 5)
1267 spin_unlock_irqrestore(&ehci->lock, flags);
1269 spin_lock_irqsave(&ehci->lock, flags);
1271 /* Put all enabled ports into suspend */
1274 &ehci->regs->port_status[ports];
1276 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1278 ehci_writel(ehci, temp | PORT_SUSPEND,
1282 spin_unlock_irqrestore(&ehci->lock, flags);
1284 spin_lock_irqsave(&ehci->lock, flags);
1286 temp = ehci_readl(ehci, status_reg);
1287 temp |= selector << 16;
1288 ehci_writel(ehci, temp, status_reg);
1294 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1299 /* "stall" on error */
1303 spin_unlock_irqrestore (&ehci->lock, flags);
1306 EXPORT_SYMBOL_GPL(ehci_hub_control);
1308 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1310 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1312 if (ehci_is_TDI(ehci))
1314 set_owner(ehci, --portnum, PORT_OWNER);
1317 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1319 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1322 if (ehci_is_TDI(ehci))
1324 reg = &ehci->regs->port_status[portnum - 1];
1325 return ehci_readl(ehci, reg) & PORT_OWNER;
1328 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1330 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1331 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1332 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1335 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1337 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1339 if (hcd->driver->port_power)
1340 hcd->driver->port_power(hcd, portnum, enable);