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/uaccess.h>
35 #include <asm/byteorder.h>
38 #include "otg_whitelist.h"
40 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
41 #define USB_VENDOR_SMSC 0x0424
42 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
43 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
45 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
46 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
48 /* Protect struct usb_device->state and ->children members
49 * Note: Both are also protected by ->dev.sem, except that ->state can
50 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
51 static DEFINE_SPINLOCK(device_state_lock
);
53 /* workqueue to process hub events */
54 static struct workqueue_struct
*hub_wq
;
55 static void hub_event(struct work_struct
*work
);
57 /* synchronize hub-port add/remove and peering operations */
58 DEFINE_MUTEX(usb_port_peer_mutex
);
60 /* cycle leds on hubs that aren't blinking for attention */
61 static bool blinkenlights
;
62 module_param(blinkenlights
, bool, S_IRUGO
);
63 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
66 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
67 * 10 seconds to send reply for the initial 64-byte descriptor request.
69 /* define initial 64-byte descriptor request timeout in milliseconds */
70 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
71 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
72 MODULE_PARM_DESC(initial_descriptor_timeout
,
73 "initial 64-byte descriptor request timeout in milliseconds "
74 "(default 5000 - 5.0 seconds)");
77 * As of 2.6.10 we introduce a new USB device initialization scheme which
78 * closely resembles the way Windows works. Hopefully it will be compatible
79 * with a wider range of devices than the old scheme. However some previously
80 * working devices may start giving rise to "device not accepting address"
81 * errors; if that happens the user can try the old scheme by adjusting the
82 * following module parameters.
84 * For maximum flexibility there are two boolean parameters to control the
85 * hub driver's behavior. On the first initialization attempt, if the
86 * "old_scheme_first" parameter is set then the old scheme will be used,
87 * otherwise the new scheme is used. If that fails and "use_both_schemes"
88 * is set, then the driver will make another attempt, using the other scheme.
90 static bool old_scheme_first
;
91 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
92 MODULE_PARM_DESC(old_scheme_first
,
93 "start with the old device initialization scheme");
95 static bool use_both_schemes
= 1;
96 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
97 MODULE_PARM_DESC(use_both_schemes
,
98 "try the other device initialization scheme if the "
101 /* Mutual exclusion for EHCI CF initialization. This interferes with
102 * port reset on some companion controllers.
104 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
105 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
107 #define HUB_DEBOUNCE_TIMEOUT 2000
108 #define HUB_DEBOUNCE_STEP 25
109 #define HUB_DEBOUNCE_STABLE 100
111 static void hub_release(struct kref
*kref
);
112 static int usb_reset_and_verify_device(struct usb_device
*udev
);
113 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
114 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
117 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
119 if (hub_is_superspeedplus(hub
->hdev
))
121 if (hub_is_superspeed(hub
->hdev
))
123 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
125 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
131 /* Note that hdev or one of its children must be locked! */
132 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
134 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
136 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
139 int usb_device_supports_lpm(struct usb_device
*udev
)
141 /* Some devices have trouble with LPM */
142 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
145 /* USB 2.1 (and greater) devices indicate LPM support through
146 * their USB 2.0 Extended Capabilities BOS descriptor.
148 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
149 if (udev
->bos
->ext_cap
&&
151 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
157 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
158 * However, there are some that don't, and they set the U1/U2 exit
161 if (!udev
->bos
->ss_cap
) {
162 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
166 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
167 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
169 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
171 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
175 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
181 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
184 static void usb_set_lpm_mel(struct usb_device
*udev
,
185 struct usb3_lpm_parameters
*udev_lpm_params
,
186 unsigned int udev_exit_latency
,
188 struct usb3_lpm_parameters
*hub_lpm_params
,
189 unsigned int hub_exit_latency
)
191 unsigned int total_mel
;
192 unsigned int device_mel
;
193 unsigned int hub_mel
;
196 * Calculate the time it takes to transition all links from the roothub
197 * to the parent hub into U0. The parent hub must then decode the
198 * packet (hub header decode latency) to figure out which port it was
201 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
202 * means 0.1us). Multiply that by 100 to get nanoseconds.
204 total_mel
= hub_lpm_params
->mel
+
205 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
208 * How long will it take to transition the downstream hub's port into
209 * U0? The greater of either the hub exit latency or the device exit
212 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
213 * Multiply that by 1000 to get nanoseconds.
215 device_mel
= udev_exit_latency
* 1000;
216 hub_mel
= hub_exit_latency
* 1000;
217 if (device_mel
> hub_mel
)
218 total_mel
+= device_mel
;
220 total_mel
+= hub_mel
;
222 udev_lpm_params
->mel
= total_mel
;
226 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
227 * a transition from either U1 or U2.
229 static void usb_set_lpm_pel(struct usb_device
*udev
,
230 struct usb3_lpm_parameters
*udev_lpm_params
,
231 unsigned int udev_exit_latency
,
233 struct usb3_lpm_parameters
*hub_lpm_params
,
234 unsigned int hub_exit_latency
,
235 unsigned int port_to_port_exit_latency
)
237 unsigned int first_link_pel
;
238 unsigned int hub_pel
;
241 * First, the device sends an LFPS to transition the link between the
242 * device and the parent hub into U0. The exit latency is the bigger of
243 * the device exit latency or the hub exit latency.
245 if (udev_exit_latency
> hub_exit_latency
)
246 first_link_pel
= udev_exit_latency
* 1000;
248 first_link_pel
= hub_exit_latency
* 1000;
251 * When the hub starts to receive the LFPS, there is a slight delay for
252 * it to figure out that one of the ports is sending an LFPS. Then it
253 * will forward the LFPS to its upstream link. The exit latency is the
254 * delay, plus the PEL that we calculated for this hub.
256 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
259 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
260 * is the greater of the two exit latencies.
262 if (first_link_pel
> hub_pel
)
263 udev_lpm_params
->pel
= first_link_pel
;
265 udev_lpm_params
->pel
= hub_pel
;
269 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
270 * when a device initiates a transition to U0, until when it will receive the
271 * first packet from the host controller.
273 * Section C.1.5.1 describes the four components to this:
275 * - t2: time for the ERDY to make it from the device to the host.
276 * - t3: a host-specific delay to process the ERDY.
277 * - t4: time for the packet to make it from the host to the device.
279 * t3 is specific to both the xHCI host and the platform the host is integrated
280 * into. The Intel HW folks have said it's negligible, FIXME if a different
281 * vendor says otherwise.
283 static void usb_set_lpm_sel(struct usb_device
*udev
,
284 struct usb3_lpm_parameters
*udev_lpm_params
)
286 struct usb_device
*parent
;
287 unsigned int num_hubs
;
288 unsigned int total_sel
;
290 /* t1 = device PEL */
291 total_sel
= udev_lpm_params
->pel
;
292 /* How many external hubs are in between the device & the root port. */
293 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
294 parent
= parent
->parent
)
296 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
298 total_sel
+= 2100 + 250 * (num_hubs
- 1);
300 /* t4 = 250ns * num_hubs */
301 total_sel
+= 250 * num_hubs
;
303 udev_lpm_params
->sel
= total_sel
;
306 static void usb_set_lpm_parameters(struct usb_device
*udev
)
309 unsigned int port_to_port_delay
;
310 unsigned int udev_u1_del
;
311 unsigned int udev_u2_del
;
312 unsigned int hub_u1_del
;
313 unsigned int hub_u2_del
;
315 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
318 hub
= usb_hub_to_struct_hub(udev
->parent
);
319 /* It doesn't take time to transition the roothub into U0, since it
320 * doesn't have an upstream link.
325 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
326 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
327 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
328 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
330 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
331 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
333 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
334 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
337 * Appendix C, section C.2.2.2, says that there is a slight delay from
338 * when the parent hub notices the downstream port is trying to
339 * transition to U0 to when the hub initiates a U0 transition on its
340 * upstream port. The section says the delays are tPort2PortU1EL and
341 * tPort2PortU2EL, but it doesn't define what they are.
343 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
344 * about the same delays. Use the maximum delay calculations from those
345 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
346 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
347 * assume the device exit latencies they are talking about are the hub
350 * What do we do if the U2 exit latency is less than the U1 exit
351 * latency? It's possible, although not likely...
353 port_to_port_delay
= 1;
355 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
356 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
359 if (hub_u2_del
> hub_u1_del
)
360 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
362 port_to_port_delay
= 1 + hub_u1_del
;
364 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
365 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
368 /* Now that we've got PEL, calculate SEL. */
369 usb_set_lpm_sel(udev
, &udev
->u1_params
);
370 usb_set_lpm_sel(udev
, &udev
->u2_params
);
373 /* USB 2.0 spec Section 11.24.4.5 */
374 static int get_hub_descriptor(struct usb_device
*hdev
,
375 struct usb_hub_descriptor
*desc
)
380 if (hub_is_superspeed(hdev
)) {
381 dtype
= USB_DT_SS_HUB
;
382 size
= USB_DT_SS_HUB_SIZE
;
385 size
= sizeof(struct usb_hub_descriptor
);
388 for (i
= 0; i
< 3; i
++) {
389 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
390 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
391 dtype
<< 8, 0, desc
, size
,
392 USB_CTRL_GET_TIMEOUT
);
393 if (hub_is_superspeed(hdev
)) {
396 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
397 /* Make sure we have the DeviceRemovable field. */
398 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
408 * USB 2.0 spec Section 11.24.2.1
410 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
412 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
413 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
417 * USB 2.0 spec Section 11.24.2.2
419 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
421 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
422 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
427 * USB 2.0 spec Section 11.24.2.13
429 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
431 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
432 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
436 static char *to_led_name(int selector
)
453 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
454 * for info about using port indicators
456 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
458 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
461 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
462 USB_PORT_FEAT_INDICATOR
);
463 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
464 to_led_name(selector
), status
);
467 #define LED_CYCLE_PERIOD ((2*HZ)/3)
469 static void led_work(struct work_struct
*work
)
471 struct usb_hub
*hub
=
472 container_of(work
, struct usb_hub
, leds
.work
);
473 struct usb_device
*hdev
= hub
->hdev
;
475 unsigned changed
= 0;
478 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
481 for (i
= 0; i
< hdev
->maxchild
; i
++) {
482 unsigned selector
, mode
;
484 /* 30%-50% duty cycle */
486 switch (hub
->indicator
[i
]) {
488 case INDICATOR_CYCLE
:
490 selector
= HUB_LED_AUTO
;
491 mode
= INDICATOR_AUTO
;
493 /* blinking green = sw attention */
494 case INDICATOR_GREEN_BLINK
:
495 selector
= HUB_LED_GREEN
;
496 mode
= INDICATOR_GREEN_BLINK_OFF
;
498 case INDICATOR_GREEN_BLINK_OFF
:
499 selector
= HUB_LED_OFF
;
500 mode
= INDICATOR_GREEN_BLINK
;
502 /* blinking amber = hw attention */
503 case INDICATOR_AMBER_BLINK
:
504 selector
= HUB_LED_AMBER
;
505 mode
= INDICATOR_AMBER_BLINK_OFF
;
507 case INDICATOR_AMBER_BLINK_OFF
:
508 selector
= HUB_LED_OFF
;
509 mode
= INDICATOR_AMBER_BLINK
;
511 /* blink green/amber = reserved */
512 case INDICATOR_ALT_BLINK
:
513 selector
= HUB_LED_GREEN
;
514 mode
= INDICATOR_ALT_BLINK_OFF
;
516 case INDICATOR_ALT_BLINK_OFF
:
517 selector
= HUB_LED_AMBER
;
518 mode
= INDICATOR_ALT_BLINK
;
523 if (selector
!= HUB_LED_AUTO
)
525 set_port_led(hub
, i
+ 1, selector
);
526 hub
->indicator
[i
] = mode
;
528 if (!changed
&& blinkenlights
) {
530 cursor
%= hdev
->maxchild
;
531 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
532 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
536 queue_delayed_work(system_power_efficient_wq
,
537 &hub
->leds
, LED_CYCLE_PERIOD
);
540 /* use a short timeout for hub/port status fetches */
541 #define USB_STS_TIMEOUT 1000
542 #define USB_STS_RETRIES 5
545 * USB 2.0 spec Section 11.24.2.6
547 static int get_hub_status(struct usb_device
*hdev
,
548 struct usb_hub_status
*data
)
550 int i
, status
= -ETIMEDOUT
;
552 for (i
= 0; i
< USB_STS_RETRIES
&&
553 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
554 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
555 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
556 data
, sizeof(*data
), USB_STS_TIMEOUT
);
562 * USB 2.0 spec Section 11.24.2.7
563 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
565 static int get_port_status(struct usb_device
*hdev
, int port1
,
566 void *data
, u16 value
, u16 length
)
568 int i
, status
= -ETIMEDOUT
;
570 for (i
= 0; i
< USB_STS_RETRIES
&&
571 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
572 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
573 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
574 port1
, data
, length
, USB_STS_TIMEOUT
);
579 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
580 u16
*status
, u16
*change
, u32
*ext_status
)
585 if (type
!= HUB_PORT_STATUS
)
588 mutex_lock(&hub
->status_mutex
);
589 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
592 dev_err(hub
->intfdev
,
593 "%s failed (err = %d)\n", __func__
, ret
);
597 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
598 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
599 if (type
!= HUB_PORT_STATUS
&& ext_status
)
600 *ext_status
= le32_to_cpu(
601 hub
->status
->port
.dwExtPortStatus
);
604 mutex_unlock(&hub
->status_mutex
);
608 static int hub_port_status(struct usb_hub
*hub
, int port1
,
609 u16
*status
, u16
*change
)
611 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
612 status
, change
, NULL
);
615 static void hub_resubmit_irq_urb(struct usb_hub
*hub
)
620 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
622 if (hub
->quiescing
) {
623 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
627 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
628 if (status
&& status
!= -ENODEV
&& status
!= -EPERM
&&
629 status
!= -ESHUTDOWN
) {
630 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
631 mod_timer(&hub
->irq_urb_retry
, jiffies
+ HZ
);
634 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
637 static void hub_retry_irq_urb(struct timer_list
*t
)
639 struct usb_hub
*hub
= from_timer(hub
, t
, irq_urb_retry
);
641 hub_resubmit_irq_urb(hub
);
645 static void kick_hub_wq(struct usb_hub
*hub
)
647 struct usb_interface
*intf
;
649 if (hub
->disconnected
|| work_pending(&hub
->events
))
653 * Suppress autosuspend until the event is proceed.
655 * Be careful and make sure that the symmetric operation is
656 * always called. We are here only when there is no pending
657 * work for this hub. Therefore put the interface either when
658 * the new work is called or when it is canceled.
660 intf
= to_usb_interface(hub
->intfdev
);
661 usb_autopm_get_interface_no_resume(intf
);
662 kref_get(&hub
->kref
);
664 if (queue_work(hub_wq
, &hub
->events
))
667 /* the work has already been scheduled */
668 usb_autopm_put_interface_async(intf
);
669 kref_put(&hub
->kref
, hub_release
);
672 void usb_kick_hub_wq(struct usb_device
*hdev
)
674 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
681 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
682 * Notification, which indicates it had initiated remote wakeup.
684 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
685 * device initiates resume, so the USB core will not receive notice of the
686 * resume through the normal hub interrupt URB.
688 void usb_wakeup_notification(struct usb_device
*hdev
,
689 unsigned int portnum
)
692 struct usb_port
*port_dev
;
697 hub
= usb_hub_to_struct_hub(hdev
);
699 port_dev
= hub
->ports
[portnum
- 1];
700 if (port_dev
&& port_dev
->child
)
701 pm_wakeup_event(&port_dev
->child
->dev
, 0);
703 set_bit(portnum
, hub
->wakeup_bits
);
707 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
709 /* completion function, fires on port status changes and various faults */
710 static void hub_irq(struct urb
*urb
)
712 struct usb_hub
*hub
= urb
->context
;
713 int status
= urb
->status
;
718 case -ENOENT
: /* synchronous unlink */
719 case -ECONNRESET
: /* async unlink */
720 case -ESHUTDOWN
: /* hardware going away */
723 default: /* presumably an error */
724 /* Cause a hub reset after 10 consecutive errors */
725 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
726 if ((++hub
->nerrors
< 10) || hub
->error
)
731 /* let hub_wq handle things */
732 case 0: /* we got data: port status changed */
734 for (i
= 0; i
< urb
->actual_length
; ++i
)
735 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
737 hub
->event_bits
[0] = bits
;
743 /* Something happened, let hub_wq figure it out */
747 hub_resubmit_irq_urb(hub
);
750 /* USB 2.0 spec Section 11.24.2.3 */
752 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
754 /* Need to clear both directions for control ep */
755 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
756 USB_ENDPOINT_XFER_CONTROL
) {
757 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
758 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
759 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
763 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
764 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
769 * enumeration blocks hub_wq for a long time. we use keventd instead, since
770 * long blocking there is the exception, not the rule. accordingly, HCDs
771 * talking to TTs must queue control transfers (not just bulk and iso), so
772 * both can talk to the same hub concurrently.
774 static void hub_tt_work(struct work_struct
*work
)
776 struct usb_hub
*hub
=
777 container_of(work
, struct usb_hub
, tt
.clear_work
);
780 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
781 while (!list_empty(&hub
->tt
.clear_list
)) {
782 struct list_head
*next
;
783 struct usb_tt_clear
*clear
;
784 struct usb_device
*hdev
= hub
->hdev
;
785 const struct hc_driver
*drv
;
788 next
= hub
->tt
.clear_list
.next
;
789 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
790 list_del(&clear
->clear_list
);
792 /* drop lock so HCD can concurrently report other TT errors */
793 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
794 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
795 if (status
&& status
!= -ENODEV
)
797 "clear tt %d (%04x) error %d\n",
798 clear
->tt
, clear
->devinfo
, status
);
800 /* Tell the HCD, even if the operation failed */
801 drv
= clear
->hcd
->driver
;
802 if (drv
->clear_tt_buffer_complete
)
803 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
806 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
808 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
812 * usb_hub_set_port_power - control hub port's power state
813 * @hdev: USB device belonging to the usb hub
816 * @set: expected status
818 * call this function to control port's power via setting or
819 * clearing the port's PORT_POWER feature.
821 * Return: 0 if successful. A negative error code otherwise.
823 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
829 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
831 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
837 set_bit(port1
, hub
->power_bits
);
839 clear_bit(port1
, hub
->power_bits
);
844 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
845 * @urb: an URB associated with the failed or incomplete split transaction
847 * High speed HCDs use this to tell the hub driver that some split control or
848 * bulk transaction failed in a way that requires clearing internal state of
849 * a transaction translator. This is normally detected (and reported) from
852 * It may not be possible for that hub to handle additional full (or low)
853 * speed transactions until that state is fully cleared out.
855 * Return: 0 if successful. A negative error code otherwise.
857 int usb_hub_clear_tt_buffer(struct urb
*urb
)
859 struct usb_device
*udev
= urb
->dev
;
860 int pipe
= urb
->pipe
;
861 struct usb_tt
*tt
= udev
->tt
;
863 struct usb_tt_clear
*clear
;
865 /* we've got to cope with an arbitrary number of pending TT clears,
866 * since each TT has "at least two" buffers that can need it (and
867 * there can be many TTs per hub). even if they're uncommon.
869 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
871 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
872 /* FIXME recover somehow ... RESET_TT? */
876 /* info that CLEAR_TT_BUFFER needs */
877 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
878 clear
->devinfo
= usb_pipeendpoint (pipe
);
879 clear
->devinfo
|= ((u16
)udev
->devaddr
) << 4;
880 clear
->devinfo
|= usb_pipecontrol(pipe
)
881 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
882 : (USB_ENDPOINT_XFER_BULK
<< 11);
883 if (usb_pipein(pipe
))
884 clear
->devinfo
|= 1 << 15;
886 /* info for completion callback */
887 clear
->hcd
= bus_to_hcd(udev
->bus
);
890 /* tell keventd to clear state for this TT */
891 spin_lock_irqsave(&tt
->lock
, flags
);
892 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
893 schedule_work(&tt
->clear_work
);
894 spin_unlock_irqrestore(&tt
->lock
, flags
);
897 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
899 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
903 /* Enable power on each port. Some hubs have reserved values
904 * of LPSM (> 2) in their descriptors, even though they are
905 * USB 2.0 hubs. Some hubs do not implement port-power switching
906 * but only emulate it. In all cases, the ports won't work
907 * unless we send these messages to the hub.
909 if (hub_is_port_power_switchable(hub
))
910 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
912 dev_dbg(hub
->intfdev
, "trying to enable port power on "
913 "non-switchable hub\n");
914 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
915 if (test_bit(port1
, hub
->power_bits
))
916 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
918 usb_clear_port_feature(hub
->hdev
, port1
,
919 USB_PORT_FEAT_POWER
);
921 msleep(hub_power_on_good_delay(hub
));
924 static int hub_hub_status(struct usb_hub
*hub
,
925 u16
*status
, u16
*change
)
929 mutex_lock(&hub
->status_mutex
);
930 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
933 dev_err(hub
->intfdev
,
934 "%s failed (err = %d)\n", __func__
, ret
);
936 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
937 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
940 mutex_unlock(&hub
->status_mutex
);
944 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
945 unsigned int link_status
)
947 return set_port_feature(hub
->hdev
,
948 port1
| (link_status
<< 3),
949 USB_PORT_FEAT_LINK_STATE
);
953 * Disable a port and mark a logical connect-change event, so that some
954 * time later hub_wq will disconnect() any existing usb_device on the port
955 * and will re-enumerate if there actually is a device attached.
957 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
959 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
960 hub_port_disable(hub
, port1
, 1);
962 /* FIXME let caller ask to power down the port:
963 * - some devices won't enumerate without a VBUS power cycle
964 * - SRP saves power that way
965 * - ... new call, TBD ...
966 * That's easy if this hub can switch power per-port, and
967 * hub_wq reactivates the port later (timer, SRP, etc).
968 * Powerdown must be optional, because of reset/DFU.
971 set_bit(port1
, hub
->change_bits
);
976 * usb_remove_device - disable a device's port on its parent hub
977 * @udev: device to be disabled and removed
978 * Context: @udev locked, must be able to sleep.
980 * After @udev's port has been disabled, hub_wq is notified and it will
981 * see that the device has been disconnected. When the device is
982 * physically unplugged and something is plugged in, the events will
983 * be received and processed normally.
985 * Return: 0 if successful. A negative error code otherwise.
987 int usb_remove_device(struct usb_device
*udev
)
990 struct usb_interface
*intf
;
993 if (!udev
->parent
) /* Can't remove a root hub */
995 hub
= usb_hub_to_struct_hub(udev
->parent
);
996 intf
= to_usb_interface(hub
->intfdev
);
998 ret
= usb_autopm_get_interface(intf
);
1002 set_bit(udev
->portnum
, hub
->removed_bits
);
1003 hub_port_logical_disconnect(hub
, udev
->portnum
);
1004 usb_autopm_put_interface(intf
);
1008 enum hub_activation_type
{
1009 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1010 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1013 static void hub_init_func2(struct work_struct
*ws
);
1014 static void hub_init_func3(struct work_struct
*ws
);
1016 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1018 struct usb_device
*hdev
= hub
->hdev
;
1019 struct usb_hcd
*hcd
;
1023 bool need_debounce_delay
= false;
1026 /* Continue a partial initialization */
1027 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1028 device_lock(&hdev
->dev
);
1030 /* Was the hub disconnected while we were waiting? */
1031 if (hub
->disconnected
)
1033 if (type
== HUB_INIT2
)
1037 kref_get(&hub
->kref
);
1039 /* The superspeed hub except for root hub has to use Hub Depth
1040 * value as an offset into the route string to locate the bits
1041 * it uses to determine the downstream port number. So hub driver
1042 * should send a set hub depth request to superspeed hub after
1043 * the superspeed hub is set configuration in initialization or
1046 * After a resume, port power should still be on.
1047 * For any other type of activation, turn it on.
1049 if (type
!= HUB_RESUME
) {
1050 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1051 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1052 HUB_SET_DEPTH
, USB_RT_HUB
,
1053 hdev
->level
- 1, 0, NULL
, 0,
1054 USB_CTRL_SET_TIMEOUT
);
1056 dev_err(hub
->intfdev
,
1057 "set hub depth failed\n");
1060 /* Speed up system boot by using a delayed_work for the
1061 * hub's initial power-up delays. This is pretty awkward
1062 * and the implementation looks like a home-brewed sort of
1063 * setjmp/longjmp, but it saves at least 100 ms for each
1064 * root hub (assuming usbcore is compiled into the kernel
1065 * rather than as a module). It adds up.
1067 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1068 * because for those activation types the ports have to be
1069 * operational when we return. In theory this could be done
1070 * for HUB_POST_RESET, but it's easier not to.
1072 if (type
== HUB_INIT
) {
1073 delay
= hub_power_on_good_delay(hub
);
1075 hub_power_on(hub
, false);
1076 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1077 queue_delayed_work(system_power_efficient_wq
,
1079 msecs_to_jiffies(delay
));
1081 /* Suppress autosuspend until init is done */
1082 usb_autopm_get_interface_no_resume(
1083 to_usb_interface(hub
->intfdev
));
1084 return; /* Continues at init2: below */
1085 } else if (type
== HUB_RESET_RESUME
) {
1086 /* The internal host controller state for the hub device
1087 * may be gone after a host power loss on system resume.
1088 * Update the device's info so the HW knows it's a hub.
1090 hcd
= bus_to_hcd(hdev
->bus
);
1091 if (hcd
->driver
->update_hub_device
) {
1092 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1093 &hub
->tt
, GFP_NOIO
);
1095 dev_err(hub
->intfdev
,
1096 "Host not accepting hub info update\n");
1097 dev_err(hub
->intfdev
,
1098 "LS/FS devices and hubs may not work under this hub\n");
1101 hub_power_on(hub
, true);
1103 hub_power_on(hub
, true);
1109 * Check each port and set hub->change_bits to let hub_wq know
1110 * which ports need attention.
1112 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1113 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1114 struct usb_device
*udev
= port_dev
->child
;
1115 u16 portstatus
, portchange
;
1117 portstatus
= portchange
= 0;
1118 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1122 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1123 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1124 portstatus
, portchange
);
1127 * After anything other than HUB_RESUME (i.e., initialization
1128 * or any sort of reset), every port should be disabled.
1129 * Unconnected ports should likewise be disabled (paranoia),
1130 * and so should ports for which we have no usb_device.
1132 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1133 type
!= HUB_RESUME
||
1134 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1136 udev
->state
== USB_STATE_NOTATTACHED
)) {
1138 * USB3 protocol ports will automatically transition
1139 * to Enabled state when detect an USB3.0 device attach.
1140 * Do not disable USB3 protocol ports, just pretend
1143 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1144 if (!hub_is_superspeed(hdev
))
1145 usb_clear_port_feature(hdev
, port1
,
1146 USB_PORT_FEAT_ENABLE
);
1149 /* Make sure a warm-reset request is handled by port_event */
1150 if (type
== HUB_RESUME
&&
1151 hub_port_warm_reset_required(hub
, port1
, portstatus
))
1152 set_bit(port1
, hub
->event_bits
);
1155 * Add debounce if USB3 link is in polling/link training state.
1156 * Link will automatically transition to Enabled state after
1157 * link training completes.
1159 if (hub_is_superspeed(hdev
) &&
1160 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1161 USB_SS_PORT_LS_POLLING
))
1162 need_debounce_delay
= true;
1164 /* Clear status-change flags; we'll debounce later */
1165 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1166 need_debounce_delay
= true;
1167 usb_clear_port_feature(hub
->hdev
, port1
,
1168 USB_PORT_FEAT_C_CONNECTION
);
1170 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1171 need_debounce_delay
= true;
1172 usb_clear_port_feature(hub
->hdev
, port1
,
1173 USB_PORT_FEAT_C_ENABLE
);
1175 if (portchange
& USB_PORT_STAT_C_RESET
) {
1176 need_debounce_delay
= true;
1177 usb_clear_port_feature(hub
->hdev
, port1
,
1178 USB_PORT_FEAT_C_RESET
);
1180 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1181 hub_is_superspeed(hub
->hdev
)) {
1182 need_debounce_delay
= true;
1183 usb_clear_port_feature(hub
->hdev
, port1
,
1184 USB_PORT_FEAT_C_BH_PORT_RESET
);
1186 /* We can forget about a "removed" device when there's a
1187 * physical disconnect or the connect status changes.
1189 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1190 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1191 clear_bit(port1
, hub
->removed_bits
);
1193 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1194 /* Tell hub_wq to disconnect the device or
1195 * check for a new connection or over current condition.
1196 * Based on USB2.0 Spec Section 11.12.5,
1197 * C_PORT_OVER_CURRENT could be set while
1198 * PORT_OVER_CURRENT is not. So check for any of them.
1200 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1201 (portchange
& USB_PORT_STAT_C_CONNECTION
) ||
1202 (portstatus
& USB_PORT_STAT_OVERCURRENT
) ||
1203 (portchange
& USB_PORT_STAT_C_OVERCURRENT
))
1204 set_bit(port1
, hub
->change_bits
);
1206 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1207 bool port_resumed
= (portstatus
&
1208 USB_PORT_STAT_LINK_STATE
) ==
1210 /* The power session apparently survived the resume.
1211 * If there was an overcurrent or suspend change
1212 * (i.e., remote wakeup request), have hub_wq
1213 * take care of it. Look at the port link state
1214 * for USB 3.0 hubs, since they don't have a suspend
1215 * change bit, and they don't set the port link change
1216 * bit on device-initiated resume.
1218 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1220 set_bit(port1
, hub
->change_bits
);
1222 } else if (udev
->persist_enabled
) {
1224 udev
->reset_resume
= 1;
1226 /* Don't set the change_bits when the device
1229 if (test_bit(port1
, hub
->power_bits
))
1230 set_bit(port1
, hub
->change_bits
);
1233 /* The power session is gone; tell hub_wq */
1234 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1235 set_bit(port1
, hub
->change_bits
);
1239 /* If no port-status-change flags were set, we don't need any
1240 * debouncing. If flags were set we can try to debounce the
1241 * ports all at once right now, instead of letting hub_wq do them
1242 * one at a time later on.
1244 * If any port-status changes do occur during this delay, hub_wq
1245 * will see them later and handle them normally.
1247 if (need_debounce_delay
) {
1248 delay
= HUB_DEBOUNCE_STABLE
;
1250 /* Don't do a long sleep inside a workqueue routine */
1251 if (type
== HUB_INIT2
) {
1252 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1253 queue_delayed_work(system_power_efficient_wq
,
1255 msecs_to_jiffies(delay
));
1256 device_unlock(&hdev
->dev
);
1257 return; /* Continues at init3: below */
1265 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1267 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1268 if (hub
->has_indicators
&& blinkenlights
)
1269 queue_delayed_work(system_power_efficient_wq
,
1270 &hub
->leds
, LED_CYCLE_PERIOD
);
1272 /* Scan all ports that need attention */
1275 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1276 /* Allow autosuspend if it was suppressed */
1278 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1279 device_unlock(&hdev
->dev
);
1282 kref_put(&hub
->kref
, hub_release
);
1285 /* Implement the continuations for the delays above */
1286 static void hub_init_func2(struct work_struct
*ws
)
1288 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1290 hub_activate(hub
, HUB_INIT2
);
1293 static void hub_init_func3(struct work_struct
*ws
)
1295 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1297 hub_activate(hub
, HUB_INIT3
);
1300 enum hub_quiescing_type
{
1301 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1304 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1306 struct usb_device
*hdev
= hub
->hdev
;
1307 unsigned long flags
;
1310 /* hub_wq and related activity won't re-trigger */
1311 spin_lock_irqsave(&hub
->irq_urb_lock
, flags
);
1313 spin_unlock_irqrestore(&hub
->irq_urb_lock
, flags
);
1315 if (type
!= HUB_SUSPEND
) {
1316 /* Disconnect all the children */
1317 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1318 if (hub
->ports
[i
]->child
)
1319 usb_disconnect(&hub
->ports
[i
]->child
);
1323 /* Stop hub_wq and related activity */
1324 del_timer_sync(&hub
->irq_urb_retry
);
1325 usb_kill_urb(hub
->urb
);
1326 if (hub
->has_indicators
)
1327 cancel_delayed_work_sync(&hub
->leds
);
1329 flush_work(&hub
->tt
.clear_work
);
1332 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1336 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1337 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1340 /* caller has locked the hub device */
1341 static int hub_pre_reset(struct usb_interface
*intf
)
1343 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1345 hub_quiesce(hub
, HUB_PRE_RESET
);
1347 hub_pm_barrier_for_all_ports(hub
);
1351 /* caller has locked the hub device */
1352 static int hub_post_reset(struct usb_interface
*intf
)
1354 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1357 hub_pm_barrier_for_all_ports(hub
);
1358 hub_activate(hub
, HUB_POST_RESET
);
1362 static int hub_configure(struct usb_hub
*hub
,
1363 struct usb_endpoint_descriptor
*endpoint
)
1365 struct usb_hcd
*hcd
;
1366 struct usb_device
*hdev
= hub
->hdev
;
1367 struct device
*hub_dev
= hub
->intfdev
;
1368 u16 hubstatus
, hubchange
;
1369 u16 wHubCharacteristics
;
1372 char *message
= "out of memory";
1377 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1383 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1388 mutex_init(&hub
->status_mutex
);
1390 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1391 if (!hub
->descriptor
) {
1396 /* Request the entire hub descriptor.
1397 * hub->descriptor can handle USB_MAXCHILDREN ports,
1398 * but a (non-SS) hub can/will return fewer bytes here.
1400 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1402 message
= "can't read hub descriptor";
1406 maxchild
= USB_MAXCHILDREN
;
1407 if (hub_is_superspeed(hdev
))
1408 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1410 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1411 message
= "hub has too many ports!";
1414 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1415 message
= "hub doesn't have any ports!";
1421 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1422 * The resulting value will be used for SetIsochDelay() request.
1424 if (hub_is_superspeed(hdev
) || hub_is_superspeedplus(hdev
)) {
1425 u32 delay
= __le16_to_cpu(hub
->descriptor
->u
.ss
.wHubDelay
);
1428 delay
+= hdev
->parent
->hub_delay
;
1430 delay
+= USB_TP_TRANSMISSION_DELAY
;
1431 hdev
->hub_delay
= min_t(u32
, delay
, USB_TP_TRANSMISSION_DELAY_MAX
);
1434 maxchild
= hub
->descriptor
->bNbrPorts
;
1435 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1436 (maxchild
== 1) ? "" : "s");
1438 hub
->ports
= kcalloc(maxchild
, sizeof(struct usb_port
*), GFP_KERNEL
);
1444 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1445 if (hub_is_superspeed(hdev
)) {
1453 /* FIXME for USB 3.0, skip for now */
1454 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1455 !(hub_is_superspeed(hdev
))) {
1456 char portstr
[USB_MAXCHILDREN
+ 1];
1458 for (i
= 0; i
< maxchild
; i
++)
1459 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1460 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1462 portstr
[maxchild
] = 0;
1463 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1465 dev_dbg(hub_dev
, "standalone hub\n");
1467 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1468 case HUB_CHAR_COMMON_LPSM
:
1469 dev_dbg(hub_dev
, "ganged power switching\n");
1471 case HUB_CHAR_INDV_PORT_LPSM
:
1472 dev_dbg(hub_dev
, "individual port power switching\n");
1474 case HUB_CHAR_NO_LPSM
:
1476 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1480 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1481 case HUB_CHAR_COMMON_OCPM
:
1482 dev_dbg(hub_dev
, "global over-current protection\n");
1484 case HUB_CHAR_INDV_PORT_OCPM
:
1485 dev_dbg(hub_dev
, "individual port over-current protection\n");
1487 case HUB_CHAR_NO_OCPM
:
1489 dev_dbg(hub_dev
, "no over-current protection\n");
1493 spin_lock_init(&hub
->tt
.lock
);
1494 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1495 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1496 switch (hdev
->descriptor
.bDeviceProtocol
) {
1499 case USB_HUB_PR_HS_SINGLE_TT
:
1500 dev_dbg(hub_dev
, "Single TT\n");
1503 case USB_HUB_PR_HS_MULTI_TT
:
1504 ret
= usb_set_interface(hdev
, 0, 1);
1506 dev_dbg(hub_dev
, "TT per port\n");
1509 dev_err(hub_dev
, "Using single TT (err %d)\n",
1514 /* USB 3.0 hubs don't have a TT */
1517 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1518 hdev
->descriptor
.bDeviceProtocol
);
1522 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1523 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1524 case HUB_TTTT_8_BITS
:
1525 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1526 hub
->tt
.think_time
= 666;
1527 dev_dbg(hub_dev
, "TT requires at most %d "
1528 "FS bit times (%d ns)\n",
1529 8, hub
->tt
.think_time
);
1532 case HUB_TTTT_16_BITS
:
1533 hub
->tt
.think_time
= 666 * 2;
1534 dev_dbg(hub_dev
, "TT requires at most %d "
1535 "FS bit times (%d ns)\n",
1536 16, hub
->tt
.think_time
);
1538 case HUB_TTTT_24_BITS
:
1539 hub
->tt
.think_time
= 666 * 3;
1540 dev_dbg(hub_dev
, "TT requires at most %d "
1541 "FS bit times (%d ns)\n",
1542 24, hub
->tt
.think_time
);
1544 case HUB_TTTT_32_BITS
:
1545 hub
->tt
.think_time
= 666 * 4;
1546 dev_dbg(hub_dev
, "TT requires at most %d "
1547 "FS bit times (%d ns)\n",
1548 32, hub
->tt
.think_time
);
1552 /* probe() zeroes hub->indicator[] */
1553 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1554 hub
->has_indicators
= 1;
1555 dev_dbg(hub_dev
, "Port indicators are supported\n");
1558 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1559 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1561 /* power budgeting mostly matters with bus-powered hubs,
1562 * and battery-powered root hubs (may provide just 8 mA).
1564 ret
= usb_get_std_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1566 message
= "can't get hub status";
1569 hcd
= bus_to_hcd(hdev
->bus
);
1570 if (hdev
== hdev
->bus
->root_hub
) {
1571 if (hcd
->power_budget
> 0)
1572 hdev
->bus_mA
= hcd
->power_budget
;
1574 hdev
->bus_mA
= full_load
* maxchild
;
1575 if (hdev
->bus_mA
>= full_load
)
1576 hub
->mA_per_port
= full_load
;
1578 hub
->mA_per_port
= hdev
->bus_mA
;
1579 hub
->limited_power
= 1;
1581 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1582 int remaining
= hdev
->bus_mA
-
1583 hub
->descriptor
->bHubContrCurrent
;
1585 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1586 hub
->descriptor
->bHubContrCurrent
);
1587 hub
->limited_power
= 1;
1589 if (remaining
< maxchild
* unit_load
)
1591 "insufficient power available "
1592 "to use all downstream ports\n");
1593 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1595 } else { /* Self-powered external hub */
1596 /* FIXME: What about battery-powered external hubs that
1597 * provide less current per port? */
1598 hub
->mA_per_port
= full_load
;
1600 if (hub
->mA_per_port
< full_load
)
1601 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1604 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1606 message
= "can't get hub status";
1610 /* local power status reports aren't always correct */
1611 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1612 dev_dbg(hub_dev
, "local power source is %s\n",
1613 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1614 ? "lost (inactive)" : "good");
1616 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1617 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1618 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1620 /* set up the interrupt endpoint
1621 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1622 * bytes as USB2.0[11.12.3] says because some hubs are known
1623 * to send more data (and thus cause overflow). For root hubs,
1624 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1625 * to be big enough for at least USB_MAXCHILDREN ports. */
1626 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1627 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1629 if (maxp
> sizeof(*hub
->buffer
))
1630 maxp
= sizeof(*hub
->buffer
);
1632 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1638 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1639 hub
, endpoint
->bInterval
);
1641 /* maybe cycle the hub leds */
1642 if (hub
->has_indicators
&& blinkenlights
)
1643 hub
->indicator
[0] = INDICATOR_CYCLE
;
1645 mutex_lock(&usb_port_peer_mutex
);
1646 for (i
= 0; i
< maxchild
; i
++) {
1647 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1649 dev_err(hub
->intfdev
,
1650 "couldn't create port%d device.\n", i
+ 1);
1655 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1656 struct usb_port
*port_dev
= hub
->ports
[i
];
1658 pm_runtime_put(&port_dev
->dev
);
1661 mutex_unlock(&usb_port_peer_mutex
);
1665 /* Update the HCD's internal representation of this hub before hub_wq
1666 * starts getting port status changes for devices under the hub.
1668 if (hcd
->driver
->update_hub_device
) {
1669 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1670 &hub
->tt
, GFP_KERNEL
);
1672 message
= "can't update HCD hub info";
1677 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1679 hub_activate(hub
, HUB_INIT
);
1683 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1685 /* hub_disconnect() frees urb and descriptor */
1689 static void hub_release(struct kref
*kref
)
1691 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1693 usb_put_dev(hub
->hdev
);
1694 usb_put_intf(to_usb_interface(hub
->intfdev
));
1698 static unsigned highspeed_hubs
;
1700 static void hub_disconnect(struct usb_interface
*intf
)
1702 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1703 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1707 * Stop adding new hub events. We do not want to block here and thus
1708 * will not try to remove any pending work item.
1710 hub
->disconnected
= 1;
1712 /* Disconnect all children and quiesce the hub */
1714 hub_quiesce(hub
, HUB_DISCONNECT
);
1716 mutex_lock(&usb_port_peer_mutex
);
1718 /* Avoid races with recursively_mark_NOTATTACHED() */
1719 spin_lock_irq(&device_state_lock
);
1720 port1
= hdev
->maxchild
;
1722 usb_set_intfdata(intf
, NULL
);
1723 spin_unlock_irq(&device_state_lock
);
1725 for (; port1
> 0; --port1
)
1726 usb_hub_remove_port_device(hub
, port1
);
1728 mutex_unlock(&usb_port_peer_mutex
);
1730 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1733 usb_free_urb(hub
->urb
);
1735 kfree(hub
->descriptor
);
1739 pm_suspend_ignore_children(&intf
->dev
, false);
1741 if (hub
->quirk_disable_autosuspend
)
1742 usb_autopm_put_interface(intf
);
1744 kref_put(&hub
->kref
, hub_release
);
1747 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1749 /* Some hubs have a subclass of 1, which AFAICT according to the */
1750 /* specs is not defined, but it works */
1751 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1752 desc
->desc
.bInterfaceSubClass
!= 1)
1755 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1756 if (desc
->desc
.bNumEndpoints
!= 1)
1759 /* If the first endpoint is not interrupt IN, we'd better punt! */
1760 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1766 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1768 struct usb_host_interface
*desc
;
1769 struct usb_device
*hdev
;
1770 struct usb_hub
*hub
;
1772 desc
= intf
->cur_altsetting
;
1773 hdev
= interface_to_usbdev(intf
);
1776 * Set default autosuspend delay as 0 to speedup bus suspend,
1777 * based on the below considerations:
1779 * - Unlike other drivers, the hub driver does not rely on the
1780 * autosuspend delay to provide enough time to handle a wakeup
1781 * event, and the submitted status URB is just to check future
1782 * change on hub downstream ports, so it is safe to do it.
1784 * - The patch might cause one or more auto supend/resume for
1785 * below very rare devices when they are plugged into hub
1788 * devices having trouble initializing, and disconnect
1789 * themselves from the bus and then reconnect a second
1792 * devices just for downloading firmware, and disconnects
1793 * themselves after completing it
1795 * For these quite rare devices, their drivers may change the
1796 * autosuspend delay of their parent hub in the probe() to one
1797 * appropriate value to avoid the subtle problem if someone
1800 * - The patch may cause one or more auto suspend/resume on
1801 * hub during running 'lsusb', but it is probably too
1802 * infrequent to worry about.
1804 * - Change autosuspend delay of hub can avoid unnecessary auto
1805 * suspend timer for hub, also may decrease power consumption
1808 * - If user has indicated to prevent autosuspend by passing
1809 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1812 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1813 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1817 * Hubs have proper suspend/resume support, except for root hubs
1818 * where the controller driver doesn't have bus_suspend and
1819 * bus_resume methods.
1821 if (hdev
->parent
) { /* normal device */
1822 usb_enable_autosuspend(hdev
);
1823 } else { /* root hub */
1824 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1826 if (drv
->bus_suspend
&& drv
->bus_resume
)
1827 usb_enable_autosuspend(hdev
);
1830 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1832 "Unsupported bus topology: hub nested too deep\n");
1836 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1838 dev_warn(&intf
->dev
, "ignoring external hub\n");
1843 if (!hub_descriptor_is_sane(desc
)) {
1844 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1848 /* We found a hub */
1849 dev_info(&intf
->dev
, "USB hub found\n");
1851 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1855 kref_init(&hub
->kref
);
1856 hub
->intfdev
= &intf
->dev
;
1858 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1859 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1860 INIT_WORK(&hub
->events
, hub_event
);
1861 spin_lock_init(&hub
->irq_urb_lock
);
1862 timer_setup(&hub
->irq_urb_retry
, hub_retry_irq_urb
, 0);
1866 usb_set_intfdata(intf
, hub
);
1867 intf
->needs_remote_wakeup
= 1;
1868 pm_suspend_ignore_children(&intf
->dev
, true);
1870 if (hdev
->speed
== USB_SPEED_HIGH
)
1873 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1874 hub
->quirk_check_port_auto_suspend
= 1;
1876 if (id
->driver_info
& HUB_QUIRK_DISABLE_AUTOSUSPEND
) {
1877 hub
->quirk_disable_autosuspend
= 1;
1878 usb_autopm_get_interface_no_resume(intf
);
1881 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0)
1884 hub_disconnect(intf
);
1889 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1891 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1892 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1894 /* assert ifno == 0 (part of hub spec) */
1896 case USBDEVFS_HUB_PORTINFO
: {
1897 struct usbdevfs_hub_portinfo
*info
= user_data
;
1900 spin_lock_irq(&device_state_lock
);
1901 if (hdev
->devnum
<= 0)
1904 info
->nports
= hdev
->maxchild
;
1905 for (i
= 0; i
< info
->nports
; i
++) {
1906 if (hub
->ports
[i
]->child
== NULL
)
1910 hub
->ports
[i
]->child
->devnum
;
1913 spin_unlock_irq(&device_state_lock
);
1915 return info
->nports
+ 1;
1924 * Allow user programs to claim ports on a hub. When a device is attached
1925 * to one of these "claimed" ports, the program will "own" the device.
1927 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1928 struct usb_dev_state
***ppowner
)
1930 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1932 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1934 if (port1
== 0 || port1
> hdev
->maxchild
)
1937 /* Devices not managed by the hub driver
1938 * will always have maxchild equal to 0.
1940 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1944 /* In the following three functions, the caller must hold hdev's lock */
1945 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1946 struct usb_dev_state
*owner
)
1949 struct usb_dev_state
**powner
;
1951 rc
= find_port_owner(hdev
, port1
, &powner
);
1959 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1961 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1962 struct usb_dev_state
*owner
)
1965 struct usb_dev_state
**powner
;
1967 rc
= find_port_owner(hdev
, port1
, &powner
);
1970 if (*powner
!= owner
)
1975 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1977 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1979 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1982 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1983 if (hub
->ports
[n
]->port_owner
== owner
)
1984 hub
->ports
[n
]->port_owner
= NULL
;
1989 /* The caller must hold udev's lock */
1990 bool usb_device_is_owned(struct usb_device
*udev
)
1992 struct usb_hub
*hub
;
1994 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1996 hub
= usb_hub_to_struct_hub(udev
->parent
);
1997 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
2000 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
2002 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2005 for (i
= 0; i
< udev
->maxchild
; ++i
) {
2006 if (hub
->ports
[i
]->child
)
2007 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
2009 if (udev
->state
== USB_STATE_SUSPENDED
)
2010 udev
->active_duration
-= jiffies
;
2011 udev
->state
= USB_STATE_NOTATTACHED
;
2015 * usb_set_device_state - change a device's current state (usbcore, hcds)
2016 * @udev: pointer to device whose state should be changed
2017 * @new_state: new state value to be stored
2019 * udev->state is _not_ fully protected by the device lock. Although
2020 * most transitions are made only while holding the lock, the state can
2021 * can change to USB_STATE_NOTATTACHED at almost any time. This
2022 * is so that devices can be marked as disconnected as soon as possible,
2023 * without having to wait for any semaphores to be released. As a result,
2024 * all changes to any device's state must be protected by the
2025 * device_state_lock spinlock.
2027 * Once a device has been added to the device tree, all changes to its state
2028 * should be made using this routine. The state should _not_ be set directly.
2030 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2031 * Otherwise udev->state is set to new_state, and if new_state is
2032 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2033 * to USB_STATE_NOTATTACHED.
2035 void usb_set_device_state(struct usb_device
*udev
,
2036 enum usb_device_state new_state
)
2038 unsigned long flags
;
2041 spin_lock_irqsave(&device_state_lock
, flags
);
2042 if (udev
->state
== USB_STATE_NOTATTACHED
)
2044 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2046 /* root hub wakeup capabilities are managed out-of-band
2047 * and may involve silicon errata ... ignore them here.
2050 if (udev
->state
== USB_STATE_SUSPENDED
2051 || new_state
== USB_STATE_SUSPENDED
)
2052 ; /* No change to wakeup settings */
2053 else if (new_state
== USB_STATE_CONFIGURED
)
2054 wakeup
= (udev
->quirks
&
2055 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
2056 udev
->actconfig
->desc
.bmAttributes
&
2057 USB_CONFIG_ATT_WAKEUP
;
2061 if (udev
->state
== USB_STATE_SUSPENDED
&&
2062 new_state
!= USB_STATE_SUSPENDED
)
2063 udev
->active_duration
-= jiffies
;
2064 else if (new_state
== USB_STATE_SUSPENDED
&&
2065 udev
->state
!= USB_STATE_SUSPENDED
)
2066 udev
->active_duration
+= jiffies
;
2067 udev
->state
= new_state
;
2069 recursively_mark_NOTATTACHED(udev
);
2070 spin_unlock_irqrestore(&device_state_lock
, flags
);
2072 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2074 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2077 * Choose a device number.
2079 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2080 * USB-2.0 buses they are also used as device addresses, however on
2081 * USB-3.0 buses the address is assigned by the controller hardware
2082 * and it usually is not the same as the device number.
2084 * WUSB devices are simple: they have no hubs behind, so the mapping
2085 * device <-> virtual port number becomes 1:1. Why? to simplify the
2086 * life of the device connection logic in
2087 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2088 * handshake we need to assign a temporary address in the unauthorized
2089 * space. For simplicity we use the first virtual port number found to
2090 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2091 * and that becomes it's address [X < 128] or its unauthorized address
2094 * We add 1 as an offset to the one-based USB-stack port number
2095 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2096 * 0 is reserved by USB for default address; (b) Linux's USB stack
2097 * uses always #1 for the root hub of the controller. So USB stack's
2098 * port #1, which is wusb virtual-port #0 has address #2.
2100 * Devices connected under xHCI are not as simple. The host controller
2101 * supports virtualization, so the hardware assigns device addresses and
2102 * the HCD must setup data structures before issuing a set address
2103 * command to the hardware.
2105 static void choose_devnum(struct usb_device
*udev
)
2108 struct usb_bus
*bus
= udev
->bus
;
2110 /* be safe when more hub events are proceed in parallel */
2111 mutex_lock(&bus
->devnum_next_mutex
);
2113 devnum
= udev
->portnum
+ 1;
2114 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2116 /* Try to allocate the next devnum beginning at
2117 * bus->devnum_next. */
2118 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2121 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2123 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2126 set_bit(devnum
, bus
->devmap
.devicemap
);
2127 udev
->devnum
= devnum
;
2129 mutex_unlock(&bus
->devnum_next_mutex
);
2132 static void release_devnum(struct usb_device
*udev
)
2134 if (udev
->devnum
> 0) {
2135 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2140 static void update_devnum(struct usb_device
*udev
, int devnum
)
2142 /* The address for a WUSB device is managed by wusbcore. */
2144 udev
->devnum
= devnum
;
2146 udev
->devaddr
= (u8
)devnum
;
2149 static void hub_free_dev(struct usb_device
*udev
)
2151 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2153 /* Root hubs aren't real devices, so don't free HCD resources */
2154 if (hcd
->driver
->free_dev
&& udev
->parent
)
2155 hcd
->driver
->free_dev(hcd
, udev
);
2158 static void hub_disconnect_children(struct usb_device
*udev
)
2160 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2163 /* Free up all the children before we remove this device */
2164 for (i
= 0; i
< udev
->maxchild
; i
++) {
2165 if (hub
->ports
[i
]->child
)
2166 usb_disconnect(&hub
->ports
[i
]->child
);
2171 * usb_disconnect - disconnect a device (usbcore-internal)
2172 * @pdev: pointer to device being disconnected
2173 * Context: !in_interrupt ()
2175 * Something got disconnected. Get rid of it and all of its children.
2177 * If *pdev is a normal device then the parent hub must already be locked.
2178 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2179 * which protects the set of root hubs as well as the list of buses.
2181 * Only hub drivers (including virtual root hub drivers for host
2182 * controllers) should ever call this.
2184 * This call is synchronous, and may not be used in an interrupt context.
2186 void usb_disconnect(struct usb_device
**pdev
)
2188 struct usb_port
*port_dev
= NULL
;
2189 struct usb_device
*udev
= *pdev
;
2190 struct usb_hub
*hub
= NULL
;
2193 /* mark the device as inactive, so any further urb submissions for
2194 * this device (and any of its children) will fail immediately.
2195 * this quiesces everything except pending urbs.
2197 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2198 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2202 * Ensure that the pm runtime code knows that the USB device
2203 * is in the process of being disconnected.
2205 pm_runtime_barrier(&udev
->dev
);
2207 usb_lock_device(udev
);
2209 hub_disconnect_children(udev
);
2211 /* deallocate hcd/hardware state ... nuking all pending urbs and
2212 * cleaning up all state associated with the current configuration
2213 * so that the hardware is now fully quiesced.
2215 dev_dbg(&udev
->dev
, "unregistering device\n");
2216 usb_disable_device(udev
, 0);
2217 usb_hcd_synchronize_unlinks(udev
);
2220 port1
= udev
->portnum
;
2221 hub
= usb_hub_to_struct_hub(udev
->parent
);
2222 port_dev
= hub
->ports
[port1
- 1];
2224 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2225 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2228 * As usb_port_runtime_resume() de-references udev, make
2229 * sure no resumes occur during removal
2231 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2232 pm_runtime_get_sync(&port_dev
->dev
);
2235 usb_remove_ep_devs(&udev
->ep0
);
2236 usb_unlock_device(udev
);
2238 /* Unregister the device. The device driver is responsible
2239 * for de-configuring the device and invoking the remove-device
2240 * notifier chain (used by usbfs and possibly others).
2242 device_del(&udev
->dev
);
2244 /* Free the device number and delete the parent's children[]
2245 * (or root_hub) pointer.
2247 release_devnum(udev
);
2249 /* Avoid races with recursively_mark_NOTATTACHED() */
2250 spin_lock_irq(&device_state_lock
);
2252 spin_unlock_irq(&device_state_lock
);
2254 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2255 pm_runtime_put(&port_dev
->dev
);
2259 put_device(&udev
->dev
);
2262 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2263 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2267 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2270 static void announce_device(struct usb_device
*udev
)
2272 u16 bcdDevice
= le16_to_cpu(udev
->descriptor
.bcdDevice
);
2274 dev_info(&udev
->dev
,
2275 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2276 le16_to_cpu(udev
->descriptor
.idVendor
),
2277 le16_to_cpu(udev
->descriptor
.idProduct
),
2278 bcdDevice
>> 8, bcdDevice
& 0xff);
2279 dev_info(&udev
->dev
,
2280 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2281 udev
->descriptor
.iManufacturer
,
2282 udev
->descriptor
.iProduct
,
2283 udev
->descriptor
.iSerialNumber
);
2284 show_string(udev
, "Product", udev
->product
);
2285 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2286 show_string(udev
, "SerialNumber", udev
->serial
);
2289 static inline void announce_device(struct usb_device
*udev
) { }
2294 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2295 * @udev: newly addressed device (in ADDRESS state)
2297 * Finish enumeration for On-The-Go devices
2299 * Return: 0 if successful. A negative error code otherwise.
2301 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2305 #ifdef CONFIG_USB_OTG
2307 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2308 * to wake us after we've powered off VBUS; and HNP, switching roles
2309 * "host" to "peripheral". The OTG descriptor helps figure this out.
2311 if (!udev
->bus
->is_b_host
2313 && udev
->parent
== udev
->bus
->root_hub
) {
2314 struct usb_otg_descriptor
*desc
= NULL
;
2315 struct usb_bus
*bus
= udev
->bus
;
2316 unsigned port1
= udev
->portnum
;
2318 /* descriptor may appear anywhere in config */
2319 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2320 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2321 USB_DT_OTG
, (void **) &desc
, sizeof(*desc
));
2322 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2325 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2326 (port1
== bus
->otg_port
) ? "" : "non-");
2328 /* enable HNP before suspend, it's simpler */
2329 if (port1
== bus
->otg_port
) {
2330 bus
->b_hnp_enable
= 1;
2331 err
= usb_control_msg(udev
,
2332 usb_sndctrlpipe(udev
, 0),
2333 USB_REQ_SET_FEATURE
, 0,
2334 USB_DEVICE_B_HNP_ENABLE
,
2336 USB_CTRL_SET_TIMEOUT
);
2339 * OTG MESSAGE: report errors here,
2340 * customize to match your product.
2342 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2344 bus
->b_hnp_enable
= 0;
2346 } else if (desc
->bLength
== sizeof
2347 (struct usb_otg_descriptor
)) {
2348 /* Set a_alt_hnp_support for legacy otg device */
2349 err
= usb_control_msg(udev
,
2350 usb_sndctrlpipe(udev
, 0),
2351 USB_REQ_SET_FEATURE
, 0,
2352 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2354 USB_CTRL_SET_TIMEOUT
);
2357 "set a_alt_hnp_support failed: %d\n",
2367 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2368 * @udev: newly addressed device (in ADDRESS state)
2370 * This is only called by usb_new_device() and usb_authorize_device()
2371 * and FIXME -- all comments that apply to them apply here wrt to
2374 * If the device is WUSB and not authorized, we don't attempt to read
2375 * the string descriptors, as they will be errored out by the device
2376 * until it has been authorized.
2378 * Return: 0 if successful. A negative error code otherwise.
2380 static int usb_enumerate_device(struct usb_device
*udev
)
2383 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2385 if (udev
->config
== NULL
) {
2386 err
= usb_get_configuration(udev
);
2389 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2395 /* read the standard strings and cache them if present */
2396 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2397 udev
->manufacturer
= usb_cache_string(udev
,
2398 udev
->descriptor
.iManufacturer
);
2399 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2401 err
= usb_enumerate_device_otg(udev
);
2405 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2406 !is_targeted(udev
)) {
2407 /* Maybe it can talk to us, though we can't talk to it.
2408 * (Includes HNP test device.)
2410 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2411 || udev
->bus
->is_b_host
)) {
2412 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2414 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2419 usb_detect_interface_quirks(udev
);
2424 static void set_usb_port_removable(struct usb_device
*udev
)
2426 struct usb_device
*hdev
= udev
->parent
;
2427 struct usb_hub
*hub
;
2428 u8 port
= udev
->portnum
;
2429 u16 wHubCharacteristics
;
2430 bool removable
= true;
2435 hub
= usb_hub_to_struct_hub(udev
->parent
);
2438 * If the platform firmware has provided information about a port,
2439 * use that to determine whether it's removable.
2441 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2442 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2443 udev
->removable
= USB_DEVICE_REMOVABLE
;
2445 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2446 case USB_PORT_NOT_USED
:
2447 udev
->removable
= USB_DEVICE_FIXED
;
2454 * Otherwise, check whether the hub knows whether a port is removable
2457 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2459 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2462 if (hub_is_superspeed(hdev
)) {
2463 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2467 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2472 udev
->removable
= USB_DEVICE_REMOVABLE
;
2474 udev
->removable
= USB_DEVICE_FIXED
;
2479 * usb_new_device - perform initial device setup (usbcore-internal)
2480 * @udev: newly addressed device (in ADDRESS state)
2482 * This is called with devices which have been detected but not fully
2483 * enumerated. The device descriptor is available, but not descriptors
2484 * for any device configuration. The caller must have locked either
2485 * the parent hub (if udev is a normal device) or else the
2486 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2487 * udev has already been installed, but udev is not yet visible through
2488 * sysfs or other filesystem code.
2490 * This call is synchronous, and may not be used in an interrupt context.
2492 * Only the hub driver or root-hub registrar should ever call this.
2494 * Return: Whether the device is configured properly or not. Zero if the
2495 * interface was registered with the driver core; else a negative errno
2499 int usb_new_device(struct usb_device
*udev
)
2504 /* Initialize non-root-hub device wakeup to disabled;
2505 * device (un)configuration controls wakeup capable
2506 * sysfs power/wakeup controls wakeup enabled/disabled
2508 device_init_wakeup(&udev
->dev
, 0);
2511 /* Tell the runtime-PM framework the device is active */
2512 pm_runtime_set_active(&udev
->dev
);
2513 pm_runtime_get_noresume(&udev
->dev
);
2514 pm_runtime_use_autosuspend(&udev
->dev
);
2515 pm_runtime_enable(&udev
->dev
);
2517 /* By default, forbid autosuspend for all devices. It will be
2518 * allowed for hubs during binding.
2520 usb_disable_autosuspend(udev
);
2522 err
= usb_enumerate_device(udev
); /* Read descriptors */
2525 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2526 udev
->devnum
, udev
->bus
->busnum
,
2527 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2528 /* export the usbdev device-node for libusb */
2529 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2530 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2532 /* Tell the world! */
2533 announce_device(udev
);
2536 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2538 add_device_randomness(udev
->product
, strlen(udev
->product
));
2539 if (udev
->manufacturer
)
2540 add_device_randomness(udev
->manufacturer
,
2541 strlen(udev
->manufacturer
));
2543 device_enable_async_suspend(&udev
->dev
);
2545 /* check whether the hub or firmware marks this port as non-removable */
2547 set_usb_port_removable(udev
);
2549 /* Register the device. The device driver is responsible
2550 * for configuring the device and invoking the add-device
2551 * notifier chain (used by usbfs and possibly others).
2553 err
= device_add(&udev
->dev
);
2555 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2559 /* Create link files between child device and usb port device. */
2561 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2562 int port1
= udev
->portnum
;
2563 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2565 err
= sysfs_create_link(&udev
->dev
.kobj
,
2566 &port_dev
->dev
.kobj
, "port");
2570 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2571 &udev
->dev
.kobj
, "device");
2573 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2577 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2578 pm_runtime_get_sync(&port_dev
->dev
);
2581 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2582 usb_mark_last_busy(udev
);
2583 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2587 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2588 pm_runtime_disable(&udev
->dev
);
2589 pm_runtime_set_suspended(&udev
->dev
);
2595 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2596 * @usb_dev: USB device
2598 * Move the USB device to a very basic state where interfaces are disabled
2599 * and the device is in fact unconfigured and unusable.
2601 * We share a lock (that we have) with device_del(), so we need to
2606 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2608 usb_lock_device(usb_dev
);
2609 if (usb_dev
->authorized
== 0)
2610 goto out_unauthorized
;
2612 usb_dev
->authorized
= 0;
2613 usb_set_configuration(usb_dev
, -1);
2616 usb_unlock_device(usb_dev
);
2621 int usb_authorize_device(struct usb_device
*usb_dev
)
2625 usb_lock_device(usb_dev
);
2626 if (usb_dev
->authorized
== 1)
2627 goto out_authorized
;
2629 result
= usb_autoresume_device(usb_dev
);
2631 dev_err(&usb_dev
->dev
,
2632 "can't autoresume for authorization: %d\n", result
);
2633 goto error_autoresume
;
2636 if (usb_dev
->wusb
) {
2637 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2639 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2640 "authorization: %d\n", result
);
2641 goto error_device_descriptor
;
2645 usb_dev
->authorized
= 1;
2646 /* Choose and set the configuration. This registers the interfaces
2647 * with the driver core and lets interface drivers bind to them.
2649 c
= usb_choose_configuration(usb_dev
);
2651 result
= usb_set_configuration(usb_dev
, c
);
2653 dev_err(&usb_dev
->dev
,
2654 "can't set config #%d, error %d\n", c
, result
);
2655 /* This need not be fatal. The user can try to
2656 * set other configurations. */
2659 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2661 error_device_descriptor
:
2662 usb_autosuspend_device(usb_dev
);
2665 usb_unlock_device(usb_dev
); /* complements locktree */
2670 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2671 * check it from the link protocol field of the current speed ID attribute.
2672 * current speed ID is got from ext port status request. Sublink speed attribute
2673 * table is returned with the hub BOS SSP device capability descriptor
2675 static int port_speed_is_ssp(struct usb_device
*hdev
, int speed_id
)
2680 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2685 ssa_count
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2686 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2688 for (i
= 0; i
<= ssa_count
; i
++) {
2689 ss_attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2690 if (speed_id
== (ss_attr
& USB_SSP_SUBLINK_SPEED_SSID
))
2691 return !!(ss_attr
& USB_SSP_SUBLINK_SPEED_LP
);
2696 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2697 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2699 struct usb_hcd
*hcd
;
2700 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2702 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2703 return hcd
->wireless
;
2707 #define PORT_RESET_TRIES 5
2708 #define SET_ADDRESS_TRIES 2
2709 #define GET_DESCRIPTOR_TRIES 2
2710 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2711 #define USE_NEW_SCHEME(i, scheme) ((i) / 2 == (int)(scheme))
2713 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2714 #define HUB_SHORT_RESET_TIME 10
2715 #define HUB_BH_RESET_TIME 50
2716 #define HUB_LONG_RESET_TIME 200
2717 #define HUB_RESET_TIMEOUT 800
2720 * "New scheme" enumeration causes an extra state transition to be
2721 * exposed to an xhci host and causes USB3 devices to receive control
2722 * commands in the default state. This has been seen to cause
2723 * enumeration failures, so disable this enumeration scheme for USB3
2726 static bool use_new_scheme(struct usb_device
*udev
, int retry
,
2727 struct usb_port
*port_dev
)
2729 int old_scheme_first_port
=
2730 port_dev
->quirks
& USB_PORT_QUIRK_OLD_SCHEME
;
2732 if (udev
->speed
>= USB_SPEED_SUPER
)
2735 return USE_NEW_SCHEME(retry
, old_scheme_first_port
|| old_scheme_first
);
2738 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2739 * Port warm reset is required to recover
2741 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2746 if (!hub_is_superspeed(hub
->hdev
))
2749 if (test_bit(port1
, hub
->warm_reset_bits
))
2752 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2753 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2754 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2757 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2758 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2760 int delay_time
, ret
;
2763 u32 ext_portstatus
= 0;
2765 for (delay_time
= 0;
2766 delay_time
< HUB_RESET_TIMEOUT
;
2767 delay_time
+= delay
) {
2768 /* wait to give the device a chance to reset */
2771 /* read and decode port status */
2772 if (hub_is_superspeedplus(hub
->hdev
))
2773 ret
= hub_ext_port_status(hub
, port1
,
2774 HUB_EXT_PORT_STATUS
,
2775 &portstatus
, &portchange
,
2778 ret
= hub_port_status(hub
, port1
, &portstatus
,
2784 * The port state is unknown until the reset completes.
2786 * On top of that, some chips may require additional time
2787 * to re-establish a connection after the reset is complete,
2788 * so also wait for the connection to be re-established.
2790 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2791 (portstatus
& USB_PORT_STAT_CONNECTION
))
2794 /* switch to the long delay after two short delay failures */
2795 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2796 delay
= HUB_LONG_RESET_TIME
;
2798 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2799 "not %sreset yet, waiting %dms\n",
2800 warm
? "warm " : "", delay
);
2803 if ((portstatus
& USB_PORT_STAT_RESET
))
2806 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2809 /* Device went away? */
2810 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2813 /* Retry if connect change is set but status is still connected.
2814 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2815 * but the device may have successfully re-connected. Ignore it.
2817 if (!hub_is_superspeed(hub
->hdev
) &&
2818 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2819 usb_clear_port_feature(hub
->hdev
, port1
,
2820 USB_PORT_FEAT_C_CONNECTION
);
2824 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2830 if (hub_is_superspeedplus(hub
->hdev
)) {
2831 /* extended portstatus Rx and Tx lane count are zero based */
2832 udev
->rx_lanes
= USB_EXT_PORT_RX_LANES(ext_portstatus
) + 1;
2833 udev
->tx_lanes
= USB_EXT_PORT_TX_LANES(ext_portstatus
) + 1;
2838 if (hub_is_wusb(hub
))
2839 udev
->speed
= USB_SPEED_WIRELESS
;
2840 else if (hub_is_superspeedplus(hub
->hdev
) &&
2841 port_speed_is_ssp(hub
->hdev
, ext_portstatus
&
2842 USB_EXT_PORT_STAT_RX_SPEED_ID
))
2843 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2844 else if (hub_is_superspeed(hub
->hdev
))
2845 udev
->speed
= USB_SPEED_SUPER
;
2846 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2847 udev
->speed
= USB_SPEED_HIGH
;
2848 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2849 udev
->speed
= USB_SPEED_LOW
;
2851 udev
->speed
= USB_SPEED_FULL
;
2855 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2856 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2857 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2860 u16 portchange
, portstatus
;
2861 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2862 int reset_recovery_time
;
2864 if (!hub_is_superspeed(hub
->hdev
)) {
2866 dev_err(hub
->intfdev
, "only USB3 hub support "
2870 /* Block EHCI CF initialization during the port reset.
2871 * Some companion controllers don't like it when they mix.
2873 down_read(&ehci_cf_port_reset_rwsem
);
2876 * If the caller hasn't explicitly requested a warm reset,
2877 * double check and see if one is needed.
2879 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2880 if (hub_port_warm_reset_required(hub
, port1
,
2884 clear_bit(port1
, hub
->warm_reset_bits
);
2886 /* Reset the port */
2887 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2888 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2889 USB_PORT_FEAT_BH_PORT_RESET
:
2890 USB_PORT_FEAT_RESET
));
2891 if (status
== -ENODEV
) {
2892 ; /* The hub is gone */
2893 } else if (status
) {
2894 dev_err(&port_dev
->dev
,
2895 "cannot %sreset (err = %d)\n",
2896 warm
? "warm " : "", status
);
2898 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2900 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2901 dev_dbg(hub
->intfdev
,
2902 "port_wait_reset: err = %d\n",
2906 /* Check for disconnect or reset */
2907 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2908 usb_clear_port_feature(hub
->hdev
, port1
,
2909 USB_PORT_FEAT_C_RESET
);
2911 if (!hub_is_superspeed(hub
->hdev
))
2914 usb_clear_port_feature(hub
->hdev
, port1
,
2915 USB_PORT_FEAT_C_BH_PORT_RESET
);
2916 usb_clear_port_feature(hub
->hdev
, port1
,
2917 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2920 usb_clear_port_feature(hub
->hdev
, port1
,
2921 USB_PORT_FEAT_C_CONNECTION
);
2924 * If a USB 3.0 device migrates from reset to an error
2925 * state, re-issue the warm reset.
2927 if (hub_port_status(hub
, port1
,
2928 &portstatus
, &portchange
) < 0)
2931 if (!hub_port_warm_reset_required(hub
, port1
,
2936 * If the port is in SS.Inactive or Compliance Mode, the
2937 * hot or warm reset failed. Try another warm reset.
2940 dev_dbg(&port_dev
->dev
,
2941 "hot reset failed, warm reset\n");
2946 dev_dbg(&port_dev
->dev
,
2947 "not enabled, trying %sreset again...\n",
2948 warm
? "warm " : "");
2949 delay
= HUB_LONG_RESET_TIME
;
2952 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2956 if (port_dev
->quirks
& USB_PORT_QUIRK_FAST_ENUM
)
2957 usleep_range(10000, 12000);
2959 /* TRSTRCY = 10 ms; plus some extra */
2960 reset_recovery_time
= 10 + 40;
2962 /* Hub needs extra delay after resetting its port. */
2963 if (hub
->hdev
->quirks
& USB_QUIRK_HUB_SLOW_RESET
)
2964 reset_recovery_time
+= 100;
2966 msleep(reset_recovery_time
);
2970 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2972 update_devnum(udev
, 0);
2973 /* The xHC may think the device is already reset,
2974 * so ignore the status.
2976 if (hcd
->driver
->reset_device
)
2977 hcd
->driver
->reset_device(hcd
, udev
);
2979 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2983 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2986 if (!hub_is_superspeed(hub
->hdev
))
2987 up_read(&ehci_cf_port_reset_rwsem
);
2992 /* Check if a port is power on */
2993 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2997 if (hub_is_superspeed(hub
->hdev
)) {
2998 if (portstatus
& USB_SS_PORT_STAT_POWER
)
3001 if (portstatus
& USB_PORT_STAT_POWER
)
3008 static void usb_lock_port(struct usb_port
*port_dev
)
3009 __acquires(&port_dev
->status_lock
)
3011 mutex_lock(&port_dev
->status_lock
);
3012 __acquire(&port_dev
->status_lock
);
3015 static void usb_unlock_port(struct usb_port
*port_dev
)
3016 __releases(&port_dev
->status_lock
)
3018 mutex_unlock(&port_dev
->status_lock
);
3019 __release(&port_dev
->status_lock
);
3024 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3025 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
3029 if (hub_is_superspeed(hub
->hdev
)) {
3030 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
3031 == USB_SS_PORT_LS_U3
)
3034 if (portstatus
& USB_PORT_STAT_SUSPEND
)
3041 /* Determine whether the device on a port is ready for a normal resume,
3042 * is ready for a reset-resume, or should be disconnected.
3044 static int check_port_resume_type(struct usb_device
*udev
,
3045 struct usb_hub
*hub
, int port1
,
3046 int status
, u16 portchange
, u16 portstatus
)
3048 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3052 /* Is a warm reset needed to recover the connection? */
3053 if (status
== 0 && udev
->reset_resume
3054 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
3057 /* Is the device still present? */
3058 else if (status
|| port_is_suspended(hub
, portstatus
) ||
3059 !port_is_power_on(hub
, portstatus
)) {
3062 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
3064 usleep_range(200, 300);
3065 status
= hub_port_status(hub
, port1
, &portstatus
,
3072 /* Can't do a normal resume if the port isn't enabled,
3073 * so try a reset-resume instead.
3075 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3076 if (udev
->persist_enabled
)
3077 udev
->reset_resume
= 1;
3083 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
3084 portchange
, portstatus
, status
);
3085 } else if (udev
->reset_resume
) {
3087 /* Late port handoff can set status-change bits */
3088 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3089 usb_clear_port_feature(hub
->hdev
, port1
,
3090 USB_PORT_FEAT_C_CONNECTION
);
3091 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3092 usb_clear_port_feature(hub
->hdev
, port1
,
3093 USB_PORT_FEAT_C_ENABLE
);
3096 * Whatever made this reset-resume necessary may have
3097 * turned on the port1 bit in hub->change_bits. But after
3098 * a successful reset-resume we want the bit to be clear;
3099 * if it was on it would indicate that something happened
3100 * following the reset-resume.
3102 clear_bit(port1
, hub
->change_bits
);
3108 int usb_disable_ltm(struct usb_device
*udev
)
3110 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3112 /* Check if the roothub and device supports LTM. */
3113 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3114 !usb_device_supports_ltm(udev
))
3117 /* Clear Feature LTM Enable can only be sent if the device is
3120 if (!udev
->actconfig
)
3123 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3124 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3125 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3126 USB_CTRL_SET_TIMEOUT
);
3128 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3130 void usb_enable_ltm(struct usb_device
*udev
)
3132 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3134 /* Check if the roothub and device supports LTM. */
3135 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3136 !usb_device_supports_ltm(udev
))
3139 /* Set Feature LTM Enable can only be sent if the device is
3142 if (!udev
->actconfig
)
3145 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3146 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3147 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3148 USB_CTRL_SET_TIMEOUT
);
3150 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3153 * usb_enable_remote_wakeup - enable remote wakeup for a device
3154 * @udev: target device
3156 * For USB-2 devices: Set the device's remote wakeup feature.
3158 * For USB-3 devices: Assume there's only one function on the device and
3159 * enable remote wake for the first interface. FIXME if the interface
3160 * association descriptor shows there's more than one function.
3162 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3164 if (udev
->speed
< USB_SPEED_SUPER
)
3165 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3166 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3167 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3168 USB_CTRL_SET_TIMEOUT
);
3170 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3171 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3172 USB_INTRF_FUNC_SUSPEND
,
3173 USB_INTRF_FUNC_SUSPEND_RW
|
3174 USB_INTRF_FUNC_SUSPEND_LP
,
3175 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3179 * usb_disable_remote_wakeup - disable remote wakeup for a device
3180 * @udev: target device
3182 * For USB-2 devices: Clear the device's remote wakeup feature.
3184 * For USB-3 devices: Assume there's only one function on the device and
3185 * disable remote wake for the first interface. FIXME if the interface
3186 * association descriptor shows there's more than one function.
3188 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3190 if (udev
->speed
< USB_SPEED_SUPER
)
3191 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3192 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3193 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3194 USB_CTRL_SET_TIMEOUT
);
3196 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3197 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3198 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3199 USB_CTRL_SET_TIMEOUT
);
3202 /* Count of wakeup-enabled devices at or below udev */
3203 unsigned usb_wakeup_enabled_descendants(struct usb_device
*udev
)
3205 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3207 return udev
->do_remote_wakeup
+
3208 (hub
? hub
->wakeup_enabled_descendants
: 0);
3210 EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants
);
3213 * usb_port_suspend - suspend a usb device's upstream port
3214 * @udev: device that's no longer in active use, not a root hub
3215 * Context: must be able to sleep; device not locked; pm locks held
3217 * Suspends a USB device that isn't in active use, conserving power.
3218 * Devices may wake out of a suspend, if anything important happens,
3219 * using the remote wakeup mechanism. They may also be taken out of
3220 * suspend by the host, using usb_port_resume(). It's also routine
3221 * to disconnect devices while they are suspended.
3223 * This only affects the USB hardware for a device; its interfaces
3224 * (and, for hubs, child devices) must already have been suspended.
3226 * Selective port suspend reduces power; most suspended devices draw
3227 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3228 * All devices below the suspended port are also suspended.
3230 * Devices leave suspend state when the host wakes them up. Some devices
3231 * also support "remote wakeup", where the device can activate the USB
3232 * tree above them to deliver data, such as a keypress or packet. In
3233 * some cases, this wakes the USB host.
3235 * Suspending OTG devices may trigger HNP, if that's been enabled
3236 * between a pair of dual-role devices. That will change roles, such
3237 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3239 * Devices on USB hub ports have only one "suspend" state, corresponding
3240 * to ACPI D2, "may cause the device to lose some context".
3241 * State transitions include:
3243 * - suspend, resume ... when the VBUS power link stays live
3244 * - suspend, disconnect ... VBUS lost
3246 * Once VBUS drop breaks the circuit, the port it's using has to go through
3247 * normal re-enumeration procedures, starting with enabling VBUS power.
3248 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3249 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3250 * timer, no SRP, no requests through sysfs.
3252 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3253 * suspended until their bus goes into global suspend (i.e., the root
3254 * hub is suspended). Nevertheless, we change @udev->state to
3255 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3256 * upstream port setting is stored in @udev->port_is_suspended.
3258 * Returns 0 on success, else negative errno.
3260 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3262 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3263 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3264 int port1
= udev
->portnum
;
3266 bool really_suspend
= true;
3268 usb_lock_port(port_dev
);
3270 /* enable remote wakeup when appropriate; this lets the device
3271 * wake up the upstream hub (including maybe the root hub).
3273 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3274 * we don't explicitly enable it here.
3276 if (udev
->do_remote_wakeup
) {
3277 status
= usb_enable_remote_wakeup(udev
);
3279 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3281 /* bail if autosuspend is requested */
3282 if (PMSG_IS_AUTO(msg
))
3287 /* disable USB2 hardware LPM */
3288 usb_disable_usb2_hardware_lpm(udev
);
3290 if (usb_disable_ltm(udev
)) {
3291 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n");
3293 if (PMSG_IS_AUTO(msg
))
3298 if (hub_is_superspeed(hub
->hdev
))
3299 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3302 * For system suspend, we do not need to enable the suspend feature
3303 * on individual USB-2 ports. The devices will automatically go
3304 * into suspend a few ms after the root hub stops sending packets.
3305 * The USB 2.0 spec calls this "global suspend".
3307 * However, many USB hubs have a bug: They don't relay wakeup requests
3308 * from a downstream port if the port's suspend feature isn't on.
3309 * Therefore we will turn on the suspend feature if udev or any of its
3310 * descendants is enabled for remote wakeup.
3312 else if (PMSG_IS_AUTO(msg
) || usb_wakeup_enabled_descendants(udev
) > 0)
3313 status
= set_port_feature(hub
->hdev
, port1
,
3314 USB_PORT_FEAT_SUSPEND
);
3316 really_suspend
= false;
3320 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3322 /* Try to enable USB3 LTM again */
3323 usb_enable_ltm(udev
);
3325 /* Try to enable USB2 hardware LPM again */
3326 usb_enable_usb2_hardware_lpm(udev
);
3328 if (udev
->do_remote_wakeup
)
3329 (void) usb_disable_remote_wakeup(udev
);
3332 /* System sleep transitions should never fail */
3333 if (!PMSG_IS_AUTO(msg
))
3336 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3337 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3338 udev
->do_remote_wakeup
);
3339 if (really_suspend
) {
3340 udev
->port_is_suspended
= 1;
3342 /* device has up to 10 msec to fully suspend */
3345 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3348 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3349 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3350 pm_runtime_put_sync(&port_dev
->dev
);
3352 usb_mark_last_busy(hub
->hdev
);
3354 usb_unlock_port(port_dev
);
3359 * If the USB "suspend" state is in use (rather than "global suspend"),
3360 * many devices will be individually taken out of suspend state using
3361 * special "resume" signaling. This routine kicks in shortly after
3362 * hardware resume signaling is finished, either because of selective
3363 * resume (by host) or remote wakeup (by device) ... now see what changed
3364 * in the tree that's rooted at this device.
3366 * If @udev->reset_resume is set then the device is reset before the
3367 * status check is done.
3369 static int finish_port_resume(struct usb_device
*udev
)
3374 /* caller owns the udev device lock */
3375 dev_dbg(&udev
->dev
, "%s\n",
3376 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3378 /* usb ch9 identifies four variants of SUSPENDED, based on what
3379 * state the device resumes to. Linux currently won't see the
3380 * first two on the host side; they'd be inside hub_port_init()
3381 * during many timeouts, but hub_wq can't suspend until later.
3383 usb_set_device_state(udev
, udev
->actconfig
3384 ? USB_STATE_CONFIGURED
3385 : USB_STATE_ADDRESS
);
3387 /* 10.5.4.5 says not to reset a suspended port if the attached
3388 * device is enabled for remote wakeup. Hence the reset
3389 * operation is carried out here, after the port has been
3392 if (udev
->reset_resume
) {
3394 * If the device morphs or switches modes when it is reset,
3395 * we don't want to perform a reset-resume. We'll fail the
3396 * resume, which will cause a logical disconnect, and then
3397 * the device will be rediscovered.
3400 if (udev
->quirks
& USB_QUIRK_RESET
)
3403 status
= usb_reset_and_verify_device(udev
);
3406 /* 10.5.4.5 says be sure devices in the tree are still there.
3407 * For now let's assume the device didn't go crazy on resume,
3408 * and device drivers will know about any resume quirks.
3412 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3414 /* If a normal resume failed, try doing a reset-resume */
3415 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3416 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3417 udev
->reset_resume
= 1;
3418 goto retry_reset_resume
;
3423 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3426 * There are a few quirky devices which violate the standard
3427 * by claiming to have remote wakeup enabled after a reset,
3428 * which crash if the feature is cleared, hence check for
3429 * udev->reset_resume
3431 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3432 if (udev
->speed
< USB_SPEED_SUPER
) {
3433 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3434 status
= usb_disable_remote_wakeup(udev
);
3436 status
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
, 0,
3438 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3439 | USB_INTRF_STAT_FUNC_RW
))
3440 status
= usb_disable_remote_wakeup(udev
);
3445 "disable remote wakeup, status %d\n",
3453 * There are some SS USB devices which take longer time for link training.
3454 * XHCI specs 4.19.4 says that when Link training is successful, port
3455 * sets CCS bit to 1. So if SW reads port status before successful link
3456 * training, then it will not find device to be present.
3457 * USB Analyzer log with such buggy devices show that in some cases
3458 * device switch on the RX termination after long delay of host enabling
3459 * the VBUS. In few other cases it has been seen that device fails to
3460 * negotiate link training in first attempt. It has been
3461 * reported till now that few devices take as long as 2000 ms to train
3462 * the link after host enabling its VBUS and termination. Following
3463 * routine implements a 2000 ms timeout for link training. If in a case
3464 * link trains before timeout, loop will exit earlier.
3466 * There are also some 2.0 hard drive based devices and 3.0 thumb
3467 * drives that, when plugged into a 2.0 only port, take a long
3468 * time to set CCS after VBUS enable.
3470 * FIXME: If a device was connected before suspend, but was removed
3471 * while system was asleep, then the loop in the following routine will
3472 * only exit at timeout.
3474 * This routine should only be called when persist is enabled.
3476 static int wait_for_connected(struct usb_device
*udev
,
3477 struct usb_hub
*hub
, int *port1
,
3478 u16
*portchange
, u16
*portstatus
)
3480 int status
= 0, delay_ms
= 0;
3482 while (delay_ms
< 2000) {
3483 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3485 if (!port_is_power_on(hub
, *portstatus
)) {
3491 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3493 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3498 * usb_port_resume - re-activate a suspended usb device's upstream port
3499 * @udev: device to re-activate, not a root hub
3500 * Context: must be able to sleep; device not locked; pm locks held
3502 * This will re-activate the suspended device, increasing power usage
3503 * while letting drivers communicate again with its endpoints.
3504 * USB resume explicitly guarantees that the power session between
3505 * the host and the device is the same as it was when the device
3508 * If @udev->reset_resume is set then this routine won't check that the
3509 * port is still enabled. Furthermore, finish_port_resume() above will
3510 * reset @udev. The end result is that a broken power session can be
3511 * recovered and @udev will appear to persist across a loss of VBUS power.
3513 * For example, if a host controller doesn't maintain VBUS suspend current
3514 * during a system sleep or is reset when the system wakes up, all the USB
3515 * power sessions below it will be broken. This is especially troublesome
3516 * for mass-storage devices containing mounted filesystems, since the
3517 * device will appear to have disconnected and all the memory mappings
3518 * to it will be lost. Using the USB_PERSIST facility, the device can be
3519 * made to appear as if it had not disconnected.
3521 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3522 * every effort to insure that the same device is present after the
3523 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3524 * quite possible for a device to remain unaltered but its media to be
3525 * changed. If the user replaces a flash memory card while the system is
3526 * asleep, he will have only himself to blame when the filesystem on the
3527 * new card is corrupted and the system crashes.
3529 * Returns 0 on success, else negative errno.
3531 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3533 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3534 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3535 int port1
= udev
->portnum
;
3537 u16 portchange
, portstatus
;
3539 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3540 status
= pm_runtime_get_sync(&port_dev
->dev
);
3542 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3548 usb_lock_port(port_dev
);
3550 /* Skip the initial Clear-Suspend step for a remote wakeup */
3551 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3552 if (status
== 0 && !port_is_suspended(hub
, portstatus
)) {
3553 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3554 pm_wakeup_event(&udev
->dev
, 0);
3555 goto SuspendCleared
;
3558 /* see 7.1.7.7; affects power usage, but not budgeting */
3559 if (hub_is_superspeed(hub
->hdev
))
3560 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3562 status
= usb_clear_port_feature(hub
->hdev
,
3563 port1
, USB_PORT_FEAT_SUSPEND
);
3565 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3567 /* drive resume for USB_RESUME_TIMEOUT msec */
3568 dev_dbg(&udev
->dev
, "usb %sresume\n",
3569 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3570 msleep(USB_RESUME_TIMEOUT
);
3572 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3573 * stop resume signaling. Then finish the resume
3576 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3578 /* TRSMRCY = 10 msec */
3584 udev
->port_is_suspended
= 0;
3585 if (hub_is_superspeed(hub
->hdev
)) {
3586 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3587 usb_clear_port_feature(hub
->hdev
, port1
,
3588 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3590 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3591 usb_clear_port_feature(hub
->hdev
, port1
,
3592 USB_PORT_FEAT_C_SUSPEND
);
3596 if (udev
->persist_enabled
)
3597 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3600 status
= check_port_resume_type(udev
,
3601 hub
, port1
, status
, portchange
, portstatus
);
3603 status
= finish_port_resume(udev
);
3605 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3606 hub_port_logical_disconnect(hub
, port1
);
3608 /* Try to enable USB2 hardware LPM */
3609 usb_enable_usb2_hardware_lpm(udev
);
3611 /* Try to enable USB3 LTM */
3612 usb_enable_ltm(udev
);
3615 usb_unlock_port(port_dev
);
3620 int usb_remote_wakeup(struct usb_device
*udev
)
3624 usb_lock_device(udev
);
3625 if (udev
->state
== USB_STATE_SUSPENDED
) {
3626 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3627 status
= usb_autoresume_device(udev
);
3629 /* Let the drivers do their thing, then... */
3630 usb_autosuspend_device(udev
);
3633 usb_unlock_device(udev
);
3637 /* Returns 1 if there was a remote wakeup and a connect status change. */
3638 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3639 u16 portstatus
, u16 portchange
)
3640 __must_hold(&port_dev
->status_lock
)
3642 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3643 struct usb_device
*hdev
;
3644 struct usb_device
*udev
;
3645 int connect_change
= 0;
3650 udev
= port_dev
->child
;
3651 if (!hub_is_superspeed(hdev
)) {
3652 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3654 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3656 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
3657 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3658 (link_state
!= USB_SS_PORT_LS_U0
&&
3659 link_state
!= USB_SS_PORT_LS_U1
&&
3660 link_state
!= USB_SS_PORT_LS_U2
))
3665 /* TRSMRCY = 10 msec */
3668 usb_unlock_port(port_dev
);
3669 ret
= usb_remote_wakeup(udev
);
3670 usb_lock_port(port_dev
);
3675 hub_port_disable(hub
, port
, 1);
3677 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3678 return connect_change
;
3681 static int check_ports_changed(struct usb_hub
*hub
)
3685 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3686 u16 portstatus
, portchange
;
3689 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3690 if (!status
&& portchange
)
3696 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3698 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3699 struct usb_device
*hdev
= hub
->hdev
;
3703 * Warn if children aren't already suspended.
3704 * Also, add up the number of wakeup-enabled descendants.
3706 hub
->wakeup_enabled_descendants
= 0;
3707 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3708 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3709 struct usb_device
*udev
= port_dev
->child
;
3711 if (udev
&& udev
->can_submit
) {
3712 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3713 dev_name(&udev
->dev
));
3714 if (PMSG_IS_AUTO(msg
))
3718 hub
->wakeup_enabled_descendants
+=
3719 usb_wakeup_enabled_descendants(udev
);
3722 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3723 /* check if there are changes pending on hub ports */
3724 if (check_ports_changed(hub
)) {
3725 if (PMSG_IS_AUTO(msg
))
3727 pm_wakeup_event(&hdev
->dev
, 2000);
3731 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3732 /* Enable hub to send remote wakeup for all ports. */
3733 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3734 set_port_feature(hdev
,
3736 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3737 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3738 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3739 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3743 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3745 /* stop hub_wq and related activity */
3746 hub_quiesce(hub
, HUB_SUSPEND
);
3750 /* Report wakeup requests from the ports of a resuming root hub */
3751 static void report_wakeup_requests(struct usb_hub
*hub
)
3753 struct usb_device
*hdev
= hub
->hdev
;
3754 struct usb_device
*udev
;
3755 struct usb_hcd
*hcd
;
3756 unsigned long resuming_ports
;
3760 return; /* Not a root hub */
3762 hcd
= bus_to_hcd(hdev
->bus
);
3763 if (hcd
->driver
->get_resuming_ports
) {
3766 * The get_resuming_ports() method returns a bitmap (origin 0)
3767 * of ports which have started wakeup signaling but have not
3768 * yet finished resuming. During system resume we will
3769 * resume all the enabled ports, regardless of any wakeup
3770 * signals, which means the wakeup requests would be lost.
3771 * To prevent this, report them to the PM core here.
3773 resuming_ports
= hcd
->driver
->get_resuming_ports(hcd
);
3774 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
3775 if (test_bit(i
, &resuming_ports
)) {
3776 udev
= hub
->ports
[i
]->child
;
3778 pm_wakeup_event(&udev
->dev
, 0);
3784 static int hub_resume(struct usb_interface
*intf
)
3786 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3788 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3789 hub_activate(hub
, HUB_RESUME
);
3792 * This should be called only for system resume, not runtime resume.
3793 * We can't tell the difference here, so some wakeup requests will be
3794 * reported at the wrong time or more than once. This shouldn't
3795 * matter much, so long as they do get reported.
3797 report_wakeup_requests(hub
);
3801 static int hub_reset_resume(struct usb_interface
*intf
)
3803 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3805 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3806 hub_activate(hub
, HUB_RESET_RESUME
);
3811 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3812 * @rhdev: struct usb_device for the root hub
3814 * The USB host controller driver calls this function when its root hub
3815 * is resumed and Vbus power has been interrupted or the controller
3816 * has been reset. The routine marks @rhdev as having lost power.
3817 * When the hub driver is resumed it will take notice and carry out
3818 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3819 * the others will be disconnected.
3821 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3823 dev_notice(&rhdev
->dev
, "root hub lost power or was reset\n");
3824 rhdev
->reset_resume
= 1;
3826 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3828 static const char * const usb3_lpm_names
[] = {
3836 * Send a Set SEL control transfer to the device, prior to enabling
3837 * device-initiated U1 or U2. This lets the device know the exit latencies from
3838 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3839 * packet from the host.
3841 * This function will fail if the SEL or PEL values for udev are greater than
3842 * the maximum allowed values for the link state to be enabled.
3844 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3846 struct usb_set_sel_req
*sel_values
;
3847 unsigned long long u1_sel
;
3848 unsigned long long u1_pel
;
3849 unsigned long long u2_sel
;
3850 unsigned long long u2_pel
;
3853 if (udev
->state
!= USB_STATE_CONFIGURED
)
3856 /* Convert SEL and PEL stored in ns to us */
3857 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3858 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3859 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3860 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3863 * Make sure that the calculated SEL and PEL values for the link
3864 * state we're enabling aren't bigger than the max SEL/PEL
3865 * value that will fit in the SET SEL control transfer.
3866 * Otherwise the device would get an incorrect idea of the exit
3867 * latency for the link state, and could start a device-initiated
3868 * U1/U2 when the exit latencies are too high.
3870 if ((state
== USB3_LPM_U1
&&
3871 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3872 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3873 (state
== USB3_LPM_U2
&&
3874 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3875 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3876 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3877 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3882 * If we're enabling device-initiated LPM for one link state,
3883 * but the other link state has a too high SEL or PEL value,
3884 * just set those values to the max in the Set SEL request.
3886 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3887 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3889 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3890 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3892 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3893 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3895 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3896 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3899 * usb_enable_lpm() can be called as part of a failed device reset,
3900 * which may be initiated by an error path of a mass storage driver.
3901 * Therefore, use GFP_NOIO.
3903 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3907 sel_values
->u1_sel
= u1_sel
;
3908 sel_values
->u1_pel
= u1_pel
;
3909 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3910 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3912 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3916 sel_values
, sizeof *(sel_values
),
3917 USB_CTRL_SET_TIMEOUT
);
3923 * Enable or disable device-initiated U1 or U2 transitions.
3925 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3926 enum usb3_link_state state
, bool enable
)
3933 feature
= USB_DEVICE_U1_ENABLE
;
3936 feature
= USB_DEVICE_U2_ENABLE
;
3939 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3940 __func__
, enable
? "enable" : "disable");
3944 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3945 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3946 "for unconfigured device.\n",
3947 __func__
, enable
? "enable" : "disable",
3948 usb3_lpm_names
[state
]);
3954 * Now send the control transfer to enable device-initiated LPM
3955 * for either U1 or U2.
3957 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3958 USB_REQ_SET_FEATURE
,
3962 USB_CTRL_SET_TIMEOUT
);
3964 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3965 USB_REQ_CLEAR_FEATURE
,
3969 USB_CTRL_SET_TIMEOUT
);
3972 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3973 enable
? "Enable" : "Disable",
3974 usb3_lpm_names
[state
]);
3980 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3981 enum usb3_link_state state
, int timeout
)
3988 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3991 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3994 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3999 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
4000 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
4001 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
4002 "which is a reserved value.\n",
4003 usb3_lpm_names
[state
], timeout
);
4007 ret
= set_port_feature(udev
->parent
,
4008 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
4011 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
4012 "error code %i\n", usb3_lpm_names
[state
],
4016 if (state
== USB3_LPM_U1
)
4017 udev
->u1_params
.timeout
= timeout
;
4019 udev
->u2_params
.timeout
= timeout
;
4024 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4027 * We will attempt to enable U1 or U2, but there are no guarantees that the
4028 * control transfers to set the hub timeout or enable device-initiated U1/U2
4029 * will be successful.
4031 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4032 * hub-initiated U1/U2 will be disabled.
4034 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4035 * driver know about it. If that call fails, it should be harmless, and just
4036 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4038 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4039 enum usb3_link_state state
)
4042 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
4043 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
4045 /* If the device says it doesn't have *any* exit latency to come out of
4046 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4049 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
4050 (state
== USB3_LPM_U2
&& u2_mel
== 0))
4054 * First, let the device know about the exit latencies
4055 * associated with the link state we're about to enable.
4057 ret
= usb_req_set_sel(udev
, state
);
4059 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
4060 usb3_lpm_names
[state
]);
4064 /* We allow the host controller to set the U1/U2 timeout internally
4065 * first, so that it can change its schedule to account for the
4066 * additional latency to send data to a device in a lower power
4069 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
4071 /* xHCI host controller doesn't want to enable this LPM state. */
4076 dev_warn(&udev
->dev
, "Could not enable %s link state, "
4077 "xHCI error %i.\n", usb3_lpm_names
[state
],
4082 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
4083 /* If we can't set the parent hub U1/U2 timeout,
4084 * device-initiated LPM won't be allowed either, so let the xHCI
4085 * host know that this link state won't be enabled.
4087 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4091 /* Only a configured device will accept the Set Feature
4094 if (udev
->actconfig
&&
4095 usb_set_device_initiated_lpm(udev
, state
, true) == 0) {
4096 if (state
== USB3_LPM_U1
)
4097 udev
->usb3_lpm_u1_enabled
= 1;
4098 else if (state
== USB3_LPM_U2
)
4099 udev
->usb3_lpm_u2_enabled
= 1;
4101 /* Don't request U1/U2 entry if the device
4102 * cannot transition to U1/U2.
4104 usb_set_lpm_timeout(udev
, state
, 0);
4105 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
4110 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4113 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4114 * If zero is returned, the parent will not allow the link to go into U1/U2.
4116 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4117 * it won't have an effect on the bus link state because the parent hub will
4118 * still disallow device-initiated U1/U2 entry.
4120 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4121 * possible. The result will be slightly more bus bandwidth will be taken up
4122 * (to account for U1/U2 exit latency), but it should be harmless.
4124 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4125 enum usb3_link_state state
)
4132 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4137 if (usb_set_lpm_timeout(udev
, state
, 0))
4140 usb_set_device_initiated_lpm(udev
, state
, false);
4142 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4143 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4144 "bus schedule bandwidth may be impacted.\n",
4145 usb3_lpm_names
[state
]);
4147 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4148 * is disabled. Hub will disallows link to enter U1/U2 as well,
4149 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4150 * timeout set to 0, no matter device-initiated LPM is disabled or
4153 if (state
== USB3_LPM_U1
)
4154 udev
->usb3_lpm_u1_enabled
= 0;
4155 else if (state
== USB3_LPM_U2
)
4156 udev
->usb3_lpm_u2_enabled
= 0;
4162 * Disable hub-initiated and device-initiated U1 and U2 entry.
4163 * Caller must own the bandwidth_mutex.
4165 * This will call usb_enable_lpm() on failure, which will decrement
4166 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4168 int usb_disable_lpm(struct usb_device
*udev
)
4170 struct usb_hcd
*hcd
;
4172 if (!udev
|| !udev
->parent
||
4173 udev
->speed
< USB_SPEED_SUPER
||
4174 !udev
->lpm_capable
||
4175 udev
->state
< USB_STATE_CONFIGURED
)
4178 hcd
= bus_to_hcd(udev
->bus
);
4179 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4182 udev
->lpm_disable_count
++;
4183 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4186 /* If LPM is enabled, attempt to disable it. */
4187 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4189 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4195 usb_enable_lpm(udev
);
4198 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4200 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4201 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4203 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4209 mutex_lock(hcd
->bandwidth_mutex
);
4210 ret
= usb_disable_lpm(udev
);
4211 mutex_unlock(hcd
->bandwidth_mutex
);
4215 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4218 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4219 * xHCI host policy may prevent U1 or U2 from being enabled.
4221 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4222 * until the lpm_disable_count drops to zero. Caller must own the
4225 void usb_enable_lpm(struct usb_device
*udev
)
4227 struct usb_hcd
*hcd
;
4228 struct usb_hub
*hub
;
4229 struct usb_port
*port_dev
;
4231 if (!udev
|| !udev
->parent
||
4232 udev
->speed
< USB_SPEED_SUPER
||
4233 !udev
->lpm_capable
||
4234 udev
->state
< USB_STATE_CONFIGURED
)
4237 udev
->lpm_disable_count
--;
4238 hcd
= bus_to_hcd(udev
->bus
);
4239 /* Double check that we can both enable and disable LPM.
4240 * Device must be configured to accept set feature U1/U2 timeout.
4242 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4243 !hcd
->driver
->disable_usb3_lpm_timeout
)
4246 if (udev
->lpm_disable_count
> 0)
4249 hub
= usb_hub_to_struct_hub(udev
->parent
);
4253 port_dev
= hub
->ports
[udev
->portnum
- 1];
4255 if (port_dev
->usb3_lpm_u1_permit
)
4256 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4258 if (port_dev
->usb3_lpm_u2_permit
)
4259 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4261 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4263 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4264 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4266 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4271 mutex_lock(hcd
->bandwidth_mutex
);
4272 usb_enable_lpm(udev
);
4273 mutex_unlock(hcd
->bandwidth_mutex
);
4275 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4277 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4278 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4279 struct usb_port
*port_dev
)
4281 struct usb_device
*udev
= port_dev
->child
;
4284 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4285 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4288 msleep(USB_RESUME_TIMEOUT
);
4289 ret
= usb_disable_remote_wakeup(udev
);
4292 dev_warn(&udev
->dev
,
4293 "Port disable: can't disable remote wake\n");
4294 udev
->do_remote_wakeup
= 0;
4298 #else /* CONFIG_PM */
4300 #define hub_suspend NULL
4301 #define hub_resume NULL
4302 #define hub_reset_resume NULL
4304 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4305 struct usb_port
*port_dev
) { }
4307 int usb_disable_lpm(struct usb_device
*udev
)
4311 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4313 void usb_enable_lpm(struct usb_device
*udev
) { }
4314 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4316 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4320 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4322 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4323 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4325 int usb_disable_ltm(struct usb_device
*udev
)
4329 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4331 void usb_enable_ltm(struct usb_device
*udev
) { }
4332 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4334 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4335 u16 portstatus
, u16 portchange
)
4340 #endif /* CONFIG_PM */
4343 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4344 * a connection with a plugged-in cable but will signal the host when the cable
4345 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4347 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4349 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4350 struct usb_device
*hdev
= hub
->hdev
;
4354 if (hub_is_superspeed(hub
->hdev
)) {
4355 hub_usb3_port_prepare_disable(hub
, port_dev
);
4356 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4359 ret
= usb_clear_port_feature(hdev
, port1
,
4360 USB_PORT_FEAT_ENABLE
);
4363 if (port_dev
->child
&& set_state
)
4364 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4365 if (ret
&& ret
!= -ENODEV
)
4366 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4371 * usb_port_disable - disable a usb device's upstream port
4372 * @udev: device to disable
4373 * Context: @udev locked, must be able to sleep.
4375 * Disables a USB device that isn't in active use.
4377 int usb_port_disable(struct usb_device
*udev
)
4379 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4381 return hub_port_disable(hub
, udev
->portnum
, 0);
4384 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4386 * Between connect detection and reset signaling there must be a delay
4387 * of 100ms at least for debounce and power-settling. The corresponding
4388 * timer shall restart whenever the downstream port detects a disconnect.
4390 * Apparently there are some bluetooth and irda-dongles and a number of
4391 * low-speed devices for which this debounce period may last over a second.
4392 * Not covered by the spec - but easy to deal with.
4394 * This implementation uses a 1500ms total debounce timeout; if the
4395 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4396 * every 25ms for transient disconnects. When the port status has been
4397 * unchanged for 100ms it returns the port status.
4399 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4402 u16 portchange
, portstatus
;
4403 unsigned connection
= 0xffff;
4404 int total_time
, stable_time
= 0;
4405 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4407 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4408 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4412 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4413 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4414 if (!must_be_connected
||
4415 (connection
== USB_PORT_STAT_CONNECTION
))
4416 stable_time
+= HUB_DEBOUNCE_STEP
;
4417 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4421 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4424 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4425 usb_clear_port_feature(hub
->hdev
, port1
,
4426 USB_PORT_FEAT_C_CONNECTION
);
4429 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4431 msleep(HUB_DEBOUNCE_STEP
);
4434 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4435 total_time
, stable_time
, portstatus
);
4437 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4442 void usb_ep0_reinit(struct usb_device
*udev
)
4444 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4445 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4446 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4448 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4450 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4451 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4453 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4456 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4459 * The host controller will choose the device address,
4460 * instead of the core having chosen it earlier
4462 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4464 if (udev
->state
== USB_STATE_ADDRESS
)
4466 if (udev
->state
!= USB_STATE_DEFAULT
)
4468 if (hcd
->driver
->address_device
)
4469 retval
= hcd
->driver
->address_device(hcd
, udev
);
4471 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4472 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4473 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4475 update_devnum(udev
, devnum
);
4476 /* Device now using proper address. */
4477 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4478 usb_ep0_reinit(udev
);
4484 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4485 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4488 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4489 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4490 * support bit in the BOS descriptor.
4492 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4494 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4495 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4497 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4501 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4503 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4504 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4505 udev
->usb2_hw_lpm_allowed
= 1;
4506 usb_enable_usb2_hardware_lpm(udev
);
4510 static int hub_enable_device(struct usb_device
*udev
)
4512 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4514 if (!hcd
->driver
->enable_device
)
4516 if (udev
->state
== USB_STATE_ADDRESS
)
4518 if (udev
->state
!= USB_STATE_DEFAULT
)
4521 return hcd
->driver
->enable_device(hcd
, udev
);
4524 /* Reset device, (re)assign address, get device descriptor.
4525 * Device connection must be stable, no more debouncing needed.
4526 * Returns device in USB_STATE_ADDRESS, except on error.
4528 * If this is called for an already-existing device (as part of
4529 * usb_reset_and_verify_device), the caller must own the device lock and
4530 * the port lock. For a newly detected device that is not accessible
4531 * through any global pointers, it's not necessary to lock the device,
4532 * but it is still necessary to lock the port.
4535 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4538 struct usb_device
*hdev
= hub
->hdev
;
4539 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4540 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4541 int retries
, operations
, retval
, i
;
4542 unsigned delay
= HUB_SHORT_RESET_TIME
;
4543 enum usb_device_speed oldspeed
= udev
->speed
;
4545 int devnum
= udev
->devnum
;
4546 const char *driver_name
;
4548 /* root hub ports have a slightly longer reset period
4549 * (from USB 2.0 spec, section 7.1.7.5)
4551 if (!hdev
->parent
) {
4552 delay
= HUB_ROOT_RESET_TIME
;
4553 if (port1
== hdev
->bus
->otg_port
)
4554 hdev
->bus
->b_hnp_enable
= 0;
4557 /* Some low speed devices have problems with the quick delay, so */
4558 /* be a bit pessimistic with those devices. RHbug #23670 */
4559 if (oldspeed
== USB_SPEED_LOW
)
4560 delay
= HUB_LONG_RESET_TIME
;
4562 mutex_lock(hcd
->address0_mutex
);
4564 /* Reset the device; full speed may morph to high speed */
4565 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4566 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4567 if (retval
< 0) /* error or disconnect */
4569 /* success, speed is known */
4573 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4574 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4575 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4576 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4579 oldspeed
= udev
->speed
;
4581 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4582 * it's fixed size except for full speed devices.
4583 * For Wireless USB devices, ep0 max packet is always 512 (tho
4584 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4586 switch (udev
->speed
) {
4587 case USB_SPEED_SUPER_PLUS
:
4588 case USB_SPEED_SUPER
:
4589 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4590 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4592 case USB_SPEED_HIGH
: /* fixed at 64 */
4593 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4595 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4596 /* to determine the ep0 maxpacket size, try to read
4597 * the device descriptor to get bMaxPacketSize0 and
4598 * then correct our initial guess.
4600 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4602 case USB_SPEED_LOW
: /* fixed at 8 */
4603 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4609 if (udev
->speed
== USB_SPEED_WIRELESS
)
4610 speed
= "variable speed Wireless";
4612 speed
= usb_speed_string(udev
->speed
);
4615 * The controller driver may be NULL if the controller device
4616 * is the middle device between platform device and roothub.
4617 * This middle device may not need a device driver due to
4618 * all hardware control can be at platform device driver, this
4619 * platform device is usually a dual-role USB controller device.
4621 if (udev
->bus
->controller
->driver
)
4622 driver_name
= udev
->bus
->controller
->driver
->name
;
4624 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4626 if (udev
->speed
< USB_SPEED_SUPER
)
4627 dev_info(&udev
->dev
,
4628 "%s %s USB device number %d using %s\n",
4629 (udev
->config
) ? "reset" : "new", speed
,
4630 devnum
, driver_name
);
4632 /* Set up TT records, if needed */
4634 udev
->tt
= hdev
->tt
;
4635 udev
->ttport
= hdev
->ttport
;
4636 } else if (udev
->speed
!= USB_SPEED_HIGH
4637 && hdev
->speed
== USB_SPEED_HIGH
) {
4639 dev_err(&udev
->dev
, "parent hub has no TT\n");
4643 udev
->tt
= &hub
->tt
;
4644 udev
->ttport
= port1
;
4647 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4648 * Because device hardware and firmware is sometimes buggy in
4649 * this area, and this is how Linux has done it for ages.
4650 * Change it cautiously.
4652 * NOTE: If use_new_scheme() is true we will start by issuing
4653 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4654 * so it may help with some non-standards-compliant devices.
4655 * Otherwise we start with SET_ADDRESS and then try to read the
4656 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4659 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4660 bool did_new_scheme
= false;
4662 if (use_new_scheme(udev
, retry_counter
, port_dev
)) {
4663 struct usb_device_descriptor
*buf
;
4666 did_new_scheme
= true;
4667 retval
= hub_enable_device(udev
);
4670 "hub failed to enable device, error %d\n",
4675 #define GET_DESCRIPTOR_BUFSIZE 64
4676 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4682 /* Retry on all errors; some devices are flakey.
4683 * 255 is for WUSB devices, we actually need to use
4684 * 512 (WUSB1.0[4.8.1]).
4686 for (operations
= 0; operations
< 3; ++operations
) {
4687 buf
->bMaxPacketSize0
= 0;
4688 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4689 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4690 USB_DT_DEVICE
<< 8, 0,
4691 buf
, GET_DESCRIPTOR_BUFSIZE
,
4692 initial_descriptor_timeout
);
4693 switch (buf
->bMaxPacketSize0
) {
4694 case 8: case 16: case 32: case 64: case 255:
4695 if (buf
->bDescriptorType
==
4707 * Some devices time out if they are powered on
4708 * when already connected. They need a second
4709 * reset. But only on the first attempt,
4710 * lest we get into a time out/reset loop
4712 if (r
== 0 || (r
== -ETIMEDOUT
&&
4714 udev
->speed
> USB_SPEED_FULL
))
4717 udev
->descriptor
.bMaxPacketSize0
=
4718 buf
->bMaxPacketSize0
;
4721 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4722 if (retval
< 0) /* error or disconnect */
4724 if (oldspeed
!= udev
->speed
) {
4726 "device reset changed speed!\n");
4732 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4737 #undef GET_DESCRIPTOR_BUFSIZE
4741 * If device is WUSB, we already assigned an
4742 * unauthorized address in the Connect Ack sequence;
4743 * authorization will assign the final address.
4745 if (udev
->wusb
== 0) {
4746 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4747 retval
= hub_set_address(udev
, devnum
);
4753 if (retval
!= -ENODEV
)
4754 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4758 if (udev
->speed
>= USB_SPEED_SUPER
) {
4759 devnum
= udev
->devnum
;
4760 dev_info(&udev
->dev
,
4761 "%s SuperSpeed%s%s USB device number %d using %s\n",
4762 (udev
->config
) ? "reset" : "new",
4763 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ?
4764 "Plus Gen 2" : " Gen 1",
4765 (udev
->rx_lanes
== 2 && udev
->tx_lanes
== 2) ?
4767 devnum
, driver_name
);
4770 /* cope with hardware quirkiness:
4771 * - let SET_ADDRESS settle, some device hardware wants it
4772 * - read ep0 maxpacket even for high and low speed,
4775 /* use_new_scheme() checks the speed which may have
4776 * changed since the initial look so we cache the result
4783 retval
= usb_get_device_descriptor(udev
, 8);
4785 if (retval
!= -ENODEV
)
4787 "device descriptor read/8, error %d\n",
4796 delay
= udev
->parent
->hub_delay
;
4797 udev
->hub_delay
= min_t(u32
, delay
,
4798 USB_TP_TRANSMISSION_DELAY_MAX
);
4799 retval
= usb_set_isoch_delay(udev
);
4802 "Failed set isoch delay, error %d\n",
4813 * Some superspeed devices have finished the link training process
4814 * and attached to a superspeed hub port, but the device descriptor
4815 * got from those devices show they aren't superspeed devices. Warm
4816 * reset the port attached by the devices can fix them.
4818 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4819 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4820 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4821 "warm reset device\n");
4822 hub_port_reset(hub
, port1
, udev
,
4823 HUB_BH_RESET_TIME
, true);
4828 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4829 udev
->speed
>= USB_SPEED_SUPER
)
4832 i
= udev
->descriptor
.bMaxPacketSize0
;
4833 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4834 if (udev
->speed
== USB_SPEED_LOW
||
4835 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4836 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4840 if (udev
->speed
== USB_SPEED_FULL
)
4841 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4843 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4844 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4845 usb_ep0_reinit(udev
);
4848 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4849 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4850 if (retval
!= -ENODEV
)
4851 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4858 usb_detect_quirks(udev
);
4860 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4861 retval
= usb_get_bos_descriptor(udev
);
4863 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4864 usb_set_lpm_parameters(udev
);
4869 /* notify HCD that we have a device connected and addressed */
4870 if (hcd
->driver
->update_device
)
4871 hcd
->driver
->update_device(hcd
, udev
);
4872 hub_set_initial_usb2_lpm_policy(udev
);
4875 hub_port_disable(hub
, port1
, 0);
4876 update_devnum(udev
, devnum
); /* for disconnect processing */
4878 mutex_unlock(hcd
->address0_mutex
);
4883 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4885 struct usb_qualifier_descriptor
*qual
;
4888 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4891 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4895 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4896 qual
, sizeof *qual
);
4897 if (status
== sizeof *qual
) {
4898 dev_info(&udev
->dev
, "not running at top speed; "
4899 "connect to a high speed hub\n");
4900 /* hub LEDs are probably harder to miss than syslog */
4901 if (hub
->has_indicators
) {
4902 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4903 queue_delayed_work(system_power_efficient_wq
,
4911 hub_power_remaining(struct usb_hub
*hub
)
4913 struct usb_device
*hdev
= hub
->hdev
;
4917 if (!hub
->limited_power
)
4920 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4921 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4922 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4923 struct usb_device
*udev
= port_dev
->child
;
4929 if (hub_is_superspeed(udev
))
4935 * Unconfigured devices may not use more than one unit load,
4936 * or 8mA for OTG ports
4938 if (udev
->actconfig
)
4939 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4940 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4944 if (delta
> hub
->mA_per_port
)
4945 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4946 delta
, hub
->mA_per_port
);
4949 if (remaining
< 0) {
4950 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4958 static int descriptors_changed(struct usb_device
*udev
,
4959 struct usb_device_descriptor
*old_device_descriptor
,
4960 struct usb_host_bos
*old_bos
)
4964 unsigned serial_len
= 0;
4966 unsigned old_length
;
4970 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4971 sizeof(*old_device_descriptor
)) != 0)
4974 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
4977 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
4978 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
4980 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
4984 /* Since the idVendor, idProduct, and bcdDevice values in the
4985 * device descriptor haven't changed, we will assume the
4986 * Manufacturer and Product strings haven't changed either.
4987 * But the SerialNumber string could be different (e.g., a
4988 * different flash card of the same brand).
4991 serial_len
= strlen(udev
->serial
) + 1;
4994 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4995 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4996 len
= max(len
, old_length
);
4999 buf
= kmalloc(len
, GFP_NOIO
);
5001 /* assume the worst */
5004 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5005 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5006 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5008 if (length
!= old_length
) {
5009 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5014 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5016 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5018 ((struct usb_config_descriptor
*) buf
)->
5019 bConfigurationValue
);
5025 if (!changed
&& serial_len
) {
5026 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5028 if (length
+ 1 != serial_len
) {
5029 dev_dbg(&udev
->dev
, "serial string error %d\n",
5032 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5033 dev_dbg(&udev
->dev
, "serial string changed\n");
5042 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
5045 int status
= -ENODEV
;
5048 struct usb_device
*hdev
= hub
->hdev
;
5049 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
5050 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5051 struct usb_device
*udev
= port_dev
->child
;
5052 static int unreliable_port
= -1;
5054 /* Disconnect any existing devices under this port */
5056 if (hcd
->usb_phy
&& !hdev
->parent
)
5057 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
5058 usb_disconnect(&port_dev
->child
);
5061 /* We can forget about a "removed" device when there's a physical
5062 * disconnect or the connect status changes.
5064 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5065 (portchange
& USB_PORT_STAT_C_CONNECTION
))
5066 clear_bit(port1
, hub
->removed_bits
);
5068 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
5069 USB_PORT_STAT_C_ENABLE
)) {
5070 status
= hub_port_debounce_be_stable(hub
, port1
);
5072 if (status
!= -ENODEV
&&
5073 port1
!= unreliable_port
&&
5075 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
5076 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
5077 unreliable_port
= port1
;
5079 portstatus
= status
;
5083 /* Return now if debouncing failed or nothing is connected or
5084 * the device was "removed".
5086 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
5087 test_bit(port1
, hub
->removed_bits
)) {
5090 * maybe switch power back on (e.g. root hub was reset)
5091 * but only if the port isn't owned by someone else.
5093 if (hub_is_port_power_switchable(hub
)
5094 && !port_is_power_on(hub
, portstatus
)
5095 && !port_dev
->port_owner
)
5096 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
5098 if (portstatus
& USB_PORT_STAT_ENABLE
)
5102 if (hub_is_superspeed(hub
->hdev
))
5108 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
5110 /* reallocate for each attempt, since references
5111 * to the previous one can escape in various ways
5113 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
5115 dev_err(&port_dev
->dev
,
5116 "couldn't allocate usb_device\n");
5120 usb_set_device_state(udev
, USB_STATE_POWERED
);
5121 udev
->bus_mA
= hub
->mA_per_port
;
5122 udev
->level
= hdev
->level
+ 1;
5123 udev
->wusb
= hub_is_wusb(hub
);
5125 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5126 if (hub_is_superspeed(hub
->hdev
))
5127 udev
->speed
= USB_SPEED_SUPER
;
5129 udev
->speed
= USB_SPEED_UNKNOWN
;
5131 choose_devnum(udev
);
5132 if (udev
->devnum
<= 0) {
5133 status
= -ENOTCONN
; /* Don't retry */
5137 /* reset (non-USB 3.0 devices) and get descriptor */
5138 usb_lock_port(port_dev
);
5139 status
= hub_port_init(hub
, udev
, port1
, i
);
5140 usb_unlock_port(port_dev
);
5144 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
5147 /* consecutive bus-powered hubs aren't reliable; they can
5148 * violate the voltage drop budget. if the new child has
5149 * a "powered" LED, users should notice we didn't enable it
5150 * (without reading syslog), even without per-port LEDs
5153 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
5154 && udev
->bus_mA
<= unit_load
) {
5157 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0,
5160 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
5163 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
5165 "can't connect bus-powered hub "
5167 if (hub
->has_indicators
) {
5168 hub
->indicator
[port1
-1] =
5169 INDICATOR_AMBER_BLINK
;
5171 system_power_efficient_wq
,
5174 status
= -ENOTCONN
; /* Don't retry */
5179 /* check for devices running slower than they could */
5180 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
5181 && udev
->speed
== USB_SPEED_FULL
5182 && highspeed_hubs
!= 0)
5183 check_highspeed(hub
, udev
, port1
);
5185 /* Store the parent's children[] pointer. At this point
5186 * udev becomes globally accessible, although presumably
5187 * no one will look at it until hdev is unlocked.
5191 mutex_lock(&usb_port_peer_mutex
);
5193 /* We mustn't add new devices if the parent hub has
5194 * been disconnected; we would race with the
5195 * recursively_mark_NOTATTACHED() routine.
5197 spin_lock_irq(&device_state_lock
);
5198 if (hdev
->state
== USB_STATE_NOTATTACHED
)
5201 port_dev
->child
= udev
;
5202 spin_unlock_irq(&device_state_lock
);
5203 mutex_unlock(&usb_port_peer_mutex
);
5205 /* Run it through the hoops (find a driver, etc) */
5207 status
= usb_new_device(udev
);
5209 mutex_lock(&usb_port_peer_mutex
);
5210 spin_lock_irq(&device_state_lock
);
5211 port_dev
->child
= NULL
;
5212 spin_unlock_irq(&device_state_lock
);
5213 mutex_unlock(&usb_port_peer_mutex
);
5215 if (hcd
->usb_phy
&& !hdev
->parent
)
5216 usb_phy_notify_connect(hcd
->usb_phy
,
5224 status
= hub_power_remaining(hub
);
5226 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
5231 hub_port_disable(hub
, port1
, 1);
5233 usb_ep0_reinit(udev
);
5234 release_devnum(udev
);
5237 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
5240 /* When halfway through our retry count, power-cycle the port */
5241 if (i
== (SET_CONFIG_TRIES
/ 2) - 1) {
5242 dev_info(&port_dev
->dev
, "attempt power cycle\n");
5243 usb_hub_set_port_power(hdev
, hub
, port1
, false);
5244 msleep(2 * hub_power_on_good_delay(hub
));
5245 usb_hub_set_port_power(hdev
, hub
, port1
, true);
5246 msleep(hub_power_on_good_delay(hub
));
5249 if (hub
->hdev
->parent
||
5250 !hcd
->driver
->port_handed_over
||
5251 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
5252 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5253 dev_err(&port_dev
->dev
,
5254 "unable to enumerate USB device\n");
5258 hub_port_disable(hub
, port1
, 1);
5259 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
5260 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5261 hcd
->driver
->relinquish_port(hcd
, port1
);
5265 /* Handle physical or logical connection change events.
5266 * This routine is called when:
5267 * a port connection-change occurs;
5268 * a port enable-change occurs (often caused by EMI);
5269 * usb_reset_and_verify_device() encounters changed descriptors (as from
5270 * a firmware download)
5271 * caller already locked the hub
5273 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
5274 u16 portstatus
, u16 portchange
)
5275 __must_hold(&port_dev
->status_lock
)
5277 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5278 struct usb_device
*udev
= port_dev
->child
;
5279 struct usb_device_descriptor descriptor
;
5280 int status
= -ENODEV
;
5283 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
5284 portchange
, portspeed(hub
, portstatus
));
5286 if (hub
->has_indicators
) {
5287 set_port_led(hub
, port1
, HUB_LED_AUTO
);
5288 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
5291 #ifdef CONFIG_USB_OTG
5292 /* during HNP, don't repeat the debounce */
5293 if (hub
->hdev
->bus
->is_b_host
)
5294 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
5295 USB_PORT_STAT_C_ENABLE
);
5298 /* Try to resuscitate an existing device */
5299 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
5300 udev
->state
!= USB_STATE_NOTATTACHED
) {
5301 if (portstatus
& USB_PORT_STAT_ENABLE
) {
5303 * USB-3 connections are initialized automatically by
5304 * the hostcontroller hardware. Therefore check for
5305 * changed device descriptors before resuscitating the
5308 descriptor
= udev
->descriptor
;
5309 retval
= usb_get_device_descriptor(udev
,
5310 sizeof(udev
->descriptor
));
5313 "can't read device descriptor %d\n",
5316 if (descriptors_changed(udev
, &descriptor
,
5319 "device descriptor has changed\n");
5320 /* for disconnect() calls */
5321 udev
->descriptor
= descriptor
;
5323 status
= 0; /* Nothing to do */
5327 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
5328 udev
->persist_enabled
) {
5329 /* For a suspended device, treat this as a
5330 * remote wakeup event.
5332 usb_unlock_port(port_dev
);
5333 status
= usb_remote_wakeup(udev
);
5334 usb_lock_port(port_dev
);
5337 /* Don't resuscitate */;
5340 clear_bit(port1
, hub
->change_bits
);
5342 /* successfully revalidated the connection */
5346 usb_unlock_port(port_dev
);
5347 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5348 usb_lock_port(port_dev
);
5351 /* Handle notifying userspace about hub over-current events */
5352 static void port_over_current_notify(struct usb_port
*port_dev
)
5355 struct device
*hub_dev
;
5356 char *port_dev_path
;
5358 sysfs_notify(&port_dev
->dev
.kobj
, NULL
, "over_current_count");
5360 hub_dev
= port_dev
->dev
.parent
;
5365 port_dev_path
= kobject_get_path(&port_dev
->dev
.kobj
, GFP_KERNEL
);
5369 envp
[0] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_PORT=%s", port_dev_path
);
5373 envp
[1] = kasprintf(GFP_KERNEL
, "OVER_CURRENT_COUNT=%u",
5374 port_dev
->over_current_count
);
5379 kobject_uevent_env(&hub_dev
->kobj
, KOBJ_CHANGE
, envp
);
5385 kfree(port_dev_path
);
5388 static void port_event(struct usb_hub
*hub
, int port1
)
5389 __must_hold(&port_dev
->status_lock
)
5392 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5393 struct usb_device
*udev
= port_dev
->child
;
5394 struct usb_device
*hdev
= hub
->hdev
;
5395 u16 portstatus
, portchange
;
5397 connect_change
= test_bit(port1
, hub
->change_bits
);
5398 clear_bit(port1
, hub
->event_bits
);
5399 clear_bit(port1
, hub
->wakeup_bits
);
5401 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5404 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5405 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5409 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5410 if (!connect_change
)
5411 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5413 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5416 * EM interference sometimes causes badly shielded USB devices
5417 * to be shutdown by the hub, this hack enables them again.
5418 * Works at least with mouse driver.
5420 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5421 && !connect_change
&& udev
) {
5422 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5427 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5428 u16 status
= 0, unused
;
5429 port_dev
->over_current_count
++;
5430 port_over_current_notify(port_dev
);
5432 dev_dbg(&port_dev
->dev
, "over-current change #%u\n",
5433 port_dev
->over_current_count
);
5434 usb_clear_port_feature(hdev
, port1
,
5435 USB_PORT_FEAT_C_OVER_CURRENT
);
5436 msleep(100); /* Cool down */
5437 hub_power_on(hub
, true);
5438 hub_port_status(hub
, port1
, &status
, &unused
);
5439 if (status
& USB_PORT_STAT_OVERCURRENT
)
5440 dev_err(&port_dev
->dev
, "over-current condition\n");
5443 if (portchange
& USB_PORT_STAT_C_RESET
) {
5444 dev_dbg(&port_dev
->dev
, "reset change\n");
5445 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5447 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5448 && hub_is_superspeed(hdev
)) {
5449 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5450 usb_clear_port_feature(hdev
, port1
,
5451 USB_PORT_FEAT_C_BH_PORT_RESET
);
5453 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5454 dev_dbg(&port_dev
->dev
, "link state change\n");
5455 usb_clear_port_feature(hdev
, port1
,
5456 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5458 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5459 dev_warn(&port_dev
->dev
, "config error\n");
5460 usb_clear_port_feature(hdev
, port1
,
5461 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5464 /* skip port actions that require the port to be powered on */
5465 if (!pm_runtime_active(&port_dev
->dev
))
5468 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5472 * Warm reset a USB3 protocol port if it's in
5473 * SS.Inactive state.
5475 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5476 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5477 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5478 || udev
->state
== USB_STATE_NOTATTACHED
) {
5479 if (hub_port_reset(hub
, port1
, NULL
,
5480 HUB_BH_RESET_TIME
, true) < 0)
5481 hub_port_disable(hub
, port1
, 1);
5483 usb_unlock_port(port_dev
);
5484 usb_lock_device(udev
);
5485 usb_reset_device(udev
);
5486 usb_unlock_device(udev
);
5487 usb_lock_port(port_dev
);
5493 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5496 static void hub_event(struct work_struct
*work
)
5498 struct usb_device
*hdev
;
5499 struct usb_interface
*intf
;
5500 struct usb_hub
*hub
;
5501 struct device
*hub_dev
;
5506 hub
= container_of(work
, struct usb_hub
, events
);
5508 hub_dev
= hub
->intfdev
;
5509 intf
= to_usb_interface(hub_dev
);
5511 kcov_remote_start_usb((u64
)hdev
->bus
->busnum
);
5513 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5514 hdev
->state
, hdev
->maxchild
,
5515 /* NOTE: expects max 15 ports... */
5516 (u16
) hub
->change_bits
[0],
5517 (u16
) hub
->event_bits
[0]);
5519 /* Lock the device, then check to see if we were
5520 * disconnected while waiting for the lock to succeed. */
5521 usb_lock_device(hdev
);
5522 if (unlikely(hub
->disconnected
))
5525 /* If the hub has died, clean up after it */
5526 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5527 hub
->error
= -ENODEV
;
5528 hub_quiesce(hub
, HUB_DISCONNECT
);
5533 ret
= usb_autopm_get_interface(intf
);
5535 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5539 /* If this is an inactive hub, do nothing */
5544 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5546 ret
= usb_reset_device(hdev
);
5548 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5556 /* deal with port status changes */
5557 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5558 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5560 if (test_bit(i
, hub
->event_bits
)
5561 || test_bit(i
, hub
->change_bits
)
5562 || test_bit(i
, hub
->wakeup_bits
)) {
5564 * The get_noresume and barrier ensure that if
5565 * the port was in the process of resuming, we
5566 * flush that work and keep the port active for
5567 * the duration of the port_event(). However,
5568 * if the port is runtime pm suspended
5569 * (powered-off), we leave it in that state, run
5570 * an abbreviated port_event(), and move on.
5572 pm_runtime_get_noresume(&port_dev
->dev
);
5573 pm_runtime_barrier(&port_dev
->dev
);
5574 usb_lock_port(port_dev
);
5576 usb_unlock_port(port_dev
);
5577 pm_runtime_put_sync(&port_dev
->dev
);
5581 /* deal with hub status changes */
5582 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5584 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5585 dev_err(hub_dev
, "get_hub_status failed\n");
5587 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5588 dev_dbg(hub_dev
, "power change\n");
5589 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5590 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5591 /* FIXME: Is this always true? */
5592 hub
->limited_power
= 1;
5594 hub
->limited_power
= 0;
5596 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5600 dev_dbg(hub_dev
, "over-current change\n");
5601 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5602 msleep(500); /* Cool down */
5603 hub_power_on(hub
, true);
5604 hub_hub_status(hub
, &status
, &unused
);
5605 if (status
& HUB_STATUS_OVERCURRENT
)
5606 dev_err(hub_dev
, "over-current condition\n");
5611 /* Balance the usb_autopm_get_interface() above */
5612 usb_autopm_put_interface_no_suspend(intf
);
5614 usb_unlock_device(hdev
);
5616 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5617 usb_autopm_put_interface(intf
);
5618 kref_put(&hub
->kref
, hub_release
);
5623 static const struct usb_device_id hub_id_table
[] = {
5624 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
| USB_DEVICE_ID_MATCH_INT_CLASS
,
5625 .idVendor
= USB_VENDOR_SMSC
,
5626 .bInterfaceClass
= USB_CLASS_HUB
,
5627 .driver_info
= HUB_QUIRK_DISABLE_AUTOSUSPEND
},
5628 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5629 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5630 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5631 .bInterfaceClass
= USB_CLASS_HUB
,
5632 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5633 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5634 .bDeviceClass
= USB_CLASS_HUB
},
5635 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5636 .bInterfaceClass
= USB_CLASS_HUB
},
5637 { } /* Terminating entry */
5640 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5642 static struct usb_driver hub_driver
= {
5645 .disconnect
= hub_disconnect
,
5646 .suspend
= hub_suspend
,
5647 .resume
= hub_resume
,
5648 .reset_resume
= hub_reset_resume
,
5649 .pre_reset
= hub_pre_reset
,
5650 .post_reset
= hub_post_reset
,
5651 .unlocked_ioctl
= hub_ioctl
,
5652 .id_table
= hub_id_table
,
5653 .supports_autosuspend
= 1,
5656 int usb_hub_init(void)
5658 if (usb_register(&hub_driver
) < 0) {
5659 printk(KERN_ERR
"%s: can't register hub driver\n",
5665 * The workqueue needs to be freezable to avoid interfering with
5666 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5667 * device was gone before the EHCI controller had handed its port
5668 * over to the companion full-speed controller.
5670 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5674 /* Fall through if kernel_thread failed */
5675 usb_deregister(&hub_driver
);
5676 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5681 void usb_hub_cleanup(void)
5683 destroy_workqueue(hub_wq
);
5686 * Hub resources are freed for us by usb_deregister. It calls
5687 * usb_driver_purge on every device which in turn calls that
5688 * devices disconnect function if it is using this driver.
5689 * The hub_disconnect function takes care of releasing the
5690 * individual hub resources. -greg
5692 usb_deregister(&hub_driver
);
5693 } /* usb_hub_cleanup() */
5696 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5697 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5699 * WARNING - don't use this routine to reset a composite device
5700 * (one with multiple interfaces owned by separate drivers)!
5701 * Use usb_reset_device() instead.
5703 * Do a port reset, reassign the device's address, and establish its
5704 * former operating configuration. If the reset fails, or the device's
5705 * descriptors change from their values before the reset, or the original
5706 * configuration and altsettings cannot be restored, a flag will be set
5707 * telling hub_wq to pretend the device has been disconnected and then
5708 * re-connected. All drivers will be unbound, and the device will be
5709 * re-enumerated and probed all over again.
5711 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5712 * flagged for logical disconnection, or some other negative error code
5713 * if the reset wasn't even attempted.
5716 * The caller must own the device lock and the port lock, the latter is
5717 * taken by usb_reset_device(). For example, it's safe to use
5718 * usb_reset_device() from a driver probe() routine after downloading
5719 * new firmware. For calls that might not occur during probe(), drivers
5720 * should lock the device using usb_lock_device_for_reset().
5722 * Locking exception: This routine may also be called from within an
5723 * autoresume handler. Such usage won't conflict with other tasks
5724 * holding the device lock because these tasks should always call
5725 * usb_autopm_resume_device(), thereby preventing any unwanted
5726 * autoresume. The autoresume handler is expected to have already
5727 * acquired the port lock before calling this routine.
5729 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5731 struct usb_device
*parent_hdev
= udev
->parent
;
5732 struct usb_hub
*parent_hub
;
5733 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5734 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5735 struct usb_host_bos
*bos
;
5737 int port1
= udev
->portnum
;
5739 if (udev
->state
== USB_STATE_NOTATTACHED
||
5740 udev
->state
== USB_STATE_SUSPENDED
) {
5741 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5749 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5751 /* Disable USB2 hardware LPM.
5752 * It will be re-enabled by the enumeration process.
5754 usb_disable_usb2_hardware_lpm(udev
);
5756 /* Disable LPM while we reset the device and reinstall the alt settings.
5757 * Device-initiated LPM, and system exit latency settings are cleared
5758 * when the device is reset, so we have to set them up again.
5760 ret
= usb_unlocked_disable_lpm(udev
);
5762 dev_err(&udev
->dev
, "%s Failed to disable LPM\n", __func__
);
5763 goto re_enumerate_no_bos
;
5769 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5771 /* ep0 maxpacket size may change; let the HCD know about it.
5772 * Other endpoints will be handled by re-enumeration. */
5773 usb_ep0_reinit(udev
);
5774 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5775 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5782 /* Device might have changed firmware (DFU or similar) */
5783 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5784 dev_info(&udev
->dev
, "device firmware changed\n");
5785 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5789 /* Restore the device's previous configuration */
5790 if (!udev
->actconfig
)
5793 mutex_lock(hcd
->bandwidth_mutex
);
5794 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5796 dev_warn(&udev
->dev
,
5797 "Busted HC? Not enough HCD resources for "
5798 "old configuration.\n");
5799 mutex_unlock(hcd
->bandwidth_mutex
);
5802 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5803 USB_REQ_SET_CONFIGURATION
, 0,
5804 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5805 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5808 "can't restore configuration #%d (error=%d)\n",
5809 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5810 mutex_unlock(hcd
->bandwidth_mutex
);
5813 mutex_unlock(hcd
->bandwidth_mutex
);
5814 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5816 /* Put interfaces back into the same altsettings as before.
5817 * Don't bother to send the Set-Interface request for interfaces
5818 * that were already in altsetting 0; besides being unnecessary,
5819 * many devices can't handle it. Instead just reset the host-side
5822 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5823 struct usb_host_config
*config
= udev
->actconfig
;
5824 struct usb_interface
*intf
= config
->interface
[i
];
5825 struct usb_interface_descriptor
*desc
;
5827 desc
= &intf
->cur_altsetting
->desc
;
5828 if (desc
->bAlternateSetting
== 0) {
5829 usb_disable_interface(udev
, intf
, true);
5830 usb_enable_interface(udev
, intf
, true);
5833 /* Let the bandwidth allocation function know that this
5834 * device has been reset, and it will have to use
5835 * alternate setting 0 as the current alternate setting.
5837 intf
->resetting_device
= 1;
5838 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5839 desc
->bAlternateSetting
);
5840 intf
->resetting_device
= 0;
5843 dev_err(&udev
->dev
, "failed to restore interface %d "
5844 "altsetting %d (error=%d)\n",
5845 desc
->bInterfaceNumber
,
5846 desc
->bAlternateSetting
,
5850 /* Resetting also frees any allocated streams */
5851 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5852 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5856 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5857 usb_enable_usb2_hardware_lpm(udev
);
5858 usb_unlocked_enable_lpm(udev
);
5859 usb_enable_ltm(udev
);
5860 usb_release_bos_descriptor(udev
);
5865 usb_release_bos_descriptor(udev
);
5867 re_enumerate_no_bos
:
5868 /* LPM state doesn't matter when we're about to destroy the device. */
5869 hub_port_logical_disconnect(parent_hub
, port1
);
5874 * usb_reset_device - warn interface drivers and perform a USB port reset
5875 * @udev: device to reset (not in NOTATTACHED state)
5877 * Warns all drivers bound to registered interfaces (using their pre_reset
5878 * method), performs the port reset, and then lets the drivers know that
5879 * the reset is over (using their post_reset method).
5881 * Return: The same as for usb_reset_and_verify_device().
5884 * The caller must own the device lock. For example, it's safe to use
5885 * this from a driver probe() routine after downloading new firmware.
5886 * For calls that might not occur during probe(), drivers should lock
5887 * the device using usb_lock_device_for_reset().
5889 * If an interface is currently being probed or disconnected, we assume
5890 * its driver knows how to handle resets. For all other interfaces,
5891 * if the driver doesn't have pre_reset and post_reset methods then
5892 * we attempt to unbind it and rebind afterward.
5894 int usb_reset_device(struct usb_device
*udev
)
5898 unsigned int noio_flag
;
5899 struct usb_port
*port_dev
;
5900 struct usb_host_config
*config
= udev
->actconfig
;
5901 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5903 if (udev
->state
== USB_STATE_NOTATTACHED
) {
5904 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5909 if (!udev
->parent
) {
5910 /* this requires hcd-specific logic; see ohci_restart() */
5911 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5915 port_dev
= hub
->ports
[udev
->portnum
- 1];
5918 * Don't allocate memory with GFP_KERNEL in current
5919 * context to avoid possible deadlock if usb mass
5920 * storage interface or usbnet interface(iSCSI case)
5921 * is included in current configuration. The easist
5922 * approach is to do it for every device reset,
5923 * because the device 'memalloc_noio' flag may have
5924 * not been set before reseting the usb device.
5926 noio_flag
= memalloc_noio_save();
5928 /* Prevent autosuspend during the reset */
5929 usb_autoresume_device(udev
);
5932 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5933 struct usb_interface
*cintf
= config
->interface
[i
];
5934 struct usb_driver
*drv
;
5937 if (cintf
->dev
.driver
) {
5938 drv
= to_usb_driver(cintf
->dev
.driver
);
5939 if (drv
->pre_reset
&& drv
->post_reset
)
5940 unbind
= (drv
->pre_reset
)(cintf
);
5941 else if (cintf
->condition
==
5942 USB_INTERFACE_BOUND
)
5945 usb_forced_unbind_intf(cintf
);
5950 usb_lock_port(port_dev
);
5951 ret
= usb_reset_and_verify_device(udev
);
5952 usb_unlock_port(port_dev
);
5955 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5956 struct usb_interface
*cintf
= config
->interface
[i
];
5957 struct usb_driver
*drv
;
5958 int rebind
= cintf
->needs_binding
;
5960 if (!rebind
&& cintf
->dev
.driver
) {
5961 drv
= to_usb_driver(cintf
->dev
.driver
);
5962 if (drv
->post_reset
)
5963 rebind
= (drv
->post_reset
)(cintf
);
5964 else if (cintf
->condition
==
5965 USB_INTERFACE_BOUND
)
5968 cintf
->needs_binding
= 1;
5972 /* If the reset failed, hub_wq will unbind drivers later */
5974 usb_unbind_and_rebind_marked_interfaces(udev
);
5977 usb_autosuspend_device(udev
);
5978 memalloc_noio_restore(noio_flag
);
5981 EXPORT_SYMBOL_GPL(usb_reset_device
);
5985 * usb_queue_reset_device - Reset a USB device from an atomic context
5986 * @iface: USB interface belonging to the device to reset
5988 * This function can be used to reset a USB device from an atomic
5989 * context, where usb_reset_device() won't work (as it blocks).
5991 * Doing a reset via this method is functionally equivalent to calling
5992 * usb_reset_device(), except for the fact that it is delayed to a
5993 * workqueue. This means that any drivers bound to other interfaces
5994 * might be unbound, as well as users from usbfs in user space.
5998 * - Scheduling two resets at the same time from two different drivers
5999 * attached to two different interfaces of the same device is
6000 * possible; depending on how the driver attached to each interface
6001 * handles ->pre_reset(), the second reset might happen or not.
6003 * - If the reset is delayed so long that the interface is unbound from
6004 * its driver, the reset will be skipped.
6006 * - This function can be called during .probe(). It can also be called
6007 * during .disconnect(), but doing so is pointless because the reset
6008 * will not occur. If you really want to reset the device during
6009 * .disconnect(), call usb_reset_device() directly -- but watch out
6010 * for nested unbinding issues!
6012 void usb_queue_reset_device(struct usb_interface
*iface
)
6014 if (schedule_work(&iface
->reset_ws
))
6015 usb_get_intf(iface
);
6017 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
6020 * usb_hub_find_child - Get the pointer of child device
6021 * attached to the port which is specified by @port1.
6022 * @hdev: USB device belonging to the usb hub
6023 * @port1: port num to indicate which port the child device
6026 * USB drivers call this function to get hub's child device
6029 * Return: %NULL if input param is invalid and
6030 * child's usb_device pointer if non-NULL.
6032 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
6035 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6037 if (port1
< 1 || port1
> hdev
->maxchild
)
6039 return hub
->ports
[port1
- 1]->child
;
6041 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
6043 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
6044 struct usb_hub_descriptor
*desc
)
6046 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6047 enum usb_port_connect_type connect_type
;
6053 if (!hub_is_superspeed(hdev
)) {
6054 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6055 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6057 connect_type
= port_dev
->connect_type
;
6058 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6059 u8 mask
= 1 << (i
%8);
6061 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
6062 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6063 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
6068 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
6070 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
6071 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
6073 connect_type
= port_dev
->connect_type
;
6074 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
6077 if (!(port_removable
& mask
)) {
6078 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
6079 port_removable
|= mask
;
6084 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
6090 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6091 * @hdev: USB device belonging to the usb hub
6092 * @port1: port num of the port
6094 * Return: Port's acpi handle if successful, %NULL if params are
6097 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
6100 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
6105 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);