1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2001-2004 by David Brownell
6 /* this file is part of ehci-hcd.c */
8 /*-------------------------------------------------------------------------*/
11 * EHCI Root Hub ... the nonsharable stuff
13 * Registers don't need cpu_to_le32, that happens transparently
16 /*-------------------------------------------------------------------------*/
17 #include <linux/usb/otg.h>
19 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
23 static void unlink_empty_async_suspended(struct ehci_hcd
*ehci
);
25 static int persist_enabled_on_companion(struct usb_device
*udev
, void *unused
)
27 return !udev
->maxchild
&& udev
->persist_enabled
&&
28 udev
->bus
->root_hub
->speed
< USB_SPEED_HIGH
;
31 /* After a power loss, ports that were owned by the companion must be
32 * reset so that the companion can still own them.
34 static void ehci_handover_companion_ports(struct ehci_hcd
*ehci
)
40 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
42 if (!ehci
->owned_ports
)
46 * USB 1.1 devices are mostly HIDs, which don't need to persist across
47 * suspends. If we ensure that none of our companion's devices have
48 * persist_enabled (by looking through all USB 1.1 buses in the system),
49 * we can skip this and avoid slowing resume down. Devices without
50 * persist will just get reenumerated shortly after resume anyway.
52 if (!usb_for_each_dev(NULL
, persist_enabled_on_companion
))
55 /* Make sure the ports are powered */
56 port
= HCS_N_PORTS(ehci
->hcs_params
);
58 if (test_bit(port
, &ehci
->owned_ports
)) {
59 reg
= &ehci
->regs
->port_status
[port
];
60 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
61 if (!(status
& PORT_POWER
))
62 ehci_port_power(ehci
, port
, true);
66 /* Give the connections some time to appear */
69 spin_lock_irq(&ehci
->lock
);
70 port
= HCS_N_PORTS(ehci
->hcs_params
);
72 if (test_bit(port
, &ehci
->owned_ports
)) {
73 reg
= &ehci
->regs
->port_status
[port
];
74 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
76 /* Port already owned by companion? */
77 if (status
& PORT_OWNER
)
78 clear_bit(port
, &ehci
->owned_ports
);
79 else if (test_bit(port
, &ehci
->companion_ports
))
80 ehci_writel(ehci
, status
& ~PORT_PE
, reg
);
82 spin_unlock_irq(&ehci
->lock
);
83 ehci_hub_control(hcd
, SetPortFeature
,
84 USB_PORT_FEAT_RESET
, port
+ 1,
86 spin_lock_irq(&ehci
->lock
);
90 spin_unlock_irq(&ehci
->lock
);
92 if (!ehci
->owned_ports
)
94 msleep(90); /* Wait for resets to complete */
96 spin_lock_irq(&ehci
->lock
);
97 port
= HCS_N_PORTS(ehci
->hcs_params
);
99 if (test_bit(port
, &ehci
->owned_ports
)) {
100 spin_unlock_irq(&ehci
->lock
);
101 ehci_hub_control(hcd
, GetPortStatus
,
103 (char *) &buf
, sizeof(buf
));
104 spin_lock_irq(&ehci
->lock
);
106 /* The companion should now own the port,
107 * but if something went wrong the port must not
110 reg
= &ehci
->regs
->port_status
[port
];
111 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
112 if (status
& PORT_OWNER
)
113 ehci_writel(ehci
, status
| PORT_CSC
, reg
);
115 ehci_dbg(ehci
, "failed handover port %d: %x\n",
117 ehci_writel(ehci
, status
& ~PORT_PE
, reg
);
122 ehci
->owned_ports
= 0;
123 spin_unlock_irq(&ehci
->lock
);
126 static int ehci_port_change(struct ehci_hcd
*ehci
)
128 int i
= HCS_N_PORTS(ehci
->hcs_params
);
130 /* First check if the controller indicates a change event */
132 if (ehci_readl(ehci
, &ehci
->regs
->status
) & STS_PCD
)
136 * Not all controllers appear to update this while going from D3 to D0,
137 * so check the individual port status registers as well
141 if (ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]) & PORT_CSC
)
147 void ehci_adjust_port_wakeup_flags(struct ehci_hcd
*ehci
,
148 bool suspending
, bool do_wakeup
)
153 /* If remote wakeup is enabled for the root hub but disabled
154 * for the controller, we must adjust all the port wakeup flags
155 * when the controller is suspended or resumed. In all other
156 * cases they don't need to be changed.
158 if (!ehci_to_hcd(ehci
)->self
.root_hub
->do_remote_wakeup
|| do_wakeup
)
161 spin_lock_irq(&ehci
->lock
);
163 /* clear phy low-power mode before changing wakeup flags */
164 if (ehci
->has_tdi_phy_lpm
) {
165 port
= HCS_N_PORTS(ehci
->hcs_params
);
167 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
169 temp
= ehci_readl(ehci
, hostpc_reg
);
170 ehci_writel(ehci
, temp
& ~HOSTPC_PHCD
, hostpc_reg
);
172 spin_unlock_irq(&ehci
->lock
);
174 spin_lock_irq(&ehci
->lock
);
177 port
= HCS_N_PORTS(ehci
->hcs_params
);
179 u32 __iomem
*reg
= &ehci
->regs
->port_status
[port
];
180 u32 t1
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
181 u32 t2
= t1
& ~PORT_WAKE_BITS
;
183 /* If we are suspending the controller, clear the flags.
184 * If we are resuming the controller, set the wakeup flags.
187 if (t1
& PORT_CONNECT
)
188 t2
|= PORT_WKOC_E
| PORT_WKDISC_E
;
190 t2
|= PORT_WKOC_E
| PORT_WKCONN_E
;
192 ehci_writel(ehci
, t2
, reg
);
195 /* enter phy low-power mode again */
196 if (ehci
->has_tdi_phy_lpm
) {
197 port
= HCS_N_PORTS(ehci
->hcs_params
);
199 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
201 temp
= ehci_readl(ehci
, hostpc_reg
);
202 ehci_writel(ehci
, temp
| HOSTPC_PHCD
, hostpc_reg
);
206 /* Does the root hub have a port wakeup pending? */
207 if (!suspending
&& ehci_port_change(ehci
))
208 usb_hcd_resume_root_hub(ehci_to_hcd(ehci
));
210 spin_unlock_irq(&ehci
->lock
);
212 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags
);
214 static int ehci_bus_suspend (struct usb_hcd
*hcd
)
216 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
222 ehci_dbg(ehci
, "suspend root hub\n");
224 if (time_before (jiffies
, ehci
->next_statechange
))
227 /* stop the schedules */
230 spin_lock_irq (&ehci
->lock
);
231 if (ehci
->rh_state
< EHCI_RH_RUNNING
)
234 /* Once the controller is stopped, port resumes that are already
235 * in progress won't complete. Hence if remote wakeup is enabled
236 * for the root hub and any ports are in the middle of a resume or
237 * remote wakeup, we must fail the suspend.
239 if (hcd
->self
.root_hub
->do_remote_wakeup
) {
240 if (ehci
->resuming_ports
) {
241 spin_unlock_irq(&ehci
->lock
);
242 ehci_dbg(ehci
, "suspend failed because a port is resuming\n");
247 /* Unlike other USB host controller types, EHCI doesn't have
248 * any notion of "global" or bus-wide suspend. The driver has
249 * to manually suspend all the active unsuspended ports, and
250 * then manually resume them in the bus_resume() routine.
252 ehci
->bus_suspended
= 0;
253 ehci
->owned_ports
= 0;
255 fs_idle_delay
= false;
256 port
= HCS_N_PORTS(ehci
->hcs_params
);
258 u32 __iomem
*reg
= &ehci
->regs
->port_status
[port
];
259 u32 t1
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
260 u32 t2
= t1
& ~PORT_WAKE_BITS
;
262 /* keep track of which ports we suspend */
264 set_bit(port
, &ehci
->owned_ports
);
265 else if ((t1
& PORT_PE
) && !(t1
& PORT_SUSPEND
)) {
267 set_bit(port
, &ehci
->bus_suspended
);
270 /* enable remote wakeup on all ports, if told to do so */
271 if (hcd
->self
.root_hub
->do_remote_wakeup
) {
272 /* only enable appropriate wake bits, otherwise the
273 * hardware can not go phy low power mode. If a race
274 * condition happens here(connection change during bits
275 * set), the port change detection will finally fix it.
277 if (t1
& PORT_CONNECT
)
278 t2
|= PORT_WKOC_E
| PORT_WKDISC_E
;
280 t2
|= PORT_WKOC_E
| PORT_WKCONN_E
;
285 * On some controllers, Wake-On-Disconnect will
286 * generate false wakeup signals until the bus
287 * switches over to full-speed idle. For their
288 * sake, add a delay if we need one.
290 if ((t2
& PORT_WKDISC_E
) &&
291 ehci_port_speed(ehci
, t2
) ==
292 USB_PORT_STAT_HIGH_SPEED
)
293 fs_idle_delay
= true;
294 ehci_writel(ehci
, t2
, reg
);
298 spin_unlock_irq(&ehci
->lock
);
300 if (changed
&& ehci_has_fsl_susp_errata(ehci
))
302 * Wait for at least 10 millisecondes to ensure the controller
303 * enter the suspend status before initiating a port resume
304 * using the Force Port Resume bit (Not-EHCI compatible).
306 usleep_range(10000, 20000);
308 if ((changed
&& ehci
->has_tdi_phy_lpm
) || fs_idle_delay
) {
310 * Wait for HCD to enter low-power mode or for the bus
311 * to switch to full-speed idle.
313 usleep_range(5000, 5500);
316 if (changed
&& ehci
->has_tdi_phy_lpm
) {
317 spin_lock_irq(&ehci
->lock
);
318 port
= HCS_N_PORTS(ehci
->hcs_params
);
320 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
323 t3
= ehci_readl(ehci
, hostpc_reg
);
324 ehci_writel(ehci
, t3
| HOSTPC_PHCD
, hostpc_reg
);
325 t3
= ehci_readl(ehci
, hostpc_reg
);
326 ehci_dbg(ehci
, "Port %d phy low-power mode %s\n",
327 port
, (t3
& HOSTPC_PHCD
) ?
328 "succeeded" : "failed");
330 spin_unlock_irq(&ehci
->lock
);
333 /* Apparently some devices need a >= 1-uframe delay here */
334 if (ehci
->bus_suspended
)
337 /* turn off now-idle HC */
340 spin_lock_irq(&ehci
->lock
);
341 if (ehci
->enabled_hrtimer_events
& BIT(EHCI_HRTIMER_POLL_DEAD
))
342 ehci_handle_controller_death(ehci
);
343 if (ehci
->rh_state
!= EHCI_RH_RUNNING
)
345 ehci
->rh_state
= EHCI_RH_SUSPENDED
;
347 unlink_empty_async_suspended(ehci
);
349 /* Any IAA cycle that started before the suspend is now invalid */
351 ehci_handle_start_intr_unlinks(ehci
);
352 ehci_handle_intr_unlinks(ehci
);
355 /* allow remote wakeup */
357 if (!hcd
->self
.root_hub
->do_remote_wakeup
)
359 ehci_writel(ehci
, mask
, &ehci
->regs
->intr_enable
);
360 ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
363 ehci
->next_statechange
= jiffies
+ msecs_to_jiffies(10);
364 ehci
->enabled_hrtimer_events
= 0;
365 ehci
->next_hrtimer_event
= EHCI_HRTIMER_NO_EVENT
;
366 spin_unlock_irq (&ehci
->lock
);
368 hrtimer_cancel(&ehci
->hrtimer
);
373 /* caller has locked the root hub, and should reset/reinit on error */
374 static int ehci_bus_resume (struct usb_hcd
*hcd
)
376 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
380 unsigned long resume_needed
= 0;
382 if (time_before (jiffies
, ehci
->next_statechange
))
384 spin_lock_irq (&ehci
->lock
);
385 if (!HCD_HW_ACCESSIBLE(hcd
) || ehci
->shutdown
)
388 if (unlikely(ehci
->debug
)) {
389 if (!dbgp_reset_prep(hcd
))
392 dbgp_external_startup(hcd
);
395 /* Ideally and we've got a real resume here, and no port's power
396 * was lost. (For PCI, that means Vaux was maintained.) But we
397 * could instead be restoring a swsusp snapshot -- so that BIOS was
398 * the last user of the controller, not reset/pm hardware keeping
399 * state we gave to it.
401 power_okay
= ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
402 ehci_dbg(ehci
, "resume root hub%s\n",
403 power_okay
? "" : " after power loss");
405 /* at least some APM implementations will try to deliver
406 * IRQs right away, so delay them until we're ready.
408 ehci_writel(ehci
, 0, &ehci
->regs
->intr_enable
);
410 /* re-init operational registers */
411 ehci_writel(ehci
, 0, &ehci
->regs
->segment
);
412 ehci_writel(ehci
, ehci
->periodic_dma
, &ehci
->regs
->frame_list
);
413 ehci_writel(ehci
, (u32
) ehci
->async
->qh_dma
, &ehci
->regs
->async_next
);
415 /* restore CMD_RUN, framelist size, and irq threshold */
416 ehci
->command
|= CMD_RUN
;
417 ehci_writel(ehci
, ehci
->command
, &ehci
->regs
->command
);
418 ehci
->rh_state
= EHCI_RH_RUNNING
;
421 * According to Bugzilla #8190, the port status for some controllers
422 * will be wrong without a delay. At their wrong status, the port
423 * is enabled, but not suspended neither resumed.
425 i
= HCS_N_PORTS(ehci
->hcs_params
);
427 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
428 if ((temp
& PORT_PE
) &&
429 !(temp
& (PORT_SUSPEND
| PORT_RESUME
))) {
430 ehci_dbg(ehci
, "Port status(0x%x) is wrong\n", temp
);
431 spin_unlock_irq(&ehci
->lock
);
433 spin_lock_irq(&ehci
->lock
);
441 /* clear phy low-power mode before resume */
442 if (ehci
->bus_suspended
&& ehci
->has_tdi_phy_lpm
) {
443 i
= HCS_N_PORTS(ehci
->hcs_params
);
445 if (test_bit(i
, &ehci
->bus_suspended
)) {
446 u32 __iomem
*hostpc_reg
=
447 &ehci
->regs
->hostpc
[i
];
449 temp
= ehci_readl(ehci
, hostpc_reg
);
450 ehci_writel(ehci
, temp
& ~HOSTPC_PHCD
,
454 spin_unlock_irq(&ehci
->lock
);
456 spin_lock_irq(&ehci
->lock
);
461 /* manually resume the ports we suspended during bus_suspend() */
462 i
= HCS_N_PORTS (ehci
->hcs_params
);
464 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
465 temp
&= ~(PORT_RWC_BITS
| PORT_WAKE_BITS
);
466 if (test_bit(i
, &ehci
->bus_suspended
) &&
467 (temp
& PORT_SUSPEND
)) {
469 set_bit(i
, &resume_needed
);
471 ehci_writel(ehci
, temp
, &ehci
->regs
->port_status
[i
]);
475 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
479 spin_unlock_irq(&ehci
->lock
);
480 msleep(USB_RESUME_TIMEOUT
);
481 spin_lock_irq(&ehci
->lock
);
486 i
= HCS_N_PORTS (ehci
->hcs_params
);
488 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
489 if (test_bit(i
, &resume_needed
)) {
490 temp
&= ~(PORT_RWC_BITS
| PORT_SUSPEND
| PORT_RESUME
);
491 ehci_writel(ehci
, temp
, &ehci
->regs
->port_status
[i
]);
495 ehci
->next_statechange
= jiffies
+ msecs_to_jiffies(5);
496 spin_unlock_irq(&ehci
->lock
);
498 ehci_handover_companion_ports(ehci
);
500 /* Now we can safely re-enable irqs */
501 spin_lock_irq(&ehci
->lock
);
504 ehci_writel(ehci
, INTR_MASK
, &ehci
->regs
->intr_enable
);
505 (void) ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
506 spin_unlock_irq(&ehci
->lock
);
511 spin_unlock_irq(&ehci
->lock
);
517 #define ehci_bus_suspend NULL
518 #define ehci_bus_resume NULL
520 #endif /* CONFIG_PM */
522 /*-------------------------------------------------------------------------*/
525 * Sets the owner of a port
527 static void set_owner(struct ehci_hcd
*ehci
, int portnum
, int new_owner
)
529 u32 __iomem
*status_reg
;
533 status_reg
= &ehci
->regs
->port_status
[portnum
];
536 * The controller won't set the OWNER bit if the port is
537 * enabled, so this loop will sometimes require at least two
538 * iterations: one to disable the port and one to set OWNER.
540 for (try = 4; try > 0; --try) {
541 spin_lock_irq(&ehci
->lock
);
542 port_status
= ehci_readl(ehci
, status_reg
);
543 if ((port_status
& PORT_OWNER
) == new_owner
544 || (port_status
& (PORT_OWNER
| PORT_CONNECT
))
548 port_status
^= PORT_OWNER
;
549 port_status
&= ~(PORT_PE
| PORT_RWC_BITS
);
550 ehci_writel(ehci
, port_status
, status_reg
);
552 spin_unlock_irq(&ehci
->lock
);
558 /*-------------------------------------------------------------------------*/
560 static int check_reset_complete (
561 struct ehci_hcd
*ehci
,
563 u32 __iomem
*status_reg
,
566 if (!(port_status
& PORT_CONNECT
))
569 /* if reset finished and it's still not enabled -- handoff */
570 if (!(port_status
& PORT_PE
)) {
572 /* with integrated TT, there's nobody to hand it to! */
573 if (ehci_is_TDI(ehci
)) {
575 "Failed to enable port %d on root hub TT\n",
580 ehci_dbg (ehci
, "port %d full speed --> companion\n",
583 // what happens if HCS_N_CC(params) == 0 ?
584 port_status
|= PORT_OWNER
;
585 port_status
&= ~PORT_RWC_BITS
;
586 ehci_writel(ehci
, port_status
, status_reg
);
588 /* ensure 440EPX ohci controller state is operational */
589 if (ehci
->has_amcc_usb23
)
590 set_ohci_hcfs(ehci
, 1);
592 ehci_dbg(ehci
, "port %d reset complete, port enabled\n",
594 /* ensure 440EPx ohci controller state is suspended */
595 if (ehci
->has_amcc_usb23
)
596 set_ohci_hcfs(ehci
, 0);
602 /*-------------------------------------------------------------------------*/
605 /* build "status change" packet (one or two bytes) from HC registers */
608 ehci_hub_status_data (struct usb_hcd
*hcd
, char *buf
)
610 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
613 int ports
, i
, retval
= 1;
617 /* init status to no-changes */
619 ports
= HCS_N_PORTS (ehci
->hcs_params
);
625 /* Inform the core about resumes-in-progress by returning
626 * a non-zero value even if there are no status changes.
628 status
= ehci
->resuming_ports
;
630 /* Some boards (mostly VIA?) report bogus overcurrent indications,
631 * causing massive log spam unless we completely ignore them. It
632 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
633 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
634 * PORT_POWER; that's surprising, but maybe within-spec.
637 mask
= PORT_CSC
| PORT_PEC
| PORT_OCC
;
639 mask
= PORT_CSC
| PORT_PEC
;
640 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
642 /* no hub change reports (bit 0) for now (power, ...) */
644 /* port N changes (bit N)? */
645 spin_lock_irqsave (&ehci
->lock
, flags
);
647 /* get per-port change detect bits */
649 ppcd
= ehci_readl(ehci
, &ehci
->regs
->status
) >> 16;
651 for (i
= 0; i
< ports
; i
++) {
652 /* leverage per-port change bits feature */
654 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
659 * Return status information even for ports with OWNER set.
660 * Otherwise hub_wq wouldn't see the disconnect event when a
661 * high-speed device is switched over to the companion
662 * controller by the user.
665 if ((temp
& mask
) != 0 || test_bit(i
, &ehci
->port_c_suspend
)
666 || (ehci
->reset_done
[i
] && time_after_eq(
667 jiffies
, ehci
->reset_done
[i
]))) {
669 buf
[0] |= 1 << (i
+ 1);
671 buf
[1] |= 1 << (i
- 7);
676 /* If a resume is in progress, make sure it can finish */
677 if (ehci
->resuming_ports
)
678 mod_timer(&hcd
->rh_timer
, jiffies
+ msecs_to_jiffies(25));
680 spin_unlock_irqrestore (&ehci
->lock
, flags
);
681 return status
? retval
: 0;
684 /*-------------------------------------------------------------------------*/
687 ehci_hub_descriptor (
688 struct ehci_hcd
*ehci
,
689 struct usb_hub_descriptor
*desc
691 int ports
= HCS_N_PORTS (ehci
->hcs_params
);
694 desc
->bDescriptorType
= USB_DT_HUB
;
695 desc
->bPwrOn2PwrGood
= 10; /* ehci 1.0, 2.3.9 says 20ms max */
696 desc
->bHubContrCurrent
= 0;
698 desc
->bNbrPorts
= ports
;
699 temp
= 1 + (ports
/ 8);
700 desc
->bDescLength
= 7 + 2 * temp
;
702 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
703 memset(&desc
->u
.hs
.DeviceRemovable
[0], 0, temp
);
704 memset(&desc
->u
.hs
.DeviceRemovable
[temp
], 0xff, temp
);
706 temp
= HUB_CHAR_INDV_PORT_OCPM
; /* per-port overcurrent reporting */
707 if (HCS_PPC (ehci
->hcs_params
))
708 temp
|= HUB_CHAR_INDV_PORT_LPSM
; /* per-port power control */
710 temp
|= HUB_CHAR_NO_LPSM
; /* no power switching */
712 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
713 if (HCS_INDICATOR (ehci
->hcs_params
))
714 temp
|= HUB_CHAR_PORTIND
; /* per-port indicators (LEDs) */
716 desc
->wHubCharacteristics
= cpu_to_le16(temp
);
719 /*-------------------------------------------------------------------------*/
720 #ifdef CONFIG_USB_HCD_TEST_MODE
722 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
724 static void usb_ehset_completion(struct urb
*urb
)
726 struct completion
*done
= urb
->context
;
730 static int submit_single_step_set_feature(
737 * Allocate and initialize a control URB. This request will be used by the
738 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
739 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
740 * Return NULL if failed.
742 static struct urb
*request_single_step_set_feature_urb(
743 struct usb_device
*udev
,
746 struct completion
*done
749 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
750 struct usb_host_endpoint
*ep
;
752 urb
= usb_alloc_urb(0, GFP_KERNEL
);
756 urb
->pipe
= usb_rcvctrlpipe(udev
, 0);
757 ep
= (usb_pipein(urb
->pipe
) ? udev
->ep_in
: udev
->ep_out
)
758 [usb_pipeendpoint(urb
->pipe
)];
766 urb
->setup_packet
= (void *)dr
;
767 urb
->transfer_buffer
= buf
;
768 urb
->transfer_buffer_length
= USB_DT_DEVICE_SIZE
;
769 urb
->complete
= usb_ehset_completion
;
770 urb
->status
= -EINPROGRESS
;
771 urb
->actual_length
= 0;
772 urb
->transfer_flags
= URB_DIR_IN
;
774 atomic_inc(&urb
->use_count
);
775 atomic_inc(&urb
->dev
->urbnum
);
776 urb
->setup_dma
= dma_map_single(
779 sizeof(struct usb_ctrlrequest
),
781 urb
->transfer_dma
= dma_map_single(
783 urb
->transfer_buffer
,
784 urb
->transfer_buffer_length
,
790 static int ehset_single_step_set_feature(struct usb_hcd
*hcd
, int port
)
792 int retval
= -ENOMEM
;
793 struct usb_ctrlrequest
*dr
;
795 struct usb_device
*udev
;
796 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
797 struct usb_device_descriptor
*buf
;
798 DECLARE_COMPLETION_ONSTACK(done
);
800 /* Obtain udev of the rhub's child port */
801 udev
= usb_hub_find_child(hcd
->self
.root_hub
, port
);
803 ehci_err(ehci
, "No device attached to the RootHub\n");
806 buf
= kmalloc(USB_DT_DEVICE_SIZE
, GFP_KERNEL
);
810 dr
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_KERNEL
);
816 /* Fill Setup packet for GetDescriptor */
817 dr
->bRequestType
= USB_DIR_IN
;
818 dr
->bRequest
= USB_REQ_GET_DESCRIPTOR
;
819 dr
->wValue
= cpu_to_le16(USB_DT_DEVICE
<< 8);
821 dr
->wLength
= cpu_to_le16(USB_DT_DEVICE_SIZE
);
822 urb
= request_single_step_set_feature_urb(udev
, dr
, buf
, &done
);
826 /* Submit just the SETUP stage */
827 retval
= submit_single_step_set_feature(hcd
, urb
, 1);
830 if (!wait_for_completion_timeout(&done
, msecs_to_jiffies(2000))) {
833 ehci_err(ehci
, "%s SETUP stage timed out on ep0\n", __func__
);
838 /* Complete remaining DATA and STATUS stages using the same URB */
839 urb
->status
= -EINPROGRESS
;
841 atomic_inc(&urb
->use_count
);
842 atomic_inc(&urb
->dev
->urbnum
);
843 retval
= submit_single_step_set_feature(hcd
, urb
, 0);
844 if (!retval
&& !wait_for_completion_timeout(&done
,
845 msecs_to_jiffies(2000))) {
848 ehci_err(ehci
, "%s IN stage timed out on ep0\n", __func__
);
857 #endif /* CONFIG_USB_HCD_TEST_MODE */
858 /*-------------------------------------------------------------------------*/
860 int ehci_hub_control(
868 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
869 int ports
= HCS_N_PORTS (ehci
->hcs_params
);
870 u32 __iomem
*status_reg
, *hostpc_reg
;
871 u32 temp
, temp1
, status
;
877 * Avoid underflow while calculating (wIndex & 0xff) - 1.
878 * The compiler might deduce that wIndex can never be 0 and then
879 * optimize away the tests for !wIndex below.
881 temp
= wIndex
& 0xff;
883 status_reg
= &ehci
->regs
->port_status
[temp
];
884 hostpc_reg
= &ehci
->regs
->hostpc
[temp
];
887 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
888 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
889 * (track current state ourselves) ... blink for diagnostics,
890 * power, "this is the one", etc. EHCI spec supports this.
893 spin_lock_irqsave (&ehci
->lock
, flags
);
895 case ClearHubFeature
:
897 case C_HUB_LOCAL_POWER
:
898 case C_HUB_OVER_CURRENT
:
899 /* no hub-wide feature/status flags */
905 case ClearPortFeature
:
906 if (!wIndex
|| wIndex
> ports
)
909 temp
= ehci_readl(ehci
, status_reg
);
910 temp
&= ~PORT_RWC_BITS
;
913 * Even if OWNER is set, so the port is owned by the
914 * companion controller, hub_wq needs to be able to clear
915 * the port-change status bits (especially
916 * USB_PORT_STAT_C_CONNECTION).
920 case USB_PORT_FEAT_ENABLE
:
921 ehci_writel(ehci
, temp
& ~PORT_PE
, status_reg
);
923 case USB_PORT_FEAT_C_ENABLE
:
924 ehci_writel(ehci
, temp
| PORT_PEC
, status_reg
);
926 case USB_PORT_FEAT_SUSPEND
:
927 if (temp
& PORT_RESET
)
929 if (ehci
->no_selective_suspend
)
931 #ifdef CONFIG_USB_OTG
932 if ((hcd
->self
.otg_port
== (wIndex
+ 1))
933 && hcd
->self
.b_hnp_enable
) {
934 otg_start_hnp(hcd
->usb_phy
->otg
);
938 if (!(temp
& PORT_SUSPEND
))
940 if ((temp
& PORT_PE
) == 0)
943 /* clear phy low-power mode before resume */
944 if (ehci
->has_tdi_phy_lpm
) {
945 temp1
= ehci_readl(ehci
, hostpc_reg
);
946 ehci_writel(ehci
, temp1
& ~HOSTPC_PHCD
,
948 spin_unlock_irqrestore(&ehci
->lock
, flags
);
949 msleep(5);/* wait to leave low-power mode */
950 spin_lock_irqsave(&ehci
->lock
, flags
);
952 /* resume signaling for 20 msec */
953 temp
&= ~PORT_WAKE_BITS
;
954 ehci_writel(ehci
, temp
| PORT_RESUME
, status_reg
);
955 ehci
->reset_done
[wIndex
] = jiffies
956 + msecs_to_jiffies(USB_RESUME_TIMEOUT
);
957 set_bit(wIndex
, &ehci
->resuming_ports
);
958 usb_hcd_start_port_resume(&hcd
->self
, wIndex
);
960 case USB_PORT_FEAT_C_SUSPEND
:
961 clear_bit(wIndex
, &ehci
->port_c_suspend
);
963 case USB_PORT_FEAT_POWER
:
964 if (HCS_PPC(ehci
->hcs_params
)) {
965 spin_unlock_irqrestore(&ehci
->lock
, flags
);
966 ehci_port_power(ehci
, wIndex
, false);
967 spin_lock_irqsave(&ehci
->lock
, flags
);
970 case USB_PORT_FEAT_C_CONNECTION
:
971 ehci_writel(ehci
, temp
| PORT_CSC
, status_reg
);
973 case USB_PORT_FEAT_C_OVER_CURRENT
:
974 ehci_writel(ehci
, temp
| PORT_OCC
, status_reg
);
976 case USB_PORT_FEAT_C_RESET
:
977 /* GetPortStatus clears reset */
982 ehci_readl(ehci
, &ehci
->regs
->command
); /* unblock posted write */
984 case GetHubDescriptor
:
985 ehci_hub_descriptor (ehci
, (struct usb_hub_descriptor
*)
989 /* no hub-wide feature/status flags */
991 //cpu_to_le32s ((u32 *) buf);
994 if (!wIndex
|| wIndex
> ports
)
998 temp
= ehci_readl(ehci
, status_reg
);
1001 if (temp
& PORT_CSC
)
1002 status
|= USB_PORT_STAT_C_CONNECTION
<< 16;
1003 if (temp
& PORT_PEC
)
1004 status
|= USB_PORT_STAT_C_ENABLE
<< 16;
1006 if ((temp
& PORT_OCC
) && !ignore_oc
){
1007 status
|= USB_PORT_STAT_C_OVERCURRENT
<< 16;
1010 * Hubs should disable port power on over-current.
1011 * However, not all EHCI implementations do this
1012 * automatically, even if they _do_ support per-port
1013 * power switching; they're allowed to just limit the
1014 * current. hub_wq will turn the power back on.
1016 if (((temp
& PORT_OC
) || (ehci
->need_oc_pp_cycle
))
1017 && HCS_PPC(ehci
->hcs_params
)) {
1018 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1019 ehci_port_power(ehci
, wIndex
, false);
1020 spin_lock_irqsave(&ehci
->lock
, flags
);
1021 temp
= ehci_readl(ehci
, status_reg
);
1025 /* no reset or resume pending */
1026 if (!ehci
->reset_done
[wIndex
]) {
1028 /* Remote Wakeup received? */
1029 if (temp
& PORT_RESUME
) {
1030 /* resume signaling for 20 msec */
1031 ehci
->reset_done
[wIndex
] = jiffies
1032 + msecs_to_jiffies(20);
1033 usb_hcd_start_port_resume(&hcd
->self
, wIndex
);
1034 set_bit(wIndex
, &ehci
->resuming_ports
);
1035 /* check the port again */
1036 mod_timer(&ehci_to_hcd(ehci
)->rh_timer
,
1037 ehci
->reset_done
[wIndex
]);
1040 /* reset or resume not yet complete */
1041 } else if (!time_after_eq(jiffies
, ehci
->reset_done
[wIndex
])) {
1042 ; /* wait until it is complete */
1044 /* resume completed */
1045 } else if (test_bit(wIndex
, &ehci
->resuming_ports
)) {
1046 clear_bit(wIndex
, &ehci
->suspended_ports
);
1047 set_bit(wIndex
, &ehci
->port_c_suspend
);
1048 ehci
->reset_done
[wIndex
] = 0;
1049 usb_hcd_end_port_resume(&hcd
->self
, wIndex
);
1051 /* stop resume signaling */
1052 temp
&= ~(PORT_RWC_BITS
| PORT_SUSPEND
| PORT_RESUME
);
1053 ehci_writel(ehci
, temp
, status_reg
);
1054 clear_bit(wIndex
, &ehci
->resuming_ports
);
1055 retval
= ehci_handshake(ehci
, status_reg
,
1056 PORT_RESUME
, 0, 2000 /* 2msec */);
1058 ehci_err(ehci
, "port %d resume error %d\n",
1059 wIndex
+ 1, retval
);
1062 temp
= ehci_readl(ehci
, status_reg
);
1064 /* whoever resets must GetPortStatus to complete it!! */
1066 status
|= USB_PORT_STAT_C_RESET
<< 16;
1067 ehci
->reset_done
[wIndex
] = 0;
1069 /* force reset to complete */
1070 ehci_writel(ehci
, temp
& ~(PORT_RWC_BITS
| PORT_RESET
),
1072 /* REVISIT: some hardware needs 550+ usec to clear
1073 * this bit; seems too long to spin routinely...
1075 retval
= ehci_handshake(ehci
, status_reg
,
1076 PORT_RESET
, 0, 1000);
1078 ehci_err (ehci
, "port %d reset error %d\n",
1079 wIndex
+ 1, retval
);
1083 /* see what we found out */
1084 temp
= check_reset_complete (ehci
, wIndex
, status_reg
,
1085 ehci_readl(ehci
, status_reg
));
1088 /* transfer dedicated ports to the companion hc */
1089 if ((temp
& PORT_CONNECT
) &&
1090 test_bit(wIndex
, &ehci
->companion_ports
)) {
1091 temp
&= ~PORT_RWC_BITS
;
1093 ehci_writel(ehci
, temp
, status_reg
);
1094 ehci_dbg(ehci
, "port %d --> companion\n", wIndex
+ 1);
1095 temp
= ehci_readl(ehci
, status_reg
);
1099 * Even if OWNER is set, there's no harm letting hub_wq
1100 * see the wPortStatus values (they should all be 0 except
1101 * for PORT_POWER anyway).
1104 if (temp
& PORT_CONNECT
) {
1105 status
|= USB_PORT_STAT_CONNECTION
;
1106 // status may be from integrated TT
1107 if (ehci
->has_hostpc
) {
1108 temp1
= ehci_readl(ehci
, hostpc_reg
);
1109 status
|= ehci_port_speed(ehci
, temp1
);
1111 status
|= ehci_port_speed(ehci
, temp
);
1114 status
|= USB_PORT_STAT_ENABLE
;
1116 /* maybe the port was unsuspended without our knowledge */
1117 if (temp
& (PORT_SUSPEND
|PORT_RESUME
)) {
1118 status
|= USB_PORT_STAT_SUSPEND
;
1119 } else if (test_bit(wIndex
, &ehci
->suspended_ports
)) {
1120 clear_bit(wIndex
, &ehci
->suspended_ports
);
1121 clear_bit(wIndex
, &ehci
->resuming_ports
);
1122 ehci
->reset_done
[wIndex
] = 0;
1124 set_bit(wIndex
, &ehci
->port_c_suspend
);
1125 usb_hcd_end_port_resume(&hcd
->self
, wIndex
);
1129 status
|= USB_PORT_STAT_OVERCURRENT
;
1130 if (temp
& PORT_RESET
)
1131 status
|= USB_PORT_STAT_RESET
;
1132 if (temp
& PORT_POWER
)
1133 status
|= USB_PORT_STAT_POWER
;
1134 if (test_bit(wIndex
, &ehci
->port_c_suspend
))
1135 status
|= USB_PORT_STAT_C_SUSPEND
<< 16;
1137 if (status
& ~0xffff) /* only if wPortChange is interesting */
1138 dbg_port(ehci
, "GetStatus", wIndex
+ 1, temp
);
1139 put_unaligned_le32(status
, buf
);
1143 case C_HUB_LOCAL_POWER
:
1144 case C_HUB_OVER_CURRENT
:
1145 /* no hub-wide feature/status flags */
1151 case SetPortFeature
:
1152 selector
= wIndex
>> 8;
1154 if (unlikely(ehci
->debug
)) {
1155 /* If the debug port is active any port
1156 * feature requests should get denied */
1157 if (wIndex
== HCS_DEBUG_PORT(ehci
->hcs_params
) &&
1158 (readl(&ehci
->debug
->control
) & DBGP_ENABLED
)) {
1163 if (!wIndex
|| wIndex
> ports
)
1166 temp
= ehci_readl(ehci
, status_reg
);
1167 if (temp
& PORT_OWNER
)
1170 temp
&= ~PORT_RWC_BITS
;
1172 case USB_PORT_FEAT_SUSPEND
:
1173 if (ehci
->no_selective_suspend
)
1175 if ((temp
& PORT_PE
) == 0
1176 || (temp
& PORT_RESET
) != 0)
1179 /* After above check the port must be connected.
1180 * Set appropriate bit thus could put phy into low power
1181 * mode if we have tdi_phy_lpm feature
1183 temp
&= ~PORT_WKCONN_E
;
1184 temp
|= PORT_WKDISC_E
| PORT_WKOC_E
;
1185 ehci_writel(ehci
, temp
| PORT_SUSPEND
, status_reg
);
1186 if (ehci
->has_tdi_phy_lpm
) {
1187 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1188 msleep(5);/* 5ms for HCD enter low pwr mode */
1189 spin_lock_irqsave(&ehci
->lock
, flags
);
1190 temp1
= ehci_readl(ehci
, hostpc_reg
);
1191 ehci_writel(ehci
, temp1
| HOSTPC_PHCD
,
1193 temp1
= ehci_readl(ehci
, hostpc_reg
);
1194 ehci_dbg(ehci
, "Port%d phy low pwr mode %s\n",
1195 wIndex
, (temp1
& HOSTPC_PHCD
) ?
1196 "succeeded" : "failed");
1198 if (ehci_has_fsl_susp_errata(ehci
)) {
1199 /* 10ms for HCD enter suspend */
1200 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1201 usleep_range(10000, 20000);
1202 spin_lock_irqsave(&ehci
->lock
, flags
);
1204 set_bit(wIndex
, &ehci
->suspended_ports
);
1206 case USB_PORT_FEAT_POWER
:
1207 if (HCS_PPC(ehci
->hcs_params
)) {
1208 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1209 ehci_port_power(ehci
, wIndex
, true);
1210 spin_lock_irqsave(&ehci
->lock
, flags
);
1213 case USB_PORT_FEAT_RESET
:
1214 if (temp
& (PORT_SUSPEND
|PORT_RESUME
))
1216 /* line status bits may report this as low speed,
1217 * which can be fine if this root hub has a
1218 * transaction translator built in.
1220 if ((temp
& (PORT_PE
|PORT_CONNECT
)) == PORT_CONNECT
1221 && !ehci_is_TDI(ehci
)
1222 && PORT_USB11 (temp
)) {
1224 "port %d low speed --> companion\n",
1232 * caller must wait, then call GetPortStatus
1233 * usb 2.0 spec says 50 ms resets on root
1235 ehci
->reset_done
[wIndex
] = jiffies
1236 + msecs_to_jiffies (50);
1239 * Force full-speed connect for FSL high-speed
1240 * erratum; disable HS Chirp by setting PFSC bit
1242 if (ehci_has_fsl_hs_errata(ehci
))
1243 temp
|= (1 << PORTSC_FSL_PFSC
);
1245 ehci_writel(ehci
, temp
, status_reg
);
1248 /* For downstream facing ports (these): one hub port is put
1249 * into test mode according to USB2 11.24.2.13, then the hub
1250 * must be reset (which for root hub now means rmmod+modprobe,
1251 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1252 * about the EHCI-specific stuff.
1254 case USB_PORT_FEAT_TEST
:
1255 #ifdef CONFIG_USB_HCD_TEST_MODE
1256 if (selector
== EHSET_TEST_SINGLE_STEP_SET_FEATURE
) {
1257 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1258 retval
= ehset_single_step_set_feature(hcd
,
1260 spin_lock_irqsave(&ehci
->lock
, flags
);
1264 if (!selector
|| selector
> 5)
1266 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1268 spin_lock_irqsave(&ehci
->lock
, flags
);
1270 /* Put all enabled ports into suspend */
1273 &ehci
->regs
->port_status
[ports
];
1275 temp
= ehci_readl(ehci
, sreg
) & ~PORT_RWC_BITS
;
1277 ehci_writel(ehci
, temp
| PORT_SUSPEND
,
1281 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1283 spin_lock_irqsave(&ehci
->lock
, flags
);
1285 temp
= ehci_readl(ehci
, status_reg
);
1286 temp
|= selector
<< 16;
1287 ehci_writel(ehci
, temp
, status_reg
);
1293 ehci_readl(ehci
, &ehci
->regs
->command
); /* unblock posted writes */
1298 /* "stall" on error */
1302 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1305 EXPORT_SYMBOL_GPL(ehci_hub_control
);
1307 static void ehci_relinquish_port(struct usb_hcd
*hcd
, int portnum
)
1309 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1311 if (ehci_is_TDI(ehci
))
1313 set_owner(ehci
, --portnum
, PORT_OWNER
);
1316 static int ehci_port_handed_over(struct usb_hcd
*hcd
, int portnum
)
1318 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1321 if (ehci_is_TDI(ehci
))
1323 reg
= &ehci
->regs
->port_status
[portnum
- 1];
1324 return ehci_readl(ehci
, reg
) & PORT_OWNER
;
1327 static int ehci_port_power(struct ehci_hcd
*ehci
, int portnum
, bool enable
)
1329 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
1330 u32 __iomem
*status_reg
= &ehci
->regs
->port_status
[portnum
];
1331 u32 temp
= ehci_readl(ehci
, status_reg
) & ~PORT_RWC_BITS
;
1334 ehci_writel(ehci
, temp
| PORT_POWER
, status_reg
);
1336 ehci_writel(ehci
, temp
& ~PORT_POWER
, status_reg
);
1338 if (hcd
->driver
->port_power
)
1339 hcd
->driver
->port_power(hcd
, portnum
, enable
);