1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2001-2004 by David Brownell
6 /* this file is part of ehci-hcd.c */
8 /*-------------------------------------------------------------------------*/
11 * EHCI Root Hub ... the nonsharable stuff
13 * Registers don't need cpu_to_le32, that happens transparently
16 /*-------------------------------------------------------------------------*/
18 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
22 static void unlink_empty_async_suspended(struct ehci_hcd
*ehci
);
24 static int persist_enabled_on_companion(struct usb_device
*udev
, void *unused
)
26 return !udev
->maxchild
&& udev
->persist_enabled
&&
27 udev
->bus
->root_hub
->speed
< USB_SPEED_HIGH
;
30 /* After a power loss, ports that were owned by the companion must be
31 * reset so that the companion can still own them.
33 static void ehci_handover_companion_ports(struct ehci_hcd
*ehci
)
39 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
41 if (!ehci
->owned_ports
)
45 * USB 1.1 devices are mostly HIDs, which don't need to persist across
46 * suspends. If we ensure that none of our companion's devices have
47 * persist_enabled (by looking through all USB 1.1 buses in the system),
48 * we can skip this and avoid slowing resume down. Devices without
49 * persist will just get reenumerated shortly after resume anyway.
51 if (!usb_for_each_dev(NULL
, persist_enabled_on_companion
))
54 /* Make sure the ports are powered */
55 port
= HCS_N_PORTS(ehci
->hcs_params
);
57 if (test_bit(port
, &ehci
->owned_ports
)) {
58 reg
= &ehci
->regs
->port_status
[port
];
59 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
60 if (!(status
& PORT_POWER
))
61 ehci_port_power(ehci
, port
, true);
65 /* Give the connections some time to appear */
68 spin_lock_irq(&ehci
->lock
);
69 port
= HCS_N_PORTS(ehci
->hcs_params
);
71 if (test_bit(port
, &ehci
->owned_ports
)) {
72 reg
= &ehci
->regs
->port_status
[port
];
73 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
75 /* Port already owned by companion? */
76 if (status
& PORT_OWNER
)
77 clear_bit(port
, &ehci
->owned_ports
);
78 else if (test_bit(port
, &ehci
->companion_ports
))
79 ehci_writel(ehci
, status
& ~PORT_PE
, reg
);
81 spin_unlock_irq(&ehci
->lock
);
82 ehci_hub_control(hcd
, SetPortFeature
,
83 USB_PORT_FEAT_RESET
, port
+ 1,
85 spin_lock_irq(&ehci
->lock
);
89 spin_unlock_irq(&ehci
->lock
);
91 if (!ehci
->owned_ports
)
93 msleep(90); /* Wait for resets to complete */
95 spin_lock_irq(&ehci
->lock
);
96 port
= HCS_N_PORTS(ehci
->hcs_params
);
98 if (test_bit(port
, &ehci
->owned_ports
)) {
99 spin_unlock_irq(&ehci
->lock
);
100 ehci_hub_control(hcd
, GetPortStatus
,
102 (char *) &buf
, sizeof(buf
));
103 spin_lock_irq(&ehci
->lock
);
105 /* The companion should now own the port,
106 * but if something went wrong the port must not
109 reg
= &ehci
->regs
->port_status
[port
];
110 status
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
111 if (status
& PORT_OWNER
)
112 ehci_writel(ehci
, status
| PORT_CSC
, reg
);
114 ehci_dbg(ehci
, "failed handover port %d: %x\n",
116 ehci_writel(ehci
, status
& ~PORT_PE
, reg
);
121 ehci
->owned_ports
= 0;
122 spin_unlock_irq(&ehci
->lock
);
125 static int ehci_port_change(struct ehci_hcd
*ehci
)
127 int i
= HCS_N_PORTS(ehci
->hcs_params
);
129 /* First check if the controller indicates a change event */
131 if (ehci_readl(ehci
, &ehci
->regs
->status
) & STS_PCD
)
135 * Not all controllers appear to update this while going from D3 to D0,
136 * so check the individual port status registers as well
140 if (ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]) & PORT_CSC
)
146 void ehci_adjust_port_wakeup_flags(struct ehci_hcd
*ehci
,
147 bool suspending
, bool do_wakeup
)
152 /* If remote wakeup is enabled for the root hub but disabled
153 * for the controller, we must adjust all the port wakeup flags
154 * when the controller is suspended or resumed. In all other
155 * cases they don't need to be changed.
157 if (!ehci_to_hcd(ehci
)->self
.root_hub
->do_remote_wakeup
|| do_wakeup
)
160 spin_lock_irq(&ehci
->lock
);
162 /* clear phy low-power mode before changing wakeup flags */
163 if (ehci
->has_tdi_phy_lpm
) {
164 port
= HCS_N_PORTS(ehci
->hcs_params
);
166 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
168 temp
= ehci_readl(ehci
, hostpc_reg
);
169 ehci_writel(ehci
, temp
& ~HOSTPC_PHCD
, hostpc_reg
);
171 spin_unlock_irq(&ehci
->lock
);
173 spin_lock_irq(&ehci
->lock
);
176 port
= HCS_N_PORTS(ehci
->hcs_params
);
178 u32 __iomem
*reg
= &ehci
->regs
->port_status
[port
];
179 u32 t1
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
180 u32 t2
= t1
& ~PORT_WAKE_BITS
;
182 /* If we are suspending the controller, clear the flags.
183 * If we are resuming the controller, set the wakeup flags.
186 if (t1
& PORT_CONNECT
)
187 t2
|= PORT_WKOC_E
| PORT_WKDISC_E
;
189 t2
|= PORT_WKOC_E
| PORT_WKCONN_E
;
191 ehci_writel(ehci
, t2
, reg
);
194 /* enter phy low-power mode again */
195 if (ehci
->has_tdi_phy_lpm
) {
196 port
= HCS_N_PORTS(ehci
->hcs_params
);
198 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
200 temp
= ehci_readl(ehci
, hostpc_reg
);
201 ehci_writel(ehci
, temp
| HOSTPC_PHCD
, hostpc_reg
);
205 /* Does the root hub have a port wakeup pending? */
206 if (!suspending
&& ehci_port_change(ehci
))
207 usb_hcd_resume_root_hub(ehci_to_hcd(ehci
));
209 spin_unlock_irq(&ehci
->lock
);
211 EXPORT_SYMBOL_GPL(ehci_adjust_port_wakeup_flags
);
213 static int ehci_bus_suspend (struct usb_hcd
*hcd
)
215 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
221 ehci_dbg(ehci
, "suspend root hub\n");
223 if (time_before (jiffies
, ehci
->next_statechange
))
226 /* stop the schedules */
229 spin_lock_irq (&ehci
->lock
);
230 if (ehci
->rh_state
< EHCI_RH_RUNNING
)
233 /* Once the controller is stopped, port resumes that are already
234 * in progress won't complete. Hence if remote wakeup is enabled
235 * for the root hub and any ports are in the middle of a resume or
236 * remote wakeup, we must fail the suspend.
238 if (hcd
->self
.root_hub
->do_remote_wakeup
) {
239 if (ehci
->resuming_ports
) {
240 spin_unlock_irq(&ehci
->lock
);
241 ehci_dbg(ehci
, "suspend failed because a port is resuming\n");
246 /* Unlike other USB host controller types, EHCI doesn't have
247 * any notion of "global" or bus-wide suspend. The driver has
248 * to manually suspend all the active unsuspended ports, and
249 * then manually resume them in the bus_resume() routine.
251 ehci
->bus_suspended
= 0;
252 ehci
->owned_ports
= 0;
254 fs_idle_delay
= false;
255 port
= HCS_N_PORTS(ehci
->hcs_params
);
257 u32 __iomem
*reg
= &ehci
->regs
->port_status
[port
];
258 u32 t1
= ehci_readl(ehci
, reg
) & ~PORT_RWC_BITS
;
259 u32 t2
= t1
& ~PORT_WAKE_BITS
;
261 /* keep track of which ports we suspend */
263 set_bit(port
, &ehci
->owned_ports
);
264 else if ((t1
& PORT_PE
) && !(t1
& PORT_SUSPEND
)) {
266 set_bit(port
, &ehci
->bus_suspended
);
269 /* enable remote wakeup on all ports, if told to do so */
270 if (hcd
->self
.root_hub
->do_remote_wakeup
) {
271 /* only enable appropriate wake bits, otherwise the
272 * hardware can not go phy low power mode. If a race
273 * condition happens here(connection change during bits
274 * set), the port change detection will finally fix it.
276 if (t1
& PORT_CONNECT
)
277 t2
|= PORT_WKOC_E
| PORT_WKDISC_E
;
279 t2
|= PORT_WKOC_E
| PORT_WKCONN_E
;
284 * On some controllers, Wake-On-Disconnect will
285 * generate false wakeup signals until the bus
286 * switches over to full-speed idle. For their
287 * sake, add a delay if we need one.
289 if ((t2
& PORT_WKDISC_E
) &&
290 ehci_port_speed(ehci
, t2
) ==
291 USB_PORT_STAT_HIGH_SPEED
)
292 fs_idle_delay
= true;
293 ehci_writel(ehci
, t2
, reg
);
297 spin_unlock_irq(&ehci
->lock
);
299 if (changed
&& ehci_has_fsl_susp_errata(ehci
))
301 * Wait for at least 10 millisecondes to ensure the controller
302 * enter the suspend status before initiating a port resume
303 * using the Force Port Resume bit (Not-EHCI compatible).
305 usleep_range(10000, 20000);
307 if ((changed
&& ehci
->has_tdi_phy_lpm
) || fs_idle_delay
) {
309 * Wait for HCD to enter low-power mode or for the bus
310 * to switch to full-speed idle.
312 usleep_range(5000, 5500);
315 if (changed
&& ehci
->has_tdi_phy_lpm
) {
316 spin_lock_irq(&ehci
->lock
);
317 port
= HCS_N_PORTS(ehci
->hcs_params
);
319 u32 __iomem
*hostpc_reg
= &ehci
->regs
->hostpc
[port
];
322 t3
= ehci_readl(ehci
, hostpc_reg
);
323 ehci_writel(ehci
, t3
| HOSTPC_PHCD
, hostpc_reg
);
324 t3
= ehci_readl(ehci
, hostpc_reg
);
325 ehci_dbg(ehci
, "Port %d phy low-power mode %s\n",
326 port
, (t3
& HOSTPC_PHCD
) ?
327 "succeeded" : "failed");
329 spin_unlock_irq(&ehci
->lock
);
332 /* Apparently some devices need a >= 1-uframe delay here */
333 if (ehci
->bus_suspended
)
336 /* turn off now-idle HC */
339 spin_lock_irq(&ehci
->lock
);
340 if (ehci
->enabled_hrtimer_events
& BIT(EHCI_HRTIMER_POLL_DEAD
))
341 ehci_handle_controller_death(ehci
);
342 if (ehci
->rh_state
!= EHCI_RH_RUNNING
)
344 ehci
->rh_state
= EHCI_RH_SUSPENDED
;
346 unlink_empty_async_suspended(ehci
);
348 /* Any IAA cycle that started before the suspend is now invalid */
350 ehci_handle_start_intr_unlinks(ehci
);
351 ehci_handle_intr_unlinks(ehci
);
354 /* allow remote wakeup */
356 if (!hcd
->self
.root_hub
->do_remote_wakeup
)
358 ehci_writel(ehci
, mask
, &ehci
->regs
->intr_enable
);
359 ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
362 ehci
->next_statechange
= jiffies
+ msecs_to_jiffies(10);
363 ehci
->enabled_hrtimer_events
= 0;
364 ehci
->next_hrtimer_event
= EHCI_HRTIMER_NO_EVENT
;
365 spin_unlock_irq (&ehci
->lock
);
367 hrtimer_cancel(&ehci
->hrtimer
);
372 /* caller has locked the root hub, and should reset/reinit on error */
373 static int ehci_bus_resume (struct usb_hcd
*hcd
)
375 struct ehci_hcd
*ehci
= hcd_to_ehci (hcd
);
379 unsigned long resume_needed
= 0;
381 if (time_before (jiffies
, ehci
->next_statechange
))
383 spin_lock_irq (&ehci
->lock
);
384 if (!HCD_HW_ACCESSIBLE(hcd
) || ehci
->shutdown
)
387 if (unlikely(ehci
->debug
)) {
388 if (!dbgp_reset_prep(hcd
))
391 dbgp_external_startup(hcd
);
394 /* Ideally and we've got a real resume here, and no port's power
395 * was lost. (For PCI, that means Vaux was maintained.) But we
396 * could instead be restoring a swsusp snapshot -- so that BIOS was
397 * the last user of the controller, not reset/pm hardware keeping
398 * state we gave to it.
400 power_okay
= ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
401 ehci_dbg(ehci
, "resume root hub%s\n",
402 power_okay
? "" : " after power loss");
404 /* at least some APM implementations will try to deliver
405 * IRQs right away, so delay them until we're ready.
407 ehci_writel(ehci
, 0, &ehci
->regs
->intr_enable
);
409 /* re-init operational registers */
410 ehci_writel(ehci
, 0, &ehci
->regs
->segment
);
411 ehci_writel(ehci
, ehci
->periodic_dma
, &ehci
->regs
->frame_list
);
412 ehci_writel(ehci
, (u32
) ehci
->async
->qh_dma
, &ehci
->regs
->async_next
);
414 /* restore CMD_RUN, framelist size, and irq threshold */
415 ehci
->command
|= CMD_RUN
;
416 ehci_writel(ehci
, ehci
->command
, &ehci
->regs
->command
);
417 ehci
->rh_state
= EHCI_RH_RUNNING
;
420 * According to Bugzilla #8190, the port status for some controllers
421 * will be wrong without a delay. At their wrong status, the port
422 * is enabled, but not suspended neither resumed.
424 i
= HCS_N_PORTS(ehci
->hcs_params
);
426 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
427 if ((temp
& PORT_PE
) &&
428 !(temp
& (PORT_SUSPEND
| PORT_RESUME
))) {
429 ehci_dbg(ehci
, "Port status(0x%x) is wrong\n", temp
);
430 spin_unlock_irq(&ehci
->lock
);
432 spin_lock_irq(&ehci
->lock
);
440 /* clear phy low-power mode before resume */
441 if (ehci
->bus_suspended
&& ehci
->has_tdi_phy_lpm
) {
442 i
= HCS_N_PORTS(ehci
->hcs_params
);
444 if (test_bit(i
, &ehci
->bus_suspended
)) {
445 u32 __iomem
*hostpc_reg
=
446 &ehci
->regs
->hostpc
[i
];
448 temp
= ehci_readl(ehci
, hostpc_reg
);
449 ehci_writel(ehci
, temp
& ~HOSTPC_PHCD
,
453 spin_unlock_irq(&ehci
->lock
);
455 spin_lock_irq(&ehci
->lock
);
460 /* manually resume the ports we suspended during bus_suspend() */
461 i
= HCS_N_PORTS (ehci
->hcs_params
);
463 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
464 temp
&= ~(PORT_RWC_BITS
| PORT_WAKE_BITS
);
465 if (test_bit(i
, &ehci
->bus_suspended
) &&
466 (temp
& PORT_SUSPEND
)) {
468 set_bit(i
, &resume_needed
);
470 ehci_writel(ehci
, temp
, &ehci
->regs
->port_status
[i
]);
474 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
478 spin_unlock_irq(&ehci
->lock
);
479 msleep(USB_RESUME_TIMEOUT
);
480 spin_lock_irq(&ehci
->lock
);
485 i
= HCS_N_PORTS (ehci
->hcs_params
);
487 temp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[i
]);
488 if (test_bit(i
, &resume_needed
)) {
489 temp
&= ~(PORT_RWC_BITS
| PORT_SUSPEND
| PORT_RESUME
);
490 ehci_writel(ehci
, temp
, &ehci
->regs
->port_status
[i
]);
494 ehci
->next_statechange
= jiffies
+ msecs_to_jiffies(5);
495 spin_unlock_irq(&ehci
->lock
);
497 ehci_handover_companion_ports(ehci
);
499 /* Now we can safely re-enable irqs */
500 spin_lock_irq(&ehci
->lock
);
503 ehci_writel(ehci
, INTR_MASK
, &ehci
->regs
->intr_enable
);
504 (void) ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
505 spin_unlock_irq(&ehci
->lock
);
510 spin_unlock_irq(&ehci
->lock
);
514 static unsigned long ehci_get_resuming_ports(struct usb_hcd
*hcd
)
516 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
518 return ehci
->resuming_ports
;
523 #define ehci_bus_suspend NULL
524 #define ehci_bus_resume NULL
525 #define ehci_get_resuming_ports 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(
786 sizeof(struct usb_ctrlrequest
),
788 urb
->transfer_dma
= dma_map_single(
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 if (ehci_has_fsl_susp_errata(ehci
)) {
1206 /* 10ms for HCD enter suspend */
1207 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1208 usleep_range(10000, 20000);
1209 spin_lock_irqsave(&ehci
->lock
, flags
);
1211 set_bit(wIndex
, &ehci
->suspended_ports
);
1213 case USB_PORT_FEAT_POWER
:
1214 if (HCS_PPC(ehci
->hcs_params
)) {
1215 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1216 ehci_port_power(ehci
, wIndex
, true);
1217 spin_lock_irqsave(&ehci
->lock
, flags
);
1220 case USB_PORT_FEAT_RESET
:
1221 if (temp
& (PORT_SUSPEND
|PORT_RESUME
))
1223 /* line status bits may report this as low speed,
1224 * which can be fine if this root hub has a
1225 * transaction translator built in.
1227 if ((temp
& (PORT_PE
|PORT_CONNECT
)) == PORT_CONNECT
1228 && !ehci_is_TDI(ehci
)
1229 && PORT_USB11 (temp
)) {
1231 "port %d low speed --> companion\n",
1239 * caller must wait, then call GetPortStatus
1240 * usb 2.0 spec says 50 ms resets on root
1242 ehci
->reset_done
[wIndex
] = jiffies
1243 + msecs_to_jiffies (50);
1246 * Force full-speed connect for FSL high-speed
1247 * erratum; disable HS Chirp by setting PFSC bit
1249 if (ehci_has_fsl_hs_errata(ehci
))
1250 temp
|= (1 << PORTSC_FSL_PFSC
);
1252 ehci_writel(ehci
, temp
, status_reg
);
1255 /* For downstream facing ports (these): one hub port is put
1256 * into test mode according to USB2 11.24.2.13, then the hub
1257 * must be reset (which for root hub now means rmmod+modprobe,
1258 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1259 * about the EHCI-specific stuff.
1261 case USB_PORT_FEAT_TEST
:
1262 #ifdef CONFIG_USB_HCD_TEST_MODE
1263 if (selector
== EHSET_TEST_SINGLE_STEP_SET_FEATURE
) {
1264 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1265 retval
= ehset_single_step_set_feature(hcd
,
1267 spin_lock_irqsave(&ehci
->lock
, flags
);
1271 if (!selector
|| selector
> 5)
1273 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1275 spin_lock_irqsave(&ehci
->lock
, flags
);
1277 /* Put all enabled ports into suspend */
1280 &ehci
->regs
->port_status
[ports
];
1282 temp
= ehci_readl(ehci
, sreg
) & ~PORT_RWC_BITS
;
1284 ehci_writel(ehci
, temp
| PORT_SUSPEND
,
1288 spin_unlock_irqrestore(&ehci
->lock
, flags
);
1290 spin_lock_irqsave(&ehci
->lock
, flags
);
1292 temp
= ehci_readl(ehci
, status_reg
);
1293 temp
|= selector
<< 16;
1294 ehci_writel(ehci
, temp
, status_reg
);
1300 ehci_readl(ehci
, &ehci
->regs
->command
); /* unblock posted writes */
1305 /* "stall" on error */
1309 spin_unlock_irqrestore (&ehci
->lock
, flags
);
1312 EXPORT_SYMBOL_GPL(ehci_hub_control
);
1314 static void ehci_relinquish_port(struct usb_hcd
*hcd
, int portnum
)
1316 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1318 if (ehci_is_TDI(ehci
))
1320 set_owner(ehci
, --portnum
, PORT_OWNER
);
1323 static int ehci_port_handed_over(struct usb_hcd
*hcd
, int portnum
)
1325 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
1328 if (ehci_is_TDI(ehci
))
1330 reg
= &ehci
->regs
->port_status
[portnum
- 1];
1331 return ehci_readl(ehci
, reg
) & PORT_OWNER
;
1334 static int ehci_port_power(struct ehci_hcd
*ehci
, int portnum
, bool enable
)
1336 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
1337 u32 __iomem
*status_reg
= &ehci
->regs
->port_status
[portnum
];
1338 u32 temp
= ehci_readl(ehci
, status_reg
) & ~PORT_RWC_BITS
;
1341 ehci_writel(ehci
, temp
| PORT_POWER
, status_reg
);
1343 ehci_writel(ehci
, temp
& ~PORT_POWER
, status_reg
);
1345 if (hcd
->driver
->port_power
)
1346 hcd
->driver
->port_power(hcd
, portnum
, enable
);