1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/kcov.h>
22 #include <linux/ioctl.h>
23 #include <linux/usb.h>
24 #include <linux/usbdevice_fs.h>
25 #include <linux/usb/hcd.h>
26 #include <linux/usb/onboard_hub.h>
27 #include <linux/usb/otg.h>
28 #include <linux/usb/quirks.h>
29 #include <linux/workqueue.h>
30 #include <linux/mutex.h>
31 #include <linux/random.h>
32 #include <linux/pm_qos.h>
33 #include <linux/kobject.h>
35 #include <linux/bitfield.h>
36 #include <linux/uaccess.h>
37 #include <asm/byteorder.h>
40 #include "otg_productlist.h"
42 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
43 #define USB_VENDOR_SMSC 0x0424
44 #define USB_PRODUCT_USB5534B 0x5534
45 #define USB_VENDOR_CYPRESS 0x04b4
46 #define USB_PRODUCT_CY7C65632 0x6570
47 #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
48 #define USB_PRODUCT_TUSB8041_USB3 0x8140
49 #define USB_PRODUCT_TUSB8041_USB2 0x8142
50 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
51 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
53 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
54 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
55 #define USB_PING_RESPONSE_TIME 400 /* ns */
57 /* Protect struct usb_device->state and ->children members
58 * Note: Both are also protected by ->dev.sem, except that ->state can
59 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
60 static DEFINE_SPINLOCK(device_state_lock
);
62 /* workqueue to process hub events */
63 static struct workqueue_struct
*hub_wq
;
64 static void hub_event(struct work_struct
*work
);
66 /* synchronize hub-port add/remove and peering operations */
67 DEFINE_MUTEX(usb_port_peer_mutex
);
69 /* cycle leds on hubs that aren't blinking for attention */
70 static bool blinkenlights
;
71 module_param(blinkenlights
, bool, S_IRUGO
);
72 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
75 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
76 * 10 seconds to send reply for the initial 64-byte descriptor request.
78 /* define initial 64-byte descriptor request timeout in milliseconds */
79 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
80 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
81 MODULE_PARM_DESC(initial_descriptor_timeout
,
82 "initial 64-byte descriptor request timeout in milliseconds "
83 "(default 5000 - 5.0 seconds)");
86 * As of 2.6.10 we introduce a new USB device initialization scheme which
87 * closely resembles the way Windows works. Hopefully it will be compatible
88 * with a wider range of devices than the old scheme. However some previously
89 * working devices may start giving rise to "device not accepting address"
90 * errors; if that happens the user can try the old scheme by adjusting the
91 * following module parameters.
93 * For maximum flexibility there are two boolean parameters to control the
94 * hub driver's behavior. On the first initialization attempt, if the
95 * "old_scheme_first" parameter is set then the old scheme will be used,
96 * otherwise the new scheme is used. If that fails and "use_both_schemes"
97 * is set, then the driver will make another attempt, using the other scheme.
99 static bool old_scheme_first
;
100 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
101 MODULE_PARM_DESC(old_scheme_first
,
102 "start with the old device initialization scheme");
104 static bool use_both_schemes
= true;
105 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
106 MODULE_PARM_DESC(use_both_schemes
,
107 "try the other device initialization scheme if the "
110 /* Mutual exclusion for EHCI CF initialization. This interferes with
111 * port reset on some companion controllers.
113 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
114 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
116 #define HUB_DEBOUNCE_TIMEOUT 2000
117 #define HUB_DEBOUNCE_STEP 25
118 #define HUB_DEBOUNCE_STABLE 100
120 static void hub_release(struct kref
*kref
);
121 static int usb_reset_and_verify_device(struct usb_device
*udev
);
122 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
123 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
126 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
128 if (hub_is_superspeedplus(hub
->hdev
))
130 if (hub_is_superspeed(hub
->hdev
))
132 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
134 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
140 /* Note that hdev or one of its children must be locked! */
141 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
143 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
145 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
148 int usb_device_supports_lpm(struct usb_device
*udev
)
150 /* Some devices have trouble with LPM */
151 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
154 /* Skip if the device BOS descriptor couldn't be read */
158 /* USB 2.1 (and greater) devices indicate LPM support through
159 * their USB 2.0 Extended Capabilities BOS descriptor.
161 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
162 if (udev
->bos
->ext_cap
&&
164 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
170 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
171 * However, there are some that don't, and they set the U1/U2 exit
174 if (!udev
->bos
->ss_cap
) {
175 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
179 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
180 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
182 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
184 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
188 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
194 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
195 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
196 * See USB 3.1 section C.1.5.2
198 static void usb_set_lpm_mel(struct usb_device
*udev
,
199 struct usb3_lpm_parameters
*udev_lpm_params
,
200 unsigned int udev_exit_latency
,
202 struct usb3_lpm_parameters
*hub_lpm_params
,
203 unsigned int hub_exit_latency
)
205 unsigned int total_mel
;
208 * tMEL1. time to transition path from host to device into U0.
209 * MEL for parent already contains the delay up to parent, so only add
210 * the exit latency for the last link (pick the slower exit latency),
211 * and the hub header decode latency. See USB 3.1 section C 2.2.1
212 * Store MEL in nanoseconds
214 total_mel
= hub_lpm_params
->mel
+
215 max(udev_exit_latency
, hub_exit_latency
) * 1000 +
216 hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100;
219 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
220 * each link + wHubDelay for each hub. Add only for last link.
221 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
222 * Multiply by 2 to include it as well.
224 total_mel
+= (__le16_to_cpu(hub
->descriptor
->u
.ss
.wHubDelay
) +
225 USB_TP_TRANSMISSION_DELAY
) * 2;
228 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
229 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
230 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
232 * Note these delays should be added only once for the entire path, so
233 * add them to the MEL of the device connected to the roothub.
235 if (!hub
->hdev
->parent
)
236 total_mel
+= USB_PING_RESPONSE_TIME
+ 2100;
238 udev_lpm_params
->mel
= total_mel
;
242 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
243 * a transition from either U1 or U2.
245 static void usb_set_lpm_pel(struct usb_device
*udev
,
246 struct usb3_lpm_parameters
*udev_lpm_params
,
247 unsigned int udev_exit_latency
,
249 struct usb3_lpm_parameters
*hub_lpm_params
,
250 unsigned int hub_exit_latency
,
251 unsigned int port_to_port_exit_latency
)
253 unsigned int first_link_pel
;
254 unsigned int hub_pel
;
257 * First, the device sends an LFPS to transition the link between the
258 * device and the parent hub into U0. The exit latency is the bigger of
259 * the device exit latency or the hub exit latency.
261 if (udev_exit_latency
> hub_exit_latency
)
262 first_link_pel
= udev_exit_latency
* 1000;
264 first_link_pel
= hub_exit_latency
* 1000;
267 * When the hub starts to receive the LFPS, there is a slight delay for
268 * it to figure out that one of the ports is sending an LFPS. Then it
269 * will forward the LFPS to its upstream link. The exit latency is the
270 * delay, plus the PEL that we calculated for this hub.
272 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
275 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
276 * is the greater of the two exit latencies.
278 if (first_link_pel
> hub_pel
)
279 udev_lpm_params
->pel
= first_link_pel
;
281 udev_lpm_params
->pel
= hub_pel
;
285 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
286 * when a device initiates a transition to U0, until when it will receive the
287 * first packet from the host controller.
289 * Section C.1.5.1 describes the four components to this:
291 * - t2: time for the ERDY to make it from the device to the host.
292 * - t3: a host-specific delay to process the ERDY.
293 * - t4: time for the packet to make it from the host to the device.
295 * t3 is specific to both the xHCI host and the platform the host is integrated
296 * into. The Intel HW folks have said it's negligible, FIXME if a different
297 * vendor says otherwise.
299 static void usb_set_lpm_sel(struct usb_device
*udev
,
300 struct usb3_lpm_parameters
*udev_lpm_params
)
302 struct usb_device
*parent
;
303 unsigned int num_hubs
;
304 unsigned int total_sel
;
306 /* t1 = device PEL */
307 total_sel
= udev_lpm_params
->pel
;
308 /* How many external hubs are in between the device & the root port. */
309 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
310 parent
= parent
->parent
)
312 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
314 total_sel
+= 2100 + 250 * (num_hubs
- 1);
316 /* t4 = 250ns * num_hubs */
317 total_sel
+= 250 * num_hubs
;
319 udev_lpm_params
->sel
= total_sel
;
322 static void usb_set_lpm_parameters(struct usb_device
*udev
)
325 unsigned int port_to_port_delay
;
326 unsigned int udev_u1_del
;
327 unsigned int udev_u2_del
;
328 unsigned int hub_u1_del
;
329 unsigned int hub_u2_del
;
331 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
334 /* Skip if the device BOS descriptor couldn't be read */
338 hub
= usb_hub_to_struct_hub(udev
->parent
);
339 /* It doesn't take time to transition the roothub into U0, since it
340 * doesn't have an upstream link.
345 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
346 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
347 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
348 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
350 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
351 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
353 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
354 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
357 * Appendix C, section C.2.2.2, says that there is a slight delay from
358 * when the parent hub notices the downstream port is trying to
359 * transition to U0 to when the hub initiates a U0 transition on its
360 * upstream port. The section says the delays are tPort2PortU1EL and
361 * tPort2PortU2EL, but it doesn't define what they are.
363 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
364 * about the same delays. Use the maximum delay calculations from those
365 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
366 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
367 * assume the device exit latencies they are talking about are the hub
370 * What do we do if the U2 exit latency is less than the U1 exit
371 * latency? It's possible, although not likely...
373 port_to_port_delay
= 1;
375 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
376 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
379 if (hub_u2_del
> hub_u1_del
)
380 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
382 port_to_port_delay
= 1 + hub_u1_del
;
384 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
385 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
388 /* Now that we've got PEL, calculate SEL. */
389 usb_set_lpm_sel(udev
, &udev
->u1_params
);
390 usb_set_lpm_sel(udev
, &udev
->u2_params
);
393 /* USB 2.0 spec Section 11.24.4.5 */
394 static int get_hub_descriptor(struct usb_device
*hdev
,
395 struct usb_hub_descriptor
*desc
)
400 if (hub_is_superspeed(hdev
)) {
401 dtype
= USB_DT_SS_HUB
;
402 size
= USB_DT_SS_HUB_SIZE
;
405 size
= sizeof(struct usb_hub_descriptor
);
408 for (i
= 0; i
< 3; i
++) {
409 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
410 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
411 dtype
<< 8, 0, desc
, size
,
412 USB_CTRL_GET_TIMEOUT
);
413 if (hub_is_superspeed(hdev
)) {
416 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
417 /* Make sure we have the DeviceRemovable field. */
418 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
428 * USB 2.0 spec Section 11.24.2.1
430 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
432 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
433 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
437 * USB 2.0 spec Section 11.24.2.2
439 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
441 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
442 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
447 * USB 2.0 spec Section 11.24.2.13
449 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
451 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
452 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
456 static char *to_led_name(int selector
)
473 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
474 * for info about using port indicators
476 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
478 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
481 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
482 USB_PORT_FEAT_INDICATOR
);
483 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
484 to_led_name(selector
), status
);
487 #define LED_CYCLE_PERIOD ((2*HZ)/3)
489 static void led_work(struct work_struct
*work
)
491 struct usb_hub
*hub
=
492 container_of(work
, struct usb_hub
, leds
.work
);
493 struct usb_device
*hdev
= hub
->hdev
;
495 unsigned changed
= 0;
498 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
501 for (i
= 0; i
< hdev
->maxchild
; i
++) {
502 unsigned selector
, mode
;
504 /* 30%-50% duty cycle */
506 switch (hub
->indicator
[i
]) {
508 case INDICATOR_CYCLE
:
510 selector
= HUB_LED_AUTO
;
511 mode
= INDICATOR_AUTO
;
513 /* blinking green = sw attention */
514 case INDICATOR_GREEN_BLINK
:
515 selector
= HUB_LED_GREEN
;
516 mode
= INDICATOR_GREEN_BLINK_OFF
;
518 case INDICATOR_GREEN_BLINK_OFF
:
519 selector
= HUB_LED_OFF
;
520 mode
= INDICATOR_GREEN_BLINK
;
522 /* blinking amber = hw attention */
523 case INDICATOR_AMBER_BLINK
:
524 selector
= HUB_LED_AMBER
;
525 mode
= INDICATOR_AMBER_BLINK_OFF
;
527 case INDICATOR_AMBER_BLINK_OFF
:
528 selector
= HUB_LED_OFF
;
529 mode
= INDICATOR_AMBER_BLINK
;
531 /* blink green/amber = reserved */
532 case INDICATOR_ALT_BLINK
:
533 selector
= HUB_LED_GREEN
;
534 mode
= INDICATOR_ALT_BLINK_OFF
;
536 case INDICATOR_ALT_BLINK_OFF
:
537 selector
= HUB_LED_AMBER
;
538 mode
= INDICATOR_ALT_BLINK
;
543 if (selector
!= HUB_LED_AUTO
)
545 set_port_led(hub
, i
+ 1, selector
);
546 hub
->indicator
[i
] = mode
;
548 if (!changed
&& blinkenlights
) {
550 cursor
%= hdev
->maxchild
;
551 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
552 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
556 queue_delayed_work(system_power_efficient_wq
,
557 &hub
->leds
, LED_CYCLE_PERIOD
);
560 /* use a short timeout for hub/port status fetches */
561 #define USB_STS_TIMEOUT 1000
562 #define USB_STS_RETRIES 5
565 * USB 2.0 spec Section 11.24.2.6
567 static int get_hub_status(struct usb_device
*hdev
,
568 struct usb_hub_status
*data
)
570 int i
, status
= -ETIMEDOUT
;
572 for (i
= 0; i
< USB_STS_RETRIES
&&
573 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
574 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
575 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
576 data
, sizeof(*data
), USB_STS_TIMEOUT
);
582 * USB 2.0 spec Section 11.24.2.7
583 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
585 static int get_port_status(struct usb_device
*hdev
, int port1
,
586 void *data
, u16 value
, u16 length
)
588 int i
, status
= -ETIMEDOUT
;
590 for (i
= 0; i
< USB_STS_RETRIES
&&
591 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
592 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
593 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
594 port1
, data
, length
, USB_STS_TIMEOUT
);
599 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
600 u16
*status
, u16
*change
, u32
*ext_status
)
605 if (type
!= HUB_PORT_STATUS
)
608 mutex_lock(&hub
->status_mutex
);
609 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
612 dev_err(hub
->intfdev
,
613 "%s failed (err = %d)\n", __func__
, ret
);
617 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
618 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
619 if (type
!= HUB_PORT_STATUS
&& ext_status
)
620 *ext_status
= le32_to_cpu(
621 hub
->status
->port
.dwExtPortStatus
);
624 mutex_unlock(&hub
->status_mutex
);
627 * There is no need to lock status_mutex here, because status_mutex
628 * protects hub->status, and the phy driver only checks the port
629 * status without changing the status.
632 struct usb_device
*hdev
= hub
->hdev
;
635 * Only roothub will be notified of port state changes,
636 * since the USB PHY only cares about changes at the next
639 if (is_root_hub(hdev
)) {
640 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
643 usb_phy_notify_port_status(hcd
->usb_phy
,
644 port1
- 1, *status
, *change
);
651 int usb_hub_port_status(struct usb_hub
*hub
, int port1
,
652 u16
*status
, u16
*change
)
654 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
655 status
, change
, NULL
);
658 static void hub_resubmit_irq_urb(struct usb_hub
*hub
)
663 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
665 if (hub
->quiescing
) {
666 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
670 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
671 if (status
&& status
!= -ENODEV
&& status
!= -EPERM
&&
672 status
!= -ESHUTDOWN
) {
673 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
674 mod_timer(&hub
->irq_urb_retry
, jiffies
+ HZ
);
677 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
680 static void hub_retry_irq_urb(struct timer_list
*t
)
682 struct usb_hub
*hub
= from_timer(hub
, t
, irq_urb_retry
);
684 hub_resubmit_irq_urb(hub
);
688 static void kick_hub_wq(struct usb_hub
*hub
)
690 struct usb_interface
*intf
;
692 if (hub
->disconnected
|| work_pending(&hub
->events
))
696 * Suppress autosuspend until the event is proceed.
698 * Be careful and make sure that the symmetric operation is
699 * always called. We are here only when there is no pending
700 * work for this hub. Therefore put the interface either when
701 * the new work is called or when it is canceled.
703 intf
= to_usb_interface(hub
->intfdev
);
704 usb_autopm_get_interface_no_resume(intf
);
705 kref_get(&hub
->kref
);
707 if (queue_work(hub_wq
, &hub
->events
))
710 /* the work has already been scheduled */
711 usb_autopm_put_interface_async(intf
);
712 kref_put(&hub
->kref
, hub_release
);
715 void usb_kick_hub_wq(struct usb_device
*hdev
)
717 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
724 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
725 * Notification, which indicates it had initiated remote wakeup.
727 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
728 * device initiates resume, so the USB core will not receive notice of the
729 * resume through the normal hub interrupt URB.
731 void usb_wakeup_notification(struct usb_device
*hdev
,
732 unsigned int portnum
)
735 struct usb_port
*port_dev
;
740 hub
= usb_hub_to_struct_hub(hdev
);
742 port_dev
= hub
->ports
[portnum
- 1];
743 if (port_dev
&& port_dev
->child
)
744 pm_wakeup_event(&port_dev
->child
->dev
, 0);
746 set_bit(portnum
, hub
->wakeup_bits
);
750 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
752 /* completion function, fires on port status changes and various faults */
753 static void hub_irq(struct urb
*urb
)
755 struct usb_hub
*hub
= urb
->context
;
756 int status
= urb
->status
;
761 case -ENOENT
: /* synchronous unlink */
762 case -ECONNRESET
: /* async unlink */
763 case -ESHUTDOWN
: /* hardware going away */
766 default: /* presumably an error */
767 /* Cause a hub reset after 10 consecutive errors */
768 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
769 if ((++hub
->nerrors
< 10) || hub
->error
)
774 /* let hub_wq handle things */
775 case 0: /* we got data: port status changed */
777 for (i
= 0; i
< urb
->actual_length
; ++i
)
778 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
780 hub
->event_bits
[0] = bits
;
786 /* Something happened, let hub_wq figure it out */
790 hub_resubmit_irq_urb(hub
);
793 /* USB 2.0 spec Section 11.24.2.3 */
795 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
797 /* Need to clear both directions for control ep */
798 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
799 USB_ENDPOINT_XFER_CONTROL
) {
800 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
801 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
802 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
806 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
807 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
812 * enumeration blocks hub_wq for a long time. we use keventd instead, since
813 * long blocking there is the exception, not the rule. accordingly, HCDs
814 * talking to TTs must queue control transfers (not just bulk and iso), so
815 * both can talk to the same hub concurrently.
817 static void hub_tt_work(struct work_struct
*work
)
819 struct usb_hub
*hub
=
820 container_of(work
, struct usb_hub
, tt
.clear_work
);
823 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
824 while (!list_empty(&hub
->tt
.clear_list
)) {
825 struct list_head
*next
;
826 struct usb_tt_clear
*clear
;
827 struct usb_device
*hdev
= hub
->hdev
;
828 const struct hc_driver
*drv
;
831 next
= hub
->tt
.clear_list
.next
;
832 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
833 list_del(&clear
->clear_list
);
835 /* drop lock so HCD can concurrently report other TT errors */
836 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
837 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
838 if (status
&& status
!= -ENODEV
)
840 "clear tt %d (%04x) error %d\n",
841 clear
->tt
, clear
->devinfo
, status
);
843 /* Tell the HCD, even if the operation failed */
844 drv
= clear
->hcd
->driver
;
845 if (drv
->clear_tt_buffer_complete
)
846 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
849 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
851 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
855 * usb_hub_set_port_power - control hub port's power state
856 * @hdev: USB device belonging to the usb hub
859 * @set: expected status
861 * call this function to control port's power via setting or
862 * clearing the port's PORT_POWER feature.
864 * Return: 0 if successful. A negative error code otherwise.
866 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
872 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
874 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
880 set_bit(port1
, hub
->power_bits
);
882 clear_bit(port1
, hub
->power_bits
);
887 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
888 * @urb: an URB associated with the failed or incomplete split transaction
890 * High speed HCDs use this to tell the hub driver that some split control or
891 * bulk transaction failed in a way that requires clearing internal state of
892 * a transaction translator. This is normally detected (and reported) from
895 * It may not be possible for that hub to handle additional full (or low)
896 * speed transactions until that state is fully cleared out.
898 * Return: 0 if successful. A negative error code otherwise.
900 int usb_hub_clear_tt_buffer(struct urb
*urb
)
902 struct usb_device
*udev
= urb
->dev
;
903 int pipe
= urb
->pipe
;
904 struct usb_tt
*tt
= udev
->tt
;
906 struct usb_tt_clear
*clear
;
908 /* we've got to cope with an arbitrary number of pending TT clears,
909 * since each TT has "at least two" buffers that can need it (and
910 * there can be many TTs per hub). even if they're uncommon.
912 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
914 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
915 /* FIXME recover somehow ... RESET_TT? */
919 /* info that CLEAR_TT_BUFFER needs */
920 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
921 clear
->devinfo
= usb_pipeendpoint (pipe
);
922 clear
->devinfo
|= ((u16
)udev
->devaddr
) << 4;
923 clear
->devinfo
|= usb_pipecontrol(pipe
)
924 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
925 : (USB_ENDPOINT_XFER_BULK
<< 11);
926 if (usb_pipein(pipe
))
927 clear
->devinfo
|= 1 << 15;
929 /* info for completion callback */
930 clear
->hcd
= bus_to_hcd(udev
->bus
);
933 /* tell keventd to clear state for this TT */
934 spin_lock_irqsave(&tt
->lock
, flags
);
935 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
936 schedule_work(&tt
->clear_work
);
937 spin_unlock_irqrestore(&tt
->lock
, flags
);
940 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
942 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
946 /* Enable power on each port. Some hubs have reserved values
947 * of LPSM (> 2) in their descriptors, even though they are
948 * USB 2.0 hubs. Some hubs do not implement port-power switching
949 * but only emulate it. In all cases, the ports won't work
950 * unless we send these messages to the hub.
952 if (hub_is_port_power_switchable(hub
))
953 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
955 dev_dbg(hub
->intfdev
, "trying to enable port power on "
956 "non-switchable hub\n");
957 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
958 if (test_bit(port1
, hub
->power_bits
))
959 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
961 usb_clear_port_feature(hub
->hdev
, port1
,
962 USB_PORT_FEAT_POWER
);
964 msleep(hub_power_on_good_delay(hub
));
967 static int hub_hub_status(struct usb_hub
*hub
,
968 u16
*status
, u16
*change
)
972 mutex_lock(&hub
->status_mutex
);
973 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
976 dev_err(hub
->intfdev
,
977 "%s failed (err = %d)\n", __func__
, ret
);
979 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
980 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
983 mutex_unlock(&hub
->status_mutex
);
987 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
988 unsigned int link_status
)
990 return set_port_feature(hub
->hdev
,
991 port1
| (link_status
<< 3),
992 USB_PORT_FEAT_LINK_STATE
);
996 * Disable a port and mark a logical connect-change event, so that some
997 * time later hub_wq will disconnect() any existing usb_device on the port
998 * and will re-enumerate if there actually is a device attached.
1000 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
1002 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
1003 hub_port_disable(hub
, port1
, 1);
1005 /* FIXME let caller ask to power down the port:
1006 * - some devices won't enumerate without a VBUS power cycle
1007 * - SRP saves power that way
1008 * - ... new call, TBD ...
1009 * That's easy if this hub can switch power per-port, and
1010 * hub_wq reactivates the port later (timer, SRP, etc).
1011 * Powerdown must be optional, because of reset/DFU.
1014 set_bit(port1
, hub
->change_bits
);
1019 * usb_remove_device - disable a device's port on its parent hub
1020 * @udev: device to be disabled and removed
1021 * Context: @udev locked, must be able to sleep.
1023 * After @udev's port has been disabled, hub_wq is notified and it will
1024 * see that the device has been disconnected. When the device is
1025 * physically unplugged and something is plugged in, the events will
1026 * be received and processed normally.
1028 * Return: 0 if successful. A negative error code otherwise.
1030 int usb_remove_device(struct usb_device
*udev
)
1032 struct usb_hub
*hub
;
1033 struct usb_interface
*intf
;
1036 if (!udev
->parent
) /* Can't remove a root hub */
1038 hub
= usb_hub_to_struct_hub(udev
->parent
);
1039 intf
= to_usb_interface(hub
->intfdev
);
1041 ret
= usb_autopm_get_interface(intf
);
1045 set_bit(udev
->portnum
, hub
->removed_bits
);
1046 hub_port_logical_disconnect(hub
, udev
->portnum
);
1047 usb_autopm_put_interface(intf
);
1051 enum hub_activation_type
{
1052 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1053 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1056 static void hub_init_func2(struct work_struct
*ws
);
1057 static void hub_init_func3(struct work_struct
*ws
);
1059 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1061 struct usb_device
*hdev
= hub
->hdev
;
1062 struct usb_hcd
*hcd
;
1066 bool need_debounce_delay
= false;
1069 /* Continue a partial initialization */
1070 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1071 device_lock(&hdev
->dev
);
1073 /* Was the hub disconnected while we were waiting? */
1074 if (hub
->disconnected
)
1076 if (type
== HUB_INIT2
)
1080 kref_get(&hub
->kref
);
1082 /* The superspeed hub except for root hub has to use Hub Depth
1083 * value as an offset into the route string to locate the bits
1084 * it uses to determine the downstream port number. So hub driver
1085 * should send a set hub depth request to superspeed hub after
1086 * the superspeed hub is set configuration in initialization or
1089 * After a resume, port power should still be on.
1090 * For any other type of activation, turn it on.
1092 if (type
!= HUB_RESUME
) {
1093 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1094 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1095 HUB_SET_DEPTH
, USB_RT_HUB
,
1096 hdev
->level
- 1, 0, NULL
, 0,
1097 USB_CTRL_SET_TIMEOUT
);
1099 dev_err(hub
->intfdev
,
1100 "set hub depth failed\n");
1103 /* Speed up system boot by using a delayed_work for the
1104 * hub's initial power-up delays. This is pretty awkward
1105 * and the implementation looks like a home-brewed sort of
1106 * setjmp/longjmp, but it saves at least 100 ms for each
1107 * root hub (assuming usbcore is compiled into the kernel
1108 * rather than as a module). It adds up.
1110 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1111 * because for those activation types the ports have to be
1112 * operational when we return. In theory this could be done
1113 * for HUB_POST_RESET, but it's easier not to.
1115 if (type
== HUB_INIT
) {
1116 delay
= hub_power_on_good_delay(hub
);
1118 hub_power_on(hub
, false);
1119 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1120 queue_delayed_work(system_power_efficient_wq
,
1122 msecs_to_jiffies(delay
));
1124 /* Suppress autosuspend until init is done */
1125 usb_autopm_get_interface_no_resume(
1126 to_usb_interface(hub
->intfdev
));
1127 return; /* Continues at init2: below */
1128 } else if (type
== HUB_RESET_RESUME
) {
1129 /* The internal host controller state for the hub device
1130 * may be gone after a host power loss on system resume.
1131 * Update the device's info so the HW knows it's a hub.
1133 hcd
= bus_to_hcd(hdev
->bus
);
1134 if (hcd
->driver
->update_hub_device
) {
1135 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1136 &hub
->tt
, GFP_NOIO
);
1138 dev_err(hub
->intfdev
,
1139 "Host not accepting hub info update\n");
1140 dev_err(hub
->intfdev
,
1141 "LS/FS devices and hubs may not work under this hub\n");
1144 hub_power_on(hub
, true);
1146 hub_power_on(hub
, true);
1148 /* Give some time on remote wakeup to let links to transit to U0 */
1149 } else if (hub_is_superspeed(hub
->hdev
))
1155 * Check each port and set hub->change_bits to let hub_wq know
1156 * which ports need attention.
1158 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1159 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1160 struct usb_device
*udev
= port_dev
->child
;
1161 u16 portstatus
, portchange
;
1163 portstatus
= portchange
= 0;
1164 status
= usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1168 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1169 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1170 portstatus
, portchange
);
1173 * After anything other than HUB_RESUME (i.e., initialization
1174 * or any sort of reset), every port should be disabled.
1175 * Unconnected ports should likewise be disabled (paranoia),
1176 * and so should ports for which we have no usb_device.
1178 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1179 type
!= HUB_RESUME
||
1180 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1182 udev
->state
== USB_STATE_NOTATTACHED
)) {
1184 * USB3 protocol ports will automatically transition
1185 * to Enabled state when detect an USB3.0 device attach.
1186 * Do not disable USB3 protocol ports, just pretend
1189 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1190 if (!hub_is_superspeed(hdev
))
1191 usb_clear_port_feature(hdev
, port1
,
1192 USB_PORT_FEAT_ENABLE
);
1195 /* Make sure a warm-reset request is handled by port_event */
1196 if (type
== HUB_RESUME
&&
1197 hub_port_warm_reset_required(hub
, port1
, portstatus
))
1198 set_bit(port1
, hub
->event_bits
);
1201 * Add debounce if USB3 link is in polling/link training state.
1202 * Link will automatically transition to Enabled state after
1203 * link training completes.
1205 if (hub_is_superspeed(hdev
) &&
1206 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1207 USB_SS_PORT_LS_POLLING
))
1208 need_debounce_delay
= true;
1210 /* Clear status-change flags; we'll debounce later */
1211 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1212 need_debounce_delay
= true;
1213 usb_clear_port_feature(hub
->hdev
, port1
,
1214 USB_PORT_FEAT_C_CONNECTION
);
1216 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1217 need_debounce_delay
= true;
1218 usb_clear_port_feature(hub
->hdev
, port1
,
1219 USB_PORT_FEAT_C_ENABLE
);
1221 if (portchange
& USB_PORT_STAT_C_RESET
) {
1222 need_debounce_delay
= true;
1223 usb_clear_port_feature(hub
->hdev
, port1
,
1224 USB_PORT_FEAT_C_RESET
);
1226 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1227 hub_is_superspeed(hub
->hdev
)) {
1228 need_debounce_delay
= true;
1229 usb_clear_port_feature(hub
->hdev
, port1
,
1230 USB_PORT_FEAT_C_BH_PORT_RESET
);
1232 /* We can forget about a "removed" device when there's a
1233 * physical disconnect or the connect status changes.
1235 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1236 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1237 clear_bit(port1
, hub
->removed_bits
);
1239 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1240 /* Tell hub_wq to disconnect the device or
1241 * check for a new connection or over current condition.
1242 * Based on USB2.0 Spec Section 11.12.5,
1243 * C_PORT_OVER_CURRENT could be set while
1244 * PORT_OVER_CURRENT is not. So check for any of them.
1246 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1247 (portchange
& USB_PORT_STAT_C_CONNECTION
) ||
1248 (portstatus
& USB_PORT_STAT_OVERCURRENT
) ||
1249 (portchange
& USB_PORT_STAT_C_OVERCURRENT
))
1250 set_bit(port1
, hub
->change_bits
);
1252 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1253 bool port_resumed
= (portstatus
&
1254 USB_PORT_STAT_LINK_STATE
) ==
1256 /* The power session apparently survived the resume.
1257 * If there was an overcurrent or suspend change
1258 * (i.e., remote wakeup request), have hub_wq
1259 * take care of it. Look at the port link state
1260 * for USB 3.0 hubs, since they don't have a suspend
1261 * change bit, and they don't set the port link change
1262 * bit on device-initiated resume.
1264 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1266 set_bit(port1
, hub
->event_bits
);
1268 } else if (udev
->persist_enabled
) {
1270 udev
->reset_resume
= 1;
1272 /* Don't set the change_bits when the device
1275 if (test_bit(port1
, hub
->power_bits
))
1276 set_bit(port1
, hub
->change_bits
);
1279 /* The power session is gone; tell hub_wq */
1280 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1281 set_bit(port1
, hub
->change_bits
);
1285 /* If no port-status-change flags were set, we don't need any
1286 * debouncing. If flags were set we can try to debounce the
1287 * ports all at once right now, instead of letting hub_wq do them
1288 * one at a time later on.
1290 * If any port-status changes do occur during this delay, hub_wq
1291 * will see them later and handle them normally.
1293 if (need_debounce_delay
) {
1294 delay
= HUB_DEBOUNCE_STABLE
;
1296 /* Don't do a long sleep inside a workqueue routine */
1297 if (type
== HUB_INIT2
) {
1298 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1299 queue_delayed_work(system_power_efficient_wq
,
1301 msecs_to_jiffies(delay
));
1302 device_unlock(&hdev
->dev
);
1303 return; /* Continues at init3: below */
1311 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1313 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1314 if (hub
->has_indicators
&& blinkenlights
)
1315 queue_delayed_work(system_power_efficient_wq
,
1316 &hub
->leds
, LED_CYCLE_PERIOD
);
1318 /* Scan all ports that need attention */
1321 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1322 /* Allow autosuspend if it was suppressed */
1324 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1325 device_unlock(&hdev
->dev
);
1328 kref_put(&hub
->kref
, hub_release
);
1331 /* Implement the continuations for the delays above */
1332 static void hub_init_func2(struct work_struct
*ws
)
1334 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1336 hub_activate(hub
, HUB_INIT2
);
1339 static void hub_init_func3(struct work_struct
*ws
)
1341 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1343 hub_activate(hub
, HUB_INIT3
);
1346 enum hub_quiescing_type
{
1347 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1350 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1352 struct usb_device
*hdev
= hub
->hdev
;
1353 unsigned long flags
;
1356 /* hub_wq and related activity won't re-trigger */
1357 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
1359 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
1361 if (type
!= HUB_SUSPEND
) {
1362 /* Disconnect all the children */
1363 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1364 if (hub
->ports
[i
]->child
)
1365 usb_disconnect(&hub
->ports
[i
]->child
);
1369 /* Stop hub_wq and related activity */
1370 del_timer_sync(&hub
->irq_urb_retry
);
1371 usb_kill_urb(hub
->urb
);
1372 if (hub
->has_indicators
)
1373 cancel_delayed_work_sync(&hub
->leds
);
1375 flush_work(&hub
->tt
.clear_work
);
1378 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1382 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1383 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1386 /* caller has locked the hub device */
1387 static int hub_pre_reset(struct usb_interface
*intf
)
1389 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1391 hub_quiesce(hub
, HUB_PRE_RESET
);
1393 hub_pm_barrier_for_all_ports(hub
);
1397 /* caller has locked the hub device */
1398 static int hub_post_reset(struct usb_interface
*intf
)
1400 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1403 hub_pm_barrier_for_all_ports(hub
);
1404 hub_activate(hub
, HUB_POST_RESET
);
1408 static int hub_configure(struct usb_hub
*hub
,
1409 struct usb_endpoint_descriptor
*endpoint
)
1411 struct usb_hcd
*hcd
;
1412 struct usb_device
*hdev
= hub
->hdev
;
1413 struct device
*hub_dev
= hub
->intfdev
;
1414 u16 hubstatus
, hubchange
;
1415 u16 wHubCharacteristics
;
1418 char *message
= "out of memory";
1423 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1429 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1434 mutex_init(&hub
->status_mutex
);
1436 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1437 if (!hub
->descriptor
) {
1442 /* Request the entire hub descriptor.
1443 * hub->descriptor can handle USB_MAXCHILDREN ports,
1444 * but a (non-SS) hub can/will return fewer bytes here.
1446 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1448 message
= "can't read hub descriptor";
1452 maxchild
= USB_MAXCHILDREN
;
1453 if (hub_is_superspeed(hdev
))
1454 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1456 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1457 message
= "hub has too many ports!";
1460 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1461 message
= "hub doesn't have any ports!";
1467 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1468 * The resulting value will be used for SetIsochDelay() request.
1470 if (hub_is_superspeed(hdev
) || hub_is_superspeedplus(hdev
)) {
1471 u32 delay
= __le16_to_cpu(hub
->descriptor
->u
.ss
.wHubDelay
);
1474 delay
+= hdev
->parent
->hub_delay
;
1476 delay
+= USB_TP_TRANSMISSION_DELAY
;
1477 hdev
->hub_delay
= min_t(u32
, delay
, USB_TP_TRANSMISSION_DELAY_MAX
);
1480 maxchild
= hub
->descriptor
->bNbrPorts
;
1481 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1482 (maxchild
== 1) ? "" : "s");
1484 hub
->ports
= kcalloc(maxchild
, sizeof(struct usb_port
*), GFP_KERNEL
);
1490 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1491 if (hub_is_superspeed(hdev
)) {
1499 /* FIXME for USB 3.0, skip for now */
1500 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1501 !(hub_is_superspeed(hdev
))) {
1502 char portstr
[USB_MAXCHILDREN
+ 1];
1504 for (i
= 0; i
< maxchild
; i
++)
1505 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1506 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1508 portstr
[maxchild
] = 0;
1509 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1511 dev_dbg(hub_dev
, "standalone hub\n");
1513 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1514 case HUB_CHAR_COMMON_LPSM
:
1515 dev_dbg(hub_dev
, "ganged power switching\n");
1517 case HUB_CHAR_INDV_PORT_LPSM
:
1518 dev_dbg(hub_dev
, "individual port power switching\n");
1520 case HUB_CHAR_NO_LPSM
:
1522 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1526 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1527 case HUB_CHAR_COMMON_OCPM
:
1528 dev_dbg(hub_dev
, "global over-current protection\n");
1530 case HUB_CHAR_INDV_PORT_OCPM
:
1531 dev_dbg(hub_dev
, "individual port over-current protection\n");
1533 case HUB_CHAR_NO_OCPM
:
1535 dev_dbg(hub_dev
, "no over-current protection\n");
1539 spin_lock_init(&hub
->tt
.lock
);
1540 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1541 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1542 switch (hdev
->descriptor
.bDeviceProtocol
) {
1545 case USB_HUB_PR_HS_SINGLE_TT
:
1546 dev_dbg(hub_dev
, "Single TT\n");
1549 case USB_HUB_PR_HS_MULTI_TT
:
1550 ret
= usb_set_interface(hdev
, 0, 1);
1552 dev_dbg(hub_dev
, "TT per port\n");
1555 dev_err(hub_dev
, "Using single TT (err %d)\n",
1560 /* USB 3.0 hubs don't have a TT */
1563 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1564 hdev
->descriptor
.bDeviceProtocol
);
1568 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1569 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1570 case HUB_TTTT_8_BITS
:
1571 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1572 hub
->tt
.think_time
= 666;
1573 dev_dbg(hub_dev
, "TT requires at most %d "
1574 "FS bit times (%d ns)\n",
1575 8, hub
->tt
.think_time
);
1578 case HUB_TTTT_16_BITS
:
1579 hub
->tt
.think_time
= 666 * 2;
1580 dev_dbg(hub_dev
, "TT requires at most %d "
1581 "FS bit times (%d ns)\n",
1582 16, hub
->tt
.think_time
);
1584 case HUB_TTTT_24_BITS
:
1585 hub
->tt
.think_time
= 666 * 3;
1586 dev_dbg(hub_dev
, "TT requires at most %d "
1587 "FS bit times (%d ns)\n",
1588 24, hub
->tt
.think_time
);
1590 case HUB_TTTT_32_BITS
:
1591 hub
->tt
.think_time
= 666 * 4;
1592 dev_dbg(hub_dev
, "TT requires at most %d "
1593 "FS bit times (%d ns)\n",
1594 32, hub
->tt
.think_time
);
1598 /* probe() zeroes hub->indicator[] */
1599 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1600 hub
->has_indicators
= 1;
1601 dev_dbg(hub_dev
, "Port indicators are supported\n");
1604 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1605 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1607 /* power budgeting mostly matters with bus-powered hubs,
1608 * and battery-powered root hubs (may provide just 8 mA).
1610 ret
= usb_get_std_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1612 message
= "can't get hub status";
1615 hcd
= bus_to_hcd(hdev
->bus
);
1616 if (hdev
== hdev
->bus
->root_hub
) {
1617 if (hcd
->power_budget
> 0)
1618 hdev
->bus_mA
= hcd
->power_budget
;
1620 hdev
->bus_mA
= full_load
* maxchild
;
1621 if (hdev
->bus_mA
>= full_load
)
1622 hub
->mA_per_port
= full_load
;
1624 hub
->mA_per_port
= hdev
->bus_mA
;
1625 hub
->limited_power
= 1;
1627 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1628 int remaining
= hdev
->bus_mA
-
1629 hub
->descriptor
->bHubContrCurrent
;
1631 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1632 hub
->descriptor
->bHubContrCurrent
);
1633 hub
->limited_power
= 1;
1635 if (remaining
< maxchild
* unit_load
)
1637 "insufficient power available "
1638 "to use all downstream ports\n");
1639 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1641 } else { /* Self-powered external hub */
1642 /* FIXME: What about battery-powered external hubs that
1643 * provide less current per port? */
1644 hub
->mA_per_port
= full_load
;
1646 if (hub
->mA_per_port
< full_load
)
1647 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1650 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1652 message
= "can't get hub status";
1656 /* local power status reports aren't always correct */
1657 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1658 dev_dbg(hub_dev
, "local power source is %s\n",
1659 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1660 ? "lost (inactive)" : "good");
1662 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1663 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1664 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1666 /* set up the interrupt endpoint
1667 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1668 * bytes as USB2.0[11.12.3] says because some hubs are known
1669 * to send more data (and thus cause overflow). For root hubs,
1670 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1671 * to be big enough for at least USB_MAXCHILDREN ports. */
1672 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1673 maxp
= usb_maxpacket(hdev
, pipe
);
1675 if (maxp
> sizeof(*hub
->buffer
))
1676 maxp
= sizeof(*hub
->buffer
);
1678 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1684 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1685 hub
, endpoint
->bInterval
);
1687 /* maybe cycle the hub leds */
1688 if (hub
->has_indicators
&& blinkenlights
)
1689 hub
->indicator
[0] = INDICATOR_CYCLE
;
1691 mutex_lock(&usb_port_peer_mutex
);
1692 for (i
= 0; i
< maxchild
; i
++) {
1693 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1695 dev_err(hub
->intfdev
,
1696 "couldn't create port%d device.\n", i
+ 1);
1701 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1702 struct usb_port
*port_dev
= hub
->ports
[i
];
1704 pm_runtime_put(&port_dev
->dev
);
1707 mutex_unlock(&usb_port_peer_mutex
);
1711 /* Update the HCD's internal representation of this hub before hub_wq
1712 * starts getting port status changes for devices under the hub.
1714 if (hcd
->driver
->update_hub_device
) {
1715 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1716 &hub
->tt
, GFP_KERNEL
);
1718 message
= "can't update HCD hub info";
1723 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1725 hub_activate(hub
, HUB_INIT
);
1729 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1731 /* hub_disconnect() frees urb and descriptor */
1735 static void hub_release(struct kref
*kref
)
1737 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1739 usb_put_dev(hub
->hdev
);
1740 usb_put_intf(to_usb_interface(hub
->intfdev
));
1744 static unsigned highspeed_hubs
;
1746 static void hub_disconnect(struct usb_interface
*intf
)
1748 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1749 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1753 * Stop adding new hub events. We do not want to block here and thus
1754 * will not try to remove any pending work item.
1756 hub
->disconnected
= 1;
1758 /* Disconnect all children and quiesce the hub */
1760 hub_quiesce(hub
, HUB_DISCONNECT
);
1762 mutex_lock(&usb_port_peer_mutex
);
1764 /* Avoid races with recursively_mark_NOTATTACHED() */
1765 spin_lock_irq(&device_state_lock
);
1766 port1
= hdev
->maxchild
;
1768 usb_set_intfdata(intf
, NULL
);
1769 spin_unlock_irq(&device_state_lock
);
1771 for (; port1
> 0; --port1
)
1772 usb_hub_remove_port_device(hub
, port1
);
1774 mutex_unlock(&usb_port_peer_mutex
);
1776 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1779 usb_free_urb(hub
->urb
);
1781 kfree(hub
->descriptor
);
1785 pm_suspend_ignore_children(&intf
->dev
, false);
1787 if (hub
->quirk_disable_autosuspend
)
1788 usb_autopm_put_interface(intf
);
1790 onboard_hub_destroy_pdevs(&hub
->onboard_hub_devs
);
1792 kref_put(&hub
->kref
, hub_release
);
1795 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1797 /* Some hubs have a subclass of 1, which AFAICT according to the */
1798 /* specs is not defined, but it works */
1799 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1800 desc
->desc
.bInterfaceSubClass
!= 1)
1803 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1804 if (desc
->desc
.bNumEndpoints
!= 1)
1807 /* If the first endpoint is not interrupt IN, we'd better punt! */
1808 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1814 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1816 struct usb_host_interface
*desc
;
1817 struct usb_device
*hdev
;
1818 struct usb_hub
*hub
;
1820 desc
= intf
->cur_altsetting
;
1821 hdev
= interface_to_usbdev(intf
);
1824 * Set default autosuspend delay as 0 to speedup bus suspend,
1825 * based on the below considerations:
1827 * - Unlike other drivers, the hub driver does not rely on the
1828 * autosuspend delay to provide enough time to handle a wakeup
1829 * event, and the submitted status URB is just to check future
1830 * change on hub downstream ports, so it is safe to do it.
1832 * - The patch might cause one or more auto supend/resume for
1833 * below very rare devices when they are plugged into hub
1836 * devices having trouble initializing, and disconnect
1837 * themselves from the bus and then reconnect a second
1840 * devices just for downloading firmware, and disconnects
1841 * themselves after completing it
1843 * For these quite rare devices, their drivers may change the
1844 * autosuspend delay of their parent hub in the probe() to one
1845 * appropriate value to avoid the subtle problem if someone
1848 * - The patch may cause one or more auto suspend/resume on
1849 * hub during running 'lsusb', but it is probably too
1850 * infrequent to worry about.
1852 * - Change autosuspend delay of hub can avoid unnecessary auto
1853 * suspend timer for hub, also may decrease power consumption
1856 * - If user has indicated to prevent autosuspend by passing
1857 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1860 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1861 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1865 * Hubs have proper suspend/resume support, except for root hubs
1866 * where the controller driver doesn't have bus_suspend and
1867 * bus_resume methods.
1869 if (hdev
->parent
) { /* normal device */
1870 usb_enable_autosuspend(hdev
);
1871 } else { /* root hub */
1872 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1874 if (drv
->bus_suspend
&& drv
->bus_resume
)
1875 usb_enable_autosuspend(hdev
);
1878 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1880 "Unsupported bus topology: hub nested too deep\n");
1884 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1886 dev_warn(&intf
->dev
, "ignoring external hub\n");
1891 if (!hub_descriptor_is_sane(desc
)) {
1892 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1896 /* We found a hub */
1897 dev_info(&intf
->dev
, "USB hub found\n");
1899 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1903 kref_init(&hub
->kref
);
1904 hub
->intfdev
= &intf
->dev
;
1906 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1907 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1908 INIT_WORK(&hub
->events
, hub_event
);
1909 INIT_LIST_HEAD(&hub
->onboard_hub_devs
);
1910 spin_lock_init(&hub
->irq_urb_lock
);
1911 timer_setup(&hub
->irq_urb_retry
, hub_retry_irq_urb
, 0);
1915 usb_set_intfdata(intf
, hub
);
1916 intf
->needs_remote_wakeup
= 1;
1917 pm_suspend_ignore_children(&intf
->dev
, true);
1919 if (hdev
->speed
== USB_SPEED_HIGH
)
1922 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1923 hub
->quirk_check_port_auto_suspend
= 1;
1925 if (id
->driver_info
& HUB_QUIRK_DISABLE_AUTOSUSPEND
) {
1926 hub
->quirk_disable_autosuspend
= 1;
1927 usb_autopm_get_interface_no_resume(intf
);
1930 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0) {
1931 onboard_hub_create_pdevs(hdev
, &hub
->onboard_hub_devs
);
1936 hub_disconnect(intf
);
1941 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1943 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1944 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1946 /* assert ifno == 0 (part of hub spec) */
1948 case USBDEVFS_HUB_PORTINFO
: {
1949 struct usbdevfs_hub_portinfo
*info
= user_data
;
1952 spin_lock_irq(&device_state_lock
);
1953 if (hdev
->devnum
<= 0)
1956 info
->nports
= hdev
->maxchild
;
1957 for (i
= 0; i
< info
->nports
; i
++) {
1958 if (hub
->ports
[i
]->child
== NULL
)
1962 hub
->ports
[i
]->child
->devnum
;
1965 spin_unlock_irq(&device_state_lock
);
1967 return info
->nports
+ 1;
1976 * Allow user programs to claim ports on a hub. When a device is attached
1977 * to one of these "claimed" ports, the program will "own" the device.
1979 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1980 struct usb_dev_state
***ppowner
)
1982 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1984 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1986 if (port1
== 0 || port1
> hdev
->maxchild
)
1989 /* Devices not managed by the hub driver
1990 * will always have maxchild equal to 0.
1992 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1996 /* In the following three functions, the caller must hold hdev's lock */
1997 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1998 struct usb_dev_state
*owner
)
2001 struct usb_dev_state
**powner
;
2003 rc
= find_port_owner(hdev
, port1
, &powner
);
2011 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
2013 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
2014 struct usb_dev_state
*owner
)
2017 struct usb_dev_state
**powner
;
2019 rc
= find_port_owner(hdev
, port1
, &powner
);
2022 if (*powner
!= owner
)
2027 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
2029 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
2031 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
2034 for (n
= 0; n
< hdev
->maxchild
; n
++) {
2035 if (hub
->ports
[n
]->port_owner
== owner
)
2036 hub
->ports
[n
]->port_owner
= NULL
;
2041 /* The caller must hold udev's lock */
2042 bool usb_device_is_owned(struct usb_device
*udev
)
2044 struct usb_hub
*hub
;
2046 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
2048 hub
= usb_hub_to_struct_hub(udev
->parent
);
2049 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
2052 static void update_port_device_state(struct usb_device
*udev
)
2054 struct usb_hub
*hub
;
2055 struct usb_port
*port_dev
;
2058 hub
= usb_hub_to_struct_hub(udev
->parent
);
2059 port_dev
= hub
->ports
[udev
->portnum
- 1];
2060 WRITE_ONCE(port_dev
->state
, udev
->state
);
2061 sysfs_notify_dirent(port_dev
->state_kn
);
2065 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
2067 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2070 for (i
= 0; i
< udev
->maxchild
; ++i
) {
2071 if (hub
->ports
[i
]->child
)
2072 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
2074 if (udev
->state
== USB_STATE_SUSPENDED
)
2075 udev
->active_duration
-= jiffies
;
2076 udev
->state
= USB_STATE_NOTATTACHED
;
2077 update_port_device_state(udev
);
2081 * usb_set_device_state - change a device's current state (usbcore, hcds)
2082 * @udev: pointer to device whose state should be changed
2083 * @new_state: new state value to be stored
2085 * udev->state is _not_ fully protected by the device lock. Although
2086 * most transitions are made only while holding the lock, the state can
2087 * can change to USB_STATE_NOTATTACHED at almost any time. This
2088 * is so that devices can be marked as disconnected as soon as possible,
2089 * without having to wait for any semaphores to be released. As a result,
2090 * all changes to any device's state must be protected by the
2091 * device_state_lock spinlock.
2093 * Once a device has been added to the device tree, all changes to its state
2094 * should be made using this routine. The state should _not_ be set directly.
2096 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2097 * Otherwise udev->state is set to new_state, and if new_state is
2098 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2099 * to USB_STATE_NOTATTACHED.
2101 void usb_set_device_state(struct usb_device
*udev
,
2102 enum usb_device_state new_state
)
2104 unsigned long flags
;
2107 spin_lock_irqsave(&device_state_lock
, flags
);
2108 if (udev
->state
== USB_STATE_NOTATTACHED
)
2110 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2112 /* root hub wakeup capabilities are managed out-of-band
2113 * and may involve silicon errata ... ignore them here.
2116 if (udev
->state
== USB_STATE_SUSPENDED
2117 || new_state
== USB_STATE_SUSPENDED
)
2118 ; /* No change to wakeup settings */
2119 else if (new_state
== USB_STATE_CONFIGURED
)
2120 wakeup
= (udev
->quirks
&
2121 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
2122 udev
->actconfig
->desc
.bmAttributes
&
2123 USB_CONFIG_ATT_WAKEUP
;
2127 if (udev
->state
== USB_STATE_SUSPENDED
&&
2128 new_state
!= USB_STATE_SUSPENDED
)
2129 udev
->active_duration
-= jiffies
;
2130 else if (new_state
== USB_STATE_SUSPENDED
&&
2131 udev
->state
!= USB_STATE_SUSPENDED
)
2132 udev
->active_duration
+= jiffies
;
2133 udev
->state
= new_state
;
2134 update_port_device_state(udev
);
2136 recursively_mark_NOTATTACHED(udev
);
2137 spin_unlock_irqrestore(&device_state_lock
, flags
);
2139 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2141 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2144 * Choose a device number.
2146 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2147 * USB-2.0 buses they are also used as device addresses, however on
2148 * USB-3.0 buses the address is assigned by the controller hardware
2149 * and it usually is not the same as the device number.
2151 * Devices connected under xHCI are not as simple. The host controller
2152 * supports virtualization, so the hardware assigns device addresses and
2153 * the HCD must setup data structures before issuing a set address
2154 * command to the hardware.
2156 static void choose_devnum(struct usb_device
*udev
)
2159 struct usb_bus
*bus
= udev
->bus
;
2161 /* be safe when more hub events are proceed in parallel */
2162 mutex_lock(&bus
->devnum_next_mutex
);
2164 /* Try to allocate the next devnum beginning at bus->devnum_next. */
2165 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2168 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128, 1);
2169 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2171 set_bit(devnum
, bus
->devmap
.devicemap
);
2172 udev
->devnum
= devnum
;
2174 mutex_unlock(&bus
->devnum_next_mutex
);
2177 static void release_devnum(struct usb_device
*udev
)
2179 if (udev
->devnum
> 0) {
2180 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2185 static void update_devnum(struct usb_device
*udev
, int devnum
)
2187 udev
->devnum
= devnum
;
2189 udev
->devaddr
= (u8
)devnum
;
2192 static void hub_free_dev(struct usb_device
*udev
)
2194 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2196 /* Root hubs aren't real devices, so don't free HCD resources */
2197 if (hcd
->driver
->free_dev
&& udev
->parent
)
2198 hcd
->driver
->free_dev(hcd
, udev
);
2201 static void hub_disconnect_children(struct usb_device
*udev
)
2203 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2206 /* Free up all the children before we remove this device */
2207 for (i
= 0; i
< udev
->maxchild
; i
++) {
2208 if (hub
->ports
[i
]->child
)
2209 usb_disconnect(&hub
->ports
[i
]->child
);
2214 * usb_disconnect - disconnect a device (usbcore-internal)
2215 * @pdev: pointer to device being disconnected
2217 * Context: task context, might sleep
2219 * Something got disconnected. Get rid of it and all of its children.
2221 * If *pdev is a normal device then the parent hub must already be locked.
2222 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2223 * which protects the set of root hubs as well as the list of buses.
2225 * Only hub drivers (including virtual root hub drivers for host
2226 * controllers) should ever call this.
2228 * This call is synchronous, and may not be used in an interrupt context.
2230 void usb_disconnect(struct usb_device
**pdev
)
2232 struct usb_port
*port_dev
= NULL
;
2233 struct usb_device
*udev
= *pdev
;
2234 struct usb_hub
*hub
= NULL
;
2237 /* mark the device as inactive, so any further urb submissions for
2238 * this device (and any of its children) will fail immediately.
2239 * this quiesces everything except pending urbs.
2241 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2242 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2246 * Ensure that the pm runtime code knows that the USB device
2247 * is in the process of being disconnected.
2249 pm_runtime_barrier(&udev
->dev
);
2251 usb_lock_device(udev
);
2253 hub_disconnect_children(udev
);
2255 /* deallocate hcd/hardware state ... nuking all pending urbs and
2256 * cleaning up all state associated with the current configuration
2257 * so that the hardware is now fully quiesced.
2259 dev_dbg(&udev
->dev
, "unregistering device\n");
2260 usb_disable_device(udev
, 0);
2261 usb_hcd_synchronize_unlinks(udev
);
2264 port1
= udev
->portnum
;
2265 hub
= usb_hub_to_struct_hub(udev
->parent
);
2266 port_dev
= hub
->ports
[port1
- 1];
2268 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2269 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2272 * As usb_port_runtime_resume() de-references udev, make
2273 * sure no resumes occur during removal
2275 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2276 pm_runtime_get_sync(&port_dev
->dev
);
2279 usb_remove_ep_devs(&udev
->ep0
);
2280 usb_unlock_device(udev
);
2282 /* Unregister the device. The device driver is responsible
2283 * for de-configuring the device and invoking the remove-device
2284 * notifier chain (used by usbfs and possibly others).
2286 device_del(&udev
->dev
);
2288 /* Free the device number and delete the parent's children[]
2289 * (or root_hub) pointer.
2291 release_devnum(udev
);
2293 /* Avoid races with recursively_mark_NOTATTACHED() */
2294 spin_lock_irq(&device_state_lock
);
2296 spin_unlock_irq(&device_state_lock
);
2298 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2299 pm_runtime_put(&port_dev
->dev
);
2303 put_device(&udev
->dev
);
2306 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2307 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2311 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2314 static void announce_device(struct usb_device
*udev
)
2316 u16 bcdDevice
= le16_to_cpu(udev
->descriptor
.bcdDevice
);
2318 dev_info(&udev
->dev
,
2319 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2320 le16_to_cpu(udev
->descriptor
.idVendor
),
2321 le16_to_cpu(udev
->descriptor
.idProduct
),
2322 bcdDevice
>> 8, bcdDevice
& 0xff);
2323 dev_info(&udev
->dev
,
2324 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2325 udev
->descriptor
.iManufacturer
,
2326 udev
->descriptor
.iProduct
,
2327 udev
->descriptor
.iSerialNumber
);
2328 show_string(udev
, "Product", udev
->product
);
2329 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2330 show_string(udev
, "SerialNumber", udev
->serial
);
2333 static inline void announce_device(struct usb_device
*udev
) { }
2338 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2339 * @udev: newly addressed device (in ADDRESS state)
2341 * Finish enumeration for On-The-Go devices
2343 * Return: 0 if successful. A negative error code otherwise.
2345 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2349 #ifdef CONFIG_USB_OTG
2351 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2352 * to wake us after we've powered off VBUS; and HNP, switching roles
2353 * "host" to "peripheral". The OTG descriptor helps figure this out.
2355 if (!udev
->bus
->is_b_host
2357 && udev
->parent
== udev
->bus
->root_hub
) {
2358 struct usb_otg_descriptor
*desc
= NULL
;
2359 struct usb_bus
*bus
= udev
->bus
;
2360 unsigned port1
= udev
->portnum
;
2362 /* descriptor may appear anywhere in config */
2363 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2364 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2365 USB_DT_OTG
, (void **) &desc
, sizeof(*desc
));
2366 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2369 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2370 (port1
== bus
->otg_port
) ? "" : "non-");
2372 /* enable HNP before suspend, it's simpler */
2373 if (port1
== bus
->otg_port
) {
2374 bus
->b_hnp_enable
= 1;
2375 err
= usb_control_msg(udev
,
2376 usb_sndctrlpipe(udev
, 0),
2377 USB_REQ_SET_FEATURE
, 0,
2378 USB_DEVICE_B_HNP_ENABLE
,
2380 USB_CTRL_SET_TIMEOUT
);
2383 * OTG MESSAGE: report errors here,
2384 * customize to match your product.
2386 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2388 bus
->b_hnp_enable
= 0;
2390 } else if (desc
->bLength
== sizeof
2391 (struct usb_otg_descriptor
)) {
2392 /* Set a_alt_hnp_support for legacy otg device */
2393 err
= usb_control_msg(udev
,
2394 usb_sndctrlpipe(udev
, 0),
2395 USB_REQ_SET_FEATURE
, 0,
2396 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2398 USB_CTRL_SET_TIMEOUT
);
2401 "set a_alt_hnp_support failed: %d\n",
2411 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2412 * @udev: newly addressed device (in ADDRESS state)
2414 * This is only called by usb_new_device() -- all comments that apply there
2415 * apply here wrt to environment.
2417 * If the device is WUSB and not authorized, we don't attempt to read
2418 * the string descriptors, as they will be errored out by the device
2419 * until it has been authorized.
2421 * Return: 0 if successful. A negative error code otherwise.
2423 static int usb_enumerate_device(struct usb_device
*udev
)
2426 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2428 if (udev
->config
== NULL
) {
2429 err
= usb_get_configuration(udev
);
2432 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2438 /* read the standard strings and cache them if present */
2439 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2440 udev
->manufacturer
= usb_cache_string(udev
,
2441 udev
->descriptor
.iManufacturer
);
2442 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2444 err
= usb_enumerate_device_otg(udev
);
2448 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST
) && hcd
->tpl_support
&&
2449 !is_targeted(udev
)) {
2450 /* Maybe it can talk to us, though we can't talk to it.
2451 * (Includes HNP test device.)
2453 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2454 || udev
->bus
->is_b_host
)) {
2455 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2457 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2462 usb_detect_interface_quirks(udev
);
2467 static void set_usb_port_removable(struct usb_device
*udev
)
2469 struct usb_device
*hdev
= udev
->parent
;
2470 struct usb_hub
*hub
;
2471 u8 port
= udev
->portnum
;
2472 u16 wHubCharacteristics
;
2473 bool removable
= true;
2475 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE_UNKNOWN
);
2480 hub
= usb_hub_to_struct_hub(udev
->parent
);
2483 * If the platform firmware has provided information about a port,
2484 * use that to determine whether it's removable.
2486 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2487 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2488 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE
);
2490 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2491 case USB_PORT_NOT_USED
:
2492 dev_set_removable(&udev
->dev
, DEVICE_FIXED
);
2499 * Otherwise, check whether the hub knows whether a port is removable
2502 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2504 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2507 if (hub_is_superspeed(hdev
)) {
2508 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2512 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2517 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE
);
2519 dev_set_removable(&udev
->dev
, DEVICE_FIXED
);
2524 * usb_new_device - perform initial device setup (usbcore-internal)
2525 * @udev: newly addressed device (in ADDRESS state)
2527 * This is called with devices which have been detected but not fully
2528 * enumerated. The device descriptor is available, but not descriptors
2529 * for any device configuration. The caller must have locked either
2530 * the parent hub (if udev is a normal device) or else the
2531 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2532 * udev has already been installed, but udev is not yet visible through
2533 * sysfs or other filesystem code.
2535 * This call is synchronous, and may not be used in an interrupt context.
2537 * Only the hub driver or root-hub registrar should ever call this.
2539 * Return: Whether the device is configured properly or not. Zero if the
2540 * interface was registered with the driver core; else a negative errno
2544 int usb_new_device(struct usb_device
*udev
)
2549 /* Initialize non-root-hub device wakeup to disabled;
2550 * device (un)configuration controls wakeup capable
2551 * sysfs power/wakeup controls wakeup enabled/disabled
2553 device_init_wakeup(&udev
->dev
, 0);
2556 /* Tell the runtime-PM framework the device is active */
2557 pm_runtime_set_active(&udev
->dev
);
2558 pm_runtime_get_noresume(&udev
->dev
);
2559 pm_runtime_use_autosuspend(&udev
->dev
);
2560 pm_runtime_enable(&udev
->dev
);
2562 /* By default, forbid autosuspend for all devices. It will be
2563 * allowed for hubs during binding.
2565 usb_disable_autosuspend(udev
);
2567 err
= usb_enumerate_device(udev
); /* Read descriptors */
2570 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2571 udev
->devnum
, udev
->bus
->busnum
,
2572 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2573 /* export the usbdev device-node for libusb */
2574 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2575 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2577 /* Tell the world! */
2578 announce_device(udev
);
2581 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2583 add_device_randomness(udev
->product
, strlen(udev
->product
));
2584 if (udev
->manufacturer
)
2585 add_device_randomness(udev
->manufacturer
,
2586 strlen(udev
->manufacturer
));
2588 device_enable_async_suspend(&udev
->dev
);
2590 /* check whether the hub or firmware marks this port as non-removable */
2591 set_usb_port_removable(udev
);
2593 /* Register the device. The device driver is responsible
2594 * for configuring the device and invoking the add-device
2595 * notifier chain (used by usbfs and possibly others).
2597 err
= device_add(&udev
->dev
);
2599 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2603 /* Create link files between child device and usb port device. */
2605 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2606 int port1
= udev
->portnum
;
2607 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2609 err
= sysfs_create_link(&udev
->dev
.kobj
,
2610 &port_dev
->dev
.kobj
, "port");
2614 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2615 &udev
->dev
.kobj
, "device");
2617 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2621 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2622 pm_runtime_get_sync(&port_dev
->dev
);
2625 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2626 usb_mark_last_busy(udev
);
2627 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2631 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2632 pm_runtime_disable(&udev
->dev
);
2633 pm_runtime_set_suspended(&udev
->dev
);
2639 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2640 * @usb_dev: USB device
2642 * Move the USB device to a very basic state where interfaces are disabled
2643 * and the device is in fact unconfigured and unusable.
2645 * We share a lock (that we have) with device_del(), so we need to
2650 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2652 usb_lock_device(usb_dev
);
2653 if (usb_dev
->authorized
== 0)
2654 goto out_unauthorized
;
2656 usb_dev
->authorized
= 0;
2657 usb_set_configuration(usb_dev
, -1);
2660 usb_unlock_device(usb_dev
);
2665 int usb_authorize_device(struct usb_device
*usb_dev
)
2669 usb_lock_device(usb_dev
);
2670 if (usb_dev
->authorized
== 1)
2671 goto out_authorized
;
2673 result
= usb_autoresume_device(usb_dev
);
2675 dev_err(&usb_dev
->dev
,
2676 "can't autoresume for authorization: %d\n", result
);
2677 goto error_autoresume
;
2680 usb_dev
->authorized
= 1;
2681 /* Choose and set the configuration. This registers the interfaces
2682 * with the driver core and lets interface drivers bind to them.
2684 c
= usb_choose_configuration(usb_dev
);
2686 result
= usb_set_configuration(usb_dev
, c
);
2688 dev_err(&usb_dev
->dev
,
2689 "can't set config #%d, error %d\n", c
, result
);
2690 /* This need not be fatal. The user can try to
2691 * set other configurations. */
2694 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2696 usb_autosuspend_device(usb_dev
);
2699 usb_unlock_device(usb_dev
); /* complements locktree */
2704 * get_port_ssp_rate - Match the extended port status to SSP rate
2705 * @hdev: The hub device
2706 * @ext_portstatus: extended port status
2708 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2709 * capability attributes. Base on the number of connected lanes and speed,
2710 * return the corresponding enum usb_ssp_rate.
2712 static enum usb_ssp_rate
get_port_ssp_rate(struct usb_device
*hdev
,
2715 struct usb_ssp_cap_descriptor
*ssp_cap
;
2725 ssp_cap
= hdev
->bos
->ssp_cap
;
2729 speed_id
= ext_portstatus
& USB_EXT_PORT_STAT_RX_SPEED_ID
;
2730 lanes
= USB_EXT_PORT_RX_LANES(ext_portstatus
) + 1;
2732 ssac
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2733 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2735 for (i
= 0; i
<= ssac
; i
++) {
2738 attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2739 ssid
= FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID
, attr
);
2740 if (speed_id
== ssid
) {
2746 * Note: currently asymmetric lane types are only
2747 * applicable for SSIC operate in SuperSpeed protocol
2749 type
= FIELD_GET(USB_SSP_SUBLINK_SPEED_ST
, attr
);
2750 if (type
== USB_SSP_SUBLINK_SPEED_ST_ASYM_RX
||
2751 type
== USB_SSP_SUBLINK_SPEED_ST_ASYM_TX
)
2754 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP
, attr
) !=
2755 USB_SSP_SUBLINK_SPEED_LP_SSP
)
2758 lse
= FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE
, attr
);
2759 mantissa
= FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM
, attr
);
2761 /* Convert to Gbps */
2762 for (; lse
< USB_SSP_SUBLINK_SPEED_LSE_GBPS
; lse
++)
2765 if (mantissa
>= 10 && lanes
== 1)
2766 return USB_SSP_GEN_2x1
;
2768 if (mantissa
>= 10 && lanes
== 2)
2769 return USB_SSP_GEN_2x2
;
2771 if (mantissa
>= 5 && lanes
== 2)
2772 return USB_SSP_GEN_1x2
;
2779 return USB_SSP_GEN_UNKNOWN
;
2782 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2783 #define PORT_RESET_TRIES 2
2784 #define SET_ADDRESS_TRIES 1
2785 #define GET_DESCRIPTOR_TRIES 1
2786 #define GET_MAXPACKET0_TRIES 1
2787 #define PORT_INIT_TRIES 4
2790 #define PORT_RESET_TRIES 5
2791 #define SET_ADDRESS_TRIES 2
2792 #define GET_DESCRIPTOR_TRIES 2
2793 #define GET_MAXPACKET0_TRIES 3
2794 #define PORT_INIT_TRIES 4
2795 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2797 #define DETECT_DISCONNECT_TRIES 5
2799 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2800 #define HUB_SHORT_RESET_TIME 10
2801 #define HUB_BH_RESET_TIME 50
2802 #define HUB_LONG_RESET_TIME 200
2803 #define HUB_RESET_TIMEOUT 800
2805 static bool use_new_scheme(struct usb_device
*udev
, int retry
,
2806 struct usb_port
*port_dev
)
2808 int old_scheme_first_port
=
2809 (port_dev
->quirks
& USB_PORT_QUIRK_OLD_SCHEME
) ||
2813 * "New scheme" enumeration causes an extra state transition to be
2814 * exposed to an xhci host and causes USB3 devices to receive control
2815 * commands in the default state. This has been seen to cause
2816 * enumeration failures, so disable this enumeration scheme for USB3
2819 if (udev
->speed
>= USB_SPEED_SUPER
)
2823 * If use_both_schemes is set, use the first scheme (whichever
2824 * it is) for the larger half of the retries, then use the other
2825 * scheme. Otherwise, use the first scheme for all the retries.
2827 if (use_both_schemes
&& retry
>= (PORT_INIT_TRIES
+ 1) / 2)
2828 return old_scheme_first_port
; /* Second half */
2829 return !old_scheme_first_port
; /* First half or all */
2832 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2833 * Port warm reset is required to recover
2835 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2840 if (!hub_is_superspeed(hub
->hdev
))
2843 if (test_bit(port1
, hub
->warm_reset_bits
))
2846 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2847 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2848 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2851 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2852 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2854 int delay_time
, ret
;
2857 u32 ext_portstatus
= 0;
2859 for (delay_time
= 0;
2860 delay_time
< HUB_RESET_TIMEOUT
;
2861 delay_time
+= delay
) {
2862 /* wait to give the device a chance to reset */
2865 /* read and decode port status */
2866 if (hub_is_superspeedplus(hub
->hdev
))
2867 ret
= hub_ext_port_status(hub
, port1
,
2868 HUB_EXT_PORT_STATUS
,
2869 &portstatus
, &portchange
,
2872 ret
= usb_hub_port_status(hub
, port1
, &portstatus
,
2878 * The port state is unknown until the reset completes.
2880 * On top of that, some chips may require additional time
2881 * to re-establish a connection after the reset is complete,
2882 * so also wait for the connection to be re-established.
2884 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2885 (portstatus
& USB_PORT_STAT_CONNECTION
))
2888 /* switch to the long delay after two short delay failures */
2889 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2890 delay
= HUB_LONG_RESET_TIME
;
2892 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2893 "not %sreset yet, waiting %dms\n",
2894 warm
? "warm " : "", delay
);
2897 if ((portstatus
& USB_PORT_STAT_RESET
))
2900 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2903 /* Device went away? */
2904 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2907 /* Retry if connect change is set but status is still connected.
2908 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2909 * but the device may have successfully re-connected. Ignore it.
2911 if (!hub_is_superspeed(hub
->hdev
) &&
2912 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2913 usb_clear_port_feature(hub
->hdev
, port1
,
2914 USB_PORT_FEAT_C_CONNECTION
);
2918 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2924 if (hub_is_superspeedplus(hub
->hdev
)) {
2925 /* extended portstatus Rx and Tx lane count are zero based */
2926 udev
->rx_lanes
= USB_EXT_PORT_RX_LANES(ext_portstatus
) + 1;
2927 udev
->tx_lanes
= USB_EXT_PORT_TX_LANES(ext_portstatus
) + 1;
2928 udev
->ssp_rate
= get_port_ssp_rate(hub
->hdev
, ext_portstatus
);
2932 udev
->ssp_rate
= USB_SSP_GEN_UNKNOWN
;
2934 if (udev
->ssp_rate
!= USB_SSP_GEN_UNKNOWN
)
2935 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2936 else if (hub_is_superspeed(hub
->hdev
))
2937 udev
->speed
= USB_SPEED_SUPER
;
2938 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2939 udev
->speed
= USB_SPEED_HIGH
;
2940 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2941 udev
->speed
= USB_SPEED_LOW
;
2943 udev
->speed
= USB_SPEED_FULL
;
2947 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2948 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2949 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2952 u16 portchange
, portstatus
;
2953 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2954 int reset_recovery_time
;
2956 if (!hub_is_superspeed(hub
->hdev
)) {
2958 dev_err(hub
->intfdev
, "only USB3 hub support "
2962 /* Block EHCI CF initialization during the port reset.
2963 * Some companion controllers don't like it when they mix.
2965 down_read(&ehci_cf_port_reset_rwsem
);
2968 * If the caller hasn't explicitly requested a warm reset,
2969 * double check and see if one is needed.
2971 if (usb_hub_port_status(hub
, port1
, &portstatus
,
2973 if (hub_port_warm_reset_required(hub
, port1
,
2977 clear_bit(port1
, hub
->warm_reset_bits
);
2979 /* Reset the port */
2980 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2981 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2982 USB_PORT_FEAT_BH_PORT_RESET
:
2983 USB_PORT_FEAT_RESET
));
2984 if (status
== -ENODEV
) {
2985 ; /* The hub is gone */
2986 } else if (status
) {
2987 dev_err(&port_dev
->dev
,
2988 "cannot %sreset (err = %d)\n",
2989 warm
? "warm " : "", status
);
2991 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2993 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2994 dev_dbg(hub
->intfdev
,
2995 "port_wait_reset: err = %d\n",
3000 * Check for disconnect or reset, and bail out after several
3001 * reset attempts to avoid warm reset loop.
3003 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
||
3004 (status
== -EBUSY
&& i
== PORT_RESET_TRIES
- 1)) {
3005 usb_clear_port_feature(hub
->hdev
, port1
,
3006 USB_PORT_FEAT_C_RESET
);
3008 if (!hub_is_superspeed(hub
->hdev
))
3011 usb_clear_port_feature(hub
->hdev
, port1
,
3012 USB_PORT_FEAT_C_BH_PORT_RESET
);
3013 usb_clear_port_feature(hub
->hdev
, port1
,
3014 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3017 usb_clear_port_feature(hub
->hdev
, port1
,
3018 USB_PORT_FEAT_C_CONNECTION
);
3021 * If a USB 3.0 device migrates from reset to an error
3022 * state, re-issue the warm reset.
3024 if (usb_hub_port_status(hub
, port1
,
3025 &portstatus
, &portchange
) < 0)
3028 if (!hub_port_warm_reset_required(hub
, port1
,
3033 * If the port is in SS.Inactive or Compliance Mode, the
3034 * hot or warm reset failed. Try another warm reset.
3037 dev_dbg(&port_dev
->dev
,
3038 "hot reset failed, warm reset\n");
3043 dev_dbg(&port_dev
->dev
,
3044 "not enabled, trying %sreset again...\n",
3045 warm
? "warm " : "");
3046 delay
= HUB_LONG_RESET_TIME
;
3049 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
3053 if (port_dev
->quirks
& USB_PORT_QUIRK_FAST_ENUM
)
3054 usleep_range(10000, 12000);
3056 /* TRSTRCY = 10 ms; plus some extra */
3057 reset_recovery_time
= 10 + 40;
3059 /* Hub needs extra delay after resetting its port. */
3060 if (hub
->hdev
->quirks
& USB_QUIRK_HUB_SLOW_RESET
)
3061 reset_recovery_time
+= 100;
3063 msleep(reset_recovery_time
);
3067 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3069 update_devnum(udev
, 0);
3070 /* The xHC may think the device is already reset,
3071 * so ignore the status.
3073 if (hcd
->driver
->reset_device
)
3074 hcd
->driver
->reset_device(hcd
, udev
);
3076 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
3080 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
3083 if (!hub_is_superspeed(hub
->hdev
))
3084 up_read(&ehci_cf_port_reset_rwsem
);
3090 * hub_port_stop_enumerate - stop USB enumeration or ignore port events
3092 * @port1: port num of the port
3093 * @retries: port retries number of hub_port_init()
3096 * true: ignore port actions/events or give up connection attempts.
3097 * false: keep original behavior.
3099 * This function will be based on retries to check whether the port which is
3100 * marked with early_stop attribute would stop enumeration or ignore events.
3103 * This function didn't change anything if early_stop is not set, and it will
3104 * prevent all connection attempts when early_stop is set and the attempts of
3105 * the port are more than 1.
3107 static bool hub_port_stop_enumerate(struct usb_hub
*hub
, int port1
, int retries
)
3109 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3111 if (port_dev
->early_stop
) {
3112 if (port_dev
->ignore_event
)
3116 * We want unsuccessful attempts to fail quickly.
3117 * Since some devices may need one failure during
3118 * port initialization, we allow two tries but no
3124 port_dev
->ignore_event
= 1;
3126 port_dev
->ignore_event
= 0;
3128 return port_dev
->ignore_event
;
3131 /* Check if a port is power on */
3132 int usb_port_is_power_on(struct usb_hub
*hub
, unsigned int portstatus
)
3136 if (hub_is_superspeed(hub
->hdev
)) {
3137 if (portstatus
& USB_SS_PORT_STAT_POWER
)
3140 if (portstatus
& USB_PORT_STAT_POWER
)
3147 static void usb_lock_port(struct usb_port
*port_dev
)
3148 __acquires(&port_dev
->status_lock
)
3150 mutex_lock(&port_dev
->status_lock
);
3151 __acquire(&port_dev
->status_lock
);
3154 static void usb_unlock_port(struct usb_port
*port_dev
)
3155 __releases(&port_dev
->status_lock
)
3157 mutex_unlock(&port_dev
->status_lock
);
3158 __release(&port_dev
->status_lock
);
3163 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3164 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
3168 if (hub_is_superspeed(hub
->hdev
)) {
3169 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
3170 == USB_SS_PORT_LS_U3
)
3173 if (portstatus
& USB_PORT_STAT_SUSPEND
)
3180 /* Determine whether the device on a port is ready for a normal resume,
3181 * is ready for a reset-resume, or should be disconnected.
3183 static int check_port_resume_type(struct usb_device
*udev
,
3184 struct usb_hub
*hub
, int port1
,
3185 int status
, u16 portchange
, u16 portstatus
)
3187 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3191 /* Is a warm reset needed to recover the connection? */
3192 if (status
== 0 && udev
->reset_resume
3193 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
3196 /* Is the device still present? */
3197 else if (status
|| port_is_suspended(hub
, portstatus
) ||
3198 !usb_port_is_power_on(hub
, portstatus
)) {
3201 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
3203 usleep_range(200, 300);
3204 status
= usb_hub_port_status(hub
, port1
, &portstatus
,
3211 /* Can't do a normal resume if the port isn't enabled,
3212 * so try a reset-resume instead.
3214 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3215 if (udev
->persist_enabled
)
3216 udev
->reset_resume
= 1;
3222 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
3223 portchange
, portstatus
, status
);
3224 } else if (udev
->reset_resume
) {
3226 /* Late port handoff can set status-change bits */
3227 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3228 usb_clear_port_feature(hub
->hdev
, port1
,
3229 USB_PORT_FEAT_C_CONNECTION
);
3230 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3231 usb_clear_port_feature(hub
->hdev
, port1
,
3232 USB_PORT_FEAT_C_ENABLE
);
3235 * Whatever made this reset-resume necessary may have
3236 * turned on the port1 bit in hub->change_bits. But after
3237 * a successful reset-resume we want the bit to be clear;
3238 * if it was on it would indicate that something happened
3239 * following the reset-resume.
3241 clear_bit(port1
, hub
->change_bits
);
3247 int usb_disable_ltm(struct usb_device
*udev
)
3249 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3251 /* Check if the roothub and device supports LTM. */
3252 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3253 !usb_device_supports_ltm(udev
))
3256 /* Clear Feature LTM Enable can only be sent if the device is
3259 if (!udev
->actconfig
)
3262 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3263 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3264 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3265 USB_CTRL_SET_TIMEOUT
);
3267 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3269 void usb_enable_ltm(struct usb_device
*udev
)
3271 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3273 /* Check if the roothub and device supports LTM. */
3274 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3275 !usb_device_supports_ltm(udev
))
3278 /* Set Feature LTM Enable can only be sent if the device is
3281 if (!udev
->actconfig
)
3284 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3285 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3286 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3287 USB_CTRL_SET_TIMEOUT
);
3289 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3292 * usb_enable_remote_wakeup - enable remote wakeup for a device
3293 * @udev: target device
3295 * For USB-2 devices: Set the device's remote wakeup feature.
3297 * For USB-3 devices: Assume there's only one function on the device and
3298 * enable remote wake for the first interface. FIXME if the interface
3299 * association descriptor shows there's more than one function.
3301 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3303 if (udev
->speed
< USB_SPEED_SUPER
)
3304 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3305 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3306 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3307 USB_CTRL_SET_TIMEOUT
);
3309 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3310 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3311 USB_INTRF_FUNC_SUSPEND
,
3312 USB_INTRF_FUNC_SUSPEND_RW
|
3313 USB_INTRF_FUNC_SUSPEND_LP
,
3314 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3318 * usb_disable_remote_wakeup - disable remote wakeup for a device
3319 * @udev: target device
3321 * For USB-2 devices: Clear the device's remote wakeup feature.
3323 * For USB-3 devices: Assume there's only one function on the device and
3324 * disable remote wake for the first interface. FIXME if the interface
3325 * association descriptor shows there's more than one function.
3327 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3329 if (udev
->speed
< USB_SPEED_SUPER
)
3330 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3331 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3332 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3333 USB_CTRL_SET_TIMEOUT
);
3335 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3336 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3337 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3338 USB_CTRL_SET_TIMEOUT
);
3341 /* Count of wakeup-enabled devices at or below udev */
3342 unsigned usb_wakeup_enabled_descendants(struct usb_device
*udev
)
3344 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3346 return udev
->do_remote_wakeup
+
3347 (hub
? hub
->wakeup_enabled_descendants
: 0);
3349 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants
);
3352 * usb_port_suspend - suspend a usb device's upstream port
3353 * @udev: device that's no longer in active use, not a root hub
3354 * Context: must be able to sleep; device not locked; pm locks held
3356 * Suspends a USB device that isn't in active use, conserving power.
3357 * Devices may wake out of a suspend, if anything important happens,
3358 * using the remote wakeup mechanism. They may also be taken out of
3359 * suspend by the host, using usb_port_resume(). It's also routine
3360 * to disconnect devices while they are suspended.
3362 * This only affects the USB hardware for a device; its interfaces
3363 * (and, for hubs, child devices) must already have been suspended.
3365 * Selective port suspend reduces power; most suspended devices draw
3366 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3367 * All devices below the suspended port are also suspended.
3369 * Devices leave suspend state when the host wakes them up. Some devices
3370 * also support "remote wakeup", where the device can activate the USB
3371 * tree above them to deliver data, such as a keypress or packet. In
3372 * some cases, this wakes the USB host.
3374 * Suspending OTG devices may trigger HNP, if that's been enabled
3375 * between a pair of dual-role devices. That will change roles, such
3376 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3378 * Devices on USB hub ports have only one "suspend" state, corresponding
3379 * to ACPI D2, "may cause the device to lose some context".
3380 * State transitions include:
3382 * - suspend, resume ... when the VBUS power link stays live
3383 * - suspend, disconnect ... VBUS lost
3385 * Once VBUS drop breaks the circuit, the port it's using has to go through
3386 * normal re-enumeration procedures, starting with enabling VBUS power.
3387 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3388 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3389 * timer, no SRP, no requests through sysfs.
3391 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3392 * suspended until their bus goes into global suspend (i.e., the root
3393 * hub is suspended). Nevertheless, we change @udev->state to
3394 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3395 * upstream port setting is stored in @udev->port_is_suspended.
3397 * Returns 0 on success, else negative errno.
3399 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3401 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3402 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3403 int port1
= udev
->portnum
;
3405 bool really_suspend
= true;
3407 usb_lock_port(port_dev
);
3409 /* enable remote wakeup when appropriate; this lets the device
3410 * wake up the upstream hub (including maybe the root hub).
3412 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3413 * we don't explicitly enable it here.
3415 if (udev
->do_remote_wakeup
) {
3416 status
= usb_enable_remote_wakeup(udev
);
3418 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3420 /* bail if autosuspend is requested */
3421 if (PMSG_IS_AUTO(msg
))
3426 /* disable USB2 hardware LPM */
3427 usb_disable_usb2_hardware_lpm(udev
);
3429 if (usb_disable_ltm(udev
)) {
3430 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n");
3432 if (PMSG_IS_AUTO(msg
))
3437 if (hub_is_superspeed(hub
->hdev
))
3438 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3441 * For system suspend, we do not need to enable the suspend feature
3442 * on individual USB-2 ports. The devices will automatically go
3443 * into suspend a few ms after the root hub stops sending packets.
3444 * The USB 2.0 spec calls this "global suspend".
3446 * However, many USB hubs have a bug: They don't relay wakeup requests
3447 * from a downstream port if the port's suspend feature isn't on.
3448 * Therefore we will turn on the suspend feature if udev or any of its
3449 * descendants is enabled for remote wakeup.
3451 else if (PMSG_IS_AUTO(msg
) || usb_wakeup_enabled_descendants(udev
) > 0)
3452 status
= set_port_feature(hub
->hdev
, port1
,
3453 USB_PORT_FEAT_SUSPEND
);
3455 really_suspend
= false;
3459 /* Check if the port has been suspended for the timeout case
3460 * to prevent the suspended port from incorrect handling.
3462 if (status
== -ETIMEDOUT
) {
3464 u16 portstatus
, portchange
;
3466 portstatus
= portchange
= 0;
3467 ret
= usb_hub_port_status(hub
, port1
, &portstatus
,
3470 dev_dbg(&port_dev
->dev
,
3471 "suspend timeout, status %04x\n", portstatus
);
3473 if (ret
== 0 && port_is_suspended(hub
, portstatus
)) {
3479 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3481 /* Try to enable USB3 LTM again */
3482 usb_enable_ltm(udev
);
3484 /* Try to enable USB2 hardware LPM again */
3485 usb_enable_usb2_hardware_lpm(udev
);
3487 if (udev
->do_remote_wakeup
)
3488 (void) usb_disable_remote_wakeup(udev
);
3491 /* System sleep transitions should never fail */
3492 if (!PMSG_IS_AUTO(msg
))
3496 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3497 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3498 udev
->do_remote_wakeup
);
3499 if (really_suspend
) {
3500 udev
->port_is_suspended
= 1;
3502 /* device has up to 10 msec to fully suspend */
3505 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3508 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3509 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3510 pm_runtime_put_sync(&port_dev
->dev
);
3512 usb_mark_last_busy(hub
->hdev
);
3514 usb_unlock_port(port_dev
);
3519 * If the USB "suspend" state is in use (rather than "global suspend"),
3520 * many devices will be individually taken out of suspend state using
3521 * special "resume" signaling. This routine kicks in shortly after
3522 * hardware resume signaling is finished, either because of selective
3523 * resume (by host) or remote wakeup (by device) ... now see what changed
3524 * in the tree that's rooted at this device.
3526 * If @udev->reset_resume is set then the device is reset before the
3527 * status check is done.
3529 static int finish_port_resume(struct usb_device
*udev
)
3534 /* caller owns the udev device lock */
3535 dev_dbg(&udev
->dev
, "%s\n",
3536 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3538 /* usb ch9 identifies four variants of SUSPENDED, based on what
3539 * state the device resumes to. Linux currently won't see the
3540 * first two on the host side; they'd be inside hub_port_init()
3541 * during many timeouts, but hub_wq can't suspend until later.
3543 usb_set_device_state(udev
, udev
->actconfig
3544 ? USB_STATE_CONFIGURED
3545 : USB_STATE_ADDRESS
);
3547 /* 10.5.4.5 says not to reset a suspended port if the attached
3548 * device is enabled for remote wakeup. Hence the reset
3549 * operation is carried out here, after the port has been
3552 if (udev
->reset_resume
) {
3554 * If the device morphs or switches modes when it is reset,
3555 * we don't want to perform a reset-resume. We'll fail the
3556 * resume, which will cause a logical disconnect, and then
3557 * the device will be rediscovered.
3560 if (udev
->quirks
& USB_QUIRK_RESET
)
3563 status
= usb_reset_and_verify_device(udev
);
3566 /* 10.5.4.5 says be sure devices in the tree are still there.
3567 * For now let's assume the device didn't go crazy on resume,
3568 * and device drivers will know about any resume quirks.
3572 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3574 /* If a normal resume failed, try doing a reset-resume */
3575 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3576 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3577 udev
->reset_resume
= 1;
3578 goto retry_reset_resume
;
3583 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3586 * There are a few quirky devices which violate the standard
3587 * by claiming to have remote wakeup enabled after a reset,
3588 * which crash if the feature is cleared, hence check for
3589 * udev->reset_resume
3591 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3592 if (udev
->speed
< USB_SPEED_SUPER
) {
3593 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3594 status
= usb_disable_remote_wakeup(udev
);
3596 status
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
, 0,
3598 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3599 | USB_INTRF_STAT_FUNC_RW
))
3600 status
= usb_disable_remote_wakeup(udev
);
3605 "disable remote wakeup, status %d\n",
3613 * There are some SS USB devices which take longer time for link training.
3614 * XHCI specs 4.19.4 says that when Link training is successful, port
3615 * sets CCS bit to 1. So if SW reads port status before successful link
3616 * training, then it will not find device to be present.
3617 * USB Analyzer log with such buggy devices show that in some cases
3618 * device switch on the RX termination after long delay of host enabling
3619 * the VBUS. In few other cases it has been seen that device fails to
3620 * negotiate link training in first attempt. It has been
3621 * reported till now that few devices take as long as 2000 ms to train
3622 * the link after host enabling its VBUS and termination. Following
3623 * routine implements a 2000 ms timeout for link training. If in a case
3624 * link trains before timeout, loop will exit earlier.
3626 * There are also some 2.0 hard drive based devices and 3.0 thumb
3627 * drives that, when plugged into a 2.0 only port, take a long
3628 * time to set CCS after VBUS enable.
3630 * FIXME: If a device was connected before suspend, but was removed
3631 * while system was asleep, then the loop in the following routine will
3632 * only exit at timeout.
3634 * This routine should only be called when persist is enabled.
3636 static int wait_for_connected(struct usb_device
*udev
,
3637 struct usb_hub
*hub
, int port1
,
3638 u16
*portchange
, u16
*portstatus
)
3640 int status
= 0, delay_ms
= 0;
3642 while (delay_ms
< 2000) {
3643 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3645 if (!usb_port_is_power_on(hub
, *portstatus
)) {
3651 status
= usb_hub_port_status(hub
, port1
, portstatus
, portchange
);
3653 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3658 * usb_port_resume - re-activate a suspended usb device's upstream port
3659 * @udev: device to re-activate, not a root hub
3660 * Context: must be able to sleep; device not locked; pm locks held
3662 * This will re-activate the suspended device, increasing power usage
3663 * while letting drivers communicate again with its endpoints.
3664 * USB resume explicitly guarantees that the power session between
3665 * the host and the device is the same as it was when the device
3668 * If @udev->reset_resume is set then this routine won't check that the
3669 * port is still enabled. Furthermore, finish_port_resume() above will
3670 * reset @udev. The end result is that a broken power session can be
3671 * recovered and @udev will appear to persist across a loss of VBUS power.
3673 * For example, if a host controller doesn't maintain VBUS suspend current
3674 * during a system sleep or is reset when the system wakes up, all the USB
3675 * power sessions below it will be broken. This is especially troublesome
3676 * for mass-storage devices containing mounted filesystems, since the
3677 * device will appear to have disconnected and all the memory mappings
3678 * to it will be lost. Using the USB_PERSIST facility, the device can be
3679 * made to appear as if it had not disconnected.
3681 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3682 * every effort to insure that the same device is present after the
3683 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3684 * quite possible for a device to remain unaltered but its media to be
3685 * changed. If the user replaces a flash memory card while the system is
3686 * asleep, he will have only himself to blame when the filesystem on the
3687 * new card is corrupted and the system crashes.
3689 * Returns 0 on success, else negative errno.
3691 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3693 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3694 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3695 int port1
= udev
->portnum
;
3697 u16 portchange
, portstatus
;
3699 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3700 status
= pm_runtime_resume_and_get(&port_dev
->dev
);
3702 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3708 usb_lock_port(port_dev
);
3710 /* Skip the initial Clear-Suspend step for a remote wakeup */
3711 status
= usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3712 if (status
== 0 && !port_is_suspended(hub
, portstatus
)) {
3713 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3714 pm_wakeup_event(&udev
->dev
, 0);
3715 goto SuspendCleared
;
3718 /* see 7.1.7.7; affects power usage, but not budgeting */
3719 if (hub_is_superspeed(hub
->hdev
))
3720 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3722 status
= usb_clear_port_feature(hub
->hdev
,
3723 port1
, USB_PORT_FEAT_SUSPEND
);
3725 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3727 /* drive resume for USB_RESUME_TIMEOUT msec */
3728 dev_dbg(&udev
->dev
, "usb %sresume\n",
3729 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3730 msleep(USB_RESUME_TIMEOUT
);
3732 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3733 * stop resume signaling. Then finish the resume
3736 status
= usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3741 udev
->port_is_suspended
= 0;
3742 if (hub_is_superspeed(hub
->hdev
)) {
3743 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3744 usb_clear_port_feature(hub
->hdev
, port1
,
3745 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3747 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3748 usb_clear_port_feature(hub
->hdev
, port1
,
3749 USB_PORT_FEAT_C_SUSPEND
);
3752 /* TRSMRCY = 10 msec */
3756 if (udev
->persist_enabled
)
3757 status
= wait_for_connected(udev
, hub
, port1
, &portchange
,
3760 status
= check_port_resume_type(udev
,
3761 hub
, port1
, status
, portchange
, portstatus
);
3763 status
= finish_port_resume(udev
);
3765 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3766 hub_port_logical_disconnect(hub
, port1
);
3768 /* Try to enable USB2 hardware LPM */
3769 usb_enable_usb2_hardware_lpm(udev
);
3771 /* Try to enable USB3 LTM */
3772 usb_enable_ltm(udev
);
3775 usb_unlock_port(port_dev
);
3780 int usb_remote_wakeup(struct usb_device
*udev
)
3784 usb_lock_device(udev
);
3785 if (udev
->state
== USB_STATE_SUSPENDED
) {
3786 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3787 status
= usb_autoresume_device(udev
);
3789 /* Let the drivers do their thing, then... */
3790 usb_autosuspend_device(udev
);
3793 usb_unlock_device(udev
);
3797 /* Returns 1 if there was a remote wakeup and a connect status change. */
3798 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3799 u16 portstatus
, u16 portchange
)
3800 __must_hold(&port_dev
->status_lock
)
3802 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3803 struct usb_device
*hdev
;
3804 struct usb_device
*udev
;
3805 int connect_change
= 0;
3810 udev
= port_dev
->child
;
3811 if (!hub_is_superspeed(hdev
)) {
3812 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3814 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3816 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
3817 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3818 (link_state
!= USB_SS_PORT_LS_U0
&&
3819 link_state
!= USB_SS_PORT_LS_U1
&&
3820 link_state
!= USB_SS_PORT_LS_U2
))
3825 /* TRSMRCY = 10 msec */
3828 usb_unlock_port(port_dev
);
3829 ret
= usb_remote_wakeup(udev
);
3830 usb_lock_port(port_dev
);
3835 hub_port_disable(hub
, port
, 1);
3837 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3838 return connect_change
;
3841 static int check_ports_changed(struct usb_hub
*hub
)
3845 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3846 u16 portstatus
, portchange
;
3849 status
= usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3850 if (!status
&& portchange
)
3856 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3858 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3859 struct usb_device
*hdev
= hub
->hdev
;
3863 * Warn if children aren't already suspended.
3864 * Also, add up the number of wakeup-enabled descendants.
3866 hub
->wakeup_enabled_descendants
= 0;
3867 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3868 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3869 struct usb_device
*udev
= port_dev
->child
;
3871 if (udev
&& udev
->can_submit
) {
3872 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3873 dev_name(&udev
->dev
));
3874 if (PMSG_IS_AUTO(msg
))
3878 hub
->wakeup_enabled_descendants
+=
3879 usb_wakeup_enabled_descendants(udev
);
3882 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3883 /* check if there are changes pending on hub ports */
3884 if (check_ports_changed(hub
)) {
3885 if (PMSG_IS_AUTO(msg
))
3887 pm_wakeup_event(&hdev
->dev
, 2000);
3891 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3892 /* Enable hub to send remote wakeup for all ports. */
3893 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3894 set_port_feature(hdev
,
3896 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3897 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3898 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3899 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3903 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3905 /* stop hub_wq and related activity */
3906 hub_quiesce(hub
, HUB_SUSPEND
);
3910 /* Report wakeup requests from the ports of a resuming root hub */
3911 static void report_wakeup_requests(struct usb_hub
*hub
)
3913 struct usb_device
*hdev
= hub
->hdev
;
3914 struct usb_device
*udev
;
3915 struct usb_hcd
*hcd
;
3916 unsigned long resuming_ports
;
3920 return; /* Not a root hub */
3922 hcd
= bus_to_hcd(hdev
->bus
);
3923 if (hcd
->driver
->get_resuming_ports
) {
3926 * The get_resuming_ports() method returns a bitmap (origin 0)
3927 * of ports which have started wakeup signaling but have not
3928 * yet finished resuming. During system resume we will
3929 * resume all the enabled ports, regardless of any wakeup
3930 * signals, which means the wakeup requests would be lost.
3931 * To prevent this, report them to the PM core here.
3933 resuming_ports
= hcd
->driver
->get_resuming_ports(hcd
);
3934 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
3935 if (test_bit(i
, &resuming_ports
)) {
3936 udev
= hub
->ports
[i
]->child
;
3938 pm_wakeup_event(&udev
->dev
, 0);
3944 static int hub_resume(struct usb_interface
*intf
)
3946 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3948 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3949 hub_activate(hub
, HUB_RESUME
);
3952 * This should be called only for system resume, not runtime resume.
3953 * We can't tell the difference here, so some wakeup requests will be
3954 * reported at the wrong time or more than once. This shouldn't
3955 * matter much, so long as they do get reported.
3957 report_wakeup_requests(hub
);
3961 static int hub_reset_resume(struct usb_interface
*intf
)
3963 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3965 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3966 hub_activate(hub
, HUB_RESET_RESUME
);
3971 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3972 * @rhdev: struct usb_device for the root hub
3974 * The USB host controller driver calls this function when its root hub
3975 * is resumed and Vbus power has been interrupted or the controller
3976 * has been reset. The routine marks @rhdev as having lost power.
3977 * When the hub driver is resumed it will take notice and carry out
3978 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3979 * the others will be disconnected.
3981 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3983 dev_notice(&rhdev
->dev
, "root hub lost power or was reset\n");
3984 rhdev
->reset_resume
= 1;
3986 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3988 static const char * const usb3_lpm_names
[] = {
3996 * Send a Set SEL control transfer to the device, prior to enabling
3997 * device-initiated U1 or U2. This lets the device know the exit latencies from
3998 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3999 * packet from the host.
4001 * This function will fail if the SEL or PEL values for udev are greater than
4002 * the maximum allowed values for the link state to be enabled.
4004 static int usb_req_set_sel(struct usb_device
*udev
)
4006 struct usb_set_sel_req
*sel_values
;
4007 unsigned long long u1_sel
;
4008 unsigned long long u1_pel
;
4009 unsigned long long u2_sel
;
4010 unsigned long long u2_pel
;
4013 if (!udev
->parent
|| udev
->speed
< USB_SPEED_SUPER
|| !udev
->lpm_capable
)
4016 /* Convert SEL and PEL stored in ns to us */
4017 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
4018 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
4019 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
4020 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
4023 * Make sure that the calculated SEL and PEL values for the link
4024 * state we're enabling aren't bigger than the max SEL/PEL
4025 * value that will fit in the SET SEL control transfer.
4026 * Otherwise the device would get an incorrect idea of the exit
4027 * latency for the link state, and could start a device-initiated
4028 * U1/U2 when the exit latencies are too high.
4030 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
4031 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
||
4032 u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
4033 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
) {
4034 dev_dbg(&udev
->dev
, "Device-initiated U1/U2 disabled due to long SEL or PEL\n");
4039 * usb_enable_lpm() can be called as part of a failed device reset,
4040 * which may be initiated by an error path of a mass storage driver.
4041 * Therefore, use GFP_NOIO.
4043 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
4047 sel_values
->u1_sel
= u1_sel
;
4048 sel_values
->u1_pel
= u1_pel
;
4049 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
4050 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
4052 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4056 sel_values
, sizeof *(sel_values
),
4057 USB_CTRL_SET_TIMEOUT
);
4061 udev
->lpm_devinit_allow
= 1;
4067 * Enable or disable device-initiated U1 or U2 transitions.
4069 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
4070 enum usb3_link_state state
, bool enable
)
4077 feature
= USB_DEVICE_U1_ENABLE
;
4080 feature
= USB_DEVICE_U2_ENABLE
;
4083 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
4084 __func__
, enable
? "enable" : "disable");
4088 if (udev
->state
!= USB_STATE_CONFIGURED
) {
4089 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
4090 "for unconfigured device.\n",
4091 __func__
, enable
? "enable" : "disable",
4092 usb3_lpm_names
[state
]);
4098 * Now send the control transfer to enable device-initiated LPM
4099 * for either U1 or U2.
4101 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4102 USB_REQ_SET_FEATURE
,
4106 USB_CTRL_SET_TIMEOUT
);
4108 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4109 USB_REQ_CLEAR_FEATURE
,
4113 USB_CTRL_SET_TIMEOUT
);
4116 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
4117 enable
? "Enable" : "Disable",
4118 usb3_lpm_names
[state
]);
4124 static int usb_set_lpm_timeout(struct usb_device
*udev
,
4125 enum usb3_link_state state
, int timeout
)
4132 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
4135 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
4138 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
4143 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
4144 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
4145 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
4146 "which is a reserved value.\n",
4147 usb3_lpm_names
[state
], timeout
);
4151 ret
= set_port_feature(udev
->parent
,
4152 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
4155 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
4156 "error code %i\n", usb3_lpm_names
[state
],
4160 if (state
== USB3_LPM_U1
)
4161 udev
->u1_params
.timeout
= timeout
;
4163 udev
->u2_params
.timeout
= timeout
;
4168 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4169 * interval is greater than the minimum service interval of any active
4170 * periodic endpoint. See USB 3.2 section 9.4.9
4172 static bool usb_device_may_initiate_lpm(struct usb_device
*udev
,
4173 enum usb3_link_state state
)
4175 unsigned int sel
; /* us */
4178 if (!udev
->lpm_devinit_allow
)
4181 if (state
== USB3_LPM_U1
)
4182 sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
4183 else if (state
== USB3_LPM_U2
)
4184 sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
4188 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
4189 struct usb_interface
*intf
;
4190 struct usb_endpoint_descriptor
*desc
;
4191 unsigned int interval
;
4193 intf
= udev
->actconfig
->interface
[i
];
4197 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++) {
4198 desc
= &intf
->cur_altsetting
->endpoint
[j
].desc
;
4200 if (usb_endpoint_xfer_int(desc
) ||
4201 usb_endpoint_xfer_isoc(desc
)) {
4202 interval
= (1 << (desc
->bInterval
- 1)) * 125;
4203 if (sel
+ 125 > interval
)
4212 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4215 * We will attempt to enable U1 or U2, but there are no guarantees that the
4216 * control transfers to set the hub timeout or enable device-initiated U1/U2
4217 * will be successful.
4219 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4220 * hub-initiated U1/U2 will be disabled.
4222 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4223 * driver know about it. If that call fails, it should be harmless, and just
4224 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4226 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4227 enum usb3_link_state state
)
4233 /* Skip if the device BOS descriptor couldn't be read */
4237 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
4238 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
4240 /* If the device says it doesn't have *any* exit latency to come out of
4241 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4244 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
4245 (state
== USB3_LPM_U2
&& u2_mel
== 0))
4248 /* We allow the host controller to set the U1/U2 timeout internally
4249 * first, so that it can change its schedule to account for the
4250 * additional latency to send data to a device in a lower power
4253 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
4255 /* xHCI host controller doesn't want to enable this LPM state. */
4260 dev_warn(&udev
->dev
, "Could not enable %s link state, "
4261 "xHCI error %i.\n", usb3_lpm_names
[state
],
4266 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
4267 /* If we can't set the parent hub U1/U2 timeout,
4268 * device-initiated LPM won't be allowed either, so let the xHCI
4269 * host know that this link state won't be enabled.
4271 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4275 /* Only a configured device will accept the Set Feature
4278 if (udev
->actconfig
&&
4279 usb_device_may_initiate_lpm(udev
, state
)) {
4280 if (usb_set_device_initiated_lpm(udev
, state
, true)) {
4282 * Request to enable device initiated U1/U2 failed,
4283 * better to turn off lpm in this case.
4285 usb_set_lpm_timeout(udev
, state
, 0);
4286 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4291 if (state
== USB3_LPM_U1
)
4292 udev
->usb3_lpm_u1_enabled
= 1;
4293 else if (state
== USB3_LPM_U2
)
4294 udev
->usb3_lpm_u2_enabled
= 1;
4297 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4300 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4301 * If zero is returned, the parent will not allow the link to go into U1/U2.
4303 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4304 * it won't have an effect on the bus link state because the parent hub will
4305 * still disallow device-initiated U1/U2 entry.
4307 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4308 * possible. The result will be slightly more bus bandwidth will be taken up
4309 * (to account for U1/U2 exit latency), but it should be harmless.
4311 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4312 enum usb3_link_state state
)
4319 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4324 if (usb_set_lpm_timeout(udev
, state
, 0))
4327 usb_set_device_initiated_lpm(udev
, state
, false);
4329 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4330 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4331 "bus schedule bandwidth may be impacted.\n",
4332 usb3_lpm_names
[state
]);
4334 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4335 * is disabled. Hub will disallows link to enter U1/U2 as well,
4336 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4337 * timeout set to 0, no matter device-initiated LPM is disabled or
4340 if (state
== USB3_LPM_U1
)
4341 udev
->usb3_lpm_u1_enabled
= 0;
4342 else if (state
== USB3_LPM_U2
)
4343 udev
->usb3_lpm_u2_enabled
= 0;
4349 * Disable hub-initiated and device-initiated U1 and U2 entry.
4350 * Caller must own the bandwidth_mutex.
4352 * This will call usb_enable_lpm() on failure, which will decrement
4353 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4355 int usb_disable_lpm(struct usb_device
*udev
)
4357 struct usb_hcd
*hcd
;
4359 if (!udev
|| !udev
->parent
||
4360 udev
->speed
< USB_SPEED_SUPER
||
4361 !udev
->lpm_capable
||
4362 udev
->state
< USB_STATE_CONFIGURED
)
4365 hcd
= bus_to_hcd(udev
->bus
);
4366 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4369 udev
->lpm_disable_count
++;
4370 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4373 /* If LPM is enabled, attempt to disable it. */
4374 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4376 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4382 usb_enable_lpm(udev
);
4385 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4387 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4388 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4390 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4396 mutex_lock(hcd
->bandwidth_mutex
);
4397 ret
= usb_disable_lpm(udev
);
4398 mutex_unlock(hcd
->bandwidth_mutex
);
4402 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4405 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4406 * xHCI host policy may prevent U1 or U2 from being enabled.
4408 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4409 * until the lpm_disable_count drops to zero. Caller must own the
4412 void usb_enable_lpm(struct usb_device
*udev
)
4414 struct usb_hcd
*hcd
;
4415 struct usb_hub
*hub
;
4416 struct usb_port
*port_dev
;
4418 if (!udev
|| !udev
->parent
||
4419 udev
->speed
< USB_SPEED_SUPER
||
4420 !udev
->lpm_capable
||
4421 udev
->state
< USB_STATE_CONFIGURED
)
4424 udev
->lpm_disable_count
--;
4425 hcd
= bus_to_hcd(udev
->bus
);
4426 /* Double check that we can both enable and disable LPM.
4427 * Device must be configured to accept set feature U1/U2 timeout.
4429 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4430 !hcd
->driver
->disable_usb3_lpm_timeout
)
4433 if (udev
->lpm_disable_count
> 0)
4436 hub
= usb_hub_to_struct_hub(udev
->parent
);
4440 port_dev
= hub
->ports
[udev
->portnum
- 1];
4442 if (port_dev
->usb3_lpm_u1_permit
)
4443 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4445 if (port_dev
->usb3_lpm_u2_permit
)
4446 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4448 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4450 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4451 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4453 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4458 mutex_lock(hcd
->bandwidth_mutex
);
4459 usb_enable_lpm(udev
);
4460 mutex_unlock(hcd
->bandwidth_mutex
);
4462 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4464 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4465 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4466 struct usb_port
*port_dev
)
4468 struct usb_device
*udev
= port_dev
->child
;
4471 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4472 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4475 msleep(USB_RESUME_TIMEOUT
);
4476 ret
= usb_disable_remote_wakeup(udev
);
4479 dev_warn(&udev
->dev
,
4480 "Port disable: can't disable remote wake\n");
4481 udev
->do_remote_wakeup
= 0;
4485 #else /* CONFIG_PM */
4487 #define hub_suspend NULL
4488 #define hub_resume NULL
4489 #define hub_reset_resume NULL
4491 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4492 struct usb_port
*port_dev
) { }
4494 int usb_disable_lpm(struct usb_device
*udev
)
4498 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4500 void usb_enable_lpm(struct usb_device
*udev
) { }
4501 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4503 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4507 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4509 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4510 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4512 int usb_disable_ltm(struct usb_device
*udev
)
4516 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4518 void usb_enable_ltm(struct usb_device
*udev
) { }
4519 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4521 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4522 u16 portstatus
, u16 portchange
)
4527 static int usb_req_set_sel(struct usb_device
*udev
)
4532 #endif /* CONFIG_PM */
4535 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4536 * a connection with a plugged-in cable but will signal the host when the cable
4537 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4539 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4541 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4542 struct usb_device
*hdev
= hub
->hdev
;
4546 if (hub_is_superspeed(hub
->hdev
)) {
4547 hub_usb3_port_prepare_disable(hub
, port_dev
);
4548 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4551 ret
= usb_clear_port_feature(hdev
, port1
,
4552 USB_PORT_FEAT_ENABLE
);
4555 if (port_dev
->child
&& set_state
)
4556 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4557 if (ret
&& ret
!= -ENODEV
)
4558 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4563 * usb_port_disable - disable a usb device's upstream port
4564 * @udev: device to disable
4565 * Context: @udev locked, must be able to sleep.
4567 * Disables a USB device that isn't in active use.
4569 int usb_port_disable(struct usb_device
*udev
)
4571 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4573 return hub_port_disable(hub
, udev
->portnum
, 0);
4576 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4578 * Between connect detection and reset signaling there must be a delay
4579 * of 100ms at least for debounce and power-settling. The corresponding
4580 * timer shall restart whenever the downstream port detects a disconnect.
4582 * Apparently there are some bluetooth and irda-dongles and a number of
4583 * low-speed devices for which this debounce period may last over a second.
4584 * Not covered by the spec - but easy to deal with.
4586 * This implementation uses a 1500ms total debounce timeout; if the
4587 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4588 * every 25ms for transient disconnects. When the port status has been
4589 * unchanged for 100ms it returns the port status.
4591 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4594 u16 portchange
, portstatus
;
4595 unsigned connection
= 0xffff;
4596 int total_time
, stable_time
= 0;
4597 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4599 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4600 ret
= usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4604 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4605 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4606 if (!must_be_connected
||
4607 (connection
== USB_PORT_STAT_CONNECTION
))
4608 stable_time
+= HUB_DEBOUNCE_STEP
;
4609 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4613 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4616 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4617 usb_clear_port_feature(hub
->hdev
, port1
,
4618 USB_PORT_FEAT_C_CONNECTION
);
4621 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4623 msleep(HUB_DEBOUNCE_STEP
);
4626 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4627 total_time
, stable_time
, portstatus
);
4629 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4634 void usb_ep0_reinit(struct usb_device
*udev
)
4636 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4637 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4638 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4640 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4642 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4643 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4645 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4648 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4651 * The host controller will choose the device address,
4652 * instead of the core having chosen it earlier
4654 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4656 if (udev
->state
== USB_STATE_ADDRESS
)
4658 if (udev
->state
!= USB_STATE_DEFAULT
)
4660 if (hcd
->driver
->address_device
)
4661 retval
= hcd
->driver
->address_device(hcd
, udev
);
4663 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4664 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4665 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4667 update_devnum(udev
, devnum
);
4668 /* Device now using proper address. */
4669 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4670 usb_ep0_reinit(udev
);
4676 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4677 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4680 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4681 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4682 * support bit in the BOS descriptor.
4684 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4686 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4687 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4689 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4693 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4695 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4696 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4697 udev
->usb2_hw_lpm_allowed
= 1;
4698 usb_enable_usb2_hardware_lpm(udev
);
4702 static int hub_enable_device(struct usb_device
*udev
)
4704 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4706 if (!hcd
->driver
->enable_device
)
4708 if (udev
->state
== USB_STATE_ADDRESS
)
4710 if (udev
->state
!= USB_STATE_DEFAULT
)
4713 return hcd
->driver
->enable_device(hcd
, udev
);
4717 * Get the bMaxPacketSize0 value during initialization by reading the
4718 * device's device descriptor. Since we don't already know this value,
4719 * the transfer is unsafe and it ignores I/O errors, only testing for
4720 * reasonable received values.
4722 * For "old scheme" initialization, size will be 8 so we read just the
4723 * start of the device descriptor, which should work okay regardless of
4724 * the actual bMaxPacketSize0 value. For "new scheme" initialization,
4725 * size will be 64 (and buf will point to a sufficiently large buffer),
4726 * which might not be kosher according to the USB spec but it's what
4727 * Windows does and what many devices expect.
4729 * Returns: bMaxPacketSize0 or a negative error code.
4731 static int get_bMaxPacketSize0(struct usb_device
*udev
,
4732 struct usb_device_descriptor
*buf
, int size
, bool first_time
)
4737 * Retry on all errors; some devices are flakey.
4738 * 255 is for WUSB devices, we actually need to use
4739 * 512 (WUSB1.0[4.8.1]).
4741 for (i
= 0; i
< GET_MAXPACKET0_TRIES
; ++i
) {
4742 /* Start with invalid values in case the transfer fails */
4743 buf
->bDescriptorType
= buf
->bMaxPacketSize0
= 0;
4744 rc
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4745 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4746 USB_DT_DEVICE
<< 8, 0,
4748 initial_descriptor_timeout
);
4749 switch (buf
->bMaxPacketSize0
) {
4750 case 8: case 16: case 32: case 64: case 9:
4751 if (buf
->bDescriptorType
== USB_DT_DEVICE
) {
4752 rc
= buf
->bMaxPacketSize0
;
4763 * Some devices time out if they are powered on
4764 * when already connected. They need a second
4765 * reset, so return early. But only on the first
4766 * attempt, lest we get into a time-out/reset loop.
4768 if (rc
> 0 || (rc
== -ETIMEDOUT
&& first_time
&&
4769 udev
->speed
> USB_SPEED_FULL
))
4775 #define GET_DESCRIPTOR_BUFSIZE 64
4777 /* Reset device, (re)assign address, get device descriptor.
4778 * Device connection must be stable, no more debouncing needed.
4779 * Returns device in USB_STATE_ADDRESS, except on error.
4781 * If this is called for an already-existing device (as part of
4782 * usb_reset_and_verify_device), the caller must own the device lock and
4783 * the port lock. For a newly detected device that is not accessible
4784 * through any global pointers, it's not necessary to lock the device,
4785 * but it is still necessary to lock the port.
4787 * For a newly detected device, @dev_descr must be NULL. The device
4788 * descriptor retrieved from the device will then be stored in
4789 * @udev->descriptor. For an already existing device, @dev_descr
4790 * must be non-NULL. The device descriptor will be stored there,
4791 * not in @udev->descriptor, because descriptors for registered
4792 * devices are meant to be immutable.
4795 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4796 int retry_counter
, struct usb_device_descriptor
*dev_descr
)
4798 struct usb_device
*hdev
= hub
->hdev
;
4799 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4800 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4801 int retries
, operations
, retval
, i
;
4802 unsigned delay
= HUB_SHORT_RESET_TIME
;
4803 enum usb_device_speed oldspeed
= udev
->speed
;
4805 int devnum
= udev
->devnum
;
4806 const char *driver_name
;
4808 const bool initial
= !dev_descr
;
4810 struct usb_device_descriptor
*buf
, *descr
;
4812 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4816 /* root hub ports have a slightly longer reset period
4817 * (from USB 2.0 spec, section 7.1.7.5)
4819 if (!hdev
->parent
) {
4820 delay
= HUB_ROOT_RESET_TIME
;
4821 if (port1
== hdev
->bus
->otg_port
)
4822 hdev
->bus
->b_hnp_enable
= 0;
4825 /* Some low speed devices have problems with the quick delay, so */
4826 /* be a bit pessimistic with those devices. RHbug #23670 */
4827 if (oldspeed
== USB_SPEED_LOW
)
4828 delay
= HUB_LONG_RESET_TIME
;
4830 /* Reset the device; full speed may morph to high speed */
4831 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4832 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4833 if (retval
< 0) /* error or disconnect */
4835 /* success, speed is known */
4839 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4840 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4841 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4842 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4845 oldspeed
= udev
->speed
;
4848 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4849 * it's fixed size except for full speed devices.
4851 switch (udev
->speed
) {
4852 case USB_SPEED_SUPER_PLUS
:
4853 case USB_SPEED_SUPER
:
4854 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4856 case USB_SPEED_HIGH
: /* fixed at 64 */
4857 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4859 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4860 /* to determine the ep0 maxpacket size, try to read
4861 * the device descriptor to get bMaxPacketSize0 and
4862 * then correct our initial guess.
4864 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4866 case USB_SPEED_LOW
: /* fixed at 8 */
4867 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4874 speed
= usb_speed_string(udev
->speed
);
4877 * The controller driver may be NULL if the controller device
4878 * is the middle device between platform device and roothub.
4879 * This middle device may not need a device driver due to
4880 * all hardware control can be at platform device driver, this
4881 * platform device is usually a dual-role USB controller device.
4883 if (udev
->bus
->controller
->driver
)
4884 driver_name
= udev
->bus
->controller
->driver
->name
;
4886 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4888 if (udev
->speed
< USB_SPEED_SUPER
)
4889 dev_info(&udev
->dev
,
4890 "%s %s USB device number %d using %s\n",
4891 (initial
? "new" : "reset"), speed
,
4892 devnum
, driver_name
);
4895 /* Set up TT records, if needed */
4897 udev
->tt
= hdev
->tt
;
4898 udev
->ttport
= hdev
->ttport
;
4899 } else if (udev
->speed
!= USB_SPEED_HIGH
4900 && hdev
->speed
== USB_SPEED_HIGH
) {
4902 dev_err(&udev
->dev
, "parent hub has no TT\n");
4906 udev
->tt
= &hub
->tt
;
4907 udev
->ttport
= port1
;
4911 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4912 * Because device hardware and firmware is sometimes buggy in
4913 * this area, and this is how Linux has done it for ages.
4914 * Change it cautiously.
4916 * NOTE: If use_new_scheme() is true we will start by issuing
4917 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4918 * so it may help with some non-standards-compliant devices.
4919 * Otherwise we start with SET_ADDRESS and then try to read the
4920 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4923 do_new_scheme
= use_new_scheme(udev
, retry_counter
, port_dev
);
4925 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4926 if (hub_port_stop_enumerate(hub
, port1
, retries
)) {
4931 if (do_new_scheme
) {
4932 retval
= hub_enable_device(udev
);
4935 "hub failed to enable device, error %d\n",
4940 maxp0
= get_bMaxPacketSize0(udev
, buf
,
4941 GET_DESCRIPTOR_BUFSIZE
, retries
== 0);
4942 if (maxp0
> 0 && !initial
&&
4943 maxp0
!= udev
->descriptor
.bMaxPacketSize0
) {
4944 dev_err(&udev
->dev
, "device reset changed ep0 maxpacket size!\n");
4949 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4950 if (retval
< 0) /* error or disconnect */
4952 if (oldspeed
!= udev
->speed
) {
4954 "device reset changed speed!\n");
4959 if (maxp0
!= -ENODEV
)
4960 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4967 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4968 retval
= hub_set_address(udev
, devnum
);
4974 if (retval
!= -ENODEV
)
4975 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4979 if (udev
->speed
>= USB_SPEED_SUPER
) {
4980 devnum
= udev
->devnum
;
4981 dev_info(&udev
->dev
,
4982 "%s SuperSpeed%s%s USB device number %d using %s\n",
4983 (udev
->config
) ? "reset" : "new",
4984 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ?
4986 (udev
->ssp_rate
== USB_SSP_GEN_2x2
) ?
4988 (udev
->ssp_rate
== USB_SSP_GEN_2x1
) ?
4990 (udev
->ssp_rate
== USB_SSP_GEN_1x2
) ?
4992 devnum
, driver_name
);
4996 * cope with hardware quirkiness:
4997 * - let SET_ADDRESS settle, some device hardware wants it
4998 * - read ep0 maxpacket even for high and low speed,
5005 maxp0
= get_bMaxPacketSize0(udev
, buf
, 8, retries
== 0);
5008 if (retval
!= -ENODEV
)
5010 "device descriptor read/8, error %d\n",
5015 if (!initial
&& maxp0
!= udev
->descriptor
.bMaxPacketSize0
) {
5016 dev_err(&udev
->dev
, "device reset changed ep0 maxpacket size!\n");
5021 delay
= udev
->parent
->hub_delay
;
5022 udev
->hub_delay
= min_t(u32
, delay
,
5023 USB_TP_TRANSMISSION_DELAY_MAX
);
5024 retval
= usb_set_isoch_delay(udev
);
5027 "Failed set isoch delay, error %d\n",
5038 * Check the ep0 maxpacket guess and correct it if necessary.
5039 * maxp0 is the value stored in the device descriptor;
5040 * i is the value it encodes (logarithmic for SuperSpeed or greater).
5043 if (udev
->speed
>= USB_SPEED_SUPER
) {
5047 i
= 0; /* Invalid */
5049 if (usb_endpoint_maxp(&udev
->ep0
.desc
) == i
) {
5050 ; /* Initial ep0 maxpacket guess is right */
5051 } else if ((udev
->speed
== USB_SPEED_FULL
||
5052 udev
->speed
== USB_SPEED_HIGH
) &&
5053 (i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
5054 /* Initial guess is wrong; use the descriptor's value */
5055 if (udev
->speed
== USB_SPEED_FULL
)
5056 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
5058 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
5059 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
5060 usb_ep0_reinit(udev
);
5062 /* Initial guess is wrong and descriptor's value is invalid */
5063 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", maxp0
);
5068 descr
= usb_get_device_descriptor(udev
);
5069 if (IS_ERR(descr
)) {
5070 retval
= PTR_ERR(descr
);
5071 if (retval
!= -ENODEV
)
5072 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
5077 udev
->descriptor
= *descr
;
5079 *dev_descr
= *descr
;
5083 * Some superspeed devices have finished the link training process
5084 * and attached to a superspeed hub port, but the device descriptor
5085 * got from those devices show they aren't superspeed devices. Warm
5086 * reset the port attached by the devices can fix them.
5088 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
5089 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
5090 dev_err(&udev
->dev
, "got a wrong device descriptor, warm reset device\n");
5091 hub_port_reset(hub
, port1
, udev
, HUB_BH_RESET_TIME
, true);
5096 usb_detect_quirks(udev
);
5098 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
5099 retval
= usb_get_bos_descriptor(udev
);
5101 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
5102 udev
->lpm_disable_count
= 1;
5103 usb_set_lpm_parameters(udev
);
5104 usb_req_set_sel(udev
);
5109 /* notify HCD that we have a device connected and addressed */
5110 if (hcd
->driver
->update_device
)
5111 hcd
->driver
->update_device(hcd
, udev
);
5112 hub_set_initial_usb2_lpm_policy(udev
);
5115 hub_port_disable(hub
, port1
, 0);
5116 update_devnum(udev
, devnum
); /* for disconnect processing */
5123 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
5125 struct usb_qualifier_descriptor
*qual
;
5128 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
5131 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
5135 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
5136 qual
, sizeof *qual
);
5137 if (status
== sizeof *qual
) {
5138 dev_info(&udev
->dev
, "not running at top speed; "
5139 "connect to a high speed hub\n");
5140 /* hub LEDs are probably harder to miss than syslog */
5141 if (hub
->has_indicators
) {
5142 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
5143 queue_delayed_work(system_power_efficient_wq
,
5151 hub_power_remaining(struct usb_hub
*hub
)
5153 struct usb_device
*hdev
= hub
->hdev
;
5157 if (!hub
->limited_power
)
5160 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
5161 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
5162 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5163 struct usb_device
*udev
= port_dev
->child
;
5169 if (hub_is_superspeed(udev
))
5175 * Unconfigured devices may not use more than one unit load,
5176 * or 8mA for OTG ports
5178 if (udev
->actconfig
)
5179 delta
= usb_get_max_power(udev
, udev
->actconfig
);
5180 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
5184 if (delta
> hub
->mA_per_port
)
5185 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
5186 delta
, hub
->mA_per_port
);
5189 if (remaining
< 0) {
5190 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
5198 static int descriptors_changed(struct usb_device
*udev
,
5199 struct usb_device_descriptor
*new_device_descriptor
,
5200 struct usb_host_bos
*old_bos
)
5204 unsigned serial_len
= 0;
5206 unsigned old_length
;
5210 if (memcmp(&udev
->descriptor
, new_device_descriptor
,
5211 sizeof(*new_device_descriptor
)) != 0)
5214 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5217 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5218 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5220 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5224 /* Since the idVendor, idProduct, and bcdDevice values in the
5225 * device descriptor haven't changed, we will assume the
5226 * Manufacturer and Product strings haven't changed either.
5227 * But the SerialNumber string could be different (e.g., a
5228 * different flash card of the same brand).
5231 serial_len
= strlen(udev
->serial
) + 1;
5234 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5235 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5236 len
= max(len
, old_length
);
5239 buf
= kmalloc(len
, GFP_NOIO
);
5241 /* assume the worst */
5244 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5245 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5246 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5248 if (length
!= old_length
) {
5249 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5254 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5256 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5258 ((struct usb_config_descriptor
*) buf
)->
5259 bConfigurationValue
);
5265 if (!changed
&& serial_len
) {
5266 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5268 if (length
+ 1 != serial_len
) {
5269 dev_dbg(&udev
->dev
, "serial string error %d\n",
5272 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5273 dev_dbg(&udev
->dev
, "serial string changed\n");
5282 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
5285 int status
= -ENODEV
;
5288 struct usb_device
*hdev
= hub
->hdev
;
5289 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
5290 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5291 struct usb_device
*udev
= port_dev
->child
;
5292 static int unreliable_port
= -1;
5295 /* Disconnect any existing devices under this port */
5297 if (hcd
->usb_phy
&& !hdev
->parent
)
5298 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
5299 usb_disconnect(&port_dev
->child
);
5302 /* We can forget about a "removed" device when there's a physical
5303 * disconnect or the connect status changes.
5305 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5306 (portchange
& USB_PORT_STAT_C_CONNECTION
))
5307 clear_bit(port1
, hub
->removed_bits
);
5309 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
5310 USB_PORT_STAT_C_ENABLE
)) {
5311 status
= hub_port_debounce_be_stable(hub
, port1
);
5313 if (status
!= -ENODEV
&&
5314 port1
!= unreliable_port
&&
5316 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
5317 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
5318 unreliable_port
= port1
;
5320 portstatus
= status
;
5324 /* Return now if debouncing failed or nothing is connected or
5325 * the device was "removed".
5327 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5328 test_bit(port1
, hub
->removed_bits
)) {
5331 * maybe switch power back on (e.g. root hub was reset)
5332 * but only if the port isn't owned by someone else.
5334 if (hub_is_port_power_switchable(hub
)
5335 && !usb_port_is_power_on(hub
, portstatus
)
5336 && !port_dev
->port_owner
)
5337 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
5339 if (portstatus
& USB_PORT_STAT_ENABLE
)
5343 if (hub_is_superspeed(hub
->hdev
))
5350 for (i
= 0; i
< PORT_INIT_TRIES
; i
++) {
5351 if (hub_port_stop_enumerate(hub
, port1
, i
)) {
5356 usb_lock_port(port_dev
);
5357 mutex_lock(hcd
->address0_mutex
);
5358 retry_locked
= true;
5359 /* reallocate for each attempt, since references
5360 * to the previous one can escape in various ways
5362 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
5364 dev_err(&port_dev
->dev
,
5365 "couldn't allocate usb_device\n");
5366 mutex_unlock(hcd
->address0_mutex
);
5367 usb_unlock_port(port_dev
);
5371 usb_set_device_state(udev
, USB_STATE_POWERED
);
5372 udev
->bus_mA
= hub
->mA_per_port
;
5373 udev
->level
= hdev
->level
+ 1;
5375 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5376 if (hub_is_superspeed(hub
->hdev
))
5377 udev
->speed
= USB_SPEED_SUPER
;
5379 udev
->speed
= USB_SPEED_UNKNOWN
;
5381 choose_devnum(udev
);
5382 if (udev
->devnum
<= 0) {
5383 status
= -ENOTCONN
; /* Don't retry */
5387 /* reset (non-USB 3.0 devices) and get descriptor */
5388 status
= hub_port_init(hub
, udev
, port1
, i
, NULL
);
5392 mutex_unlock(hcd
->address0_mutex
);
5393 usb_unlock_port(port_dev
);
5394 retry_locked
= false;
5396 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
5399 /* consecutive bus-powered hubs aren't reliable; they can
5400 * violate the voltage drop budget. if the new child has
5401 * a "powered" LED, users should notice we didn't enable it
5402 * (without reading syslog), even without per-port LEDs
5405 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
5406 && udev
->bus_mA
<= unit_load
) {
5409 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0,
5412 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
5415 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
5417 "can't connect bus-powered hub "
5419 if (hub
->has_indicators
) {
5420 hub
->indicator
[port1
-1] =
5421 INDICATOR_AMBER_BLINK
;
5423 system_power_efficient_wq
,
5426 status
= -ENOTCONN
; /* Don't retry */
5431 /* check for devices running slower than they could */
5432 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
5433 && udev
->speed
== USB_SPEED_FULL
5434 && highspeed_hubs
!= 0)
5435 check_highspeed(hub
, udev
, port1
);
5437 /* Store the parent's children[] pointer. At this point
5438 * udev becomes globally accessible, although presumably
5439 * no one will look at it until hdev is unlocked.
5443 mutex_lock(&usb_port_peer_mutex
);
5445 /* We mustn't add new devices if the parent hub has
5446 * been disconnected; we would race with the
5447 * recursively_mark_NOTATTACHED() routine.
5449 spin_lock_irq(&device_state_lock
);
5450 if (hdev
->state
== USB_STATE_NOTATTACHED
)
5453 port_dev
->child
= udev
;
5454 spin_unlock_irq(&device_state_lock
);
5455 mutex_unlock(&usb_port_peer_mutex
);
5457 /* Run it through the hoops (find a driver, etc) */
5459 status
= usb_new_device(udev
);
5461 mutex_lock(&usb_port_peer_mutex
);
5462 spin_lock_irq(&device_state_lock
);
5463 port_dev
->child
= NULL
;
5464 spin_unlock_irq(&device_state_lock
);
5465 mutex_unlock(&usb_port_peer_mutex
);
5467 if (hcd
->usb_phy
&& !hdev
->parent
)
5468 usb_phy_notify_connect(hcd
->usb_phy
,
5476 status
= hub_power_remaining(hub
);
5478 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
5483 hub_port_disable(hub
, port1
, 1);
5485 usb_ep0_reinit(udev
);
5486 release_devnum(udev
);
5489 mutex_unlock(hcd
->address0_mutex
);
5490 usb_unlock_port(port_dev
);
5493 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
5496 /* When halfway through our retry count, power-cycle the port */
5497 if (i
== (PORT_INIT_TRIES
- 1) / 2) {
5498 dev_info(&port_dev
->dev
, "attempt power cycle\n");
5499 usb_hub_set_port_power(hdev
, hub
, port1
, false);
5500 msleep(2 * hub_power_on_good_delay(hub
));
5501 usb_hub_set_port_power(hdev
, hub
, port1
, true);
5502 msleep(hub_power_on_good_delay(hub
));
5505 if (hub
->hdev
->parent
||
5506 !hcd
->driver
->port_handed_over
||
5507 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
5508 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5509 dev_err(&port_dev
->dev
,
5510 "unable to enumerate USB device\n");
5514 hub_port_disable(hub
, port1
, 1);
5515 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
5516 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5517 hcd
->driver
->relinquish_port(hcd
, port1
);
5521 /* Handle physical or logical connection change events.
5522 * This routine is called when:
5523 * a port connection-change occurs;
5524 * a port enable-change occurs (often caused by EMI);
5525 * usb_reset_and_verify_device() encounters changed descriptors (as from
5526 * a firmware download)
5527 * caller already locked the hub
5529 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
5530 u16 portstatus
, u16 portchange
)
5531 __must_hold(&port_dev
->status_lock
)
5533 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5534 struct usb_device
*udev
= port_dev
->child
;
5535 struct usb_device_descriptor
*descr
;
5536 int status
= -ENODEV
;
5538 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
5539 portchange
, portspeed(hub
, portstatus
));
5541 if (hub
->has_indicators
) {
5542 set_port_led(hub
, port1
, HUB_LED_AUTO
);
5543 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
5546 #ifdef CONFIG_USB_OTG
5547 /* during HNP, don't repeat the debounce */
5548 if (hub
->hdev
->bus
->is_b_host
)
5549 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
5550 USB_PORT_STAT_C_ENABLE
);
5553 /* Try to resuscitate an existing device */
5554 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
5555 udev
->state
!= USB_STATE_NOTATTACHED
) {
5556 if (portstatus
& USB_PORT_STAT_ENABLE
) {
5558 * USB-3 connections are initialized automatically by
5559 * the hostcontroller hardware. Therefore check for
5560 * changed device descriptors before resuscitating the
5563 descr
= usb_get_device_descriptor(udev
);
5564 if (IS_ERR(descr
)) {
5566 "can't read device descriptor %ld\n",
5569 if (descriptors_changed(udev
, descr
,
5572 "device descriptor has changed\n");
5574 status
= 0; /* Nothing to do */
5579 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
5580 udev
->persist_enabled
) {
5581 /* For a suspended device, treat this as a
5582 * remote wakeup event.
5584 usb_unlock_port(port_dev
);
5585 status
= usb_remote_wakeup(udev
);
5586 usb_lock_port(port_dev
);
5589 /* Don't resuscitate */;
5592 clear_bit(port1
, hub
->change_bits
);
5594 /* successfully revalidated the connection */
5598 usb_unlock_port(port_dev
);
5599 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5600 usb_lock_port(port_dev
);
5603 /* Handle notifying userspace about hub over-current events */
5604 static void port_over_current_notify(struct usb_port
*port_dev
)
5606 char *envp
[3] = { NULL
, NULL
, NULL
};
5607 struct device
*hub_dev
;
5608 char *port_dev_path
;
5610 sysfs_notify(&port_dev
->dev
.kobj
, NULL
, "over_current_count");
5612 hub_dev
= port_dev
->dev
.parent
;
5617 port_dev_path
= kobject_get_path(&port_dev
->dev
.kobj
, GFP_KERNEL
);
5621 envp
[0] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_PORT=%s", port_dev_path
);
5625 envp
[1] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_COUNT=%u",
5626 port_dev
->over_current_count
);
5630 kobject_uevent_env(&hub_dev
->kobj
, KOBJ_CHANGE
, envp
);
5635 kfree(port_dev_path
);
5638 static void port_event(struct usb_hub
*hub
, int port1
)
5639 __must_hold(&port_dev
->status_lock
)
5642 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5643 struct usb_device
*udev
= port_dev
->child
;
5644 struct usb_device
*hdev
= hub
->hdev
;
5645 u16 portstatus
, portchange
;
5648 connect_change
= test_bit(port1
, hub
->change_bits
);
5649 clear_bit(port1
, hub
->event_bits
);
5650 clear_bit(port1
, hub
->wakeup_bits
);
5652 if (usb_hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5655 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5656 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5660 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5661 if (!connect_change
)
5662 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5664 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5667 * EM interference sometimes causes badly shielded USB devices
5668 * to be shutdown by the hub, this hack enables them again.
5669 * Works at least with mouse driver.
5671 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5672 && !connect_change
&& udev
) {
5673 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5678 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5679 u16 status
= 0, unused
;
5680 port_dev
->over_current_count
++;
5681 port_over_current_notify(port_dev
);
5683 dev_dbg(&port_dev
->dev
, "over-current change #%u\n",
5684 port_dev
->over_current_count
);
5685 usb_clear_port_feature(hdev
, port1
,
5686 USB_PORT_FEAT_C_OVER_CURRENT
);
5687 msleep(100); /* Cool down */
5688 hub_power_on(hub
, true);
5689 usb_hub_port_status(hub
, port1
, &status
, &unused
);
5690 if (status
& USB_PORT_STAT_OVERCURRENT
)
5691 dev_err(&port_dev
->dev
, "over-current condition\n");
5694 if (portchange
& USB_PORT_STAT_C_RESET
) {
5695 dev_dbg(&port_dev
->dev
, "reset change\n");
5696 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5698 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5699 && hub_is_superspeed(hdev
)) {
5700 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5701 usb_clear_port_feature(hdev
, port1
,
5702 USB_PORT_FEAT_C_BH_PORT_RESET
);
5704 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5705 dev_dbg(&port_dev
->dev
, "link state change\n");
5706 usb_clear_port_feature(hdev
, port1
,
5707 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5709 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5710 dev_warn(&port_dev
->dev
, "config error\n");
5711 usb_clear_port_feature(hdev
, port1
,
5712 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5715 /* skip port actions that require the port to be powered on */
5716 if (!pm_runtime_active(&port_dev
->dev
))
5719 /* skip port actions if ignore_event and early_stop are true */
5720 if (port_dev
->ignore_event
&& port_dev
->early_stop
)
5723 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5727 * Avoid trying to recover a USB3 SS.Inactive port with a warm reset if
5728 * the device was disconnected. A 12ms disconnect detect timer in
5729 * SS.Inactive state transitions the port to RxDetect automatically.
5730 * SS.Inactive link error state is common during device disconnect.
5732 while (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5733 if ((i
++ < DETECT_DISCONNECT_TRIES
) && udev
) {
5737 usb_hub_port_status(hub
, port1
, &portstatus
, &unused
);
5738 dev_dbg(&port_dev
->dev
, "Wait for inactive link disconnect detect\n");
5740 } else if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5741 || udev
->state
== USB_STATE_NOTATTACHED
) {
5742 dev_dbg(&port_dev
->dev
, "do warm reset, port only\n");
5743 if (hub_port_reset(hub
, port1
, NULL
,
5744 HUB_BH_RESET_TIME
, true) < 0)
5745 hub_port_disable(hub
, port1
, 1);
5747 dev_dbg(&port_dev
->dev
, "do warm reset, full device\n");
5748 usb_unlock_port(port_dev
);
5749 usb_lock_device(udev
);
5750 usb_reset_device(udev
);
5751 usb_unlock_device(udev
);
5752 usb_lock_port(port_dev
);
5759 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5762 static void hub_event(struct work_struct
*work
)
5764 struct usb_device
*hdev
;
5765 struct usb_interface
*intf
;
5766 struct usb_hub
*hub
;
5767 struct device
*hub_dev
;
5772 hub
= container_of(work
, struct usb_hub
, events
);
5774 hub_dev
= hub
->intfdev
;
5775 intf
= to_usb_interface(hub_dev
);
5777 kcov_remote_start_usb((u64
)hdev
->bus
->busnum
);
5779 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5780 hdev
->state
, hdev
->maxchild
,
5781 /* NOTE: expects max 15 ports... */
5782 (u16
) hub
->change_bits
[0],
5783 (u16
) hub
->event_bits
[0]);
5785 /* Lock the device, then check to see if we were
5786 * disconnected while waiting for the lock to succeed. */
5787 usb_lock_device(hdev
);
5788 if (unlikely(hub
->disconnected
))
5791 /* If the hub has died, clean up after it */
5792 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5793 hub
->error
= -ENODEV
;
5794 hub_quiesce(hub
, HUB_DISCONNECT
);
5799 ret
= usb_autopm_get_interface(intf
);
5801 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5805 /* If this is an inactive hub, do nothing */
5810 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5812 ret
= usb_reset_device(hdev
);
5814 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5822 /* deal with port status changes */
5823 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5824 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5826 if (test_bit(i
, hub
->event_bits
)
5827 || test_bit(i
, hub
->change_bits
)
5828 || test_bit(i
, hub
->wakeup_bits
)) {
5830 * The get_noresume and barrier ensure that if
5831 * the port was in the process of resuming, we
5832 * flush that work and keep the port active for
5833 * the duration of the port_event(). However,
5834 * if the port is runtime pm suspended
5835 * (powered-off), we leave it in that state, run
5836 * an abbreviated port_event(), and move on.
5838 pm_runtime_get_noresume(&port_dev
->dev
);
5839 pm_runtime_barrier(&port_dev
->dev
);
5840 usb_lock_port(port_dev
);
5842 usb_unlock_port(port_dev
);
5843 pm_runtime_put_sync(&port_dev
->dev
);
5847 /* deal with hub status changes */
5848 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5850 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5851 dev_err(hub_dev
, "get_hub_status failed\n");
5853 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5854 dev_dbg(hub_dev
, "power change\n");
5855 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5856 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5857 /* FIXME: Is this always true? */
5858 hub
->limited_power
= 1;
5860 hub
->limited_power
= 0;
5862 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5866 dev_dbg(hub_dev
, "over-current change\n");
5867 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5868 msleep(500); /* Cool down */
5869 hub_power_on(hub
, true);
5870 hub_hub_status(hub
, &status
, &unused
);
5871 if (status
& HUB_STATUS_OVERCURRENT
)
5872 dev_err(hub_dev
, "over-current condition\n");
5877 /* Balance the usb_autopm_get_interface() above */
5878 usb_autopm_put_interface_no_suspend(intf
);
5880 usb_unlock_device(hdev
);
5882 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5883 usb_autopm_put_interface(intf
);
5884 kref_put(&hub
->kref
, hub_release
);
5889 static const struct usb_device_id hub_id_table
[] = {
5890 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5891 | USB_DEVICE_ID_MATCH_PRODUCT
5892 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5893 .idVendor
= USB_VENDOR_SMSC
,
5894 .idProduct
= USB_PRODUCT_USB5534B
,
5895 .bInterfaceClass
= USB_CLASS_HUB
,
5896 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5897 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5898 | USB_DEVICE_ID_MATCH_PRODUCT
,
5899 .idVendor
= USB_VENDOR_CYPRESS
,
5900 .idProduct
= USB_PRODUCT_CY7C65632
,
5901 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5902 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5903 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5904 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5905 .bInterfaceClass
= USB_CLASS_HUB
,
5906 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5907 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5908 | USB_DEVICE_ID_MATCH_PRODUCT
,
5909 .idVendor
= USB_VENDOR_TEXAS_INSTRUMENTS
,
5910 .idProduct
= USB_PRODUCT_TUSB8041_USB2
,
5911 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5912 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5913 | USB_DEVICE_ID_MATCH_PRODUCT
,
5914 .idVendor
= USB_VENDOR_TEXAS_INSTRUMENTS
,
5915 .idProduct
= USB_PRODUCT_TUSB8041_USB3
,
5916 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5917 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5918 .bDeviceClass
= USB_CLASS_HUB
},
5919 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5920 .bInterfaceClass
= USB_CLASS_HUB
},
5921 { } /* Terminating entry */
5924 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5926 static struct usb_driver hub_driver
= {
5929 .disconnect
= hub_disconnect
,
5930 .suspend
= hub_suspend
,
5931 .resume
= hub_resume
,
5932 .reset_resume
= hub_reset_resume
,
5933 .pre_reset
= hub_pre_reset
,
5934 .post_reset
= hub_post_reset
,
5935 .unlocked_ioctl
= hub_ioctl
,
5936 .id_table
= hub_id_table
,
5937 .supports_autosuspend
= 1,
5940 int usb_hub_init(void)
5942 if (usb_register(&hub_driver
) < 0) {
5943 printk(KERN_ERR
"%s: can't register hub driver\n",
5949 * The workqueue needs to be freezable to avoid interfering with
5950 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5951 * device was gone before the EHCI controller had handed its port
5952 * over to the companion full-speed controller.
5954 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5958 /* Fall through if kernel_thread failed */
5959 usb_deregister(&hub_driver
);
5960 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5965 void usb_hub_cleanup(void)
5967 destroy_workqueue(hub_wq
);
5970 * Hub resources are freed for us by usb_deregister. It calls
5971 * usb_driver_purge on every device which in turn calls that
5972 * devices disconnect function if it is using this driver.
5973 * The hub_disconnect function takes care of releasing the
5974 * individual hub resources. -greg
5976 usb_deregister(&hub_driver
);
5977 } /* usb_hub_cleanup() */
5980 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5981 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5983 * WARNING - don't use this routine to reset a composite device
5984 * (one with multiple interfaces owned by separate drivers)!
5985 * Use usb_reset_device() instead.
5987 * Do a port reset, reassign the device's address, and establish its
5988 * former operating configuration. If the reset fails, or the device's
5989 * descriptors change from their values before the reset, or the original
5990 * configuration and altsettings cannot be restored, a flag will be set
5991 * telling hub_wq to pretend the device has been disconnected and then
5992 * re-connected. All drivers will be unbound, and the device will be
5993 * re-enumerated and probed all over again.
5995 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5996 * flagged for logical disconnection, or some other negative error code
5997 * if the reset wasn't even attempted.
6000 * The caller must own the device lock and the port lock, the latter is
6001 * taken by usb_reset_device(). For example, it's safe to use
6002 * usb_reset_device() from a driver probe() routine after downloading
6003 * new firmware. For calls that might not occur during probe(), drivers
6004 * should lock the device using usb_lock_device_for_reset().
6006 * Locking exception: This routine may also be called from within an
6007 * autoresume handler. Such usage won't conflict with other tasks
6008 * holding the device lock because these tasks should always call
6009 * usb_autopm_resume_device(), thereby preventing any unwanted
6010 * autoresume. The autoresume handler is expected to have already
6011 * acquired the port lock before calling this routine.
6013 static int usb_reset_and_verify_device(struct usb_device
*udev
)
6015 struct usb_device
*parent_hdev
= udev
->parent
;
6016 struct usb_hub
*parent_hub
;
6017 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
6018 struct usb_device_descriptor descriptor
;
6019 struct usb_host_bos
*bos
;
6021 int port1
= udev
->portnum
;
6023 if (udev
->state
== USB_STATE_NOTATTACHED
||
6024 udev
->state
== USB_STATE_SUSPENDED
) {
6025 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
6033 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
6035 /* Disable USB2 hardware LPM.
6036 * It will be re-enabled by the enumeration process.
6038 usb_disable_usb2_hardware_lpm(udev
);
6043 mutex_lock(hcd
->address0_mutex
);
6045 for (i
= 0; i
< PORT_INIT_TRIES
; ++i
) {
6046 if (hub_port_stop_enumerate(parent_hub
, port1
, i
)) {
6051 /* ep0 maxpacket size may change; let the HCD know about it.
6052 * Other endpoints will be handled by re-enumeration. */
6053 usb_ep0_reinit(udev
);
6054 ret
= hub_port_init(parent_hub
, udev
, port1
, i
, &descriptor
);
6055 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
6058 mutex_unlock(hcd
->address0_mutex
);
6063 /* Device might have changed firmware (DFU or similar) */
6064 if (descriptors_changed(udev
, &descriptor
, bos
)) {
6065 dev_info(&udev
->dev
, "device firmware changed\n");
6069 /* Restore the device's previous configuration */
6070 if (!udev
->actconfig
)
6073 mutex_lock(hcd
->bandwidth_mutex
);
6074 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
6076 dev_warn(&udev
->dev
,
6077 "Busted HC? Not enough HCD resources for "
6078 "old configuration.\n");
6079 mutex_unlock(hcd
->bandwidth_mutex
);
6082 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
6083 USB_REQ_SET_CONFIGURATION
, 0,
6084 udev
->actconfig
->desc
.bConfigurationValue
, 0,
6085 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
6088 "can't restore configuration #%d (error=%d)\n",
6089 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
6090 mutex_unlock(hcd
->bandwidth_mutex
);
6093 mutex_unlock(hcd
->bandwidth_mutex
);
6094 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
6096 /* Put interfaces back into the same altsettings as before.
6097 * Don't bother to send the Set-Interface request for interfaces
6098 * that were already in altsetting 0; besides being unnecessary,
6099 * many devices can't handle it. Instead just reset the host-side
6102 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
6103 struct usb_host_config
*config
= udev
->actconfig
;
6104 struct usb_interface
*intf
= config
->interface
[i
];
6105 struct usb_interface_descriptor
*desc
;
6107 desc
= &intf
->cur_altsetting
->desc
;
6108 if (desc
->bAlternateSetting
== 0) {
6109 usb_disable_interface(udev
, intf
, true);
6110 usb_enable_interface(udev
, intf
, true);
6113 /* Let the bandwidth allocation function know that this
6114 * device has been reset, and it will have to use
6115 * alternate setting 0 as the current alternate setting.
6117 intf
->resetting_device
= 1;
6118 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
6119 desc
->bAlternateSetting
);
6120 intf
->resetting_device
= 0;
6123 dev_err(&udev
->dev
, "failed to restore interface %d "
6124 "altsetting %d (error=%d)\n",
6125 desc
->bInterfaceNumber
,
6126 desc
->bAlternateSetting
,
6130 /* Resetting also frees any allocated streams */
6131 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
6132 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
6136 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6137 usb_enable_usb2_hardware_lpm(udev
);
6138 usb_unlocked_enable_lpm(udev
);
6139 usb_enable_ltm(udev
);
6140 usb_release_bos_descriptor(udev
);
6145 usb_release_bos_descriptor(udev
);
6147 hub_port_logical_disconnect(parent_hub
, port1
);
6152 * usb_reset_device - warn interface drivers and perform a USB port reset
6153 * @udev: device to reset (not in NOTATTACHED state)
6155 * Warns all drivers bound to registered interfaces (using their pre_reset
6156 * method), performs the port reset, and then lets the drivers know that
6157 * the reset is over (using their post_reset method).
6159 * Return: The same as for usb_reset_and_verify_device().
6160 * However, if a reset is already in progress (for instance, if a
6161 * driver doesn't have pre_reset() or post_reset() callbacks, and while
6162 * being unbound or re-bound during the ongoing reset its disconnect()
6163 * or probe() routine tries to perform a second, nested reset), the
6164 * routine returns -EINPROGRESS.
6167 * The caller must own the device lock. For example, it's safe to use
6168 * this from a driver probe() routine after downloading new firmware.
6169 * For calls that might not occur during probe(), drivers should lock
6170 * the device using usb_lock_device_for_reset().
6172 * If an interface is currently being probed or disconnected, we assume
6173 * its driver knows how to handle resets. For all other interfaces,
6174 * if the driver doesn't have pre_reset and post_reset methods then
6175 * we attempt to unbind it and rebind afterward.
6177 int usb_reset_device(struct usb_device
*udev
)
6181 unsigned int noio_flag
;
6182 struct usb_port
*port_dev
;
6183 struct usb_host_config
*config
= udev
->actconfig
;
6184 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
6186 if (udev
->state
== USB_STATE_NOTATTACHED
) {
6187 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
6192 if (!udev
->parent
) {
6193 /* this requires hcd-specific logic; see ohci_restart() */
6194 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
6198 if (udev
->reset_in_progress
)
6199 return -EINPROGRESS
;
6200 udev
->reset_in_progress
= 1;
6202 port_dev
= hub
->ports
[udev
->portnum
- 1];
6205 * Don't allocate memory with GFP_KERNEL in current
6206 * context to avoid possible deadlock if usb mass
6207 * storage interface or usbnet interface(iSCSI case)
6208 * is included in current configuration. The easist
6209 * approach is to do it for every device reset,
6210 * because the device 'memalloc_noio' flag may have
6211 * not been set before reseting the usb device.
6213 noio_flag
= memalloc_noio_save();
6215 /* Prevent autosuspend during the reset */
6216 usb_autoresume_device(udev
);
6219 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
6220 struct usb_interface
*cintf
= config
->interface
[i
];
6221 struct usb_driver
*drv
;
6224 if (cintf
->dev
.driver
) {
6225 drv
= to_usb_driver(cintf
->dev
.driver
);
6226 if (drv
->pre_reset
&& drv
->post_reset
)
6227 unbind
= (drv
->pre_reset
)(cintf
);
6228 else if (cintf
->condition
==
6229 USB_INTERFACE_BOUND
)
6232 usb_forced_unbind_intf(cintf
);
6237 usb_lock_port(port_dev
);
6238 ret
= usb_reset_and_verify_device(udev
);
6239 usb_unlock_port(port_dev
);
6242 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
6243 struct usb_interface
*cintf
= config
->interface
[i
];
6244 struct usb_driver
*drv
;
6245 int rebind
= cintf
->needs_binding
;
6247 if (!rebind
&& cintf
->dev
.driver
) {
6248 drv
= to_usb_driver(cintf
->dev
.driver
);
6249 if (drv
->post_reset
)
6250 rebind
= (drv
->post_reset
)(cintf
);
6251 else if (cintf
->condition
==
6252 USB_INTERFACE_BOUND
)
6255 cintf
->needs_binding
= 1;
6259 /* If the reset failed, hub_wq will unbind drivers later */
6261 usb_unbind_and_rebind_marked_interfaces(udev
);
6264 usb_autosuspend_device(udev
);
6265 memalloc_noio_restore(noio_flag
);
6266 udev
->reset_in_progress
= 0;
6269 EXPORT_SYMBOL_GPL(usb_reset_device
);
6273 * usb_queue_reset_device - Reset a USB device from an atomic context
6274 * @iface: USB interface belonging to the device to reset
6276 * This function can be used to reset a USB device from an atomic
6277 * context, where usb_reset_device() won't work (as it blocks).
6279 * Doing a reset via this method is functionally equivalent to calling
6280 * usb_reset_device(), except for the fact that it is delayed to a
6281 * workqueue. This means that any drivers bound to other interfaces
6282 * might be unbound, as well as users from usbfs in user space.
6286 * - Scheduling two resets at the same time from two different drivers
6287 * attached to two different interfaces of the same device is
6288 * possible; depending on how the driver attached to each interface
6289 * handles ->pre_reset(), the second reset might happen or not.
6291 * - If the reset is delayed so long that the interface is unbound from
6292 * its driver, the reset will be skipped.
6294 * - This function can be called during .probe(). It can also be called
6295 * during .disconnect(), but doing so is pointless because the reset
6296 * will not occur. If you really want to reset the device during
6297 * .disconnect(), call usb_reset_device() directly -- but watch out
6298 * for nested unbinding issues!
6300 void usb_queue_reset_device(struct usb_interface
*iface
)
6302 if (schedule_work(&iface
->reset_ws
))
6303 usb_get_intf(iface
);
6305 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
6308 * usb_hub_find_child - Get the pointer of child device
6309 * attached to the port which is specified by @port1.
6310 * @hdev: USB device belonging to the usb hub
6311 * @port1: port num to indicate which port the child device
6314 * USB drivers call this function to get hub's child device
6317 * Return: %NULL if input param is invalid and
6318 * child's usb_device pointer if non-NULL.
6320 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
6323 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6325 if (port1
< 1 || port1
> hdev
->maxchild
)
6327 return hub
->ports
[port1
- 1]->child
;
6329 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
6331 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
6332 struct usb_hub_descriptor
*desc
)
6334 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6335 enum usb_port_connect_type connect_type
;
6341 if (!hub_is_superspeed(hdev
)) {
6342 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6343 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6345 connect_type
= port_dev
->connect_type
;
6346 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6347 u8 mask
= 1 << (i
%8);
6349 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
6350 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6351 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
6356 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
6358 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6359 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6361 connect_type
= port_dev
->connect_type
;
6362 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6365 if (!(port_removable
& mask
)) {
6366 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6367 port_removable
|= mask
;
6372 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
6378 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6379 * @hdev: USB device belonging to the usb hub
6380 * @port1: port num of the port
6382 * Return: Port's acpi handle if successful, %NULL if params are
6385 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
6388 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6393 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);