4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
9 * Released under the GPLv2 only.
10 * SPDX-License-Identifier: GPL-2.0
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/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
41 /* Protect struct usb_device->state and ->children members
42 * Note: Both are also protected by ->dev.sem, except that ->state can
43 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
44 static DEFINE_SPINLOCK(device_state_lock
);
46 /* workqueue to process hub events */
47 static struct workqueue_struct
*hub_wq
;
48 static void hub_event(struct work_struct
*work
);
50 /* synchronize hub-port add/remove and peering operations */
51 DEFINE_MUTEX(usb_port_peer_mutex
);
53 /* cycle leds on hubs that aren't blinking for attention */
54 static bool blinkenlights
;
55 module_param(blinkenlights
, bool, S_IRUGO
);
56 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
59 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
60 * 10 seconds to send reply for the initial 64-byte descriptor request.
62 /* define initial 64-byte descriptor request timeout in milliseconds */
63 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
64 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
65 MODULE_PARM_DESC(initial_descriptor_timeout
,
66 "initial 64-byte descriptor request timeout in milliseconds "
67 "(default 5000 - 5.0 seconds)");
70 * As of 2.6.10 we introduce a new USB device initialization scheme which
71 * closely resembles the way Windows works. Hopefully it will be compatible
72 * with a wider range of devices than the old scheme. However some previously
73 * working devices may start giving rise to "device not accepting address"
74 * errors; if that happens the user can try the old scheme by adjusting the
75 * following module parameters.
77 * For maximum flexibility there are two boolean parameters to control the
78 * hub driver's behavior. On the first initialization attempt, if the
79 * "old_scheme_first" parameter is set then the old scheme will be used,
80 * otherwise the new scheme is used. If that fails and "use_both_schemes"
81 * is set, then the driver will make another attempt, using the other scheme.
83 static bool old_scheme_first
;
84 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
85 MODULE_PARM_DESC(old_scheme_first
,
86 "start with the old device initialization scheme");
88 static bool use_both_schemes
= 1;
89 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
90 MODULE_PARM_DESC(use_both_schemes
,
91 "try the other device initialization scheme if the "
94 /* Mutual exclusion for EHCI CF initialization. This interferes with
95 * port reset on some companion controllers.
97 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
98 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
100 #define HUB_DEBOUNCE_TIMEOUT 2000
101 #define HUB_DEBOUNCE_STEP 25
102 #define HUB_DEBOUNCE_STABLE 100
104 static void hub_release(struct kref
*kref
);
105 static int usb_reset_and_verify_device(struct usb_device
*udev
);
106 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
108 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
110 if (hub_is_superspeedplus(hub
->hdev
))
112 if (hub_is_superspeed(hub
->hdev
))
114 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
116 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
122 /* Note that hdev or one of its children must be locked! */
123 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
125 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
127 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
130 int usb_device_supports_lpm(struct usb_device
*udev
)
132 /* Some devices have trouble with LPM */
133 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
136 /* USB 2.1 (and greater) devices indicate LPM support through
137 * their USB 2.0 Extended Capabilities BOS descriptor.
139 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
140 if (udev
->bos
->ext_cap
&&
142 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
148 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
149 * However, there are some that don't, and they set the U1/U2 exit
152 if (!udev
->bos
->ss_cap
) {
153 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
157 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
158 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
160 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
162 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
166 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device
*udev
,
176 struct usb3_lpm_parameters
*udev_lpm_params
,
177 unsigned int udev_exit_latency
,
179 struct usb3_lpm_parameters
*hub_lpm_params
,
180 unsigned int hub_exit_latency
)
182 unsigned int total_mel
;
183 unsigned int device_mel
;
184 unsigned int hub_mel
;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel
= hub_lpm_params
->mel
+
196 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel
= udev_exit_latency
* 1000;
207 hub_mel
= hub_exit_latency
* 1000;
208 if (device_mel
> hub_mel
)
209 total_mel
+= device_mel
;
211 total_mel
+= hub_mel
;
213 udev_lpm_params
->mel
= total_mel
;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device
*udev
,
221 struct usb3_lpm_parameters
*udev_lpm_params
,
222 unsigned int udev_exit_latency
,
224 struct usb3_lpm_parameters
*hub_lpm_params
,
225 unsigned int hub_exit_latency
,
226 unsigned int port_to_port_exit_latency
)
228 unsigned int first_link_pel
;
229 unsigned int hub_pel
;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency
> hub_exit_latency
)
237 first_link_pel
= udev_exit_latency
* 1000;
239 first_link_pel
= hub_exit_latency
* 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel
> hub_pel
)
254 udev_lpm_params
->pel
= first_link_pel
;
256 udev_lpm_params
->pel
= hub_pel
;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device
*udev
,
275 struct usb3_lpm_parameters
*udev_lpm_params
)
277 struct usb_device
*parent
;
278 unsigned int num_hubs
;
279 unsigned int total_sel
;
281 /* t1 = device PEL */
282 total_sel
= udev_lpm_params
->pel
;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
285 parent
= parent
->parent
)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel
+= 2100 + 250 * (num_hubs
- 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel
+= 250 * num_hubs
;
294 udev_lpm_params
->sel
= total_sel
;
297 static void usb_set_lpm_parameters(struct usb_device
*udev
)
300 unsigned int port_to_port_delay
;
301 unsigned int udev_u1_del
;
302 unsigned int udev_u2_del
;
303 unsigned int hub_u1_del
;
304 unsigned int hub_u2_del
;
306 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
309 hub
= usb_hub_to_struct_hub(udev
->parent
);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
317 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
318 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
319 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
321 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
322 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
324 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
325 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay
= 1;
346 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
347 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
350 if (hub_u2_del
> hub_u1_del
)
351 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
353 port_to_port_delay
= 1 + hub_u1_del
;
355 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
356 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev
, &udev
->u1_params
);
361 usb_set_lpm_sel(udev
, &udev
->u2_params
);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device
*hdev
,
366 struct usb_hub_descriptor
*desc
)
371 if (hub_is_superspeed(hdev
)) {
372 dtype
= USB_DT_SS_HUB
;
373 size
= USB_DT_SS_HUB_SIZE
;
376 size
= sizeof(struct usb_hub_descriptor
);
379 for (i
= 0; i
< 3; i
++) {
380 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
381 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
382 dtype
<< 8, 0, desc
, size
,
383 USB_CTRL_GET_TIMEOUT
);
384 if (hub_is_superspeed(hdev
)) {
387 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
388 /* Make sure we have the DeviceRemovable field. */
389 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
399 * USB 2.0 spec Section 11.24.2.1
401 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
403 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
404 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
408 * USB 2.0 spec Section 11.24.2.2
410 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
412 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
413 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
418 * USB 2.0 spec Section 11.24.2.13
420 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
422 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
423 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
427 static char *to_led_name(int selector
)
444 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
445 * for info about using port indicators
447 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
449 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
452 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
453 USB_PORT_FEAT_INDICATOR
);
454 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
455 to_led_name(selector
), status
);
458 #define LED_CYCLE_PERIOD ((2*HZ)/3)
460 static void led_work(struct work_struct
*work
)
462 struct usb_hub
*hub
=
463 container_of(work
, struct usb_hub
, leds
.work
);
464 struct usb_device
*hdev
= hub
->hdev
;
466 unsigned changed
= 0;
469 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
472 for (i
= 0; i
< hdev
->maxchild
; i
++) {
473 unsigned selector
, mode
;
475 /* 30%-50% duty cycle */
477 switch (hub
->indicator
[i
]) {
479 case INDICATOR_CYCLE
:
481 selector
= HUB_LED_AUTO
;
482 mode
= INDICATOR_AUTO
;
484 /* blinking green = sw attention */
485 case INDICATOR_GREEN_BLINK
:
486 selector
= HUB_LED_GREEN
;
487 mode
= INDICATOR_GREEN_BLINK_OFF
;
489 case INDICATOR_GREEN_BLINK_OFF
:
490 selector
= HUB_LED_OFF
;
491 mode
= INDICATOR_GREEN_BLINK
;
493 /* blinking amber = hw attention */
494 case INDICATOR_AMBER_BLINK
:
495 selector
= HUB_LED_AMBER
;
496 mode
= INDICATOR_AMBER_BLINK_OFF
;
498 case INDICATOR_AMBER_BLINK_OFF
:
499 selector
= HUB_LED_OFF
;
500 mode
= INDICATOR_AMBER_BLINK
;
502 /* blink green/amber = reserved */
503 case INDICATOR_ALT_BLINK
:
504 selector
= HUB_LED_GREEN
;
505 mode
= INDICATOR_ALT_BLINK_OFF
;
507 case INDICATOR_ALT_BLINK_OFF
:
508 selector
= HUB_LED_AMBER
;
509 mode
= INDICATOR_ALT_BLINK
;
514 if (selector
!= HUB_LED_AUTO
)
516 set_port_led(hub
, i
+ 1, selector
);
517 hub
->indicator
[i
] = mode
;
519 if (!changed
&& blinkenlights
) {
521 cursor
%= hdev
->maxchild
;
522 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
523 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
527 queue_delayed_work(system_power_efficient_wq
,
528 &hub
->leds
, LED_CYCLE_PERIOD
);
531 /* use a short timeout for hub/port status fetches */
532 #define USB_STS_TIMEOUT 1000
533 #define USB_STS_RETRIES 5
536 * USB 2.0 spec Section 11.24.2.6
538 static int get_hub_status(struct usb_device
*hdev
,
539 struct usb_hub_status
*data
)
541 int i
, status
= -ETIMEDOUT
;
543 for (i
= 0; i
< USB_STS_RETRIES
&&
544 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
545 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
546 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
547 data
, sizeof(*data
), USB_STS_TIMEOUT
);
553 * USB 2.0 spec Section 11.24.2.7
554 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
556 static int get_port_status(struct usb_device
*hdev
, int port1
,
557 void *data
, u16 value
, u16 length
)
559 int i
, status
= -ETIMEDOUT
;
561 for (i
= 0; i
< USB_STS_RETRIES
&&
562 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
563 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
564 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
565 port1
, data
, length
, USB_STS_TIMEOUT
);
570 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
571 u16
*status
, u16
*change
, u32
*ext_status
)
576 if (type
!= HUB_PORT_STATUS
)
579 mutex_lock(&hub
->status_mutex
);
580 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
583 dev_err(hub
->intfdev
,
584 "%s failed (err = %d)\n", __func__
, ret
);
588 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
589 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
590 if (type
!= HUB_PORT_STATUS
&& ext_status
)
591 *ext_status
= le32_to_cpu(
592 hub
->status
->port
.dwExtPortStatus
);
595 mutex_unlock(&hub
->status_mutex
);
599 static int hub_port_status(struct usb_hub
*hub
, int port1
,
600 u16
*status
, u16
*change
)
602 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
603 status
, change
, NULL
);
606 static void kick_hub_wq(struct usb_hub
*hub
)
608 struct usb_interface
*intf
;
610 if (hub
->disconnected
|| work_pending(&hub
->events
))
614 * Suppress autosuspend until the event is proceed.
616 * Be careful and make sure that the symmetric operation is
617 * always called. We are here only when there is no pending
618 * work for this hub. Therefore put the interface either when
619 * the new work is called or when it is canceled.
621 intf
= to_usb_interface(hub
->intfdev
);
622 usb_autopm_get_interface_no_resume(intf
);
623 kref_get(&hub
->kref
);
625 if (queue_work(hub_wq
, &hub
->events
))
628 /* the work has already been scheduled */
629 usb_autopm_put_interface_async(intf
);
630 kref_put(&hub
->kref
, hub_release
);
633 void usb_kick_hub_wq(struct usb_device
*hdev
)
635 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
642 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
643 * Notification, which indicates it had initiated remote wakeup.
645 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
646 * device initiates resume, so the USB core will not receive notice of the
647 * resume through the normal hub interrupt URB.
649 void usb_wakeup_notification(struct usb_device
*hdev
,
650 unsigned int portnum
)
657 hub
= usb_hub_to_struct_hub(hdev
);
659 set_bit(portnum
, hub
->wakeup_bits
);
663 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
665 /* completion function, fires on port status changes and various faults */
666 static void hub_irq(struct urb
*urb
)
668 struct usb_hub
*hub
= urb
->context
;
669 int status
= urb
->status
;
674 case -ENOENT
: /* synchronous unlink */
675 case -ECONNRESET
: /* async unlink */
676 case -ESHUTDOWN
: /* hardware going away */
679 default: /* presumably an error */
680 /* Cause a hub reset after 10 consecutive errors */
681 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
682 if ((++hub
->nerrors
< 10) || hub
->error
)
687 /* let hub_wq handle things */
688 case 0: /* we got data: port status changed */
690 for (i
= 0; i
< urb
->actual_length
; ++i
)
691 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
693 hub
->event_bits
[0] = bits
;
699 /* Something happened, let hub_wq figure it out */
706 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
707 if (status
!= 0 && status
!= -ENODEV
&& status
!= -EPERM
)
708 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
711 /* USB 2.0 spec Section 11.24.2.3 */
713 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
715 /* Need to clear both directions for control ep */
716 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
717 USB_ENDPOINT_XFER_CONTROL
) {
718 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
719 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
720 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
724 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
725 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
730 * enumeration blocks hub_wq for a long time. we use keventd instead, since
731 * long blocking there is the exception, not the rule. accordingly, HCDs
732 * talking to TTs must queue control transfers (not just bulk and iso), so
733 * both can talk to the same hub concurrently.
735 static void hub_tt_work(struct work_struct
*work
)
737 struct usb_hub
*hub
=
738 container_of(work
, struct usb_hub
, tt
.clear_work
);
741 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
742 while (!list_empty(&hub
->tt
.clear_list
)) {
743 struct list_head
*next
;
744 struct usb_tt_clear
*clear
;
745 struct usb_device
*hdev
= hub
->hdev
;
746 const struct hc_driver
*drv
;
749 next
= hub
->tt
.clear_list
.next
;
750 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
751 list_del(&clear
->clear_list
);
753 /* drop lock so HCD can concurrently report other TT errors */
754 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
755 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
756 if (status
&& status
!= -ENODEV
)
758 "clear tt %d (%04x) error %d\n",
759 clear
->tt
, clear
->devinfo
, status
);
761 /* Tell the HCD, even if the operation failed */
762 drv
= clear
->hcd
->driver
;
763 if (drv
->clear_tt_buffer_complete
)
764 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
767 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
769 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
773 * usb_hub_set_port_power - control hub port's power state
774 * @hdev: USB device belonging to the usb hub
777 * @set: expected status
779 * call this function to control port's power via setting or
780 * clearing the port's PORT_POWER feature.
782 * Return: 0 if successful. A negative error code otherwise.
784 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
790 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
792 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
798 set_bit(port1
, hub
->power_bits
);
800 clear_bit(port1
, hub
->power_bits
);
805 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
806 * @urb: an URB associated with the failed or incomplete split transaction
808 * High speed HCDs use this to tell the hub driver that some split control or
809 * bulk transaction failed in a way that requires clearing internal state of
810 * a transaction translator. This is normally detected (and reported) from
813 * It may not be possible for that hub to handle additional full (or low)
814 * speed transactions until that state is fully cleared out.
816 * Return: 0 if successful. A negative error code otherwise.
818 int usb_hub_clear_tt_buffer(struct urb
*urb
)
820 struct usb_device
*udev
= urb
->dev
;
821 int pipe
= urb
->pipe
;
822 struct usb_tt
*tt
= udev
->tt
;
824 struct usb_tt_clear
*clear
;
826 /* we've got to cope with an arbitrary number of pending TT clears,
827 * since each TT has "at least two" buffers that can need it (and
828 * there can be many TTs per hub). even if they're uncommon.
830 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
832 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
833 /* FIXME recover somehow ... RESET_TT? */
837 /* info that CLEAR_TT_BUFFER needs */
838 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
839 clear
->devinfo
= usb_pipeendpoint (pipe
);
840 clear
->devinfo
|= udev
->devnum
<< 4;
841 clear
->devinfo
|= usb_pipecontrol(pipe
)
842 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
843 : (USB_ENDPOINT_XFER_BULK
<< 11);
844 if (usb_pipein(pipe
))
845 clear
->devinfo
|= 1 << 15;
847 /* info for completion callback */
848 clear
->hcd
= bus_to_hcd(udev
->bus
);
851 /* tell keventd to clear state for this TT */
852 spin_lock_irqsave(&tt
->lock
, flags
);
853 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
854 schedule_work(&tt
->clear_work
);
855 spin_unlock_irqrestore(&tt
->lock
, flags
);
858 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
860 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
864 /* Enable power on each port. Some hubs have reserved values
865 * of LPSM (> 2) in their descriptors, even though they are
866 * USB 2.0 hubs. Some hubs do not implement port-power switching
867 * but only emulate it. In all cases, the ports won't work
868 * unless we send these messages to the hub.
870 if (hub_is_port_power_switchable(hub
))
871 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
873 dev_dbg(hub
->intfdev
, "trying to enable port power on "
874 "non-switchable hub\n");
875 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
876 if (test_bit(port1
, hub
->power_bits
))
877 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
879 usb_clear_port_feature(hub
->hdev
, port1
,
880 USB_PORT_FEAT_POWER
);
882 msleep(hub_power_on_good_delay(hub
));
885 static int hub_hub_status(struct usb_hub
*hub
,
886 u16
*status
, u16
*change
)
890 mutex_lock(&hub
->status_mutex
);
891 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
894 dev_err(hub
->intfdev
,
895 "%s failed (err = %d)\n", __func__
, ret
);
897 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
898 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
901 mutex_unlock(&hub
->status_mutex
);
905 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
906 unsigned int link_status
)
908 return set_port_feature(hub
->hdev
,
909 port1
| (link_status
<< 3),
910 USB_PORT_FEAT_LINK_STATE
);
914 * Disable a port and mark a logical connect-change event, so that some
915 * time later hub_wq will disconnect() any existing usb_device on the port
916 * and will re-enumerate if there actually is a device attached.
918 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
920 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
921 hub_port_disable(hub
, port1
, 1);
923 /* FIXME let caller ask to power down the port:
924 * - some devices won't enumerate without a VBUS power cycle
925 * - SRP saves power that way
926 * - ... new call, TBD ...
927 * That's easy if this hub can switch power per-port, and
928 * hub_wq reactivates the port later (timer, SRP, etc).
929 * Powerdown must be optional, because of reset/DFU.
932 set_bit(port1
, hub
->change_bits
);
937 * usb_remove_device - disable a device's port on its parent hub
938 * @udev: device to be disabled and removed
939 * Context: @udev locked, must be able to sleep.
941 * After @udev's port has been disabled, hub_wq is notified and it will
942 * see that the device has been disconnected. When the device is
943 * physically unplugged and something is plugged in, the events will
944 * be received and processed normally.
946 * Return: 0 if successful. A negative error code otherwise.
948 int usb_remove_device(struct usb_device
*udev
)
951 struct usb_interface
*intf
;
953 if (!udev
->parent
) /* Can't remove a root hub */
955 hub
= usb_hub_to_struct_hub(udev
->parent
);
956 intf
= to_usb_interface(hub
->intfdev
);
958 usb_autopm_get_interface(intf
);
959 set_bit(udev
->portnum
, hub
->removed_bits
);
960 hub_port_logical_disconnect(hub
, udev
->portnum
);
961 usb_autopm_put_interface(intf
);
965 enum hub_activation_type
{
966 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
967 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
970 static void hub_init_func2(struct work_struct
*ws
);
971 static void hub_init_func3(struct work_struct
*ws
);
973 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
975 struct usb_device
*hdev
= hub
->hdev
;
980 bool need_debounce_delay
= false;
983 /* Continue a partial initialization */
984 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
985 device_lock(&hdev
->dev
);
987 /* Was the hub disconnected while we were waiting? */
988 if (hub
->disconnected
)
990 if (type
== HUB_INIT2
)
994 kref_get(&hub
->kref
);
996 /* The superspeed hub except for root hub has to use Hub Depth
997 * value as an offset into the route string to locate the bits
998 * it uses to determine the downstream port number. So hub driver
999 * should send a set hub depth request to superspeed hub after
1000 * the superspeed hub is set configuration in initialization or
1003 * After a resume, port power should still be on.
1004 * For any other type of activation, turn it on.
1006 if (type
!= HUB_RESUME
) {
1007 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1008 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1009 HUB_SET_DEPTH
, USB_RT_HUB
,
1010 hdev
->level
- 1, 0, NULL
, 0,
1011 USB_CTRL_SET_TIMEOUT
);
1013 dev_err(hub
->intfdev
,
1014 "set hub depth failed\n");
1017 /* Speed up system boot by using a delayed_work for the
1018 * hub's initial power-up delays. This is pretty awkward
1019 * and the implementation looks like a home-brewed sort of
1020 * setjmp/longjmp, but it saves at least 100 ms for each
1021 * root hub (assuming usbcore is compiled into the kernel
1022 * rather than as a module). It adds up.
1024 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1025 * because for those activation types the ports have to be
1026 * operational when we return. In theory this could be done
1027 * for HUB_POST_RESET, but it's easier not to.
1029 if (type
== HUB_INIT
) {
1030 delay
= hub_power_on_good_delay(hub
);
1032 hub_power_on(hub
, false);
1033 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1034 queue_delayed_work(system_power_efficient_wq
,
1036 msecs_to_jiffies(delay
));
1038 /* Suppress autosuspend until init is done */
1039 usb_autopm_get_interface_no_resume(
1040 to_usb_interface(hub
->intfdev
));
1041 return; /* Continues at init2: below */
1042 } else if (type
== HUB_RESET_RESUME
) {
1043 /* The internal host controller state for the hub device
1044 * may be gone after a host power loss on system resume.
1045 * Update the device's info so the HW knows it's a hub.
1047 hcd
= bus_to_hcd(hdev
->bus
);
1048 if (hcd
->driver
->update_hub_device
) {
1049 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1050 &hub
->tt
, GFP_NOIO
);
1052 dev_err(hub
->intfdev
, "Host not "
1053 "accepting hub info "
1055 dev_err(hub
->intfdev
, "LS/FS devices "
1056 "and hubs may not work "
1057 "under this hub\n.");
1060 hub_power_on(hub
, true);
1062 hub_power_on(hub
, true);
1068 * Check each port and set hub->change_bits to let hub_wq know
1069 * which ports need attention.
1071 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1072 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1073 struct usb_device
*udev
= port_dev
->child
;
1074 u16 portstatus
, portchange
;
1076 portstatus
= portchange
= 0;
1077 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1081 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1082 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1083 portstatus
, portchange
);
1086 * After anything other than HUB_RESUME (i.e., initialization
1087 * or any sort of reset), every port should be disabled.
1088 * Unconnected ports should likewise be disabled (paranoia),
1089 * and so should ports for which we have no usb_device.
1091 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1092 type
!= HUB_RESUME
||
1093 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1095 udev
->state
== USB_STATE_NOTATTACHED
)) {
1097 * USB3 protocol ports will automatically transition
1098 * to Enabled state when detect an USB3.0 device attach.
1099 * Do not disable USB3 protocol ports, just pretend
1102 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1103 if (!hub_is_superspeed(hdev
))
1104 usb_clear_port_feature(hdev
, port1
,
1105 USB_PORT_FEAT_ENABLE
);
1108 /* Clear status-change flags; we'll debounce later */
1109 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1110 need_debounce_delay
= true;
1111 usb_clear_port_feature(hub
->hdev
, port1
,
1112 USB_PORT_FEAT_C_CONNECTION
);
1114 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1115 need_debounce_delay
= true;
1116 usb_clear_port_feature(hub
->hdev
, port1
,
1117 USB_PORT_FEAT_C_ENABLE
);
1119 if (portchange
& USB_PORT_STAT_C_RESET
) {
1120 need_debounce_delay
= true;
1121 usb_clear_port_feature(hub
->hdev
, port1
,
1122 USB_PORT_FEAT_C_RESET
);
1124 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1125 hub_is_superspeed(hub
->hdev
)) {
1126 need_debounce_delay
= true;
1127 usb_clear_port_feature(hub
->hdev
, port1
,
1128 USB_PORT_FEAT_C_BH_PORT_RESET
);
1130 /* We can forget about a "removed" device when there's a
1131 * physical disconnect or the connect status changes.
1133 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1134 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1135 clear_bit(port1
, hub
->removed_bits
);
1137 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1138 /* Tell hub_wq to disconnect the device or
1139 * check for a new connection
1141 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1142 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1143 set_bit(port1
, hub
->change_bits
);
1145 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1146 bool port_resumed
= (portstatus
&
1147 USB_PORT_STAT_LINK_STATE
) ==
1149 /* The power session apparently survived the resume.
1150 * If there was an overcurrent or suspend change
1151 * (i.e., remote wakeup request), have hub_wq
1152 * take care of it. Look at the port link state
1153 * for USB 3.0 hubs, since they don't have a suspend
1154 * change bit, and they don't set the port link change
1155 * bit on device-initiated resume.
1157 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1159 set_bit(port1
, hub
->change_bits
);
1161 } else if (udev
->persist_enabled
) {
1163 udev
->reset_resume
= 1;
1165 /* Don't set the change_bits when the device
1168 if (test_bit(port1
, hub
->power_bits
))
1169 set_bit(port1
, hub
->change_bits
);
1172 /* The power session is gone; tell hub_wq */
1173 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1174 set_bit(port1
, hub
->change_bits
);
1178 /* If no port-status-change flags were set, we don't need any
1179 * debouncing. If flags were set we can try to debounce the
1180 * ports all at once right now, instead of letting hub_wq do them
1181 * one at a time later on.
1183 * If any port-status changes do occur during this delay, hub_wq
1184 * will see them later and handle them normally.
1186 if (need_debounce_delay
) {
1187 delay
= HUB_DEBOUNCE_STABLE
;
1189 /* Don't do a long sleep inside a workqueue routine */
1190 if (type
== HUB_INIT2
) {
1191 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1192 queue_delayed_work(system_power_efficient_wq
,
1194 msecs_to_jiffies(delay
));
1195 device_unlock(&hdev
->dev
);
1196 return; /* Continues at init3: below */
1204 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1206 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1207 if (hub
->has_indicators
&& blinkenlights
)
1208 queue_delayed_work(system_power_efficient_wq
,
1209 &hub
->leds
, LED_CYCLE_PERIOD
);
1211 /* Scan all ports that need attention */
1214 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1215 /* Allow autosuspend if it was suppressed */
1217 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1218 device_unlock(&hdev
->dev
);
1221 kref_put(&hub
->kref
, hub_release
);
1224 /* Implement the continuations for the delays above */
1225 static void hub_init_func2(struct work_struct
*ws
)
1227 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1229 hub_activate(hub
, HUB_INIT2
);
1232 static void hub_init_func3(struct work_struct
*ws
)
1234 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1236 hub_activate(hub
, HUB_INIT3
);
1239 enum hub_quiescing_type
{
1240 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1243 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1245 struct usb_device
*hdev
= hub
->hdev
;
1248 /* hub_wq and related activity won't re-trigger */
1251 if (type
!= HUB_SUSPEND
) {
1252 /* Disconnect all the children */
1253 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1254 if (hub
->ports
[i
]->child
)
1255 usb_disconnect(&hub
->ports
[i
]->child
);
1259 /* Stop hub_wq and related activity */
1260 usb_kill_urb(hub
->urb
);
1261 if (hub
->has_indicators
)
1262 cancel_delayed_work_sync(&hub
->leds
);
1264 flush_work(&hub
->tt
.clear_work
);
1267 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1271 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1272 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1275 /* caller has locked the hub device */
1276 static int hub_pre_reset(struct usb_interface
*intf
)
1278 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1280 hub_quiesce(hub
, HUB_PRE_RESET
);
1282 hub_pm_barrier_for_all_ports(hub
);
1286 /* caller has locked the hub device */
1287 static int hub_post_reset(struct usb_interface
*intf
)
1289 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1292 hub_pm_barrier_for_all_ports(hub
);
1293 hub_activate(hub
, HUB_POST_RESET
);
1297 static int hub_configure(struct usb_hub
*hub
,
1298 struct usb_endpoint_descriptor
*endpoint
)
1300 struct usb_hcd
*hcd
;
1301 struct usb_device
*hdev
= hub
->hdev
;
1302 struct device
*hub_dev
= hub
->intfdev
;
1303 u16 hubstatus
, hubchange
;
1304 u16 wHubCharacteristics
;
1307 char *message
= "out of memory";
1312 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1318 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1323 mutex_init(&hub
->status_mutex
);
1325 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1326 if (!hub
->descriptor
) {
1331 /* Request the entire hub descriptor.
1332 * hub->descriptor can handle USB_MAXCHILDREN ports,
1333 * but a (non-SS) hub can/will return fewer bytes here.
1335 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1337 message
= "can't read hub descriptor";
1341 maxchild
= USB_MAXCHILDREN
;
1342 if (hub_is_superspeed(hdev
))
1343 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1345 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1346 message
= "hub has too many ports!";
1349 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1350 message
= "hub doesn't have any ports!";
1355 maxchild
= hub
->descriptor
->bNbrPorts
;
1356 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1357 (maxchild
== 1) ? "" : "s");
1359 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1365 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1366 if (hub_is_superspeed(hdev
)) {
1374 /* FIXME for USB 3.0, skip for now */
1375 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1376 !(hub_is_superspeed(hdev
))) {
1377 char portstr
[USB_MAXCHILDREN
+ 1];
1379 for (i
= 0; i
< maxchild
; i
++)
1380 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1381 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1383 portstr
[maxchild
] = 0;
1384 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1386 dev_dbg(hub_dev
, "standalone hub\n");
1388 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1389 case HUB_CHAR_COMMON_LPSM
:
1390 dev_dbg(hub_dev
, "ganged power switching\n");
1392 case HUB_CHAR_INDV_PORT_LPSM
:
1393 dev_dbg(hub_dev
, "individual port power switching\n");
1395 case HUB_CHAR_NO_LPSM
:
1397 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1401 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1402 case HUB_CHAR_COMMON_OCPM
:
1403 dev_dbg(hub_dev
, "global over-current protection\n");
1405 case HUB_CHAR_INDV_PORT_OCPM
:
1406 dev_dbg(hub_dev
, "individual port over-current protection\n");
1408 case HUB_CHAR_NO_OCPM
:
1410 dev_dbg(hub_dev
, "no over-current protection\n");
1414 spin_lock_init(&hub
->tt
.lock
);
1415 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1416 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1417 switch (hdev
->descriptor
.bDeviceProtocol
) {
1420 case USB_HUB_PR_HS_SINGLE_TT
:
1421 dev_dbg(hub_dev
, "Single TT\n");
1424 case USB_HUB_PR_HS_MULTI_TT
:
1425 ret
= usb_set_interface(hdev
, 0, 1);
1427 dev_dbg(hub_dev
, "TT per port\n");
1430 dev_err(hub_dev
, "Using single TT (err %d)\n",
1435 /* USB 3.0 hubs don't have a TT */
1438 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1439 hdev
->descriptor
.bDeviceProtocol
);
1443 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1444 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1445 case HUB_TTTT_8_BITS
:
1446 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1447 hub
->tt
.think_time
= 666;
1448 dev_dbg(hub_dev
, "TT requires at most %d "
1449 "FS bit times (%d ns)\n",
1450 8, hub
->tt
.think_time
);
1453 case HUB_TTTT_16_BITS
:
1454 hub
->tt
.think_time
= 666 * 2;
1455 dev_dbg(hub_dev
, "TT requires at most %d "
1456 "FS bit times (%d ns)\n",
1457 16, hub
->tt
.think_time
);
1459 case HUB_TTTT_24_BITS
:
1460 hub
->tt
.think_time
= 666 * 3;
1461 dev_dbg(hub_dev
, "TT requires at most %d "
1462 "FS bit times (%d ns)\n",
1463 24, hub
->tt
.think_time
);
1465 case HUB_TTTT_32_BITS
:
1466 hub
->tt
.think_time
= 666 * 4;
1467 dev_dbg(hub_dev
, "TT requires at most %d "
1468 "FS bit times (%d ns)\n",
1469 32, hub
->tt
.think_time
);
1473 /* probe() zeroes hub->indicator[] */
1474 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1475 hub
->has_indicators
= 1;
1476 dev_dbg(hub_dev
, "Port indicators are supported\n");
1479 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1480 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1482 /* power budgeting mostly matters with bus-powered hubs,
1483 * and battery-powered root hubs (may provide just 8 mA).
1485 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1487 message
= "can't get hub status";
1490 hcd
= bus_to_hcd(hdev
->bus
);
1491 if (hdev
== hdev
->bus
->root_hub
) {
1492 if (hcd
->power_budget
> 0)
1493 hdev
->bus_mA
= hcd
->power_budget
;
1495 hdev
->bus_mA
= full_load
* maxchild
;
1496 if (hdev
->bus_mA
>= full_load
)
1497 hub
->mA_per_port
= full_load
;
1499 hub
->mA_per_port
= hdev
->bus_mA
;
1500 hub
->limited_power
= 1;
1502 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1503 int remaining
= hdev
->bus_mA
-
1504 hub
->descriptor
->bHubContrCurrent
;
1506 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1507 hub
->descriptor
->bHubContrCurrent
);
1508 hub
->limited_power
= 1;
1510 if (remaining
< maxchild
* unit_load
)
1512 "insufficient power available "
1513 "to use all downstream ports\n");
1514 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1516 } else { /* Self-powered external hub */
1517 /* FIXME: What about battery-powered external hubs that
1518 * provide less current per port? */
1519 hub
->mA_per_port
= full_load
;
1521 if (hub
->mA_per_port
< full_load
)
1522 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1525 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1527 message
= "can't get hub status";
1531 /* local power status reports aren't always correct */
1532 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1533 dev_dbg(hub_dev
, "local power source is %s\n",
1534 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1535 ? "lost (inactive)" : "good");
1537 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1538 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1539 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1541 /* set up the interrupt endpoint
1542 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1543 * bytes as USB2.0[11.12.3] says because some hubs are known
1544 * to send more data (and thus cause overflow). For root hubs,
1545 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1546 * to be big enough for at least USB_MAXCHILDREN ports. */
1547 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1548 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1550 if (maxp
> sizeof(*hub
->buffer
))
1551 maxp
= sizeof(*hub
->buffer
);
1553 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1559 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1560 hub
, endpoint
->bInterval
);
1562 /* maybe cycle the hub leds */
1563 if (hub
->has_indicators
&& blinkenlights
)
1564 hub
->indicator
[0] = INDICATOR_CYCLE
;
1566 mutex_lock(&usb_port_peer_mutex
);
1567 for (i
= 0; i
< maxchild
; i
++) {
1568 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1570 dev_err(hub
->intfdev
,
1571 "couldn't create port%d device.\n", i
+ 1);
1576 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1577 struct usb_port
*port_dev
= hub
->ports
[i
];
1579 pm_runtime_put(&port_dev
->dev
);
1582 mutex_unlock(&usb_port_peer_mutex
);
1586 /* Update the HCD's internal representation of this hub before hub_wq
1587 * starts getting port status changes for devices under the hub.
1589 if (hcd
->driver
->update_hub_device
) {
1590 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1591 &hub
->tt
, GFP_KERNEL
);
1593 message
= "can't update HCD hub info";
1598 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1600 hub_activate(hub
, HUB_INIT
);
1604 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1606 /* hub_disconnect() frees urb and descriptor */
1610 static void hub_release(struct kref
*kref
)
1612 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1614 usb_put_dev(hub
->hdev
);
1615 usb_put_intf(to_usb_interface(hub
->intfdev
));
1619 static unsigned highspeed_hubs
;
1621 static void hub_disconnect(struct usb_interface
*intf
)
1623 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1624 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1628 * Stop adding new hub events. We do not want to block here and thus
1629 * will not try to remove any pending work item.
1631 hub
->disconnected
= 1;
1633 /* Disconnect all children and quiesce the hub */
1635 hub_quiesce(hub
, HUB_DISCONNECT
);
1637 mutex_lock(&usb_port_peer_mutex
);
1639 /* Avoid races with recursively_mark_NOTATTACHED() */
1640 spin_lock_irq(&device_state_lock
);
1641 port1
= hdev
->maxchild
;
1643 usb_set_intfdata(intf
, NULL
);
1644 spin_unlock_irq(&device_state_lock
);
1646 for (; port1
> 0; --port1
)
1647 usb_hub_remove_port_device(hub
, port1
);
1649 mutex_unlock(&usb_port_peer_mutex
);
1651 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1654 usb_free_urb(hub
->urb
);
1656 kfree(hub
->descriptor
);
1660 pm_suspend_ignore_children(&intf
->dev
, false);
1661 kref_put(&hub
->kref
, hub_release
);
1664 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1666 /* Some hubs have a subclass of 1, which AFAICT according to the */
1667 /* specs is not defined, but it works */
1668 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1669 desc
->desc
.bInterfaceSubClass
!= 1)
1672 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1673 if (desc
->desc
.bNumEndpoints
!= 1)
1676 /* If the first endpoint is not interrupt IN, we'd better punt! */
1677 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1683 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1685 struct usb_host_interface
*desc
;
1686 struct usb_device
*hdev
;
1687 struct usb_hub
*hub
;
1689 desc
= intf
->cur_altsetting
;
1690 hdev
= interface_to_usbdev(intf
);
1693 * Set default autosuspend delay as 0 to speedup bus suspend,
1694 * based on the below considerations:
1696 * - Unlike other drivers, the hub driver does not rely on the
1697 * autosuspend delay to provide enough time to handle a wakeup
1698 * event, and the submitted status URB is just to check future
1699 * change on hub downstream ports, so it is safe to do it.
1701 * - The patch might cause one or more auto supend/resume for
1702 * below very rare devices when they are plugged into hub
1705 * devices having trouble initializing, and disconnect
1706 * themselves from the bus and then reconnect a second
1709 * devices just for downloading firmware, and disconnects
1710 * themselves after completing it
1712 * For these quite rare devices, their drivers may change the
1713 * autosuspend delay of their parent hub in the probe() to one
1714 * appropriate value to avoid the subtle problem if someone
1717 * - The patch may cause one or more auto suspend/resume on
1718 * hub during running 'lsusb', but it is probably too
1719 * infrequent to worry about.
1721 * - Change autosuspend delay of hub can avoid unnecessary auto
1722 * suspend timer for hub, also may decrease power consumption
1725 * - If user has indicated to prevent autosuspend by passing
1726 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1729 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1730 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1734 * Hubs have proper suspend/resume support, except for root hubs
1735 * where the controller driver doesn't have bus_suspend and
1736 * bus_resume methods.
1738 if (hdev
->parent
) { /* normal device */
1739 usb_enable_autosuspend(hdev
);
1740 } else { /* root hub */
1741 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1743 if (drv
->bus_suspend
&& drv
->bus_resume
)
1744 usb_enable_autosuspend(hdev
);
1747 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1749 "Unsupported bus topology: hub nested too deep\n");
1753 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1755 dev_warn(&intf
->dev
, "ignoring external hub\n");
1760 if (!hub_descriptor_is_sane(desc
)) {
1761 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1765 /* We found a hub */
1766 dev_info(&intf
->dev
, "USB hub found\n");
1768 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1772 kref_init(&hub
->kref
);
1773 hub
->intfdev
= &intf
->dev
;
1775 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1776 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1777 INIT_WORK(&hub
->events
, hub_event
);
1781 usb_set_intfdata(intf
, hub
);
1782 intf
->needs_remote_wakeup
= 1;
1783 pm_suspend_ignore_children(&intf
->dev
, true);
1785 if (hdev
->speed
== USB_SPEED_HIGH
)
1788 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1789 hub
->quirk_check_port_auto_suspend
= 1;
1791 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0)
1794 hub_disconnect(intf
);
1799 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1801 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1802 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1804 /* assert ifno == 0 (part of hub spec) */
1806 case USBDEVFS_HUB_PORTINFO
: {
1807 struct usbdevfs_hub_portinfo
*info
= user_data
;
1810 spin_lock_irq(&device_state_lock
);
1811 if (hdev
->devnum
<= 0)
1814 info
->nports
= hdev
->maxchild
;
1815 for (i
= 0; i
< info
->nports
; i
++) {
1816 if (hub
->ports
[i
]->child
== NULL
)
1820 hub
->ports
[i
]->child
->devnum
;
1823 spin_unlock_irq(&device_state_lock
);
1825 return info
->nports
+ 1;
1834 * Allow user programs to claim ports on a hub. When a device is attached
1835 * to one of these "claimed" ports, the program will "own" the device.
1837 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1838 struct usb_dev_state
***ppowner
)
1840 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1842 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1844 if (port1
== 0 || port1
> hdev
->maxchild
)
1847 /* Devices not managed by the hub driver
1848 * will always have maxchild equal to 0.
1850 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1854 /* In the following three functions, the caller must hold hdev's lock */
1855 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1856 struct usb_dev_state
*owner
)
1859 struct usb_dev_state
**powner
;
1861 rc
= find_port_owner(hdev
, port1
, &powner
);
1869 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1871 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1872 struct usb_dev_state
*owner
)
1875 struct usb_dev_state
**powner
;
1877 rc
= find_port_owner(hdev
, port1
, &powner
);
1880 if (*powner
!= owner
)
1885 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1887 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1889 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1892 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1893 if (hub
->ports
[n
]->port_owner
== owner
)
1894 hub
->ports
[n
]->port_owner
= NULL
;
1899 /* The caller must hold udev's lock */
1900 bool usb_device_is_owned(struct usb_device
*udev
)
1902 struct usb_hub
*hub
;
1904 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1906 hub
= usb_hub_to_struct_hub(udev
->parent
);
1907 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1910 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1912 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1915 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1916 if (hub
->ports
[i
]->child
)
1917 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1919 if (udev
->state
== USB_STATE_SUSPENDED
)
1920 udev
->active_duration
-= jiffies
;
1921 udev
->state
= USB_STATE_NOTATTACHED
;
1925 * usb_set_device_state - change a device's current state (usbcore, hcds)
1926 * @udev: pointer to device whose state should be changed
1927 * @new_state: new state value to be stored
1929 * udev->state is _not_ fully protected by the device lock. Although
1930 * most transitions are made only while holding the lock, the state can
1931 * can change to USB_STATE_NOTATTACHED at almost any time. This
1932 * is so that devices can be marked as disconnected as soon as possible,
1933 * without having to wait for any semaphores to be released. As a result,
1934 * all changes to any device's state must be protected by the
1935 * device_state_lock spinlock.
1937 * Once a device has been added to the device tree, all changes to its state
1938 * should be made using this routine. The state should _not_ be set directly.
1940 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1941 * Otherwise udev->state is set to new_state, and if new_state is
1942 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1943 * to USB_STATE_NOTATTACHED.
1945 void usb_set_device_state(struct usb_device
*udev
,
1946 enum usb_device_state new_state
)
1948 unsigned long flags
;
1951 spin_lock_irqsave(&device_state_lock
, flags
);
1952 if (udev
->state
== USB_STATE_NOTATTACHED
)
1954 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1956 /* root hub wakeup capabilities are managed out-of-band
1957 * and may involve silicon errata ... ignore them here.
1960 if (udev
->state
== USB_STATE_SUSPENDED
1961 || new_state
== USB_STATE_SUSPENDED
)
1962 ; /* No change to wakeup settings */
1963 else if (new_state
== USB_STATE_CONFIGURED
)
1964 wakeup
= (udev
->quirks
&
1965 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1966 udev
->actconfig
->desc
.bmAttributes
&
1967 USB_CONFIG_ATT_WAKEUP
;
1971 if (udev
->state
== USB_STATE_SUSPENDED
&&
1972 new_state
!= USB_STATE_SUSPENDED
)
1973 udev
->active_duration
-= jiffies
;
1974 else if (new_state
== USB_STATE_SUSPENDED
&&
1975 udev
->state
!= USB_STATE_SUSPENDED
)
1976 udev
->active_duration
+= jiffies
;
1977 udev
->state
= new_state
;
1979 recursively_mark_NOTATTACHED(udev
);
1980 spin_unlock_irqrestore(&device_state_lock
, flags
);
1982 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1984 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1987 * Choose a device number.
1989 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1990 * USB-2.0 buses they are also used as device addresses, however on
1991 * USB-3.0 buses the address is assigned by the controller hardware
1992 * and it usually is not the same as the device number.
1994 * WUSB devices are simple: they have no hubs behind, so the mapping
1995 * device <-> virtual port number becomes 1:1. Why? to simplify the
1996 * life of the device connection logic in
1997 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1998 * handshake we need to assign a temporary address in the unauthorized
1999 * space. For simplicity we use the first virtual port number found to
2000 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2001 * and that becomes it's address [X < 128] or its unauthorized address
2004 * We add 1 as an offset to the one-based USB-stack port number
2005 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2006 * 0 is reserved by USB for default address; (b) Linux's USB stack
2007 * uses always #1 for the root hub of the controller. So USB stack's
2008 * port #1, which is wusb virtual-port #0 has address #2.
2010 * Devices connected under xHCI are not as simple. The host controller
2011 * supports virtualization, so the hardware assigns device addresses and
2012 * the HCD must setup data structures before issuing a set address
2013 * command to the hardware.
2015 static void choose_devnum(struct usb_device
*udev
)
2018 struct usb_bus
*bus
= udev
->bus
;
2020 /* be safe when more hub events are proceed in parallel */
2021 mutex_lock(&bus
->devnum_next_mutex
);
2023 devnum
= udev
->portnum
+ 1;
2024 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2026 /* Try to allocate the next devnum beginning at
2027 * bus->devnum_next. */
2028 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2031 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2033 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2036 set_bit(devnum
, bus
->devmap
.devicemap
);
2037 udev
->devnum
= devnum
;
2039 mutex_unlock(&bus
->devnum_next_mutex
);
2042 static void release_devnum(struct usb_device
*udev
)
2044 if (udev
->devnum
> 0) {
2045 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2050 static void update_devnum(struct usb_device
*udev
, int devnum
)
2052 /* The address for a WUSB device is managed by wusbcore. */
2054 udev
->devnum
= devnum
;
2057 static void hub_free_dev(struct usb_device
*udev
)
2059 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2061 /* Root hubs aren't real devices, so don't free HCD resources */
2062 if (hcd
->driver
->free_dev
&& udev
->parent
)
2063 hcd
->driver
->free_dev(hcd
, udev
);
2066 static void hub_disconnect_children(struct usb_device
*udev
)
2068 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2071 /* Free up all the children before we remove this device */
2072 for (i
= 0; i
< udev
->maxchild
; i
++) {
2073 if (hub
->ports
[i
]->child
)
2074 usb_disconnect(&hub
->ports
[i
]->child
);
2079 * usb_disconnect - disconnect a device (usbcore-internal)
2080 * @pdev: pointer to device being disconnected
2081 * Context: !in_interrupt ()
2083 * Something got disconnected. Get rid of it and all of its children.
2085 * If *pdev is a normal device then the parent hub must already be locked.
2086 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2087 * which protects the set of root hubs as well as the list of buses.
2089 * Only hub drivers (including virtual root hub drivers for host
2090 * controllers) should ever call this.
2092 * This call is synchronous, and may not be used in an interrupt context.
2094 void usb_disconnect(struct usb_device
**pdev
)
2096 struct usb_port
*port_dev
= NULL
;
2097 struct usb_device
*udev
= *pdev
;
2098 struct usb_hub
*hub
= NULL
;
2101 /* mark the device as inactive, so any further urb submissions for
2102 * this device (and any of its children) will fail immediately.
2103 * this quiesces everything except pending urbs.
2105 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2106 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2110 * Ensure that the pm runtime code knows that the USB device
2111 * is in the process of being disconnected.
2113 pm_runtime_barrier(&udev
->dev
);
2115 usb_lock_device(udev
);
2117 hub_disconnect_children(udev
);
2119 /* deallocate hcd/hardware state ... nuking all pending urbs and
2120 * cleaning up all state associated with the current configuration
2121 * so that the hardware is now fully quiesced.
2123 dev_dbg(&udev
->dev
, "unregistering device\n");
2124 usb_disable_device(udev
, 0);
2125 usb_hcd_synchronize_unlinks(udev
);
2128 port1
= udev
->portnum
;
2129 hub
= usb_hub_to_struct_hub(udev
->parent
);
2130 port_dev
= hub
->ports
[port1
- 1];
2132 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2133 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2136 * As usb_port_runtime_resume() de-references udev, make
2137 * sure no resumes occur during removal
2139 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2140 pm_runtime_get_sync(&port_dev
->dev
);
2143 usb_remove_ep_devs(&udev
->ep0
);
2144 usb_unlock_device(udev
);
2146 /* Unregister the device. The device driver is responsible
2147 * for de-configuring the device and invoking the remove-device
2148 * notifier chain (used by usbfs and possibly others).
2150 device_del(&udev
->dev
);
2152 /* Free the device number and delete the parent's children[]
2153 * (or root_hub) pointer.
2155 release_devnum(udev
);
2157 /* Avoid races with recursively_mark_NOTATTACHED() */
2158 spin_lock_irq(&device_state_lock
);
2160 spin_unlock_irq(&device_state_lock
);
2162 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2163 pm_runtime_put(&port_dev
->dev
);
2167 put_device(&udev
->dev
);
2170 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2171 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2175 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2178 static void announce_device(struct usb_device
*udev
)
2180 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2181 le16_to_cpu(udev
->descriptor
.idVendor
),
2182 le16_to_cpu(udev
->descriptor
.idProduct
));
2183 dev_info(&udev
->dev
,
2184 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2185 udev
->descriptor
.iManufacturer
,
2186 udev
->descriptor
.iProduct
,
2187 udev
->descriptor
.iSerialNumber
);
2188 show_string(udev
, "Product", udev
->product
);
2189 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2190 show_string(udev
, "SerialNumber", udev
->serial
);
2193 static inline void announce_device(struct usb_device
*udev
) { }
2198 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2199 * @udev: newly addressed device (in ADDRESS state)
2201 * Finish enumeration for On-The-Go devices
2203 * Return: 0 if successful. A negative error code otherwise.
2205 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2209 #ifdef CONFIG_USB_OTG
2211 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2212 * to wake us after we've powered off VBUS; and HNP, switching roles
2213 * "host" to "peripheral". The OTG descriptor helps figure this out.
2215 if (!udev
->bus
->is_b_host
2217 && udev
->parent
== udev
->bus
->root_hub
) {
2218 struct usb_otg_descriptor
*desc
= NULL
;
2219 struct usb_bus
*bus
= udev
->bus
;
2220 unsigned port1
= udev
->portnum
;
2222 /* descriptor may appear anywhere in config */
2223 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2224 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2225 USB_DT_OTG
, (void **) &desc
);
2226 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2229 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2230 (port1
== bus
->otg_port
) ? "" : "non-");
2232 /* enable HNP before suspend, it's simpler */
2233 if (port1
== bus
->otg_port
) {
2234 bus
->b_hnp_enable
= 1;
2235 err
= usb_control_msg(udev
,
2236 usb_sndctrlpipe(udev
, 0),
2237 USB_REQ_SET_FEATURE
, 0,
2238 USB_DEVICE_B_HNP_ENABLE
,
2240 USB_CTRL_SET_TIMEOUT
);
2243 * OTG MESSAGE: report errors here,
2244 * customize to match your product.
2246 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2248 bus
->b_hnp_enable
= 0;
2250 } else if (desc
->bLength
== sizeof
2251 (struct usb_otg_descriptor
)) {
2252 /* Set a_alt_hnp_support for legacy otg device */
2253 err
= usb_control_msg(udev
,
2254 usb_sndctrlpipe(udev
, 0),
2255 USB_REQ_SET_FEATURE
, 0,
2256 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2258 USB_CTRL_SET_TIMEOUT
);
2261 "set a_alt_hnp_support failed: %d\n",
2271 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2272 * @udev: newly addressed device (in ADDRESS state)
2274 * This is only called by usb_new_device() and usb_authorize_device()
2275 * and FIXME -- all comments that apply to them apply here wrt to
2278 * If the device is WUSB and not authorized, we don't attempt to read
2279 * the string descriptors, as they will be errored out by the device
2280 * until it has been authorized.
2282 * Return: 0 if successful. A negative error code otherwise.
2284 static int usb_enumerate_device(struct usb_device
*udev
)
2287 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2289 if (udev
->config
== NULL
) {
2290 err
= usb_get_configuration(udev
);
2293 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2299 /* read the standard strings and cache them if present */
2300 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2301 udev
->manufacturer
= usb_cache_string(udev
,
2302 udev
->descriptor
.iManufacturer
);
2303 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2305 err
= usb_enumerate_device_otg(udev
);
2309 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2310 !is_targeted(udev
)) {
2311 /* Maybe it can talk to us, though we can't talk to it.
2312 * (Includes HNP test device.)
2314 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2315 || udev
->bus
->is_b_host
)) {
2316 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2318 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2323 usb_detect_interface_quirks(udev
);
2328 static void set_usb_port_removable(struct usb_device
*udev
)
2330 struct usb_device
*hdev
= udev
->parent
;
2331 struct usb_hub
*hub
;
2332 u8 port
= udev
->portnum
;
2333 u16 wHubCharacteristics
;
2334 bool removable
= true;
2339 hub
= usb_hub_to_struct_hub(udev
->parent
);
2342 * If the platform firmware has provided information about a port,
2343 * use that to determine whether it's removable.
2345 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2346 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2347 udev
->removable
= USB_DEVICE_REMOVABLE
;
2349 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2350 case USB_PORT_NOT_USED
:
2351 udev
->removable
= USB_DEVICE_FIXED
;
2358 * Otherwise, check whether the hub knows whether a port is removable
2361 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2363 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2366 if (hub_is_superspeed(hdev
)) {
2367 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2371 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2376 udev
->removable
= USB_DEVICE_REMOVABLE
;
2378 udev
->removable
= USB_DEVICE_FIXED
;
2383 * usb_new_device - perform initial device setup (usbcore-internal)
2384 * @udev: newly addressed device (in ADDRESS state)
2386 * This is called with devices which have been detected but not fully
2387 * enumerated. The device descriptor is available, but not descriptors
2388 * for any device configuration. The caller must have locked either
2389 * the parent hub (if udev is a normal device) or else the
2390 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2391 * udev has already been installed, but udev is not yet visible through
2392 * sysfs or other filesystem code.
2394 * This call is synchronous, and may not be used in an interrupt context.
2396 * Only the hub driver or root-hub registrar should ever call this.
2398 * Return: Whether the device is configured properly or not. Zero if the
2399 * interface was registered with the driver core; else a negative errno
2403 int usb_new_device(struct usb_device
*udev
)
2408 /* Initialize non-root-hub device wakeup to disabled;
2409 * device (un)configuration controls wakeup capable
2410 * sysfs power/wakeup controls wakeup enabled/disabled
2412 device_init_wakeup(&udev
->dev
, 0);
2415 /* Tell the runtime-PM framework the device is active */
2416 pm_runtime_set_active(&udev
->dev
);
2417 pm_runtime_get_noresume(&udev
->dev
);
2418 pm_runtime_use_autosuspend(&udev
->dev
);
2419 pm_runtime_enable(&udev
->dev
);
2421 /* By default, forbid autosuspend for all devices. It will be
2422 * allowed for hubs during binding.
2424 usb_disable_autosuspend(udev
);
2426 err
= usb_enumerate_device(udev
); /* Read descriptors */
2429 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2430 udev
->devnum
, udev
->bus
->busnum
,
2431 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2432 /* export the usbdev device-node for libusb */
2433 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2434 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2436 /* Tell the world! */
2437 announce_device(udev
);
2440 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2442 add_device_randomness(udev
->product
, strlen(udev
->product
));
2443 if (udev
->manufacturer
)
2444 add_device_randomness(udev
->manufacturer
,
2445 strlen(udev
->manufacturer
));
2447 device_enable_async_suspend(&udev
->dev
);
2449 /* check whether the hub or firmware marks this port as non-removable */
2451 set_usb_port_removable(udev
);
2453 /* Register the device. The device driver is responsible
2454 * for configuring the device and invoking the add-device
2455 * notifier chain (used by usbfs and possibly others).
2457 err
= device_add(&udev
->dev
);
2459 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2463 /* Create link files between child device and usb port device. */
2465 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2466 int port1
= udev
->portnum
;
2467 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2469 err
= sysfs_create_link(&udev
->dev
.kobj
,
2470 &port_dev
->dev
.kobj
, "port");
2474 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2475 &udev
->dev
.kobj
, "device");
2477 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2481 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2482 pm_runtime_get_sync(&port_dev
->dev
);
2485 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2486 usb_mark_last_busy(udev
);
2487 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2491 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2492 pm_runtime_disable(&udev
->dev
);
2493 pm_runtime_set_suspended(&udev
->dev
);
2499 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2500 * @usb_dev: USB device
2502 * Move the USB device to a very basic state where interfaces are disabled
2503 * and the device is in fact unconfigured and unusable.
2505 * We share a lock (that we have) with device_del(), so we need to
2510 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2512 usb_lock_device(usb_dev
);
2513 if (usb_dev
->authorized
== 0)
2514 goto out_unauthorized
;
2516 usb_dev
->authorized
= 0;
2517 usb_set_configuration(usb_dev
, -1);
2520 usb_unlock_device(usb_dev
);
2525 int usb_authorize_device(struct usb_device
*usb_dev
)
2529 usb_lock_device(usb_dev
);
2530 if (usb_dev
->authorized
== 1)
2531 goto out_authorized
;
2533 result
= usb_autoresume_device(usb_dev
);
2535 dev_err(&usb_dev
->dev
,
2536 "can't autoresume for authorization: %d\n", result
);
2537 goto error_autoresume
;
2540 if (usb_dev
->wusb
) {
2541 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2543 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2544 "authorization: %d\n", result
);
2545 goto error_device_descriptor
;
2549 usb_dev
->authorized
= 1;
2550 /* Choose and set the configuration. This registers the interfaces
2551 * with the driver core and lets interface drivers bind to them.
2553 c
= usb_choose_configuration(usb_dev
);
2555 result
= usb_set_configuration(usb_dev
, c
);
2557 dev_err(&usb_dev
->dev
,
2558 "can't set config #%d, error %d\n", c
, result
);
2559 /* This need not be fatal. The user can try to
2560 * set other configurations. */
2563 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2565 error_device_descriptor
:
2566 usb_autosuspend_device(usb_dev
);
2569 usb_unlock_device(usb_dev
); /* complements locktree */
2574 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2575 * check it from the link protocol field of the current speed ID attribute.
2576 * current speed ID is got from ext port status request. Sublink speed attribute
2577 * table is returned with the hub BOS SSP device capability descriptor
2579 static int port_speed_is_ssp(struct usb_device
*hdev
, int speed_id
)
2584 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2589 ssa_count
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2590 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2592 for (i
= 0; i
<= ssa_count
; i
++) {
2593 ss_attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2594 if (speed_id
== (ss_attr
& USB_SSP_SUBLINK_SPEED_SSID
))
2595 return !!(ss_attr
& USB_SSP_SUBLINK_SPEED_LP
);
2600 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2601 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2603 struct usb_hcd
*hcd
;
2604 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2606 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2607 return hcd
->wireless
;
2611 #define PORT_RESET_TRIES 5
2612 #define SET_ADDRESS_TRIES 2
2613 #define GET_DESCRIPTOR_TRIES 2
2614 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2615 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2617 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2618 #define HUB_SHORT_RESET_TIME 10
2619 #define HUB_BH_RESET_TIME 50
2620 #define HUB_LONG_RESET_TIME 200
2621 #define HUB_RESET_TIMEOUT 800
2624 * "New scheme" enumeration causes an extra state transition to be
2625 * exposed to an xhci host and causes USB3 devices to receive control
2626 * commands in the default state. This has been seen to cause
2627 * enumeration failures, so disable this enumeration scheme for USB3
2630 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2632 if (udev
->speed
>= USB_SPEED_SUPER
)
2635 return USE_NEW_SCHEME(retry
);
2638 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2639 * Port worm reset is required to recover
2641 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2646 if (!hub_is_superspeed(hub
->hdev
))
2649 if (test_bit(port1
, hub
->warm_reset_bits
))
2652 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2653 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2654 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2657 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2658 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2660 int delay_time
, ret
;
2663 u32 ext_portstatus
= 0;
2665 for (delay_time
= 0;
2666 delay_time
< HUB_RESET_TIMEOUT
;
2667 delay_time
+= delay
) {
2668 /* wait to give the device a chance to reset */
2671 /* read and decode port status */
2672 if (hub_is_superspeedplus(hub
->hdev
))
2673 ret
= hub_ext_port_status(hub
, port1
,
2674 HUB_EXT_PORT_STATUS
,
2675 &portstatus
, &portchange
,
2678 ret
= hub_port_status(hub
, port1
, &portstatus
,
2684 * The port state is unknown until the reset completes.
2686 * On top of that, some chips may require additional time
2687 * to re-establish a connection after the reset is complete,
2688 * so also wait for the connection to be re-established.
2690 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2691 (portstatus
& USB_PORT_STAT_CONNECTION
))
2694 /* switch to the long delay after two short delay failures */
2695 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2696 delay
= HUB_LONG_RESET_TIME
;
2698 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2699 "not %sreset yet, waiting %dms\n",
2700 warm
? "warm " : "", delay
);
2703 if ((portstatus
& USB_PORT_STAT_RESET
))
2706 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2709 /* Device went away? */
2710 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2713 /* bomb out completely if the connection bounced. A USB 3.0
2714 * connection may bounce if multiple warm resets were issued,
2715 * but the device may have successfully re-connected. Ignore it.
2717 if (!hub_is_superspeed(hub
->hdev
) &&
2718 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2721 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2727 if (hub_is_wusb(hub
))
2728 udev
->speed
= USB_SPEED_WIRELESS
;
2729 else if (hub_is_superspeedplus(hub
->hdev
) &&
2730 port_speed_is_ssp(hub
->hdev
, ext_portstatus
&
2731 USB_EXT_PORT_STAT_RX_SPEED_ID
))
2732 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2733 else if (hub_is_superspeed(hub
->hdev
))
2734 udev
->speed
= USB_SPEED_SUPER
;
2735 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2736 udev
->speed
= USB_SPEED_HIGH
;
2737 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2738 udev
->speed
= USB_SPEED_LOW
;
2740 udev
->speed
= USB_SPEED_FULL
;
2744 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2745 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2746 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2749 u16 portchange
, portstatus
;
2750 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2752 if (!hub_is_superspeed(hub
->hdev
)) {
2754 dev_err(hub
->intfdev
, "only USB3 hub support "
2758 /* Block EHCI CF initialization during the port reset.
2759 * Some companion controllers don't like it when they mix.
2761 down_read(&ehci_cf_port_reset_rwsem
);
2764 * If the caller hasn't explicitly requested a warm reset,
2765 * double check and see if one is needed.
2767 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2768 if (hub_port_warm_reset_required(hub
, port1
,
2772 clear_bit(port1
, hub
->warm_reset_bits
);
2774 /* Reset the port */
2775 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2776 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2777 USB_PORT_FEAT_BH_PORT_RESET
:
2778 USB_PORT_FEAT_RESET
));
2779 if (status
== -ENODEV
) {
2780 ; /* The hub is gone */
2781 } else if (status
) {
2782 dev_err(&port_dev
->dev
,
2783 "cannot %sreset (err = %d)\n",
2784 warm
? "warm " : "", status
);
2786 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2788 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2789 dev_dbg(hub
->intfdev
,
2790 "port_wait_reset: err = %d\n",
2794 /* Check for disconnect or reset */
2795 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2796 usb_clear_port_feature(hub
->hdev
, port1
,
2797 USB_PORT_FEAT_C_RESET
);
2799 if (!hub_is_superspeed(hub
->hdev
))
2802 usb_clear_port_feature(hub
->hdev
, port1
,
2803 USB_PORT_FEAT_C_BH_PORT_RESET
);
2804 usb_clear_port_feature(hub
->hdev
, port1
,
2805 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2806 usb_clear_port_feature(hub
->hdev
, port1
,
2807 USB_PORT_FEAT_C_CONNECTION
);
2810 * If a USB 3.0 device migrates from reset to an error
2811 * state, re-issue the warm reset.
2813 if (hub_port_status(hub
, port1
,
2814 &portstatus
, &portchange
) < 0)
2817 if (!hub_port_warm_reset_required(hub
, port1
,
2822 * If the port is in SS.Inactive or Compliance Mode, the
2823 * hot or warm reset failed. Try another warm reset.
2826 dev_dbg(&port_dev
->dev
,
2827 "hot reset failed, warm reset\n");
2832 dev_dbg(&port_dev
->dev
,
2833 "not enabled, trying %sreset again...\n",
2834 warm
? "warm " : "");
2835 delay
= HUB_LONG_RESET_TIME
;
2838 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2842 /* TRSTRCY = 10 ms; plus some extra */
2845 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2847 update_devnum(udev
, 0);
2848 /* The xHC may think the device is already reset,
2849 * so ignore the status.
2851 if (hcd
->driver
->reset_device
)
2852 hcd
->driver
->reset_device(hcd
, udev
);
2854 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2858 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2861 if (!hub_is_superspeed(hub
->hdev
))
2862 up_read(&ehci_cf_port_reset_rwsem
);
2867 /* Check if a port is power on */
2868 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2872 if (hub_is_superspeed(hub
->hdev
)) {
2873 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2876 if (portstatus
& USB_PORT_STAT_POWER
)
2883 static void usb_lock_port(struct usb_port
*port_dev
)
2884 __acquires(&port_dev
->status_lock
)
2886 mutex_lock(&port_dev
->status_lock
);
2887 __acquire(&port_dev
->status_lock
);
2890 static void usb_unlock_port(struct usb_port
*port_dev
)
2891 __releases(&port_dev
->status_lock
)
2893 mutex_unlock(&port_dev
->status_lock
);
2894 __release(&port_dev
->status_lock
);
2899 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2900 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2904 if (hub_is_superspeed(hub
->hdev
)) {
2905 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2906 == USB_SS_PORT_LS_U3
)
2909 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2916 /* Determine whether the device on a port is ready for a normal resume,
2917 * is ready for a reset-resume, or should be disconnected.
2919 static int check_port_resume_type(struct usb_device
*udev
,
2920 struct usb_hub
*hub
, int port1
,
2921 int status
, u16 portchange
, u16 portstatus
)
2923 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2927 /* Is a warm reset needed to recover the connection? */
2928 if (status
== 0 && udev
->reset_resume
2929 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2932 /* Is the device still present? */
2933 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2934 !port_is_power_on(hub
, portstatus
)) {
2937 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2939 usleep_range(200, 300);
2940 status
= hub_port_status(hub
, port1
, &portstatus
,
2947 /* Can't do a normal resume if the port isn't enabled,
2948 * so try a reset-resume instead.
2950 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2951 if (udev
->persist_enabled
)
2952 udev
->reset_resume
= 1;
2958 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
2959 portchange
, portstatus
, status
);
2960 } else if (udev
->reset_resume
) {
2962 /* Late port handoff can set status-change bits */
2963 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2964 usb_clear_port_feature(hub
->hdev
, port1
,
2965 USB_PORT_FEAT_C_CONNECTION
);
2966 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2967 usb_clear_port_feature(hub
->hdev
, port1
,
2968 USB_PORT_FEAT_C_ENABLE
);
2974 int usb_disable_ltm(struct usb_device
*udev
)
2976 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2978 /* Check if the roothub and device supports LTM. */
2979 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2980 !usb_device_supports_ltm(udev
))
2983 /* Clear Feature LTM Enable can only be sent if the device is
2986 if (!udev
->actconfig
)
2989 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2990 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2991 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2992 USB_CTRL_SET_TIMEOUT
);
2994 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2996 void usb_enable_ltm(struct usb_device
*udev
)
2998 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3000 /* Check if the roothub and device supports LTM. */
3001 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3002 !usb_device_supports_ltm(udev
))
3005 /* Set Feature LTM Enable can only be sent if the device is
3008 if (!udev
->actconfig
)
3011 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3012 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3013 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3014 USB_CTRL_SET_TIMEOUT
);
3016 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3019 * usb_enable_remote_wakeup - enable remote wakeup for a device
3020 * @udev: target device
3022 * For USB-2 devices: Set the device's remote wakeup feature.
3024 * For USB-3 devices: Assume there's only one function on the device and
3025 * enable remote wake for the first interface. FIXME if the interface
3026 * association descriptor shows there's more than one function.
3028 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3030 if (udev
->speed
< USB_SPEED_SUPER
)
3031 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3032 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3033 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3034 USB_CTRL_SET_TIMEOUT
);
3036 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3037 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3038 USB_INTRF_FUNC_SUSPEND
,
3039 USB_INTRF_FUNC_SUSPEND_RW
|
3040 USB_INTRF_FUNC_SUSPEND_LP
,
3041 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3045 * usb_disable_remote_wakeup - disable remote wakeup for a device
3046 * @udev: target device
3048 * For USB-2 devices: Clear the device's remote wakeup feature.
3050 * For USB-3 devices: Assume there's only one function on the device and
3051 * disable remote wake for the first interface. FIXME if the interface
3052 * association descriptor shows there's more than one function.
3054 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3056 if (udev
->speed
< USB_SPEED_SUPER
)
3057 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3058 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3059 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3060 USB_CTRL_SET_TIMEOUT
);
3062 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3063 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3064 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3065 USB_CTRL_SET_TIMEOUT
);
3068 /* Count of wakeup-enabled devices at or below udev */
3069 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3071 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3073 return udev
->do_remote_wakeup
+
3074 (hub
? hub
->wakeup_enabled_descendants
: 0);
3078 * usb_port_suspend - suspend a usb device's upstream port
3079 * @udev: device that's no longer in active use, not a root hub
3080 * Context: must be able to sleep; device not locked; pm locks held
3082 * Suspends a USB device that isn't in active use, conserving power.
3083 * Devices may wake out of a suspend, if anything important happens,
3084 * using the remote wakeup mechanism. They may also be taken out of
3085 * suspend by the host, using usb_port_resume(). It's also routine
3086 * to disconnect devices while they are suspended.
3088 * This only affects the USB hardware for a device; its interfaces
3089 * (and, for hubs, child devices) must already have been suspended.
3091 * Selective port suspend reduces power; most suspended devices draw
3092 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3093 * All devices below the suspended port are also suspended.
3095 * Devices leave suspend state when the host wakes them up. Some devices
3096 * also support "remote wakeup", where the device can activate the USB
3097 * tree above them to deliver data, such as a keypress or packet. In
3098 * some cases, this wakes the USB host.
3100 * Suspending OTG devices may trigger HNP, if that's been enabled
3101 * between a pair of dual-role devices. That will change roles, such
3102 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3104 * Devices on USB hub ports have only one "suspend" state, corresponding
3105 * to ACPI D2, "may cause the device to lose some context".
3106 * State transitions include:
3108 * - suspend, resume ... when the VBUS power link stays live
3109 * - suspend, disconnect ... VBUS lost
3111 * Once VBUS drop breaks the circuit, the port it's using has to go through
3112 * normal re-enumeration procedures, starting with enabling VBUS power.
3113 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3114 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3115 * timer, no SRP, no requests through sysfs.
3117 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3118 * suspended until their bus goes into global suspend (i.e., the root
3119 * hub is suspended). Nevertheless, we change @udev->state to
3120 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3121 * upstream port setting is stored in @udev->port_is_suspended.
3123 * Returns 0 on success, else negative errno.
3125 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3127 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3128 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3129 int port1
= udev
->portnum
;
3131 bool really_suspend
= true;
3133 usb_lock_port(port_dev
);
3135 /* enable remote wakeup when appropriate; this lets the device
3136 * wake up the upstream hub (including maybe the root hub).
3138 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3139 * we don't explicitly enable it here.
3141 if (udev
->do_remote_wakeup
) {
3142 status
= usb_enable_remote_wakeup(udev
);
3144 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3146 /* bail if autosuspend is requested */
3147 if (PMSG_IS_AUTO(msg
))
3152 /* disable USB2 hardware LPM */
3153 if (udev
->usb2_hw_lpm_enabled
== 1)
3154 usb_set_usb2_hardware_lpm(udev
, 0);
3156 if (usb_disable_ltm(udev
)) {
3157 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3159 if (PMSG_IS_AUTO(msg
))
3164 if (hub_is_superspeed(hub
->hdev
))
3165 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3168 * For system suspend, we do not need to enable the suspend feature
3169 * on individual USB-2 ports. The devices will automatically go
3170 * into suspend a few ms after the root hub stops sending packets.
3171 * The USB 2.0 spec calls this "global suspend".
3173 * However, many USB hubs have a bug: They don't relay wakeup requests
3174 * from a downstream port if the port's suspend feature isn't on.
3175 * Therefore we will turn on the suspend feature if udev or any of its
3176 * descendants is enabled for remote wakeup.
3178 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3179 status
= set_port_feature(hub
->hdev
, port1
,
3180 USB_PORT_FEAT_SUSPEND
);
3182 really_suspend
= false;
3186 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3188 /* Try to enable USB3 LTM again */
3189 usb_enable_ltm(udev
);
3191 /* Try to enable USB2 hardware LPM again */
3192 if (udev
->usb2_hw_lpm_capable
== 1)
3193 usb_set_usb2_hardware_lpm(udev
, 1);
3195 if (udev
->do_remote_wakeup
)
3196 (void) usb_disable_remote_wakeup(udev
);
3199 /* System sleep transitions should never fail */
3200 if (!PMSG_IS_AUTO(msg
))
3203 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3204 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3205 udev
->do_remote_wakeup
);
3206 if (really_suspend
) {
3207 udev
->port_is_suspended
= 1;
3209 /* device has up to 10 msec to fully suspend */
3212 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3215 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3216 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3217 pm_runtime_put_sync(&port_dev
->dev
);
3219 usb_mark_last_busy(hub
->hdev
);
3221 usb_unlock_port(port_dev
);
3226 * If the USB "suspend" state is in use (rather than "global suspend"),
3227 * many devices will be individually taken out of suspend state using
3228 * special "resume" signaling. This routine kicks in shortly after
3229 * hardware resume signaling is finished, either because of selective
3230 * resume (by host) or remote wakeup (by device) ... now see what changed
3231 * in the tree that's rooted at this device.
3233 * If @udev->reset_resume is set then the device is reset before the
3234 * status check is done.
3236 static int finish_port_resume(struct usb_device
*udev
)
3241 /* caller owns the udev device lock */
3242 dev_dbg(&udev
->dev
, "%s\n",
3243 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3245 /* usb ch9 identifies four variants of SUSPENDED, based on what
3246 * state the device resumes to. Linux currently won't see the
3247 * first two on the host side; they'd be inside hub_port_init()
3248 * during many timeouts, but hub_wq can't suspend until later.
3250 usb_set_device_state(udev
, udev
->actconfig
3251 ? USB_STATE_CONFIGURED
3252 : USB_STATE_ADDRESS
);
3254 /* 10.5.4.5 says not to reset a suspended port if the attached
3255 * device is enabled for remote wakeup. Hence the reset
3256 * operation is carried out here, after the port has been
3259 if (udev
->reset_resume
) {
3261 * If the device morphs or switches modes when it is reset,
3262 * we don't want to perform a reset-resume. We'll fail the
3263 * resume, which will cause a logical disconnect, and then
3264 * the device will be rediscovered.
3267 if (udev
->quirks
& USB_QUIRK_RESET
)
3270 status
= usb_reset_and_verify_device(udev
);
3273 /* 10.5.4.5 says be sure devices in the tree are still there.
3274 * For now let's assume the device didn't go crazy on resume,
3275 * and device drivers will know about any resume quirks.
3279 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3281 /* If a normal resume failed, try doing a reset-resume */
3282 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3283 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3284 udev
->reset_resume
= 1;
3285 goto retry_reset_resume
;
3290 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3293 * There are a few quirky devices which violate the standard
3294 * by claiming to have remote wakeup enabled after a reset,
3295 * which crash if the feature is cleared, hence check for
3296 * udev->reset_resume
3298 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3299 if (udev
->speed
< USB_SPEED_SUPER
) {
3300 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3301 status
= usb_disable_remote_wakeup(udev
);
3303 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3305 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3306 | USB_INTRF_STAT_FUNC_RW
))
3307 status
= usb_disable_remote_wakeup(udev
);
3312 "disable remote wakeup, status %d\n",
3320 * There are some SS USB devices which take longer time for link training.
3321 * XHCI specs 4.19.4 says that when Link training is successful, port
3322 * sets CCS bit to 1. So if SW reads port status before successful link
3323 * training, then it will not find device to be present.
3324 * USB Analyzer log with such buggy devices show that in some cases
3325 * device switch on the RX termination after long delay of host enabling
3326 * the VBUS. In few other cases it has been seen that device fails to
3327 * negotiate link training in first attempt. It has been
3328 * reported till now that few devices take as long as 2000 ms to train
3329 * the link after host enabling its VBUS and termination. Following
3330 * routine implements a 2000 ms timeout for link training. If in a case
3331 * link trains before timeout, loop will exit earlier.
3333 * There are also some 2.0 hard drive based devices and 3.0 thumb
3334 * drives that, when plugged into a 2.0 only port, take a long
3335 * time to set CCS after VBUS enable.
3337 * FIXME: If a device was connected before suspend, but was removed
3338 * while system was asleep, then the loop in the following routine will
3339 * only exit at timeout.
3341 * This routine should only be called when persist is enabled.
3343 static int wait_for_connected(struct usb_device
*udev
,
3344 struct usb_hub
*hub
, int *port1
,
3345 u16
*portchange
, u16
*portstatus
)
3347 int status
= 0, delay_ms
= 0;
3349 while (delay_ms
< 2000) {
3350 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3354 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3356 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3361 * usb_port_resume - re-activate a suspended usb device's upstream port
3362 * @udev: device to re-activate, not a root hub
3363 * Context: must be able to sleep; device not locked; pm locks held
3365 * This will re-activate the suspended device, increasing power usage
3366 * while letting drivers communicate again with its endpoints.
3367 * USB resume explicitly guarantees that the power session between
3368 * the host and the device is the same as it was when the device
3371 * If @udev->reset_resume is set then this routine won't check that the
3372 * port is still enabled. Furthermore, finish_port_resume() above will
3373 * reset @udev. The end result is that a broken power session can be
3374 * recovered and @udev will appear to persist across a loss of VBUS power.
3376 * For example, if a host controller doesn't maintain VBUS suspend current
3377 * during a system sleep or is reset when the system wakes up, all the USB
3378 * power sessions below it will be broken. This is especially troublesome
3379 * for mass-storage devices containing mounted filesystems, since the
3380 * device will appear to have disconnected and all the memory mappings
3381 * to it will be lost. Using the USB_PERSIST facility, the device can be
3382 * made to appear as if it had not disconnected.
3384 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3385 * every effort to insure that the same device is present after the
3386 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3387 * quite possible for a device to remain unaltered but its media to be
3388 * changed. If the user replaces a flash memory card while the system is
3389 * asleep, he will have only himself to blame when the filesystem on the
3390 * new card is corrupted and the system crashes.
3392 * Returns 0 on success, else negative errno.
3394 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3396 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3397 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3398 int port1
= udev
->portnum
;
3400 u16 portchange
, portstatus
;
3402 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3403 status
= pm_runtime_get_sync(&port_dev
->dev
);
3405 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3411 usb_lock_port(port_dev
);
3413 /* Skip the initial Clear-Suspend step for a remote wakeup */
3414 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3415 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3416 goto SuspendCleared
;
3418 /* see 7.1.7.7; affects power usage, but not budgeting */
3419 if (hub_is_superspeed(hub
->hdev
))
3420 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3422 status
= usb_clear_port_feature(hub
->hdev
,
3423 port1
, USB_PORT_FEAT_SUSPEND
);
3425 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3427 /* drive resume for USB_RESUME_TIMEOUT msec */
3428 dev_dbg(&udev
->dev
, "usb %sresume\n",
3429 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3430 msleep(USB_RESUME_TIMEOUT
);
3432 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3433 * stop resume signaling. Then finish the resume
3436 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3438 /* TRSMRCY = 10 msec */
3444 udev
->port_is_suspended
= 0;
3445 if (hub_is_superspeed(hub
->hdev
)) {
3446 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3447 usb_clear_port_feature(hub
->hdev
, port1
,
3448 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3450 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3451 usb_clear_port_feature(hub
->hdev
, port1
,
3452 USB_PORT_FEAT_C_SUSPEND
);
3456 if (udev
->persist_enabled
)
3457 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3460 status
= check_port_resume_type(udev
,
3461 hub
, port1
, status
, portchange
, portstatus
);
3463 status
= finish_port_resume(udev
);
3465 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3466 hub_port_logical_disconnect(hub
, port1
);
3468 /* Try to enable USB2 hardware LPM */
3469 if (udev
->usb2_hw_lpm_capable
== 1)
3470 usb_set_usb2_hardware_lpm(udev
, 1);
3472 /* Try to enable USB3 LTM */
3473 usb_enable_ltm(udev
);
3476 usb_unlock_port(port_dev
);
3481 int usb_remote_wakeup(struct usb_device
*udev
)
3485 usb_lock_device(udev
);
3486 if (udev
->state
== USB_STATE_SUSPENDED
) {
3487 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3488 status
= usb_autoresume_device(udev
);
3490 /* Let the drivers do their thing, then... */
3491 usb_autosuspend_device(udev
);
3494 usb_unlock_device(udev
);
3498 /* Returns 1 if there was a remote wakeup and a connect status change. */
3499 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3500 u16 portstatus
, u16 portchange
)
3501 __must_hold(&port_dev
->status_lock
)
3503 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3504 struct usb_device
*hdev
;
3505 struct usb_device
*udev
;
3506 int connect_change
= 0;
3510 udev
= port_dev
->child
;
3511 if (!hub_is_superspeed(hdev
)) {
3512 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3514 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3516 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3517 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
3523 /* TRSMRCY = 10 msec */
3526 usb_unlock_port(port_dev
);
3527 ret
= usb_remote_wakeup(udev
);
3528 usb_lock_port(port_dev
);
3533 hub_port_disable(hub
, port
, 1);
3535 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3536 return connect_change
;
3539 static int check_ports_changed(struct usb_hub
*hub
)
3543 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3544 u16 portstatus
, portchange
;
3547 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3548 if (!status
&& portchange
)
3554 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3556 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3557 struct usb_device
*hdev
= hub
->hdev
;
3562 * Warn if children aren't already suspended.
3563 * Also, add up the number of wakeup-enabled descendants.
3565 hub
->wakeup_enabled_descendants
= 0;
3566 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3567 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3568 struct usb_device
*udev
= port_dev
->child
;
3570 if (udev
&& udev
->can_submit
) {
3571 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3572 dev_name(&udev
->dev
));
3573 if (PMSG_IS_AUTO(msg
))
3577 hub
->wakeup_enabled_descendants
+=
3578 wakeup_enabled_descendants(udev
);
3581 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3582 /* check if there are changes pending on hub ports */
3583 if (check_ports_changed(hub
)) {
3584 if (PMSG_IS_AUTO(msg
))
3586 pm_wakeup_event(&hdev
->dev
, 2000);
3590 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3591 /* Enable hub to send remote wakeup for all ports. */
3592 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3593 status
= set_port_feature(hdev
,
3595 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3596 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3597 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3598 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3602 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3604 /* stop hub_wq and related activity */
3605 hub_quiesce(hub
, HUB_SUSPEND
);
3609 static int hub_resume(struct usb_interface
*intf
)
3611 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3613 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3614 hub_activate(hub
, HUB_RESUME
);
3618 static int hub_reset_resume(struct usb_interface
*intf
)
3620 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3622 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3623 hub_activate(hub
, HUB_RESET_RESUME
);
3628 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3629 * @rhdev: struct usb_device for the root hub
3631 * The USB host controller driver calls this function when its root hub
3632 * is resumed and Vbus power has been interrupted or the controller
3633 * has been reset. The routine marks @rhdev as having lost power.
3634 * When the hub driver is resumed it will take notice and carry out
3635 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3636 * the others will be disconnected.
3638 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3640 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3641 rhdev
->reset_resume
= 1;
3643 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3645 static const char * const usb3_lpm_names
[] = {
3653 * Send a Set SEL control transfer to the device, prior to enabling
3654 * device-initiated U1 or U2. This lets the device know the exit latencies from
3655 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3656 * packet from the host.
3658 * This function will fail if the SEL or PEL values for udev are greater than
3659 * the maximum allowed values for the link state to be enabled.
3661 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3663 struct usb_set_sel_req
*sel_values
;
3664 unsigned long long u1_sel
;
3665 unsigned long long u1_pel
;
3666 unsigned long long u2_sel
;
3667 unsigned long long u2_pel
;
3670 if (udev
->state
!= USB_STATE_CONFIGURED
)
3673 /* Convert SEL and PEL stored in ns to us */
3674 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3675 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3676 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3677 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3680 * Make sure that the calculated SEL and PEL values for the link
3681 * state we're enabling aren't bigger than the max SEL/PEL
3682 * value that will fit in the SET SEL control transfer.
3683 * Otherwise the device would get an incorrect idea of the exit
3684 * latency for the link state, and could start a device-initiated
3685 * U1/U2 when the exit latencies are too high.
3687 if ((state
== USB3_LPM_U1
&&
3688 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3689 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3690 (state
== USB3_LPM_U2
&&
3691 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3692 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3693 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3694 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3699 * If we're enabling device-initiated LPM for one link state,
3700 * but the other link state has a too high SEL or PEL value,
3701 * just set those values to the max in the Set SEL request.
3703 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3704 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3706 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3707 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3709 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3710 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3712 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3713 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3716 * usb_enable_lpm() can be called as part of a failed device reset,
3717 * which may be initiated by an error path of a mass storage driver.
3718 * Therefore, use GFP_NOIO.
3720 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3724 sel_values
->u1_sel
= u1_sel
;
3725 sel_values
->u1_pel
= u1_pel
;
3726 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3727 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3729 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3733 sel_values
, sizeof *(sel_values
),
3734 USB_CTRL_SET_TIMEOUT
);
3740 * Enable or disable device-initiated U1 or U2 transitions.
3742 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3743 enum usb3_link_state state
, bool enable
)
3750 feature
= USB_DEVICE_U1_ENABLE
;
3753 feature
= USB_DEVICE_U2_ENABLE
;
3756 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3757 __func__
, enable
? "enable" : "disable");
3761 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3762 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3763 "for unconfigured device.\n",
3764 __func__
, enable
? "enable" : "disable",
3765 usb3_lpm_names
[state
]);
3771 * Now send the control transfer to enable device-initiated LPM
3772 * for either U1 or U2.
3774 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3775 USB_REQ_SET_FEATURE
,
3779 USB_CTRL_SET_TIMEOUT
);
3781 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3782 USB_REQ_CLEAR_FEATURE
,
3786 USB_CTRL_SET_TIMEOUT
);
3789 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3790 enable
? "Enable" : "Disable",
3791 usb3_lpm_names
[state
]);
3797 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3798 enum usb3_link_state state
, int timeout
)
3805 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3808 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3811 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3816 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3817 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3818 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3819 "which is a reserved value.\n",
3820 usb3_lpm_names
[state
], timeout
);
3824 ret
= set_port_feature(udev
->parent
,
3825 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3828 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3829 "error code %i\n", usb3_lpm_names
[state
],
3833 if (state
== USB3_LPM_U1
)
3834 udev
->u1_params
.timeout
= timeout
;
3836 udev
->u2_params
.timeout
= timeout
;
3841 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3844 * We will attempt to enable U1 or U2, but there are no guarantees that the
3845 * control transfers to set the hub timeout or enable device-initiated U1/U2
3846 * will be successful.
3848 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3849 * driver know about it. If that call fails, it should be harmless, and just
3850 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3852 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3853 enum usb3_link_state state
)
3856 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3857 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3859 /* If the device says it doesn't have *any* exit latency to come out of
3860 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3863 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3864 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3868 * First, let the device know about the exit latencies
3869 * associated with the link state we're about to enable.
3871 ret
= usb_req_set_sel(udev
, state
);
3873 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3874 usb3_lpm_names
[state
]);
3878 /* We allow the host controller to set the U1/U2 timeout internally
3879 * first, so that it can change its schedule to account for the
3880 * additional latency to send data to a device in a lower power
3883 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3885 /* xHCI host controller doesn't want to enable this LPM state. */
3890 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3891 "xHCI error %i.\n", usb3_lpm_names
[state
],
3896 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
3897 /* If we can't set the parent hub U1/U2 timeout,
3898 * device-initiated LPM won't be allowed either, so let the xHCI
3899 * host know that this link state won't be enabled.
3901 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3903 /* Only a configured device will accept the Set Feature
3906 if (udev
->actconfig
)
3907 usb_set_device_initiated_lpm(udev
, state
, true);
3909 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3910 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3911 * matter the result of usb_set_device_initiated_lpm().
3912 * The only difference is whether device is able to initiate
3915 if (state
== USB3_LPM_U1
)
3916 udev
->usb3_lpm_u1_enabled
= 1;
3917 else if (state
== USB3_LPM_U2
)
3918 udev
->usb3_lpm_u2_enabled
= 1;
3923 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3926 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3927 * If zero is returned, the parent will not allow the link to go into U1/U2.
3929 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3930 * it won't have an effect on the bus link state because the parent hub will
3931 * still disallow device-initiated U1/U2 entry.
3933 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3934 * possible. The result will be slightly more bus bandwidth will be taken up
3935 * (to account for U1/U2 exit latency), but it should be harmless.
3937 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3938 enum usb3_link_state state
)
3945 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3950 if (usb_set_lpm_timeout(udev
, state
, 0))
3953 usb_set_device_initiated_lpm(udev
, state
, false);
3955 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3956 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3957 "bus schedule bandwidth may be impacted.\n",
3958 usb3_lpm_names
[state
]);
3960 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3961 * is disabled. Hub will disallows link to enter U1/U2 as well,
3962 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3963 * timeout set to 0, no matter device-initiated LPM is disabled or
3966 if (state
== USB3_LPM_U1
)
3967 udev
->usb3_lpm_u1_enabled
= 0;
3968 else if (state
== USB3_LPM_U2
)
3969 udev
->usb3_lpm_u2_enabled
= 0;
3975 * Disable hub-initiated and device-initiated U1 and U2 entry.
3976 * Caller must own the bandwidth_mutex.
3978 * This will call usb_enable_lpm() on failure, which will decrement
3979 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3981 int usb_disable_lpm(struct usb_device
*udev
)
3983 struct usb_hcd
*hcd
;
3985 if (!udev
|| !udev
->parent
||
3986 udev
->speed
< USB_SPEED_SUPER
||
3987 !udev
->lpm_capable
||
3988 udev
->state
< USB_STATE_DEFAULT
)
3991 hcd
= bus_to_hcd(udev
->bus
);
3992 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3995 udev
->lpm_disable_count
++;
3996 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3999 /* If LPM is enabled, attempt to disable it. */
4000 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4002 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4008 usb_enable_lpm(udev
);
4011 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4013 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4014 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4016 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4022 mutex_lock(hcd
->bandwidth_mutex
);
4023 ret
= usb_disable_lpm(udev
);
4024 mutex_unlock(hcd
->bandwidth_mutex
);
4028 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4031 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4032 * xHCI host policy may prevent U1 or U2 from being enabled.
4034 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4035 * until the lpm_disable_count drops to zero. Caller must own the
4038 void usb_enable_lpm(struct usb_device
*udev
)
4040 struct usb_hcd
*hcd
;
4041 struct usb_hub
*hub
;
4042 struct usb_port
*port_dev
;
4044 if (!udev
|| !udev
->parent
||
4045 udev
->speed
< USB_SPEED_SUPER
||
4046 !udev
->lpm_capable
||
4047 udev
->state
< USB_STATE_DEFAULT
)
4050 udev
->lpm_disable_count
--;
4051 hcd
= bus_to_hcd(udev
->bus
);
4052 /* Double check that we can both enable and disable LPM.
4053 * Device must be configured to accept set feature U1/U2 timeout.
4055 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4056 !hcd
->driver
->disable_usb3_lpm_timeout
)
4059 if (udev
->lpm_disable_count
> 0)
4062 hub
= usb_hub_to_struct_hub(udev
->parent
);
4066 port_dev
= hub
->ports
[udev
->portnum
- 1];
4068 if (port_dev
->usb3_lpm_u1_permit
)
4069 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4071 if (port_dev
->usb3_lpm_u2_permit
)
4072 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4074 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4076 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4077 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4079 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4084 mutex_lock(hcd
->bandwidth_mutex
);
4085 usb_enable_lpm(udev
);
4086 mutex_unlock(hcd
->bandwidth_mutex
);
4088 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4090 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4091 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4092 struct usb_port
*port_dev
)
4094 struct usb_device
*udev
= port_dev
->child
;
4097 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4098 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4101 msleep(USB_RESUME_TIMEOUT
);
4102 ret
= usb_disable_remote_wakeup(udev
);
4105 dev_warn(&udev
->dev
,
4106 "Port disable: can't disable remote wake\n");
4107 udev
->do_remote_wakeup
= 0;
4111 #else /* CONFIG_PM */
4113 #define hub_suspend NULL
4114 #define hub_resume NULL
4115 #define hub_reset_resume NULL
4117 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4118 struct usb_port
*port_dev
) { }
4120 int usb_disable_lpm(struct usb_device
*udev
)
4124 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4126 void usb_enable_lpm(struct usb_device
*udev
) { }
4127 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4129 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4133 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4135 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4136 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4138 int usb_disable_ltm(struct usb_device
*udev
)
4142 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4144 void usb_enable_ltm(struct usb_device
*udev
) { }
4145 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4147 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4148 u16 portstatus
, u16 portchange
)
4153 #endif /* CONFIG_PM */
4156 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4157 * a connection with a plugged-in cable but will signal the host when the cable
4158 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4160 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4162 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4163 struct usb_device
*hdev
= hub
->hdev
;
4167 if (hub_is_superspeed(hub
->hdev
)) {
4168 hub_usb3_port_prepare_disable(hub
, port_dev
);
4169 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4172 ret
= usb_clear_port_feature(hdev
, port1
,
4173 USB_PORT_FEAT_ENABLE
);
4176 if (port_dev
->child
&& set_state
)
4177 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4178 if (ret
&& ret
!= -ENODEV
)
4179 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4184 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4186 * Between connect detection and reset signaling there must be a delay
4187 * of 100ms at least for debounce and power-settling. The corresponding
4188 * timer shall restart whenever the downstream port detects a disconnect.
4190 * Apparently there are some bluetooth and irda-dongles and a number of
4191 * low-speed devices for which this debounce period may last over a second.
4192 * Not covered by the spec - but easy to deal with.
4194 * This implementation uses a 1500ms total debounce timeout; if the
4195 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4196 * every 25ms for transient disconnects. When the port status has been
4197 * unchanged for 100ms it returns the port status.
4199 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4202 u16 portchange
, portstatus
;
4203 unsigned connection
= 0xffff;
4204 int total_time
, stable_time
= 0;
4205 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4207 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4208 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4212 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4213 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4214 if (!must_be_connected
||
4215 (connection
== USB_PORT_STAT_CONNECTION
))
4216 stable_time
+= HUB_DEBOUNCE_STEP
;
4217 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4221 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4224 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4225 usb_clear_port_feature(hub
->hdev
, port1
,
4226 USB_PORT_FEAT_C_CONNECTION
);
4229 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4231 msleep(HUB_DEBOUNCE_STEP
);
4234 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4235 total_time
, stable_time
, portstatus
);
4237 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4242 void usb_ep0_reinit(struct usb_device
*udev
)
4244 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4245 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4246 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4248 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4250 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4251 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4253 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4256 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4259 * The host controller will choose the device address,
4260 * instead of the core having chosen it earlier
4262 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4264 if (udev
->state
== USB_STATE_ADDRESS
)
4266 if (udev
->state
!= USB_STATE_DEFAULT
)
4268 if (hcd
->driver
->address_device
)
4269 retval
= hcd
->driver
->address_device(hcd
, udev
);
4271 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4272 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4273 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4275 update_devnum(udev
, devnum
);
4276 /* Device now using proper address. */
4277 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4278 usb_ep0_reinit(udev
);
4284 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4285 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4288 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4289 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4290 * support bit in the BOS descriptor.
4292 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4294 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4295 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4297 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4301 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4303 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4304 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4305 udev
->usb2_hw_lpm_allowed
= 1;
4306 usb_set_usb2_hardware_lpm(udev
, 1);
4310 static int hub_enable_device(struct usb_device
*udev
)
4312 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4314 if (!hcd
->driver
->enable_device
)
4316 if (udev
->state
== USB_STATE_ADDRESS
)
4318 if (udev
->state
!= USB_STATE_DEFAULT
)
4321 return hcd
->driver
->enable_device(hcd
, udev
);
4324 /* Reset device, (re)assign address, get device descriptor.
4325 * Device connection must be stable, no more debouncing needed.
4326 * Returns device in USB_STATE_ADDRESS, except on error.
4328 * If this is called for an already-existing device (as part of
4329 * usb_reset_and_verify_device), the caller must own the device lock and
4330 * the port lock. For a newly detected device that is not accessible
4331 * through any global pointers, it's not necessary to lock the device,
4332 * but it is still necessary to lock the port.
4335 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4338 struct usb_device
*hdev
= hub
->hdev
;
4339 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4340 int retries
, operations
, retval
, i
;
4341 unsigned delay
= HUB_SHORT_RESET_TIME
;
4342 enum usb_device_speed oldspeed
= udev
->speed
;
4344 int devnum
= udev
->devnum
;
4345 const char *driver_name
;
4347 /* root hub ports have a slightly longer reset period
4348 * (from USB 2.0 spec, section 7.1.7.5)
4350 if (!hdev
->parent
) {
4351 delay
= HUB_ROOT_RESET_TIME
;
4352 if (port1
== hdev
->bus
->otg_port
)
4353 hdev
->bus
->b_hnp_enable
= 0;
4356 /* Some low speed devices have problems with the quick delay, so */
4357 /* be a bit pessimistic with those devices. RHbug #23670 */
4358 if (oldspeed
== USB_SPEED_LOW
)
4359 delay
= HUB_LONG_RESET_TIME
;
4361 mutex_lock(hcd
->address0_mutex
);
4363 /* Reset the device; full speed may morph to high speed */
4364 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4365 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4366 if (retval
< 0) /* error or disconnect */
4368 /* success, speed is known */
4372 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4373 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4374 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4375 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4378 oldspeed
= udev
->speed
;
4380 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4381 * it's fixed size except for full speed devices.
4382 * For Wireless USB devices, ep0 max packet is always 512 (tho
4383 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4385 switch (udev
->speed
) {
4386 case USB_SPEED_SUPER_PLUS
:
4387 case USB_SPEED_SUPER
:
4388 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4389 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4391 case USB_SPEED_HIGH
: /* fixed at 64 */
4392 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4394 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4395 /* to determine the ep0 maxpacket size, try to read
4396 * the device descriptor to get bMaxPacketSize0 and
4397 * then correct our initial guess.
4399 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4401 case USB_SPEED_LOW
: /* fixed at 8 */
4402 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4408 if (udev
->speed
== USB_SPEED_WIRELESS
)
4409 speed
= "variable speed Wireless";
4411 speed
= usb_speed_string(udev
->speed
);
4414 * The controller driver may be NULL if the controller device
4415 * is the middle device between platform device and roothub.
4416 * This middle device may not need a device driver due to
4417 * all hardware control can be at platform device driver, this
4418 * platform device is usually a dual-role USB controller device.
4420 if (udev
->bus
->controller
->driver
)
4421 driver_name
= udev
->bus
->controller
->driver
->name
;
4423 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4425 if (udev
->speed
< USB_SPEED_SUPER
)
4426 dev_info(&udev
->dev
,
4427 "%s %s USB device number %d using %s\n",
4428 (udev
->config
) ? "reset" : "new", speed
,
4429 devnum
, driver_name
);
4431 /* Set up TT records, if needed */
4433 udev
->tt
= hdev
->tt
;
4434 udev
->ttport
= hdev
->ttport
;
4435 } else if (udev
->speed
!= USB_SPEED_HIGH
4436 && hdev
->speed
== USB_SPEED_HIGH
) {
4438 dev_err(&udev
->dev
, "parent hub has no TT\n");
4442 udev
->tt
= &hub
->tt
;
4443 udev
->ttport
= port1
;
4446 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4447 * Because device hardware and firmware is sometimes buggy in
4448 * this area, and this is how Linux has done it for ages.
4449 * Change it cautiously.
4451 * NOTE: If use_new_scheme() is true we will start by issuing
4452 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4453 * so it may help with some non-standards-compliant devices.
4454 * Otherwise we start with SET_ADDRESS and then try to read the
4455 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4458 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4459 bool did_new_scheme
= false;
4461 if (use_new_scheme(udev
, retry_counter
)) {
4462 struct usb_device_descriptor
*buf
;
4465 did_new_scheme
= true;
4466 retval
= hub_enable_device(udev
);
4469 "hub failed to enable device, error %d\n",
4474 #define GET_DESCRIPTOR_BUFSIZE 64
4475 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4481 /* Retry on all errors; some devices are flakey.
4482 * 255 is for WUSB devices, we actually need to use
4483 * 512 (WUSB1.0[4.8.1]).
4485 for (operations
= 0; operations
< 3; ++operations
) {
4486 buf
->bMaxPacketSize0
= 0;
4487 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4488 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4489 USB_DT_DEVICE
<< 8, 0,
4490 buf
, GET_DESCRIPTOR_BUFSIZE
,
4491 initial_descriptor_timeout
);
4492 switch (buf
->bMaxPacketSize0
) {
4493 case 8: case 16: case 32: case 64: case 255:
4494 if (buf
->bDescriptorType
==
4506 * Some devices time out if they are powered on
4507 * when already connected. They need a second
4508 * reset. But only on the first attempt,
4509 * lest we get into a time out/reset loop
4511 if (r
== 0 || (r
== -ETIMEDOUT
&& retries
== 0))
4514 udev
->descriptor
.bMaxPacketSize0
=
4515 buf
->bMaxPacketSize0
;
4518 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4519 if (retval
< 0) /* error or disconnect */
4521 if (oldspeed
!= udev
->speed
) {
4523 "device reset changed speed!\n");
4529 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4534 #undef GET_DESCRIPTOR_BUFSIZE
4538 * If device is WUSB, we already assigned an
4539 * unauthorized address in the Connect Ack sequence;
4540 * authorization will assign the final address.
4542 if (udev
->wusb
== 0) {
4543 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4544 retval
= hub_set_address(udev
, devnum
);
4550 if (retval
!= -ENODEV
)
4551 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4555 if (udev
->speed
>= USB_SPEED_SUPER
) {
4556 devnum
= udev
->devnum
;
4557 dev_info(&udev
->dev
,
4558 "%s SuperSpeed%s USB device number %d using %s\n",
4559 (udev
->config
) ? "reset" : "new",
4560 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ? "Plus" : "",
4561 devnum
, driver_name
);
4564 /* cope with hardware quirkiness:
4565 * - let SET_ADDRESS settle, some device hardware wants it
4566 * - read ep0 maxpacket even for high and low speed,
4569 /* use_new_scheme() checks the speed which may have
4570 * changed since the initial look so we cache the result
4577 retval
= usb_get_device_descriptor(udev
, 8);
4579 if (retval
!= -ENODEV
)
4581 "device descriptor read/8, error %d\n",
4594 * Some superspeed devices have finished the link training process
4595 * and attached to a superspeed hub port, but the device descriptor
4596 * got from those devices show they aren't superspeed devices. Warm
4597 * reset the port attached by the devices can fix them.
4599 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4600 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4601 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4602 "warm reset device\n");
4603 hub_port_reset(hub
, port1
, udev
,
4604 HUB_BH_RESET_TIME
, true);
4609 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4610 udev
->speed
>= USB_SPEED_SUPER
)
4613 i
= udev
->descriptor
.bMaxPacketSize0
;
4614 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4615 if (udev
->speed
== USB_SPEED_LOW
||
4616 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4617 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4621 if (udev
->speed
== USB_SPEED_FULL
)
4622 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4624 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4625 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4626 usb_ep0_reinit(udev
);
4629 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4630 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4631 if (retval
!= -ENODEV
)
4632 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4639 usb_detect_quirks(udev
);
4641 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4642 retval
= usb_get_bos_descriptor(udev
);
4644 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4645 usb_set_lpm_parameters(udev
);
4650 /* notify HCD that we have a device connected and addressed */
4651 if (hcd
->driver
->update_device
)
4652 hcd
->driver
->update_device(hcd
, udev
);
4653 hub_set_initial_usb2_lpm_policy(udev
);
4656 hub_port_disable(hub
, port1
, 0);
4657 update_devnum(udev
, devnum
); /* for disconnect processing */
4659 mutex_unlock(hcd
->address0_mutex
);
4664 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4666 struct usb_qualifier_descriptor
*qual
;
4669 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4672 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4676 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4677 qual
, sizeof *qual
);
4678 if (status
== sizeof *qual
) {
4679 dev_info(&udev
->dev
, "not running at top speed; "
4680 "connect to a high speed hub\n");
4681 /* hub LEDs are probably harder to miss than syslog */
4682 if (hub
->has_indicators
) {
4683 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4684 queue_delayed_work(system_power_efficient_wq
,
4692 hub_power_remaining(struct usb_hub
*hub
)
4694 struct usb_device
*hdev
= hub
->hdev
;
4698 if (!hub
->limited_power
)
4701 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4702 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4703 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4704 struct usb_device
*udev
= port_dev
->child
;
4710 if (hub_is_superspeed(udev
))
4716 * Unconfigured devices may not use more than one unit load,
4717 * or 8mA for OTG ports
4719 if (udev
->actconfig
)
4720 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4721 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4725 if (delta
> hub
->mA_per_port
)
4726 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4727 delta
, hub
->mA_per_port
);
4730 if (remaining
< 0) {
4731 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4738 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4741 int status
= -ENODEV
;
4744 struct usb_device
*hdev
= hub
->hdev
;
4745 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4746 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4747 struct usb_device
*udev
= port_dev
->child
;
4748 static int unreliable_port
= -1;
4750 /* Disconnect any existing devices under this port */
4752 if (hcd
->usb_phy
&& !hdev
->parent
)
4753 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4754 usb_disconnect(&port_dev
->child
);
4757 /* We can forget about a "removed" device when there's a physical
4758 * disconnect or the connect status changes.
4760 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4761 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4762 clear_bit(port1
, hub
->removed_bits
);
4764 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4765 USB_PORT_STAT_C_ENABLE
)) {
4766 status
= hub_port_debounce_be_stable(hub
, port1
);
4768 if (status
!= -ENODEV
&&
4769 port1
!= unreliable_port
&&
4771 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4772 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4773 unreliable_port
= port1
;
4775 portstatus
= status
;
4779 /* Return now if debouncing failed or nothing is connected or
4780 * the device was "removed".
4782 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4783 test_bit(port1
, hub
->removed_bits
)) {
4786 * maybe switch power back on (e.g. root hub was reset)
4787 * but only if the port isn't owned by someone else.
4789 if (hub_is_port_power_switchable(hub
)
4790 && !port_is_power_on(hub
, portstatus
)
4791 && !port_dev
->port_owner
)
4792 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4794 if (portstatus
& USB_PORT_STAT_ENABLE
)
4798 if (hub_is_superspeed(hub
->hdev
))
4804 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4806 /* reallocate for each attempt, since references
4807 * to the previous one can escape in various ways
4809 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4811 dev_err(&port_dev
->dev
,
4812 "couldn't allocate usb_device\n");
4816 usb_set_device_state(udev
, USB_STATE_POWERED
);
4817 udev
->bus_mA
= hub
->mA_per_port
;
4818 udev
->level
= hdev
->level
+ 1;
4819 udev
->wusb
= hub_is_wusb(hub
);
4821 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4822 if (hub_is_superspeed(hub
->hdev
))
4823 udev
->speed
= USB_SPEED_SUPER
;
4825 udev
->speed
= USB_SPEED_UNKNOWN
;
4827 choose_devnum(udev
);
4828 if (udev
->devnum
<= 0) {
4829 status
= -ENOTCONN
; /* Don't retry */
4833 /* reset (non-USB 3.0 devices) and get descriptor */
4834 usb_lock_port(port_dev
);
4835 status
= hub_port_init(hub
, udev
, port1
, i
);
4836 usb_unlock_port(port_dev
);
4840 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4843 /* consecutive bus-powered hubs aren't reliable; they can
4844 * violate the voltage drop budget. if the new child has
4845 * a "powered" LED, users should notice we didn't enable it
4846 * (without reading syslog), even without per-port LEDs
4849 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4850 && udev
->bus_mA
<= unit_load
) {
4853 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4856 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4859 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4861 "can't connect bus-powered hub "
4863 if (hub
->has_indicators
) {
4864 hub
->indicator
[port1
-1] =
4865 INDICATOR_AMBER_BLINK
;
4867 system_power_efficient_wq
,
4870 status
= -ENOTCONN
; /* Don't retry */
4875 /* check for devices running slower than they could */
4876 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4877 && udev
->speed
== USB_SPEED_FULL
4878 && highspeed_hubs
!= 0)
4879 check_highspeed(hub
, udev
, port1
);
4881 /* Store the parent's children[] pointer. At this point
4882 * udev becomes globally accessible, although presumably
4883 * no one will look at it until hdev is unlocked.
4887 mutex_lock(&usb_port_peer_mutex
);
4889 /* We mustn't add new devices if the parent hub has
4890 * been disconnected; we would race with the
4891 * recursively_mark_NOTATTACHED() routine.
4893 spin_lock_irq(&device_state_lock
);
4894 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4897 port_dev
->child
= udev
;
4898 spin_unlock_irq(&device_state_lock
);
4899 mutex_unlock(&usb_port_peer_mutex
);
4901 /* Run it through the hoops (find a driver, etc) */
4903 status
= usb_new_device(udev
);
4905 mutex_lock(&usb_port_peer_mutex
);
4906 spin_lock_irq(&device_state_lock
);
4907 port_dev
->child
= NULL
;
4908 spin_unlock_irq(&device_state_lock
);
4909 mutex_unlock(&usb_port_peer_mutex
);
4911 if (hcd
->usb_phy
&& !hdev
->parent
)
4912 usb_phy_notify_connect(hcd
->usb_phy
,
4920 status
= hub_power_remaining(hub
);
4922 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
4927 hub_port_disable(hub
, port1
, 1);
4929 usb_ep0_reinit(udev
);
4930 release_devnum(udev
);
4933 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4936 if (hub
->hdev
->parent
||
4937 !hcd
->driver
->port_handed_over
||
4938 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4939 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4940 dev_err(&port_dev
->dev
,
4941 "unable to enumerate USB device\n");
4945 hub_port_disable(hub
, port1
, 1);
4946 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
4947 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4948 hcd
->driver
->relinquish_port(hcd
, port1
);
4952 /* Handle physical or logical connection change events.
4953 * This routine is called when:
4954 * a port connection-change occurs;
4955 * a port enable-change occurs (often caused by EMI);
4956 * usb_reset_and_verify_device() encounters changed descriptors (as from
4957 * a firmware download)
4958 * caller already locked the hub
4960 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4961 u16 portstatus
, u16 portchange
)
4962 __must_hold(&port_dev
->status_lock
)
4964 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4965 struct usb_device
*udev
= port_dev
->child
;
4966 int status
= -ENODEV
;
4968 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
4969 portchange
, portspeed(hub
, portstatus
));
4971 if (hub
->has_indicators
) {
4972 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4973 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4976 #ifdef CONFIG_USB_OTG
4977 /* during HNP, don't repeat the debounce */
4978 if (hub
->hdev
->bus
->is_b_host
)
4979 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4980 USB_PORT_STAT_C_ENABLE
);
4983 /* Try to resuscitate an existing device */
4984 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4985 udev
->state
!= USB_STATE_NOTATTACHED
) {
4986 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4987 status
= 0; /* Nothing to do */
4989 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4990 udev
->persist_enabled
) {
4991 /* For a suspended device, treat this as a
4992 * remote wakeup event.
4994 usb_unlock_port(port_dev
);
4995 status
= usb_remote_wakeup(udev
);
4996 usb_lock_port(port_dev
);
4999 /* Don't resuscitate */;
5002 clear_bit(port1
, hub
->change_bits
);
5004 /* successfully revalidated the connection */
5008 usb_unlock_port(port_dev
);
5009 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5010 usb_lock_port(port_dev
);
5013 static void port_event(struct usb_hub
*hub
, int port1
)
5014 __must_hold(&port_dev
->status_lock
)
5017 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5018 struct usb_device
*udev
= port_dev
->child
;
5019 struct usb_device
*hdev
= hub
->hdev
;
5020 u16 portstatus
, portchange
;
5022 connect_change
= test_bit(port1
, hub
->change_bits
);
5023 clear_bit(port1
, hub
->event_bits
);
5024 clear_bit(port1
, hub
->wakeup_bits
);
5026 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5029 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5030 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5034 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5035 if (!connect_change
)
5036 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5038 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5041 * EM interference sometimes causes badly shielded USB devices
5042 * to be shutdown by the hub, this hack enables them again.
5043 * Works at least with mouse driver.
5045 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5046 && !connect_change
&& udev
) {
5047 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5052 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5053 u16 status
= 0, unused
;
5055 dev_dbg(&port_dev
->dev
, "over-current change\n");
5056 usb_clear_port_feature(hdev
, port1
,
5057 USB_PORT_FEAT_C_OVER_CURRENT
);
5058 msleep(100); /* Cool down */
5059 hub_power_on(hub
, true);
5060 hub_port_status(hub
, port1
, &status
, &unused
);
5061 if (status
& USB_PORT_STAT_OVERCURRENT
)
5062 dev_err(&port_dev
->dev
, "over-current condition\n");
5065 if (portchange
& USB_PORT_STAT_C_RESET
) {
5066 dev_dbg(&port_dev
->dev
, "reset change\n");
5067 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5069 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5070 && hub_is_superspeed(hdev
)) {
5071 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5072 usb_clear_port_feature(hdev
, port1
,
5073 USB_PORT_FEAT_C_BH_PORT_RESET
);
5075 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5076 dev_dbg(&port_dev
->dev
, "link state change\n");
5077 usb_clear_port_feature(hdev
, port1
,
5078 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5080 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5081 dev_warn(&port_dev
->dev
, "config error\n");
5082 usb_clear_port_feature(hdev
, port1
,
5083 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5086 /* skip port actions that require the port to be powered on */
5087 if (!pm_runtime_active(&port_dev
->dev
))
5090 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5094 * Warm reset a USB3 protocol port if it's in
5095 * SS.Inactive state.
5097 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5098 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5099 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5100 || udev
->state
== USB_STATE_NOTATTACHED
) {
5101 if (hub_port_reset(hub
, port1
, NULL
,
5102 HUB_BH_RESET_TIME
, true) < 0)
5103 hub_port_disable(hub
, port1
, 1);
5105 usb_unlock_port(port_dev
);
5106 usb_lock_device(udev
);
5107 usb_reset_device(udev
);
5108 usb_unlock_device(udev
);
5109 usb_lock_port(port_dev
);
5115 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5118 static void hub_event(struct work_struct
*work
)
5120 struct usb_device
*hdev
;
5121 struct usb_interface
*intf
;
5122 struct usb_hub
*hub
;
5123 struct device
*hub_dev
;
5128 hub
= container_of(work
, struct usb_hub
, events
);
5130 hub_dev
= hub
->intfdev
;
5131 intf
= to_usb_interface(hub_dev
);
5133 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5134 hdev
->state
, hdev
->maxchild
,
5135 /* NOTE: expects max 15 ports... */
5136 (u16
) hub
->change_bits
[0],
5137 (u16
) hub
->event_bits
[0]);
5139 /* Lock the device, then check to see if we were
5140 * disconnected while waiting for the lock to succeed. */
5141 usb_lock_device(hdev
);
5142 if (unlikely(hub
->disconnected
))
5145 /* If the hub has died, clean up after it */
5146 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5147 hub
->error
= -ENODEV
;
5148 hub_quiesce(hub
, HUB_DISCONNECT
);
5153 ret
= usb_autopm_get_interface(intf
);
5155 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5159 /* If this is an inactive hub, do nothing */
5164 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5166 ret
= usb_reset_device(hdev
);
5168 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5176 /* deal with port status changes */
5177 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5178 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5180 if (test_bit(i
, hub
->event_bits
)
5181 || test_bit(i
, hub
->change_bits
)
5182 || test_bit(i
, hub
->wakeup_bits
)) {
5184 * The get_noresume and barrier ensure that if
5185 * the port was in the process of resuming, we
5186 * flush that work and keep the port active for
5187 * the duration of the port_event(). However,
5188 * if the port is runtime pm suspended
5189 * (powered-off), we leave it in that state, run
5190 * an abbreviated port_event(), and move on.
5192 pm_runtime_get_noresume(&port_dev
->dev
);
5193 pm_runtime_barrier(&port_dev
->dev
);
5194 usb_lock_port(port_dev
);
5196 usb_unlock_port(port_dev
);
5197 pm_runtime_put_sync(&port_dev
->dev
);
5201 /* deal with hub status changes */
5202 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5204 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5205 dev_err(hub_dev
, "get_hub_status failed\n");
5207 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5208 dev_dbg(hub_dev
, "power change\n");
5209 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5210 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5211 /* FIXME: Is this always true? */
5212 hub
->limited_power
= 1;
5214 hub
->limited_power
= 0;
5216 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5220 dev_dbg(hub_dev
, "over-current change\n");
5221 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5222 msleep(500); /* Cool down */
5223 hub_power_on(hub
, true);
5224 hub_hub_status(hub
, &status
, &unused
);
5225 if (status
& HUB_STATUS_OVERCURRENT
)
5226 dev_err(hub_dev
, "over-current condition\n");
5231 /* Balance the usb_autopm_get_interface() above */
5232 usb_autopm_put_interface_no_suspend(intf
);
5234 usb_unlock_device(hdev
);
5236 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5237 usb_autopm_put_interface(intf
);
5238 kref_put(&hub
->kref
, hub_release
);
5241 static const struct usb_device_id hub_id_table
[] = {
5242 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5243 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5244 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5245 .bInterfaceClass
= USB_CLASS_HUB
,
5246 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5247 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5248 .bDeviceClass
= USB_CLASS_HUB
},
5249 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5250 .bInterfaceClass
= USB_CLASS_HUB
},
5251 { } /* Terminating entry */
5254 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5256 static struct usb_driver hub_driver
= {
5259 .disconnect
= hub_disconnect
,
5260 .suspend
= hub_suspend
,
5261 .resume
= hub_resume
,
5262 .reset_resume
= hub_reset_resume
,
5263 .pre_reset
= hub_pre_reset
,
5264 .post_reset
= hub_post_reset
,
5265 .unlocked_ioctl
= hub_ioctl
,
5266 .id_table
= hub_id_table
,
5267 .supports_autosuspend
= 1,
5270 int usb_hub_init(void)
5272 if (usb_register(&hub_driver
) < 0) {
5273 printk(KERN_ERR
"%s: can't register hub driver\n",
5279 * The workqueue needs to be freezable to avoid interfering with
5280 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5281 * device was gone before the EHCI controller had handed its port
5282 * over to the companion full-speed controller.
5284 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5288 /* Fall through if kernel_thread failed */
5289 usb_deregister(&hub_driver
);
5290 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5295 void usb_hub_cleanup(void)
5297 destroy_workqueue(hub_wq
);
5300 * Hub resources are freed for us by usb_deregister. It calls
5301 * usb_driver_purge on every device which in turn calls that
5302 * devices disconnect function if it is using this driver.
5303 * The hub_disconnect function takes care of releasing the
5304 * individual hub resources. -greg
5306 usb_deregister(&hub_driver
);
5307 } /* usb_hub_cleanup() */
5309 static int descriptors_changed(struct usb_device
*udev
,
5310 struct usb_device_descriptor
*old_device_descriptor
,
5311 struct usb_host_bos
*old_bos
)
5315 unsigned serial_len
= 0;
5317 unsigned old_length
;
5321 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5322 sizeof(*old_device_descriptor
)) != 0)
5325 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5328 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5329 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5331 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5335 /* Since the idVendor, idProduct, and bcdDevice values in the
5336 * device descriptor haven't changed, we will assume the
5337 * Manufacturer and Product strings haven't changed either.
5338 * But the SerialNumber string could be different (e.g., a
5339 * different flash card of the same brand).
5342 serial_len
= strlen(udev
->serial
) + 1;
5345 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5346 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5347 len
= max(len
, old_length
);
5350 buf
= kmalloc(len
, GFP_NOIO
);
5352 /* assume the worst */
5355 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5356 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5357 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5359 if (length
!= old_length
) {
5360 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5365 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5367 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5369 ((struct usb_config_descriptor
*) buf
)->
5370 bConfigurationValue
);
5376 if (!changed
&& serial_len
) {
5377 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5379 if (length
+ 1 != serial_len
) {
5380 dev_dbg(&udev
->dev
, "serial string error %d\n",
5383 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5384 dev_dbg(&udev
->dev
, "serial string changed\n");
5394 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5395 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5397 * WARNING - don't use this routine to reset a composite device
5398 * (one with multiple interfaces owned by separate drivers)!
5399 * Use usb_reset_device() instead.
5401 * Do a port reset, reassign the device's address, and establish its
5402 * former operating configuration. If the reset fails, or the device's
5403 * descriptors change from their values before the reset, or the original
5404 * configuration and altsettings cannot be restored, a flag will be set
5405 * telling hub_wq to pretend the device has been disconnected and then
5406 * re-connected. All drivers will be unbound, and the device will be
5407 * re-enumerated and probed all over again.
5409 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5410 * flagged for logical disconnection, or some other negative error code
5411 * if the reset wasn't even attempted.
5414 * The caller must own the device lock and the port lock, the latter is
5415 * taken by usb_reset_device(). For example, it's safe to use
5416 * usb_reset_device() from a driver probe() routine after downloading
5417 * new firmware. For calls that might not occur during probe(), drivers
5418 * should lock the device using usb_lock_device_for_reset().
5420 * Locking exception: This routine may also be called from within an
5421 * autoresume handler. Such usage won't conflict with other tasks
5422 * holding the device lock because these tasks should always call
5423 * usb_autopm_resume_device(), thereby preventing any unwanted
5424 * autoresume. The autoresume handler is expected to have already
5425 * acquired the port lock before calling this routine.
5427 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5429 struct usb_device
*parent_hdev
= udev
->parent
;
5430 struct usb_hub
*parent_hub
;
5431 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5432 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5433 struct usb_host_bos
*bos
;
5435 int port1
= udev
->portnum
;
5437 if (udev
->state
== USB_STATE_NOTATTACHED
||
5438 udev
->state
== USB_STATE_SUSPENDED
) {
5439 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5447 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5449 /* Disable USB2 hardware LPM.
5450 * It will be re-enabled by the enumeration process.
5452 if (udev
->usb2_hw_lpm_enabled
== 1)
5453 usb_set_usb2_hardware_lpm(udev
, 0);
5455 /* Disable LPM and LTM while we reset the device and reinstall the alt
5456 * settings. Device-initiated LPM settings, and system exit latency
5457 * settings are cleared when the device is reset, so we have to set
5460 ret
= usb_unlocked_disable_lpm(udev
);
5462 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5463 goto re_enumerate_no_bos
;
5465 ret
= usb_disable_ltm(udev
);
5467 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5469 goto re_enumerate_no_bos
;
5475 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5477 /* ep0 maxpacket size may change; let the HCD know about it.
5478 * Other endpoints will be handled by re-enumeration. */
5479 usb_ep0_reinit(udev
);
5480 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5481 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5488 /* Device might have changed firmware (DFU or similar) */
5489 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5490 dev_info(&udev
->dev
, "device firmware changed\n");
5491 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5495 /* Restore the device's previous configuration */
5496 if (!udev
->actconfig
)
5499 mutex_lock(hcd
->bandwidth_mutex
);
5500 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5502 dev_warn(&udev
->dev
,
5503 "Busted HC? Not enough HCD resources for "
5504 "old configuration.\n");
5505 mutex_unlock(hcd
->bandwidth_mutex
);
5508 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5509 USB_REQ_SET_CONFIGURATION
, 0,
5510 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5511 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5514 "can't restore configuration #%d (error=%d)\n",
5515 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5516 mutex_unlock(hcd
->bandwidth_mutex
);
5519 mutex_unlock(hcd
->bandwidth_mutex
);
5520 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5522 /* Put interfaces back into the same altsettings as before.
5523 * Don't bother to send the Set-Interface request for interfaces
5524 * that were already in altsetting 0; besides being unnecessary,
5525 * many devices can't handle it. Instead just reset the host-side
5528 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5529 struct usb_host_config
*config
= udev
->actconfig
;
5530 struct usb_interface
*intf
= config
->interface
[i
];
5531 struct usb_interface_descriptor
*desc
;
5533 desc
= &intf
->cur_altsetting
->desc
;
5534 if (desc
->bAlternateSetting
== 0) {
5535 usb_disable_interface(udev
, intf
, true);
5536 usb_enable_interface(udev
, intf
, true);
5539 /* Let the bandwidth allocation function know that this
5540 * device has been reset, and it will have to use
5541 * alternate setting 0 as the current alternate setting.
5543 intf
->resetting_device
= 1;
5544 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5545 desc
->bAlternateSetting
);
5546 intf
->resetting_device
= 0;
5549 dev_err(&udev
->dev
, "failed to restore interface %d "
5550 "altsetting %d (error=%d)\n",
5551 desc
->bInterfaceNumber
,
5552 desc
->bAlternateSetting
,
5556 /* Resetting also frees any allocated streams */
5557 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5558 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5562 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5563 usb_set_usb2_hardware_lpm(udev
, 1);
5564 usb_unlocked_enable_lpm(udev
);
5565 usb_enable_ltm(udev
);
5566 usb_release_bos_descriptor(udev
);
5571 usb_release_bos_descriptor(udev
);
5573 re_enumerate_no_bos
:
5574 /* LPM state doesn't matter when we're about to destroy the device. */
5575 hub_port_logical_disconnect(parent_hub
, port1
);
5580 * usb_reset_device - warn interface drivers and perform a USB port reset
5581 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5583 * Warns all drivers bound to registered interfaces (using their pre_reset
5584 * method), performs the port reset, and then lets the drivers know that
5585 * the reset is over (using their post_reset method).
5587 * Return: The same as for usb_reset_and_verify_device().
5590 * The caller must own the device lock. For example, it's safe to use
5591 * this from a driver probe() routine after downloading new firmware.
5592 * For calls that might not occur during probe(), drivers should lock
5593 * the device using usb_lock_device_for_reset().
5595 * If an interface is currently being probed or disconnected, we assume
5596 * its driver knows how to handle resets. For all other interfaces,
5597 * if the driver doesn't have pre_reset and post_reset methods then
5598 * we attempt to unbind it and rebind afterward.
5600 int usb_reset_device(struct usb_device
*udev
)
5604 unsigned int noio_flag
;
5605 struct usb_port
*port_dev
;
5606 struct usb_host_config
*config
= udev
->actconfig
;
5607 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5609 if (udev
->state
== USB_STATE_NOTATTACHED
||
5610 udev
->state
== USB_STATE_SUSPENDED
) {
5611 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5616 if (!udev
->parent
) {
5617 /* this requires hcd-specific logic; see ohci_restart() */
5618 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5622 port_dev
= hub
->ports
[udev
->portnum
- 1];
5625 * Don't allocate memory with GFP_KERNEL in current
5626 * context to avoid possible deadlock if usb mass
5627 * storage interface or usbnet interface(iSCSI case)
5628 * is included in current configuration. The easist
5629 * approach is to do it for every device reset,
5630 * because the device 'memalloc_noio' flag may have
5631 * not been set before reseting the usb device.
5633 noio_flag
= memalloc_noio_save();
5635 /* Prevent autosuspend during the reset */
5636 usb_autoresume_device(udev
);
5639 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5640 struct usb_interface
*cintf
= config
->interface
[i
];
5641 struct usb_driver
*drv
;
5644 if (cintf
->dev
.driver
) {
5645 drv
= to_usb_driver(cintf
->dev
.driver
);
5646 if (drv
->pre_reset
&& drv
->post_reset
)
5647 unbind
= (drv
->pre_reset
)(cintf
);
5648 else if (cintf
->condition
==
5649 USB_INTERFACE_BOUND
)
5652 usb_forced_unbind_intf(cintf
);
5657 usb_lock_port(port_dev
);
5658 ret
= usb_reset_and_verify_device(udev
);
5659 usb_unlock_port(port_dev
);
5662 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5663 struct usb_interface
*cintf
= config
->interface
[i
];
5664 struct usb_driver
*drv
;
5665 int rebind
= cintf
->needs_binding
;
5667 if (!rebind
&& cintf
->dev
.driver
) {
5668 drv
= to_usb_driver(cintf
->dev
.driver
);
5669 if (drv
->post_reset
)
5670 rebind
= (drv
->post_reset
)(cintf
);
5671 else if (cintf
->condition
==
5672 USB_INTERFACE_BOUND
)
5675 cintf
->needs_binding
= 1;
5678 usb_unbind_and_rebind_marked_interfaces(udev
);
5681 usb_autosuspend_device(udev
);
5682 memalloc_noio_restore(noio_flag
);
5685 EXPORT_SYMBOL_GPL(usb_reset_device
);
5689 * usb_queue_reset_device - Reset a USB device from an atomic context
5690 * @iface: USB interface belonging to the device to reset
5692 * This function can be used to reset a USB device from an atomic
5693 * context, where usb_reset_device() won't work (as it blocks).
5695 * Doing a reset via this method is functionally equivalent to calling
5696 * usb_reset_device(), except for the fact that it is delayed to a
5697 * workqueue. This means that any drivers bound to other interfaces
5698 * might be unbound, as well as users from usbfs in user space.
5702 * - Scheduling two resets at the same time from two different drivers
5703 * attached to two different interfaces of the same device is
5704 * possible; depending on how the driver attached to each interface
5705 * handles ->pre_reset(), the second reset might happen or not.
5707 * - If the reset is delayed so long that the interface is unbound from
5708 * its driver, the reset will be skipped.
5710 * - This function can be called during .probe(). It can also be called
5711 * during .disconnect(), but doing so is pointless because the reset
5712 * will not occur. If you really want to reset the device during
5713 * .disconnect(), call usb_reset_device() directly -- but watch out
5714 * for nested unbinding issues!
5716 void usb_queue_reset_device(struct usb_interface
*iface
)
5718 if (schedule_work(&iface
->reset_ws
))
5719 usb_get_intf(iface
);
5721 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5724 * usb_hub_find_child - Get the pointer of child device
5725 * attached to the port which is specified by @port1.
5726 * @hdev: USB device belonging to the usb hub
5727 * @port1: port num to indicate which port the child device
5730 * USB drivers call this function to get hub's child device
5733 * Return: %NULL if input param is invalid and
5734 * child's usb_device pointer if non-NULL.
5736 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5739 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5741 if (port1
< 1 || port1
> hdev
->maxchild
)
5743 return hub
->ports
[port1
- 1]->child
;
5745 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5747 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5748 struct usb_hub_descriptor
*desc
)
5750 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5751 enum usb_port_connect_type connect_type
;
5757 if (!hub_is_superspeed(hdev
)) {
5758 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5759 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5761 connect_type
= port_dev
->connect_type
;
5762 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5763 u8 mask
= 1 << (i
%8);
5765 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5766 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5767 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5772 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5774 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5775 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5777 connect_type
= port_dev
->connect_type
;
5778 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5781 if (!(port_removable
& mask
)) {
5782 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5783 port_removable
|= mask
;
5788 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5794 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5795 * @hdev: USB device belonging to the usb hub
5796 * @port1: port num of the port
5798 * Return: Port's acpi handle if successful, %NULL if params are
5801 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5804 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5809 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);