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_fsl_susp_errata(ehci))
314 * Wait for at least 10 millisecondes to ensure the controller
315 * enter the suspend status before initiating a port resume
316 * using the Force Port Resume bit (Not-EHCI compatible).
318 usleep_range(10000, 20000);
320 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
322 * Wait for HCD to enter low-power mode or for the bus
323 * to switch to full-speed idle.
325 usleep_range(5000, 5500);
328 if (changed && ehci->has_tdi_phy_lpm) {
329 spin_lock_irq(&ehci->lock);
330 port = HCS_N_PORTS(ehci->hcs_params);
332 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
335 t3 = ehci_readl(ehci, hostpc_reg);
336 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
337 t3 = ehci_readl(ehci, hostpc_reg);
338 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
339 port, (t3 & HOSTPC_PHCD) ?
340 "succeeded" : "failed");
342 spin_unlock_irq(&ehci->lock);
345 /* Apparently some devices need a >= 1-uframe delay here */
346 if (ehci->bus_suspended)
349 /* turn off now-idle HC */
352 spin_lock_irq(&ehci->lock);
353 if (ehci->enabled_hrtimer_events & BIT(EHCI_HRTIMER_POLL_DEAD))
354 ehci_handle_controller_death(ehci);
355 if (ehci->rh_state != EHCI_RH_RUNNING)
357 ehci->rh_state = EHCI_RH_SUSPENDED;
359 unlink_empty_async_suspended(ehci);
361 /* Some Synopsys controllers mistakenly leave IAA turned on */
362 ehci_writel(ehci, STS_IAA, &ehci->regs->status);
364 /* Any IAA cycle that started before the suspend is now invalid */
366 ehci_handle_start_intr_unlinks(ehci);
367 ehci_handle_intr_unlinks(ehci);
370 /* allow remote wakeup */
372 if (!hcd->self.root_hub->do_remote_wakeup)
374 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
375 ehci_readl(ehci, &ehci->regs->intr_enable);
378 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
379 ehci->enabled_hrtimer_events = 0;
380 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
381 spin_unlock_irq (&ehci->lock);
383 hrtimer_cancel(&ehci->hrtimer);
388 /* caller has locked the root hub, and should reset/reinit on error */
389 static int ehci_bus_resume (struct usb_hcd *hcd)
391 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
395 unsigned long resume_needed = 0;
397 if (time_before (jiffies, ehci->next_statechange))
399 spin_lock_irq (&ehci->lock);
400 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
403 if (unlikely(ehci->debug)) {
404 if (!dbgp_reset_prep(hcd))
407 dbgp_external_startup(hcd);
410 /* Ideally and we've got a real resume here, and no port's power
411 * was lost. (For PCI, that means Vaux was maintained.) But we
412 * could instead be restoring a swsusp snapshot -- so that BIOS was
413 * the last user of the controller, not reset/pm hardware keeping
414 * state we gave to it.
416 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
417 ehci_dbg(ehci, "resume root hub%s\n",
418 power_okay ? "" : " after power loss");
420 /* at least some APM implementations will try to deliver
421 * IRQs right away, so delay them until we're ready.
423 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
425 /* re-init operational registers */
426 ehci_writel(ehci, 0, &ehci->regs->segment);
427 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
428 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
430 /* restore CMD_RUN, framelist size, and irq threshold */
431 ehci->command |= CMD_RUN;
432 ehci_writel(ehci, ehci->command, &ehci->regs->command);
433 ehci->rh_state = EHCI_RH_RUNNING;
436 * According to Bugzilla #8190, the port status for some controllers
437 * will be wrong without a delay. At their wrong status, the port
438 * is enabled, but not suspended neither resumed.
440 i = HCS_N_PORTS(ehci->hcs_params);
442 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
443 if ((temp & PORT_PE) &&
444 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
445 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
446 spin_unlock_irq(&ehci->lock);
448 spin_lock_irq(&ehci->lock);
456 /* clear phy low-power mode before resume */
457 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
458 i = HCS_N_PORTS(ehci->hcs_params);
460 if (test_bit(i, &ehci->bus_suspended)) {
461 u32 __iomem *hostpc_reg =
462 &ehci->regs->hostpc[i];
464 temp = ehci_readl(ehci, hostpc_reg);
465 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
469 spin_unlock_irq(&ehci->lock);
471 spin_lock_irq(&ehci->lock);
476 /* manually resume the ports we suspended during bus_suspend() */
477 i = HCS_N_PORTS (ehci->hcs_params);
479 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
480 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
481 if (test_bit(i, &ehci->bus_suspended) &&
482 (temp & PORT_SUSPEND)) {
484 set_bit(i, &resume_needed);
486 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
490 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
494 spin_unlock_irq(&ehci->lock);
495 msleep(USB_RESUME_TIMEOUT);
496 spin_lock_irq(&ehci->lock);
501 i = HCS_N_PORTS (ehci->hcs_params);
503 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
504 if (test_bit(i, &resume_needed)) {
505 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
506 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
510 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
511 spin_unlock_irq(&ehci->lock);
513 ehci_handover_companion_ports(ehci);
515 /* Now we can safely re-enable irqs */
516 spin_lock_irq(&ehci->lock);
519 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
520 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
521 spin_unlock_irq(&ehci->lock);
526 spin_unlock_irq(&ehci->lock);
532 #define ehci_bus_suspend NULL
533 #define ehci_bus_resume NULL
535 #endif /* CONFIG_PM */
537 /*-------------------------------------------------------------------------*/
540 * Sets the owner of a port
542 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
544 u32 __iomem *status_reg;
548 status_reg = &ehci->regs->port_status[portnum];
551 * The controller won't set the OWNER bit if the port is
552 * enabled, so this loop will sometimes require at least two
553 * iterations: one to disable the port and one to set OWNER.
555 for (try = 4; try > 0; --try) {
556 spin_lock_irq(&ehci->lock);
557 port_status = ehci_readl(ehci, status_reg);
558 if ((port_status & PORT_OWNER) == new_owner
559 || (port_status & (PORT_OWNER | PORT_CONNECT))
563 port_status ^= PORT_OWNER;
564 port_status &= ~(PORT_PE | PORT_RWC_BITS);
565 ehci_writel(ehci, port_status, status_reg);
567 spin_unlock_irq(&ehci->lock);
573 /*-------------------------------------------------------------------------*/
575 static int check_reset_complete (
576 struct ehci_hcd *ehci,
578 u32 __iomem *status_reg,
581 if (!(port_status & PORT_CONNECT))
584 /* if reset finished and it's still not enabled -- handoff */
585 if (!(port_status & PORT_PE)) {
587 /* with integrated TT, there's nobody to hand it to! */
588 if (ehci_is_TDI(ehci)) {
590 "Failed to enable port %d on root hub TT\n",
595 ehci_dbg (ehci, "port %d full speed --> companion\n",
598 // what happens if HCS_N_CC(params) == 0 ?
599 port_status |= PORT_OWNER;
600 port_status &= ~PORT_RWC_BITS;
601 ehci_writel(ehci, port_status, status_reg);
603 /* ensure 440EPX ohci controller state is operational */
604 if (ehci->has_amcc_usb23)
605 set_ohci_hcfs(ehci, 1);
607 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
609 /* ensure 440EPx ohci controller state is suspended */
610 if (ehci->has_amcc_usb23)
611 set_ohci_hcfs(ehci, 0);
617 /*-------------------------------------------------------------------------*/
620 /* build "status change" packet (one or two bytes) from HC registers */
623 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
625 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
628 int ports, i, retval = 1;
632 /* init status to no-changes */
634 ports = HCS_N_PORTS (ehci->hcs_params);
640 /* Inform the core about resumes-in-progress by returning
641 * a non-zero value even if there are no status changes.
643 status = ehci->resuming_ports;
645 /* Some boards (mostly VIA?) report bogus overcurrent indications,
646 * causing massive log spam unless we completely ignore them. It
647 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
648 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
649 * PORT_POWER; that's surprising, but maybe within-spec.
652 mask = PORT_CSC | PORT_PEC | PORT_OCC;
654 mask = PORT_CSC | PORT_PEC;
655 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
657 /* no hub change reports (bit 0) for now (power, ...) */
659 /* port N changes (bit N)? */
660 spin_lock_irqsave (&ehci->lock, flags);
662 /* get per-port change detect bits */
664 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
666 for (i = 0; i < ports; i++) {
667 /* leverage per-port change bits feature */
669 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
674 * Return status information even for ports with OWNER set.
675 * Otherwise hub_wq wouldn't see the disconnect event when a
676 * high-speed device is switched over to the companion
677 * controller by the user.
680 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
681 || (ehci->reset_done[i] && time_after_eq(
682 jiffies, ehci->reset_done[i]))) {
684 buf [0] |= 1 << (i + 1);
686 buf [1] |= 1 << (i - 7);
691 /* If a resume is in progress, make sure it can finish */
692 if (ehci->resuming_ports)
693 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(25));
695 spin_unlock_irqrestore (&ehci->lock, flags);
696 return status ? retval : 0;
699 /*-------------------------------------------------------------------------*/
702 ehci_hub_descriptor (
703 struct ehci_hcd *ehci,
704 struct usb_hub_descriptor *desc
706 int ports = HCS_N_PORTS (ehci->hcs_params);
709 desc->bDescriptorType = USB_DT_HUB;
710 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
711 desc->bHubContrCurrent = 0;
713 desc->bNbrPorts = ports;
714 temp = 1 + (ports / 8);
715 desc->bDescLength = 7 + 2 * temp;
717 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
718 memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
719 memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
721 temp = HUB_CHAR_INDV_PORT_OCPM; /* per-port overcurrent reporting */
722 if (HCS_PPC (ehci->hcs_params))
723 temp |= HUB_CHAR_INDV_PORT_LPSM; /* per-port power control */
725 temp |= HUB_CHAR_NO_LPSM; /* no power switching */
727 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
728 if (HCS_INDICATOR (ehci->hcs_params))
729 temp |= HUB_CHAR_PORTIND; /* per-port indicators (LEDs) */
731 desc->wHubCharacteristics = cpu_to_le16(temp);
734 /*-------------------------------------------------------------------------*/
735 #ifdef CONFIG_USB_HCD_TEST_MODE
737 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
739 static void usb_ehset_completion(struct urb *urb)
741 struct completion *done = urb->context;
745 static int submit_single_step_set_feature(
752 * Allocate and initialize a control URB. This request will be used by the
753 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
754 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
755 * Return NULL if failed.
757 static struct urb *request_single_step_set_feature_urb(
758 struct usb_device *udev,
761 struct completion *done
764 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
765 struct usb_host_endpoint *ep;
767 urb = usb_alloc_urb(0, GFP_KERNEL);
771 urb->pipe = usb_rcvctrlpipe(udev, 0);
772 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
773 [usb_pipeendpoint(urb->pipe)];
781 urb->setup_packet = (void *)dr;
782 urb->transfer_buffer = buf;
783 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
784 urb->complete = usb_ehset_completion;
785 urb->status = -EINPROGRESS;
786 urb->actual_length = 0;
787 urb->transfer_flags = URB_DIR_IN;
789 atomic_inc(&urb->use_count);
790 atomic_inc(&urb->dev->urbnum);
791 urb->setup_dma = dma_map_single(
794 sizeof(struct usb_ctrlrequest),
796 urb->transfer_dma = dma_map_single(
798 urb->transfer_buffer,
799 urb->transfer_buffer_length,
805 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
807 int retval = -ENOMEM;
808 struct usb_ctrlrequest *dr;
810 struct usb_device *udev;
811 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
812 struct usb_device_descriptor *buf;
813 DECLARE_COMPLETION_ONSTACK(done);
815 /* Obtain udev of the rhub's child port */
816 udev = usb_hub_find_child(hcd->self.root_hub, port);
818 ehci_err(ehci, "No device attached to the RootHub\n");
821 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
825 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
831 /* Fill Setup packet for GetDescriptor */
832 dr->bRequestType = USB_DIR_IN;
833 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
834 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
836 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
837 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
841 /* Submit just the SETUP stage */
842 retval = submit_single_step_set_feature(hcd, urb, 1);
845 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
848 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
853 /* Complete remaining DATA and STATUS stages using the same URB */
854 urb->status = -EINPROGRESS;
856 atomic_inc(&urb->use_count);
857 atomic_inc(&urb->dev->urbnum);
858 retval = submit_single_step_set_feature(hcd, urb, 0);
859 if (!retval && !wait_for_completion_timeout(&done,
860 msecs_to_jiffies(2000))) {
863 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
872 #endif /* CONFIG_USB_HCD_TEST_MODE */
873 /*-------------------------------------------------------------------------*/
875 int ehci_hub_control(
883 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
884 int ports = HCS_N_PORTS (ehci->hcs_params);
885 u32 __iomem *status_reg, *hostpc_reg;
886 u32 temp, temp1, status;
892 * Avoid underflow while calculating (wIndex & 0xff) - 1.
893 * The compiler might deduce that wIndex can never be 0 and then
894 * optimize away the tests for !wIndex below.
896 temp = wIndex & 0xff;
898 status_reg = &ehci->regs->port_status[temp];
899 hostpc_reg = &ehci->regs->hostpc[temp];
902 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
903 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
904 * (track current state ourselves) ... blink for diagnostics,
905 * power, "this is the one", etc. EHCI spec supports this.
908 spin_lock_irqsave (&ehci->lock, flags);
910 case ClearHubFeature:
912 case C_HUB_LOCAL_POWER:
913 case C_HUB_OVER_CURRENT:
914 /* no hub-wide feature/status flags */
920 case ClearPortFeature:
921 if (!wIndex || wIndex > ports)
924 temp = ehci_readl(ehci, status_reg);
925 temp &= ~PORT_RWC_BITS;
928 * Even if OWNER is set, so the port is owned by the
929 * companion controller, hub_wq needs to be able to clear
930 * the port-change status bits (especially
931 * USB_PORT_STAT_C_CONNECTION).
935 case USB_PORT_FEAT_ENABLE:
936 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
938 case USB_PORT_FEAT_C_ENABLE:
939 ehci_writel(ehci, temp | PORT_PEC, status_reg);
941 case USB_PORT_FEAT_SUSPEND:
942 if (temp & PORT_RESET)
944 if (ehci->no_selective_suspend)
946 #ifdef CONFIG_USB_OTG
947 if ((hcd->self.otg_port == (wIndex + 1))
948 && hcd->self.b_hnp_enable) {
949 otg_start_hnp(hcd->usb_phy->otg);
953 if (!(temp & PORT_SUSPEND))
955 if ((temp & PORT_PE) == 0)
958 /* clear phy low-power mode before resume */
959 if (ehci->has_tdi_phy_lpm) {
960 temp1 = ehci_readl(ehci, hostpc_reg);
961 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
963 spin_unlock_irqrestore(&ehci->lock, flags);
964 msleep(5);/* wait to leave low-power mode */
965 spin_lock_irqsave(&ehci->lock, flags);
967 /* resume signaling for 20 msec */
968 temp &= ~PORT_WAKE_BITS;
969 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
970 ehci->reset_done[wIndex] = jiffies
971 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
972 set_bit(wIndex, &ehci->resuming_ports);
973 usb_hcd_start_port_resume(&hcd->self, wIndex);
975 case USB_PORT_FEAT_C_SUSPEND:
976 clear_bit(wIndex, &ehci->port_c_suspend);
978 case USB_PORT_FEAT_POWER:
979 if (HCS_PPC(ehci->hcs_params)) {
980 spin_unlock_irqrestore(&ehci->lock, flags);
981 ehci_port_power(ehci, wIndex, false);
982 spin_lock_irqsave(&ehci->lock, flags);
985 case USB_PORT_FEAT_C_CONNECTION:
986 ehci_writel(ehci, temp | PORT_CSC, status_reg);
988 case USB_PORT_FEAT_C_OVER_CURRENT:
989 ehci_writel(ehci, temp | PORT_OCC, status_reg);
991 case USB_PORT_FEAT_C_RESET:
992 /* GetPortStatus clears reset */
997 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
999 case GetHubDescriptor:
1000 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
1004 /* no hub-wide feature/status flags */
1006 //cpu_to_le32s ((u32 *) buf);
1009 if (!wIndex || wIndex > ports)
1013 temp = ehci_readl(ehci, status_reg);
1016 if (temp & PORT_CSC)
1017 status |= USB_PORT_STAT_C_CONNECTION << 16;
1018 if (temp & PORT_PEC)
1019 status |= USB_PORT_STAT_C_ENABLE << 16;
1021 if ((temp & PORT_OCC) && !ignore_oc){
1022 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1025 * Hubs should disable port power on over-current.
1026 * However, not all EHCI implementations do this
1027 * automatically, even if they _do_ support per-port
1028 * power switching; they're allowed to just limit the
1029 * current. hub_wq will turn the power back on.
1031 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
1032 && HCS_PPC(ehci->hcs_params)) {
1033 spin_unlock_irqrestore(&ehci->lock, flags);
1034 ehci_port_power(ehci, wIndex, false);
1035 spin_lock_irqsave(&ehci->lock, flags);
1036 temp = ehci_readl(ehci, status_reg);
1040 /* no reset or resume pending */
1041 if (!ehci->reset_done[wIndex]) {
1043 /* Remote Wakeup received? */
1044 if (temp & PORT_RESUME) {
1045 /* resume signaling for 20 msec */
1046 ehci->reset_done[wIndex] = jiffies
1047 + msecs_to_jiffies(20);
1048 usb_hcd_start_port_resume(&hcd->self, wIndex);
1049 set_bit(wIndex, &ehci->resuming_ports);
1050 /* check the port again */
1051 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1052 ehci->reset_done[wIndex]);
1055 /* reset or resume not yet complete */
1056 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
1057 ; /* wait until it is complete */
1059 /* resume completed */
1060 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
1061 clear_bit(wIndex, &ehci->suspended_ports);
1062 set_bit(wIndex, &ehci->port_c_suspend);
1063 ehci->reset_done[wIndex] = 0;
1064 usb_hcd_end_port_resume(&hcd->self, wIndex);
1066 /* stop resume signaling */
1067 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
1068 ehci_writel(ehci, temp, status_reg);
1069 clear_bit(wIndex, &ehci->resuming_ports);
1070 retval = ehci_handshake(ehci, status_reg,
1071 PORT_RESUME, 0, 2000 /* 2msec */);
1073 ehci_err(ehci, "port %d resume error %d\n",
1074 wIndex + 1, retval);
1077 temp = ehci_readl(ehci, status_reg);
1079 /* whoever resets must GetPortStatus to complete it!! */
1081 status |= USB_PORT_STAT_C_RESET << 16;
1082 ehci->reset_done [wIndex] = 0;
1084 /* force reset to complete */
1085 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1087 /* REVISIT: some hardware needs 550+ usec to clear
1088 * this bit; seems too long to spin routinely...
1090 retval = ehci_handshake(ehci, status_reg,
1091 PORT_RESET, 0, 1000);
1093 ehci_err (ehci, "port %d reset error %d\n",
1094 wIndex + 1, retval);
1098 /* see what we found out */
1099 temp = check_reset_complete (ehci, wIndex, status_reg,
1100 ehci_readl(ehci, status_reg));
1103 /* transfer dedicated ports to the companion hc */
1104 if ((temp & PORT_CONNECT) &&
1105 test_bit(wIndex, &ehci->companion_ports)) {
1106 temp &= ~PORT_RWC_BITS;
1108 ehci_writel(ehci, temp, status_reg);
1109 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1110 temp = ehci_readl(ehci, status_reg);
1114 * Even if OWNER is set, there's no harm letting hub_wq
1115 * see the wPortStatus values (they should all be 0 except
1116 * for PORT_POWER anyway).
1119 if (temp & PORT_CONNECT) {
1120 status |= USB_PORT_STAT_CONNECTION;
1121 // status may be from integrated TT
1122 if (ehci->has_hostpc) {
1123 temp1 = ehci_readl(ehci, hostpc_reg);
1124 status |= ehci_port_speed(ehci, temp1);
1126 status |= ehci_port_speed(ehci, temp);
1129 status |= USB_PORT_STAT_ENABLE;
1131 /* maybe the port was unsuspended without our knowledge */
1132 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1133 status |= USB_PORT_STAT_SUSPEND;
1134 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1135 clear_bit(wIndex, &ehci->suspended_ports);
1136 clear_bit(wIndex, &ehci->resuming_ports);
1137 ehci->reset_done[wIndex] = 0;
1139 set_bit(wIndex, &ehci->port_c_suspend);
1140 usb_hcd_end_port_resume(&hcd->self, wIndex);
1144 status |= USB_PORT_STAT_OVERCURRENT;
1145 if (temp & PORT_RESET)
1146 status |= USB_PORT_STAT_RESET;
1147 if (temp & PORT_POWER)
1148 status |= USB_PORT_STAT_POWER;
1149 if (test_bit(wIndex, &ehci->port_c_suspend))
1150 status |= USB_PORT_STAT_C_SUSPEND << 16;
1152 if (status & ~0xffff) /* only if wPortChange is interesting */
1153 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1154 put_unaligned_le32(status, buf);
1158 case C_HUB_LOCAL_POWER:
1159 case C_HUB_OVER_CURRENT:
1160 /* no hub-wide feature/status flags */
1166 case SetPortFeature:
1167 selector = wIndex >> 8;
1169 if (unlikely(ehci->debug)) {
1170 /* If the debug port is active any port
1171 * feature requests should get denied */
1172 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1173 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1178 if (!wIndex || wIndex > ports)
1181 temp = ehci_readl(ehci, status_reg);
1182 if (temp & PORT_OWNER)
1185 temp &= ~PORT_RWC_BITS;
1187 case USB_PORT_FEAT_SUSPEND:
1188 if (ehci->no_selective_suspend)
1190 if ((temp & PORT_PE) == 0
1191 || (temp & PORT_RESET) != 0)
1194 /* After above check the port must be connected.
1195 * Set appropriate bit thus could put phy into low power
1196 * mode if we have tdi_phy_lpm feature
1198 temp &= ~PORT_WKCONN_E;
1199 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1200 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1201 if (ehci->has_tdi_phy_lpm) {
1202 spin_unlock_irqrestore(&ehci->lock, flags);
1203 msleep(5);/* 5ms for HCD enter low pwr mode */
1204 spin_lock_irqsave(&ehci->lock, flags);
1205 temp1 = ehci_readl(ehci, hostpc_reg);
1206 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1208 temp1 = ehci_readl(ehci, hostpc_reg);
1209 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1210 wIndex, (temp1 & HOSTPC_PHCD) ?
1211 "succeeded" : "failed");
1213 if (ehci_has_fsl_susp_errata(ehci)) {
1214 /* 10ms for HCD enter suspend */
1215 spin_unlock_irqrestore(&ehci->lock, flags);
1216 usleep_range(10000, 20000);
1217 spin_lock_irqsave(&ehci->lock, flags);
1219 set_bit(wIndex, &ehci->suspended_ports);
1221 case USB_PORT_FEAT_POWER:
1222 if (HCS_PPC(ehci->hcs_params)) {
1223 spin_unlock_irqrestore(&ehci->lock, flags);
1224 ehci_port_power(ehci, wIndex, true);
1225 spin_lock_irqsave(&ehci->lock, flags);
1228 case USB_PORT_FEAT_RESET:
1229 if (temp & (PORT_SUSPEND|PORT_RESUME))
1231 /* line status bits may report this as low speed,
1232 * which can be fine if this root hub has a
1233 * transaction translator built in.
1235 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1236 && !ehci_is_TDI(ehci)
1237 && PORT_USB11 (temp)) {
1239 "port %d low speed --> companion\n",
1247 * caller must wait, then call GetPortStatus
1248 * usb 2.0 spec says 50 ms resets on root
1250 ehci->reset_done [wIndex] = jiffies
1251 + msecs_to_jiffies (50);
1254 * Force full-speed connect for FSL high-speed
1255 * erratum; disable HS Chirp by setting PFSC bit
1257 if (ehci_has_fsl_hs_errata(ehci))
1258 temp |= (1 << PORTSC_FSL_PFSC);
1260 ehci_writel(ehci, temp, status_reg);
1263 /* For downstream facing ports (these): one hub port is put
1264 * into test mode according to USB2 11.24.2.13, then the hub
1265 * must be reset (which for root hub now means rmmod+modprobe,
1266 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1267 * about the EHCI-specific stuff.
1269 case USB_PORT_FEAT_TEST:
1270 #ifdef CONFIG_USB_HCD_TEST_MODE
1271 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1272 spin_unlock_irqrestore(&ehci->lock, flags);
1273 retval = ehset_single_step_set_feature(hcd,
1275 spin_lock_irqsave(&ehci->lock, flags);
1279 if (!selector || selector > 5)
1281 spin_unlock_irqrestore(&ehci->lock, flags);
1283 spin_lock_irqsave(&ehci->lock, flags);
1285 /* Put all enabled ports into suspend */
1288 &ehci->regs->port_status[ports];
1290 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1292 ehci_writel(ehci, temp | PORT_SUSPEND,
1296 spin_unlock_irqrestore(&ehci->lock, flags);
1298 spin_lock_irqsave(&ehci->lock, flags);
1300 temp = ehci_readl(ehci, status_reg);
1301 temp |= selector << 16;
1302 ehci_writel(ehci, temp, status_reg);
1308 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1313 /* "stall" on error */
1317 spin_unlock_irqrestore (&ehci->lock, flags);
1320 EXPORT_SYMBOL_GPL(ehci_hub_control);
1322 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1324 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1326 if (ehci_is_TDI(ehci))
1328 set_owner(ehci, --portnum, PORT_OWNER);
1331 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1333 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1336 if (ehci_is_TDI(ehci))
1338 reg = &ehci->regs->port_status[portnum - 1];
1339 return ehci_readl(ehci, reg) & PORT_OWNER;
1342 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable)
1344 struct usb_hcd *hcd = ehci_to_hcd(ehci);
1345 u32 __iomem *status_reg = &ehci->regs->port_status[portnum];
1346 u32 temp = ehci_readl(ehci, status_reg) & ~PORT_RWC_BITS;
1349 ehci_writel(ehci, temp | PORT_POWER, status_reg);
1351 ehci_writel(ehci, temp & ~PORT_POWER, status_reg);
1353 if (hcd->driver->port_power)
1354 hcd->driver->port_power(hcd, portnum, enable);