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)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/workqueue.h>
26 #include <linux/mutex.h>
27 #include <linux/random.h>
28 #include <linux/pm_qos.h>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
34 #include "otg_whitelist.h"
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->dev.sem, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock
);
44 /* workqueue to process hub events */
45 static struct workqueue_struct
*hub_wq
;
46 static void hub_event(struct work_struct
*work
);
48 /* synchronize hub-port add/remove and peering operations */
49 DEFINE_MUTEX(usb_port_peer_mutex
);
51 /* cycle leds on hubs that aren't blinking for attention */
52 static bool blinkenlights
;
53 module_param(blinkenlights
, bool, S_IRUGO
);
54 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
57 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
58 * 10 seconds to send reply for the initial 64-byte descriptor request.
60 /* define initial 64-byte descriptor request timeout in milliseconds */
61 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
62 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
63 MODULE_PARM_DESC(initial_descriptor_timeout
,
64 "initial 64-byte descriptor request timeout in milliseconds "
65 "(default 5000 - 5.0 seconds)");
68 * As of 2.6.10 we introduce a new USB device initialization scheme which
69 * closely resembles the way Windows works. Hopefully it will be compatible
70 * with a wider range of devices than the old scheme. However some previously
71 * working devices may start giving rise to "device not accepting address"
72 * errors; if that happens the user can try the old scheme by adjusting the
73 * following module parameters.
75 * For maximum flexibility there are two boolean parameters to control the
76 * hub driver's behavior. On the first initialization attempt, if the
77 * "old_scheme_first" parameter is set then the old scheme will be used,
78 * otherwise the new scheme is used. If that fails and "use_both_schemes"
79 * is set, then the driver will make another attempt, using the other scheme.
81 static bool old_scheme_first
;
82 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
83 MODULE_PARM_DESC(old_scheme_first
,
84 "start with the old device initialization scheme");
86 static bool use_both_schemes
= 1;
87 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
88 MODULE_PARM_DESC(use_both_schemes
,
89 "try the other device initialization scheme if the "
92 /* Mutual exclusion for EHCI CF initialization. This interferes with
93 * port reset on some companion controllers.
95 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
96 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
98 #define HUB_DEBOUNCE_TIMEOUT 2000
99 #define HUB_DEBOUNCE_STEP 25
100 #define HUB_DEBOUNCE_STABLE 100
102 static void hub_release(struct kref
*kref
);
103 static int usb_reset_and_verify_device(struct usb_device
*udev
);
105 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
107 if (hub_is_superspeedplus(hub
->hdev
))
109 if (hub_is_superspeed(hub
->hdev
))
111 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
113 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
119 /* Note that hdev or one of its children must be locked! */
120 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
122 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
124 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
127 int usb_device_supports_lpm(struct usb_device
*udev
)
129 /* Some devices have trouble with LPM */
130 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
133 /* USB 2.1 (and greater) devices indicate LPM support through
134 * their USB 2.0 Extended Capabilities BOS descriptor.
136 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
137 if (udev
->bos
->ext_cap
&&
139 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
145 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
146 * However, there are some that don't, and they set the U1/U2 exit
149 if (!udev
->bos
->ss_cap
) {
150 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
154 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
155 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
157 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
159 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
163 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
169 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
172 static void usb_set_lpm_mel(struct usb_device
*udev
,
173 struct usb3_lpm_parameters
*udev_lpm_params
,
174 unsigned int udev_exit_latency
,
176 struct usb3_lpm_parameters
*hub_lpm_params
,
177 unsigned int hub_exit_latency
)
179 unsigned int total_mel
;
180 unsigned int device_mel
;
181 unsigned int hub_mel
;
184 * Calculate the time it takes to transition all links from the roothub
185 * to the parent hub into U0. The parent hub must then decode the
186 * packet (hub header decode latency) to figure out which port it was
189 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
190 * means 0.1us). Multiply that by 100 to get nanoseconds.
192 total_mel
= hub_lpm_params
->mel
+
193 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
196 * How long will it take to transition the downstream hub's port into
197 * U0? The greater of either the hub exit latency or the device exit
200 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
201 * Multiply that by 1000 to get nanoseconds.
203 device_mel
= udev_exit_latency
* 1000;
204 hub_mel
= hub_exit_latency
* 1000;
205 if (device_mel
> hub_mel
)
206 total_mel
+= device_mel
;
208 total_mel
+= hub_mel
;
210 udev_lpm_params
->mel
= total_mel
;
214 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
215 * a transition from either U1 or U2.
217 static void usb_set_lpm_pel(struct usb_device
*udev
,
218 struct usb3_lpm_parameters
*udev_lpm_params
,
219 unsigned int udev_exit_latency
,
221 struct usb3_lpm_parameters
*hub_lpm_params
,
222 unsigned int hub_exit_latency
,
223 unsigned int port_to_port_exit_latency
)
225 unsigned int first_link_pel
;
226 unsigned int hub_pel
;
229 * First, the device sends an LFPS to transition the link between the
230 * device and the parent hub into U0. The exit latency is the bigger of
231 * the device exit latency or the hub exit latency.
233 if (udev_exit_latency
> hub_exit_latency
)
234 first_link_pel
= udev_exit_latency
* 1000;
236 first_link_pel
= hub_exit_latency
* 1000;
239 * When the hub starts to receive the LFPS, there is a slight delay for
240 * it to figure out that one of the ports is sending an LFPS. Then it
241 * will forward the LFPS to its upstream link. The exit latency is the
242 * delay, plus the PEL that we calculated for this hub.
244 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
247 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
248 * is the greater of the two exit latencies.
250 if (first_link_pel
> hub_pel
)
251 udev_lpm_params
->pel
= first_link_pel
;
253 udev_lpm_params
->pel
= hub_pel
;
257 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
258 * when a device initiates a transition to U0, until when it will receive the
259 * first packet from the host controller.
261 * Section C.1.5.1 describes the four components to this:
263 * - t2: time for the ERDY to make it from the device to the host.
264 * - t3: a host-specific delay to process the ERDY.
265 * - t4: time for the packet to make it from the host to the device.
267 * t3 is specific to both the xHCI host and the platform the host is integrated
268 * into. The Intel HW folks have said it's negligible, FIXME if a different
269 * vendor says otherwise.
271 static void usb_set_lpm_sel(struct usb_device
*udev
,
272 struct usb3_lpm_parameters
*udev_lpm_params
)
274 struct usb_device
*parent
;
275 unsigned int num_hubs
;
276 unsigned int total_sel
;
278 /* t1 = device PEL */
279 total_sel
= udev_lpm_params
->pel
;
280 /* How many external hubs are in between the device & the root port. */
281 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
282 parent
= parent
->parent
)
284 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
286 total_sel
+= 2100 + 250 * (num_hubs
- 1);
288 /* t4 = 250ns * num_hubs */
289 total_sel
+= 250 * num_hubs
;
291 udev_lpm_params
->sel
= total_sel
;
294 static void usb_set_lpm_parameters(struct usb_device
*udev
)
297 unsigned int port_to_port_delay
;
298 unsigned int udev_u1_del
;
299 unsigned int udev_u2_del
;
300 unsigned int hub_u1_del
;
301 unsigned int hub_u2_del
;
303 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
306 hub
= usb_hub_to_struct_hub(udev
->parent
);
307 /* It doesn't take time to transition the roothub into U0, since it
308 * doesn't have an upstream link.
313 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
314 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
315 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
316 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
318 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
319 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
321 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
322 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
325 * Appendix C, section C.2.2.2, says that there is a slight delay from
326 * when the parent hub notices the downstream port is trying to
327 * transition to U0 to when the hub initiates a U0 transition on its
328 * upstream port. The section says the delays are tPort2PortU1EL and
329 * tPort2PortU2EL, but it doesn't define what they are.
331 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
332 * about the same delays. Use the maximum delay calculations from those
333 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
334 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
335 * assume the device exit latencies they are talking about are the hub
338 * What do we do if the U2 exit latency is less than the U1 exit
339 * latency? It's possible, although not likely...
341 port_to_port_delay
= 1;
343 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
344 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
347 if (hub_u2_del
> hub_u1_del
)
348 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
350 port_to_port_delay
= 1 + hub_u1_del
;
352 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
353 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
356 /* Now that we've got PEL, calculate SEL. */
357 usb_set_lpm_sel(udev
, &udev
->u1_params
);
358 usb_set_lpm_sel(udev
, &udev
->u2_params
);
361 /* USB 2.0 spec Section 11.24.4.5 */
362 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
367 if (hub_is_superspeed(hdev
)) {
368 dtype
= USB_DT_SS_HUB
;
369 size
= USB_DT_SS_HUB_SIZE
;
372 size
= sizeof(struct usb_hub_descriptor
);
375 for (i
= 0; i
< 3; i
++) {
376 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
377 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
378 dtype
<< 8, 0, data
, size
,
379 USB_CTRL_GET_TIMEOUT
);
380 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
387 * USB 2.0 spec Section 11.24.2.1
389 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
391 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
392 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
396 * USB 2.0 spec Section 11.24.2.2
398 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
400 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
401 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
406 * USB 2.0 spec Section 11.24.2.13
408 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
410 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
411 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
415 static char *to_led_name(int selector
)
432 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
433 * for info about using port indicators
435 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
437 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
440 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
441 USB_PORT_FEAT_INDICATOR
);
442 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
443 to_led_name(selector
), status
);
446 #define LED_CYCLE_PERIOD ((2*HZ)/3)
448 static void led_work(struct work_struct
*work
)
450 struct usb_hub
*hub
=
451 container_of(work
, struct usb_hub
, leds
.work
);
452 struct usb_device
*hdev
= hub
->hdev
;
454 unsigned changed
= 0;
457 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
460 for (i
= 0; i
< hdev
->maxchild
; i
++) {
461 unsigned selector
, mode
;
463 /* 30%-50% duty cycle */
465 switch (hub
->indicator
[i
]) {
467 case INDICATOR_CYCLE
:
469 selector
= HUB_LED_AUTO
;
470 mode
= INDICATOR_AUTO
;
472 /* blinking green = sw attention */
473 case INDICATOR_GREEN_BLINK
:
474 selector
= HUB_LED_GREEN
;
475 mode
= INDICATOR_GREEN_BLINK_OFF
;
477 case INDICATOR_GREEN_BLINK_OFF
:
478 selector
= HUB_LED_OFF
;
479 mode
= INDICATOR_GREEN_BLINK
;
481 /* blinking amber = hw attention */
482 case INDICATOR_AMBER_BLINK
:
483 selector
= HUB_LED_AMBER
;
484 mode
= INDICATOR_AMBER_BLINK_OFF
;
486 case INDICATOR_AMBER_BLINK_OFF
:
487 selector
= HUB_LED_OFF
;
488 mode
= INDICATOR_AMBER_BLINK
;
490 /* blink green/amber = reserved */
491 case INDICATOR_ALT_BLINK
:
492 selector
= HUB_LED_GREEN
;
493 mode
= INDICATOR_ALT_BLINK_OFF
;
495 case INDICATOR_ALT_BLINK_OFF
:
496 selector
= HUB_LED_AMBER
;
497 mode
= INDICATOR_ALT_BLINK
;
502 if (selector
!= HUB_LED_AUTO
)
504 set_port_led(hub
, i
+ 1, selector
);
505 hub
->indicator
[i
] = mode
;
507 if (!changed
&& blinkenlights
) {
509 cursor
%= hdev
->maxchild
;
510 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
511 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
515 queue_delayed_work(system_power_efficient_wq
,
516 &hub
->leds
, LED_CYCLE_PERIOD
);
519 /* use a short timeout for hub/port status fetches */
520 #define USB_STS_TIMEOUT 1000
521 #define USB_STS_RETRIES 5
524 * USB 2.0 spec Section 11.24.2.6
526 static int get_hub_status(struct usb_device
*hdev
,
527 struct usb_hub_status
*data
)
529 int i
, status
= -ETIMEDOUT
;
531 for (i
= 0; i
< USB_STS_RETRIES
&&
532 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
533 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
534 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
535 data
, sizeof(*data
), USB_STS_TIMEOUT
);
541 * USB 2.0 spec Section 11.24.2.7
542 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
544 static int get_port_status(struct usb_device
*hdev
, int port1
,
545 void *data
, u16 value
, u16 length
)
547 int i
, status
= -ETIMEDOUT
;
549 for (i
= 0; i
< USB_STS_RETRIES
&&
550 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
551 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
552 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
553 port1
, data
, length
, USB_STS_TIMEOUT
);
558 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
559 u16
*status
, u16
*change
, u32
*ext_status
)
564 if (type
!= HUB_PORT_STATUS
)
567 mutex_lock(&hub
->status_mutex
);
568 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
571 dev_err(hub
->intfdev
,
572 "%s failed (err = %d)\n", __func__
, ret
);
576 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
577 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
578 if (type
!= HUB_PORT_STATUS
&& ext_status
)
579 *ext_status
= le32_to_cpu(
580 hub
->status
->port
.dwExtPortStatus
);
583 mutex_unlock(&hub
->status_mutex
);
587 static int hub_port_status(struct usb_hub
*hub
, int port1
,
588 u16
*status
, u16
*change
)
590 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
591 status
, change
, NULL
);
594 static void kick_hub_wq(struct usb_hub
*hub
)
596 struct usb_interface
*intf
;
598 if (hub
->disconnected
|| work_pending(&hub
->events
))
602 * Suppress autosuspend until the event is proceed.
604 * Be careful and make sure that the symmetric operation is
605 * always called. We are here only when there is no pending
606 * work for this hub. Therefore put the interface either when
607 * the new work is called or when it is canceled.
609 intf
= to_usb_interface(hub
->intfdev
);
610 usb_autopm_get_interface_no_resume(intf
);
611 kref_get(&hub
->kref
);
613 if (queue_work(hub_wq
, &hub
->events
))
616 /* the work has already been scheduled */
617 usb_autopm_put_interface_async(intf
);
618 kref_put(&hub
->kref
, hub_release
);
621 void usb_kick_hub_wq(struct usb_device
*hdev
)
623 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
630 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
631 * Notification, which indicates it had initiated remote wakeup.
633 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
634 * device initiates resume, so the USB core will not receive notice of the
635 * resume through the normal hub interrupt URB.
637 void usb_wakeup_notification(struct usb_device
*hdev
,
638 unsigned int portnum
)
645 hub
= usb_hub_to_struct_hub(hdev
);
647 set_bit(portnum
, hub
->wakeup_bits
);
651 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
653 /* completion function, fires on port status changes and various faults */
654 static void hub_irq(struct urb
*urb
)
656 struct usb_hub
*hub
= urb
->context
;
657 int status
= urb
->status
;
662 case -ENOENT
: /* synchronous unlink */
663 case -ECONNRESET
: /* async unlink */
664 case -ESHUTDOWN
: /* hardware going away */
667 default: /* presumably an error */
668 /* Cause a hub reset after 10 consecutive errors */
669 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
670 if ((++hub
->nerrors
< 10) || hub
->error
)
675 /* let hub_wq handle things */
676 case 0: /* we got data: port status changed */
678 for (i
= 0; i
< urb
->actual_length
; ++i
)
679 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
681 hub
->event_bits
[0] = bits
;
687 /* Something happened, let hub_wq figure it out */
694 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
695 if (status
!= 0 && status
!= -ENODEV
&& status
!= -EPERM
)
696 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
699 /* USB 2.0 spec Section 11.24.2.3 */
701 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
703 /* Need to clear both directions for control ep */
704 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
705 USB_ENDPOINT_XFER_CONTROL
) {
706 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
707 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
708 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
712 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
713 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
718 * enumeration blocks hub_wq for a long time. we use keventd instead, since
719 * long blocking there is the exception, not the rule. accordingly, HCDs
720 * talking to TTs must queue control transfers (not just bulk and iso), so
721 * both can talk to the same hub concurrently.
723 static void hub_tt_work(struct work_struct
*work
)
725 struct usb_hub
*hub
=
726 container_of(work
, struct usb_hub
, tt
.clear_work
);
729 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
730 while (!list_empty(&hub
->tt
.clear_list
)) {
731 struct list_head
*next
;
732 struct usb_tt_clear
*clear
;
733 struct usb_device
*hdev
= hub
->hdev
;
734 const struct hc_driver
*drv
;
737 next
= hub
->tt
.clear_list
.next
;
738 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
739 list_del(&clear
->clear_list
);
741 /* drop lock so HCD can concurrently report other TT errors */
742 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
743 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
744 if (status
&& status
!= -ENODEV
)
746 "clear tt %d (%04x) error %d\n",
747 clear
->tt
, clear
->devinfo
, status
);
749 /* Tell the HCD, even if the operation failed */
750 drv
= clear
->hcd
->driver
;
751 if (drv
->clear_tt_buffer_complete
)
752 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
755 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
757 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
761 * usb_hub_set_port_power - control hub port's power state
762 * @hdev: USB device belonging to the usb hub
765 * @set: expected status
767 * call this function to control port's power via setting or
768 * clearing the port's PORT_POWER feature.
770 * Return: 0 if successful. A negative error code otherwise.
772 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
778 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
780 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
786 set_bit(port1
, hub
->power_bits
);
788 clear_bit(port1
, hub
->power_bits
);
793 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
794 * @urb: an URB associated with the failed or incomplete split transaction
796 * High speed HCDs use this to tell the hub driver that some split control or
797 * bulk transaction failed in a way that requires clearing internal state of
798 * a transaction translator. This is normally detected (and reported) from
801 * It may not be possible for that hub to handle additional full (or low)
802 * speed transactions until that state is fully cleared out.
804 * Return: 0 if successful. A negative error code otherwise.
806 int usb_hub_clear_tt_buffer(struct urb
*urb
)
808 struct usb_device
*udev
= urb
->dev
;
809 int pipe
= urb
->pipe
;
810 struct usb_tt
*tt
= udev
->tt
;
812 struct usb_tt_clear
*clear
;
814 /* we've got to cope with an arbitrary number of pending TT clears,
815 * since each TT has "at least two" buffers that can need it (and
816 * there can be many TTs per hub). even if they're uncommon.
818 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
820 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
821 /* FIXME recover somehow ... RESET_TT? */
825 /* info that CLEAR_TT_BUFFER needs */
826 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
827 clear
->devinfo
= usb_pipeendpoint (pipe
);
828 clear
->devinfo
|= udev
->devnum
<< 4;
829 clear
->devinfo
|= usb_pipecontrol(pipe
)
830 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
831 : (USB_ENDPOINT_XFER_BULK
<< 11);
832 if (usb_pipein(pipe
))
833 clear
->devinfo
|= 1 << 15;
835 /* info for completion callback */
836 clear
->hcd
= bus_to_hcd(udev
->bus
);
839 /* tell keventd to clear state for this TT */
840 spin_lock_irqsave(&tt
->lock
, flags
);
841 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
842 schedule_work(&tt
->clear_work
);
843 spin_unlock_irqrestore(&tt
->lock
, flags
);
846 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
848 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
852 /* Enable power on each port. Some hubs have reserved values
853 * of LPSM (> 2) in their descriptors, even though they are
854 * USB 2.0 hubs. Some hubs do not implement port-power switching
855 * but only emulate it. In all cases, the ports won't work
856 * unless we send these messages to the hub.
858 if (hub_is_port_power_switchable(hub
))
859 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
861 dev_dbg(hub
->intfdev
, "trying to enable port power on "
862 "non-switchable hub\n");
863 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
864 if (test_bit(port1
, hub
->power_bits
))
865 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
867 usb_clear_port_feature(hub
->hdev
, port1
,
868 USB_PORT_FEAT_POWER
);
870 msleep(hub_power_on_good_delay(hub
));
873 static int hub_hub_status(struct usb_hub
*hub
,
874 u16
*status
, u16
*change
)
878 mutex_lock(&hub
->status_mutex
);
879 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
882 dev_err(hub
->intfdev
,
883 "%s failed (err = %d)\n", __func__
, ret
);
885 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
886 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
889 mutex_unlock(&hub
->status_mutex
);
893 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
894 unsigned int link_status
)
896 return set_port_feature(hub
->hdev
,
897 port1
| (link_status
<< 3),
898 USB_PORT_FEAT_LINK_STATE
);
902 * If USB 3.0 ports are placed into the Disabled state, they will no longer
903 * detect any device connects or disconnects. This is generally not what the
904 * USB core wants, since it expects a disabled port to produce a port status
905 * change event when a new device connects.
907 * Instead, set the link state to Disabled, wait for the link to settle into
908 * that state, clear any change bits, and then put the port into the RxDetect
911 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
915 u16 portchange
, portstatus
;
917 if (!hub_is_superspeed(hub
->hdev
))
920 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
925 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
926 * Controller [1022:7814] will have spurious result making the following
927 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
928 * as high-speed device if we set the usb 3.0 port link state to
929 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
930 * check the state here to avoid the bug.
932 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
933 USB_SS_PORT_LS_RX_DETECT
) {
934 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
935 "Not disabling port; link state is RxDetect\n");
939 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
943 /* Wait for the link to enter the disabled state. */
944 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
945 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
949 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
950 USB_SS_PORT_LS_SS_DISABLED
)
952 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
954 msleep(HUB_DEBOUNCE_STEP
);
956 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
957 dev_warn(&hub
->ports
[port1
- 1]->dev
,
958 "Could not disable after %d ms\n", total_time
);
960 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
963 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
965 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
966 struct usb_device
*hdev
= hub
->hdev
;
969 if (port_dev
->child
&& set_state
)
970 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
972 if (hub_is_superspeed(hub
->hdev
))
973 ret
= hub_usb3_port_disable(hub
, port1
);
975 ret
= usb_clear_port_feature(hdev
, port1
,
976 USB_PORT_FEAT_ENABLE
);
978 if (ret
&& ret
!= -ENODEV
)
979 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
984 * Disable a port and mark a logical connect-change event, so that some
985 * time later hub_wq will disconnect() any existing usb_device on the port
986 * and will re-enumerate if there actually is a device attached.
988 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
990 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
991 hub_port_disable(hub
, port1
, 1);
993 /* FIXME let caller ask to power down the port:
994 * - some devices won't enumerate without a VBUS power cycle
995 * - SRP saves power that way
996 * - ... new call, TBD ...
997 * That's easy if this hub can switch power per-port, and
998 * hub_wq reactivates the port later (timer, SRP, etc).
999 * Powerdown must be optional, because of reset/DFU.
1002 set_bit(port1
, hub
->change_bits
);
1007 * usb_remove_device - disable a device's port on its parent hub
1008 * @udev: device to be disabled and removed
1009 * Context: @udev locked, must be able to sleep.
1011 * After @udev's port has been disabled, hub_wq is notified and it will
1012 * see that the device has been disconnected. When the device is
1013 * physically unplugged and something is plugged in, the events will
1014 * be received and processed normally.
1016 * Return: 0 if successful. A negative error code otherwise.
1018 int usb_remove_device(struct usb_device
*udev
)
1020 struct usb_hub
*hub
;
1021 struct usb_interface
*intf
;
1023 if (!udev
->parent
) /* Can't remove a root hub */
1025 hub
= usb_hub_to_struct_hub(udev
->parent
);
1026 intf
= to_usb_interface(hub
->intfdev
);
1028 usb_autopm_get_interface(intf
);
1029 set_bit(udev
->portnum
, hub
->removed_bits
);
1030 hub_port_logical_disconnect(hub
, udev
->portnum
);
1031 usb_autopm_put_interface(intf
);
1035 enum hub_activation_type
{
1036 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1037 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1040 static void hub_init_func2(struct work_struct
*ws
);
1041 static void hub_init_func3(struct work_struct
*ws
);
1043 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1045 struct usb_device
*hdev
= hub
->hdev
;
1046 struct usb_hcd
*hcd
;
1050 bool need_debounce_delay
= false;
1053 /* Continue a partial initialization */
1054 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1055 device_lock(&hdev
->dev
);
1057 /* Was the hub disconnected while we were waiting? */
1058 if (hub
->disconnected
)
1060 if (type
== HUB_INIT2
)
1064 kref_get(&hub
->kref
);
1066 /* The superspeed hub except for root hub has to use Hub Depth
1067 * value as an offset into the route string to locate the bits
1068 * it uses to determine the downstream port number. So hub driver
1069 * should send a set hub depth request to superspeed hub after
1070 * the superspeed hub is set configuration in initialization or
1073 * After a resume, port power should still be on.
1074 * For any other type of activation, turn it on.
1076 if (type
!= HUB_RESUME
) {
1077 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1078 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1079 HUB_SET_DEPTH
, USB_RT_HUB
,
1080 hdev
->level
- 1, 0, NULL
, 0,
1081 USB_CTRL_SET_TIMEOUT
);
1083 dev_err(hub
->intfdev
,
1084 "set hub depth failed\n");
1087 /* Speed up system boot by using a delayed_work for the
1088 * hub's initial power-up delays. This is pretty awkward
1089 * and the implementation looks like a home-brewed sort of
1090 * setjmp/longjmp, but it saves at least 100 ms for each
1091 * root hub (assuming usbcore is compiled into the kernel
1092 * rather than as a module). It adds up.
1094 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1095 * because for those activation types the ports have to be
1096 * operational when we return. In theory this could be done
1097 * for HUB_POST_RESET, but it's easier not to.
1099 if (type
== HUB_INIT
) {
1100 delay
= hub_power_on_good_delay(hub
);
1102 hub_power_on(hub
, false);
1103 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1104 queue_delayed_work(system_power_efficient_wq
,
1106 msecs_to_jiffies(delay
));
1108 /* Suppress autosuspend until init is done */
1109 usb_autopm_get_interface_no_resume(
1110 to_usb_interface(hub
->intfdev
));
1111 return; /* Continues at init2: below */
1112 } else if (type
== HUB_RESET_RESUME
) {
1113 /* The internal host controller state for the hub device
1114 * may be gone after a host power loss on system resume.
1115 * Update the device's info so the HW knows it's a hub.
1117 hcd
= bus_to_hcd(hdev
->bus
);
1118 if (hcd
->driver
->update_hub_device
) {
1119 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1120 &hub
->tt
, GFP_NOIO
);
1122 dev_err(hub
->intfdev
, "Host not "
1123 "accepting hub info "
1125 dev_err(hub
->intfdev
, "LS/FS devices "
1126 "and hubs may not work "
1127 "under this hub\n.");
1130 hub_power_on(hub
, true);
1132 hub_power_on(hub
, true);
1138 * Check each port and set hub->change_bits to let hub_wq know
1139 * which ports need attention.
1141 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1142 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1143 struct usb_device
*udev
= port_dev
->child
;
1144 u16 portstatus
, portchange
;
1146 portstatus
= portchange
= 0;
1147 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1148 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1149 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1150 portstatus
, portchange
);
1153 * After anything other than HUB_RESUME (i.e., initialization
1154 * or any sort of reset), every port should be disabled.
1155 * Unconnected ports should likewise be disabled (paranoia),
1156 * and so should ports for which we have no usb_device.
1158 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1159 type
!= HUB_RESUME
||
1160 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1162 udev
->state
== USB_STATE_NOTATTACHED
)) {
1164 * USB3 protocol ports will automatically transition
1165 * to Enabled state when detect an USB3.0 device attach.
1166 * Do not disable USB3 protocol ports, just pretend
1169 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1170 if (!hub_is_superspeed(hdev
))
1171 usb_clear_port_feature(hdev
, port1
,
1172 USB_PORT_FEAT_ENABLE
);
1175 /* Clear status-change flags; we'll debounce later */
1176 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1177 need_debounce_delay
= true;
1178 usb_clear_port_feature(hub
->hdev
, port1
,
1179 USB_PORT_FEAT_C_CONNECTION
);
1181 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1182 need_debounce_delay
= true;
1183 usb_clear_port_feature(hub
->hdev
, port1
,
1184 USB_PORT_FEAT_C_ENABLE
);
1186 if (portchange
& USB_PORT_STAT_C_RESET
) {
1187 need_debounce_delay
= true;
1188 usb_clear_port_feature(hub
->hdev
, port1
,
1189 USB_PORT_FEAT_C_RESET
);
1191 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1192 hub_is_superspeed(hub
->hdev
)) {
1193 need_debounce_delay
= true;
1194 usb_clear_port_feature(hub
->hdev
, port1
,
1195 USB_PORT_FEAT_C_BH_PORT_RESET
);
1197 /* We can forget about a "removed" device when there's a
1198 * physical disconnect or the connect status changes.
1200 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1201 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1202 clear_bit(port1
, hub
->removed_bits
);
1204 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1205 /* Tell hub_wq to disconnect the device or
1206 * check for a new connection
1208 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1209 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1210 set_bit(port1
, hub
->change_bits
);
1212 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1213 bool port_resumed
= (portstatus
&
1214 USB_PORT_STAT_LINK_STATE
) ==
1216 /* The power session apparently survived the resume.
1217 * If there was an overcurrent or suspend change
1218 * (i.e., remote wakeup request), have hub_wq
1219 * take care of it. Look at the port link state
1220 * for USB 3.0 hubs, since they don't have a suspend
1221 * change bit, and they don't set the port link change
1222 * bit on device-initiated resume.
1224 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1226 set_bit(port1
, hub
->change_bits
);
1228 } else if (udev
->persist_enabled
) {
1230 udev
->reset_resume
= 1;
1232 /* Don't set the change_bits when the device
1235 if (test_bit(port1
, hub
->power_bits
))
1236 set_bit(port1
, hub
->change_bits
);
1239 /* The power session is gone; tell hub_wq */
1240 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1241 set_bit(port1
, hub
->change_bits
);
1245 /* If no port-status-change flags were set, we don't need any
1246 * debouncing. If flags were set we can try to debounce the
1247 * ports all at once right now, instead of letting hub_wq do them
1248 * one at a time later on.
1250 * If any port-status changes do occur during this delay, hub_wq
1251 * will see them later and handle them normally.
1253 if (need_debounce_delay
) {
1254 delay
= HUB_DEBOUNCE_STABLE
;
1256 /* Don't do a long sleep inside a workqueue routine */
1257 if (type
== HUB_INIT2
) {
1258 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1259 queue_delayed_work(system_power_efficient_wq
,
1261 msecs_to_jiffies(delay
));
1262 device_unlock(&hdev
->dev
);
1263 return; /* Continues at init3: below */
1271 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1273 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1274 if (hub
->has_indicators
&& blinkenlights
)
1275 queue_delayed_work(system_power_efficient_wq
,
1276 &hub
->leds
, LED_CYCLE_PERIOD
);
1278 /* Scan all ports that need attention */
1281 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1282 /* Allow autosuspend if it was suppressed */
1284 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1285 device_unlock(&hdev
->dev
);
1288 kref_put(&hub
->kref
, hub_release
);
1291 /* Implement the continuations for the delays above */
1292 static void hub_init_func2(struct work_struct
*ws
)
1294 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1296 hub_activate(hub
, HUB_INIT2
);
1299 static void hub_init_func3(struct work_struct
*ws
)
1301 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1303 hub_activate(hub
, HUB_INIT3
);
1306 enum hub_quiescing_type
{
1307 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1310 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1312 struct usb_device
*hdev
= hub
->hdev
;
1315 /* hub_wq and related activity won't re-trigger */
1318 if (type
!= HUB_SUSPEND
) {
1319 /* Disconnect all the children */
1320 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1321 if (hub
->ports
[i
]->child
)
1322 usb_disconnect(&hub
->ports
[i
]->child
);
1326 /* Stop hub_wq and related activity */
1327 usb_kill_urb(hub
->urb
);
1328 if (hub
->has_indicators
)
1329 cancel_delayed_work_sync(&hub
->leds
);
1331 flush_work(&hub
->tt
.clear_work
);
1334 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1338 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1339 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1342 /* caller has locked the hub device */
1343 static int hub_pre_reset(struct usb_interface
*intf
)
1345 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1347 hub_quiesce(hub
, HUB_PRE_RESET
);
1349 hub_pm_barrier_for_all_ports(hub
);
1353 /* caller has locked the hub device */
1354 static int hub_post_reset(struct usb_interface
*intf
)
1356 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1359 hub_pm_barrier_for_all_ports(hub
);
1360 hub_activate(hub
, HUB_POST_RESET
);
1364 static int hub_configure(struct usb_hub
*hub
,
1365 struct usb_endpoint_descriptor
*endpoint
)
1367 struct usb_hcd
*hcd
;
1368 struct usb_device
*hdev
= hub
->hdev
;
1369 struct device
*hub_dev
= hub
->intfdev
;
1370 u16 hubstatus
, hubchange
;
1371 u16 wHubCharacteristics
;
1374 char *message
= "out of memory";
1379 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1385 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1390 mutex_init(&hub
->status_mutex
);
1392 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1393 if (!hub
->descriptor
) {
1398 /* Request the entire hub descriptor.
1399 * hub->descriptor can handle USB_MAXCHILDREN ports,
1400 * but the hub can/will return fewer bytes here.
1402 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1404 message
= "can't read hub descriptor";
1406 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1407 message
= "hub has too many ports!";
1410 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1411 message
= "hub doesn't have any ports!";
1416 maxchild
= hub
->descriptor
->bNbrPorts
;
1417 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1418 (maxchild
== 1) ? "" : "s");
1420 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1426 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1427 if (hub_is_superspeed(hdev
)) {
1435 /* FIXME for USB 3.0, skip for now */
1436 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1437 !(hub_is_superspeed(hdev
))) {
1438 char portstr
[USB_MAXCHILDREN
+ 1];
1440 for (i
= 0; i
< maxchild
; i
++)
1441 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1442 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1444 portstr
[maxchild
] = 0;
1445 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1447 dev_dbg(hub_dev
, "standalone hub\n");
1449 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1450 case HUB_CHAR_COMMON_LPSM
:
1451 dev_dbg(hub_dev
, "ganged power switching\n");
1453 case HUB_CHAR_INDV_PORT_LPSM
:
1454 dev_dbg(hub_dev
, "individual port power switching\n");
1456 case HUB_CHAR_NO_LPSM
:
1458 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1462 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1463 case HUB_CHAR_COMMON_OCPM
:
1464 dev_dbg(hub_dev
, "global over-current protection\n");
1466 case HUB_CHAR_INDV_PORT_OCPM
:
1467 dev_dbg(hub_dev
, "individual port over-current protection\n");
1469 case HUB_CHAR_NO_OCPM
:
1471 dev_dbg(hub_dev
, "no over-current protection\n");
1475 spin_lock_init(&hub
->tt
.lock
);
1476 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1477 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1478 switch (hdev
->descriptor
.bDeviceProtocol
) {
1481 case USB_HUB_PR_HS_SINGLE_TT
:
1482 dev_dbg(hub_dev
, "Single TT\n");
1485 case USB_HUB_PR_HS_MULTI_TT
:
1486 ret
= usb_set_interface(hdev
, 0, 1);
1488 dev_dbg(hub_dev
, "TT per port\n");
1491 dev_err(hub_dev
, "Using single TT (err %d)\n",
1496 /* USB 3.0 hubs don't have a TT */
1499 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1500 hdev
->descriptor
.bDeviceProtocol
);
1504 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1505 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1506 case HUB_TTTT_8_BITS
:
1507 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1508 hub
->tt
.think_time
= 666;
1509 dev_dbg(hub_dev
, "TT requires at most %d "
1510 "FS bit times (%d ns)\n",
1511 8, hub
->tt
.think_time
);
1514 case HUB_TTTT_16_BITS
:
1515 hub
->tt
.think_time
= 666 * 2;
1516 dev_dbg(hub_dev
, "TT requires at most %d "
1517 "FS bit times (%d ns)\n",
1518 16, hub
->tt
.think_time
);
1520 case HUB_TTTT_24_BITS
:
1521 hub
->tt
.think_time
= 666 * 3;
1522 dev_dbg(hub_dev
, "TT requires at most %d "
1523 "FS bit times (%d ns)\n",
1524 24, hub
->tt
.think_time
);
1526 case HUB_TTTT_32_BITS
:
1527 hub
->tt
.think_time
= 666 * 4;
1528 dev_dbg(hub_dev
, "TT requires at most %d "
1529 "FS bit times (%d ns)\n",
1530 32, hub
->tt
.think_time
);
1534 /* probe() zeroes hub->indicator[] */
1535 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1536 hub
->has_indicators
= 1;
1537 dev_dbg(hub_dev
, "Port indicators are supported\n");
1540 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1541 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1543 /* power budgeting mostly matters with bus-powered hubs,
1544 * and battery-powered root hubs (may provide just 8 mA).
1546 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1548 message
= "can't get hub status";
1551 hcd
= bus_to_hcd(hdev
->bus
);
1552 if (hdev
== hdev
->bus
->root_hub
) {
1553 if (hcd
->power_budget
> 0)
1554 hdev
->bus_mA
= hcd
->power_budget
;
1556 hdev
->bus_mA
= full_load
* maxchild
;
1557 if (hdev
->bus_mA
>= full_load
)
1558 hub
->mA_per_port
= full_load
;
1560 hub
->mA_per_port
= hdev
->bus_mA
;
1561 hub
->limited_power
= 1;
1563 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1564 int remaining
= hdev
->bus_mA
-
1565 hub
->descriptor
->bHubContrCurrent
;
1567 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1568 hub
->descriptor
->bHubContrCurrent
);
1569 hub
->limited_power
= 1;
1571 if (remaining
< maxchild
* unit_load
)
1573 "insufficient power available "
1574 "to use all downstream ports\n");
1575 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1577 } else { /* Self-powered external hub */
1578 /* FIXME: What about battery-powered external hubs that
1579 * provide less current per port? */
1580 hub
->mA_per_port
= full_load
;
1582 if (hub
->mA_per_port
< full_load
)
1583 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1586 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1588 message
= "can't get hub status";
1592 /* local power status reports aren't always correct */
1593 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1594 dev_dbg(hub_dev
, "local power source is %s\n",
1595 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1596 ? "lost (inactive)" : "good");
1598 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1599 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1600 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1602 /* set up the interrupt endpoint
1603 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1604 * bytes as USB2.0[11.12.3] says because some hubs are known
1605 * to send more data (and thus cause overflow). For root hubs,
1606 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1607 * to be big enough for at least USB_MAXCHILDREN ports. */
1608 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1609 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1611 if (maxp
> sizeof(*hub
->buffer
))
1612 maxp
= sizeof(*hub
->buffer
);
1614 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1620 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1621 hub
, endpoint
->bInterval
);
1623 /* maybe cycle the hub leds */
1624 if (hub
->has_indicators
&& blinkenlights
)
1625 hub
->indicator
[0] = INDICATOR_CYCLE
;
1627 mutex_lock(&usb_port_peer_mutex
);
1628 for (i
= 0; i
< maxchild
; i
++) {
1629 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1631 dev_err(hub
->intfdev
,
1632 "couldn't create port%d device.\n", i
+ 1);
1637 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1638 struct usb_port
*port_dev
= hub
->ports
[i
];
1640 pm_runtime_put(&port_dev
->dev
);
1643 mutex_unlock(&usb_port_peer_mutex
);
1647 /* Update the HCD's internal representation of this hub before hub_wq
1648 * starts getting port status changes for devices under the hub.
1650 if (hcd
->driver
->update_hub_device
) {
1651 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1652 &hub
->tt
, GFP_KERNEL
);
1654 message
= "can't update HCD hub info";
1659 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1661 hub_activate(hub
, HUB_INIT
);
1665 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1667 /* hub_disconnect() frees urb and descriptor */
1671 static void hub_release(struct kref
*kref
)
1673 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1675 usb_put_dev(hub
->hdev
);
1676 usb_put_intf(to_usb_interface(hub
->intfdev
));
1680 static unsigned highspeed_hubs
;
1682 static void hub_disconnect(struct usb_interface
*intf
)
1684 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1685 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1689 * Stop adding new hub events. We do not want to block here and thus
1690 * will not try to remove any pending work item.
1692 hub
->disconnected
= 1;
1694 /* Disconnect all children and quiesce the hub */
1696 hub_quiesce(hub
, HUB_DISCONNECT
);
1698 mutex_lock(&usb_port_peer_mutex
);
1700 /* Avoid races with recursively_mark_NOTATTACHED() */
1701 spin_lock_irq(&device_state_lock
);
1702 port1
= hdev
->maxchild
;
1704 usb_set_intfdata(intf
, NULL
);
1705 spin_unlock_irq(&device_state_lock
);
1707 for (; port1
> 0; --port1
)
1708 usb_hub_remove_port_device(hub
, port1
);
1710 mutex_unlock(&usb_port_peer_mutex
);
1712 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1715 usb_free_urb(hub
->urb
);
1717 kfree(hub
->descriptor
);
1721 pm_suspend_ignore_children(&intf
->dev
, false);
1722 kref_put(&hub
->kref
, hub_release
);
1725 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1727 struct usb_host_interface
*desc
;
1728 struct usb_endpoint_descriptor
*endpoint
;
1729 struct usb_device
*hdev
;
1730 struct usb_hub
*hub
;
1732 desc
= intf
->cur_altsetting
;
1733 hdev
= interface_to_usbdev(intf
);
1736 * Set default autosuspend delay as 0 to speedup bus suspend,
1737 * based on the below considerations:
1739 * - Unlike other drivers, the hub driver does not rely on the
1740 * autosuspend delay to provide enough time to handle a wakeup
1741 * event, and the submitted status URB is just to check future
1742 * change on hub downstream ports, so it is safe to do it.
1744 * - The patch might cause one or more auto supend/resume for
1745 * below very rare devices when they are plugged into hub
1748 * devices having trouble initializing, and disconnect
1749 * themselves from the bus and then reconnect a second
1752 * devices just for downloading firmware, and disconnects
1753 * themselves after completing it
1755 * For these quite rare devices, their drivers may change the
1756 * autosuspend delay of their parent hub in the probe() to one
1757 * appropriate value to avoid the subtle problem if someone
1760 * - The patch may cause one or more auto suspend/resume on
1761 * hub during running 'lsusb', but it is probably too
1762 * infrequent to worry about.
1764 * - Change autosuspend delay of hub can avoid unnecessary auto
1765 * suspend timer for hub, also may decrease power consumption
1768 * - If user has indicated to prevent autosuspend by passing
1769 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1772 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1773 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1777 * Hubs have proper suspend/resume support, except for root hubs
1778 * where the controller driver doesn't have bus_suspend and
1779 * bus_resume methods.
1781 if (hdev
->parent
) { /* normal device */
1782 usb_enable_autosuspend(hdev
);
1783 } else { /* root hub */
1784 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1786 if (drv
->bus_suspend
&& drv
->bus_resume
)
1787 usb_enable_autosuspend(hdev
);
1790 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1792 "Unsupported bus topology: hub nested too deep\n");
1796 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1798 dev_warn(&intf
->dev
, "ignoring external hub\n");
1803 /* Some hubs have a subclass of 1, which AFAICT according to the */
1804 /* specs is not defined, but it works */
1805 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1806 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1808 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1812 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1813 if (desc
->desc
.bNumEndpoints
!= 1)
1814 goto descriptor_error
;
1816 endpoint
= &desc
->endpoint
[0].desc
;
1818 /* If it's not an interrupt in endpoint, we'd better punt! */
1819 if (!usb_endpoint_is_int_in(endpoint
))
1820 goto descriptor_error
;
1822 /* We found a hub */
1823 dev_info(&intf
->dev
, "USB hub found\n");
1825 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1827 dev_dbg(&intf
->dev
, "couldn't kmalloc hub struct\n");
1831 kref_init(&hub
->kref
);
1832 hub
->intfdev
= &intf
->dev
;
1834 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1835 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1836 INIT_WORK(&hub
->events
, hub_event
);
1840 usb_set_intfdata(intf
, hub
);
1841 intf
->needs_remote_wakeup
= 1;
1842 pm_suspend_ignore_children(&intf
->dev
, true);
1844 if (hdev
->speed
== USB_SPEED_HIGH
)
1847 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1848 hub
->quirk_check_port_auto_suspend
= 1;
1850 if (hub_configure(hub
, endpoint
) >= 0)
1853 hub_disconnect(intf
);
1858 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1860 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1861 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1863 /* assert ifno == 0 (part of hub spec) */
1865 case USBDEVFS_HUB_PORTINFO
: {
1866 struct usbdevfs_hub_portinfo
*info
= user_data
;
1869 spin_lock_irq(&device_state_lock
);
1870 if (hdev
->devnum
<= 0)
1873 info
->nports
= hdev
->maxchild
;
1874 for (i
= 0; i
< info
->nports
; i
++) {
1875 if (hub
->ports
[i
]->child
== NULL
)
1879 hub
->ports
[i
]->child
->devnum
;
1882 spin_unlock_irq(&device_state_lock
);
1884 return info
->nports
+ 1;
1893 * Allow user programs to claim ports on a hub. When a device is attached
1894 * to one of these "claimed" ports, the program will "own" the device.
1896 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1897 struct usb_dev_state
***ppowner
)
1899 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1901 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1903 if (port1
== 0 || port1
> hdev
->maxchild
)
1906 /* Devices not managed by the hub driver
1907 * will always have maxchild equal to 0.
1909 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1913 /* In the following three functions, the caller must hold hdev's lock */
1914 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1915 struct usb_dev_state
*owner
)
1918 struct usb_dev_state
**powner
;
1920 rc
= find_port_owner(hdev
, port1
, &powner
);
1928 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1930 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1931 struct usb_dev_state
*owner
)
1934 struct usb_dev_state
**powner
;
1936 rc
= find_port_owner(hdev
, port1
, &powner
);
1939 if (*powner
!= owner
)
1944 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1946 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1948 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1951 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1952 if (hub
->ports
[n
]->port_owner
== owner
)
1953 hub
->ports
[n
]->port_owner
= NULL
;
1958 /* The caller must hold udev's lock */
1959 bool usb_device_is_owned(struct usb_device
*udev
)
1961 struct usb_hub
*hub
;
1963 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1965 hub
= usb_hub_to_struct_hub(udev
->parent
);
1966 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1969 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1971 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1974 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1975 if (hub
->ports
[i
]->child
)
1976 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1978 if (udev
->state
== USB_STATE_SUSPENDED
)
1979 udev
->active_duration
-= jiffies
;
1980 udev
->state
= USB_STATE_NOTATTACHED
;
1984 * usb_set_device_state - change a device's current state (usbcore, hcds)
1985 * @udev: pointer to device whose state should be changed
1986 * @new_state: new state value to be stored
1988 * udev->state is _not_ fully protected by the device lock. Although
1989 * most transitions are made only while holding the lock, the state can
1990 * can change to USB_STATE_NOTATTACHED at almost any time. This
1991 * is so that devices can be marked as disconnected as soon as possible,
1992 * without having to wait for any semaphores to be released. As a result,
1993 * all changes to any device's state must be protected by the
1994 * device_state_lock spinlock.
1996 * Once a device has been added to the device tree, all changes to its state
1997 * should be made using this routine. The state should _not_ be set directly.
1999 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2000 * Otherwise udev->state is set to new_state, and if new_state is
2001 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2002 * to USB_STATE_NOTATTACHED.
2004 void usb_set_device_state(struct usb_device
*udev
,
2005 enum usb_device_state new_state
)
2007 unsigned long flags
;
2010 spin_lock_irqsave(&device_state_lock
, flags
);
2011 if (udev
->state
== USB_STATE_NOTATTACHED
)
2013 else if (new_state
!= USB_STATE_NOTATTACHED
) {
2015 /* root hub wakeup capabilities are managed out-of-band
2016 * and may involve silicon errata ... ignore them here.
2019 if (udev
->state
== USB_STATE_SUSPENDED
2020 || new_state
== USB_STATE_SUSPENDED
)
2021 ; /* No change to wakeup settings */
2022 else if (new_state
== USB_STATE_CONFIGURED
)
2023 wakeup
= (udev
->quirks
&
2024 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
2025 udev
->actconfig
->desc
.bmAttributes
&
2026 USB_CONFIG_ATT_WAKEUP
;
2030 if (udev
->state
== USB_STATE_SUSPENDED
&&
2031 new_state
!= USB_STATE_SUSPENDED
)
2032 udev
->active_duration
-= jiffies
;
2033 else if (new_state
== USB_STATE_SUSPENDED
&&
2034 udev
->state
!= USB_STATE_SUSPENDED
)
2035 udev
->active_duration
+= jiffies
;
2036 udev
->state
= new_state
;
2038 recursively_mark_NOTATTACHED(udev
);
2039 spin_unlock_irqrestore(&device_state_lock
, flags
);
2041 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2043 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2046 * Choose a device number.
2048 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2049 * USB-2.0 buses they are also used as device addresses, however on
2050 * USB-3.0 buses the address is assigned by the controller hardware
2051 * and it usually is not the same as the device number.
2053 * WUSB devices are simple: they have no hubs behind, so the mapping
2054 * device <-> virtual port number becomes 1:1. Why? to simplify the
2055 * life of the device connection logic in
2056 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2057 * handshake we need to assign a temporary address in the unauthorized
2058 * space. For simplicity we use the first virtual port number found to
2059 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2060 * and that becomes it's address [X < 128] or its unauthorized address
2063 * We add 1 as an offset to the one-based USB-stack port number
2064 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2065 * 0 is reserved by USB for default address; (b) Linux's USB stack
2066 * uses always #1 for the root hub of the controller. So USB stack's
2067 * port #1, which is wusb virtual-port #0 has address #2.
2069 * Devices connected under xHCI are not as simple. The host controller
2070 * supports virtualization, so the hardware assigns device addresses and
2071 * the HCD must setup data structures before issuing a set address
2072 * command to the hardware.
2074 static void choose_devnum(struct usb_device
*udev
)
2077 struct usb_bus
*bus
= udev
->bus
;
2079 /* be safe when more hub events are proceed in parallel */
2080 mutex_lock(&bus
->devnum_next_mutex
);
2082 devnum
= udev
->portnum
+ 1;
2083 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2085 /* Try to allocate the next devnum beginning at
2086 * bus->devnum_next. */
2087 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2090 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2092 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2095 set_bit(devnum
, bus
->devmap
.devicemap
);
2096 udev
->devnum
= devnum
;
2098 mutex_unlock(&bus
->devnum_next_mutex
);
2101 static void release_devnum(struct usb_device
*udev
)
2103 if (udev
->devnum
> 0) {
2104 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2109 static void update_devnum(struct usb_device
*udev
, int devnum
)
2111 /* The address for a WUSB device is managed by wusbcore. */
2113 udev
->devnum
= devnum
;
2116 static void hub_free_dev(struct usb_device
*udev
)
2118 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2120 /* Root hubs aren't real devices, so don't free HCD resources */
2121 if (hcd
->driver
->free_dev
&& udev
->parent
)
2122 hcd
->driver
->free_dev(hcd
, udev
);
2125 static void hub_disconnect_children(struct usb_device
*udev
)
2127 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2130 /* Free up all the children before we remove this device */
2131 for (i
= 0; i
< udev
->maxchild
; i
++) {
2132 if (hub
->ports
[i
]->child
)
2133 usb_disconnect(&hub
->ports
[i
]->child
);
2138 * usb_disconnect - disconnect a device (usbcore-internal)
2139 * @pdev: pointer to device being disconnected
2140 * Context: !in_interrupt ()
2142 * Something got disconnected. Get rid of it and all of its children.
2144 * If *pdev is a normal device then the parent hub must already be locked.
2145 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2146 * which protects the set of root hubs as well as the list of buses.
2148 * Only hub drivers (including virtual root hub drivers for host
2149 * controllers) should ever call this.
2151 * This call is synchronous, and may not be used in an interrupt context.
2153 void usb_disconnect(struct usb_device
**pdev
)
2155 struct usb_port
*port_dev
= NULL
;
2156 struct usb_device
*udev
= *pdev
;
2157 struct usb_hub
*hub
= NULL
;
2160 /* mark the device as inactive, so any further urb submissions for
2161 * this device (and any of its children) will fail immediately.
2162 * this quiesces everything except pending urbs.
2164 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2165 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2168 usb_lock_device(udev
);
2170 hub_disconnect_children(udev
);
2172 /* deallocate hcd/hardware state ... nuking all pending urbs and
2173 * cleaning up all state associated with the current configuration
2174 * so that the hardware is now fully quiesced.
2176 dev_dbg(&udev
->dev
, "unregistering device\n");
2177 usb_disable_device(udev
, 0);
2178 usb_hcd_synchronize_unlinks(udev
);
2181 port1
= udev
->portnum
;
2182 hub
= usb_hub_to_struct_hub(udev
->parent
);
2183 port_dev
= hub
->ports
[port1
- 1];
2185 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2186 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2189 * As usb_port_runtime_resume() de-references udev, make
2190 * sure no resumes occur during removal
2192 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2193 pm_runtime_get_sync(&port_dev
->dev
);
2196 usb_remove_ep_devs(&udev
->ep0
);
2197 usb_unlock_device(udev
);
2199 /* Unregister the device. The device driver is responsible
2200 * for de-configuring the device and invoking the remove-device
2201 * notifier chain (used by usbfs and possibly others).
2203 device_del(&udev
->dev
);
2205 /* Free the device number and delete the parent's children[]
2206 * (or root_hub) pointer.
2208 release_devnum(udev
);
2210 /* Avoid races with recursively_mark_NOTATTACHED() */
2211 spin_lock_irq(&device_state_lock
);
2213 spin_unlock_irq(&device_state_lock
);
2215 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2216 pm_runtime_put(&port_dev
->dev
);
2220 put_device(&udev
->dev
);
2223 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2224 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2228 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2231 static void announce_device(struct usb_device
*udev
)
2233 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2234 le16_to_cpu(udev
->descriptor
.idVendor
),
2235 le16_to_cpu(udev
->descriptor
.idProduct
));
2236 dev_info(&udev
->dev
,
2237 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2238 udev
->descriptor
.iManufacturer
,
2239 udev
->descriptor
.iProduct
,
2240 udev
->descriptor
.iSerialNumber
);
2241 show_string(udev
, "Product", udev
->product
);
2242 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2243 show_string(udev
, "SerialNumber", udev
->serial
);
2246 static inline void announce_device(struct usb_device
*udev
) { }
2251 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2252 * @udev: newly addressed device (in ADDRESS state)
2254 * Finish enumeration for On-The-Go devices
2256 * Return: 0 if successful. A negative error code otherwise.
2258 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2262 #ifdef CONFIG_USB_OTG
2264 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2265 * to wake us after we've powered off VBUS; and HNP, switching roles
2266 * "host" to "peripheral". The OTG descriptor helps figure this out.
2268 if (!udev
->bus
->is_b_host
2270 && udev
->parent
== udev
->bus
->root_hub
) {
2271 struct usb_otg_descriptor
*desc
= NULL
;
2272 struct usb_bus
*bus
= udev
->bus
;
2273 unsigned port1
= udev
->portnum
;
2275 /* descriptor may appear anywhere in config */
2276 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2277 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2278 USB_DT_OTG
, (void **) &desc
);
2279 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2282 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2283 (port1
== bus
->otg_port
) ? "" : "non-");
2285 /* enable HNP before suspend, it's simpler */
2286 if (port1
== bus
->otg_port
) {
2287 bus
->b_hnp_enable
= 1;
2288 err
= usb_control_msg(udev
,
2289 usb_sndctrlpipe(udev
, 0),
2290 USB_REQ_SET_FEATURE
, 0,
2291 USB_DEVICE_B_HNP_ENABLE
,
2293 USB_CTRL_SET_TIMEOUT
);
2296 * OTG MESSAGE: report errors here,
2297 * customize to match your product.
2299 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2301 bus
->b_hnp_enable
= 0;
2303 } else if (desc
->bLength
== sizeof
2304 (struct usb_otg_descriptor
)) {
2305 /* Set a_alt_hnp_support for legacy otg device */
2306 err
= usb_control_msg(udev
,
2307 usb_sndctrlpipe(udev
, 0),
2308 USB_REQ_SET_FEATURE
, 0,
2309 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2311 USB_CTRL_SET_TIMEOUT
);
2314 "set a_alt_hnp_support failed: %d\n",
2324 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2325 * @udev: newly addressed device (in ADDRESS state)
2327 * This is only called by usb_new_device() and usb_authorize_device()
2328 * and FIXME -- all comments that apply to them apply here wrt to
2331 * If the device is WUSB and not authorized, we don't attempt to read
2332 * the string descriptors, as they will be errored out by the device
2333 * until it has been authorized.
2335 * Return: 0 if successful. A negative error code otherwise.
2337 static int usb_enumerate_device(struct usb_device
*udev
)
2340 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2342 if (udev
->config
== NULL
) {
2343 err
= usb_get_configuration(udev
);
2346 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2352 /* read the standard strings and cache them if present */
2353 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2354 udev
->manufacturer
= usb_cache_string(udev
,
2355 udev
->descriptor
.iManufacturer
);
2356 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2358 err
= usb_enumerate_device_otg(udev
);
2362 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2363 !is_targeted(udev
)) {
2364 /* Maybe it can talk to us, though we can't talk to it.
2365 * (Includes HNP test device.)
2367 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2368 || udev
->bus
->is_b_host
)) {
2369 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2371 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2376 usb_detect_interface_quirks(udev
);
2381 static void set_usb_port_removable(struct usb_device
*udev
)
2383 struct usb_device
*hdev
= udev
->parent
;
2384 struct usb_hub
*hub
;
2385 u8 port
= udev
->portnum
;
2386 u16 wHubCharacteristics
;
2387 bool removable
= true;
2392 hub
= usb_hub_to_struct_hub(udev
->parent
);
2395 * If the platform firmware has provided information about a port,
2396 * use that to determine whether it's removable.
2398 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2399 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2400 udev
->removable
= USB_DEVICE_REMOVABLE
;
2402 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2403 case USB_PORT_NOT_USED
:
2404 udev
->removable
= USB_DEVICE_FIXED
;
2411 * Otherwise, check whether the hub knows whether a port is removable
2414 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2416 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2419 if (hub_is_superspeed(hdev
)) {
2420 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2424 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2429 udev
->removable
= USB_DEVICE_REMOVABLE
;
2431 udev
->removable
= USB_DEVICE_FIXED
;
2436 * usb_new_device - perform initial device setup (usbcore-internal)
2437 * @udev: newly addressed device (in ADDRESS state)
2439 * This is called with devices which have been detected but not fully
2440 * enumerated. The device descriptor is available, but not descriptors
2441 * for any device configuration. The caller must have locked either
2442 * the parent hub (if udev is a normal device) or else the
2443 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2444 * udev has already been installed, but udev is not yet visible through
2445 * sysfs or other filesystem code.
2447 * This call is synchronous, and may not be used in an interrupt context.
2449 * Only the hub driver or root-hub registrar should ever call this.
2451 * Return: Whether the device is configured properly or not. Zero if the
2452 * interface was registered with the driver core; else a negative errno
2456 int usb_new_device(struct usb_device
*udev
)
2461 /* Initialize non-root-hub device wakeup to disabled;
2462 * device (un)configuration controls wakeup capable
2463 * sysfs power/wakeup controls wakeup enabled/disabled
2465 device_init_wakeup(&udev
->dev
, 0);
2468 /* Tell the runtime-PM framework the device is active */
2469 pm_runtime_set_active(&udev
->dev
);
2470 pm_runtime_get_noresume(&udev
->dev
);
2471 pm_runtime_use_autosuspend(&udev
->dev
);
2472 pm_runtime_enable(&udev
->dev
);
2474 /* By default, forbid autosuspend for all devices. It will be
2475 * allowed for hubs during binding.
2477 usb_disable_autosuspend(udev
);
2479 err
= usb_enumerate_device(udev
); /* Read descriptors */
2482 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2483 udev
->devnum
, udev
->bus
->busnum
,
2484 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2485 /* export the usbdev device-node for libusb */
2486 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2487 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2489 /* Tell the world! */
2490 announce_device(udev
);
2493 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2495 add_device_randomness(udev
->product
, strlen(udev
->product
));
2496 if (udev
->manufacturer
)
2497 add_device_randomness(udev
->manufacturer
,
2498 strlen(udev
->manufacturer
));
2500 device_enable_async_suspend(&udev
->dev
);
2502 /* check whether the hub or firmware marks this port as non-removable */
2504 set_usb_port_removable(udev
);
2506 /* Register the device. The device driver is responsible
2507 * for configuring the device and invoking the add-device
2508 * notifier chain (used by usbfs and possibly others).
2510 err
= device_add(&udev
->dev
);
2512 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2516 /* Create link files between child device and usb port device. */
2518 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2519 int port1
= udev
->portnum
;
2520 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2522 err
= sysfs_create_link(&udev
->dev
.kobj
,
2523 &port_dev
->dev
.kobj
, "port");
2527 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2528 &udev
->dev
.kobj
, "device");
2530 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2534 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2535 pm_runtime_get_sync(&port_dev
->dev
);
2538 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2539 usb_mark_last_busy(udev
);
2540 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2544 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2545 pm_runtime_disable(&udev
->dev
);
2546 pm_runtime_set_suspended(&udev
->dev
);
2552 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2553 * @usb_dev: USB device
2555 * Move the USB device to a very basic state where interfaces are disabled
2556 * and the device is in fact unconfigured and unusable.
2558 * We share a lock (that we have) with device_del(), so we need to
2563 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2565 usb_lock_device(usb_dev
);
2566 if (usb_dev
->authorized
== 0)
2567 goto out_unauthorized
;
2569 usb_dev
->authorized
= 0;
2570 usb_set_configuration(usb_dev
, -1);
2573 usb_unlock_device(usb_dev
);
2578 int usb_authorize_device(struct usb_device
*usb_dev
)
2582 usb_lock_device(usb_dev
);
2583 if (usb_dev
->authorized
== 1)
2584 goto out_authorized
;
2586 result
= usb_autoresume_device(usb_dev
);
2588 dev_err(&usb_dev
->dev
,
2589 "can't autoresume for authorization: %d\n", result
);
2590 goto error_autoresume
;
2593 if (usb_dev
->wusb
) {
2594 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2596 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2597 "authorization: %d\n", result
);
2598 goto error_device_descriptor
;
2602 usb_dev
->authorized
= 1;
2603 /* Choose and set the configuration. This registers the interfaces
2604 * with the driver core and lets interface drivers bind to them.
2606 c
= usb_choose_configuration(usb_dev
);
2608 result
= usb_set_configuration(usb_dev
, c
);
2610 dev_err(&usb_dev
->dev
,
2611 "can't set config #%d, error %d\n", c
, result
);
2612 /* This need not be fatal. The user can try to
2613 * set other configurations. */
2616 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2618 error_device_descriptor
:
2619 usb_autosuspend_device(usb_dev
);
2622 usb_unlock_device(usb_dev
); /* complements locktree */
2627 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2628 * check it from the link protocol field of the current speed ID attribute.
2629 * current speed ID is got from ext port status request. Sublink speed attribute
2630 * table is returned with the hub BOS SSP device capability descriptor
2632 static int port_speed_is_ssp(struct usb_device
*hdev
, int speed_id
)
2637 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2642 ssa_count
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2643 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2645 for (i
= 0; i
<= ssa_count
; i
++) {
2646 ss_attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2647 if (speed_id
== (ss_attr
& USB_SSP_SUBLINK_SPEED_SSID
))
2648 return !!(ss_attr
& USB_SSP_SUBLINK_SPEED_LP
);
2653 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2654 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2656 struct usb_hcd
*hcd
;
2657 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2659 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2660 return hcd
->wireless
;
2664 #define PORT_RESET_TRIES 5
2665 #define SET_ADDRESS_TRIES 2
2666 #define GET_DESCRIPTOR_TRIES 2
2667 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2668 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2670 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2671 #define HUB_SHORT_RESET_TIME 10
2672 #define HUB_BH_RESET_TIME 50
2673 #define HUB_LONG_RESET_TIME 200
2674 #define HUB_RESET_TIMEOUT 800
2677 * "New scheme" enumeration causes an extra state transition to be
2678 * exposed to an xhci host and causes USB3 devices to receive control
2679 * commands in the default state. This has been seen to cause
2680 * enumeration failures, so disable this enumeration scheme for USB3
2683 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2685 if (udev
->speed
>= USB_SPEED_SUPER
)
2688 return USE_NEW_SCHEME(retry
);
2691 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2692 * Port worm reset is required to recover
2694 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2699 if (!hub_is_superspeed(hub
->hdev
))
2702 if (test_bit(port1
, hub
->warm_reset_bits
))
2705 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2706 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2707 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2710 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2711 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2713 int delay_time
, ret
;
2716 u32 ext_portstatus
= 0;
2718 for (delay_time
= 0;
2719 delay_time
< HUB_RESET_TIMEOUT
;
2720 delay_time
+= delay
) {
2721 /* wait to give the device a chance to reset */
2724 /* read and decode port status */
2725 if (hub_is_superspeedplus(hub
->hdev
))
2726 ret
= hub_ext_port_status(hub
, port1
,
2727 HUB_EXT_PORT_STATUS
,
2728 &portstatus
, &portchange
,
2731 ret
= hub_port_status(hub
, port1
, &portstatus
,
2736 /* The port state is unknown until the reset completes. */
2737 if (!(portstatus
& USB_PORT_STAT_RESET
))
2740 /* switch to the long delay after two short delay failures */
2741 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2742 delay
= HUB_LONG_RESET_TIME
;
2744 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2745 "not %sreset yet, waiting %dms\n",
2746 warm
? "warm " : "", delay
);
2749 if ((portstatus
& USB_PORT_STAT_RESET
))
2752 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2755 /* Device went away? */
2756 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2759 /* bomb out completely if the connection bounced. A USB 3.0
2760 * connection may bounce if multiple warm resets were issued,
2761 * but the device may have successfully re-connected. Ignore it.
2763 if (!hub_is_superspeed(hub
->hdev
) &&
2764 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2767 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2773 if (hub_is_wusb(hub
))
2774 udev
->speed
= USB_SPEED_WIRELESS
;
2775 else if (hub_is_superspeedplus(hub
->hdev
) &&
2776 port_speed_is_ssp(hub
->hdev
, ext_portstatus
&
2777 USB_EXT_PORT_STAT_RX_SPEED_ID
))
2778 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2779 else if (hub_is_superspeed(hub
->hdev
))
2780 udev
->speed
= USB_SPEED_SUPER
;
2781 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2782 udev
->speed
= USB_SPEED_HIGH
;
2783 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2784 udev
->speed
= USB_SPEED_LOW
;
2786 udev
->speed
= USB_SPEED_FULL
;
2790 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2791 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2792 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2795 u16 portchange
, portstatus
;
2796 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2798 if (!hub_is_superspeed(hub
->hdev
)) {
2800 dev_err(hub
->intfdev
, "only USB3 hub support "
2804 /* Block EHCI CF initialization during the port reset.
2805 * Some companion controllers don't like it when they mix.
2807 down_read(&ehci_cf_port_reset_rwsem
);
2810 * If the caller hasn't explicitly requested a warm reset,
2811 * double check and see if one is needed.
2813 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2814 if (hub_port_warm_reset_required(hub
, port1
,
2818 clear_bit(port1
, hub
->warm_reset_bits
);
2820 /* Reset the port */
2821 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2822 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2823 USB_PORT_FEAT_BH_PORT_RESET
:
2824 USB_PORT_FEAT_RESET
));
2825 if (status
== -ENODEV
) {
2826 ; /* The hub is gone */
2827 } else if (status
) {
2828 dev_err(&port_dev
->dev
,
2829 "cannot %sreset (err = %d)\n",
2830 warm
? "warm " : "", status
);
2832 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2834 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2835 dev_dbg(hub
->intfdev
,
2836 "port_wait_reset: err = %d\n",
2840 /* Check for disconnect or reset */
2841 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2842 usb_clear_port_feature(hub
->hdev
, port1
,
2843 USB_PORT_FEAT_C_RESET
);
2845 if (!hub_is_superspeed(hub
->hdev
))
2848 usb_clear_port_feature(hub
->hdev
, port1
,
2849 USB_PORT_FEAT_C_BH_PORT_RESET
);
2850 usb_clear_port_feature(hub
->hdev
, port1
,
2851 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2852 usb_clear_port_feature(hub
->hdev
, port1
,
2853 USB_PORT_FEAT_C_CONNECTION
);
2856 * If a USB 3.0 device migrates from reset to an error
2857 * state, re-issue the warm reset.
2859 if (hub_port_status(hub
, port1
,
2860 &portstatus
, &portchange
) < 0)
2863 if (!hub_port_warm_reset_required(hub
, port1
,
2868 * If the port is in SS.Inactive or Compliance Mode, the
2869 * hot or warm reset failed. Try another warm reset.
2872 dev_dbg(&port_dev
->dev
,
2873 "hot reset failed, warm reset\n");
2878 dev_dbg(&port_dev
->dev
,
2879 "not enabled, trying %sreset again...\n",
2880 warm
? "warm " : "");
2881 delay
= HUB_LONG_RESET_TIME
;
2884 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2888 /* TRSTRCY = 10 ms; plus some extra */
2891 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2893 update_devnum(udev
, 0);
2894 /* The xHC may think the device is already reset,
2895 * so ignore the status.
2897 if (hcd
->driver
->reset_device
)
2898 hcd
->driver
->reset_device(hcd
, udev
);
2900 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2904 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2907 if (!hub_is_superspeed(hub
->hdev
))
2908 up_read(&ehci_cf_port_reset_rwsem
);
2913 /* Check if a port is power on */
2914 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2918 if (hub_is_superspeed(hub
->hdev
)) {
2919 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2922 if (portstatus
& USB_PORT_STAT_POWER
)
2929 static void usb_lock_port(struct usb_port
*port_dev
)
2930 __acquires(&port_dev
->status_lock
)
2932 mutex_lock(&port_dev
->status_lock
);
2933 __acquire(&port_dev
->status_lock
);
2936 static void usb_unlock_port(struct usb_port
*port_dev
)
2937 __releases(&port_dev
->status_lock
)
2939 mutex_unlock(&port_dev
->status_lock
);
2940 __release(&port_dev
->status_lock
);
2945 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2946 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2950 if (hub_is_superspeed(hub
->hdev
)) {
2951 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2952 == USB_SS_PORT_LS_U3
)
2955 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2962 /* Determine whether the device on a port is ready for a normal resume,
2963 * is ready for a reset-resume, or should be disconnected.
2965 static int check_port_resume_type(struct usb_device
*udev
,
2966 struct usb_hub
*hub
, int port1
,
2967 int status
, u16 portchange
, u16 portstatus
)
2969 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2973 /* Is a warm reset needed to recover the connection? */
2974 if (status
== 0 && udev
->reset_resume
2975 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2978 /* Is the device still present? */
2979 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2980 !port_is_power_on(hub
, portstatus
)) {
2983 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2985 usleep_range(200, 300);
2986 status
= hub_port_status(hub
, port1
, &portstatus
,
2993 /* Can't do a normal resume if the port isn't enabled,
2994 * so try a reset-resume instead.
2996 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2997 if (udev
->persist_enabled
)
2998 udev
->reset_resume
= 1;
3004 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
3005 portchange
, portstatus
, status
);
3006 } else if (udev
->reset_resume
) {
3008 /* Late port handoff can set status-change bits */
3009 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3010 usb_clear_port_feature(hub
->hdev
, port1
,
3011 USB_PORT_FEAT_C_CONNECTION
);
3012 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3013 usb_clear_port_feature(hub
->hdev
, port1
,
3014 USB_PORT_FEAT_C_ENABLE
);
3020 int usb_disable_ltm(struct usb_device
*udev
)
3022 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3024 /* Check if the roothub and device supports LTM. */
3025 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3026 !usb_device_supports_ltm(udev
))
3029 /* Clear Feature LTM Enable can only be sent if the device is
3032 if (!udev
->actconfig
)
3035 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3036 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3037 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3038 USB_CTRL_SET_TIMEOUT
);
3040 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3042 void usb_enable_ltm(struct usb_device
*udev
)
3044 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3046 /* Check if the roothub and device supports LTM. */
3047 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3048 !usb_device_supports_ltm(udev
))
3051 /* Set Feature LTM Enable can only be sent if the device is
3054 if (!udev
->actconfig
)
3057 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3058 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3059 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3060 USB_CTRL_SET_TIMEOUT
);
3062 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3065 * usb_enable_remote_wakeup - enable remote wakeup for a device
3066 * @udev: target device
3068 * For USB-2 devices: Set the device's remote wakeup feature.
3070 * For USB-3 devices: Assume there's only one function on the device and
3071 * enable remote wake for the first interface. FIXME if the interface
3072 * association descriptor shows there's more than one function.
3074 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3076 if (udev
->speed
< USB_SPEED_SUPER
)
3077 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3078 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3079 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3080 USB_CTRL_SET_TIMEOUT
);
3082 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3083 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3084 USB_INTRF_FUNC_SUSPEND
,
3085 USB_INTRF_FUNC_SUSPEND_RW
|
3086 USB_INTRF_FUNC_SUSPEND_LP
,
3087 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3091 * usb_disable_remote_wakeup - disable remote wakeup for a device
3092 * @udev: target device
3094 * For USB-2 devices: Clear the device's remote wakeup feature.
3096 * For USB-3 devices: Assume there's only one function on the device and
3097 * disable remote wake for the first interface. FIXME if the interface
3098 * association descriptor shows there's more than one function.
3100 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3102 if (udev
->speed
< USB_SPEED_SUPER
)
3103 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3104 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3105 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3106 USB_CTRL_SET_TIMEOUT
);
3108 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3109 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
3110 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3111 USB_CTRL_SET_TIMEOUT
);
3114 /* Count of wakeup-enabled devices at or below udev */
3115 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3117 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3119 return udev
->do_remote_wakeup
+
3120 (hub
? hub
->wakeup_enabled_descendants
: 0);
3124 * usb_port_suspend - suspend a usb device's upstream port
3125 * @udev: device that's no longer in active use, not a root hub
3126 * Context: must be able to sleep; device not locked; pm locks held
3128 * Suspends a USB device that isn't in active use, conserving power.
3129 * Devices may wake out of a suspend, if anything important happens,
3130 * using the remote wakeup mechanism. They may also be taken out of
3131 * suspend by the host, using usb_port_resume(). It's also routine
3132 * to disconnect devices while they are suspended.
3134 * This only affects the USB hardware for a device; its interfaces
3135 * (and, for hubs, child devices) must already have been suspended.
3137 * Selective port suspend reduces power; most suspended devices draw
3138 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3139 * All devices below the suspended port are also suspended.
3141 * Devices leave suspend state when the host wakes them up. Some devices
3142 * also support "remote wakeup", where the device can activate the USB
3143 * tree above them to deliver data, such as a keypress or packet. In
3144 * some cases, this wakes the USB host.
3146 * Suspending OTG devices may trigger HNP, if that's been enabled
3147 * between a pair of dual-role devices. That will change roles, such
3148 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3150 * Devices on USB hub ports have only one "suspend" state, corresponding
3151 * to ACPI D2, "may cause the device to lose some context".
3152 * State transitions include:
3154 * - suspend, resume ... when the VBUS power link stays live
3155 * - suspend, disconnect ... VBUS lost
3157 * Once VBUS drop breaks the circuit, the port it's using has to go through
3158 * normal re-enumeration procedures, starting with enabling VBUS power.
3159 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3160 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3161 * timer, no SRP, no requests through sysfs.
3163 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3164 * suspended until their bus goes into global suspend (i.e., the root
3165 * hub is suspended). Nevertheless, we change @udev->state to
3166 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3167 * upstream port setting is stored in @udev->port_is_suspended.
3169 * Returns 0 on success, else negative errno.
3171 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3173 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3174 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3175 int port1
= udev
->portnum
;
3177 bool really_suspend
= true;
3179 usb_lock_port(port_dev
);
3181 /* enable remote wakeup when appropriate; this lets the device
3182 * wake up the upstream hub (including maybe the root hub).
3184 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3185 * we don't explicitly enable it here.
3187 if (udev
->do_remote_wakeup
) {
3188 status
= usb_enable_remote_wakeup(udev
);
3190 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3192 /* bail if autosuspend is requested */
3193 if (PMSG_IS_AUTO(msg
))
3198 /* disable USB2 hardware LPM */
3199 if (udev
->usb2_hw_lpm_enabled
== 1)
3200 usb_set_usb2_hardware_lpm(udev
, 0);
3202 if (usb_disable_ltm(udev
)) {
3203 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3205 if (PMSG_IS_AUTO(msg
))
3208 if (usb_unlocked_disable_lpm(udev
)) {
3209 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3211 if (PMSG_IS_AUTO(msg
))
3216 if (hub_is_superspeed(hub
->hdev
))
3217 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3220 * For system suspend, we do not need to enable the suspend feature
3221 * on individual USB-2 ports. The devices will automatically go
3222 * into suspend a few ms after the root hub stops sending packets.
3223 * The USB 2.0 spec calls this "global suspend".
3225 * However, many USB hubs have a bug: They don't relay wakeup requests
3226 * from a downstream port if the port's suspend feature isn't on.
3227 * Therefore we will turn on the suspend feature if udev or any of its
3228 * descendants is enabled for remote wakeup.
3230 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3231 status
= set_port_feature(hub
->hdev
, port1
,
3232 USB_PORT_FEAT_SUSPEND
);
3234 really_suspend
= false;
3238 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3240 /* Try to enable USB3 LPM and LTM again */
3241 usb_unlocked_enable_lpm(udev
);
3243 usb_enable_ltm(udev
);
3245 /* Try to enable USB2 hardware LPM again */
3246 if (udev
->usb2_hw_lpm_capable
== 1)
3247 usb_set_usb2_hardware_lpm(udev
, 1);
3249 if (udev
->do_remote_wakeup
)
3250 (void) usb_disable_remote_wakeup(udev
);
3253 /* System sleep transitions should never fail */
3254 if (!PMSG_IS_AUTO(msg
))
3257 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3258 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3259 udev
->do_remote_wakeup
);
3260 if (really_suspend
) {
3261 udev
->port_is_suspended
= 1;
3263 /* device has up to 10 msec to fully suspend */
3266 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3269 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3270 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3271 pm_runtime_put_sync(&port_dev
->dev
);
3273 usb_mark_last_busy(hub
->hdev
);
3275 usb_unlock_port(port_dev
);
3280 * If the USB "suspend" state is in use (rather than "global suspend"),
3281 * many devices will be individually taken out of suspend state using
3282 * special "resume" signaling. This routine kicks in shortly after
3283 * hardware resume signaling is finished, either because of selective
3284 * resume (by host) or remote wakeup (by device) ... now see what changed
3285 * in the tree that's rooted at this device.
3287 * If @udev->reset_resume is set then the device is reset before the
3288 * status check is done.
3290 static int finish_port_resume(struct usb_device
*udev
)
3295 /* caller owns the udev device lock */
3296 dev_dbg(&udev
->dev
, "%s\n",
3297 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3299 /* usb ch9 identifies four variants of SUSPENDED, based on what
3300 * state the device resumes to. Linux currently won't see the
3301 * first two on the host side; they'd be inside hub_port_init()
3302 * during many timeouts, but hub_wq can't suspend until later.
3304 usb_set_device_state(udev
, udev
->actconfig
3305 ? USB_STATE_CONFIGURED
3306 : USB_STATE_ADDRESS
);
3308 /* 10.5.4.5 says not to reset a suspended port if the attached
3309 * device is enabled for remote wakeup. Hence the reset
3310 * operation is carried out here, after the port has been
3313 if (udev
->reset_resume
) {
3315 * If the device morphs or switches modes when it is reset,
3316 * we don't want to perform a reset-resume. We'll fail the
3317 * resume, which will cause a logical disconnect, and then
3318 * the device will be rediscovered.
3321 if (udev
->quirks
& USB_QUIRK_RESET
)
3324 status
= usb_reset_and_verify_device(udev
);
3327 /* 10.5.4.5 says be sure devices in the tree are still there.
3328 * For now let's assume the device didn't go crazy on resume,
3329 * and device drivers will know about any resume quirks.
3333 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3335 /* If a normal resume failed, try doing a reset-resume */
3336 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3337 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3338 udev
->reset_resume
= 1;
3339 goto retry_reset_resume
;
3344 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3347 * There are a few quirky devices which violate the standard
3348 * by claiming to have remote wakeup enabled after a reset,
3349 * which crash if the feature is cleared, hence check for
3350 * udev->reset_resume
3352 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3353 if (udev
->speed
< USB_SPEED_SUPER
) {
3354 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3355 status
= usb_disable_remote_wakeup(udev
);
3357 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3359 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3360 | USB_INTRF_STAT_FUNC_RW
))
3361 status
= usb_disable_remote_wakeup(udev
);
3366 "disable remote wakeup, status %d\n",
3374 * There are some SS USB devices which take longer time for link training.
3375 * XHCI specs 4.19.4 says that when Link training is successful, port
3376 * sets CCS bit to 1. So if SW reads port status before successful link
3377 * training, then it will not find device to be present.
3378 * USB Analyzer log with such buggy devices show that in some cases
3379 * device switch on the RX termination after long delay of host enabling
3380 * the VBUS. In few other cases it has been seen that device fails to
3381 * negotiate link training in first attempt. It has been
3382 * reported till now that few devices take as long as 2000 ms to train
3383 * the link after host enabling its VBUS and termination. Following
3384 * routine implements a 2000 ms timeout for link training. If in a case
3385 * link trains before timeout, loop will exit earlier.
3387 * There are also some 2.0 hard drive based devices and 3.0 thumb
3388 * drives that, when plugged into a 2.0 only port, take a long
3389 * time to set CCS after VBUS enable.
3391 * FIXME: If a device was connected before suspend, but was removed
3392 * while system was asleep, then the loop in the following routine will
3393 * only exit at timeout.
3395 * This routine should only be called when persist is enabled.
3397 static int wait_for_connected(struct usb_device
*udev
,
3398 struct usb_hub
*hub
, int *port1
,
3399 u16
*portchange
, u16
*portstatus
)
3401 int status
= 0, delay_ms
= 0;
3403 while (delay_ms
< 2000) {
3404 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3408 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3410 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3415 * usb_port_resume - re-activate a suspended usb device's upstream port
3416 * @udev: device to re-activate, not a root hub
3417 * Context: must be able to sleep; device not locked; pm locks held
3419 * This will re-activate the suspended device, increasing power usage
3420 * while letting drivers communicate again with its endpoints.
3421 * USB resume explicitly guarantees that the power session between
3422 * the host and the device is the same as it was when the device
3425 * If @udev->reset_resume is set then this routine won't check that the
3426 * port is still enabled. Furthermore, finish_port_resume() above will
3427 * reset @udev. The end result is that a broken power session can be
3428 * recovered and @udev will appear to persist across a loss of VBUS power.
3430 * For example, if a host controller doesn't maintain VBUS suspend current
3431 * during a system sleep or is reset when the system wakes up, all the USB
3432 * power sessions below it will be broken. This is especially troublesome
3433 * for mass-storage devices containing mounted filesystems, since the
3434 * device will appear to have disconnected and all the memory mappings
3435 * to it will be lost. Using the USB_PERSIST facility, the device can be
3436 * made to appear as if it had not disconnected.
3438 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3439 * every effort to insure that the same device is present after the
3440 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3441 * quite possible for a device to remain unaltered but its media to be
3442 * changed. If the user replaces a flash memory card while the system is
3443 * asleep, he will have only himself to blame when the filesystem on the
3444 * new card is corrupted and the system crashes.
3446 * Returns 0 on success, else negative errno.
3448 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3450 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3451 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3452 int port1
= udev
->portnum
;
3454 u16 portchange
, portstatus
;
3456 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3457 status
= pm_runtime_get_sync(&port_dev
->dev
);
3459 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3465 usb_lock_port(port_dev
);
3467 /* Skip the initial Clear-Suspend step for a remote wakeup */
3468 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3469 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3470 goto SuspendCleared
;
3472 /* see 7.1.7.7; affects power usage, but not budgeting */
3473 if (hub_is_superspeed(hub
->hdev
))
3474 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3476 status
= usb_clear_port_feature(hub
->hdev
,
3477 port1
, USB_PORT_FEAT_SUSPEND
);
3479 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3481 /* drive resume for USB_RESUME_TIMEOUT msec */
3482 dev_dbg(&udev
->dev
, "usb %sresume\n",
3483 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3484 msleep(USB_RESUME_TIMEOUT
);
3486 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3487 * stop resume signaling. Then finish the resume
3490 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3492 /* TRSMRCY = 10 msec */
3498 udev
->port_is_suspended
= 0;
3499 if (hub_is_superspeed(hub
->hdev
)) {
3500 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3501 usb_clear_port_feature(hub
->hdev
, port1
,
3502 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3504 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3505 usb_clear_port_feature(hub
->hdev
, port1
,
3506 USB_PORT_FEAT_C_SUSPEND
);
3510 if (udev
->persist_enabled
)
3511 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3514 status
= check_port_resume_type(udev
,
3515 hub
, port1
, status
, portchange
, portstatus
);
3517 status
= finish_port_resume(udev
);
3519 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3520 hub_port_logical_disconnect(hub
, port1
);
3522 /* Try to enable USB2 hardware LPM */
3523 if (udev
->usb2_hw_lpm_capable
== 1)
3524 usb_set_usb2_hardware_lpm(udev
, 1);
3526 /* Try to enable USB3 LTM and LPM */
3527 usb_enable_ltm(udev
);
3528 usb_unlocked_enable_lpm(udev
);
3531 usb_unlock_port(port_dev
);
3536 int usb_remote_wakeup(struct usb_device
*udev
)
3540 usb_lock_device(udev
);
3541 if (udev
->state
== USB_STATE_SUSPENDED
) {
3542 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3543 status
= usb_autoresume_device(udev
);
3545 /* Let the drivers do their thing, then... */
3546 usb_autosuspend_device(udev
);
3549 usb_unlock_device(udev
);
3553 /* Returns 1 if there was a remote wakeup and a connect status change. */
3554 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3555 u16 portstatus
, u16 portchange
)
3556 __must_hold(&port_dev
->status_lock
)
3558 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3559 struct usb_device
*hdev
;
3560 struct usb_device
*udev
;
3561 int connect_change
= 0;
3565 udev
= port_dev
->child
;
3566 if (!hub_is_superspeed(hdev
)) {
3567 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3569 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3571 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3572 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
3578 /* TRSMRCY = 10 msec */
3581 usb_unlock_port(port_dev
);
3582 ret
= usb_remote_wakeup(udev
);
3583 usb_lock_port(port_dev
);
3588 hub_port_disable(hub
, port
, 1);
3590 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3591 return connect_change
;
3594 static int check_ports_changed(struct usb_hub
*hub
)
3598 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3599 u16 portstatus
, portchange
;
3602 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3603 if (!status
&& portchange
)
3609 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3611 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3612 struct usb_device
*hdev
= hub
->hdev
;
3617 * Warn if children aren't already suspended.
3618 * Also, add up the number of wakeup-enabled descendants.
3620 hub
->wakeup_enabled_descendants
= 0;
3621 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3622 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3623 struct usb_device
*udev
= port_dev
->child
;
3625 if (udev
&& udev
->can_submit
) {
3626 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3627 dev_name(&udev
->dev
));
3628 if (PMSG_IS_AUTO(msg
))
3632 hub
->wakeup_enabled_descendants
+=
3633 wakeup_enabled_descendants(udev
);
3636 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3637 /* check if there are changes pending on hub ports */
3638 if (check_ports_changed(hub
)) {
3639 if (PMSG_IS_AUTO(msg
))
3641 pm_wakeup_event(&hdev
->dev
, 2000);
3645 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3646 /* Enable hub to send remote wakeup for all ports. */
3647 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3648 status
= set_port_feature(hdev
,
3650 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3651 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3652 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3653 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3657 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3659 /* stop hub_wq and related activity */
3660 hub_quiesce(hub
, HUB_SUSPEND
);
3664 static int hub_resume(struct usb_interface
*intf
)
3666 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3668 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3669 hub_activate(hub
, HUB_RESUME
);
3673 static int hub_reset_resume(struct usb_interface
*intf
)
3675 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3677 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3678 hub_activate(hub
, HUB_RESET_RESUME
);
3683 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3684 * @rhdev: struct usb_device for the root hub
3686 * The USB host controller driver calls this function when its root hub
3687 * is resumed and Vbus power has been interrupted or the controller
3688 * has been reset. The routine marks @rhdev as having lost power.
3689 * When the hub driver is resumed it will take notice and carry out
3690 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3691 * the others will be disconnected.
3693 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3695 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3696 rhdev
->reset_resume
= 1;
3698 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3700 static const char * const usb3_lpm_names
[] = {
3708 * Send a Set SEL control transfer to the device, prior to enabling
3709 * device-initiated U1 or U2. This lets the device know the exit latencies from
3710 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3711 * packet from the host.
3713 * This function will fail if the SEL or PEL values for udev are greater than
3714 * the maximum allowed values for the link state to be enabled.
3716 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3718 struct usb_set_sel_req
*sel_values
;
3719 unsigned long long u1_sel
;
3720 unsigned long long u1_pel
;
3721 unsigned long long u2_sel
;
3722 unsigned long long u2_pel
;
3725 if (udev
->state
!= USB_STATE_CONFIGURED
)
3728 /* Convert SEL and PEL stored in ns to us */
3729 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3730 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3731 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3732 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3735 * Make sure that the calculated SEL and PEL values for the link
3736 * state we're enabling aren't bigger than the max SEL/PEL
3737 * value that will fit in the SET SEL control transfer.
3738 * Otherwise the device would get an incorrect idea of the exit
3739 * latency for the link state, and could start a device-initiated
3740 * U1/U2 when the exit latencies are too high.
3742 if ((state
== USB3_LPM_U1
&&
3743 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3744 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3745 (state
== USB3_LPM_U2
&&
3746 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3747 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3748 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3749 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3754 * If we're enabling device-initiated LPM for one link state,
3755 * but the other link state has a too high SEL or PEL value,
3756 * just set those values to the max in the Set SEL request.
3758 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3759 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3761 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3762 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3764 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3765 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3767 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3768 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3771 * usb_enable_lpm() can be called as part of a failed device reset,
3772 * which may be initiated by an error path of a mass storage driver.
3773 * Therefore, use GFP_NOIO.
3775 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3779 sel_values
->u1_sel
= u1_sel
;
3780 sel_values
->u1_pel
= u1_pel
;
3781 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3782 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3784 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3788 sel_values
, sizeof *(sel_values
),
3789 USB_CTRL_SET_TIMEOUT
);
3795 * Enable or disable device-initiated U1 or U2 transitions.
3797 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3798 enum usb3_link_state state
, bool enable
)
3805 feature
= USB_DEVICE_U1_ENABLE
;
3808 feature
= USB_DEVICE_U2_ENABLE
;
3811 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3812 __func__
, enable
? "enable" : "disable");
3816 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3817 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3818 "for unconfigured device.\n",
3819 __func__
, enable
? "enable" : "disable",
3820 usb3_lpm_names
[state
]);
3826 * Now send the control transfer to enable device-initiated LPM
3827 * for either U1 or U2.
3829 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3830 USB_REQ_SET_FEATURE
,
3834 USB_CTRL_SET_TIMEOUT
);
3836 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3837 USB_REQ_CLEAR_FEATURE
,
3841 USB_CTRL_SET_TIMEOUT
);
3844 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3845 enable
? "Enable" : "Disable",
3846 usb3_lpm_names
[state
]);
3852 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3853 enum usb3_link_state state
, int timeout
)
3860 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3863 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3866 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3871 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3872 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3873 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3874 "which is a reserved value.\n",
3875 usb3_lpm_names
[state
], timeout
);
3879 ret
= set_port_feature(udev
->parent
,
3880 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3883 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3884 "error code %i\n", usb3_lpm_names
[state
],
3888 if (state
== USB3_LPM_U1
)
3889 udev
->u1_params
.timeout
= timeout
;
3891 udev
->u2_params
.timeout
= timeout
;
3896 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3899 * We will attempt to enable U1 or U2, but there are no guarantees that the
3900 * control transfers to set the hub timeout or enable device-initiated U1/U2
3901 * will be successful.
3903 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3904 * driver know about it. If that call fails, it should be harmless, and just
3905 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3907 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3908 enum usb3_link_state state
)
3911 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3912 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3914 /* If the device says it doesn't have *any* exit latency to come out of
3915 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3918 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3919 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3923 * First, let the device know about the exit latencies
3924 * associated with the link state we're about to enable.
3926 ret
= usb_req_set_sel(udev
, state
);
3928 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3929 usb3_lpm_names
[state
]);
3933 /* We allow the host controller to set the U1/U2 timeout internally
3934 * first, so that it can change its schedule to account for the
3935 * additional latency to send data to a device in a lower power
3938 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3940 /* xHCI host controller doesn't want to enable this LPM state. */
3945 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3946 "xHCI error %i.\n", usb3_lpm_names
[state
],
3951 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
3952 /* If we can't set the parent hub U1/U2 timeout,
3953 * device-initiated LPM won't be allowed either, so let the xHCI
3954 * host know that this link state won't be enabled.
3956 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3958 /* Only a configured device will accept the Set Feature
3961 if (udev
->actconfig
)
3962 usb_set_device_initiated_lpm(udev
, state
, true);
3964 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3965 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3966 * matter the result of usb_set_device_initiated_lpm().
3967 * The only difference is whether device is able to initiate
3970 if (state
== USB3_LPM_U1
)
3971 udev
->usb3_lpm_u1_enabled
= 1;
3972 else if (state
== USB3_LPM_U2
)
3973 udev
->usb3_lpm_u2_enabled
= 1;
3978 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3981 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3982 * If zero is returned, the parent will not allow the link to go into U1/U2.
3984 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3985 * it won't have an effect on the bus link state because the parent hub will
3986 * still disallow device-initiated U1/U2 entry.
3988 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3989 * possible. The result will be slightly more bus bandwidth will be taken up
3990 * (to account for U1/U2 exit latency), but it should be harmless.
3992 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3993 enum usb3_link_state state
)
4000 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4005 if (usb_set_lpm_timeout(udev
, state
, 0))
4008 usb_set_device_initiated_lpm(udev
, state
, false);
4010 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4011 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4012 "bus schedule bandwidth may be impacted.\n",
4013 usb3_lpm_names
[state
]);
4015 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4016 * is disabled. Hub will disallows link to enter U1/U2 as well,
4017 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4018 * timeout set to 0, no matter device-initiated LPM is disabled or
4021 if (state
== USB3_LPM_U1
)
4022 udev
->usb3_lpm_u1_enabled
= 0;
4023 else if (state
== USB3_LPM_U2
)
4024 udev
->usb3_lpm_u2_enabled
= 0;
4030 * Disable hub-initiated and device-initiated U1 and U2 entry.
4031 * Caller must own the bandwidth_mutex.
4033 * This will call usb_enable_lpm() on failure, which will decrement
4034 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4036 int usb_disable_lpm(struct usb_device
*udev
)
4038 struct usb_hcd
*hcd
;
4040 if (!udev
|| !udev
->parent
||
4041 udev
->speed
< USB_SPEED_SUPER
||
4042 !udev
->lpm_capable
||
4043 udev
->state
< USB_STATE_DEFAULT
)
4046 hcd
= bus_to_hcd(udev
->bus
);
4047 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4050 udev
->lpm_disable_count
++;
4051 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4054 /* If LPM is enabled, attempt to disable it. */
4055 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4057 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4063 usb_enable_lpm(udev
);
4066 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4068 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4069 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4071 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4077 mutex_lock(hcd
->bandwidth_mutex
);
4078 ret
= usb_disable_lpm(udev
);
4079 mutex_unlock(hcd
->bandwidth_mutex
);
4083 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4086 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4087 * xHCI host policy may prevent U1 or U2 from being enabled.
4089 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4090 * until the lpm_disable_count drops to zero. Caller must own the
4093 void usb_enable_lpm(struct usb_device
*udev
)
4095 struct usb_hcd
*hcd
;
4096 struct usb_hub
*hub
;
4097 struct usb_port
*port_dev
;
4099 if (!udev
|| !udev
->parent
||
4100 udev
->speed
< USB_SPEED_SUPER
||
4101 !udev
->lpm_capable
||
4102 udev
->state
< USB_STATE_DEFAULT
)
4105 udev
->lpm_disable_count
--;
4106 hcd
= bus_to_hcd(udev
->bus
);
4107 /* Double check that we can both enable and disable LPM.
4108 * Device must be configured to accept set feature U1/U2 timeout.
4110 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4111 !hcd
->driver
->disable_usb3_lpm_timeout
)
4114 if (udev
->lpm_disable_count
> 0)
4117 hub
= usb_hub_to_struct_hub(udev
->parent
);
4121 port_dev
= hub
->ports
[udev
->portnum
- 1];
4123 if (port_dev
->usb3_lpm_u1_permit
)
4124 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4126 if (port_dev
->usb3_lpm_u2_permit
)
4127 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4129 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4131 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4132 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4134 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4139 mutex_lock(hcd
->bandwidth_mutex
);
4140 usb_enable_lpm(udev
);
4141 mutex_unlock(hcd
->bandwidth_mutex
);
4143 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4146 #else /* CONFIG_PM */
4148 #define hub_suspend NULL
4149 #define hub_resume NULL
4150 #define hub_reset_resume NULL
4152 int usb_disable_lpm(struct usb_device
*udev
)
4156 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4158 void usb_enable_lpm(struct usb_device
*udev
) { }
4159 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4161 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4165 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4167 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4168 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4170 int usb_disable_ltm(struct usb_device
*udev
)
4174 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4176 void usb_enable_ltm(struct usb_device
*udev
) { }
4177 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4179 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4180 u16 portstatus
, u16 portchange
)
4185 #endif /* CONFIG_PM */
4188 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4190 * Between connect detection and reset signaling there must be a delay
4191 * of 100ms at least for debounce and power-settling. The corresponding
4192 * timer shall restart whenever the downstream port detects a disconnect.
4194 * Apparently there are some bluetooth and irda-dongles and a number of
4195 * low-speed devices for which this debounce period may last over a second.
4196 * Not covered by the spec - but easy to deal with.
4198 * This implementation uses a 1500ms total debounce timeout; if the
4199 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4200 * every 25ms for transient disconnects. When the port status has been
4201 * unchanged for 100ms it returns the port status.
4203 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4206 u16 portchange
, portstatus
;
4207 unsigned connection
= 0xffff;
4208 int total_time
, stable_time
= 0;
4209 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4211 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4212 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4216 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4217 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4218 if (!must_be_connected
||
4219 (connection
== USB_PORT_STAT_CONNECTION
))
4220 stable_time
+= HUB_DEBOUNCE_STEP
;
4221 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4225 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4228 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4229 usb_clear_port_feature(hub
->hdev
, port1
,
4230 USB_PORT_FEAT_C_CONNECTION
);
4233 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4235 msleep(HUB_DEBOUNCE_STEP
);
4238 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4239 total_time
, stable_time
, portstatus
);
4241 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4246 void usb_ep0_reinit(struct usb_device
*udev
)
4248 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4249 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4250 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4252 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4254 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4255 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4257 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4260 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4263 * The host controller will choose the device address,
4264 * instead of the core having chosen it earlier
4266 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4268 if (udev
->state
== USB_STATE_ADDRESS
)
4270 if (udev
->state
!= USB_STATE_DEFAULT
)
4272 if (hcd
->driver
->address_device
)
4273 retval
= hcd
->driver
->address_device(hcd
, udev
);
4275 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4276 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4277 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4279 update_devnum(udev
, devnum
);
4280 /* Device now using proper address. */
4281 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4282 usb_ep0_reinit(udev
);
4288 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4289 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4292 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4293 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4294 * support bit in the BOS descriptor.
4296 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4298 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4299 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4301 if (!udev
->usb2_hw_lpm_capable
)
4305 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4307 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4308 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4309 udev
->usb2_hw_lpm_allowed
= 1;
4310 usb_set_usb2_hardware_lpm(udev
, 1);
4314 static int hub_enable_device(struct usb_device
*udev
)
4316 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4318 if (!hcd
->driver
->enable_device
)
4320 if (udev
->state
== USB_STATE_ADDRESS
)
4322 if (udev
->state
!= USB_STATE_DEFAULT
)
4325 return hcd
->driver
->enable_device(hcd
, udev
);
4328 /* Reset device, (re)assign address, get device descriptor.
4329 * Device connection must be stable, no more debouncing needed.
4330 * Returns device in USB_STATE_ADDRESS, except on error.
4332 * If this is called for an already-existing device (as part of
4333 * usb_reset_and_verify_device), the caller must own the device lock and
4334 * the port lock. For a newly detected device that is not accessible
4335 * through any global pointers, it's not necessary to lock the device,
4336 * but it is still necessary to lock the port.
4339 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4342 struct usb_device
*hdev
= hub
->hdev
;
4343 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4344 int retries
, operations
, retval
, i
;
4345 unsigned delay
= HUB_SHORT_RESET_TIME
;
4346 enum usb_device_speed oldspeed
= udev
->speed
;
4348 int devnum
= udev
->devnum
;
4350 /* root hub ports have a slightly longer reset period
4351 * (from USB 2.0 spec, section 7.1.7.5)
4353 if (!hdev
->parent
) {
4354 delay
= HUB_ROOT_RESET_TIME
;
4355 if (port1
== hdev
->bus
->otg_port
)
4356 hdev
->bus
->b_hnp_enable
= 0;
4359 /* Some low speed devices have problems with the quick delay, so */
4360 /* be a bit pessimistic with those devices. RHbug #23670 */
4361 if (oldspeed
== USB_SPEED_LOW
)
4362 delay
= HUB_LONG_RESET_TIME
;
4364 mutex_lock(hcd
->address0_mutex
);
4366 /* Reset the device; full speed may morph to high speed */
4367 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4368 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4369 if (retval
< 0) /* error or disconnect */
4371 /* success, speed is known */
4375 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4376 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4377 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4378 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4381 oldspeed
= udev
->speed
;
4383 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4384 * it's fixed size except for full speed devices.
4385 * For Wireless USB devices, ep0 max packet is always 512 (tho
4386 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4388 switch (udev
->speed
) {
4389 case USB_SPEED_SUPER_PLUS
:
4390 case USB_SPEED_SUPER
:
4391 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4392 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4394 case USB_SPEED_HIGH
: /* fixed at 64 */
4395 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4397 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4398 /* to determine the ep0 maxpacket size, try to read
4399 * the device descriptor to get bMaxPacketSize0 and
4400 * then correct our initial guess.
4402 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4404 case USB_SPEED_LOW
: /* fixed at 8 */
4405 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4411 if (udev
->speed
== USB_SPEED_WIRELESS
)
4412 speed
= "variable speed Wireless";
4414 speed
= usb_speed_string(udev
->speed
);
4416 if (udev
->speed
< USB_SPEED_SUPER
)
4417 dev_info(&udev
->dev
,
4418 "%s %s USB device number %d using %s\n",
4419 (udev
->config
) ? "reset" : "new", speed
,
4420 devnum
, udev
->bus
->controller
->driver
->name
);
4422 /* Set up TT records, if needed */
4424 udev
->tt
= hdev
->tt
;
4425 udev
->ttport
= hdev
->ttport
;
4426 } else if (udev
->speed
!= USB_SPEED_HIGH
4427 && hdev
->speed
== USB_SPEED_HIGH
) {
4429 dev_err(&udev
->dev
, "parent hub has no TT\n");
4433 udev
->tt
= &hub
->tt
;
4434 udev
->ttport
= port1
;
4437 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4438 * Because device hardware and firmware is sometimes buggy in
4439 * this area, and this is how Linux has done it for ages.
4440 * Change it cautiously.
4442 * NOTE: If use_new_scheme() is true we will start by issuing
4443 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4444 * so it may help with some non-standards-compliant devices.
4445 * Otherwise we start with SET_ADDRESS and then try to read the
4446 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4449 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4450 bool did_new_scheme
= false;
4452 if (use_new_scheme(udev
, retry_counter
)) {
4453 struct usb_device_descriptor
*buf
;
4456 did_new_scheme
= true;
4457 retval
= hub_enable_device(udev
);
4460 "hub failed to enable device, error %d\n",
4465 #define GET_DESCRIPTOR_BUFSIZE 64
4466 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4472 /* Retry on all errors; some devices are flakey.
4473 * 255 is for WUSB devices, we actually need to use
4474 * 512 (WUSB1.0[4.8.1]).
4476 for (operations
= 0; operations
< 3; ++operations
) {
4477 buf
->bMaxPacketSize0
= 0;
4478 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4479 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4480 USB_DT_DEVICE
<< 8, 0,
4481 buf
, GET_DESCRIPTOR_BUFSIZE
,
4482 initial_descriptor_timeout
);
4483 switch (buf
->bMaxPacketSize0
) {
4484 case 8: case 16: case 32: case 64: case 255:
4485 if (buf
->bDescriptorType
==
4497 * Some devices time out if they are powered on
4498 * when already connected. They need a second
4499 * reset. But only on the first attempt,
4500 * lest we get into a time out/reset loop
4502 if (r
== 0 || (r
== -ETIMEDOUT
&& retries
== 0))
4505 udev
->descriptor
.bMaxPacketSize0
=
4506 buf
->bMaxPacketSize0
;
4509 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4510 if (retval
< 0) /* error or disconnect */
4512 if (oldspeed
!= udev
->speed
) {
4514 "device reset changed speed!\n");
4520 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4525 #undef GET_DESCRIPTOR_BUFSIZE
4529 * If device is WUSB, we already assigned an
4530 * unauthorized address in the Connect Ack sequence;
4531 * authorization will assign the final address.
4533 if (udev
->wusb
== 0) {
4534 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4535 retval
= hub_set_address(udev
, devnum
);
4541 if (retval
!= -ENODEV
)
4542 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4546 if (udev
->speed
>= USB_SPEED_SUPER
) {
4547 devnum
= udev
->devnum
;
4548 dev_info(&udev
->dev
,
4549 "%s SuperSpeed%s USB device number %d using %s\n",
4550 (udev
->config
) ? "reset" : "new",
4551 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ? "Plus" : "",
4552 devnum
, udev
->bus
->controller
->driver
->name
);
4555 /* cope with hardware quirkiness:
4556 * - let SET_ADDRESS settle, some device hardware wants it
4557 * - read ep0 maxpacket even for high and low speed,
4560 /* use_new_scheme() checks the speed which may have
4561 * changed since the initial look so we cache the result
4568 retval
= usb_get_device_descriptor(udev
, 8);
4570 if (retval
!= -ENODEV
)
4572 "device descriptor read/8, error %d\n",
4585 * Some superspeed devices have finished the link training process
4586 * and attached to a superspeed hub port, but the device descriptor
4587 * got from those devices show they aren't superspeed devices. Warm
4588 * reset the port attached by the devices can fix them.
4590 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4591 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4592 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4593 "warm reset device\n");
4594 hub_port_reset(hub
, port1
, udev
,
4595 HUB_BH_RESET_TIME
, true);
4600 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4601 udev
->speed
>= USB_SPEED_SUPER
)
4604 i
= udev
->descriptor
.bMaxPacketSize0
;
4605 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4606 if (udev
->speed
== USB_SPEED_LOW
||
4607 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4608 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4612 if (udev
->speed
== USB_SPEED_FULL
)
4613 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4615 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4616 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4617 usb_ep0_reinit(udev
);
4620 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4621 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4622 if (retval
!= -ENODEV
)
4623 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4630 usb_detect_quirks(udev
);
4632 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4633 retval
= usb_get_bos_descriptor(udev
);
4635 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4636 usb_set_lpm_parameters(udev
);
4641 /* notify HCD that we have a device connected and addressed */
4642 if (hcd
->driver
->update_device
)
4643 hcd
->driver
->update_device(hcd
, udev
);
4644 hub_set_initial_usb2_lpm_policy(udev
);
4647 hub_port_disable(hub
, port1
, 0);
4648 update_devnum(udev
, devnum
); /* for disconnect processing */
4650 mutex_unlock(hcd
->address0_mutex
);
4655 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4657 struct usb_qualifier_descriptor
*qual
;
4660 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4663 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4667 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4668 qual
, sizeof *qual
);
4669 if (status
== sizeof *qual
) {
4670 dev_info(&udev
->dev
, "not running at top speed; "
4671 "connect to a high speed hub\n");
4672 /* hub LEDs are probably harder to miss than syslog */
4673 if (hub
->has_indicators
) {
4674 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4675 queue_delayed_work(system_power_efficient_wq
,
4683 hub_power_remaining(struct usb_hub
*hub
)
4685 struct usb_device
*hdev
= hub
->hdev
;
4689 if (!hub
->limited_power
)
4692 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4693 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4694 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4695 struct usb_device
*udev
= port_dev
->child
;
4701 if (hub_is_superspeed(udev
))
4707 * Unconfigured devices may not use more than one unit load,
4708 * or 8mA for OTG ports
4710 if (udev
->actconfig
)
4711 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4712 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4716 if (delta
> hub
->mA_per_port
)
4717 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4718 delta
, hub
->mA_per_port
);
4721 if (remaining
< 0) {
4722 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4729 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4734 struct usb_device
*hdev
= hub
->hdev
;
4735 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4736 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4737 struct usb_device
*udev
= port_dev
->child
;
4738 static int unreliable_port
= -1;
4740 /* Disconnect any existing devices under this port */
4742 if (hcd
->usb_phy
&& !hdev
->parent
)
4743 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4744 usb_disconnect(&port_dev
->child
);
4747 /* We can forget about a "removed" device when there's a physical
4748 * disconnect or the connect status changes.
4750 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4751 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4752 clear_bit(port1
, hub
->removed_bits
);
4754 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4755 USB_PORT_STAT_C_ENABLE
)) {
4756 status
= hub_port_debounce_be_stable(hub
, port1
);
4758 if (status
!= -ENODEV
&&
4759 port1
!= unreliable_port
&&
4761 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4762 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4763 unreliable_port
= port1
;
4765 portstatus
= status
;
4769 /* Return now if debouncing failed or nothing is connected or
4770 * the device was "removed".
4772 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4773 test_bit(port1
, hub
->removed_bits
)) {
4776 * maybe switch power back on (e.g. root hub was reset)
4777 * but only if the port isn't owned by someone else.
4779 if (hub_is_port_power_switchable(hub
)
4780 && !port_is_power_on(hub
, portstatus
)
4781 && !port_dev
->port_owner
)
4782 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4784 if (portstatus
& USB_PORT_STAT_ENABLE
)
4788 if (hub_is_superspeed(hub
->hdev
))
4794 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4796 /* reallocate for each attempt, since references
4797 * to the previous one can escape in various ways
4799 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4801 dev_err(&port_dev
->dev
,
4802 "couldn't allocate usb_device\n");
4806 usb_set_device_state(udev
, USB_STATE_POWERED
);
4807 udev
->bus_mA
= hub
->mA_per_port
;
4808 udev
->level
= hdev
->level
+ 1;
4809 udev
->wusb
= hub_is_wusb(hub
);
4811 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4812 if (hub_is_superspeed(hub
->hdev
))
4813 udev
->speed
= USB_SPEED_SUPER
;
4815 udev
->speed
= USB_SPEED_UNKNOWN
;
4817 choose_devnum(udev
);
4818 if (udev
->devnum
<= 0) {
4819 status
= -ENOTCONN
; /* Don't retry */
4823 /* reset (non-USB 3.0 devices) and get descriptor */
4824 usb_lock_port(port_dev
);
4825 status
= hub_port_init(hub
, udev
, port1
, i
);
4826 usb_unlock_port(port_dev
);
4830 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4833 /* consecutive bus-powered hubs aren't reliable; they can
4834 * violate the voltage drop budget. if the new child has
4835 * a "powered" LED, users should notice we didn't enable it
4836 * (without reading syslog), even without per-port LEDs
4839 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4840 && udev
->bus_mA
<= unit_load
) {
4843 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4846 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4849 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4851 "can't connect bus-powered hub "
4853 if (hub
->has_indicators
) {
4854 hub
->indicator
[port1
-1] =
4855 INDICATOR_AMBER_BLINK
;
4857 system_power_efficient_wq
,
4860 status
= -ENOTCONN
; /* Don't retry */
4865 /* check for devices running slower than they could */
4866 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4867 && udev
->speed
== USB_SPEED_FULL
4868 && highspeed_hubs
!= 0)
4869 check_highspeed(hub
, udev
, port1
);
4871 /* Store the parent's children[] pointer. At this point
4872 * udev becomes globally accessible, although presumably
4873 * no one will look at it until hdev is unlocked.
4877 mutex_lock(&usb_port_peer_mutex
);
4879 /* We mustn't add new devices if the parent hub has
4880 * been disconnected; we would race with the
4881 * recursively_mark_NOTATTACHED() routine.
4883 spin_lock_irq(&device_state_lock
);
4884 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4887 port_dev
->child
= udev
;
4888 spin_unlock_irq(&device_state_lock
);
4889 mutex_unlock(&usb_port_peer_mutex
);
4891 /* Run it through the hoops (find a driver, etc) */
4893 status
= usb_new_device(udev
);
4895 mutex_lock(&usb_port_peer_mutex
);
4896 spin_lock_irq(&device_state_lock
);
4897 port_dev
->child
= NULL
;
4898 spin_unlock_irq(&device_state_lock
);
4899 mutex_unlock(&usb_port_peer_mutex
);
4901 if (hcd
->usb_phy
&& !hdev
->parent
)
4902 usb_phy_notify_connect(hcd
->usb_phy
,
4910 status
= hub_power_remaining(hub
);
4912 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
4917 hub_port_disable(hub
, port1
, 1);
4919 usb_ep0_reinit(udev
);
4920 release_devnum(udev
);
4923 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4926 if (hub
->hdev
->parent
||
4927 !hcd
->driver
->port_handed_over
||
4928 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4929 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4930 dev_err(&port_dev
->dev
,
4931 "unable to enumerate USB device\n");
4935 hub_port_disable(hub
, port1
, 1);
4936 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4937 hcd
->driver
->relinquish_port(hcd
, port1
);
4941 /* Handle physical or logical connection change events.
4942 * This routine is called when:
4943 * a port connection-change occurs;
4944 * a port enable-change occurs (often caused by EMI);
4945 * usb_reset_and_verify_device() encounters changed descriptors (as from
4946 * a firmware download)
4947 * caller already locked the hub
4949 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4950 u16 portstatus
, u16 portchange
)
4951 __must_hold(&port_dev
->status_lock
)
4953 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4954 struct usb_device
*udev
= port_dev
->child
;
4955 int status
= -ENODEV
;
4957 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
4958 portchange
, portspeed(hub
, portstatus
));
4960 if (hub
->has_indicators
) {
4961 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4962 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4965 #ifdef CONFIG_USB_OTG
4966 /* during HNP, don't repeat the debounce */
4967 if (hub
->hdev
->bus
->is_b_host
)
4968 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4969 USB_PORT_STAT_C_ENABLE
);
4972 /* Try to resuscitate an existing device */
4973 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4974 udev
->state
!= USB_STATE_NOTATTACHED
) {
4975 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4976 status
= 0; /* Nothing to do */
4978 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4979 udev
->persist_enabled
) {
4980 /* For a suspended device, treat this as a
4981 * remote wakeup event.
4983 usb_unlock_port(port_dev
);
4984 status
= usb_remote_wakeup(udev
);
4985 usb_lock_port(port_dev
);
4988 /* Don't resuscitate */;
4991 clear_bit(port1
, hub
->change_bits
);
4993 /* successfully revalidated the connection */
4997 usb_unlock_port(port_dev
);
4998 hub_port_connect(hub
, port1
, portstatus
, portchange
);
4999 usb_lock_port(port_dev
);
5002 static void port_event(struct usb_hub
*hub
, int port1
)
5003 __must_hold(&port_dev
->status_lock
)
5006 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5007 struct usb_device
*udev
= port_dev
->child
;
5008 struct usb_device
*hdev
= hub
->hdev
;
5009 u16 portstatus
, portchange
;
5011 connect_change
= test_bit(port1
, hub
->change_bits
);
5012 clear_bit(port1
, hub
->event_bits
);
5013 clear_bit(port1
, hub
->wakeup_bits
);
5015 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5018 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5019 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5023 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5024 if (!connect_change
)
5025 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5027 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5030 * EM interference sometimes causes badly shielded USB devices
5031 * to be shutdown by the hub, this hack enables them again.
5032 * Works at least with mouse driver.
5034 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5035 && !connect_change
&& udev
) {
5036 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5041 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5042 u16 status
= 0, unused
;
5044 dev_dbg(&port_dev
->dev
, "over-current change\n");
5045 usb_clear_port_feature(hdev
, port1
,
5046 USB_PORT_FEAT_C_OVER_CURRENT
);
5047 msleep(100); /* Cool down */
5048 hub_power_on(hub
, true);
5049 hub_port_status(hub
, port1
, &status
, &unused
);
5050 if (status
& USB_PORT_STAT_OVERCURRENT
)
5051 dev_err(&port_dev
->dev
, "over-current condition\n");
5054 if (portchange
& USB_PORT_STAT_C_RESET
) {
5055 dev_dbg(&port_dev
->dev
, "reset change\n");
5056 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5058 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5059 && hub_is_superspeed(hdev
)) {
5060 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5061 usb_clear_port_feature(hdev
, port1
,
5062 USB_PORT_FEAT_C_BH_PORT_RESET
);
5064 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5065 dev_dbg(&port_dev
->dev
, "link state change\n");
5066 usb_clear_port_feature(hdev
, port1
,
5067 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5069 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5070 dev_warn(&port_dev
->dev
, "config error\n");
5071 usb_clear_port_feature(hdev
, port1
,
5072 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5075 /* skip port actions that require the port to be powered on */
5076 if (!pm_runtime_active(&port_dev
->dev
))
5079 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5083 * Warm reset a USB3 protocol port if it's in
5084 * SS.Inactive state.
5086 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5087 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5088 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5089 || udev
->state
== USB_STATE_NOTATTACHED
) {
5090 if (hub_port_reset(hub
, port1
, NULL
,
5091 HUB_BH_RESET_TIME
, true) < 0)
5092 hub_port_disable(hub
, port1
, 1);
5094 usb_unlock_port(port_dev
);
5095 usb_lock_device(udev
);
5096 usb_reset_device(udev
);
5097 usb_unlock_device(udev
);
5098 usb_lock_port(port_dev
);
5104 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5107 static void hub_event(struct work_struct
*work
)
5109 struct usb_device
*hdev
;
5110 struct usb_interface
*intf
;
5111 struct usb_hub
*hub
;
5112 struct device
*hub_dev
;
5117 hub
= container_of(work
, struct usb_hub
, events
);
5119 hub_dev
= hub
->intfdev
;
5120 intf
= to_usb_interface(hub_dev
);
5122 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5123 hdev
->state
, hdev
->maxchild
,
5124 /* NOTE: expects max 15 ports... */
5125 (u16
) hub
->change_bits
[0],
5126 (u16
) hub
->event_bits
[0]);
5128 /* Lock the device, then check to see if we were
5129 * disconnected while waiting for the lock to succeed. */
5130 usb_lock_device(hdev
);
5131 if (unlikely(hub
->disconnected
))
5134 /* If the hub has died, clean up after it */
5135 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5136 hub
->error
= -ENODEV
;
5137 hub_quiesce(hub
, HUB_DISCONNECT
);
5142 ret
= usb_autopm_get_interface(intf
);
5144 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5148 /* If this is an inactive hub, do nothing */
5153 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5155 ret
= usb_reset_device(hdev
);
5157 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5165 /* deal with port status changes */
5166 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5167 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5169 if (test_bit(i
, hub
->event_bits
)
5170 || test_bit(i
, hub
->change_bits
)
5171 || test_bit(i
, hub
->wakeup_bits
)) {
5173 * The get_noresume and barrier ensure that if
5174 * the port was in the process of resuming, we
5175 * flush that work and keep the port active for
5176 * the duration of the port_event(). However,
5177 * if the port is runtime pm suspended
5178 * (powered-off), we leave it in that state, run
5179 * an abbreviated port_event(), and move on.
5181 pm_runtime_get_noresume(&port_dev
->dev
);
5182 pm_runtime_barrier(&port_dev
->dev
);
5183 usb_lock_port(port_dev
);
5185 usb_unlock_port(port_dev
);
5186 pm_runtime_put_sync(&port_dev
->dev
);
5190 /* deal with hub status changes */
5191 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5193 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5194 dev_err(hub_dev
, "get_hub_status failed\n");
5196 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5197 dev_dbg(hub_dev
, "power change\n");
5198 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5199 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5200 /* FIXME: Is this always true? */
5201 hub
->limited_power
= 1;
5203 hub
->limited_power
= 0;
5205 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5209 dev_dbg(hub_dev
, "over-current change\n");
5210 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5211 msleep(500); /* Cool down */
5212 hub_power_on(hub
, true);
5213 hub_hub_status(hub
, &status
, &unused
);
5214 if (status
& HUB_STATUS_OVERCURRENT
)
5215 dev_err(hub_dev
, "over-current condition\n");
5220 /* Balance the usb_autopm_get_interface() above */
5221 usb_autopm_put_interface_no_suspend(intf
);
5223 usb_unlock_device(hdev
);
5225 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5226 usb_autopm_put_interface(intf
);
5227 kref_put(&hub
->kref
, hub_release
);
5230 static const struct usb_device_id hub_id_table
[] = {
5231 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5232 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5233 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5234 .bInterfaceClass
= USB_CLASS_HUB
,
5235 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5236 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5237 .bDeviceClass
= USB_CLASS_HUB
},
5238 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5239 .bInterfaceClass
= USB_CLASS_HUB
},
5240 { } /* Terminating entry */
5243 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5245 static struct usb_driver hub_driver
= {
5248 .disconnect
= hub_disconnect
,
5249 .suspend
= hub_suspend
,
5250 .resume
= hub_resume
,
5251 .reset_resume
= hub_reset_resume
,
5252 .pre_reset
= hub_pre_reset
,
5253 .post_reset
= hub_post_reset
,
5254 .unlocked_ioctl
= hub_ioctl
,
5255 .id_table
= hub_id_table
,
5256 .supports_autosuspend
= 1,
5259 int usb_hub_init(void)
5261 if (usb_register(&hub_driver
) < 0) {
5262 printk(KERN_ERR
"%s: can't register hub driver\n",
5268 * The workqueue needs to be freezable to avoid interfering with
5269 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5270 * device was gone before the EHCI controller had handed its port
5271 * over to the companion full-speed controller.
5273 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5277 /* Fall through if kernel_thread failed */
5278 usb_deregister(&hub_driver
);
5279 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5284 void usb_hub_cleanup(void)
5286 destroy_workqueue(hub_wq
);
5289 * Hub resources are freed for us by usb_deregister. It calls
5290 * usb_driver_purge on every device which in turn calls that
5291 * devices disconnect function if it is using this driver.
5292 * The hub_disconnect function takes care of releasing the
5293 * individual hub resources. -greg
5295 usb_deregister(&hub_driver
);
5296 } /* usb_hub_cleanup() */
5298 static int descriptors_changed(struct usb_device
*udev
,
5299 struct usb_device_descriptor
*old_device_descriptor
,
5300 struct usb_host_bos
*old_bos
)
5304 unsigned serial_len
= 0;
5306 unsigned old_length
;
5310 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5311 sizeof(*old_device_descriptor
)) != 0)
5314 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5317 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5318 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5320 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5324 /* Since the idVendor, idProduct, and bcdDevice values in the
5325 * device descriptor haven't changed, we will assume the
5326 * Manufacturer and Product strings haven't changed either.
5327 * But the SerialNumber string could be different (e.g., a
5328 * different flash card of the same brand).
5331 serial_len
= strlen(udev
->serial
) + 1;
5334 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5335 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5336 len
= max(len
, old_length
);
5339 buf
= kmalloc(len
, GFP_NOIO
);
5341 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5342 /* assume the worst */
5345 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5346 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5347 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5349 if (length
!= old_length
) {
5350 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5355 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5357 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5359 ((struct usb_config_descriptor
*) buf
)->
5360 bConfigurationValue
);
5366 if (!changed
&& serial_len
) {
5367 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5369 if (length
+ 1 != serial_len
) {
5370 dev_dbg(&udev
->dev
, "serial string error %d\n",
5373 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5374 dev_dbg(&udev
->dev
, "serial string changed\n");
5384 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5385 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5387 * WARNING - don't use this routine to reset a composite device
5388 * (one with multiple interfaces owned by separate drivers)!
5389 * Use usb_reset_device() instead.
5391 * Do a port reset, reassign the device's address, and establish its
5392 * former operating configuration. If the reset fails, or the device's
5393 * descriptors change from their values before the reset, or the original
5394 * configuration and altsettings cannot be restored, a flag will be set
5395 * telling hub_wq to pretend the device has been disconnected and then
5396 * re-connected. All drivers will be unbound, and the device will be
5397 * re-enumerated and probed all over again.
5399 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5400 * flagged for logical disconnection, or some other negative error code
5401 * if the reset wasn't even attempted.
5404 * The caller must own the device lock and the port lock, the latter is
5405 * taken by usb_reset_device(). For example, it's safe to use
5406 * usb_reset_device() from a driver probe() routine after downloading
5407 * new firmware. For calls that might not occur during probe(), drivers
5408 * should lock the device using usb_lock_device_for_reset().
5410 * Locking exception: This routine may also be called from within an
5411 * autoresume handler. Such usage won't conflict with other tasks
5412 * holding the device lock because these tasks should always call
5413 * usb_autopm_resume_device(), thereby preventing any unwanted
5414 * autoresume. The autoresume handler is expected to have already
5415 * acquired the port lock before calling this routine.
5417 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5419 struct usb_device
*parent_hdev
= udev
->parent
;
5420 struct usb_hub
*parent_hub
;
5421 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5422 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5423 struct usb_host_bos
*bos
;
5425 int port1
= udev
->portnum
;
5427 if (udev
->state
== USB_STATE_NOTATTACHED
||
5428 udev
->state
== USB_STATE_SUSPENDED
) {
5429 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5437 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5439 /* Disable USB2 hardware LPM.
5440 * It will be re-enabled by the enumeration process.
5442 if (udev
->usb2_hw_lpm_enabled
== 1)
5443 usb_set_usb2_hardware_lpm(udev
, 0);
5445 /* Disable LPM and LTM while we reset the device and reinstall the alt
5446 * settings. Device-initiated LPM settings, and system exit latency
5447 * settings are cleared when the device is reset, so we have to set
5450 ret
= usb_unlocked_disable_lpm(udev
);
5452 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5453 goto re_enumerate_no_bos
;
5455 ret
= usb_disable_ltm(udev
);
5457 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5459 goto re_enumerate_no_bos
;
5465 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5467 /* ep0 maxpacket size may change; let the HCD know about it.
5468 * Other endpoints will be handled by re-enumeration. */
5469 usb_ep0_reinit(udev
);
5470 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5471 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5478 /* Device might have changed firmware (DFU or similar) */
5479 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5480 dev_info(&udev
->dev
, "device firmware changed\n");
5481 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5485 /* Restore the device's previous configuration */
5486 if (!udev
->actconfig
)
5489 mutex_lock(hcd
->bandwidth_mutex
);
5490 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5492 dev_warn(&udev
->dev
,
5493 "Busted HC? Not enough HCD resources for "
5494 "old configuration.\n");
5495 mutex_unlock(hcd
->bandwidth_mutex
);
5498 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5499 USB_REQ_SET_CONFIGURATION
, 0,
5500 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5501 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5504 "can't restore configuration #%d (error=%d)\n",
5505 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5506 mutex_unlock(hcd
->bandwidth_mutex
);
5509 mutex_unlock(hcd
->bandwidth_mutex
);
5510 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5512 /* Put interfaces back into the same altsettings as before.
5513 * Don't bother to send the Set-Interface request for interfaces
5514 * that were already in altsetting 0; besides being unnecessary,
5515 * many devices can't handle it. Instead just reset the host-side
5518 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5519 struct usb_host_config
*config
= udev
->actconfig
;
5520 struct usb_interface
*intf
= config
->interface
[i
];
5521 struct usb_interface_descriptor
*desc
;
5523 desc
= &intf
->cur_altsetting
->desc
;
5524 if (desc
->bAlternateSetting
== 0) {
5525 usb_disable_interface(udev
, intf
, true);
5526 usb_enable_interface(udev
, intf
, true);
5529 /* Let the bandwidth allocation function know that this
5530 * device has been reset, and it will have to use
5531 * alternate setting 0 as the current alternate setting.
5533 intf
->resetting_device
= 1;
5534 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5535 desc
->bAlternateSetting
);
5536 intf
->resetting_device
= 0;
5539 dev_err(&udev
->dev
, "failed to restore interface %d "
5540 "altsetting %d (error=%d)\n",
5541 desc
->bInterfaceNumber
,
5542 desc
->bAlternateSetting
,
5546 /* Resetting also frees any allocated streams */
5547 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5548 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5552 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5553 usb_set_usb2_hardware_lpm(udev
, 1);
5554 usb_unlocked_enable_lpm(udev
);
5555 usb_enable_ltm(udev
);
5556 usb_release_bos_descriptor(udev
);
5561 usb_release_bos_descriptor(udev
);
5563 re_enumerate_no_bos
:
5564 /* LPM state doesn't matter when we're about to destroy the device. */
5565 hub_port_logical_disconnect(parent_hub
, port1
);
5570 * usb_reset_device - warn interface drivers and perform a USB port reset
5571 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5573 * Warns all drivers bound to registered interfaces (using their pre_reset
5574 * method), performs the port reset, and then lets the drivers know that
5575 * the reset is over (using their post_reset method).
5577 * Return: The same as for usb_reset_and_verify_device().
5580 * The caller must own the device lock. For example, it's safe to use
5581 * this from a driver probe() routine after downloading new firmware.
5582 * For calls that might not occur during probe(), drivers should lock
5583 * the device using usb_lock_device_for_reset().
5585 * If an interface is currently being probed or disconnected, we assume
5586 * its driver knows how to handle resets. For all other interfaces,
5587 * if the driver doesn't have pre_reset and post_reset methods then
5588 * we attempt to unbind it and rebind afterward.
5590 int usb_reset_device(struct usb_device
*udev
)
5594 unsigned int noio_flag
;
5595 struct usb_port
*port_dev
;
5596 struct usb_host_config
*config
= udev
->actconfig
;
5597 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5599 if (udev
->state
== USB_STATE_NOTATTACHED
||
5600 udev
->state
== USB_STATE_SUSPENDED
) {
5601 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5606 if (!udev
->parent
) {
5607 /* this requires hcd-specific logic; see ohci_restart() */
5608 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5612 port_dev
= hub
->ports
[udev
->portnum
- 1];
5615 * Don't allocate memory with GFP_KERNEL in current
5616 * context to avoid possible deadlock if usb mass
5617 * storage interface or usbnet interface(iSCSI case)
5618 * is included in current configuration. The easist
5619 * approach is to do it for every device reset,
5620 * because the device 'memalloc_noio' flag may have
5621 * not been set before reseting the usb device.
5623 noio_flag
= memalloc_noio_save();
5625 /* Prevent autosuspend during the reset */
5626 usb_autoresume_device(udev
);
5629 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5630 struct usb_interface
*cintf
= config
->interface
[i
];
5631 struct usb_driver
*drv
;
5634 if (cintf
->dev
.driver
) {
5635 drv
= to_usb_driver(cintf
->dev
.driver
);
5636 if (drv
->pre_reset
&& drv
->post_reset
)
5637 unbind
= (drv
->pre_reset
)(cintf
);
5638 else if (cintf
->condition
==
5639 USB_INTERFACE_BOUND
)
5642 usb_forced_unbind_intf(cintf
);
5647 usb_lock_port(port_dev
);
5648 ret
= usb_reset_and_verify_device(udev
);
5649 usb_unlock_port(port_dev
);
5652 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5653 struct usb_interface
*cintf
= config
->interface
[i
];
5654 struct usb_driver
*drv
;
5655 int rebind
= cintf
->needs_binding
;
5657 if (!rebind
&& cintf
->dev
.driver
) {
5658 drv
= to_usb_driver(cintf
->dev
.driver
);
5659 if (drv
->post_reset
)
5660 rebind
= (drv
->post_reset
)(cintf
);
5661 else if (cintf
->condition
==
5662 USB_INTERFACE_BOUND
)
5665 cintf
->needs_binding
= 1;
5668 usb_unbind_and_rebind_marked_interfaces(udev
);
5671 usb_autosuspend_device(udev
);
5672 memalloc_noio_restore(noio_flag
);
5675 EXPORT_SYMBOL_GPL(usb_reset_device
);
5679 * usb_queue_reset_device - Reset a USB device from an atomic context
5680 * @iface: USB interface belonging to the device to reset
5682 * This function can be used to reset a USB device from an atomic
5683 * context, where usb_reset_device() won't work (as it blocks).
5685 * Doing a reset via this method is functionally equivalent to calling
5686 * usb_reset_device(), except for the fact that it is delayed to a
5687 * workqueue. This means that any drivers bound to other interfaces
5688 * might be unbound, as well as users from usbfs in user space.
5692 * - Scheduling two resets at the same time from two different drivers
5693 * attached to two different interfaces of the same device is
5694 * possible; depending on how the driver attached to each interface
5695 * handles ->pre_reset(), the second reset might happen or not.
5697 * - If the reset is delayed so long that the interface is unbound from
5698 * its driver, the reset will be skipped.
5700 * - This function can be called during .probe(). It can also be called
5701 * during .disconnect(), but doing so is pointless because the reset
5702 * will not occur. If you really want to reset the device during
5703 * .disconnect(), call usb_reset_device() directly -- but watch out
5704 * for nested unbinding issues!
5706 void usb_queue_reset_device(struct usb_interface
*iface
)
5708 if (schedule_work(&iface
->reset_ws
))
5709 usb_get_intf(iface
);
5711 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5714 * usb_hub_find_child - Get the pointer of child device
5715 * attached to the port which is specified by @port1.
5716 * @hdev: USB device belonging to the usb hub
5717 * @port1: port num to indicate which port the child device
5720 * USB drivers call this function to get hub's child device
5723 * Return: %NULL if input param is invalid and
5724 * child's usb_device pointer if non-NULL.
5726 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5729 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5731 if (port1
< 1 || port1
> hdev
->maxchild
)
5733 return hub
->ports
[port1
- 1]->child
;
5735 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5737 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5738 struct usb_hub_descriptor
*desc
)
5740 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5741 enum usb_port_connect_type connect_type
;
5747 if (!hub_is_superspeed(hdev
)) {
5748 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5749 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5751 connect_type
= port_dev
->connect_type
;
5752 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5753 u8 mask
= 1 << (i
%8);
5755 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5756 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5757 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5762 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5764 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5765 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5767 connect_type
= port_dev
->connect_type
;
5768 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5771 if (!(port_removable
& mask
)) {
5772 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5773 port_removable
|= mask
;
5778 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5784 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5785 * @hdev: USB device belonging to the usb hub
5786 * @port1: port num of the port
5788 * Return: Port's acpi handle if successful, %NULL if params are
5791 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5794 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5799 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);