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/otg.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
29 #include <linux/mutex.h>
30 #include <linux/random.h>
31 #include <linux/pm_qos.h>
32 #include <linux/kobject.h>
34 #include <linux/bitfield.h>
35 #include <linux/uaccess.h>
36 #include <asm/byteorder.h>
39 #include "otg_productlist.h"
41 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
42 #define USB_VENDOR_SMSC 0x0424
43 #define USB_PRODUCT_USB5534B 0x5534
44 #define USB_VENDOR_CYPRESS 0x04b4
45 #define USB_PRODUCT_CY7C65632 0x6570
46 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
47 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
49 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
50 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
51 #define USB_PING_RESPONSE_TIME 400 /* ns */
53 /* Protect struct usb_device->state and ->children members
54 * Note: Both are also protected by ->dev.sem, except that ->state can
55 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
56 static DEFINE_SPINLOCK(device_state_lock
);
58 /* workqueue to process hub events */
59 static struct workqueue_struct
*hub_wq
;
60 static void hub_event(struct work_struct
*work
);
62 /* synchronize hub-port add/remove and peering operations */
63 DEFINE_MUTEX(usb_port_peer_mutex
);
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights
;
67 module_param(blinkenlights
, bool, S_IRUGO
);
68 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
76 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
77 MODULE_PARM_DESC(initial_descriptor_timeout
,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first
;
96 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
97 MODULE_PARM_DESC(old_scheme_first
,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes
= true;
101 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
102 MODULE_PARM_DESC(use_both_schemes
,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static void hub_release(struct kref
*kref
);
117 static int usb_reset_and_verify_device(struct usb_device
*udev
);
118 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
119 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
122 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
124 if (hub_is_superspeedplus(hub
->hdev
))
126 if (hub_is_superspeed(hub
->hdev
))
128 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
130 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
136 /* Note that hdev or one of its children must be locked! */
137 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
139 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
141 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
144 int usb_device_supports_lpm(struct usb_device
*udev
)
146 /* Some devices have trouble with LPM */
147 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
150 /* USB 2.1 (and greater) devices indicate LPM support through
151 * their USB 2.0 Extended Capabilities BOS descriptor.
153 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
154 if (udev
->bos
->ext_cap
&&
156 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
162 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
163 * However, there are some that don't, and they set the U1/U2 exit
166 if (!udev
->bos
->ss_cap
) {
167 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
171 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
172 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
174 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
176 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
180 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
186 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
187 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
188 * See USB 3.1 section C.1.5.2
190 static void usb_set_lpm_mel(struct usb_device
*udev
,
191 struct usb3_lpm_parameters
*udev_lpm_params
,
192 unsigned int udev_exit_latency
,
194 struct usb3_lpm_parameters
*hub_lpm_params
,
195 unsigned int hub_exit_latency
)
197 unsigned int total_mel
;
200 * tMEL1. time to transition path from host to device into U0.
201 * MEL for parent already contains the delay up to parent, so only add
202 * the exit latency for the last link (pick the slower exit latency),
203 * and the hub header decode latency. See USB 3.1 section C 2.2.1
204 * Store MEL in nanoseconds
206 total_mel
= hub_lpm_params
->mel
+
207 max(udev_exit_latency
, hub_exit_latency
) * 1000 +
208 hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100;
211 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
212 * each link + wHubDelay for each hub. Add only for last link.
213 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
214 * Multiply by 2 to include it as well.
216 total_mel
+= (__le16_to_cpu(hub
->descriptor
->u
.ss
.wHubDelay
) +
217 USB_TP_TRANSMISSION_DELAY
) * 2;
220 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
221 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
222 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
224 * Note these delays should be added only once for the entire path, so
225 * add them to the MEL of the device connected to the roothub.
227 if (!hub
->hdev
->parent
)
228 total_mel
+= USB_PING_RESPONSE_TIME
+ 2100;
230 udev_lpm_params
->mel
= total_mel
;
234 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
235 * a transition from either U1 or U2.
237 static void usb_set_lpm_pel(struct usb_device
*udev
,
238 struct usb3_lpm_parameters
*udev_lpm_params
,
239 unsigned int udev_exit_latency
,
241 struct usb3_lpm_parameters
*hub_lpm_params
,
242 unsigned int hub_exit_latency
,
243 unsigned int port_to_port_exit_latency
)
245 unsigned int first_link_pel
;
246 unsigned int hub_pel
;
249 * First, the device sends an LFPS to transition the link between the
250 * device and the parent hub into U0. The exit latency is the bigger of
251 * the device exit latency or the hub exit latency.
253 if (udev_exit_latency
> hub_exit_latency
)
254 first_link_pel
= udev_exit_latency
* 1000;
256 first_link_pel
= hub_exit_latency
* 1000;
259 * When the hub starts to receive the LFPS, there is a slight delay for
260 * it to figure out that one of the ports is sending an LFPS. Then it
261 * will forward the LFPS to its upstream link. The exit latency is the
262 * delay, plus the PEL that we calculated for this hub.
264 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
267 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
268 * is the greater of the two exit latencies.
270 if (first_link_pel
> hub_pel
)
271 udev_lpm_params
->pel
= first_link_pel
;
273 udev_lpm_params
->pel
= hub_pel
;
277 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
278 * when a device initiates a transition to U0, until when it will receive the
279 * first packet from the host controller.
281 * Section C.1.5.1 describes the four components to this:
283 * - t2: time for the ERDY to make it from the device to the host.
284 * - t3: a host-specific delay to process the ERDY.
285 * - t4: time for the packet to make it from the host to the device.
287 * t3 is specific to both the xHCI host and the platform the host is integrated
288 * into. The Intel HW folks have said it's negligible, FIXME if a different
289 * vendor says otherwise.
291 static void usb_set_lpm_sel(struct usb_device
*udev
,
292 struct usb3_lpm_parameters
*udev_lpm_params
)
294 struct usb_device
*parent
;
295 unsigned int num_hubs
;
296 unsigned int total_sel
;
298 /* t1 = device PEL */
299 total_sel
= udev_lpm_params
->pel
;
300 /* How many external hubs are in between the device & the root port. */
301 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
302 parent
= parent
->parent
)
304 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
306 total_sel
+= 2100 + 250 * (num_hubs
- 1);
308 /* t4 = 250ns * num_hubs */
309 total_sel
+= 250 * num_hubs
;
311 udev_lpm_params
->sel
= total_sel
;
314 static void usb_set_lpm_parameters(struct usb_device
*udev
)
317 unsigned int port_to_port_delay
;
318 unsigned int udev_u1_del
;
319 unsigned int udev_u2_del
;
320 unsigned int hub_u1_del
;
321 unsigned int hub_u2_del
;
323 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
326 hub
= usb_hub_to_struct_hub(udev
->parent
);
327 /* It doesn't take time to transition the roothub into U0, since it
328 * doesn't have an upstream link.
333 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
334 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
335 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
336 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
338 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
339 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
341 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
342 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
345 * Appendix C, section C.2.2.2, says that there is a slight delay from
346 * when the parent hub notices the downstream port is trying to
347 * transition to U0 to when the hub initiates a U0 transition on its
348 * upstream port. The section says the delays are tPort2PortU1EL and
349 * tPort2PortU2EL, but it doesn't define what they are.
351 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
352 * about the same delays. Use the maximum delay calculations from those
353 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
354 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
355 * assume the device exit latencies they are talking about are the hub
358 * What do we do if the U2 exit latency is less than the U1 exit
359 * latency? It's possible, although not likely...
361 port_to_port_delay
= 1;
363 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
364 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
367 if (hub_u2_del
> hub_u1_del
)
368 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
370 port_to_port_delay
= 1 + hub_u1_del
;
372 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
373 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
376 /* Now that we've got PEL, calculate SEL. */
377 usb_set_lpm_sel(udev
, &udev
->u1_params
);
378 usb_set_lpm_sel(udev
, &udev
->u2_params
);
381 /* USB 2.0 spec Section 11.24.4.5 */
382 static int get_hub_descriptor(struct usb_device
*hdev
,
383 struct usb_hub_descriptor
*desc
)
388 if (hub_is_superspeed(hdev
)) {
389 dtype
= USB_DT_SS_HUB
;
390 size
= USB_DT_SS_HUB_SIZE
;
393 size
= sizeof(struct usb_hub_descriptor
);
396 for (i
= 0; i
< 3; i
++) {
397 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
398 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
399 dtype
<< 8, 0, desc
, size
,
400 USB_CTRL_GET_TIMEOUT
);
401 if (hub_is_superspeed(hdev
)) {
404 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
405 /* Make sure we have the DeviceRemovable field. */
406 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
416 * USB 2.0 spec Section 11.24.2.1
418 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
420 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
421 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
425 * USB 2.0 spec Section 11.24.2.2
427 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
429 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
430 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
435 * USB 2.0 spec Section 11.24.2.13
437 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
439 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
440 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
444 static char *to_led_name(int selector
)
461 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
462 * for info about using port indicators
464 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
466 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
469 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
470 USB_PORT_FEAT_INDICATOR
);
471 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
472 to_led_name(selector
), status
);
475 #define LED_CYCLE_PERIOD ((2*HZ)/3)
477 static void led_work(struct work_struct
*work
)
479 struct usb_hub
*hub
=
480 container_of(work
, struct usb_hub
, leds
.work
);
481 struct usb_device
*hdev
= hub
->hdev
;
483 unsigned changed
= 0;
486 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
489 for (i
= 0; i
< hdev
->maxchild
; i
++) {
490 unsigned selector
, mode
;
492 /* 30%-50% duty cycle */
494 switch (hub
->indicator
[i
]) {
496 case INDICATOR_CYCLE
:
498 selector
= HUB_LED_AUTO
;
499 mode
= INDICATOR_AUTO
;
501 /* blinking green = sw attention */
502 case INDICATOR_GREEN_BLINK
:
503 selector
= HUB_LED_GREEN
;
504 mode
= INDICATOR_GREEN_BLINK_OFF
;
506 case INDICATOR_GREEN_BLINK_OFF
:
507 selector
= HUB_LED_OFF
;
508 mode
= INDICATOR_GREEN_BLINK
;
510 /* blinking amber = hw attention */
511 case INDICATOR_AMBER_BLINK
:
512 selector
= HUB_LED_AMBER
;
513 mode
= INDICATOR_AMBER_BLINK_OFF
;
515 case INDICATOR_AMBER_BLINK_OFF
:
516 selector
= HUB_LED_OFF
;
517 mode
= INDICATOR_AMBER_BLINK
;
519 /* blink green/amber = reserved */
520 case INDICATOR_ALT_BLINK
:
521 selector
= HUB_LED_GREEN
;
522 mode
= INDICATOR_ALT_BLINK_OFF
;
524 case INDICATOR_ALT_BLINK_OFF
:
525 selector
= HUB_LED_AMBER
;
526 mode
= INDICATOR_ALT_BLINK
;
531 if (selector
!= HUB_LED_AUTO
)
533 set_port_led(hub
, i
+ 1, selector
);
534 hub
->indicator
[i
] = mode
;
536 if (!changed
&& blinkenlights
) {
538 cursor
%= hdev
->maxchild
;
539 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
540 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
544 queue_delayed_work(system_power_efficient_wq
,
545 &hub
->leds
, LED_CYCLE_PERIOD
);
548 /* use a short timeout for hub/port status fetches */
549 #define USB_STS_TIMEOUT 1000
550 #define USB_STS_RETRIES 5
553 * USB 2.0 spec Section 11.24.2.6
555 static int get_hub_status(struct usb_device
*hdev
,
556 struct usb_hub_status
*data
)
558 int i
, status
= -ETIMEDOUT
;
560 for (i
= 0; i
< USB_STS_RETRIES
&&
561 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
562 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
563 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
564 data
, sizeof(*data
), USB_STS_TIMEOUT
);
570 * USB 2.0 spec Section 11.24.2.7
571 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
573 static int get_port_status(struct usb_device
*hdev
, int port1
,
574 void *data
, u16 value
, u16 length
)
576 int i
, status
= -ETIMEDOUT
;
578 for (i
= 0; i
< USB_STS_RETRIES
&&
579 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
580 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
581 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
582 port1
, data
, length
, USB_STS_TIMEOUT
);
587 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
588 u16
*status
, u16
*change
, u32
*ext_status
)
593 if (type
!= HUB_PORT_STATUS
)
596 mutex_lock(&hub
->status_mutex
);
597 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
600 dev_err(hub
->intfdev
,
601 "%s failed (err = %d)\n", __func__
, ret
);
605 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
606 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
607 if (type
!= HUB_PORT_STATUS
&& ext_status
)
608 *ext_status
= le32_to_cpu(
609 hub
->status
->port
.dwExtPortStatus
);
612 mutex_unlock(&hub
->status_mutex
);
616 static int hub_port_status(struct usb_hub
*hub
, int port1
,
617 u16
*status
, u16
*change
)
619 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
620 status
, change
, NULL
);
623 static void hub_resubmit_irq_urb(struct usb_hub
*hub
)
628 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
630 if (hub
->quiescing
) {
631 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
635 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
636 if (status
&& status
!= -ENODEV
&& status
!= -EPERM
&&
637 status
!= -ESHUTDOWN
) {
638 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
639 mod_timer(&hub
->irq_urb_retry
, jiffies
+ HZ
);
642 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
645 static void hub_retry_irq_urb(struct timer_list
*t
)
647 struct usb_hub
*hub
= from_timer(hub
, t
, irq_urb_retry
);
649 hub_resubmit_irq_urb(hub
);
653 static void kick_hub_wq(struct usb_hub
*hub
)
655 struct usb_interface
*intf
;
657 if (hub
->disconnected
|| work_pending(&hub
->events
))
661 * Suppress autosuspend until the event is proceed.
663 * Be careful and make sure that the symmetric operation is
664 * always called. We are here only when there is no pending
665 * work for this hub. Therefore put the interface either when
666 * the new work is called or when it is canceled.
668 intf
= to_usb_interface(hub
->intfdev
);
669 usb_autopm_get_interface_no_resume(intf
);
670 kref_get(&hub
->kref
);
672 if (queue_work(hub_wq
, &hub
->events
))
675 /* the work has already been scheduled */
676 usb_autopm_put_interface_async(intf
);
677 kref_put(&hub
->kref
, hub_release
);
680 void usb_kick_hub_wq(struct usb_device
*hdev
)
682 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
689 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
690 * Notification, which indicates it had initiated remote wakeup.
692 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
693 * device initiates resume, so the USB core will not receive notice of the
694 * resume through the normal hub interrupt URB.
696 void usb_wakeup_notification(struct usb_device
*hdev
,
697 unsigned int portnum
)
700 struct usb_port
*port_dev
;
705 hub
= usb_hub_to_struct_hub(hdev
);
707 port_dev
= hub
->ports
[portnum
- 1];
708 if (port_dev
&& port_dev
->child
)
709 pm_wakeup_event(&port_dev
->child
->dev
, 0);
711 set_bit(portnum
, hub
->wakeup_bits
);
715 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
717 /* completion function, fires on port status changes and various faults */
718 static void hub_irq(struct urb
*urb
)
720 struct usb_hub
*hub
= urb
->context
;
721 int status
= urb
->status
;
726 case -ENOENT
: /* synchronous unlink */
727 case -ECONNRESET
: /* async unlink */
728 case -ESHUTDOWN
: /* hardware going away */
731 default: /* presumably an error */
732 /* Cause a hub reset after 10 consecutive errors */
733 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
734 if ((++hub
->nerrors
< 10) || hub
->error
)
739 /* let hub_wq handle things */
740 case 0: /* we got data: port status changed */
742 for (i
= 0; i
< urb
->actual_length
; ++i
)
743 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
745 hub
->event_bits
[0] = bits
;
751 /* Something happened, let hub_wq figure it out */
755 hub_resubmit_irq_urb(hub
);
758 /* USB 2.0 spec Section 11.24.2.3 */
760 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
762 /* Need to clear both directions for control ep */
763 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
764 USB_ENDPOINT_XFER_CONTROL
) {
765 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
766 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
767 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
771 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
772 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
777 * enumeration blocks hub_wq for a long time. we use keventd instead, since
778 * long blocking there is the exception, not the rule. accordingly, HCDs
779 * talking to TTs must queue control transfers (not just bulk and iso), so
780 * both can talk to the same hub concurrently.
782 static void hub_tt_work(struct work_struct
*work
)
784 struct usb_hub
*hub
=
785 container_of(work
, struct usb_hub
, tt
.clear_work
);
788 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
789 while (!list_empty(&hub
->tt
.clear_list
)) {
790 struct list_head
*next
;
791 struct usb_tt_clear
*clear
;
792 struct usb_device
*hdev
= hub
->hdev
;
793 const struct hc_driver
*drv
;
796 next
= hub
->tt
.clear_list
.next
;
797 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
798 list_del(&clear
->clear_list
);
800 /* drop lock so HCD can concurrently report other TT errors */
801 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
802 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
803 if (status
&& status
!= -ENODEV
)
805 "clear tt %d (%04x) error %d\n",
806 clear
->tt
, clear
->devinfo
, status
);
808 /* Tell the HCD, even if the operation failed */
809 drv
= clear
->hcd
->driver
;
810 if (drv
->clear_tt_buffer_complete
)
811 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
814 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
816 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
820 * usb_hub_set_port_power - control hub port's power state
821 * @hdev: USB device belonging to the usb hub
824 * @set: expected status
826 * call this function to control port's power via setting or
827 * clearing the port's PORT_POWER feature.
829 * Return: 0 if successful. A negative error code otherwise.
831 int usb_hub_set_port_power(struct usb_hub
*hub
, int port1
, bool set
)
833 struct usb_device
*hdev
= hub
->hdev
;
837 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
839 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
845 set_bit(port1
, hub
->power_bits
);
847 clear_bit(port1
, hub
->power_bits
);
852 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
853 * @urb: an URB associated with the failed or incomplete split transaction
855 * High speed HCDs use this to tell the hub driver that some split control or
856 * bulk transaction failed in a way that requires clearing internal state of
857 * a transaction translator. This is normally detected (and reported) from
860 * It may not be possible for that hub to handle additional full (or low)
861 * speed transactions until that state is fully cleared out.
863 * Return: 0 if successful. A negative error code otherwise.
865 int usb_hub_clear_tt_buffer(struct urb
*urb
)
867 struct usb_device
*udev
= urb
->dev
;
868 int pipe
= urb
->pipe
;
869 struct usb_tt
*tt
= udev
->tt
;
871 struct usb_tt_clear
*clear
;
873 /* we've got to cope with an arbitrary number of pending TT clears,
874 * since each TT has "at least two" buffers that can need it (and
875 * there can be many TTs per hub). even if they're uncommon.
877 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
879 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
880 /* FIXME recover somehow ... RESET_TT? */
884 /* info that CLEAR_TT_BUFFER needs */
885 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
886 clear
->devinfo
= usb_pipeendpoint (pipe
);
887 clear
->devinfo
|= ((u16
)udev
->devaddr
) << 4;
888 clear
->devinfo
|= usb_pipecontrol(pipe
)
889 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
890 : (USB_ENDPOINT_XFER_BULK
<< 11);
891 if (usb_pipein(pipe
))
892 clear
->devinfo
|= 1 << 15;
894 /* info for completion callback */
895 clear
->hcd
= bus_to_hcd(udev
->bus
);
898 /* tell keventd to clear state for this TT */
899 spin_lock_irqsave(&tt
->lock
, flags
);
900 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
901 schedule_work(&tt
->clear_work
);
902 spin_unlock_irqrestore(&tt
->lock
, flags
);
905 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
907 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
911 /* Enable power on each port. Some hubs have reserved values
912 * of LPSM (> 2) in their descriptors, even though they are
913 * USB 2.0 hubs. Some hubs do not implement port-power switching
914 * but only emulate it. In all cases, the ports won't work
915 * unless we send these messages to the hub.
917 if (hub_is_port_power_switchable(hub
))
918 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
920 dev_dbg(hub
->intfdev
, "trying to enable port power on "
921 "non-switchable hub\n");
922 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
923 if (test_bit(port1
, hub
->power_bits
))
924 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
926 usb_clear_port_feature(hub
->hdev
, port1
,
927 USB_PORT_FEAT_POWER
);
929 msleep(hub_power_on_good_delay(hub
));
932 static int hub_hub_status(struct usb_hub
*hub
,
933 u16
*status
, u16
*change
)
937 mutex_lock(&hub
->status_mutex
);
938 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
941 dev_err(hub
->intfdev
,
942 "%s failed (err = %d)\n", __func__
, ret
);
944 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
945 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
948 mutex_unlock(&hub
->status_mutex
);
952 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
953 unsigned int link_status
)
955 return set_port_feature(hub
->hdev
,
956 port1
| (link_status
<< 3),
957 USB_PORT_FEAT_LINK_STATE
);
961 * Disable a port and mark a logical connect-change event, so that some
962 * time later hub_wq will disconnect() any existing usb_device on the port
963 * and will re-enumerate if there actually is a device attached.
965 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
967 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
968 hub_port_disable(hub
, port1
, 1);
970 /* FIXME let caller ask to power down the port:
971 * - some devices won't enumerate without a VBUS power cycle
972 * - SRP saves power that way
973 * - ... new call, TBD ...
974 * That's easy if this hub can switch power per-port, and
975 * hub_wq reactivates the port later (timer, SRP, etc).
976 * Powerdown must be optional, because of reset/DFU.
979 set_bit(port1
, hub
->change_bits
);
984 * usb_remove_device - disable a device's port on its parent hub
985 * @udev: device to be disabled and removed
986 * Context: @udev locked, must be able to sleep.
988 * After @udev's port has been disabled, hub_wq is notified and it will
989 * see that the device has been disconnected. When the device is
990 * physically unplugged and something is plugged in, the events will
991 * be received and processed normally.
993 * Return: 0 if successful. A negative error code otherwise.
995 int usb_remove_device(struct usb_device
*udev
)
998 struct usb_interface
*intf
;
1001 if (!udev
->parent
) /* Can't remove a root hub */
1003 hub
= usb_hub_to_struct_hub(udev
->parent
);
1004 intf
= to_usb_interface(hub
->intfdev
);
1006 ret
= usb_autopm_get_interface(intf
);
1010 set_bit(udev
->portnum
, hub
->removed_bits
);
1011 hub_port_logical_disconnect(hub
, udev
->portnum
);
1012 usb_autopm_put_interface(intf
);
1016 enum hub_activation_type
{
1017 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1018 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1021 static void hub_init_func2(struct work_struct
*ws
);
1022 static void hub_init_func3(struct work_struct
*ws
);
1024 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1026 struct usb_device
*hdev
= hub
->hdev
;
1027 struct usb_hcd
*hcd
;
1031 bool need_debounce_delay
= false;
1034 /* Continue a partial initialization */
1035 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1036 device_lock(&hdev
->dev
);
1038 /* Was the hub disconnected while we were waiting? */
1039 if (hub
->disconnected
)
1041 if (type
== HUB_INIT2
)
1045 kref_get(&hub
->kref
);
1047 /* The superspeed hub except for root hub has to use Hub Depth
1048 * value as an offset into the route string to locate the bits
1049 * it uses to determine the downstream port number. So hub driver
1050 * should send a set hub depth request to superspeed hub after
1051 * the superspeed hub is set configuration in initialization or
1054 * After a resume, port power should still be on.
1055 * For any other type of activation, turn it on.
1057 if (type
!= HUB_RESUME
) {
1058 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1059 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1060 HUB_SET_DEPTH
, USB_RT_HUB
,
1061 hdev
->level
- 1, 0, NULL
, 0,
1062 USB_CTRL_SET_TIMEOUT
);
1064 dev_err(hub
->intfdev
,
1065 "set hub depth failed\n");
1068 /* Speed up system boot by using a delayed_work for the
1069 * hub's initial power-up delays. This is pretty awkward
1070 * and the implementation looks like a home-brewed sort of
1071 * setjmp/longjmp, but it saves at least 100 ms for each
1072 * root hub (assuming usbcore is compiled into the kernel
1073 * rather than as a module). It adds up.
1075 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1076 * because for those activation types the ports have to be
1077 * operational when we return. In theory this could be done
1078 * for HUB_POST_RESET, but it's easier not to.
1080 if (type
== HUB_INIT
) {
1081 delay
= hub_power_on_good_delay(hub
);
1083 hub_power_on(hub
, false);
1084 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1085 queue_delayed_work(system_power_efficient_wq
,
1087 msecs_to_jiffies(delay
));
1089 /* Suppress autosuspend until init is done */
1090 usb_autopm_get_interface_no_resume(
1091 to_usb_interface(hub
->intfdev
));
1092 return; /* Continues at init2: below */
1093 } else if (type
== HUB_RESET_RESUME
) {
1094 /* The internal host controller state for the hub device
1095 * may be gone after a host power loss on system resume.
1096 * Update the device's info so the HW knows it's a hub.
1098 hcd
= bus_to_hcd(hdev
->bus
);
1099 if (hcd
->driver
->update_hub_device
) {
1100 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1101 &hub
->tt
, GFP_NOIO
);
1103 dev_err(hub
->intfdev
,
1104 "Host not accepting hub info update\n");
1105 dev_err(hub
->intfdev
,
1106 "LS/FS devices and hubs may not work under this hub\n");
1109 hub_power_on(hub
, true);
1111 hub_power_on(hub
, true);
1117 * Check each port and set hub->change_bits to let hub_wq know
1118 * which ports need attention.
1120 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1121 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1122 struct usb_device
*udev
= port_dev
->child
;
1123 u16 portstatus
, portchange
;
1125 portstatus
= portchange
= 0;
1126 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1130 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1131 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1132 portstatus
, portchange
);
1135 * After anything other than HUB_RESUME (i.e., initialization
1136 * or any sort of reset), every port should be disabled.
1137 * Unconnected ports should likewise be disabled (paranoia),
1138 * and so should ports for which we have no usb_device.
1140 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1141 type
!= HUB_RESUME
||
1142 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1144 udev
->state
== USB_STATE_NOTATTACHED
)) {
1146 * USB3 protocol ports will automatically transition
1147 * to Enabled state when detect an USB3.0 device attach.
1148 * Do not disable USB3 protocol ports, just pretend
1151 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1152 if (!hub_is_superspeed(hdev
))
1153 usb_clear_port_feature(hdev
, port1
,
1154 USB_PORT_FEAT_ENABLE
);
1157 /* Make sure a warm-reset request is handled by port_event */
1158 if (type
== HUB_RESUME
&&
1159 hub_port_warm_reset_required(hub
, port1
, portstatus
))
1160 set_bit(port1
, hub
->event_bits
);
1163 * Add debounce if USB3 link is in polling/link training state.
1164 * Link will automatically transition to Enabled state after
1165 * link training completes.
1167 if (hub_is_superspeed(hdev
) &&
1168 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1169 USB_SS_PORT_LS_POLLING
))
1170 need_debounce_delay
= true;
1172 /* Clear status-change flags; we'll debounce later */
1173 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1174 need_debounce_delay
= true;
1175 usb_clear_port_feature(hub
->hdev
, port1
,
1176 USB_PORT_FEAT_C_CONNECTION
);
1178 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1179 need_debounce_delay
= true;
1180 usb_clear_port_feature(hub
->hdev
, port1
,
1181 USB_PORT_FEAT_C_ENABLE
);
1183 if (portchange
& USB_PORT_STAT_C_RESET
) {
1184 need_debounce_delay
= true;
1185 usb_clear_port_feature(hub
->hdev
, port1
,
1186 USB_PORT_FEAT_C_RESET
);
1188 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1189 hub_is_superspeed(hub
->hdev
)) {
1190 need_debounce_delay
= true;
1191 usb_clear_port_feature(hub
->hdev
, port1
,
1192 USB_PORT_FEAT_C_BH_PORT_RESET
);
1194 /* We can forget about a "removed" device when there's a
1195 * physical disconnect or the connect status changes.
1197 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1198 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1199 clear_bit(port1
, hub
->removed_bits
);
1201 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1202 /* Tell hub_wq to disconnect the device or
1203 * check for a new connection or over current condition.
1204 * Based on USB2.0 Spec Section 11.12.5,
1205 * C_PORT_OVER_CURRENT could be set while
1206 * PORT_OVER_CURRENT is not. So check for any of them.
1208 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1209 (portchange
& USB_PORT_STAT_C_CONNECTION
) ||
1210 (portstatus
& USB_PORT_STAT_OVERCURRENT
) ||
1211 (portchange
& USB_PORT_STAT_C_OVERCURRENT
))
1212 set_bit(port1
, hub
->change_bits
);
1214 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1215 bool port_resumed
= (portstatus
&
1216 USB_PORT_STAT_LINK_STATE
) ==
1218 /* The power session apparently survived the resume.
1219 * If there was an overcurrent or suspend change
1220 * (i.e., remote wakeup request), have hub_wq
1221 * take care of it. Look at the port link state
1222 * for USB 3.0 hubs, since they don't have a suspend
1223 * change bit, and they don't set the port link change
1224 * bit on device-initiated resume.
1226 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1228 set_bit(port1
, hub
->change_bits
);
1230 } else if (udev
->persist_enabled
) {
1232 udev
->reset_resume
= 1;
1234 /* Don't set the change_bits when the device
1237 if (test_bit(port1
, hub
->power_bits
))
1238 set_bit(port1
, hub
->change_bits
);
1241 /* The power session is gone; tell hub_wq */
1242 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1243 set_bit(port1
, hub
->change_bits
);
1247 /* If no port-status-change flags were set, we don't need any
1248 * debouncing. If flags were set we can try to debounce the
1249 * ports all at once right now, instead of letting hub_wq do them
1250 * one at a time later on.
1252 * If any port-status changes do occur during this delay, hub_wq
1253 * will see them later and handle them normally.
1255 if (need_debounce_delay
) {
1256 delay
= HUB_DEBOUNCE_STABLE
;
1258 /* Don't do a long sleep inside a workqueue routine */
1259 if (type
== HUB_INIT2
) {
1260 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1261 queue_delayed_work(system_power_efficient_wq
,
1263 msecs_to_jiffies(delay
));
1264 device_unlock(&hdev
->dev
);
1265 return; /* Continues at init3: below */
1273 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1275 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1276 if (hub
->has_indicators
&& blinkenlights
)
1277 queue_delayed_work(system_power_efficient_wq
,
1278 &hub
->leds
, LED_CYCLE_PERIOD
);
1280 /* Scan all ports that need attention */
1283 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1284 /* Allow autosuspend if it was suppressed */
1286 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1287 device_unlock(&hdev
->dev
);
1290 kref_put(&hub
->kref
, hub_release
);
1293 /* Implement the continuations for the delays above */
1294 static void hub_init_func2(struct work_struct
*ws
)
1296 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1298 hub_activate(hub
, HUB_INIT2
);
1301 static void hub_init_func3(struct work_struct
*ws
)
1303 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1305 hub_activate(hub
, HUB_INIT3
);
1308 enum hub_quiescing_type
{
1309 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1312 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1314 struct usb_device
*hdev
= hub
->hdev
;
1315 unsigned long flags
;
1318 /* hub_wq and related activity won't re-trigger */
1319 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
1321 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
1323 if (type
!= HUB_SUSPEND
) {
1324 /* Disconnect all the children */
1325 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1326 if (hub
->ports
[i
]->child
)
1327 usb_disconnect(&hub
->ports
[i
]->child
);
1331 /* Stop hub_wq and related activity */
1332 del_timer_sync(&hub
->irq_urb_retry
);
1333 usb_kill_urb(hub
->urb
);
1334 if (hub
->has_indicators
)
1335 cancel_delayed_work_sync(&hub
->leds
);
1337 flush_work(&hub
->tt
.clear_work
);
1340 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1344 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1345 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1348 /* caller has locked the hub device */
1349 static int hub_pre_reset(struct usb_interface
*intf
)
1351 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1353 hub_quiesce(hub
, HUB_PRE_RESET
);
1355 hub_pm_barrier_for_all_ports(hub
);
1359 /* caller has locked the hub device */
1360 static int hub_post_reset(struct usb_interface
*intf
)
1362 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1365 hub_pm_barrier_for_all_ports(hub
);
1366 hub_activate(hub
, HUB_POST_RESET
);
1370 static int hub_configure(struct usb_hub
*hub
,
1371 struct usb_endpoint_descriptor
*endpoint
)
1373 struct usb_hcd
*hcd
;
1374 struct usb_device
*hdev
= hub
->hdev
;
1375 struct device
*hub_dev
= hub
->intfdev
;
1376 u16 hubstatus
, hubchange
;
1377 u16 wHubCharacteristics
;
1380 char *message
= "out of memory";
1385 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1391 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1396 mutex_init(&hub
->status_mutex
);
1398 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1399 if (!hub
->descriptor
) {
1404 /* Request the entire hub descriptor.
1405 * hub->descriptor can handle USB_MAXCHILDREN ports,
1406 * but a (non-SS) hub can/will return fewer bytes here.
1408 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1410 message
= "can't read hub descriptor";
1414 maxchild
= USB_MAXCHILDREN
;
1415 if (hub_is_superspeed(hdev
))
1416 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1418 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1419 message
= "hub has too many ports!";
1422 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1423 message
= "hub doesn't have any ports!";
1429 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1430 * The resulting value will be used for SetIsochDelay() request.
1432 if (hub_is_superspeed(hdev
) || hub_is_superspeedplus(hdev
)) {
1433 u32 delay
= __le16_to_cpu(hub
->descriptor
->u
.ss
.wHubDelay
);
1436 delay
+= hdev
->parent
->hub_delay
;
1438 delay
+= USB_TP_TRANSMISSION_DELAY
;
1439 hdev
->hub_delay
= min_t(u32
, delay
, USB_TP_TRANSMISSION_DELAY_MAX
);
1442 maxchild
= hub
->descriptor
->bNbrPorts
;
1443 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1444 (maxchild
== 1) ? "" : "s");
1446 hub
->ports
= kcalloc(maxchild
, sizeof(struct usb_port
*), GFP_KERNEL
);
1452 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1453 if (hub_is_superspeed(hdev
)) {
1461 /* FIXME for USB 3.0, skip for now */
1462 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1463 !(hub_is_superspeed(hdev
))) {
1464 char portstr
[USB_MAXCHILDREN
+ 1];
1466 for (i
= 0; i
< maxchild
; i
++)
1467 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1468 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1470 portstr
[maxchild
] = 0;
1471 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1473 dev_dbg(hub_dev
, "standalone hub\n");
1475 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1476 case HUB_CHAR_COMMON_LPSM
:
1477 dev_dbg(hub_dev
, "ganged power switching\n");
1479 case HUB_CHAR_INDV_PORT_LPSM
:
1480 dev_dbg(hub_dev
, "individual port power switching\n");
1482 case HUB_CHAR_NO_LPSM
:
1484 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1488 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1489 case HUB_CHAR_COMMON_OCPM
:
1490 dev_dbg(hub_dev
, "global over-current protection\n");
1492 case HUB_CHAR_INDV_PORT_OCPM
:
1493 dev_dbg(hub_dev
, "individual port over-current protection\n");
1495 case HUB_CHAR_NO_OCPM
:
1497 dev_dbg(hub_dev
, "no over-current protection\n");
1501 spin_lock_init(&hub
->tt
.lock
);
1502 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1503 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1504 switch (hdev
->descriptor
.bDeviceProtocol
) {
1507 case USB_HUB_PR_HS_SINGLE_TT
:
1508 dev_dbg(hub_dev
, "Single TT\n");
1511 case USB_HUB_PR_HS_MULTI_TT
:
1512 ret
= usb_set_interface(hdev
, 0, 1);
1514 dev_dbg(hub_dev
, "TT per port\n");
1517 dev_err(hub_dev
, "Using single TT (err %d)\n",
1522 /* USB 3.0 hubs don't have a TT */
1525 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1526 hdev
->descriptor
.bDeviceProtocol
);
1530 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1531 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1532 case HUB_TTTT_8_BITS
:
1533 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1534 hub
->tt
.think_time
= 666;
1535 dev_dbg(hub_dev
, "TT requires at most %d "
1536 "FS bit times (%d ns)\n",
1537 8, hub
->tt
.think_time
);
1540 case HUB_TTTT_16_BITS
:
1541 hub
->tt
.think_time
= 666 * 2;
1542 dev_dbg(hub_dev
, "TT requires at most %d "
1543 "FS bit times (%d ns)\n",
1544 16, hub
->tt
.think_time
);
1546 case HUB_TTTT_24_BITS
:
1547 hub
->tt
.think_time
= 666 * 3;
1548 dev_dbg(hub_dev
, "TT requires at most %d "
1549 "FS bit times (%d ns)\n",
1550 24, hub
->tt
.think_time
);
1552 case HUB_TTTT_32_BITS
:
1553 hub
->tt
.think_time
= 666 * 4;
1554 dev_dbg(hub_dev
, "TT requires at most %d "
1555 "FS bit times (%d ns)\n",
1556 32, hub
->tt
.think_time
);
1560 /* probe() zeroes hub->indicator[] */
1561 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1562 hub
->has_indicators
= 1;
1563 dev_dbg(hub_dev
, "Port indicators are supported\n");
1566 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1567 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1569 /* power budgeting mostly matters with bus-powered hubs,
1570 * and battery-powered root hubs (may provide just 8 mA).
1572 ret
= usb_get_std_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1574 message
= "can't get hub status";
1577 hcd
= bus_to_hcd(hdev
->bus
);
1578 if (hdev
== hdev
->bus
->root_hub
) {
1579 if (hcd
->power_budget
> 0)
1580 hdev
->bus_mA
= hcd
->power_budget
;
1582 hdev
->bus_mA
= full_load
* maxchild
;
1583 if (hdev
->bus_mA
>= full_load
)
1584 hub
->mA_per_port
= full_load
;
1586 hub
->mA_per_port
= hdev
->bus_mA
;
1587 hub
->limited_power
= 1;
1589 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1590 int remaining
= hdev
->bus_mA
-
1591 hub
->descriptor
->bHubContrCurrent
;
1593 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1594 hub
->descriptor
->bHubContrCurrent
);
1595 hub
->limited_power
= 1;
1597 if (remaining
< maxchild
* unit_load
)
1599 "insufficient power available "
1600 "to use all downstream ports\n");
1601 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1603 } else { /* Self-powered external hub */
1604 /* FIXME: What about battery-powered external hubs that
1605 * provide less current per port? */
1606 hub
->mA_per_port
= full_load
;
1608 if (hub
->mA_per_port
< full_load
)
1609 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1612 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1614 message
= "can't get hub status";
1618 /* local power status reports aren't always correct */
1619 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1620 dev_dbg(hub_dev
, "local power source is %s\n",
1621 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1622 ? "lost (inactive)" : "good");
1624 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1625 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1626 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1628 /* set up the interrupt endpoint
1629 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1630 * bytes as USB2.0[11.12.3] says because some hubs are known
1631 * to send more data (and thus cause overflow). For root hubs,
1632 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1633 * to be big enough for at least USB_MAXCHILDREN ports. */
1634 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1635 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1637 if (maxp
> sizeof(*hub
->buffer
))
1638 maxp
= sizeof(*hub
->buffer
);
1640 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1646 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1647 hub
, endpoint
->bInterval
);
1649 /* maybe cycle the hub leds */
1650 if (hub
->has_indicators
&& blinkenlights
)
1651 hub
->indicator
[0] = INDICATOR_CYCLE
;
1653 mutex_lock(&usb_port_peer_mutex
);
1654 for (i
= 0; i
< maxchild
; i
++) {
1655 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1657 dev_err(hub
->intfdev
,
1658 "couldn't create port%d device.\n", i
+ 1);
1663 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1664 struct usb_port
*port_dev
= hub
->ports
[i
];
1666 pm_runtime_put(&port_dev
->dev
);
1669 mutex_unlock(&usb_port_peer_mutex
);
1673 /* Update the HCD's internal representation of this hub before hub_wq
1674 * starts getting port status changes for devices under the hub.
1676 if (hcd
->driver
->update_hub_device
) {
1677 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1678 &hub
->tt
, GFP_KERNEL
);
1680 message
= "can't update HCD hub info";
1685 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1687 hub_activate(hub
, HUB_INIT
);
1691 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1693 /* hub_disconnect() frees urb and descriptor */
1697 static void hub_release(struct kref
*kref
)
1699 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1701 usb_put_dev(hub
->hdev
);
1702 usb_put_intf(to_usb_interface(hub
->intfdev
));
1706 static unsigned highspeed_hubs
;
1708 static void hub_disconnect(struct usb_interface
*intf
)
1710 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1711 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1715 * Stop adding new hub events. We do not want to block here and thus
1716 * will not try to remove any pending work item.
1718 hub
->disconnected
= 1;
1720 /* Disconnect all children and quiesce the hub */
1722 hub_quiesce(hub
, HUB_DISCONNECT
);
1724 mutex_lock(&usb_port_peer_mutex
);
1726 /* Avoid races with recursively_mark_NOTATTACHED() */
1727 spin_lock_irq(&device_state_lock
);
1728 port1
= hdev
->maxchild
;
1730 usb_set_intfdata(intf
, NULL
);
1731 spin_unlock_irq(&device_state_lock
);
1733 for (; port1
> 0; --port1
)
1734 usb_hub_remove_port_device(hub
, port1
);
1736 mutex_unlock(&usb_port_peer_mutex
);
1738 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1741 usb_free_urb(hub
->urb
);
1743 kfree(hub
->descriptor
);
1747 pm_suspend_ignore_children(&intf
->dev
, false);
1749 if (hub
->quirk_disable_autosuspend
)
1750 usb_autopm_put_interface(intf
);
1752 kref_put(&hub
->kref
, hub_release
);
1755 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1757 /* Some hubs have a subclass of 1, which AFAICT according to the */
1758 /* specs is not defined, but it works */
1759 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1760 desc
->desc
.bInterfaceSubClass
!= 1)
1763 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1764 if (desc
->desc
.bNumEndpoints
!= 1)
1767 /* If the first endpoint is not interrupt IN, we'd better punt! */
1768 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1774 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1776 struct usb_host_interface
*desc
;
1777 struct usb_device
*hdev
;
1778 struct usb_hub
*hub
;
1780 desc
= intf
->cur_altsetting
;
1781 hdev
= interface_to_usbdev(intf
);
1784 * Set default autosuspend delay as 0 to speedup bus suspend,
1785 * based on the below considerations:
1787 * - Unlike other drivers, the hub driver does not rely on the
1788 * autosuspend delay to provide enough time to handle a wakeup
1789 * event, and the submitted status URB is just to check future
1790 * change on hub downstream ports, so it is safe to do it.
1792 * - The patch might cause one or more auto supend/resume for
1793 * below very rare devices when they are plugged into hub
1796 * devices having trouble initializing, and disconnect
1797 * themselves from the bus and then reconnect a second
1800 * devices just for downloading firmware, and disconnects
1801 * themselves after completing it
1803 * For these quite rare devices, their drivers may change the
1804 * autosuspend delay of their parent hub in the probe() to one
1805 * appropriate value to avoid the subtle problem if someone
1808 * - The patch may cause one or more auto suspend/resume on
1809 * hub during running 'lsusb', but it is probably too
1810 * infrequent to worry about.
1812 * - Change autosuspend delay of hub can avoid unnecessary auto
1813 * suspend timer for hub, also may decrease power consumption
1816 * - If user has indicated to prevent autosuspend by passing
1817 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1820 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1821 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1825 * Hubs have proper suspend/resume support, except for root hubs
1826 * where the controller driver doesn't have bus_suspend and
1827 * bus_resume methods.
1829 if (hdev
->parent
) { /* normal device */
1830 usb_enable_autosuspend(hdev
);
1831 } else { /* root hub */
1832 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1834 if (drv
->bus_suspend
&& drv
->bus_resume
)
1835 usb_enable_autosuspend(hdev
);
1838 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1840 "Unsupported bus topology: hub nested too deep\n");
1844 #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1846 dev_warn(&intf
->dev
, "ignoring external hub\n");
1851 if (!hub_descriptor_is_sane(desc
)) {
1852 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1856 /* We found a hub */
1857 dev_info(&intf
->dev
, "USB hub found\n");
1859 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1863 kref_init(&hub
->kref
);
1864 hub
->intfdev
= &intf
->dev
;
1866 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1867 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1868 INIT_WORK(&hub
->events
, hub_event
);
1869 spin_lock_init(&hub
->irq_urb_lock
);
1870 timer_setup(&hub
->irq_urb_retry
, hub_retry_irq_urb
, 0);
1874 usb_set_intfdata(intf
, hub
);
1875 intf
->needs_remote_wakeup
= 1;
1876 pm_suspend_ignore_children(&intf
->dev
, true);
1878 if (hdev
->speed
== USB_SPEED_HIGH
)
1881 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1882 hub
->quirk_check_port_auto_suspend
= 1;
1884 if (id
->driver_info
& HUB_QUIRK_DISABLE_AUTOSUSPEND
) {
1885 hub
->quirk_disable_autosuspend
= 1;
1886 usb_autopm_get_interface_no_resume(intf
);
1889 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0)
1892 hub_disconnect(intf
);
1897 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1899 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1900 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1902 /* assert ifno == 0 (part of hub spec) */
1904 case USBDEVFS_HUB_PORTINFO
: {
1905 struct usbdevfs_hub_portinfo
*info
= user_data
;
1908 spin_lock_irq(&device_state_lock
);
1909 if (hdev
->devnum
<= 0)
1912 info
->nports
= hdev
->maxchild
;
1913 for (i
= 0; i
< info
->nports
; i
++) {
1914 if (hub
->ports
[i
]->child
== NULL
)
1918 hub
->ports
[i
]->child
->devnum
;
1921 spin_unlock_irq(&device_state_lock
);
1923 return info
->nports
+ 1;
1932 * Allow user programs to claim ports on a hub. When a device is attached
1933 * to one of these "claimed" ports, the program will "own" the device.
1935 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1936 struct usb_dev_state
***ppowner
)
1938 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1940 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1942 if (port1
== 0 || port1
> hdev
->maxchild
)
1945 /* Devices not managed by the hub driver
1946 * will always have maxchild equal to 0.
1948 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1952 /* In the following three functions, the caller must hold hdev's lock */
1953 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1954 struct usb_dev_state
*owner
)
1957 struct usb_dev_state
**powner
;
1959 rc
= find_port_owner(hdev
, port1
, &powner
);
1967 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1969 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1970 struct usb_dev_state
*owner
)
1973 struct usb_dev_state
**powner
;
1975 rc
= find_port_owner(hdev
, port1
, &powner
);
1978 if (*powner
!= owner
)
1983 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1985 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1987 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1990 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1991 if (hub
->ports
[n
]->port_owner
== owner
)
1992 hub
->ports
[n
]->port_owner
= NULL
;
1997 /* The caller must hold udev's lock */
1998 bool usb_device_is_owned(struct usb_device
*udev
)
2000 struct usb_hub
*hub
;
2002 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
2004 hub
= usb_hub_to_struct_hub(udev
->parent
);
2005 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
2008 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
2010 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2013 for (i
= 0; i
< udev
->maxchild
; ++i
) {
2014 if (hub
->ports
[i
]->child
)
2015 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
2017 if (udev
->state
== USB_STATE_SUSPENDED
)
2018 udev
->active_duration
-= jiffies
;
2019 udev
->state
= USB_STATE_NOTATTACHED
;
2023 * usb_set_device_state - change a device's current state (usbcore, hcds)
2024 * @udev: pointer to device whose state should be changed
2025 * @new_state: new state value to be stored
2027 * udev->state is _not_ fully protected by the device lock. Although
2028 * most transitions are made only while holding the lock, the state can
2029 * can change to USB_STATE_NOTATTACHED at almost any time. This
2030 * is so that devices can be marked as disconnected as soon as possible,
2031 * without having to wait for any semaphores to be released. As a result,
2032 * all changes to any device's state must be protected by the
2033 * device_state_lock spinlock.
2035 * Once a device has been added to the device tree, all changes to its state
2036 * should be made using this routine. The state should _not_ be set directly.
2038 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2039 * Otherwise udev->state is set to new_state, and if new_state is
2040 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2041 * to USB_STATE_NOTATTACHED.
2043 void usb_set_device_state(struct usb_device
*udev
,
2044 enum usb_device_state new_state
)
2046 unsigned long flags
;
2049 spin_lock_irqsave(&device_state_lock
, flags
);
2050 if (udev
->state
== USB_STATE_NOTATTACHED
)
2052 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2054 /* root hub wakeup capabilities are managed out-of-band
2055 * and may involve silicon errata ... ignore them here.
2058 if (udev
->state
== USB_STATE_SUSPENDED
2059 || new_state
== USB_STATE_SUSPENDED
)
2060 ; /* No change to wakeup settings */
2061 else if (new_state
== USB_STATE_CONFIGURED
)
2062 wakeup
= (udev
->quirks
&
2063 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
2064 udev
->actconfig
->desc
.bmAttributes
&
2065 USB_CONFIG_ATT_WAKEUP
;
2069 if (udev
->state
== USB_STATE_SUSPENDED
&&
2070 new_state
!= USB_STATE_SUSPENDED
)
2071 udev
->active_duration
-= jiffies
;
2072 else if (new_state
== USB_STATE_SUSPENDED
&&
2073 udev
->state
!= USB_STATE_SUSPENDED
)
2074 udev
->active_duration
+= jiffies
;
2075 udev
->state
= new_state
;
2077 recursively_mark_NOTATTACHED(udev
);
2078 spin_unlock_irqrestore(&device_state_lock
, flags
);
2080 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2082 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2085 * Choose a device number.
2087 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2088 * USB-2.0 buses they are also used as device addresses, however on
2089 * USB-3.0 buses the address is assigned by the controller hardware
2090 * and it usually is not the same as the device number.
2092 * WUSB devices are simple: they have no hubs behind, so the mapping
2093 * device <-> virtual port number becomes 1:1. Why? to simplify the
2094 * life of the device connection logic in
2095 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2096 * handshake we need to assign a temporary address in the unauthorized
2097 * space. For simplicity we use the first virtual port number found to
2098 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2099 * and that becomes it's address [X < 128] or its unauthorized address
2102 * We add 1 as an offset to the one-based USB-stack port number
2103 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2104 * 0 is reserved by USB for default address; (b) Linux's USB stack
2105 * uses always #1 for the root hub of the controller. So USB stack's
2106 * port #1, which is wusb virtual-port #0 has address #2.
2108 * Devices connected under xHCI are not as simple. The host controller
2109 * supports virtualization, so the hardware assigns device addresses and
2110 * the HCD must setup data structures before issuing a set address
2111 * command to the hardware.
2113 static void choose_devnum(struct usb_device
*udev
)
2116 struct usb_bus
*bus
= udev
->bus
;
2118 /* be safe when more hub events are proceed in parallel */
2119 mutex_lock(&bus
->devnum_next_mutex
);
2121 devnum
= udev
->portnum
+ 1;
2122 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2124 /* Try to allocate the next devnum beginning at
2125 * bus->devnum_next. */
2126 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2129 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2131 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2134 set_bit(devnum
, bus
->devmap
.devicemap
);
2135 udev
->devnum
= devnum
;
2137 mutex_unlock(&bus
->devnum_next_mutex
);
2140 static void release_devnum(struct usb_device
*udev
)
2142 if (udev
->devnum
> 0) {
2143 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2148 static void update_devnum(struct usb_device
*udev
, int devnum
)
2150 /* The address for a WUSB device is managed by wusbcore. */
2152 udev
->devnum
= devnum
;
2154 udev
->devaddr
= (u8
)devnum
;
2157 static void hub_free_dev(struct usb_device
*udev
)
2159 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2161 /* Root hubs aren't real devices, so don't free HCD resources */
2162 if (hcd
->driver
->free_dev
&& udev
->parent
)
2163 hcd
->driver
->free_dev(hcd
, udev
);
2166 static void hub_disconnect_children(struct usb_device
*udev
)
2168 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2171 /* Free up all the children before we remove this device */
2172 for (i
= 0; i
< udev
->maxchild
; i
++) {
2173 if (hub
->ports
[i
]->child
)
2174 usb_disconnect(&hub
->ports
[i
]->child
);
2179 * usb_disconnect - disconnect a device (usbcore-internal)
2180 * @pdev: pointer to device being disconnected
2182 * Context: task context, might sleep
2184 * Something got disconnected. Get rid of it and all of its children.
2186 * If *pdev is a normal device then the parent hub must already be locked.
2187 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2188 * which protects the set of root hubs as well as the list of buses.
2190 * Only hub drivers (including virtual root hub drivers for host
2191 * controllers) should ever call this.
2193 * This call is synchronous, and may not be used in an interrupt context.
2195 void usb_disconnect(struct usb_device
**pdev
)
2197 struct usb_port
*port_dev
= NULL
;
2198 struct usb_device
*udev
= *pdev
;
2199 struct usb_hub
*hub
= NULL
;
2202 /* mark the device as inactive, so any further urb submissions for
2203 * this device (and any of its children) will fail immediately.
2204 * this quiesces everything except pending urbs.
2206 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2207 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2211 * Ensure that the pm runtime code knows that the USB device
2212 * is in the process of being disconnected.
2214 pm_runtime_barrier(&udev
->dev
);
2216 usb_lock_device(udev
);
2218 hub_disconnect_children(udev
);
2220 /* deallocate hcd/hardware state ... nuking all pending urbs and
2221 * cleaning up all state associated with the current configuration
2222 * so that the hardware is now fully quiesced.
2224 dev_dbg(&udev
->dev
, "unregistering device\n");
2225 usb_disable_device(udev
, 0);
2226 usb_hcd_synchronize_unlinks(udev
);
2229 port1
= udev
->portnum
;
2230 hub
= usb_hub_to_struct_hub(udev
->parent
);
2231 port_dev
= hub
->ports
[port1
- 1];
2233 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2234 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2237 * As usb_port_runtime_resume() de-references udev, make
2238 * sure no resumes occur during removal
2240 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2241 pm_runtime_get_sync(&port_dev
->dev
);
2244 usb_remove_ep_devs(&udev
->ep0
);
2245 usb_unlock_device(udev
);
2247 /* Unregister the device. The device driver is responsible
2248 * for de-configuring the device and invoking the remove-device
2249 * notifier chain (used by usbfs and possibly others).
2251 device_del(&udev
->dev
);
2253 /* Free the device number and delete the parent's children[]
2254 * (or root_hub) pointer.
2256 release_devnum(udev
);
2258 /* Avoid races with recursively_mark_NOTATTACHED() */
2259 spin_lock_irq(&device_state_lock
);
2261 spin_unlock_irq(&device_state_lock
);
2263 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2264 pm_runtime_put(&port_dev
->dev
);
2268 put_device(&udev
->dev
);
2271 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2272 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2276 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2279 static void announce_device(struct usb_device
*udev
)
2281 u16 bcdDevice
= le16_to_cpu(udev
->descriptor
.bcdDevice
);
2283 dev_info(&udev
->dev
,
2284 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2285 le16_to_cpu(udev
->descriptor
.idVendor
),
2286 le16_to_cpu(udev
->descriptor
.idProduct
),
2287 bcdDevice
>> 8, bcdDevice
& 0xff);
2288 dev_info(&udev
->dev
,
2289 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2290 udev
->descriptor
.iManufacturer
,
2291 udev
->descriptor
.iProduct
,
2292 udev
->descriptor
.iSerialNumber
);
2293 show_string(udev
, "Product", udev
->product
);
2294 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2295 show_string(udev
, "SerialNumber", udev
->serial
);
2298 static inline void announce_device(struct usb_device
*udev
) { }
2303 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2304 * @udev: newly addressed device (in ADDRESS state)
2306 * Finish enumeration for On-The-Go devices
2308 * Return: 0 if successful. A negative error code otherwise.
2310 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2314 #ifdef CONFIG_USB_OTG
2316 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2317 * to wake us after we've powered off VBUS; and HNP, switching roles
2318 * "host" to "peripheral". The OTG descriptor helps figure this out.
2320 if (!udev
->bus
->is_b_host
2322 && udev
->parent
== udev
->bus
->root_hub
) {
2323 struct usb_otg_descriptor
*desc
= NULL
;
2324 struct usb_bus
*bus
= udev
->bus
;
2325 unsigned port1
= udev
->portnum
;
2327 /* descriptor may appear anywhere in config */
2328 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2329 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2330 USB_DT_OTG
, (void **) &desc
, sizeof(*desc
));
2331 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2334 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2335 (port1
== bus
->otg_port
) ? "" : "non-");
2337 /* enable HNP before suspend, it's simpler */
2338 if (port1
== bus
->otg_port
) {
2339 bus
->b_hnp_enable
= 1;
2340 err
= usb_control_msg(udev
,
2341 usb_sndctrlpipe(udev
, 0),
2342 USB_REQ_SET_FEATURE
, 0,
2343 USB_DEVICE_B_HNP_ENABLE
,
2345 USB_CTRL_SET_TIMEOUT
);
2348 * OTG MESSAGE: report errors here,
2349 * customize to match your product.
2351 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2353 bus
->b_hnp_enable
= 0;
2355 } else if (desc
->bLength
== sizeof
2356 (struct usb_otg_descriptor
)) {
2357 /* Set a_alt_hnp_support for legacy otg device */
2358 err
= usb_control_msg(udev
,
2359 usb_sndctrlpipe(udev
, 0),
2360 USB_REQ_SET_FEATURE
, 0,
2361 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2363 USB_CTRL_SET_TIMEOUT
);
2366 "set a_alt_hnp_support failed: %d\n",
2376 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2377 * @udev: newly addressed device (in ADDRESS state)
2379 * This is only called by usb_new_device() and usb_authorize_device()
2380 * and FIXME -- all comments that apply to them apply here wrt to
2383 * If the device is WUSB and not authorized, we don't attempt to read
2384 * the string descriptors, as they will be errored out by the device
2385 * until it has been authorized.
2387 * Return: 0 if successful. A negative error code otherwise.
2389 static int usb_enumerate_device(struct usb_device
*udev
)
2392 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2394 if (udev
->config
== NULL
) {
2395 err
= usb_get_configuration(udev
);
2398 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2404 /* read the standard strings and cache them if present */
2405 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2406 udev
->manufacturer
= usb_cache_string(udev
,
2407 udev
->descriptor
.iManufacturer
);
2408 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2410 err
= usb_enumerate_device_otg(udev
);
2414 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST
) && hcd
->tpl_support
&&
2415 !is_targeted(udev
)) {
2416 /* Maybe it can talk to us, though we can't talk to it.
2417 * (Includes HNP test device.)
2419 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2420 || udev
->bus
->is_b_host
)) {
2421 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2423 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2428 usb_detect_interface_quirks(udev
);
2433 static void set_usb_port_removable(struct usb_device
*udev
)
2435 struct usb_device
*hdev
= udev
->parent
;
2436 struct usb_hub
*hub
;
2437 u8 port
= udev
->portnum
;
2438 u16 wHubCharacteristics
;
2439 bool removable
= true;
2441 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE_UNKNOWN
);
2446 hub
= usb_hub_to_struct_hub(udev
->parent
);
2449 * If the platform firmware has provided information about a port,
2450 * use that to determine whether it's removable.
2452 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2453 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2454 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE
);
2456 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2457 case USB_PORT_NOT_USED
:
2458 dev_set_removable(&udev
->dev
, DEVICE_FIXED
);
2465 * Otherwise, check whether the hub knows whether a port is removable
2468 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2470 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2473 if (hub_is_superspeed(hdev
)) {
2474 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2478 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2483 dev_set_removable(&udev
->dev
, DEVICE_REMOVABLE
);
2485 dev_set_removable(&udev
->dev
, DEVICE_FIXED
);
2490 * usb_new_device - perform initial device setup (usbcore-internal)
2491 * @udev: newly addressed device (in ADDRESS state)
2493 * This is called with devices which have been detected but not fully
2494 * enumerated. The device descriptor is available, but not descriptors
2495 * for any device configuration. The caller must have locked either
2496 * the parent hub (if udev is a normal device) or else the
2497 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2498 * udev has already been installed, but udev is not yet visible through
2499 * sysfs or other filesystem code.
2501 * This call is synchronous, and may not be used in an interrupt context.
2503 * Only the hub driver or root-hub registrar should ever call this.
2505 * Return: Whether the device is configured properly or not. Zero if the
2506 * interface was registered with the driver core; else a negative errno
2510 int usb_new_device(struct usb_device
*udev
)
2515 /* Initialize non-root-hub device wakeup to disabled;
2516 * device (un)configuration controls wakeup capable
2517 * sysfs power/wakeup controls wakeup enabled/disabled
2519 device_init_wakeup(&udev
->dev
, 0);
2522 /* Tell the runtime-PM framework the device is active */
2523 pm_runtime_set_active(&udev
->dev
);
2524 pm_runtime_get_noresume(&udev
->dev
);
2525 pm_runtime_use_autosuspend(&udev
->dev
);
2526 pm_runtime_enable(&udev
->dev
);
2528 /* By default, forbid autosuspend for all devices. It will be
2529 * allowed for hubs during binding.
2531 usb_disable_autosuspend(udev
);
2533 err
= usb_enumerate_device(udev
); /* Read descriptors */
2536 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2537 udev
->devnum
, udev
->bus
->busnum
,
2538 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2539 /* export the usbdev device-node for libusb */
2540 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2541 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2543 /* Tell the world! */
2544 announce_device(udev
);
2547 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2549 add_device_randomness(udev
->product
, strlen(udev
->product
));
2550 if (udev
->manufacturer
)
2551 add_device_randomness(udev
->manufacturer
,
2552 strlen(udev
->manufacturer
));
2554 device_enable_async_suspend(&udev
->dev
);
2556 /* check whether the hub or firmware marks this port as non-removable */
2557 set_usb_port_removable(udev
);
2559 /* Register the device. The device driver is responsible
2560 * for configuring the device and invoking the add-device
2561 * notifier chain (used by usbfs and possibly others).
2563 err
= device_add(&udev
->dev
);
2565 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2569 /* Create link files between child device and usb port device. */
2571 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2572 int port1
= udev
->portnum
;
2573 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2575 err
= sysfs_create_link(&udev
->dev
.kobj
,
2576 &port_dev
->dev
.kobj
, "port");
2580 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2581 &udev
->dev
.kobj
, "device");
2583 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2587 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2588 pm_runtime_get_sync(&port_dev
->dev
);
2591 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2592 usb_mark_last_busy(udev
);
2593 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2597 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2598 pm_runtime_disable(&udev
->dev
);
2599 pm_runtime_set_suspended(&udev
->dev
);
2605 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2606 * @usb_dev: USB device
2608 * Move the USB device to a very basic state where interfaces are disabled
2609 * and the device is in fact unconfigured and unusable.
2611 * We share a lock (that we have) with device_del(), so we need to
2616 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2618 usb_lock_device(usb_dev
);
2619 if (usb_dev
->authorized
== 0)
2620 goto out_unauthorized
;
2622 usb_dev
->authorized
= 0;
2623 usb_set_configuration(usb_dev
, -1);
2626 usb_unlock_device(usb_dev
);
2631 int usb_authorize_device(struct usb_device
*usb_dev
)
2635 usb_lock_device(usb_dev
);
2636 if (usb_dev
->authorized
== 1)
2637 goto out_authorized
;
2639 result
= usb_autoresume_device(usb_dev
);
2641 dev_err(&usb_dev
->dev
,
2642 "can't autoresume for authorization: %d\n", result
);
2643 goto error_autoresume
;
2646 if (usb_dev
->wusb
) {
2647 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2649 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2650 "authorization: %d\n", result
);
2651 goto error_device_descriptor
;
2655 usb_dev
->authorized
= 1;
2656 /* Choose and set the configuration. This registers the interfaces
2657 * with the driver core and lets interface drivers bind to them.
2659 c
= usb_choose_configuration(usb_dev
);
2661 result
= usb_set_configuration(usb_dev
, c
);
2663 dev_err(&usb_dev
->dev
,
2664 "can't set config #%d, error %d\n", c
, result
);
2665 /* This need not be fatal. The user can try to
2666 * set other configurations. */
2669 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2671 error_device_descriptor
:
2672 usb_autosuspend_device(usb_dev
);
2675 usb_unlock_device(usb_dev
); /* complements locktree */
2680 * get_port_ssp_rate - Match the extended port status to SSP rate
2681 * @hdev: The hub device
2682 * @ext_portstatus: extended port status
2684 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2685 * capability attributes. Base on the number of connected lanes and speed,
2686 * return the corresponding enum usb_ssp_rate.
2688 static enum usb_ssp_rate
get_port_ssp_rate(struct usb_device
*hdev
,
2691 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2701 speed_id
= ext_portstatus
& USB_EXT_PORT_STAT_RX_SPEED_ID
;
2702 lanes
= USB_EXT_PORT_RX_LANES(ext_portstatus
) + 1;
2704 ssac
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2705 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2707 for (i
= 0; i
<= ssac
; i
++) {
2710 attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2711 ssid
= FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID
, attr
);
2712 if (speed_id
== ssid
) {
2718 * Note: currently asymmetric lane types are only
2719 * applicable for SSIC operate in SuperSpeed protocol
2721 type
= FIELD_GET(USB_SSP_SUBLINK_SPEED_ST
, attr
);
2722 if (type
== USB_SSP_SUBLINK_SPEED_ST_ASYM_RX
||
2723 type
== USB_SSP_SUBLINK_SPEED_ST_ASYM_TX
)
2726 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP
, attr
) !=
2727 USB_SSP_SUBLINK_SPEED_LP_SSP
)
2730 lse
= FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE
, attr
);
2731 mantissa
= FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM
, attr
);
2733 /* Convert to Gbps */
2734 for (; lse
< USB_SSP_SUBLINK_SPEED_LSE_GBPS
; lse
++)
2737 if (mantissa
>= 10 && lanes
== 1)
2738 return USB_SSP_GEN_2x1
;
2740 if (mantissa
>= 10 && lanes
== 2)
2741 return USB_SSP_GEN_2x2
;
2743 if (mantissa
>= 5 && lanes
== 2)
2744 return USB_SSP_GEN_1x2
;
2751 return USB_SSP_GEN_UNKNOWN
;
2754 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2755 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2757 struct usb_hcd
*hcd
;
2758 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2760 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2761 return hcd
->wireless
;
2765 #ifdef CONFIG_USB_FEW_INIT_RETRIES
2766 #define PORT_RESET_TRIES 2
2767 #define SET_ADDRESS_TRIES 1
2768 #define GET_DESCRIPTOR_TRIES 1
2769 #define GET_MAXPACKET0_TRIES 1
2770 #define PORT_INIT_TRIES 4
2773 #define PORT_RESET_TRIES 5
2774 #define SET_ADDRESS_TRIES 2
2775 #define GET_DESCRIPTOR_TRIES 2
2776 #define GET_MAXPACKET0_TRIES 3
2777 #define PORT_INIT_TRIES 4
2778 #endif /* CONFIG_USB_FEW_INIT_RETRIES */
2780 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2781 #define HUB_SHORT_RESET_TIME 10
2782 #define HUB_BH_RESET_TIME 50
2783 #define HUB_LONG_RESET_TIME 200
2784 #define HUB_RESET_TIMEOUT 800
2786 static bool use_new_scheme(struct usb_device
*udev
, int retry
,
2787 struct usb_port
*port_dev
)
2789 int old_scheme_first_port
=
2790 (port_dev
->quirks
& USB_PORT_QUIRK_OLD_SCHEME
) ||
2794 * "New scheme" enumeration causes an extra state transition to be
2795 * exposed to an xhci host and causes USB3 devices to receive control
2796 * commands in the default state. This has been seen to cause
2797 * enumeration failures, so disable this enumeration scheme for USB3
2800 if (udev
->speed
>= USB_SPEED_SUPER
)
2804 * If use_both_schemes is set, use the first scheme (whichever
2805 * it is) for the larger half of the retries, then use the other
2806 * scheme. Otherwise, use the first scheme for all the retries.
2808 if (use_both_schemes
&& retry
>= (PORT_INIT_TRIES
+ 1) / 2)
2809 return old_scheme_first_port
; /* Second half */
2810 return !old_scheme_first_port
; /* First half or all */
2813 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2814 * Port warm reset is required to recover
2816 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2821 if (!hub_is_superspeed(hub
->hdev
))
2824 if (test_bit(port1
, hub
->warm_reset_bits
))
2827 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2828 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2829 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2832 static void hub_port_power_cycle(struct usb_hub
*hub
, int port1
)
2834 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2837 ret
= usb_hub_set_port_power(hub
, port1
, false);
2839 dev_info(&port_dev
->dev
, "failed to disable port power\n");
2843 msleep(2 * hub_power_on_good_delay(hub
));
2844 ret
= usb_hub_set_port_power(hub
, port1
, true);
2846 dev_info(&port_dev
->dev
, "failed to enable port power\n");
2850 msleep(hub_power_on_good_delay(hub
));
2853 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2854 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2856 int delay_time
, ret
;
2859 u32 ext_portstatus
= 0;
2861 for (delay_time
= 0;
2862 delay_time
< HUB_RESET_TIMEOUT
;
2863 delay_time
+= delay
) {
2864 /* wait to give the device a chance to reset */
2867 /* read and decode port status */
2868 if (hub_is_superspeedplus(hub
->hdev
))
2869 ret
= hub_ext_port_status(hub
, port1
,
2870 HUB_EXT_PORT_STATUS
,
2871 &portstatus
, &portchange
,
2874 ret
= hub_port_status(hub
, port1
, &portstatus
,
2880 * The port state is unknown until the reset completes.
2882 * On top of that, some chips may require additional time
2883 * to re-establish a connection after the reset is complete,
2884 * so also wait for the connection to be re-established.
2886 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2887 (portstatus
& USB_PORT_STAT_CONNECTION
))
2890 /* switch to the long delay after two short delay failures */
2891 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2892 delay
= HUB_LONG_RESET_TIME
;
2894 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2895 "not %sreset yet, waiting %dms\n",
2896 warm
? "warm " : "", delay
);
2899 if ((portstatus
& USB_PORT_STAT_RESET
))
2902 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2905 /* Device went away? */
2906 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2909 /* Retry if connect change is set but status is still connected.
2910 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2911 * but the device may have successfully re-connected. Ignore it.
2913 if (!hub_is_superspeed(hub
->hdev
) &&
2914 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2915 usb_clear_port_feature(hub
->hdev
, port1
,
2916 USB_PORT_FEAT_C_CONNECTION
);
2920 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2926 if (hub_is_superspeedplus(hub
->hdev
)) {
2927 /* extended portstatus Rx and Tx lane count are zero based */
2928 udev
->rx_lanes
= USB_EXT_PORT_RX_LANES(ext_portstatus
) + 1;
2929 udev
->tx_lanes
= USB_EXT_PORT_TX_LANES(ext_portstatus
) + 1;
2930 udev
->ssp_rate
= get_port_ssp_rate(hub
->hdev
, ext_portstatus
);
2934 udev
->ssp_rate
= USB_SSP_GEN_UNKNOWN
;
2936 if (hub_is_wusb(hub
))
2937 udev
->speed
= USB_SPEED_WIRELESS
;
2938 else if (udev
->ssp_rate
!= USB_SSP_GEN_UNKNOWN
)
2939 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2940 else if (hub_is_superspeed(hub
->hdev
))
2941 udev
->speed
= USB_SPEED_SUPER
;
2942 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2943 udev
->speed
= USB_SPEED_HIGH
;
2944 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2945 udev
->speed
= USB_SPEED_LOW
;
2947 udev
->speed
= USB_SPEED_FULL
;
2951 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2952 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2953 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2956 u16 portchange
, portstatus
;
2957 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2958 int reset_recovery_time
;
2960 if (!hub_is_superspeed(hub
->hdev
)) {
2962 dev_err(hub
->intfdev
, "only USB3 hub support "
2966 /* Block EHCI CF initialization during the port reset.
2967 * Some companion controllers don't like it when they mix.
2969 down_read(&ehci_cf_port_reset_rwsem
);
2972 * If the caller hasn't explicitly requested a warm reset,
2973 * double check and see if one is needed.
2975 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2976 if (hub_port_warm_reset_required(hub
, port1
,
2980 clear_bit(port1
, hub
->warm_reset_bits
);
2982 /* Reset the port */
2983 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2984 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2985 USB_PORT_FEAT_BH_PORT_RESET
:
2986 USB_PORT_FEAT_RESET
));
2987 if (status
== -ENODEV
) {
2988 ; /* The hub is gone */
2989 } else if (status
) {
2990 dev_err(&port_dev
->dev
,
2991 "cannot %sreset (err = %d)\n",
2992 warm
? "warm " : "", status
);
2994 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2996 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2997 dev_dbg(hub
->intfdev
,
2998 "port_wait_reset: err = %d\n",
3002 /* Check for disconnect or reset */
3003 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
3004 usb_clear_port_feature(hub
->hdev
, port1
,
3005 USB_PORT_FEAT_C_RESET
);
3007 if (!hub_is_superspeed(hub
->hdev
))
3010 usb_clear_port_feature(hub
->hdev
, port1
,
3011 USB_PORT_FEAT_C_BH_PORT_RESET
);
3012 usb_clear_port_feature(hub
->hdev
, port1
,
3013 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3016 usb_clear_port_feature(hub
->hdev
, port1
,
3017 USB_PORT_FEAT_C_CONNECTION
);
3020 * If a USB 3.0 device migrates from reset to an error
3021 * state, re-issue the warm reset.
3023 if (hub_port_status(hub
, port1
,
3024 &portstatus
, &portchange
) < 0)
3027 if (!hub_port_warm_reset_required(hub
, port1
,
3032 * If the port is in SS.Inactive or Compliance Mode, the
3033 * hot or warm reset failed. Try another warm reset.
3036 dev_dbg(&port_dev
->dev
,
3037 "hot reset failed, warm reset\n");
3042 dev_dbg(&port_dev
->dev
,
3043 "not enabled, trying %sreset again...\n",
3044 warm
? "warm " : "");
3045 delay
= HUB_LONG_RESET_TIME
;
3048 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
3052 if (port_dev
->quirks
& USB_PORT_QUIRK_FAST_ENUM
)
3053 usleep_range(10000, 12000);
3055 /* TRSTRCY = 10 ms; plus some extra */
3056 reset_recovery_time
= 10 + 40;
3058 /* Hub needs extra delay after resetting its port. */
3059 if (hub
->hdev
->quirks
& USB_QUIRK_HUB_SLOW_RESET
)
3060 reset_recovery_time
+= 100;
3062 msleep(reset_recovery_time
);
3066 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3068 update_devnum(udev
, 0);
3069 /* The xHC may think the device is already reset,
3070 * so ignore the status.
3072 if (hcd
->driver
->reset_device
)
3073 hcd
->driver
->reset_device(hcd
, udev
);
3075 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
3079 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
3082 if (!hub_is_superspeed(hub
->hdev
))
3083 up_read(&ehci_cf_port_reset_rwsem
);
3088 /* Check if a port is power on */
3089 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
3093 if (hub_is_superspeed(hub
->hdev
)) {
3094 if (portstatus
& USB_SS_PORT_STAT_POWER
)
3097 if (portstatus
& USB_PORT_STAT_POWER
)
3104 static void usb_lock_port(struct usb_port
*port_dev
)
3105 __acquires(&port_dev
->status_lock
)
3107 mutex_lock(&port_dev
->status_lock
);
3108 __acquire(&port_dev
->status_lock
);
3111 static void usb_unlock_port(struct usb_port
*port_dev
)
3112 __releases(&port_dev
->status_lock
)
3114 mutex_unlock(&port_dev
->status_lock
);
3115 __release(&port_dev
->status_lock
);
3120 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3121 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
3125 if (hub_is_superspeed(hub
->hdev
)) {
3126 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
3127 == USB_SS_PORT_LS_U3
)
3130 if (portstatus
& USB_PORT_STAT_SUSPEND
)
3137 /* Determine whether the device on a port is ready for a normal resume,
3138 * is ready for a reset-resume, or should be disconnected.
3140 static int check_port_resume_type(struct usb_device
*udev
,
3141 struct usb_hub
*hub
, int port1
,
3142 int status
, u16 portchange
, u16 portstatus
)
3144 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3148 /* Is a warm reset needed to recover the connection? */
3149 if (status
== 0 && udev
->reset_resume
3150 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
3153 /* Is the device still present? */
3154 else if (status
|| port_is_suspended(hub
, portstatus
) ||
3155 !port_is_power_on(hub
, portstatus
)) {
3158 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
3160 usleep_range(200, 300);
3161 status
= hub_port_status(hub
, port1
, &portstatus
,
3168 /* Can't do a normal resume if the port isn't enabled,
3169 * so try a reset-resume instead.
3171 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3172 if (udev
->persist_enabled
)
3173 udev
->reset_resume
= 1;
3179 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
3180 portchange
, portstatus
, status
);
3181 } else if (udev
->reset_resume
) {
3183 /* Late port handoff can set status-change bits */
3184 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3185 usb_clear_port_feature(hub
->hdev
, port1
,
3186 USB_PORT_FEAT_C_CONNECTION
);
3187 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3188 usb_clear_port_feature(hub
->hdev
, port1
,
3189 USB_PORT_FEAT_C_ENABLE
);
3192 * Whatever made this reset-resume necessary may have
3193 * turned on the port1 bit in hub->change_bits. But after
3194 * a successful reset-resume we want the bit to be clear;
3195 * if it was on it would indicate that something happened
3196 * following the reset-resume.
3198 clear_bit(port1
, hub
->change_bits
);
3204 int usb_disable_ltm(struct usb_device
*udev
)
3206 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3208 /* Check if the roothub and device supports LTM. */
3209 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3210 !usb_device_supports_ltm(udev
))
3213 /* Clear Feature LTM Enable can only be sent if the device is
3216 if (!udev
->actconfig
)
3219 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3220 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3221 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3222 USB_CTRL_SET_TIMEOUT
);
3224 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3226 void usb_enable_ltm(struct usb_device
*udev
)
3228 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3230 /* Check if the roothub and device supports LTM. */
3231 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3232 !usb_device_supports_ltm(udev
))
3235 /* Set Feature LTM Enable can only be sent if the device is
3238 if (!udev
->actconfig
)
3241 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3242 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3243 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3244 USB_CTRL_SET_TIMEOUT
);
3246 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3249 * usb_enable_remote_wakeup - enable remote wakeup for a device
3250 * @udev: target device
3252 * For USB-2 devices: Set the device's remote wakeup feature.
3254 * For USB-3 devices: Assume there's only one function on the device and
3255 * enable remote wake for the first interface. FIXME if the interface
3256 * association descriptor shows there's more than one function.
3258 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3260 if (udev
->speed
< USB_SPEED_SUPER
)
3261 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3262 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3263 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3264 USB_CTRL_SET_TIMEOUT
);
3266 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3267 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3268 USB_INTRF_FUNC_SUSPEND
,
3269 USB_INTRF_FUNC_SUSPEND_RW
|
3270 USB_INTRF_FUNC_SUSPEND_LP
,
3271 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3275 * usb_disable_remote_wakeup - disable remote wakeup for a device
3276 * @udev: target device
3278 * For USB-2 devices: Clear the device's remote wakeup feature.
3280 * For USB-3 devices: Assume there's only one function on the device and
3281 * disable remote wake for the first interface. FIXME if the interface
3282 * association descriptor shows there's more than one function.
3284 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3286 if (udev
->speed
< USB_SPEED_SUPER
)
3287 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3288 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3289 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3290 USB_CTRL_SET_TIMEOUT
);
3292 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3293 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3294 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3295 USB_CTRL_SET_TIMEOUT
);
3298 /* Count of wakeup-enabled devices at or below udev */
3299 unsigned usb_wakeup_enabled_descendants(struct usb_device
*udev
)
3301 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3303 return udev
->do_remote_wakeup
+
3304 (hub
? hub
->wakeup_enabled_descendants
: 0);
3306 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants
);
3309 * usb_port_suspend - suspend a usb device's upstream port
3310 * @udev: device that's no longer in active use, not a root hub
3311 * Context: must be able to sleep; device not locked; pm locks held
3313 * Suspends a USB device that isn't in active use, conserving power.
3314 * Devices may wake out of a suspend, if anything important happens,
3315 * using the remote wakeup mechanism. They may also be taken out of
3316 * suspend by the host, using usb_port_resume(). It's also routine
3317 * to disconnect devices while they are suspended.
3319 * This only affects the USB hardware for a device; its interfaces
3320 * (and, for hubs, child devices) must already have been suspended.
3322 * Selective port suspend reduces power; most suspended devices draw
3323 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3324 * All devices below the suspended port are also suspended.
3326 * Devices leave suspend state when the host wakes them up. Some devices
3327 * also support "remote wakeup", where the device can activate the USB
3328 * tree above them to deliver data, such as a keypress or packet. In
3329 * some cases, this wakes the USB host.
3331 * Suspending OTG devices may trigger HNP, if that's been enabled
3332 * between a pair of dual-role devices. That will change roles, such
3333 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3335 * Devices on USB hub ports have only one "suspend" state, corresponding
3336 * to ACPI D2, "may cause the device to lose some context".
3337 * State transitions include:
3339 * - suspend, resume ... when the VBUS power link stays live
3340 * - suspend, disconnect ... VBUS lost
3342 * Once VBUS drop breaks the circuit, the port it's using has to go through
3343 * normal re-enumeration procedures, starting with enabling VBUS power.
3344 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3345 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3346 * timer, no SRP, no requests through sysfs.
3348 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3349 * suspended until their bus goes into global suspend (i.e., the root
3350 * hub is suspended). Nevertheless, we change @udev->state to
3351 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3352 * upstream port setting is stored in @udev->port_is_suspended.
3354 * Returns 0 on success, else negative errno.
3356 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3358 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3359 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3360 int port1
= udev
->portnum
;
3362 bool really_suspend
= true;
3364 usb_lock_port(port_dev
);
3366 /* enable remote wakeup when appropriate; this lets the device
3367 * wake up the upstream hub (including maybe the root hub).
3369 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3370 * we don't explicitly enable it here.
3372 if (udev
->do_remote_wakeup
) {
3373 status
= usb_enable_remote_wakeup(udev
);
3375 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3377 /* bail if autosuspend is requested */
3378 if (PMSG_IS_AUTO(msg
))
3383 /* disable USB2 hardware LPM */
3384 usb_disable_usb2_hardware_lpm(udev
);
3386 if (usb_disable_ltm(udev
)) {
3387 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n");
3389 if (PMSG_IS_AUTO(msg
))
3394 if (hub_is_superspeed(hub
->hdev
))
3395 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3398 * For system suspend, we do not need to enable the suspend feature
3399 * on individual USB-2 ports. The devices will automatically go
3400 * into suspend a few ms after the root hub stops sending packets.
3401 * The USB 2.0 spec calls this "global suspend".
3403 * However, many USB hubs have a bug: They don't relay wakeup requests
3404 * from a downstream port if the port's suspend feature isn't on.
3405 * Therefore we will turn on the suspend feature if udev or any of its
3406 * descendants is enabled for remote wakeup.
3408 else if (PMSG_IS_AUTO(msg
) || usb_wakeup_enabled_descendants(udev
) > 0)
3409 status
= set_port_feature(hub
->hdev
, port1
,
3410 USB_PORT_FEAT_SUSPEND
);
3412 really_suspend
= false;
3416 /* Check if the port has been suspended for the timeout case
3417 * to prevent the suspended port from incorrect handling.
3419 if (status
== -ETIMEDOUT
) {
3421 u16 portstatus
, portchange
;
3423 portstatus
= portchange
= 0;
3424 ret
= hub_port_status(hub
, port1
, &portstatus
,
3427 dev_dbg(&port_dev
->dev
,
3428 "suspend timeout, status %04x\n", portstatus
);
3430 if (ret
== 0 && port_is_suspended(hub
, portstatus
)) {
3436 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3438 /* Try to enable USB3 LTM again */
3439 usb_enable_ltm(udev
);
3441 /* Try to enable USB2 hardware LPM again */
3442 usb_enable_usb2_hardware_lpm(udev
);
3444 if (udev
->do_remote_wakeup
)
3445 (void) usb_disable_remote_wakeup(udev
);
3448 /* System sleep transitions should never fail */
3449 if (!PMSG_IS_AUTO(msg
))
3453 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3454 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3455 udev
->do_remote_wakeup
);
3456 if (really_suspend
) {
3457 udev
->port_is_suspended
= 1;
3459 /* device has up to 10 msec to fully suspend */
3462 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3465 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3466 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3467 pm_runtime_put_sync(&port_dev
->dev
);
3469 usb_mark_last_busy(hub
->hdev
);
3471 usb_unlock_port(port_dev
);
3476 * If the USB "suspend" state is in use (rather than "global suspend"),
3477 * many devices will be individually taken out of suspend state using
3478 * special "resume" signaling. This routine kicks in shortly after
3479 * hardware resume signaling is finished, either because of selective
3480 * resume (by host) or remote wakeup (by device) ... now see what changed
3481 * in the tree that's rooted at this device.
3483 * If @udev->reset_resume is set then the device is reset before the
3484 * status check is done.
3486 static int finish_port_resume(struct usb_device
*udev
)
3491 /* caller owns the udev device lock */
3492 dev_dbg(&udev
->dev
, "%s\n",
3493 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3495 /* usb ch9 identifies four variants of SUSPENDED, based on what
3496 * state the device resumes to. Linux currently won't see the
3497 * first two on the host side; they'd be inside hub_port_init()
3498 * during many timeouts, but hub_wq can't suspend until later.
3500 usb_set_device_state(udev
, udev
->actconfig
3501 ? USB_STATE_CONFIGURED
3502 : USB_STATE_ADDRESS
);
3504 /* 10.5.4.5 says not to reset a suspended port if the attached
3505 * device is enabled for remote wakeup. Hence the reset
3506 * operation is carried out here, after the port has been
3509 if (udev
->reset_resume
) {
3511 * If the device morphs or switches modes when it is reset,
3512 * we don't want to perform a reset-resume. We'll fail the
3513 * resume, which will cause a logical disconnect, and then
3514 * the device will be rediscovered.
3517 if (udev
->quirks
& USB_QUIRK_RESET
)
3520 status
= usb_reset_and_verify_device(udev
);
3523 /* 10.5.4.5 says be sure devices in the tree are still there.
3524 * For now let's assume the device didn't go crazy on resume,
3525 * and device drivers will know about any resume quirks.
3529 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3531 /* If a normal resume failed, try doing a reset-resume */
3532 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3533 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3534 udev
->reset_resume
= 1;
3535 goto retry_reset_resume
;
3540 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3543 * There are a few quirky devices which violate the standard
3544 * by claiming to have remote wakeup enabled after a reset,
3545 * which crash if the feature is cleared, hence check for
3546 * udev->reset_resume
3548 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3549 if (udev
->speed
< USB_SPEED_SUPER
) {
3550 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3551 status
= usb_disable_remote_wakeup(udev
);
3553 status
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
, 0,
3555 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3556 | USB_INTRF_STAT_FUNC_RW
))
3557 status
= usb_disable_remote_wakeup(udev
);
3562 "disable remote wakeup, status %d\n",
3570 * There are some SS USB devices which take longer time for link training.
3571 * XHCI specs 4.19.4 says that when Link training is successful, port
3572 * sets CCS bit to 1. So if SW reads port status before successful link
3573 * training, then it will not find device to be present.
3574 * USB Analyzer log with such buggy devices show that in some cases
3575 * device switch on the RX termination after long delay of host enabling
3576 * the VBUS. In few other cases it has been seen that device fails to
3577 * negotiate link training in first attempt. It has been
3578 * reported till now that few devices take as long as 2000 ms to train
3579 * the link after host enabling its VBUS and termination. Following
3580 * routine implements a 2000 ms timeout for link training. If in a case
3581 * link trains before timeout, loop will exit earlier.
3583 * There are also some 2.0 hard drive based devices and 3.0 thumb
3584 * drives that, when plugged into a 2.0 only port, take a long
3585 * time to set CCS after VBUS enable.
3587 * FIXME: If a device was connected before suspend, but was removed
3588 * while system was asleep, then the loop in the following routine will
3589 * only exit at timeout.
3591 * This routine should only be called when persist is enabled.
3593 static int wait_for_connected(struct usb_device
*udev
,
3594 struct usb_hub
*hub
, int *port1
,
3595 u16
*portchange
, u16
*portstatus
)
3597 int status
= 0, delay_ms
= 0;
3599 while (delay_ms
< 2000) {
3600 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3602 if (!port_is_power_on(hub
, *portstatus
)) {
3608 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3610 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3615 * usb_port_resume - re-activate a suspended usb device's upstream port
3616 * @udev: device to re-activate, not a root hub
3617 * Context: must be able to sleep; device not locked; pm locks held
3619 * This will re-activate the suspended device, increasing power usage
3620 * while letting drivers communicate again with its endpoints.
3621 * USB resume explicitly guarantees that the power session between
3622 * the host and the device is the same as it was when the device
3625 * If @udev->reset_resume is set then this routine won't check that the
3626 * port is still enabled. Furthermore, finish_port_resume() above will
3627 * reset @udev. The end result is that a broken power session can be
3628 * recovered and @udev will appear to persist across a loss of VBUS power.
3630 * For example, if a host controller doesn't maintain VBUS suspend current
3631 * during a system sleep or is reset when the system wakes up, all the USB
3632 * power sessions below it will be broken. This is especially troublesome
3633 * for mass-storage devices containing mounted filesystems, since the
3634 * device will appear to have disconnected and all the memory mappings
3635 * to it will be lost. Using the USB_PERSIST facility, the device can be
3636 * made to appear as if it had not disconnected.
3638 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3639 * every effort to insure that the same device is present after the
3640 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3641 * quite possible for a device to remain unaltered but its media to be
3642 * changed. If the user replaces a flash memory card while the system is
3643 * asleep, he will have only himself to blame when the filesystem on the
3644 * new card is corrupted and the system crashes.
3646 * Returns 0 on success, else negative errno.
3648 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3650 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3651 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3652 int port1
= udev
->portnum
;
3654 u16 portchange
, portstatus
;
3656 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3657 status
= pm_runtime_resume_and_get(&port_dev
->dev
);
3659 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3665 usb_lock_port(port_dev
);
3667 /* Skip the initial Clear-Suspend step for a remote wakeup */
3668 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3669 if (status
== 0 && !port_is_suspended(hub
, portstatus
)) {
3670 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3671 pm_wakeup_event(&udev
->dev
, 0);
3672 goto SuspendCleared
;
3675 /* see 7.1.7.7; affects power usage, but not budgeting */
3676 if (hub_is_superspeed(hub
->hdev
))
3677 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3679 status
= usb_clear_port_feature(hub
->hdev
,
3680 port1
, USB_PORT_FEAT_SUSPEND
);
3682 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3684 /* drive resume for USB_RESUME_TIMEOUT msec */
3685 dev_dbg(&udev
->dev
, "usb %sresume\n",
3686 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3687 msleep(USB_RESUME_TIMEOUT
);
3689 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3690 * stop resume signaling. Then finish the resume
3693 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3698 udev
->port_is_suspended
= 0;
3699 if (hub_is_superspeed(hub
->hdev
)) {
3700 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3701 usb_clear_port_feature(hub
->hdev
, port1
,
3702 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3704 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3705 usb_clear_port_feature(hub
->hdev
, port1
,
3706 USB_PORT_FEAT_C_SUSPEND
);
3709 /* TRSMRCY = 10 msec */
3713 if (udev
->persist_enabled
)
3714 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3717 status
= check_port_resume_type(udev
,
3718 hub
, port1
, status
, portchange
, portstatus
);
3720 status
= finish_port_resume(udev
);
3722 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3723 hub_port_logical_disconnect(hub
, port1
);
3725 /* Try to enable USB2 hardware LPM */
3726 usb_enable_usb2_hardware_lpm(udev
);
3728 /* Try to enable USB3 LTM */
3729 usb_enable_ltm(udev
);
3732 usb_unlock_port(port_dev
);
3737 int usb_remote_wakeup(struct usb_device
*udev
)
3741 usb_lock_device(udev
);
3742 if (udev
->state
== USB_STATE_SUSPENDED
) {
3743 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3744 status
= usb_autoresume_device(udev
);
3746 /* Let the drivers do their thing, then... */
3747 usb_autosuspend_device(udev
);
3750 usb_unlock_device(udev
);
3754 /* Returns 1 if there was a remote wakeup and a connect status change. */
3755 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3756 u16 portstatus
, u16 portchange
)
3757 __must_hold(&port_dev
->status_lock
)
3759 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3760 struct usb_device
*hdev
;
3761 struct usb_device
*udev
;
3762 int connect_change
= 0;
3767 udev
= port_dev
->child
;
3768 if (!hub_is_superspeed(hdev
)) {
3769 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3771 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3773 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
3774 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3775 (link_state
!= USB_SS_PORT_LS_U0
&&
3776 link_state
!= USB_SS_PORT_LS_U1
&&
3777 link_state
!= USB_SS_PORT_LS_U2
))
3782 /* TRSMRCY = 10 msec */
3785 usb_unlock_port(port_dev
);
3786 ret
= usb_remote_wakeup(udev
);
3787 usb_lock_port(port_dev
);
3792 hub_port_disable(hub
, port
, 1);
3794 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3795 return connect_change
;
3798 static int check_ports_changed(struct usb_hub
*hub
)
3802 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3803 u16 portstatus
, portchange
;
3806 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3807 if (!status
&& portchange
)
3813 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3815 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3816 struct usb_device
*hdev
= hub
->hdev
;
3820 * Warn if children aren't already suspended.
3821 * Also, add up the number of wakeup-enabled descendants.
3823 hub
->wakeup_enabled_descendants
= 0;
3824 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3825 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3826 struct usb_device
*udev
= port_dev
->child
;
3828 if (udev
&& udev
->can_submit
) {
3829 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3830 dev_name(&udev
->dev
));
3831 if (PMSG_IS_AUTO(msg
))
3835 hub
->wakeup_enabled_descendants
+=
3836 usb_wakeup_enabled_descendants(udev
);
3839 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3840 /* check if there are changes pending on hub ports */
3841 if (check_ports_changed(hub
)) {
3842 if (PMSG_IS_AUTO(msg
))
3844 pm_wakeup_event(&hdev
->dev
, 2000);
3848 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3849 /* Enable hub to send remote wakeup for all ports. */
3850 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3851 set_port_feature(hdev
,
3853 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3854 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3855 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3856 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3860 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3862 /* stop hub_wq and related activity */
3863 hub_quiesce(hub
, HUB_SUSPEND
);
3867 /* Report wakeup requests from the ports of a resuming root hub */
3868 static void report_wakeup_requests(struct usb_hub
*hub
)
3870 struct usb_device
*hdev
= hub
->hdev
;
3871 struct usb_device
*udev
;
3872 struct usb_hcd
*hcd
;
3873 unsigned long resuming_ports
;
3877 return; /* Not a root hub */
3879 hcd
= bus_to_hcd(hdev
->bus
);
3880 if (hcd
->driver
->get_resuming_ports
) {
3883 * The get_resuming_ports() method returns a bitmap (origin 0)
3884 * of ports which have started wakeup signaling but have not
3885 * yet finished resuming. During system resume we will
3886 * resume all the enabled ports, regardless of any wakeup
3887 * signals, which means the wakeup requests would be lost.
3888 * To prevent this, report them to the PM core here.
3890 resuming_ports
= hcd
->driver
->get_resuming_ports(hcd
);
3891 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
3892 if (test_bit(i
, &resuming_ports
)) {
3893 udev
= hub
->ports
[i
]->child
;
3895 pm_wakeup_event(&udev
->dev
, 0);
3901 static int hub_resume(struct usb_interface
*intf
)
3903 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3905 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3906 hub_activate(hub
, HUB_RESUME
);
3909 * This should be called only for system resume, not runtime resume.
3910 * We can't tell the difference here, so some wakeup requests will be
3911 * reported at the wrong time or more than once. This shouldn't
3912 * matter much, so long as they do get reported.
3914 report_wakeup_requests(hub
);
3918 static int hub_reset_resume(struct usb_interface
*intf
)
3920 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3922 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3923 hub_activate(hub
, HUB_RESET_RESUME
);
3928 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3929 * @rhdev: struct usb_device for the root hub
3931 * The USB host controller driver calls this function when its root hub
3932 * is resumed and Vbus power has been interrupted or the controller
3933 * has been reset. The routine marks @rhdev as having lost power.
3934 * When the hub driver is resumed it will take notice and carry out
3935 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3936 * the others will be disconnected.
3938 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3940 dev_notice(&rhdev
->dev
, "root hub lost power or was reset\n");
3941 rhdev
->reset_resume
= 1;
3943 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3945 static const char * const usb3_lpm_names
[] = {
3953 * Send a Set SEL control transfer to the device, prior to enabling
3954 * device-initiated U1 or U2. This lets the device know the exit latencies from
3955 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3956 * packet from the host.
3958 * This function will fail if the SEL or PEL values for udev are greater than
3959 * the maximum allowed values for the link state to be enabled.
3961 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3963 struct usb_set_sel_req
*sel_values
;
3964 unsigned long long u1_sel
;
3965 unsigned long long u1_pel
;
3966 unsigned long long u2_sel
;
3967 unsigned long long u2_pel
;
3970 if (udev
->state
!= USB_STATE_CONFIGURED
)
3973 /* Convert SEL and PEL stored in ns to us */
3974 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3975 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3976 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3977 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3980 * Make sure that the calculated SEL and PEL values for the link
3981 * state we're enabling aren't bigger than the max SEL/PEL
3982 * value that will fit in the SET SEL control transfer.
3983 * Otherwise the device would get an incorrect idea of the exit
3984 * latency for the link state, and could start a device-initiated
3985 * U1/U2 when the exit latencies are too high.
3987 if ((state
== USB3_LPM_U1
&&
3988 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3989 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3990 (state
== USB3_LPM_U2
&&
3991 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3992 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3993 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3994 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3999 * If we're enabling device-initiated LPM for one link state,
4000 * but the other link state has a too high SEL or PEL value,
4001 * just set those values to the max in the Set SEL request.
4003 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
4004 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
4006 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
4007 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
4009 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
4010 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
4012 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
4013 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
4016 * usb_enable_lpm() can be called as part of a failed device reset,
4017 * which may be initiated by an error path of a mass storage driver.
4018 * Therefore, use GFP_NOIO.
4020 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
4024 sel_values
->u1_sel
= u1_sel
;
4025 sel_values
->u1_pel
= u1_pel
;
4026 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
4027 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
4029 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4033 sel_values
, sizeof *(sel_values
),
4034 USB_CTRL_SET_TIMEOUT
);
4040 * Enable or disable device-initiated U1 or U2 transitions.
4042 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
4043 enum usb3_link_state state
, bool enable
)
4050 feature
= USB_DEVICE_U1_ENABLE
;
4053 feature
= USB_DEVICE_U2_ENABLE
;
4056 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
4057 __func__
, enable
? "enable" : "disable");
4061 if (udev
->state
!= USB_STATE_CONFIGURED
) {
4062 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
4063 "for unconfigured device.\n",
4064 __func__
, enable
? "enable" : "disable",
4065 usb3_lpm_names
[state
]);
4071 * Now send the control transfer to enable device-initiated LPM
4072 * for either U1 or U2.
4074 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4075 USB_REQ_SET_FEATURE
,
4079 USB_CTRL_SET_TIMEOUT
);
4081 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4082 USB_REQ_CLEAR_FEATURE
,
4086 USB_CTRL_SET_TIMEOUT
);
4089 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
4090 enable
? "Enable" : "Disable",
4091 usb3_lpm_names
[state
]);
4097 static int usb_set_lpm_timeout(struct usb_device
*udev
,
4098 enum usb3_link_state state
, int timeout
)
4105 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
4108 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
4111 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
4116 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
4117 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
4118 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
4119 "which is a reserved value.\n",
4120 usb3_lpm_names
[state
], timeout
);
4124 ret
= set_port_feature(udev
->parent
,
4125 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
4128 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
4129 "error code %i\n", usb3_lpm_names
[state
],
4133 if (state
== USB3_LPM_U1
)
4134 udev
->u1_params
.timeout
= timeout
;
4136 udev
->u2_params
.timeout
= timeout
;
4141 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4142 * interval is greater than the minimum service interval of any active
4143 * periodic endpoint. See USB 3.2 section 9.4.9
4145 static bool usb_device_may_initiate_lpm(struct usb_device
*udev
,
4146 enum usb3_link_state state
)
4148 unsigned int sel
; /* us */
4151 if (state
== USB3_LPM_U1
)
4152 sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
4153 else if (state
== USB3_LPM_U2
)
4154 sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
4158 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
4159 struct usb_interface
*intf
;
4160 struct usb_endpoint_descriptor
*desc
;
4161 unsigned int interval
;
4163 intf
= udev
->actconfig
->interface
[i
];
4167 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++) {
4168 desc
= &intf
->cur_altsetting
->endpoint
[j
].desc
;
4170 if (usb_endpoint_xfer_int(desc
) ||
4171 usb_endpoint_xfer_isoc(desc
)) {
4172 interval
= (1 << (desc
->bInterval
- 1)) * 125;
4173 if (sel
+ 125 > interval
)
4182 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4185 * We will attempt to enable U1 or U2, but there are no guarantees that the
4186 * control transfers to set the hub timeout or enable device-initiated U1/U2
4187 * will be successful.
4189 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4190 * hub-initiated U1/U2 will be disabled.
4192 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4193 * driver know about it. If that call fails, it should be harmless, and just
4194 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4196 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4197 enum usb3_link_state state
)
4200 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
4201 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
4203 /* If the device says it doesn't have *any* exit latency to come out of
4204 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4207 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
4208 (state
== USB3_LPM_U2
&& u2_mel
== 0))
4212 * First, let the device know about the exit latencies
4213 * associated with the link state we're about to enable.
4215 ret
= usb_req_set_sel(udev
, state
);
4217 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
4218 usb3_lpm_names
[state
]);
4222 /* We allow the host controller to set the U1/U2 timeout internally
4223 * first, so that it can change its schedule to account for the
4224 * additional latency to send data to a device in a lower power
4227 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
4229 /* xHCI host controller doesn't want to enable this LPM state. */
4234 dev_warn(&udev
->dev
, "Could not enable %s link state, "
4235 "xHCI error %i.\n", usb3_lpm_names
[state
],
4240 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
4241 /* If we can't set the parent hub U1/U2 timeout,
4242 * device-initiated LPM won't be allowed either, so let the xHCI
4243 * host know that this link state won't be enabled.
4245 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4249 /* Only a configured device will accept the Set Feature
4252 if (udev
->actconfig
&&
4253 usb_device_may_initiate_lpm(udev
, state
)) {
4254 if (usb_set_device_initiated_lpm(udev
, state
, true)) {
4256 * Request to enable device initiated U1/U2 failed,
4257 * better to turn off lpm in this case.
4259 usb_set_lpm_timeout(udev
, state
, 0);
4260 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4265 if (state
== USB3_LPM_U1
)
4266 udev
->usb3_lpm_u1_enabled
= 1;
4267 else if (state
== USB3_LPM_U2
)
4268 udev
->usb3_lpm_u2_enabled
= 1;
4271 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4274 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4275 * If zero is returned, the parent will not allow the link to go into U1/U2.
4277 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4278 * it won't have an effect on the bus link state because the parent hub will
4279 * still disallow device-initiated U1/U2 entry.
4281 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4282 * possible. The result will be slightly more bus bandwidth will be taken up
4283 * (to account for U1/U2 exit latency), but it should be harmless.
4285 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4286 enum usb3_link_state state
)
4293 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4298 if (usb_set_lpm_timeout(udev
, state
, 0))
4301 usb_set_device_initiated_lpm(udev
, state
, false);
4303 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4304 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4305 "bus schedule bandwidth may be impacted.\n",
4306 usb3_lpm_names
[state
]);
4308 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4309 * is disabled. Hub will disallows link to enter U1/U2 as well,
4310 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4311 * timeout set to 0, no matter device-initiated LPM is disabled or
4314 if (state
== USB3_LPM_U1
)
4315 udev
->usb3_lpm_u1_enabled
= 0;
4316 else if (state
== USB3_LPM_U2
)
4317 udev
->usb3_lpm_u2_enabled
= 0;
4323 * Disable hub-initiated and device-initiated U1 and U2 entry.
4324 * Caller must own the bandwidth_mutex.
4326 * This will call usb_enable_lpm() on failure, which will decrement
4327 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4329 int usb_disable_lpm(struct usb_device
*udev
)
4331 struct usb_hcd
*hcd
;
4333 if (!udev
|| !udev
->parent
||
4334 udev
->speed
< USB_SPEED_SUPER
||
4335 !udev
->lpm_capable
||
4336 udev
->state
< USB_STATE_CONFIGURED
)
4339 hcd
= bus_to_hcd(udev
->bus
);
4340 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4343 udev
->lpm_disable_count
++;
4344 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4347 /* If LPM is enabled, attempt to disable it. */
4348 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4350 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4356 usb_enable_lpm(udev
);
4359 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4361 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4362 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4364 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4370 mutex_lock(hcd
->bandwidth_mutex
);
4371 ret
= usb_disable_lpm(udev
);
4372 mutex_unlock(hcd
->bandwidth_mutex
);
4376 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4379 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4380 * xHCI host policy may prevent U1 or U2 from being enabled.
4382 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4383 * until the lpm_disable_count drops to zero. Caller must own the
4386 void usb_enable_lpm(struct usb_device
*udev
)
4388 struct usb_hcd
*hcd
;
4389 struct usb_hub
*hub
;
4390 struct usb_port
*port_dev
;
4392 if (!udev
|| !udev
->parent
||
4393 udev
->speed
< USB_SPEED_SUPER
||
4394 !udev
->lpm_capable
||
4395 udev
->state
< USB_STATE_CONFIGURED
)
4398 udev
->lpm_disable_count
--;
4399 hcd
= bus_to_hcd(udev
->bus
);
4400 /* Double check that we can both enable and disable LPM.
4401 * Device must be configured to accept set feature U1/U2 timeout.
4403 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4404 !hcd
->driver
->disable_usb3_lpm_timeout
)
4407 if (udev
->lpm_disable_count
> 0)
4410 hub
= usb_hub_to_struct_hub(udev
->parent
);
4414 port_dev
= hub
->ports
[udev
->portnum
- 1];
4416 if (port_dev
->usb3_lpm_u1_permit
)
4417 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4419 if (port_dev
->usb3_lpm_u2_permit
)
4420 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4422 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4424 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4425 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4427 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4432 mutex_lock(hcd
->bandwidth_mutex
);
4433 usb_enable_lpm(udev
);
4434 mutex_unlock(hcd
->bandwidth_mutex
);
4436 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4438 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4439 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4440 struct usb_port
*port_dev
)
4442 struct usb_device
*udev
= port_dev
->child
;
4445 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4446 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4449 msleep(USB_RESUME_TIMEOUT
);
4450 ret
= usb_disable_remote_wakeup(udev
);
4453 dev_warn(&udev
->dev
,
4454 "Port disable: can't disable remote wake\n");
4455 udev
->do_remote_wakeup
= 0;
4459 #else /* CONFIG_PM */
4461 #define hub_suspend NULL
4462 #define hub_resume NULL
4463 #define hub_reset_resume NULL
4465 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4466 struct usb_port
*port_dev
) { }
4468 int usb_disable_lpm(struct usb_device
*udev
)
4472 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4474 void usb_enable_lpm(struct usb_device
*udev
) { }
4475 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4477 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4481 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4483 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4484 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4486 int usb_disable_ltm(struct usb_device
*udev
)
4490 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4492 void usb_enable_ltm(struct usb_device
*udev
) { }
4493 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4495 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4496 u16 portstatus
, u16 portchange
)
4501 #endif /* CONFIG_PM */
4504 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4505 * a connection with a plugged-in cable but will signal the host when the cable
4506 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4508 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4510 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4511 struct usb_device
*hdev
= hub
->hdev
;
4515 if (hub_is_superspeed(hub
->hdev
)) {
4516 hub_usb3_port_prepare_disable(hub
, port_dev
);
4517 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4520 ret
= usb_clear_port_feature(hdev
, port1
,
4521 USB_PORT_FEAT_ENABLE
);
4524 if (port_dev
->child
&& set_state
)
4525 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4526 if (ret
&& ret
!= -ENODEV
)
4527 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4532 * usb_port_disable - disable a usb device's upstream port
4533 * @udev: device to disable
4534 * Context: @udev locked, must be able to sleep.
4536 * Disables a USB device that isn't in active use.
4538 int usb_port_disable(struct usb_device
*udev
)
4540 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4542 return hub_port_disable(hub
, udev
->portnum
, 0);
4545 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4547 * Between connect detection and reset signaling there must be a delay
4548 * of 100ms at least for debounce and power-settling. The corresponding
4549 * timer shall restart whenever the downstream port detects a disconnect.
4551 * Apparently there are some bluetooth and irda-dongles and a number of
4552 * low-speed devices for which this debounce period may last over a second.
4553 * Not covered by the spec - but easy to deal with.
4555 * This implementation uses a 1500ms total debounce timeout; if the
4556 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4557 * every 25ms for transient disconnects. When the port status has been
4558 * unchanged for 100ms it returns the port status.
4560 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4563 u16 portchange
, portstatus
;
4564 unsigned connection
= 0xffff;
4565 int total_time
, stable_time
= 0;
4566 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4568 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4569 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4573 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4574 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4575 if (!must_be_connected
||
4576 (connection
== USB_PORT_STAT_CONNECTION
))
4577 stable_time
+= HUB_DEBOUNCE_STEP
;
4578 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4582 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4585 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4586 usb_clear_port_feature(hub
->hdev
, port1
,
4587 USB_PORT_FEAT_C_CONNECTION
);
4590 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4592 msleep(HUB_DEBOUNCE_STEP
);
4595 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4596 total_time
, stable_time
, portstatus
);
4598 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4603 void usb_ep0_reinit(struct usb_device
*udev
)
4605 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4606 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4607 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4609 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4611 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4612 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4614 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4617 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4620 * The host controller will choose the device address,
4621 * instead of the core having chosen it earlier
4623 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4625 if (udev
->state
== USB_STATE_ADDRESS
)
4627 if (udev
->state
!= USB_STATE_DEFAULT
)
4629 if (hcd
->driver
->address_device
)
4630 retval
= hcd
->driver
->address_device(hcd
, udev
);
4632 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4633 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4634 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4636 update_devnum(udev
, devnum
);
4637 /* Device now using proper address. */
4638 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4639 usb_ep0_reinit(udev
);
4645 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4646 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4649 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4650 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4651 * support bit in the BOS descriptor.
4653 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4655 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4656 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4658 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4662 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4664 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4665 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4666 udev
->usb2_hw_lpm_allowed
= 1;
4667 usb_enable_usb2_hardware_lpm(udev
);
4671 static int hub_enable_device(struct usb_device
*udev
)
4673 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4675 if (!hcd
->driver
->enable_device
)
4677 if (udev
->state
== USB_STATE_ADDRESS
)
4679 if (udev
->state
!= USB_STATE_DEFAULT
)
4682 return hcd
->driver
->enable_device(hcd
, udev
);
4685 /* Reset device, (re)assign address, get device descriptor.
4686 * Device connection must be stable, no more debouncing needed.
4687 * Returns device in USB_STATE_ADDRESS, except on error.
4689 * If this is called for an already-existing device (as part of
4690 * usb_reset_and_verify_device), the caller must own the device lock and
4691 * the port lock. For a newly detected device that is not accessible
4692 * through any global pointers, it's not necessary to lock the device,
4693 * but it is still necessary to lock the port.
4696 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4699 struct usb_device
*hdev
= hub
->hdev
;
4700 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4701 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4702 int retries
, operations
, retval
, i
;
4703 unsigned delay
= HUB_SHORT_RESET_TIME
;
4704 enum usb_device_speed oldspeed
= udev
->speed
;
4706 int devnum
= udev
->devnum
;
4707 const char *driver_name
;
4710 /* root hub ports have a slightly longer reset period
4711 * (from USB 2.0 spec, section 7.1.7.5)
4713 if (!hdev
->parent
) {
4714 delay
= HUB_ROOT_RESET_TIME
;
4715 if (port1
== hdev
->bus
->otg_port
)
4716 hdev
->bus
->b_hnp_enable
= 0;
4719 /* Some low speed devices have problems with the quick delay, so */
4720 /* be a bit pessimistic with those devices. RHbug #23670 */
4721 if (oldspeed
== USB_SPEED_LOW
)
4722 delay
= HUB_LONG_RESET_TIME
;
4724 mutex_lock(hcd
->address0_mutex
);
4726 /* Reset the device; full speed may morph to high speed */
4727 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4728 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4729 if (retval
< 0) /* error or disconnect */
4731 /* success, speed is known */
4735 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4736 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4737 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4738 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4741 oldspeed
= udev
->speed
;
4743 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4744 * it's fixed size except for full speed devices.
4745 * For Wireless USB devices, ep0 max packet is always 512 (tho
4746 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4748 switch (udev
->speed
) {
4749 case USB_SPEED_SUPER_PLUS
:
4750 case USB_SPEED_SUPER
:
4751 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4752 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4754 case USB_SPEED_HIGH
: /* fixed at 64 */
4755 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4757 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4758 /* to determine the ep0 maxpacket size, try to read
4759 * the device descriptor to get bMaxPacketSize0 and
4760 * then correct our initial guess.
4762 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4764 case USB_SPEED_LOW
: /* fixed at 8 */
4765 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4771 if (udev
->speed
== USB_SPEED_WIRELESS
)
4772 speed
= "variable speed Wireless";
4774 speed
= usb_speed_string(udev
->speed
);
4777 * The controller driver may be NULL if the controller device
4778 * is the middle device between platform device and roothub.
4779 * This middle device may not need a device driver due to
4780 * all hardware control can be at platform device driver, this
4781 * platform device is usually a dual-role USB controller device.
4783 if (udev
->bus
->controller
->driver
)
4784 driver_name
= udev
->bus
->controller
->driver
->name
;
4786 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4788 if (udev
->speed
< USB_SPEED_SUPER
)
4789 dev_info(&udev
->dev
,
4790 "%s %s USB device number %d using %s\n",
4791 (udev
->config
) ? "reset" : "new", speed
,
4792 devnum
, driver_name
);
4794 /* Set up TT records, if needed */
4796 udev
->tt
= hdev
->tt
;
4797 udev
->ttport
= hdev
->ttport
;
4798 } else if (udev
->speed
!= USB_SPEED_HIGH
4799 && hdev
->speed
== USB_SPEED_HIGH
) {
4801 dev_err(&udev
->dev
, "parent hub has no TT\n");
4805 udev
->tt
= &hub
->tt
;
4806 udev
->ttport
= port1
;
4809 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4810 * Because device hardware and firmware is sometimes buggy in
4811 * this area, and this is how Linux has done it for ages.
4812 * Change it cautiously.
4814 * NOTE: If use_new_scheme() is true we will start by issuing
4815 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4816 * so it may help with some non-standards-compliant devices.
4817 * Otherwise we start with SET_ADDRESS and then try to read the
4818 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4821 do_new_scheme
= use_new_scheme(udev
, retry_counter
, port_dev
);
4823 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4824 if (do_new_scheme
) {
4825 struct usb_device_descriptor
*buf
;
4828 retval
= hub_enable_device(udev
);
4831 "hub failed to enable device, error %d\n",
4836 #define GET_DESCRIPTOR_BUFSIZE 64
4837 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4843 /* Retry on all errors; some devices are flakey.
4844 * 255 is for WUSB devices, we actually need to use
4845 * 512 (WUSB1.0[4.8.1]).
4847 for (operations
= 0; operations
< GET_MAXPACKET0_TRIES
;
4849 buf
->bMaxPacketSize0
= 0;
4850 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4851 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4852 USB_DT_DEVICE
<< 8, 0,
4853 buf
, GET_DESCRIPTOR_BUFSIZE
,
4854 initial_descriptor_timeout
);
4855 switch (buf
->bMaxPacketSize0
) {
4856 case 8: case 16: case 32: case 64: case 255:
4857 if (buf
->bDescriptorType
==
4869 * Some devices time out if they are powered on
4870 * when already connected. They need a second
4871 * reset. But only on the first attempt,
4872 * lest we get into a time out/reset loop
4874 if (r
== 0 || (r
== -ETIMEDOUT
&&
4876 udev
->speed
> USB_SPEED_FULL
))
4879 udev
->descriptor
.bMaxPacketSize0
=
4880 buf
->bMaxPacketSize0
;
4883 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4884 if (retval
< 0) /* error or disconnect */
4886 if (oldspeed
!= udev
->speed
) {
4888 "device reset changed speed!\n");
4894 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4899 #undef GET_DESCRIPTOR_BUFSIZE
4903 * If device is WUSB, we already assigned an
4904 * unauthorized address in the Connect Ack sequence;
4905 * authorization will assign the final address.
4907 if (udev
->wusb
== 0) {
4908 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4909 retval
= hub_set_address(udev
, devnum
);
4915 if (retval
!= -ENODEV
)
4916 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4920 if (udev
->speed
>= USB_SPEED_SUPER
) {
4921 devnum
= udev
->devnum
;
4922 dev_info(&udev
->dev
,
4923 "%s SuperSpeed%s%s USB device number %d using %s\n",
4924 (udev
->config
) ? "reset" : "new",
4925 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ?
4927 (udev
->ssp_rate
== USB_SSP_GEN_2x2
) ?
4929 (udev
->ssp_rate
== USB_SSP_GEN_2x1
) ?
4931 (udev
->ssp_rate
== USB_SSP_GEN_1x2
) ?
4933 devnum
, driver_name
);
4936 /* cope with hardware quirkiness:
4937 * - let SET_ADDRESS settle, some device hardware wants it
4938 * - read ep0 maxpacket even for high and low speed,
4945 retval
= usb_get_device_descriptor(udev
, 8);
4947 if (retval
!= -ENODEV
)
4949 "device descriptor read/8, error %d\n",
4958 delay
= udev
->parent
->hub_delay
;
4959 udev
->hub_delay
= min_t(u32
, delay
,
4960 USB_TP_TRANSMISSION_DELAY_MAX
);
4961 retval
= usb_set_isoch_delay(udev
);
4964 "Failed set isoch delay, error %d\n",
4975 * Some superspeed devices have finished the link training process
4976 * and attached to a superspeed hub port, but the device descriptor
4977 * got from those devices show they aren't superspeed devices. Warm
4978 * reset the port attached by the devices can fix them.
4980 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4981 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4982 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4983 "warm reset device\n");
4984 hub_port_reset(hub
, port1
, udev
,
4985 HUB_BH_RESET_TIME
, true);
4990 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4991 udev
->speed
>= USB_SPEED_SUPER
)
4994 i
= udev
->descriptor
.bMaxPacketSize0
;
4995 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4996 if (udev
->speed
== USB_SPEED_LOW
||
4997 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4998 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
5002 if (udev
->speed
== USB_SPEED_FULL
)
5003 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
5005 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
5006 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
5007 usb_ep0_reinit(udev
);
5010 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
5011 if (retval
< (signed)sizeof(udev
->descriptor
)) {
5012 if (retval
!= -ENODEV
)
5013 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
5020 usb_detect_quirks(udev
);
5022 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
5023 retval
= usb_get_bos_descriptor(udev
);
5025 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
5026 usb_set_lpm_parameters(udev
);
5031 /* notify HCD that we have a device connected and addressed */
5032 if (hcd
->driver
->update_device
)
5033 hcd
->driver
->update_device(hcd
, udev
);
5034 hub_set_initial_usb2_lpm_policy(udev
);
5037 hub_port_disable(hub
, port1
, 0);
5038 update_devnum(udev
, devnum
); /* for disconnect processing */
5040 mutex_unlock(hcd
->address0_mutex
);
5045 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
5047 struct usb_qualifier_descriptor
*qual
;
5050 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
5053 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
5057 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
5058 qual
, sizeof *qual
);
5059 if (status
== sizeof *qual
) {
5060 dev_info(&udev
->dev
, "not running at top speed; "
5061 "connect to a high speed hub\n");
5062 /* hub LEDs are probably harder to miss than syslog */
5063 if (hub
->has_indicators
) {
5064 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
5065 queue_delayed_work(system_power_efficient_wq
,
5073 hub_power_remaining(struct usb_hub
*hub
)
5075 struct usb_device
*hdev
= hub
->hdev
;
5079 if (!hub
->limited_power
)
5082 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
5083 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
5084 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5085 struct usb_device
*udev
= port_dev
->child
;
5091 if (hub_is_superspeed(udev
))
5097 * Unconfigured devices may not use more than one unit load,
5098 * or 8mA for OTG ports
5100 if (udev
->actconfig
)
5101 delta
= usb_get_max_power(udev
, udev
->actconfig
);
5102 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
5106 if (delta
> hub
->mA_per_port
)
5107 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
5108 delta
, hub
->mA_per_port
);
5111 if (remaining
< 0) {
5112 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
5120 static int descriptors_changed(struct usb_device
*udev
,
5121 struct usb_device_descriptor
*old_device_descriptor
,
5122 struct usb_host_bos
*old_bos
)
5126 unsigned serial_len
= 0;
5128 unsigned old_length
;
5132 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5133 sizeof(*old_device_descriptor
)) != 0)
5136 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5139 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5140 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5142 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5146 /* Since the idVendor, idProduct, and bcdDevice values in the
5147 * device descriptor haven't changed, we will assume the
5148 * Manufacturer and Product strings haven't changed either.
5149 * But the SerialNumber string could be different (e.g., a
5150 * different flash card of the same brand).
5153 serial_len
= strlen(udev
->serial
) + 1;
5156 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5157 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5158 len
= max(len
, old_length
);
5161 buf
= kmalloc(len
, GFP_NOIO
);
5163 /* assume the worst */
5166 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5167 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5168 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5170 if (length
!= old_length
) {
5171 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5176 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5178 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5180 ((struct usb_config_descriptor
*) buf
)->
5181 bConfigurationValue
);
5187 if (!changed
&& serial_len
) {
5188 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5190 if (length
+ 1 != serial_len
) {
5191 dev_dbg(&udev
->dev
, "serial string error %d\n",
5194 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5195 dev_dbg(&udev
->dev
, "serial string changed\n");
5204 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
5207 int status
= -ENODEV
;
5210 struct usb_device
*hdev
= hub
->hdev
;
5211 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
5212 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5213 struct usb_device
*udev
= port_dev
->child
;
5214 static int unreliable_port
= -1;
5216 /* Disconnect any existing devices under this port */
5218 if (hcd
->usb_phy
&& !hdev
->parent
)
5219 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
5220 usb_disconnect(&port_dev
->child
);
5223 /* We can forget about a "removed" device when there's a physical
5224 * disconnect or the connect status changes.
5226 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5227 (portchange
& USB_PORT_STAT_C_CONNECTION
))
5228 clear_bit(port1
, hub
->removed_bits
);
5230 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
5231 USB_PORT_STAT_C_ENABLE
)) {
5232 status
= hub_port_debounce_be_stable(hub
, port1
);
5234 if (status
!= -ENODEV
&&
5235 port1
!= unreliable_port
&&
5237 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
5238 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
5239 unreliable_port
= port1
;
5241 portstatus
= status
;
5245 /* Return now if debouncing failed or nothing is connected or
5246 * the device was "removed".
5248 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5249 test_bit(port1
, hub
->removed_bits
)) {
5252 * maybe switch power back on (e.g. root hub was reset)
5253 * but only if the port isn't owned by someone else.
5255 if (hub_is_port_power_switchable(hub
)
5256 && !port_is_power_on(hub
, portstatus
)
5257 && !port_dev
->port_owner
)
5258 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
5260 if (portstatus
& USB_PORT_STAT_ENABLE
)
5264 if (hub_is_superspeed(hub
->hdev
))
5270 for (i
= 0; i
< PORT_INIT_TRIES
; i
++) {
5272 /* reallocate for each attempt, since references
5273 * to the previous one can escape in various ways
5275 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
5277 dev_err(&port_dev
->dev
,
5278 "couldn't allocate usb_device\n");
5282 usb_set_device_state(udev
, USB_STATE_POWERED
);
5283 udev
->bus_mA
= hub
->mA_per_port
;
5284 udev
->level
= hdev
->level
+ 1;
5285 udev
->wusb
= hub_is_wusb(hub
);
5287 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5288 if (hub_is_superspeed(hub
->hdev
))
5289 udev
->speed
= USB_SPEED_SUPER
;
5291 udev
->speed
= USB_SPEED_UNKNOWN
;
5293 choose_devnum(udev
);
5294 if (udev
->devnum
<= 0) {
5295 status
= -ENOTCONN
; /* Don't retry */
5299 /* reset (non-USB 3.0 devices) and get descriptor */
5300 usb_lock_port(port_dev
);
5301 status
= hub_port_init(hub
, udev
, port1
, i
);
5302 usb_unlock_port(port_dev
);
5306 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
5309 /* consecutive bus-powered hubs aren't reliable; they can
5310 * violate the voltage drop budget. if the new child has
5311 * a "powered" LED, users should notice we didn't enable it
5312 * (without reading syslog), even without per-port LEDs
5315 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
5316 && udev
->bus_mA
<= unit_load
) {
5319 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0,
5322 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
5325 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
5327 "can't connect bus-powered hub "
5329 if (hub
->has_indicators
) {
5330 hub
->indicator
[port1
-1] =
5331 INDICATOR_AMBER_BLINK
;
5333 system_power_efficient_wq
,
5336 status
= -ENOTCONN
; /* Don't retry */
5341 /* check for devices running slower than they could */
5342 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
5343 && udev
->speed
== USB_SPEED_FULL
5344 && highspeed_hubs
!= 0)
5345 check_highspeed(hub
, udev
, port1
);
5347 /* Store the parent's children[] pointer. At this point
5348 * udev becomes globally accessible, although presumably
5349 * no one will look at it until hdev is unlocked.
5353 mutex_lock(&usb_port_peer_mutex
);
5355 /* We mustn't add new devices if the parent hub has
5356 * been disconnected; we would race with the
5357 * recursively_mark_NOTATTACHED() routine.
5359 spin_lock_irq(&device_state_lock
);
5360 if (hdev
->state
== USB_STATE_NOTATTACHED
)
5363 port_dev
->child
= udev
;
5364 spin_unlock_irq(&device_state_lock
);
5365 mutex_unlock(&usb_port_peer_mutex
);
5367 /* Run it through the hoops (find a driver, etc) */
5369 status
= usb_new_device(udev
);
5371 mutex_lock(&usb_port_peer_mutex
);
5372 spin_lock_irq(&device_state_lock
);
5373 port_dev
->child
= NULL
;
5374 spin_unlock_irq(&device_state_lock
);
5375 mutex_unlock(&usb_port_peer_mutex
);
5377 if (hcd
->usb_phy
&& !hdev
->parent
)
5378 usb_phy_notify_connect(hcd
->usb_phy
,
5386 status
= hub_power_remaining(hub
);
5388 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
5393 hub_port_disable(hub
, port1
, 1);
5395 usb_ep0_reinit(udev
);
5396 release_devnum(udev
);
5399 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
5402 /* When halfway through our retry count, power-cycle the port */
5403 if (i
== (PORT_INIT_TRIES
- 1) / 2) {
5404 dev_info(&port_dev
->dev
, "attempt power cycle\n");
5405 hub_port_power_cycle(hub
, port1
);
5408 if (hub
->hdev
->parent
||
5409 !hcd
->driver
->port_handed_over
||
5410 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
5411 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5412 dev_err(&port_dev
->dev
,
5413 "unable to enumerate USB device\n");
5417 hub_port_disable(hub
, port1
, 1);
5418 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
5419 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5420 hcd
->driver
->relinquish_port(hcd
, port1
);
5424 /* Handle physical or logical connection change events.
5425 * This routine is called when:
5426 * a port connection-change occurs;
5427 * a port enable-change occurs (often caused by EMI);
5428 * usb_reset_and_verify_device() encounters changed descriptors (as from
5429 * a firmware download)
5430 * caller already locked the hub
5432 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
5433 u16 portstatus
, u16 portchange
)
5434 __must_hold(&port_dev
->status_lock
)
5436 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5437 struct usb_device
*udev
= port_dev
->child
;
5438 struct usb_device_descriptor descriptor
;
5439 int status
= -ENODEV
;
5442 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
5443 portchange
, portspeed(hub
, portstatus
));
5445 if (hub
->has_indicators
) {
5446 set_port_led(hub
, port1
, HUB_LED_AUTO
);
5447 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
5450 #ifdef CONFIG_USB_OTG
5451 /* during HNP, don't repeat the debounce */
5452 if (hub
->hdev
->bus
->is_b_host
)
5453 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
5454 USB_PORT_STAT_C_ENABLE
);
5457 /* Try to resuscitate an existing device */
5458 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
5459 udev
->state
!= USB_STATE_NOTATTACHED
) {
5460 if (portstatus
& USB_PORT_STAT_ENABLE
) {
5462 * USB-3 connections are initialized automatically by
5463 * the hostcontroller hardware. Therefore check for
5464 * changed device descriptors before resuscitating the
5467 descriptor
= udev
->descriptor
;
5468 retval
= usb_get_device_descriptor(udev
,
5469 sizeof(udev
->descriptor
));
5472 "can't read device descriptor %d\n",
5475 if (descriptors_changed(udev
, &descriptor
,
5478 "device descriptor has changed\n");
5479 /* for disconnect() calls */
5480 udev
->descriptor
= descriptor
;
5482 status
= 0; /* Nothing to do */
5486 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
5487 udev
->persist_enabled
) {
5488 /* For a suspended device, treat this as a
5489 * remote wakeup event.
5491 usb_unlock_port(port_dev
);
5492 status
= usb_remote_wakeup(udev
);
5493 usb_lock_port(port_dev
);
5496 /* Don't resuscitate */;
5499 clear_bit(port1
, hub
->change_bits
);
5501 /* successfully revalidated the connection */
5505 usb_unlock_port(port_dev
);
5506 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5507 usb_lock_port(port_dev
);
5510 /* Handle notifying userspace about hub over-current events */
5511 static void port_over_current_notify(struct usb_port
*port_dev
)
5514 struct device
*hub_dev
;
5515 char *port_dev_path
;
5517 sysfs_notify(&port_dev
->dev
.kobj
, NULL
, "over_current_count");
5519 hub_dev
= port_dev
->dev
.parent
;
5524 port_dev_path
= kobject_get_path(&port_dev
->dev
.kobj
, GFP_KERNEL
);
5528 envp
[0] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_PORT=%s", port_dev_path
);
5532 envp
[1] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_COUNT=%u",
5533 port_dev
->over_current_count
);
5538 kobject_uevent_env(&hub_dev
->kobj
, KOBJ_CHANGE
, envp
);
5544 kfree(port_dev_path
);
5547 static void port_event(struct usb_hub
*hub
, int port1
)
5548 __must_hold(&port_dev
->status_lock
)
5551 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5552 struct usb_device
*udev
= port_dev
->child
;
5553 struct usb_device
*hdev
= hub
->hdev
;
5554 u16 portstatus
, portchange
;
5556 connect_change
= test_bit(port1
, hub
->change_bits
);
5557 clear_bit(port1
, hub
->event_bits
);
5558 clear_bit(port1
, hub
->wakeup_bits
);
5560 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5563 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5564 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5568 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5569 if (!connect_change
)
5570 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5572 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5575 * EM interference sometimes causes badly shielded USB devices
5576 * to be shutdown by the hub, this hack enables them again.
5577 * Works at least with mouse driver.
5579 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5580 && !connect_change
&& udev
) {
5581 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5586 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5587 u16 status
= 0, unused
;
5588 port_dev
->over_current_count
++;
5589 port_over_current_notify(port_dev
);
5591 dev_dbg(&port_dev
->dev
, "over-current change #%u\n",
5592 port_dev
->over_current_count
);
5593 usb_clear_port_feature(hdev
, port1
,
5594 USB_PORT_FEAT_C_OVER_CURRENT
);
5595 msleep(100); /* Cool down */
5596 hub_power_on(hub
, true);
5597 hub_port_status(hub
, port1
, &status
, &unused
);
5598 if (status
& USB_PORT_STAT_OVERCURRENT
)
5599 dev_err(&port_dev
->dev
, "over-current condition\n");
5602 if (portchange
& USB_PORT_STAT_C_RESET
) {
5603 dev_dbg(&port_dev
->dev
, "reset change\n");
5604 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5606 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5607 && hub_is_superspeed(hdev
)) {
5608 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5609 usb_clear_port_feature(hdev
, port1
,
5610 USB_PORT_FEAT_C_BH_PORT_RESET
);
5612 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5613 dev_dbg(&port_dev
->dev
, "link state change\n");
5614 usb_clear_port_feature(hdev
, port1
,
5615 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5617 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5618 dev_warn(&port_dev
->dev
, "config error\n");
5619 usb_clear_port_feature(hdev
, port1
,
5620 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5623 /* skip port actions that require the port to be powered on */
5624 if (!pm_runtime_active(&port_dev
->dev
))
5627 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5631 * Warm reset a USB3 protocol port if it's in
5632 * SS.Inactive state.
5634 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5635 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5636 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5637 || udev
->state
== USB_STATE_NOTATTACHED
) {
5638 if (hub_port_reset(hub
, port1
, NULL
,
5639 HUB_BH_RESET_TIME
, true) < 0)
5640 hub_port_disable(hub
, port1
, 1);
5642 usb_unlock_port(port_dev
);
5643 usb_lock_device(udev
);
5644 usb_reset_device(udev
);
5645 usb_unlock_device(udev
);
5646 usb_lock_port(port_dev
);
5652 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5655 static void hub_event(struct work_struct
*work
)
5657 struct usb_device
*hdev
;
5658 struct usb_interface
*intf
;
5659 struct usb_hub
*hub
;
5660 struct device
*hub_dev
;
5665 hub
= container_of(work
, struct usb_hub
, events
);
5667 hub_dev
= hub
->intfdev
;
5668 intf
= to_usb_interface(hub_dev
);
5670 kcov_remote_start_usb((u64
)hdev
->bus
->busnum
);
5672 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5673 hdev
->state
, hdev
->maxchild
,
5674 /* NOTE: expects max 15 ports... */
5675 (u16
) hub
->change_bits
[0],
5676 (u16
) hub
->event_bits
[0]);
5678 /* Lock the device, then check to see if we were
5679 * disconnected while waiting for the lock to succeed. */
5680 usb_lock_device(hdev
);
5681 if (unlikely(hub
->disconnected
))
5684 /* If the hub has died, clean up after it */
5685 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5686 hub
->error
= -ENODEV
;
5687 hub_quiesce(hub
, HUB_DISCONNECT
);
5692 ret
= usb_autopm_get_interface(intf
);
5694 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5698 /* If this is an inactive hub, do nothing */
5703 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5705 ret
= usb_reset_device(hdev
);
5707 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5715 /* deal with port status changes */
5716 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5717 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5719 if (test_bit(i
, hub
->event_bits
)
5720 || test_bit(i
, hub
->change_bits
)
5721 || test_bit(i
, hub
->wakeup_bits
)) {
5723 * The get_noresume and barrier ensure that if
5724 * the port was in the process of resuming, we
5725 * flush that work and keep the port active for
5726 * the duration of the port_event(). However,
5727 * if the port is runtime pm suspended
5728 * (powered-off), we leave it in that state, run
5729 * an abbreviated port_event(), and move on.
5731 pm_runtime_get_noresume(&port_dev
->dev
);
5732 pm_runtime_barrier(&port_dev
->dev
);
5733 usb_lock_port(port_dev
);
5735 usb_unlock_port(port_dev
);
5736 pm_runtime_put_sync(&port_dev
->dev
);
5740 /* deal with hub status changes */
5741 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5743 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5744 dev_err(hub_dev
, "get_hub_status failed\n");
5746 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5747 dev_dbg(hub_dev
, "power change\n");
5748 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5749 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5750 /* FIXME: Is this always true? */
5751 hub
->limited_power
= 1;
5753 hub
->limited_power
= 0;
5755 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5759 dev_dbg(hub_dev
, "over-current change\n");
5760 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5761 msleep(500); /* Cool down */
5762 hub_power_on(hub
, true);
5763 hub_hub_status(hub
, &status
, &unused
);
5764 if (status
& HUB_STATUS_OVERCURRENT
)
5765 dev_err(hub_dev
, "over-current condition\n");
5770 /* Balance the usb_autopm_get_interface() above */
5771 usb_autopm_put_interface_no_suspend(intf
);
5773 usb_unlock_device(hdev
);
5775 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5776 usb_autopm_put_interface(intf
);
5777 kref_put(&hub
->kref
, hub_release
);
5782 static const struct usb_device_id hub_id_table
[] = {
5783 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5784 | USB_DEVICE_ID_MATCH_PRODUCT
5785 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5786 .idVendor
= USB_VENDOR_SMSC
,
5787 .idProduct
= USB_PRODUCT_USB5534B
,
5788 .bInterfaceClass
= USB_CLASS_HUB
,
5789 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5790 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5791 | USB_DEVICE_ID_MATCH_PRODUCT
,
5792 .idVendor
= USB_VENDOR_CYPRESS
,
5793 .idProduct
= USB_PRODUCT_CY7C65632
,
5794 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5795 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5796 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5797 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5798 .bInterfaceClass
= USB_CLASS_HUB
,
5799 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5800 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5801 .bDeviceClass
= USB_CLASS_HUB
},
5802 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5803 .bInterfaceClass
= USB_CLASS_HUB
},
5804 { } /* Terminating entry */
5807 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5809 static struct usb_driver hub_driver
= {
5812 .disconnect
= hub_disconnect
,
5813 .suspend
= hub_suspend
,
5814 .resume
= hub_resume
,
5815 .reset_resume
= hub_reset_resume
,
5816 .pre_reset
= hub_pre_reset
,
5817 .post_reset
= hub_post_reset
,
5818 .unlocked_ioctl
= hub_ioctl
,
5819 .id_table
= hub_id_table
,
5820 .supports_autosuspend
= 1,
5823 int usb_hub_init(void)
5825 if (usb_register(&hub_driver
) < 0) {
5826 printk(KERN_ERR
"%s: can't register hub driver\n",
5832 * The workqueue needs to be freezable to avoid interfering with
5833 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5834 * device was gone before the EHCI controller had handed its port
5835 * over to the companion full-speed controller.
5837 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5841 /* Fall through if kernel_thread failed */
5842 usb_deregister(&hub_driver
);
5843 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5848 void usb_hub_cleanup(void)
5850 destroy_workqueue(hub_wq
);
5853 * Hub resources are freed for us by usb_deregister. It calls
5854 * usb_driver_purge on every device which in turn calls that
5855 * devices disconnect function if it is using this driver.
5856 * The hub_disconnect function takes care of releasing the
5857 * individual hub resources. -greg
5859 usb_deregister(&hub_driver
);
5860 } /* usb_hub_cleanup() */
5863 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5864 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5866 * WARNING - don't use this routine to reset a composite device
5867 * (one with multiple interfaces owned by separate drivers)!
5868 * Use usb_reset_device() instead.
5870 * Do a port reset, reassign the device's address, and establish its
5871 * former operating configuration. If the reset fails, or the device's
5872 * descriptors change from their values before the reset, or the original
5873 * configuration and altsettings cannot be restored, a flag will be set
5874 * telling hub_wq to pretend the device has been disconnected and then
5875 * re-connected. All drivers will be unbound, and the device will be
5876 * re-enumerated and probed all over again.
5878 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5879 * flagged for logical disconnection, or some other negative error code
5880 * if the reset wasn't even attempted.
5883 * The caller must own the device lock and the port lock, the latter is
5884 * taken by usb_reset_device(). For example, it's safe to use
5885 * usb_reset_device() from a driver probe() routine after downloading
5886 * new firmware. For calls that might not occur during probe(), drivers
5887 * should lock the device using usb_lock_device_for_reset().
5889 * Locking exception: This routine may also be called from within an
5890 * autoresume handler. Such usage won't conflict with other tasks
5891 * holding the device lock because these tasks should always call
5892 * usb_autopm_resume_device(), thereby preventing any unwanted
5893 * autoresume. The autoresume handler is expected to have already
5894 * acquired the port lock before calling this routine.
5896 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5898 struct usb_device
*parent_hdev
= udev
->parent
;
5899 struct usb_hub
*parent_hub
;
5900 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5901 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5902 struct usb_host_bos
*bos
;
5904 int port1
= udev
->portnum
;
5906 if (udev
->state
== USB_STATE_NOTATTACHED
||
5907 udev
->state
== USB_STATE_SUSPENDED
) {
5908 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5916 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5918 /* Disable USB2 hardware LPM.
5919 * It will be re-enabled by the enumeration process.
5921 usb_disable_usb2_hardware_lpm(udev
);
5923 /* Disable LPM while we reset the device and reinstall the alt settings.
5924 * Device-initiated LPM, and system exit latency settings are cleared
5925 * when the device is reset, so we have to set them up again.
5927 ret
= usb_unlocked_disable_lpm(udev
);
5929 dev_err(&udev
->dev
, "%s Failed to disable LPM\n", __func__
);
5930 goto re_enumerate_no_bos
;
5936 for (i
= 0; i
< PORT_INIT_TRIES
; ++i
) {
5938 /* ep0 maxpacket size may change; let the HCD know about it.
5939 * Other endpoints will be handled by re-enumeration. */
5940 usb_ep0_reinit(udev
);
5941 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5942 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5949 /* Device might have changed firmware (DFU or similar) */
5950 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5951 dev_info(&udev
->dev
, "device firmware changed\n");
5952 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5956 /* Restore the device's previous configuration */
5957 if (!udev
->actconfig
)
5960 mutex_lock(hcd
->bandwidth_mutex
);
5961 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5963 dev_warn(&udev
->dev
,
5964 "Busted HC? Not enough HCD resources for "
5965 "old configuration.\n");
5966 mutex_unlock(hcd
->bandwidth_mutex
);
5969 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5970 USB_REQ_SET_CONFIGURATION
, 0,
5971 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5972 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5975 "can't restore configuration #%d (error=%d)\n",
5976 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5977 mutex_unlock(hcd
->bandwidth_mutex
);
5980 mutex_unlock(hcd
->bandwidth_mutex
);
5981 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5983 /* Put interfaces back into the same altsettings as before.
5984 * Don't bother to send the Set-Interface request for interfaces
5985 * that were already in altsetting 0; besides being unnecessary,
5986 * many devices can't handle it. Instead just reset the host-side
5989 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5990 struct usb_host_config
*config
= udev
->actconfig
;
5991 struct usb_interface
*intf
= config
->interface
[i
];
5992 struct usb_interface_descriptor
*desc
;
5994 desc
= &intf
->cur_altsetting
->desc
;
5995 if (desc
->bAlternateSetting
== 0) {
5996 usb_disable_interface(udev
, intf
, true);
5997 usb_enable_interface(udev
, intf
, true);
6000 /* Let the bandwidth allocation function know that this
6001 * device has been reset, and it will have to use
6002 * alternate setting 0 as the current alternate setting.
6004 intf
->resetting_device
= 1;
6005 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
6006 desc
->bAlternateSetting
);
6007 intf
->resetting_device
= 0;
6010 dev_err(&udev
->dev
, "failed to restore interface %d "
6011 "altsetting %d (error=%d)\n",
6012 desc
->bInterfaceNumber
,
6013 desc
->bAlternateSetting
,
6017 /* Resetting also frees any allocated streams */
6018 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
6019 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
6023 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6024 usb_enable_usb2_hardware_lpm(udev
);
6025 usb_unlocked_enable_lpm(udev
);
6026 usb_enable_ltm(udev
);
6027 usb_release_bos_descriptor(udev
);
6032 usb_release_bos_descriptor(udev
);
6034 re_enumerate_no_bos
:
6035 /* LPM state doesn't matter when we're about to destroy the device. */
6036 hub_port_logical_disconnect(parent_hub
, port1
);
6041 * usb_reset_device - warn interface drivers and perform a USB port reset
6042 * @udev: device to reset (not in NOTATTACHED state)
6044 * Warns all drivers bound to registered interfaces (using their pre_reset
6045 * method), performs the port reset, and then lets the drivers know that
6046 * the reset is over (using their post_reset method).
6048 * Return: The same as for usb_reset_and_verify_device().
6051 * The caller must own the device lock. For example, it's safe to use
6052 * this from a driver probe() routine after downloading new firmware.
6053 * For calls that might not occur during probe(), drivers should lock
6054 * the device using usb_lock_device_for_reset().
6056 * If an interface is currently being probed or disconnected, we assume
6057 * its driver knows how to handle resets. For all other interfaces,
6058 * if the driver doesn't have pre_reset and post_reset methods then
6059 * we attempt to unbind it and rebind afterward.
6061 int usb_reset_device(struct usb_device
*udev
)
6065 unsigned int noio_flag
;
6066 struct usb_port
*port_dev
;
6067 struct usb_host_config
*config
= udev
->actconfig
;
6068 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
6070 if (udev
->state
== USB_STATE_NOTATTACHED
) {
6071 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
6076 if (!udev
->parent
) {
6077 /* this requires hcd-specific logic; see ohci_restart() */
6078 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
6082 port_dev
= hub
->ports
[udev
->portnum
- 1];
6085 * Don't allocate memory with GFP_KERNEL in current
6086 * context to avoid possible deadlock if usb mass
6087 * storage interface or usbnet interface(iSCSI case)
6088 * is included in current configuration. The easist
6089 * approach is to do it for every device reset,
6090 * because the device 'memalloc_noio' flag may have
6091 * not been set before reseting the usb device.
6093 noio_flag
= memalloc_noio_save();
6095 /* Prevent autosuspend during the reset */
6096 usb_autoresume_device(udev
);
6099 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
6100 struct usb_interface
*cintf
= config
->interface
[i
];
6101 struct usb_driver
*drv
;
6104 if (cintf
->dev
.driver
) {
6105 drv
= to_usb_driver(cintf
->dev
.driver
);
6106 if (drv
->pre_reset
&& drv
->post_reset
)
6107 unbind
= (drv
->pre_reset
)(cintf
);
6108 else if (cintf
->condition
==
6109 USB_INTERFACE_BOUND
)
6112 usb_forced_unbind_intf(cintf
);
6117 usb_lock_port(port_dev
);
6118 ret
= usb_reset_and_verify_device(udev
);
6119 usb_unlock_port(port_dev
);
6122 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
6123 struct usb_interface
*cintf
= config
->interface
[i
];
6124 struct usb_driver
*drv
;
6125 int rebind
= cintf
->needs_binding
;
6127 if (!rebind
&& cintf
->dev
.driver
) {
6128 drv
= to_usb_driver(cintf
->dev
.driver
);
6129 if (drv
->post_reset
)
6130 rebind
= (drv
->post_reset
)(cintf
);
6131 else if (cintf
->condition
==
6132 USB_INTERFACE_BOUND
)
6135 cintf
->needs_binding
= 1;
6139 /* If the reset failed, hub_wq will unbind drivers later */
6141 usb_unbind_and_rebind_marked_interfaces(udev
);
6144 usb_autosuspend_device(udev
);
6145 memalloc_noio_restore(noio_flag
);
6148 EXPORT_SYMBOL_GPL(usb_reset_device
);
6152 * usb_queue_reset_device - Reset a USB device from an atomic context
6153 * @iface: USB interface belonging to the device to reset
6155 * This function can be used to reset a USB device from an atomic
6156 * context, where usb_reset_device() won't work (as it blocks).
6158 * Doing a reset via this method is functionally equivalent to calling
6159 * usb_reset_device(), except for the fact that it is delayed to a
6160 * workqueue. This means that any drivers bound to other interfaces
6161 * might be unbound, as well as users from usbfs in user space.
6165 * - Scheduling two resets at the same time from two different drivers
6166 * attached to two different interfaces of the same device is
6167 * possible; depending on how the driver attached to each interface
6168 * handles ->pre_reset(), the second reset might happen or not.
6170 * - If the reset is delayed so long that the interface is unbound from
6171 * its driver, the reset will be skipped.
6173 * - This function can be called during .probe(). It can also be called
6174 * during .disconnect(), but doing so is pointless because the reset
6175 * will not occur. If you really want to reset the device during
6176 * .disconnect(), call usb_reset_device() directly -- but watch out
6177 * for nested unbinding issues!
6179 void usb_queue_reset_device(struct usb_interface
*iface
)
6181 if (schedule_work(&iface
->reset_ws
))
6182 usb_get_intf(iface
);
6184 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
6187 * usb_hub_find_child - Get the pointer of child device
6188 * attached to the port which is specified by @port1.
6189 * @hdev: USB device belonging to the usb hub
6190 * @port1: port num to indicate which port the child device
6193 * USB drivers call this function to get hub's child device
6196 * Return: %NULL if input param is invalid and
6197 * child's usb_device pointer if non-NULL.
6199 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
6202 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6204 if (port1
< 1 || port1
> hdev
->maxchild
)
6206 return hub
->ports
[port1
- 1]->child
;
6208 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
6210 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
6211 struct usb_hub_descriptor
*desc
)
6213 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6214 enum usb_port_connect_type connect_type
;
6220 if (!hub_is_superspeed(hdev
)) {
6221 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6222 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6224 connect_type
= port_dev
->connect_type
;
6225 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6226 u8 mask
= 1 << (i
%8);
6228 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
6229 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6230 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
6235 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
6237 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6238 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6240 connect_type
= port_dev
->connect_type
;
6241 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6244 if (!(port_removable
& mask
)) {
6245 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6246 port_removable
|= mask
;
6251 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
6257 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6258 * @hdev: USB device belonging to the usb hub
6259 * @port1: port num of the port
6261 * Return: Port's acpi handle if successful, %NULL if params are
6264 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
6267 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6272 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);