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"
35 #if defined(CONFIG_USB_OTG_WHITELIST_FOR_MDM)
36 #include "otg_whitelist_for_mdm.h"
39 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
40 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
42 extern int deny_new_usb
;
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock
);
49 /* workqueue to process hub events */
50 static struct workqueue_struct
*hub_wq
;
51 static void hub_event(struct work_struct
*work
);
53 /* synchronize hub-port add/remove and peering operations */
54 DEFINE_MUTEX(usb_port_peer_mutex
);
56 /* cycle leds on hubs that aren't blinking for attention */
57 static bool blinkenlights
= 0;
58 module_param(blinkenlights
, bool, S_IRUGO
);
59 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
62 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
63 * 10 seconds to send reply for the initial 64-byte descriptor request.
65 /* define initial 64-byte descriptor request timeout in milliseconds */
66 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
67 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
68 MODULE_PARM_DESC(initial_descriptor_timeout
,
69 "initial 64-byte descriptor request timeout in milliseconds "
70 "(default 5000 - 5.0 seconds)");
73 * As of 2.6.10 we introduce a new USB device initialization scheme which
74 * closely resembles the way Windows works. Hopefully it will be compatible
75 * with a wider range of devices than the old scheme. However some previously
76 * working devices may start giving rise to "device not accepting address"
77 * errors; if that happens the user can try the old scheme by adjusting the
78 * following module parameters.
80 * For maximum flexibility there are two boolean parameters to control the
81 * hub driver's behavior. On the first initialization attempt, if the
82 * "old_scheme_first" parameter is set then the old scheme will be used,
83 * otherwise the new scheme is used. If that fails and "use_both_schemes"
84 * is set, then the driver will make another attempt, using the other scheme.
86 static bool old_scheme_first
= 0;
87 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
88 MODULE_PARM_DESC(old_scheme_first
,
89 "start with the old device initialization scheme");
91 static bool use_both_schemes
= 1;
92 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
93 MODULE_PARM_DESC(use_both_schemes
,
94 "try the other device initialization scheme if the "
97 /* Mutual exclusion for EHCI CF initialization. This interferes with
98 * port reset on some companion controllers.
100 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
101 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
103 #define HUB_DEBOUNCE_TIMEOUT 2000
104 #define HUB_DEBOUNCE_STEP 25
105 #define HUB_DEBOUNCE_STABLE 100
107 static void hub_release(struct kref
*kref
);
108 static int usb_reset_and_verify_device(struct usb_device
*udev
);
109 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
111 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
113 if (hub_is_superspeed(hub
->hdev
))
115 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
117 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
123 /* Note that hdev or one of its children must be locked! */
124 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
126 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
128 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
131 int usb_device_supports_lpm(struct usb_device
*udev
)
133 /* Some devices have trouble with LPM */
134 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
137 /* USB 2.1 (and greater) devices indicate LPM support through
138 * their USB 2.0 Extended Capabilities BOS descriptor.
140 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
141 if (udev
->bos
->ext_cap
&&
143 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
149 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
150 * However, there are some that don't, and they set the U1/U2 exit
153 if (!udev
->bos
->ss_cap
) {
154 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
158 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
159 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
161 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
163 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
167 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
173 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
176 static void usb_set_lpm_mel(struct usb_device
*udev
,
177 struct usb3_lpm_parameters
*udev_lpm_params
,
178 unsigned int udev_exit_latency
,
180 struct usb3_lpm_parameters
*hub_lpm_params
,
181 unsigned int hub_exit_latency
)
183 unsigned int total_mel
;
184 unsigned int device_mel
;
185 unsigned int hub_mel
;
188 * Calculate the time it takes to transition all links from the roothub
189 * to the parent hub into U0. The parent hub must then decode the
190 * packet (hub header decode latency) to figure out which port it was
193 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
194 * means 0.1us). Multiply that by 100 to get nanoseconds.
196 total_mel
= hub_lpm_params
->mel
+
197 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
200 * How long will it take to transition the downstream hub's port into
201 * U0? The greater of either the hub exit latency or the device exit
204 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
205 * Multiply that by 1000 to get nanoseconds.
207 device_mel
= udev_exit_latency
* 1000;
208 hub_mel
= hub_exit_latency
* 1000;
209 if (device_mel
> hub_mel
)
210 total_mel
+= device_mel
;
212 total_mel
+= hub_mel
;
214 udev_lpm_params
->mel
= total_mel
;
218 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
219 * a transition from either U1 or U2.
221 static void usb_set_lpm_pel(struct usb_device
*udev
,
222 struct usb3_lpm_parameters
*udev_lpm_params
,
223 unsigned int udev_exit_latency
,
225 struct usb3_lpm_parameters
*hub_lpm_params
,
226 unsigned int hub_exit_latency
,
227 unsigned int port_to_port_exit_latency
)
229 unsigned int first_link_pel
;
230 unsigned int hub_pel
;
233 * First, the device sends an LFPS to transition the link between the
234 * device and the parent hub into U0. The exit latency is the bigger of
235 * the device exit latency or the hub exit latency.
237 if (udev_exit_latency
> hub_exit_latency
)
238 first_link_pel
= udev_exit_latency
* 1000;
240 first_link_pel
= hub_exit_latency
* 1000;
243 * When the hub starts to receive the LFPS, there is a slight delay for
244 * it to figure out that one of the ports is sending an LFPS. Then it
245 * will forward the LFPS to its upstream link. The exit latency is the
246 * delay, plus the PEL that we calculated for this hub.
248 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
251 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
252 * is the greater of the two exit latencies.
254 if (first_link_pel
> hub_pel
)
255 udev_lpm_params
->pel
= first_link_pel
;
257 udev_lpm_params
->pel
= hub_pel
;
261 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
262 * when a device initiates a transition to U0, until when it will receive the
263 * first packet from the host controller.
265 * Section C.1.5.1 describes the four components to this:
267 * - t2: time for the ERDY to make it from the device to the host.
268 * - t3: a host-specific delay to process the ERDY.
269 * - t4: time for the packet to make it from the host to the device.
271 * t3 is specific to both the xHCI host and the platform the host is integrated
272 * into. The Intel HW folks have said it's negligible, FIXME if a different
273 * vendor says otherwise.
275 static void usb_set_lpm_sel(struct usb_device
*udev
,
276 struct usb3_lpm_parameters
*udev_lpm_params
)
278 struct usb_device
*parent
;
279 unsigned int num_hubs
;
280 unsigned int total_sel
;
282 /* t1 = device PEL */
283 total_sel
= udev_lpm_params
->pel
;
284 /* How many external hubs are in between the device & the root port. */
285 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
286 parent
= parent
->parent
)
288 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
290 total_sel
+= 2100 + 250 * (num_hubs
- 1);
292 /* t4 = 250ns * num_hubs */
293 total_sel
+= 250 * num_hubs
;
295 udev_lpm_params
->sel
= total_sel
;
298 static void usb_set_lpm_parameters(struct usb_device
*udev
)
301 unsigned int port_to_port_delay
;
302 unsigned int udev_u1_del
;
303 unsigned int udev_u2_del
;
304 unsigned int hub_u1_del
;
305 unsigned int hub_u2_del
;
307 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
310 hub
= usb_hub_to_struct_hub(udev
->parent
);
311 /* It doesn't take time to transition the roothub into U0, since it
312 * doesn't have an upstream link.
317 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
318 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
319 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
320 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
322 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
323 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
325 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
326 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
329 * Appendix C, section C.2.2.2, says that there is a slight delay from
330 * when the parent hub notices the downstream port is trying to
331 * transition to U0 to when the hub initiates a U0 transition on its
332 * upstream port. The section says the delays are tPort2PortU1EL and
333 * tPort2PortU2EL, but it doesn't define what they are.
335 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
336 * about the same delays. Use the maximum delay calculations from those
337 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
338 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
339 * assume the device exit latencies they are talking about are the hub
342 * What do we do if the U2 exit latency is less than the U1 exit
343 * latency? It's possible, although not likely...
345 port_to_port_delay
= 1;
347 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
348 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
351 if (hub_u2_del
> hub_u1_del
)
352 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
354 port_to_port_delay
= 1 + hub_u1_del
;
356 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
357 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
360 /* Now that we've got PEL, calculate SEL. */
361 usb_set_lpm_sel(udev
, &udev
->u1_params
);
362 usb_set_lpm_sel(udev
, &udev
->u2_params
);
365 /* USB 2.0 spec Section 11.24.4.5 */
366 static int get_hub_descriptor(struct usb_device
*hdev
,
367 struct usb_hub_descriptor
*desc
)
372 if (hub_is_superspeed(hdev
)) {
373 dtype
= USB_DT_SS_HUB
;
374 size
= USB_DT_SS_HUB_SIZE
;
377 size
= sizeof(struct usb_hub_descriptor
);
380 for (i
= 0; i
< 3; i
++) {
381 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
382 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
383 dtype
<< 8, 0, desc
, size
,
384 USB_CTRL_GET_TIMEOUT
);
385 if (hub_is_superspeed(hdev
)) {
388 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
389 /* Make sure we have the DeviceRemovable field. */
390 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
400 * USB 2.0 spec Section 11.24.2.1
402 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
404 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
405 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
409 * USB 2.0 spec Section 11.24.2.2
411 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
413 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
414 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
419 * USB 2.0 spec Section 11.24.2.13
421 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
423 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
424 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
428 static char *to_led_name(int selector
)
445 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
446 * for info about using port indicators
448 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
450 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
453 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
454 USB_PORT_FEAT_INDICATOR
);
455 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
456 to_led_name(selector
), status
);
459 #define LED_CYCLE_PERIOD ((2*HZ)/3)
461 static void led_work(struct work_struct
*work
)
463 struct usb_hub
*hub
=
464 container_of(work
, struct usb_hub
, leds
.work
);
465 struct usb_device
*hdev
= hub
->hdev
;
467 unsigned changed
= 0;
470 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
473 for (i
= 0; i
< hdev
->maxchild
; i
++) {
474 unsigned selector
, mode
;
476 /* 30%-50% duty cycle */
478 switch (hub
->indicator
[i
]) {
480 case INDICATOR_CYCLE
:
482 selector
= HUB_LED_AUTO
;
483 mode
= INDICATOR_AUTO
;
485 /* blinking green = sw attention */
486 case INDICATOR_GREEN_BLINK
:
487 selector
= HUB_LED_GREEN
;
488 mode
= INDICATOR_GREEN_BLINK_OFF
;
490 case INDICATOR_GREEN_BLINK_OFF
:
491 selector
= HUB_LED_OFF
;
492 mode
= INDICATOR_GREEN_BLINK
;
494 /* blinking amber = hw attention */
495 case INDICATOR_AMBER_BLINK
:
496 selector
= HUB_LED_AMBER
;
497 mode
= INDICATOR_AMBER_BLINK_OFF
;
499 case INDICATOR_AMBER_BLINK_OFF
:
500 selector
= HUB_LED_OFF
;
501 mode
= INDICATOR_AMBER_BLINK
;
503 /* blink green/amber = reserved */
504 case INDICATOR_ALT_BLINK
:
505 selector
= HUB_LED_GREEN
;
506 mode
= INDICATOR_ALT_BLINK_OFF
;
508 case INDICATOR_ALT_BLINK_OFF
:
509 selector
= HUB_LED_AMBER
;
510 mode
= INDICATOR_ALT_BLINK
;
515 if (selector
!= HUB_LED_AUTO
)
517 set_port_led(hub
, i
+ 1, selector
);
518 hub
->indicator
[i
] = mode
;
520 if (!changed
&& blinkenlights
) {
522 cursor
%= hdev
->maxchild
;
523 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
524 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
528 queue_delayed_work(system_power_efficient_wq
,
529 &hub
->leds
, LED_CYCLE_PERIOD
);
532 /* use a short timeout for hub/port status fetches */
533 #define USB_STS_TIMEOUT 1000
534 #define USB_STS_RETRIES 5
537 * USB 2.0 spec Section 11.24.2.6
539 static int get_hub_status(struct usb_device
*hdev
,
540 struct usb_hub_status
*data
)
542 int i
, status
= -ETIMEDOUT
;
544 for (i
= 0; i
< USB_STS_RETRIES
&&
545 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
546 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
547 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
548 data
, sizeof(*data
), USB_STS_TIMEOUT
);
554 * USB 2.0 spec Section 11.24.2.7
556 static int get_port_status(struct usb_device
*hdev
, int port1
,
557 struct usb_port_status
*data
)
559 int i
, status
= -ETIMEDOUT
;
561 for (i
= 0; i
< USB_STS_RETRIES
&&
562 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
563 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
564 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
565 data
, sizeof(*data
), USB_STS_TIMEOUT
);
570 static int hub_port_status(struct usb_hub
*hub
, int port1
,
571 u16
*status
, u16
*change
)
575 mutex_lock(&hub
->status_mutex
);
576 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
579 dev_err(hub
->intfdev
,
580 "%s failed (err = %d)\n", __func__
, ret
);
584 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
585 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
589 mutex_unlock(&hub
->status_mutex
);
593 static void kick_hub_wq(struct usb_hub
*hub
)
595 struct usb_interface
*intf
;
597 if (hub
->disconnected
|| work_pending(&hub
->events
))
601 * Suppress autosuspend until the event is proceed.
603 * Be careful and make sure that the symmetric operation is
604 * always called. We are here only when there is no pending
605 * work for this hub. Therefore put the interface either when
606 * the new work is called or when it is canceled.
608 intf
= to_usb_interface(hub
->intfdev
);
609 usb_autopm_get_interface_no_resume(intf
);
610 kref_get(&hub
->kref
);
612 if (queue_work(hub_wq
, &hub
->events
))
615 /* the work has already been scheduled */
616 usb_autopm_put_interface_async(intf
);
617 kref_put(&hub
->kref
, hub_release
);
620 void usb_kick_hub_wq(struct usb_device
*hdev
)
622 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
629 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
630 * Notification, which indicates it had initiated remote wakeup.
632 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
633 * device initiates resume, so the USB core will not receive notice of the
634 * resume through the normal hub interrupt URB.
636 void usb_wakeup_notification(struct usb_device
*hdev
,
637 unsigned int portnum
)
644 hub
= usb_hub_to_struct_hub(hdev
);
646 set_bit(portnum
, hub
->wakeup_bits
);
650 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
652 /* completion function, fires on port status changes and various faults */
653 static void hub_irq(struct urb
*urb
)
655 struct usb_hub
*hub
= urb
->context
;
656 int status
= urb
->status
;
661 case -ENOENT
: /* synchronous unlink */
662 case -ECONNRESET
: /* async unlink */
663 case -ESHUTDOWN
: /* hardware going away */
666 default: /* presumably an error */
667 /* Cause a hub reset after 10 consecutive errors */
668 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
669 if ((++hub
->nerrors
< 10) || hub
->error
)
674 /* let hub_wq handle things */
675 case 0: /* we got data: port status changed */
677 for (i
= 0; i
< urb
->actual_length
; ++i
)
678 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
680 hub
->event_bits
[0] = bits
;
686 /* Something happened, let hub_wq figure it out */
693 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
694 if (status
!= 0 && status
!= -ENODEV
&& status
!= -EPERM
)
695 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
698 /* USB 2.0 spec Section 11.24.2.3 */
700 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
702 /* Need to clear both directions for control ep */
703 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
704 USB_ENDPOINT_XFER_CONTROL
) {
705 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
706 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
707 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
711 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
712 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
717 * enumeration blocks hub_wq for a long time. we use keventd instead, since
718 * long blocking there is the exception, not the rule. accordingly, HCDs
719 * talking to TTs must queue control transfers (not just bulk and iso), so
720 * both can talk to the same hub concurrently.
722 static void hub_tt_work(struct work_struct
*work
)
724 struct usb_hub
*hub
=
725 container_of(work
, struct usb_hub
, tt
.clear_work
);
728 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
729 while (!list_empty(&hub
->tt
.clear_list
)) {
730 struct list_head
*next
;
731 struct usb_tt_clear
*clear
;
732 struct usb_device
*hdev
= hub
->hdev
;
733 const struct hc_driver
*drv
;
736 next
= hub
->tt
.clear_list
.next
;
737 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
738 list_del(&clear
->clear_list
);
740 /* drop lock so HCD can concurrently report other TT errors */
741 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
742 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
743 if (status
&& status
!= -ENODEV
)
745 "clear tt %d (%04x) error %d\n",
746 clear
->tt
, clear
->devinfo
, status
);
748 /* Tell the HCD, even if the operation failed */
749 drv
= clear
->hcd
->driver
;
750 if (drv
->clear_tt_buffer_complete
)
751 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
754 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
756 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
760 * usb_hub_set_port_power - control hub port's power state
761 * @hdev: USB device belonging to the usb hub
764 * @set: expected status
766 * call this function to control port's power via setting or
767 * clearing the port's PORT_POWER feature.
769 * Return: 0 if successful. A negative error code otherwise.
771 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
777 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
779 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
785 set_bit(port1
, hub
->power_bits
);
787 clear_bit(port1
, hub
->power_bits
);
792 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
793 * @urb: an URB associated with the failed or incomplete split transaction
795 * High speed HCDs use this to tell the hub driver that some split control or
796 * bulk transaction failed in a way that requires clearing internal state of
797 * a transaction translator. This is normally detected (and reported) from
800 * It may not be possible for that hub to handle additional full (or low)
801 * speed transactions until that state is fully cleared out.
803 * Return: 0 if successful. A negative error code otherwise.
805 int usb_hub_clear_tt_buffer(struct urb
*urb
)
807 struct usb_device
*udev
= urb
->dev
;
808 int pipe
= urb
->pipe
;
809 struct usb_tt
*tt
= udev
->tt
;
811 struct usb_tt_clear
*clear
;
813 /* we've got to cope with an arbitrary number of pending TT clears,
814 * since each TT has "at least two" buffers that can need it (and
815 * there can be many TTs per hub). even if they're uncommon.
817 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
819 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
820 /* FIXME recover somehow ... RESET_TT? */
824 /* info that CLEAR_TT_BUFFER needs */
825 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
826 clear
->devinfo
= usb_pipeendpoint (pipe
);
827 clear
->devinfo
|= udev
->devnum
<< 4;
828 clear
->devinfo
|= usb_pipecontrol(pipe
)
829 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
830 : (USB_ENDPOINT_XFER_BULK
<< 11);
831 if (usb_pipein(pipe
))
832 clear
->devinfo
|= 1 << 15;
834 /* info for completion callback */
835 clear
->hcd
= bus_to_hcd(udev
->bus
);
838 /* tell keventd to clear state for this TT */
839 spin_lock_irqsave(&tt
->lock
, flags
);
840 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
841 schedule_work(&tt
->clear_work
);
842 spin_unlock_irqrestore(&tt
->lock
, flags
);
845 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
847 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
851 /* Enable power on each port. Some hubs have reserved values
852 * of LPSM (> 2) in their descriptors, even though they are
853 * USB 2.0 hubs. Some hubs do not implement port-power switching
854 * but only emulate it. In all cases, the ports won't work
855 * unless we send these messages to the hub.
857 if (hub_is_port_power_switchable(hub
))
858 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
860 dev_dbg(hub
->intfdev
, "trying to enable port power on "
861 "non-switchable hub\n");
862 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
863 if (test_bit(port1
, hub
->power_bits
))
864 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
866 usb_clear_port_feature(hub
->hdev
, port1
,
867 USB_PORT_FEAT_POWER
);
869 msleep(hub_power_on_good_delay(hub
));
872 static int hub_hub_status(struct usb_hub
*hub
,
873 u16
*status
, u16
*change
)
877 mutex_lock(&hub
->status_mutex
);
878 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
881 dev_err(hub
->intfdev
,
882 "%s failed (err = %d)\n", __func__
, ret
);
884 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
885 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
888 mutex_unlock(&hub
->status_mutex
);
892 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
893 unsigned int link_status
)
895 return set_port_feature(hub
->hdev
,
896 port1
| (link_status
<< 3),
897 USB_PORT_FEAT_LINK_STATE
);
901 * Disable a port and mark a logical connect-change event, so that some
902 * time later hub_wq will disconnect() any existing usb_device on the port
903 * and will re-enumerate if there actually is a device attached.
905 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
907 #ifdef CONFIG_USB_DEBUG_DETAILED_LOG
908 dev_info(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
910 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
912 hub_port_disable(hub
, port1
, 1);
914 /* FIXME let caller ask to power down the port:
915 * - some devices won't enumerate without a VBUS power cycle
916 * - SRP saves power that way
917 * - ... new call, TBD ...
918 * That's easy if this hub can switch power per-port, and
919 * hub_wq reactivates the port later (timer, SRP, etc).
920 * Powerdown must be optional, because of reset/DFU.
923 set_bit(port1
, hub
->change_bits
);
928 * usb_remove_device - disable a device's port on its parent hub
929 * @udev: device to be disabled and removed
930 * Context: @udev locked, must be able to sleep.
932 * After @udev's port has been disabled, hub_wq is notified and it will
933 * see that the device has been disconnected. When the device is
934 * physically unplugged and something is plugged in, the events will
935 * be received and processed normally.
937 * Return: 0 if successful. A negative error code otherwise.
939 int usb_remove_device(struct usb_device
*udev
)
942 struct usb_interface
*intf
;
944 if (!udev
->parent
) /* Can't remove a root hub */
946 hub
= usb_hub_to_struct_hub(udev
->parent
);
947 intf
= to_usb_interface(hub
->intfdev
);
949 usb_autopm_get_interface(intf
);
950 set_bit(udev
->portnum
, hub
->removed_bits
);
951 hub_port_logical_disconnect(hub
, udev
->portnum
);
952 usb_autopm_put_interface(intf
);
956 enum hub_activation_type
{
957 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
958 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
961 static void hub_init_func2(struct work_struct
*ws
);
962 static void hub_init_func3(struct work_struct
*ws
);
964 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
966 struct usb_device
*hdev
= hub
->hdev
;
971 bool need_debounce_delay
= false;
974 /* Continue a partial initialization */
975 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
976 device_lock(&hdev
->dev
);
978 /* Was the hub disconnected while we were waiting? */
979 if (hub
->disconnected
)
981 if (type
== HUB_INIT2
)
985 kref_get(&hub
->kref
);
987 /* The superspeed hub except for root hub has to use Hub Depth
988 * value as an offset into the route string to locate the bits
989 * it uses to determine the downstream port number. So hub driver
990 * should send a set hub depth request to superspeed hub after
991 * the superspeed hub is set configuration in initialization or
994 * After a resume, port power should still be on.
995 * For any other type of activation, turn it on.
997 if (type
!= HUB_RESUME
) {
998 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
999 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1000 HUB_SET_DEPTH
, USB_RT_HUB
,
1001 hdev
->level
- 1, 0, NULL
, 0,
1002 USB_CTRL_SET_TIMEOUT
);
1004 dev_err(hub
->intfdev
,
1005 "set hub depth failed\n");
1008 /* Speed up system boot by using a delayed_work for the
1009 * hub's initial power-up delays. This is pretty awkward
1010 * and the implementation looks like a home-brewed sort of
1011 * setjmp/longjmp, but it saves at least 100 ms for each
1012 * root hub (assuming usbcore is compiled into the kernel
1013 * rather than as a module). It adds up.
1015 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1016 * because for those activation types the ports have to be
1017 * operational when we return. In theory this could be done
1018 * for HUB_POST_RESET, but it's easier not to.
1020 if (type
== HUB_INIT
) {
1021 delay
= hub_power_on_good_delay(hub
);
1023 hub_power_on(hub
, false);
1024 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1025 queue_delayed_work(system_power_efficient_wq
,
1027 msecs_to_jiffies(delay
));
1029 /* Suppress autosuspend until init is done */
1030 usb_autopm_get_interface_no_resume(
1031 to_usb_interface(hub
->intfdev
));
1032 return; /* Continues at init2: below */
1033 } else if (type
== HUB_RESET_RESUME
) {
1034 /* The internal host controller state for the hub device
1035 * may be gone after a host power loss on system resume.
1036 * Update the device's info so the HW knows it's a hub.
1038 hcd
= bus_to_hcd(hdev
->bus
);
1039 if (hcd
->driver
->update_hub_device
) {
1040 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1041 &hub
->tt
, GFP_NOIO
);
1043 dev_err(hub
->intfdev
, "Host not "
1044 "accepting hub info "
1046 dev_err(hub
->intfdev
, "LS/FS devices "
1047 "and hubs may not work "
1048 "under this hub\n.");
1051 hub_power_on(hub
, true);
1053 hub_power_on(hub
, true);
1059 * Check each port and set hub->change_bits to let hub_wq know
1060 * which ports need attention.
1062 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1063 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1064 struct usb_device
*udev
= port_dev
->child
;
1065 u16 portstatus
, portchange
;
1067 portstatus
= portchange
= 0;
1068 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1072 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1073 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1074 portstatus
, portchange
);
1077 * After anything other than HUB_RESUME (i.e., initialization
1078 * or any sort of reset), every port should be disabled.
1079 * Unconnected ports should likewise be disabled (paranoia),
1080 * and so should ports for which we have no usb_device.
1082 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1083 type
!= HUB_RESUME
||
1084 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1086 udev
->state
== USB_STATE_NOTATTACHED
)) {
1088 * USB3 protocol ports will automatically transition
1089 * to Enabled state when detect an USB3.0 device attach.
1090 * Do not disable USB3 protocol ports, just pretend
1093 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1094 if (!hub_is_superspeed(hdev
))
1095 usb_clear_port_feature(hdev
, port1
,
1096 USB_PORT_FEAT_ENABLE
);
1099 /* Clear status-change flags; we'll debounce later */
1100 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1101 need_debounce_delay
= true;
1102 usb_clear_port_feature(hub
->hdev
, port1
,
1103 USB_PORT_FEAT_C_CONNECTION
);
1105 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1106 need_debounce_delay
= true;
1107 usb_clear_port_feature(hub
->hdev
, port1
,
1108 USB_PORT_FEAT_C_ENABLE
);
1110 if (portchange
& USB_PORT_STAT_C_RESET
) {
1111 need_debounce_delay
= true;
1112 usb_clear_port_feature(hub
->hdev
, port1
,
1113 USB_PORT_FEAT_C_RESET
);
1115 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1116 hub_is_superspeed(hub
->hdev
)) {
1117 need_debounce_delay
= true;
1118 usb_clear_port_feature(hub
->hdev
, port1
,
1119 USB_PORT_FEAT_C_BH_PORT_RESET
);
1121 /* We can forget about a "removed" device when there's a
1122 * physical disconnect or the connect status changes.
1124 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1125 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1126 clear_bit(port1
, hub
->removed_bits
);
1128 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1129 /* Tell hub_wq to disconnect the device or
1130 * check for a new connection
1132 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1133 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1134 set_bit(port1
, hub
->change_bits
);
1136 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1137 bool port_resumed
= (portstatus
&
1138 USB_PORT_STAT_LINK_STATE
) ==
1140 /* The power session apparently survived the resume.
1141 * If there was an overcurrent or suspend change
1142 * (i.e., remote wakeup request), have hub_wq
1143 * take care of it. Look at the port link state
1144 * for USB 3.0 hubs, since they don't have a suspend
1145 * change bit, and they don't set the port link change
1146 * bit on device-initiated resume.
1148 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1150 set_bit(port1
, hub
->change_bits
);
1152 } else if (udev
->persist_enabled
) {
1154 udev
->reset_resume
= 1;
1156 /* Don't set the change_bits when the device
1159 if (test_bit(port1
, hub
->power_bits
))
1160 set_bit(port1
, hub
->change_bits
);
1163 /* The power session is gone; tell hub_wq */
1164 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1165 set_bit(port1
, hub
->change_bits
);
1169 /* If no port-status-change flags were set, we don't need any
1170 * debouncing. If flags were set we can try to debounce the
1171 * ports all at once right now, instead of letting hub_wq do them
1172 * one at a time later on.
1174 * If any port-status changes do occur during this delay, hub_wq
1175 * will see them later and handle them normally.
1177 if (need_debounce_delay
) {
1178 delay
= HUB_DEBOUNCE_STABLE
;
1180 /* Don't do a long sleep inside a workqueue routine */
1181 if (type
== HUB_INIT2
) {
1182 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1183 queue_delayed_work(system_power_efficient_wq
,
1185 msecs_to_jiffies(delay
));
1186 device_unlock(&hdev
->dev
);
1187 return; /* Continues at init3: below */
1195 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1197 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1198 if (hub
->has_indicators
&& blinkenlights
)
1199 queue_delayed_work(system_power_efficient_wq
,
1200 &hub
->leds
, LED_CYCLE_PERIOD
);
1202 /* Scan all ports that need attention */
1205 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1206 /* Allow autosuspend if it was suppressed */
1208 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1209 device_unlock(&hdev
->dev
);
1212 kref_put(&hub
->kref
, hub_release
);
1215 /* Implement the continuations for the delays above */
1216 static void hub_init_func2(struct work_struct
*ws
)
1218 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1220 hub_activate(hub
, HUB_INIT2
);
1223 static void hub_init_func3(struct work_struct
*ws
)
1225 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1227 hub_activate(hub
, HUB_INIT3
);
1230 enum hub_quiescing_type
{
1231 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1234 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1236 struct usb_device
*hdev
= hub
->hdev
;
1239 /* hub_wq and related activity won't re-trigger */
1242 if (type
!= HUB_SUSPEND
) {
1243 /* Disconnect all the children */
1244 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1245 if (hub
->ports
[i
]->child
)
1246 usb_disconnect(&hub
->ports
[i
]->child
);
1250 /* Stop hub_wq and related activity */
1251 usb_kill_urb(hub
->urb
);
1252 if (hub
->has_indicators
)
1253 cancel_delayed_work_sync(&hub
->leds
);
1255 flush_work(&hub
->tt
.clear_work
);
1258 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1262 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1263 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1266 /* caller has locked the hub device */
1267 static int hub_pre_reset(struct usb_interface
*intf
)
1269 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1271 hub_quiesce(hub
, HUB_PRE_RESET
);
1273 hub_pm_barrier_for_all_ports(hub
);
1277 /* caller has locked the hub device */
1278 static int hub_post_reset(struct usb_interface
*intf
)
1280 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1283 hub_pm_barrier_for_all_ports(hub
);
1284 hub_activate(hub
, HUB_POST_RESET
);
1288 static int hub_configure(struct usb_hub
*hub
,
1289 struct usb_endpoint_descriptor
*endpoint
)
1291 struct usb_hcd
*hcd
;
1292 struct usb_device
*hdev
= hub
->hdev
;
1293 struct device
*hub_dev
= hub
->intfdev
;
1294 u16 hubstatus
, hubchange
;
1295 u16 wHubCharacteristics
;
1298 char *message
= "out of memory";
1303 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1309 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1314 mutex_init(&hub
->status_mutex
);
1316 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1317 if (!hub
->descriptor
) {
1322 /* Request the entire hub descriptor.
1323 * hub->descriptor can handle USB_MAXCHILDREN ports,
1324 * but a (non-SS) hub can/will return fewer bytes here.
1326 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1328 message
= "can't read hub descriptor";
1332 maxchild
= USB_MAXCHILDREN
;
1333 if (hub_is_superspeed(hdev
))
1334 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1336 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1337 message
= "hub has too many ports!";
1340 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1341 message
= "hub doesn't have any ports!";
1346 maxchild
= hub
->descriptor
->bNbrPorts
;
1347 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1348 (maxchild
== 1) ? "" : "s");
1350 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1356 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1357 if (hub_is_superspeed(hdev
)) {
1365 /* FIXME for USB 3.0, skip for now */
1366 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1367 !(hub_is_superspeed(hdev
))) {
1368 char portstr
[USB_MAXCHILDREN
+ 1];
1370 for (i
= 0; i
< maxchild
; i
++)
1371 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1372 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1374 portstr
[maxchild
] = 0;
1375 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1377 dev_dbg(hub_dev
, "standalone hub\n");
1379 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1380 case HUB_CHAR_COMMON_LPSM
:
1381 dev_dbg(hub_dev
, "ganged power switching\n");
1383 case HUB_CHAR_INDV_PORT_LPSM
:
1384 dev_dbg(hub_dev
, "individual port power switching\n");
1386 case HUB_CHAR_NO_LPSM
:
1388 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1392 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1393 case HUB_CHAR_COMMON_OCPM
:
1394 dev_dbg(hub_dev
, "global over-current protection\n");
1396 case HUB_CHAR_INDV_PORT_OCPM
:
1397 dev_dbg(hub_dev
, "individual port over-current protection\n");
1399 case HUB_CHAR_NO_OCPM
:
1401 dev_dbg(hub_dev
, "no over-current protection\n");
1405 spin_lock_init(&hub
->tt
.lock
);
1406 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1407 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1408 switch (hdev
->descriptor
.bDeviceProtocol
) {
1411 case USB_HUB_PR_HS_SINGLE_TT
:
1412 dev_dbg(hub_dev
, "Single TT\n");
1415 case USB_HUB_PR_HS_MULTI_TT
:
1416 ret
= usb_set_interface(hdev
, 0, 1);
1418 dev_dbg(hub_dev
, "TT per port\n");
1421 dev_err(hub_dev
, "Using single TT (err %d)\n",
1426 /* USB 3.0 hubs don't have a TT */
1429 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1430 hdev
->descriptor
.bDeviceProtocol
);
1434 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1435 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1436 case HUB_TTTT_8_BITS
:
1437 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1438 hub
->tt
.think_time
= 666;
1439 dev_dbg(hub_dev
, "TT requires at most %d "
1440 "FS bit times (%d ns)\n",
1441 8, hub
->tt
.think_time
);
1444 case HUB_TTTT_16_BITS
:
1445 hub
->tt
.think_time
= 666 * 2;
1446 dev_dbg(hub_dev
, "TT requires at most %d "
1447 "FS bit times (%d ns)\n",
1448 16, hub
->tt
.think_time
);
1450 case HUB_TTTT_24_BITS
:
1451 hub
->tt
.think_time
= 666 * 3;
1452 dev_dbg(hub_dev
, "TT requires at most %d "
1453 "FS bit times (%d ns)\n",
1454 24, hub
->tt
.think_time
);
1456 case HUB_TTTT_32_BITS
:
1457 hub
->tt
.think_time
= 666 * 4;
1458 dev_dbg(hub_dev
, "TT requires at most %d "
1459 "FS bit times (%d ns)\n",
1460 32, hub
->tt
.think_time
);
1464 /* probe() zeroes hub->indicator[] */
1465 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1466 hub
->has_indicators
= 1;
1467 dev_dbg(hub_dev
, "Port indicators are supported\n");
1470 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1471 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1473 /* power budgeting mostly matters with bus-powered hubs,
1474 * and battery-powered root hubs (may provide just 8 mA).
1476 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1478 message
= "can't get hub status";
1481 hcd
= bus_to_hcd(hdev
->bus
);
1482 if (hdev
== hdev
->bus
->root_hub
) {
1483 if (hcd
->power_budget
> 0)
1484 hdev
->bus_mA
= hcd
->power_budget
;
1486 hdev
->bus_mA
= full_load
* maxchild
;
1487 if (hdev
->bus_mA
>= full_load
)
1488 hub
->mA_per_port
= full_load
;
1490 hub
->mA_per_port
= hdev
->bus_mA
;
1491 hub
->limited_power
= 1;
1493 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1494 int remaining
= hdev
->bus_mA
-
1495 hub
->descriptor
->bHubContrCurrent
;
1497 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1498 hub
->descriptor
->bHubContrCurrent
);
1499 hub
->limited_power
= 1;
1501 if (remaining
< maxchild
* unit_load
)
1503 "insufficient power available "
1504 "to use all downstream ports\n");
1505 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1507 } else { /* Self-powered external hub */
1508 /* FIXME: What about battery-powered external hubs that
1509 * provide less current per port? */
1510 hub
->mA_per_port
= full_load
;
1512 if (hub
->mA_per_port
< full_load
)
1513 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1516 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1518 message
= "can't get hub status";
1522 /* local power status reports aren't always correct */
1523 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1524 dev_dbg(hub_dev
, "local power source is %s\n",
1525 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1526 ? "lost (inactive)" : "good");
1528 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1529 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1530 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1532 /* set up the interrupt endpoint
1533 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1534 * bytes as USB2.0[11.12.3] says because some hubs are known
1535 * to send more data (and thus cause overflow). For root hubs,
1536 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1537 * to be big enough for at least USB_MAXCHILDREN ports. */
1538 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1539 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1541 if (maxp
> sizeof(*hub
->buffer
))
1542 maxp
= sizeof(*hub
->buffer
);
1544 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1550 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1551 hub
, endpoint
->bInterval
);
1553 /* maybe cycle the hub leds */
1554 if (hub
->has_indicators
&& blinkenlights
)
1555 hub
->indicator
[0] = INDICATOR_CYCLE
;
1557 mutex_lock(&usb_port_peer_mutex
);
1558 for (i
= 0; i
< maxchild
; i
++) {
1559 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1561 dev_err(hub
->intfdev
,
1562 "couldn't create port%d device.\n", i
+ 1);
1567 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1568 struct usb_port
*port_dev
= hub
->ports
[i
];
1570 pm_runtime_put(&port_dev
->dev
);
1573 mutex_unlock(&usb_port_peer_mutex
);
1577 /* Update the HCD's internal representation of this hub before hub_wq
1578 * starts getting port status changes for devices under the hub.
1580 if (hcd
->driver
->update_hub_device
) {
1581 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1582 &hub
->tt
, GFP_KERNEL
);
1584 message
= "can't update HCD hub info";
1589 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1591 hub_activate(hub
, HUB_INIT
);
1595 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1597 /* hub_disconnect() frees urb and descriptor */
1601 static void hub_release(struct kref
*kref
)
1603 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1605 usb_put_dev(hub
->hdev
);
1606 usb_put_intf(to_usb_interface(hub
->intfdev
));
1610 static unsigned highspeed_hubs
;
1612 static void hub_disconnect(struct usb_interface
*intf
)
1614 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1615 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1619 * Stop adding new hub events. We do not want to block here and thus
1620 * will not try to remove any pending work item.
1622 hub
->disconnected
= 1;
1624 /* Disconnect all children and quiesce the hub */
1626 hub_quiesce(hub
, HUB_DISCONNECT
);
1628 mutex_lock(&usb_port_peer_mutex
);
1630 /* Avoid races with recursively_mark_NOTATTACHED() */
1631 spin_lock_irq(&device_state_lock
);
1632 port1
= hdev
->maxchild
;
1634 usb_set_intfdata(intf
, NULL
);
1635 spin_unlock_irq(&device_state_lock
);
1637 for (; port1
> 0; --port1
)
1638 usb_hub_remove_port_device(hub
, port1
);
1640 mutex_unlock(&usb_port_peer_mutex
);
1642 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1645 usb_free_urb(hub
->urb
);
1647 kfree(hub
->descriptor
);
1651 pm_suspend_ignore_children(&intf
->dev
, false);
1652 kref_put(&hub
->kref
, hub_release
);
1655 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1657 struct usb_host_interface
*desc
;
1658 struct usb_endpoint_descriptor
*endpoint
;
1659 struct usb_device
*hdev
;
1660 struct usb_hub
*hub
;
1662 desc
= intf
->cur_altsetting
;
1663 hdev
= interface_to_usbdev(intf
);
1666 * Set default autosuspend delay as 0 to speedup bus suspend,
1667 * based on the below considerations:
1669 * - Unlike other drivers, the hub driver does not rely on the
1670 * autosuspend delay to provide enough time to handle a wakeup
1671 * event, and the submitted status URB is just to check future
1672 * change on hub downstream ports, so it is safe to do it.
1674 * - The patch might cause one or more auto supend/resume for
1675 * below very rare devices when they are plugged into hub
1678 * devices having trouble initializing, and disconnect
1679 * themselves from the bus and then reconnect a second
1682 * devices just for downloading firmware, and disconnects
1683 * themselves after completing it
1685 * For these quite rare devices, their drivers may change the
1686 * autosuspend delay of their parent hub in the probe() to one
1687 * appropriate value to avoid the subtle problem if someone
1690 * - The patch may cause one or more auto suspend/resume on
1691 * hub during running 'lsusb', but it is probably too
1692 * infrequent to worry about.
1694 * - Change autosuspend delay of hub can avoid unnecessary auto
1695 * suspend timer for hub, also may decrease power consumption
1698 * - If user has indicated to prevent autosuspend by passing
1699 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1702 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1703 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1707 * Hubs have proper suspend/resume support, except for root hubs
1708 * where the controller driver doesn't have bus_suspend and
1709 * bus_resume methods.
1711 if (hdev
->parent
) { /* normal device */
1712 usb_enable_autosuspend(hdev
);
1713 } else { /* root hub */
1714 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1716 if (drv
->bus_suspend
&& drv
->bus_resume
)
1717 usb_enable_autosuspend(hdev
);
1720 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1722 "Unsupported bus topology: hub nested too deep\n");
1726 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1728 dev_warn(&intf
->dev
, "ignoring external hub\n");
1733 /* Some hubs have a subclass of 1, which AFAICT according to the */
1734 /* specs is not defined, but it works */
1735 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1736 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1738 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1742 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1743 if (desc
->desc
.bNumEndpoints
!= 1)
1744 goto descriptor_error
;
1746 endpoint
= &desc
->endpoint
[0].desc
;
1748 /* If it's not an interrupt in endpoint, we'd better punt! */
1749 if (!usb_endpoint_is_int_in(endpoint
))
1750 goto descriptor_error
;
1752 /* We found a hub */
1753 dev_info(&intf
->dev
, "USB hub found\n");
1755 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1757 dev_dbg(&intf
->dev
, "couldn't kmalloc hub struct\n");
1761 kref_init(&hub
->kref
);
1762 hub
->intfdev
= &intf
->dev
;
1764 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1765 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1766 INIT_WORK(&hub
->events
, hub_event
);
1770 usb_set_intfdata(intf
, hub
);
1771 intf
->needs_remote_wakeup
= 1;
1772 pm_suspend_ignore_children(&intf
->dev
, true);
1774 if (hdev
->speed
== USB_SPEED_HIGH
)
1777 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1778 hub
->quirk_check_port_auto_suspend
= 1;
1780 if (hub_configure(hub
, endpoint
) >= 0)
1783 hub_disconnect(intf
);
1788 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1790 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1791 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1793 /* assert ifno == 0 (part of hub spec) */
1795 case USBDEVFS_HUB_PORTINFO
: {
1796 struct usbdevfs_hub_portinfo
*info
= user_data
;
1799 spin_lock_irq(&device_state_lock
);
1800 if (hdev
->devnum
<= 0)
1803 info
->nports
= hdev
->maxchild
;
1804 for (i
= 0; i
< info
->nports
; i
++) {
1805 if (hub
->ports
[i
]->child
== NULL
)
1809 hub
->ports
[i
]->child
->devnum
;
1812 spin_unlock_irq(&device_state_lock
);
1814 return info
->nports
+ 1;
1823 * Allow user programs to claim ports on a hub. When a device is attached
1824 * to one of these "claimed" ports, the program will "own" the device.
1826 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1827 struct usb_dev_state
***ppowner
)
1829 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1831 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1833 if (port1
== 0 || port1
> hdev
->maxchild
)
1836 /* Devices not managed by the hub driver
1837 * will always have maxchild equal to 0.
1839 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1843 /* In the following three functions, the caller must hold hdev's lock */
1844 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1845 struct usb_dev_state
*owner
)
1848 struct usb_dev_state
**powner
;
1850 rc
= find_port_owner(hdev
, port1
, &powner
);
1858 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1860 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1861 struct usb_dev_state
*owner
)
1864 struct usb_dev_state
**powner
;
1866 rc
= find_port_owner(hdev
, port1
, &powner
);
1869 if (*powner
!= owner
)
1874 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1876 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1878 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1881 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1882 if (hub
->ports
[n
]->port_owner
== owner
)
1883 hub
->ports
[n
]->port_owner
= NULL
;
1888 /* The caller must hold udev's lock */
1889 bool usb_device_is_owned(struct usb_device
*udev
)
1891 struct usb_hub
*hub
;
1893 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1895 hub
= usb_hub_to_struct_hub(udev
->parent
);
1896 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1899 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1901 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1904 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1905 if (hub
->ports
[i
]->child
)
1906 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1908 if (udev
->state
== USB_STATE_SUSPENDED
)
1909 udev
->active_duration
-= jiffies
;
1910 udev
->state
= USB_STATE_NOTATTACHED
;
1914 * usb_set_device_state - change a device's current state (usbcore, hcds)
1915 * @udev: pointer to device whose state should be changed
1916 * @new_state: new state value to be stored
1918 * udev->state is _not_ fully protected by the device lock. Although
1919 * most transitions are made only while holding the lock, the state can
1920 * can change to USB_STATE_NOTATTACHED at almost any time. This
1921 * is so that devices can be marked as disconnected as soon as possible,
1922 * without having to wait for any semaphores to be released. As a result,
1923 * all changes to any device's state must be protected by the
1924 * device_state_lock spinlock.
1926 * Once a device has been added to the device tree, all changes to its state
1927 * should be made using this routine. The state should _not_ be set directly.
1929 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1930 * Otherwise udev->state is set to new_state, and if new_state is
1931 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1932 * to USB_STATE_NOTATTACHED.
1934 void usb_set_device_state(struct usb_device
*udev
,
1935 enum usb_device_state new_state
)
1937 unsigned long flags
;
1940 spin_lock_irqsave(&device_state_lock
, flags
);
1941 if (udev
->state
== USB_STATE_NOTATTACHED
)
1943 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1945 /* root hub wakeup capabilities are managed out-of-band
1946 * and may involve silicon errata ... ignore them here.
1949 if (udev
->state
== USB_STATE_SUSPENDED
1950 || new_state
== USB_STATE_SUSPENDED
)
1951 ; /* No change to wakeup settings */
1952 else if (new_state
== USB_STATE_CONFIGURED
)
1953 wakeup
= (udev
->quirks
&
1954 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1955 udev
->actconfig
->desc
.bmAttributes
&
1956 USB_CONFIG_ATT_WAKEUP
;
1960 if (udev
->state
== USB_STATE_SUSPENDED
&&
1961 new_state
!= USB_STATE_SUSPENDED
)
1962 udev
->active_duration
-= jiffies
;
1963 else if (new_state
== USB_STATE_SUSPENDED
&&
1964 udev
->state
!= USB_STATE_SUSPENDED
)
1965 udev
->active_duration
+= jiffies
;
1966 udev
->state
= new_state
;
1968 recursively_mark_NOTATTACHED(udev
);
1969 spin_unlock_irqrestore(&device_state_lock
, flags
);
1971 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1973 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1976 * Choose a device number.
1978 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1979 * USB-2.0 buses they are also used as device addresses, however on
1980 * USB-3.0 buses the address is assigned by the controller hardware
1981 * and it usually is not the same as the device number.
1983 * WUSB devices are simple: they have no hubs behind, so the mapping
1984 * device <-> virtual port number becomes 1:1. Why? to simplify the
1985 * life of the device connection logic in
1986 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1987 * handshake we need to assign a temporary address in the unauthorized
1988 * space. For simplicity we use the first virtual port number found to
1989 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1990 * and that becomes it's address [X < 128] or its unauthorized address
1993 * We add 1 as an offset to the one-based USB-stack port number
1994 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1995 * 0 is reserved by USB for default address; (b) Linux's USB stack
1996 * uses always #1 for the root hub of the controller. So USB stack's
1997 * port #1, which is wusb virtual-port #0 has address #2.
1999 * Devices connected under xHCI are not as simple. The host controller
2000 * supports virtualization, so the hardware assigns device addresses and
2001 * the HCD must setup data structures before issuing a set address
2002 * command to the hardware.
2004 static void choose_devnum(struct usb_device
*udev
)
2007 struct usb_bus
*bus
= udev
->bus
;
2009 /* be safe when more hub events are proceed in parallel */
2010 mutex_lock(&bus
->devnum_next_mutex
);
2012 devnum
= udev
->portnum
+ 1;
2013 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2015 /* Try to allocate the next devnum beginning at
2016 * bus->devnum_next. */
2017 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2020 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2022 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2025 set_bit(devnum
, bus
->devmap
.devicemap
);
2026 udev
->devnum
= devnum
;
2028 mutex_unlock(&bus
->devnum_next_mutex
);
2031 static void release_devnum(struct usb_device
*udev
)
2033 if (udev
->devnum
> 0) {
2034 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2039 static void update_devnum(struct usb_device
*udev
, int devnum
)
2041 /* The address for a WUSB device is managed by wusbcore. */
2043 udev
->devnum
= devnum
;
2046 static void hub_free_dev(struct usb_device
*udev
)
2048 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2050 /* Root hubs aren't real devices, so don't free HCD resources */
2051 if (hcd
->driver
->free_dev
&& udev
->parent
)
2052 hcd
->driver
->free_dev(hcd
, udev
);
2055 static void hub_disconnect_children(struct usb_device
*udev
)
2057 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2060 /* Free up all the children before we remove this device */
2061 for (i
= 0; i
< udev
->maxchild
; i
++) {
2062 if (hub
->ports
[i
]->child
)
2063 usb_disconnect(&hub
->ports
[i
]->child
);
2068 * usb_disconnect - disconnect a device (usbcore-internal)
2069 * @pdev: pointer to device being disconnected
2070 * Context: !in_interrupt ()
2072 * Something got disconnected. Get rid of it and all of its children.
2074 * If *pdev is a normal device then the parent hub must already be locked.
2075 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2076 * which protects the set of root hubs as well as the list of buses.
2078 * Only hub drivers (including virtual root hub drivers for host
2079 * controllers) should ever call this.
2081 * This call is synchronous, and may not be used in an interrupt context.
2083 void usb_disconnect(struct usb_device
**pdev
)
2085 struct usb_port
*port_dev
= NULL
;
2086 struct usb_device
*udev
= *pdev
;
2087 struct usb_hub
*hub
= NULL
;
2090 /* mark the device as inactive, so any further urb submissions for
2091 * this device (and any of its children) will fail immediately.
2092 * this quiesces everything except pending urbs.
2094 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2095 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2099 * Ensure that the pm runtime code knows that the USB device
2100 * is in the process of being disconnected.
2102 pm_runtime_barrier(&udev
->dev
);
2104 usb_lock_device(udev
);
2106 hub_disconnect_children(udev
);
2108 /* deallocate hcd/hardware state ... nuking all pending urbs and
2109 * cleaning up all state associated with the current configuration
2110 * so that the hardware is now fully quiesced.
2112 dev_dbg(&udev
->dev
, "unregistering device\n");
2113 usb_disable_device(udev
, 0);
2114 usb_hcd_synchronize_unlinks(udev
);
2117 port1
= udev
->portnum
;
2118 hub
= usb_hub_to_struct_hub(udev
->parent
);
2119 port_dev
= hub
->ports
[port1
- 1];
2121 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2122 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2125 * As usb_port_runtime_resume() de-references udev, make
2126 * sure no resumes occur during removal
2128 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2129 pm_runtime_get_sync(&port_dev
->dev
);
2132 usb_remove_ep_devs(&udev
->ep0
);
2133 usb_unlock_device(udev
);
2135 /* Unregister the device. The device driver is responsible
2136 * for de-configuring the device and invoking the remove-device
2137 * notifier chain (used by usbfs and possibly others).
2139 device_del(&udev
->dev
);
2141 /* Free the device number and delete the parent's children[]
2142 * (or root_hub) pointer.
2144 release_devnum(udev
);
2146 /* Avoid races with recursively_mark_NOTATTACHED() */
2147 spin_lock_irq(&device_state_lock
);
2149 spin_unlock_irq(&device_state_lock
);
2151 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2152 pm_runtime_put(&port_dev
->dev
);
2156 put_device(&udev
->dev
);
2159 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2160 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2164 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2167 static void announce_device(struct usb_device
*udev
)
2169 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2170 le16_to_cpu(udev
->descriptor
.idVendor
),
2171 le16_to_cpu(udev
->descriptor
.idProduct
));
2172 dev_info(&udev
->dev
,
2173 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2174 udev
->descriptor
.iManufacturer
,
2175 udev
->descriptor
.iProduct
,
2176 udev
->descriptor
.iSerialNumber
);
2177 show_string(udev
, "Product", udev
->product
);
2178 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2179 show_string(udev
, "SerialNumber", udev
->serial
);
2182 static inline void announce_device(struct usb_device
*udev
) { }
2187 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2188 * @udev: newly addressed device (in ADDRESS state)
2190 * Finish enumeration for On-The-Go devices
2192 * Return: 0 if successful. A negative error code otherwise.
2194 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2198 #ifdef CONFIG_USB_OTG
2200 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2201 * to wake us after we've powered off VBUS; and HNP, switching roles
2202 * "host" to "peripheral". The OTG descriptor helps figure this out.
2204 if (!udev
->bus
->is_b_host
2206 && udev
->parent
== udev
->bus
->root_hub
) {
2207 struct usb_otg_descriptor
*desc
= NULL
;
2208 struct usb_bus
*bus
= udev
->bus
;
2209 unsigned port1
= udev
->portnum
;
2211 /* descriptor may appear anywhere in config */
2212 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2213 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2214 USB_DT_OTG
, (void **) &desc
);
2215 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2218 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2219 (port1
== bus
->otg_port
) ? "" : "non-");
2221 /* enable HNP before suspend, it's simpler */
2222 if (port1
== bus
->otg_port
) {
2223 bus
->b_hnp_enable
= 1;
2224 err
= usb_control_msg(udev
,
2225 usb_sndctrlpipe(udev
, 0),
2226 USB_REQ_SET_FEATURE
, 0,
2227 USB_DEVICE_B_HNP_ENABLE
,
2229 USB_CTRL_SET_TIMEOUT
);
2232 * OTG MESSAGE: report errors here,
2233 * customize to match your product.
2235 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2237 bus
->b_hnp_enable
= 0;
2239 } else if (desc
->bLength
== sizeof
2240 (struct usb_otg_descriptor
)) {
2241 /* Set a_alt_hnp_support for legacy otg device */
2242 err
= usb_control_msg(udev
,
2243 usb_sndctrlpipe(udev
, 0),
2244 USB_REQ_SET_FEATURE
, 0,
2245 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2247 USB_CTRL_SET_TIMEOUT
);
2250 "set a_alt_hnp_support failed: %d\n",
2260 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2261 * @udev: newly addressed device (in ADDRESS state)
2263 * This is only called by usb_new_device() and usb_authorize_device()
2264 * and FIXME -- all comments that apply to them apply here wrt to
2267 * If the device is WUSB and not authorized, we don't attempt to read
2268 * the string descriptors, as they will be errored out by the device
2269 * until it has been authorized.
2271 * Return: 0 if successful. A negative error code otherwise.
2273 static int usb_enumerate_device(struct usb_device
*udev
)
2276 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2278 if (udev
->config
== NULL
) {
2279 err
= usb_get_configuration(udev
);
2282 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2288 /* read the standard strings and cache them if present */
2289 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2290 udev
->manufacturer
= usb_cache_string(udev
,
2291 udev
->descriptor
.iManufacturer
);
2292 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2294 err
= usb_enumerate_device_otg(udev
);
2298 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2299 !is_targeted(udev
)) {
2300 /* Maybe it can talk to us, though we can't talk to it.
2301 * (Includes HNP test device.)
2303 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2304 || udev
->bus
->is_b_host
)) {
2305 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2307 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2311 #if defined(CONFIG_USB_OTG_WHITELIST_FOR_MDM)
2312 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST_FOR_MDM
) &&
2313 /*hcd->tpl_support &&*/
2314 !is_targeted_for_samsung_mdm(udev
)) {
2315 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2316 || udev
->bus
->is_b_host
)) {
2317 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2319 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2324 usb_detect_interface_quirks(udev
);
2329 static void set_usb_port_removable(struct usb_device
*udev
)
2331 struct usb_device
*hdev
= udev
->parent
;
2332 struct usb_hub
*hub
;
2333 u8 port
= udev
->portnum
;
2334 u16 wHubCharacteristics
;
2335 bool removable
= true;
2340 hub
= usb_hub_to_struct_hub(udev
->parent
);
2343 * If the platform firmware has provided information about a port,
2344 * use that to determine whether it's removable.
2346 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2347 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2348 udev
->removable
= USB_DEVICE_REMOVABLE
;
2350 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2351 case USB_PORT_NOT_USED
:
2352 udev
->removable
= USB_DEVICE_FIXED
;
2359 * Otherwise, check whether the hub knows whether a port is removable
2362 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2364 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2367 if (hub_is_superspeed(hdev
)) {
2368 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2372 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2377 udev
->removable
= USB_DEVICE_REMOVABLE
;
2379 udev
->removable
= USB_DEVICE_FIXED
;
2384 * usb_new_device - perform initial device setup (usbcore-internal)
2385 * @udev: newly addressed device (in ADDRESS state)
2387 * This is called with devices which have been detected but not fully
2388 * enumerated. The device descriptor is available, but not descriptors
2389 * for any device configuration. The caller must have locked either
2390 * the parent hub (if udev is a normal device) or else the
2391 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2392 * udev has already been installed, but udev is not yet visible through
2393 * sysfs or other filesystem code.
2395 * This call is synchronous, and may not be used in an interrupt context.
2397 * Only the hub driver or root-hub registrar should ever call this.
2399 * Return: Whether the device is configured properly or not. Zero if the
2400 * interface was registered with the driver core; else a negative errno
2404 int usb_new_device(struct usb_device
*udev
)
2409 /* Initialize non-root-hub device wakeup to disabled;
2410 * device (un)configuration controls wakeup capable
2411 * sysfs power/wakeup controls wakeup enabled/disabled
2413 device_init_wakeup(&udev
->dev
, 0);
2416 /* Tell the runtime-PM framework the device is active */
2417 pm_runtime_set_active(&udev
->dev
);
2418 pm_runtime_get_noresume(&udev
->dev
);
2419 pm_runtime_use_autosuspend(&udev
->dev
);
2420 pm_runtime_enable(&udev
->dev
);
2422 /* By default, forbid autosuspend for all devices. It will be
2423 * allowed for hubs during binding.
2425 usb_disable_autosuspend(udev
);
2427 err
= usb_enumerate_device(udev
); /* Read descriptors */
2430 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2431 udev
->devnum
, udev
->bus
->busnum
,
2432 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2433 /* export the usbdev device-node for libusb */
2434 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2435 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2437 /* Tell the world! */
2438 announce_device(udev
);
2441 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2443 add_device_randomness(udev
->product
, strlen(udev
->product
));
2444 if (udev
->manufacturer
)
2445 add_device_randomness(udev
->manufacturer
,
2446 strlen(udev
->manufacturer
));
2448 device_enable_async_suspend(&udev
->dev
);
2450 /* check whether the hub or firmware marks this port as non-removable */
2452 set_usb_port_removable(udev
);
2454 /* Register the device. The device driver is responsible
2455 * for configuring the device and invoking the add-device
2456 * notifier chain (used by usbfs and possibly others).
2458 err
= device_add(&udev
->dev
);
2460 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2464 /* Create link files between child device and usb port device. */
2466 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2467 int port1
= udev
->portnum
;
2468 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2470 err
= sysfs_create_link(&udev
->dev
.kobj
,
2471 &port_dev
->dev
.kobj
, "port");
2475 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2476 &udev
->dev
.kobj
, "device");
2478 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2482 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2483 pm_runtime_get_sync(&port_dev
->dev
);
2486 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2487 usb_mark_last_busy(udev
);
2488 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2492 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2493 pm_runtime_disable(&udev
->dev
);
2494 pm_runtime_set_suspended(&udev
->dev
);
2500 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2501 * @usb_dev: USB device
2503 * Move the USB device to a very basic state where interfaces are disabled
2504 * and the device is in fact unconfigured and unusable.
2506 * We share a lock (that we have) with device_del(), so we need to
2511 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2513 usb_lock_device(usb_dev
);
2514 if (usb_dev
->authorized
== 0)
2515 goto out_unauthorized
;
2517 usb_dev
->authorized
= 0;
2518 usb_set_configuration(usb_dev
, -1);
2521 usb_unlock_device(usb_dev
);
2526 int usb_authorize_device(struct usb_device
*usb_dev
)
2530 usb_lock_device(usb_dev
);
2531 if (usb_dev
->authorized
== 1)
2532 goto out_authorized
;
2534 result
= usb_autoresume_device(usb_dev
);
2536 dev_err(&usb_dev
->dev
,
2537 "can't autoresume for authorization: %d\n", result
);
2538 goto error_autoresume
;
2541 if (usb_dev
->wusb
) {
2542 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2544 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2545 "authorization: %d\n", result
);
2546 goto error_device_descriptor
;
2550 usb_dev
->authorized
= 1;
2551 /* Choose and set the configuration. This registers the interfaces
2552 * with the driver core and lets interface drivers bind to them.
2554 c
= usb_choose_configuration(usb_dev
);
2556 result
= usb_set_configuration(usb_dev
, c
);
2558 dev_err(&usb_dev
->dev
,
2559 "can't set config #%d, error %d\n", c
, result
);
2560 /* This need not be fatal. The user can try to
2561 * set other configurations. */
2564 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2566 error_device_descriptor
:
2567 usb_autosuspend_device(usb_dev
);
2570 usb_unlock_device(usb_dev
); /* complements locktree */
2575 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2576 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2578 struct usb_hcd
*hcd
;
2579 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2581 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2582 return hcd
->wireless
;
2586 #define PORT_RESET_TRIES 5
2587 #define SET_ADDRESS_TRIES 2
2588 #define GET_DESCRIPTOR_TRIES 2
2589 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2590 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2592 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2593 #define HUB_SHORT_RESET_TIME 10
2594 #define HUB_BH_RESET_TIME 50
2595 #define HUB_LONG_RESET_TIME 200
2596 #define HUB_RESET_TIMEOUT 800
2599 * "New scheme" enumeration causes an extra state transition to be
2600 * exposed to an xhci host and causes USB3 devices to receive control
2601 * commands in the default state. This has been seen to cause
2602 * enumeration failures, so disable this enumeration scheme for USB3
2605 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2607 if (udev
->speed
>= USB_SPEED_SUPER
)
2610 return USE_NEW_SCHEME(retry
);
2613 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2614 * Port worm reset is required to recover
2616 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2621 if (!hub_is_superspeed(hub
->hdev
))
2624 if (test_bit(port1
, hub
->warm_reset_bits
))
2627 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2628 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2629 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2632 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2633 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2635 int delay_time
, ret
;
2639 for (delay_time
= 0;
2640 delay_time
< HUB_RESET_TIMEOUT
;
2641 delay_time
+= delay
) {
2642 /* wait to give the device a chance to reset */
2645 /* read and decode port status */
2646 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2651 * The port state is unknown until the reset completes.
2653 * On top of that, some chips may require additional time
2654 * to re-establish a connection after the reset is complete,
2655 * so also wait for the connection to be re-established.
2657 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2658 (portstatus
& USB_PORT_STAT_CONNECTION
))
2661 /* switch to the long delay after two short delay failures */
2662 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2663 delay
= HUB_LONG_RESET_TIME
;
2665 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2666 "not %sreset yet, waiting %dms\n",
2667 warm
? "warm " : "", delay
);
2670 if ((portstatus
& USB_PORT_STAT_RESET
))
2673 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2676 /* Device went away? */
2677 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2680 /* Retry if connect change is set but status is still connected.
2681 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2682 * but the device may have successfully re-connected. Ignore it.
2684 if (!hub_is_superspeed(hub
->hdev
) &&
2685 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2686 usb_clear_port_feature(hub
->hdev
, port1
,
2687 USB_PORT_FEAT_C_CONNECTION
);
2691 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2697 if (hub_is_wusb(hub
))
2698 udev
->speed
= USB_SPEED_WIRELESS
;
2699 else if (hub_is_superspeed(hub
->hdev
))
2700 udev
->speed
= USB_SPEED_SUPER
;
2701 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2702 udev
->speed
= USB_SPEED_HIGH
;
2703 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2704 udev
->speed
= USB_SPEED_LOW
;
2706 udev
->speed
= USB_SPEED_FULL
;
2710 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2711 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2712 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2715 u16 portchange
, portstatus
;
2716 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2718 if (!hub_is_superspeed(hub
->hdev
)) {
2720 dev_err(hub
->intfdev
, "only USB3 hub support "
2724 /* Block EHCI CF initialization during the port reset.
2725 * Some companion controllers don't like it when they mix.
2727 down_read(&ehci_cf_port_reset_rwsem
);
2730 * If the caller hasn't explicitly requested a warm reset,
2731 * double check and see if one is needed.
2733 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2734 if (hub_port_warm_reset_required(hub
, port1
,
2738 clear_bit(port1
, hub
->warm_reset_bits
);
2740 /* Reset the port */
2741 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2742 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2743 USB_PORT_FEAT_BH_PORT_RESET
:
2744 USB_PORT_FEAT_RESET
));
2745 if (status
== -ENODEV
) {
2746 ; /* The hub is gone */
2747 } else if (status
) {
2748 dev_err(&port_dev
->dev
,
2749 "cannot %sreset (err = %d)\n",
2750 warm
? "warm " : "", status
);
2752 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2754 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2755 dev_dbg(hub
->intfdev
,
2756 "port_wait_reset: err = %d\n",
2760 /* Check for disconnect or reset */
2761 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2762 usb_clear_port_feature(hub
->hdev
, port1
,
2763 USB_PORT_FEAT_C_RESET
);
2765 if (!hub_is_superspeed(hub
->hdev
))
2768 usb_clear_port_feature(hub
->hdev
, port1
,
2769 USB_PORT_FEAT_C_BH_PORT_RESET
);
2770 usb_clear_port_feature(hub
->hdev
, port1
,
2771 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2772 usb_clear_port_feature(hub
->hdev
, port1
,
2773 USB_PORT_FEAT_C_CONNECTION
);
2776 * If a USB 3.0 device migrates from reset to an error
2777 * state, re-issue the warm reset.
2779 if (hub_port_status(hub
, port1
,
2780 &portstatus
, &portchange
) < 0)
2783 if (!hub_port_warm_reset_required(hub
, port1
,
2788 * If the port is in SS.Inactive or Compliance Mode, the
2789 * hot or warm reset failed. Try another warm reset.
2792 dev_dbg(&port_dev
->dev
,
2793 "hot reset failed, warm reset\n");
2798 dev_dbg(&port_dev
->dev
,
2799 "not enabled, trying %sreset again...\n",
2800 warm
? "warm " : "");
2801 delay
= HUB_LONG_RESET_TIME
;
2804 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2808 /* TRSTRCY = 10 ms; plus some extra */
2811 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2813 update_devnum(udev
, 0);
2814 /* The xHC may think the device is already reset,
2815 * so ignore the status.
2817 if (hcd
->driver
->reset_device
)
2818 hcd
->driver
->reset_device(hcd
, udev
);
2820 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2824 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2827 if (!hub_is_superspeed(hub
->hdev
))
2828 up_read(&ehci_cf_port_reset_rwsem
);
2833 /* Check if a port is power on */
2834 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2838 if (hub_is_superspeed(hub
->hdev
)) {
2839 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2842 if (portstatus
& USB_PORT_STAT_POWER
)
2849 static void usb_lock_port(struct usb_port
*port_dev
)
2850 __acquires(&port_dev
->status_lock
)
2852 mutex_lock(&port_dev
->status_lock
);
2853 __acquire(&port_dev
->status_lock
);
2856 static void usb_unlock_port(struct usb_port
*port_dev
)
2857 __releases(&port_dev
->status_lock
)
2859 mutex_unlock(&port_dev
->status_lock
);
2860 __release(&port_dev
->status_lock
);
2865 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2866 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2870 if (hub_is_superspeed(hub
->hdev
)) {
2871 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2872 == USB_SS_PORT_LS_U3
)
2875 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2882 /* Determine whether the device on a port is ready for a normal resume,
2883 * is ready for a reset-resume, or should be disconnected.
2885 static int check_port_resume_type(struct usb_device
*udev
,
2886 struct usb_hub
*hub
, int port1
,
2887 int status
, u16 portchange
, u16 portstatus
)
2889 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2893 /* Is a warm reset needed to recover the connection? */
2894 if (status
== 0 && udev
->reset_resume
2895 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2898 /* Is the device still present? */
2899 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2900 !port_is_power_on(hub
, portstatus
)) {
2903 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2905 usleep_range(200, 300);
2906 status
= hub_port_status(hub
, port1
, &portstatus
,
2913 /* Can't do a normal resume if the port isn't enabled,
2914 * so try a reset-resume instead.
2916 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2917 if (udev
->persist_enabled
)
2918 udev
->reset_resume
= 1;
2924 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
2925 portchange
, portstatus
, status
);
2926 } else if (udev
->reset_resume
) {
2928 /* Late port handoff can set status-change bits */
2929 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2930 usb_clear_port_feature(hub
->hdev
, port1
,
2931 USB_PORT_FEAT_C_CONNECTION
);
2932 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2933 usb_clear_port_feature(hub
->hdev
, port1
,
2934 USB_PORT_FEAT_C_ENABLE
);
2940 int usb_disable_ltm(struct usb_device
*udev
)
2942 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2944 /* Check if the roothub and device supports LTM. */
2945 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2946 !usb_device_supports_ltm(udev
))
2949 /* Clear Feature LTM Enable can only be sent if the device is
2952 if (!udev
->actconfig
)
2955 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2956 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2957 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2958 USB_CTRL_SET_TIMEOUT
);
2960 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2962 void usb_enable_ltm(struct usb_device
*udev
)
2964 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2966 /* Check if the roothub and device supports LTM. */
2967 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2968 !usb_device_supports_ltm(udev
))
2971 /* Set Feature LTM Enable can only be sent if the device is
2974 if (!udev
->actconfig
)
2977 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2978 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2979 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2980 USB_CTRL_SET_TIMEOUT
);
2982 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2985 * usb_enable_remote_wakeup - enable remote wakeup for a device
2986 * @udev: target device
2988 * For USB-2 devices: Set the device's remote wakeup feature.
2990 * For USB-3 devices: Assume there's only one function on the device and
2991 * enable remote wake for the first interface. FIXME if the interface
2992 * association descriptor shows there's more than one function.
2994 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
2996 if (udev
->speed
< USB_SPEED_SUPER
)
2997 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2998 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2999 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3000 USB_CTRL_SET_TIMEOUT
);
3002 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3003 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3004 USB_INTRF_FUNC_SUSPEND
,
3005 USB_INTRF_FUNC_SUSPEND_RW
|
3006 USB_INTRF_FUNC_SUSPEND_LP
,
3007 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3011 * usb_disable_remote_wakeup - disable remote wakeup for a device
3012 * @udev: target device
3014 * For USB-2 devices: Clear the device's remote wakeup feature.
3016 * For USB-3 devices: Assume there's only one function on the device and
3017 * disable remote wake for the first interface. FIXME if the interface
3018 * association descriptor shows there's more than one function.
3020 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3022 if (udev
->speed
< USB_SPEED_SUPER
)
3023 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3024 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3025 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3026 USB_CTRL_SET_TIMEOUT
);
3028 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3029 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
3030 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3031 USB_CTRL_SET_TIMEOUT
);
3034 /* Count of wakeup-enabled devices at or below udev */
3035 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3037 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3039 return udev
->do_remote_wakeup
+
3040 (hub
? hub
->wakeup_enabled_descendants
: 0);
3044 * usb_port_suspend - suspend a usb device's upstream port
3045 * @udev: device that's no longer in active use, not a root hub
3046 * Context: must be able to sleep; device not locked; pm locks held
3048 * Suspends a USB device that isn't in active use, conserving power.
3049 * Devices may wake out of a suspend, if anything important happens,
3050 * using the remote wakeup mechanism. They may also be taken out of
3051 * suspend by the host, using usb_port_resume(). It's also routine
3052 * to disconnect devices while they are suspended.
3054 * This only affects the USB hardware for a device; its interfaces
3055 * (and, for hubs, child devices) must already have been suspended.
3057 * Selective port suspend reduces power; most suspended devices draw
3058 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3059 * All devices below the suspended port are also suspended.
3061 * Devices leave suspend state when the host wakes them up. Some devices
3062 * also support "remote wakeup", where the device can activate the USB
3063 * tree above them to deliver data, such as a keypress or packet. In
3064 * some cases, this wakes the USB host.
3066 * Suspending OTG devices may trigger HNP, if that's been enabled
3067 * between a pair of dual-role devices. That will change roles, such
3068 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3070 * Devices on USB hub ports have only one "suspend" state, corresponding
3071 * to ACPI D2, "may cause the device to lose some context".
3072 * State transitions include:
3074 * - suspend, resume ... when the VBUS power link stays live
3075 * - suspend, disconnect ... VBUS lost
3077 * Once VBUS drop breaks the circuit, the port it's using has to go through
3078 * normal re-enumeration procedures, starting with enabling VBUS power.
3079 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3080 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3081 * timer, no SRP, no requests through sysfs.
3083 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3084 * suspended until their bus goes into global suspend (i.e., the root
3085 * hub is suspended). Nevertheless, we change @udev->state to
3086 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3087 * upstream port setting is stored in @udev->port_is_suspended.
3089 * Returns 0 on success, else negative errno.
3091 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3093 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3094 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3095 int port1
= udev
->portnum
;
3097 bool really_suspend
= true;
3099 usb_lock_port(port_dev
);
3101 /* enable remote wakeup when appropriate; this lets the device
3102 * wake up the upstream hub (including maybe the root hub).
3104 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3105 * we don't explicitly enable it here.
3107 if (udev
->do_remote_wakeup
) {
3108 status
= usb_enable_remote_wakeup(udev
);
3110 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3112 /* bail if autosuspend is requested */
3113 if (PMSG_IS_AUTO(msg
))
3118 /* disable USB2 hardware LPM */
3119 if (udev
->usb2_hw_lpm_enabled
== 1)
3120 usb_set_usb2_hardware_lpm(udev
, 0);
3122 if (usb_disable_ltm(udev
)) {
3123 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3125 if (PMSG_IS_AUTO(msg
))
3128 if (usb_unlocked_disable_lpm(udev
)) {
3129 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3131 if (PMSG_IS_AUTO(msg
))
3136 if (hub_is_superspeed(hub
->hdev
))
3137 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3140 * For system suspend, we do not need to enable the suspend feature
3141 * on individual USB-2 ports. The devices will automatically go
3142 * into suspend a few ms after the root hub stops sending packets.
3143 * The USB 2.0 spec calls this "global suspend".
3145 * However, many USB hubs have a bug: They don't relay wakeup requests
3146 * from a downstream port if the port's suspend feature isn't on.
3147 * Therefore we will turn on the suspend feature if udev or any of its
3148 * descendants is enabled for remote wakeup.
3150 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3151 status
= set_port_feature(hub
->hdev
, port1
,
3152 USB_PORT_FEAT_SUSPEND
);
3154 really_suspend
= false;
3158 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3160 /* Try to enable USB3 LPM and LTM again */
3161 usb_unlocked_enable_lpm(udev
);
3163 usb_enable_ltm(udev
);
3165 /* Try to enable USB2 hardware LPM again */
3166 if (udev
->usb2_hw_lpm_capable
== 1)
3167 usb_set_usb2_hardware_lpm(udev
, 1);
3169 if (udev
->do_remote_wakeup
)
3170 (void) usb_disable_remote_wakeup(udev
);
3173 /* System sleep transitions should never fail */
3174 if (!PMSG_IS_AUTO(msg
))
3177 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3178 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3179 udev
->do_remote_wakeup
);
3180 if (really_suspend
) {
3181 udev
->port_is_suspended
= 1;
3183 /* device has up to 10 msec to fully suspend */
3186 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3189 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3190 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3191 pm_runtime_put_sync(&port_dev
->dev
);
3193 usb_mark_last_busy(hub
->hdev
);
3195 usb_unlock_port(port_dev
);
3200 * If the USB "suspend" state is in use (rather than "global suspend"),
3201 * many devices will be individually taken out of suspend state using
3202 * special "resume" signaling. This routine kicks in shortly after
3203 * hardware resume signaling is finished, either because of selective
3204 * resume (by host) or remote wakeup (by device) ... now see what changed
3205 * in the tree that's rooted at this device.
3207 * If @udev->reset_resume is set then the device is reset before the
3208 * status check is done.
3210 static int finish_port_resume(struct usb_device
*udev
)
3215 /* caller owns the udev device lock */
3216 dev_dbg(&udev
->dev
, "%s\n",
3217 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3219 /* usb ch9 identifies four variants of SUSPENDED, based on what
3220 * state the device resumes to. Linux currently won't see the
3221 * first two on the host side; they'd be inside hub_port_init()
3222 * during many timeouts, but hub_wq can't suspend until later.
3224 usb_set_device_state(udev
, udev
->actconfig
3225 ? USB_STATE_CONFIGURED
3226 : USB_STATE_ADDRESS
);
3228 /* 10.5.4.5 says not to reset a suspended port if the attached
3229 * device is enabled for remote wakeup. Hence the reset
3230 * operation is carried out here, after the port has been
3233 if (udev
->reset_resume
) {
3235 * If the device morphs or switches modes when it is reset,
3236 * we don't want to perform a reset-resume. We'll fail the
3237 * resume, which will cause a logical disconnect, and then
3238 * the device will be rediscovered.
3241 if (udev
->quirks
& USB_QUIRK_RESET
)
3244 status
= usb_reset_and_verify_device(udev
);
3247 /* 10.5.4.5 says be sure devices in the tree are still there.
3248 * For now let's assume the device didn't go crazy on resume,
3249 * and device drivers will know about any resume quirks.
3253 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3255 /* If a normal resume failed, try doing a reset-resume */
3256 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3257 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3258 udev
->reset_resume
= 1;
3259 goto retry_reset_resume
;
3264 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3267 * There are a few quirky devices which violate the standard
3268 * by claiming to have remote wakeup enabled after a reset,
3269 * which crash if the feature is cleared, hence check for
3270 * udev->reset_resume
3272 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3273 if (udev
->speed
< USB_SPEED_SUPER
) {
3274 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3275 status
= usb_disable_remote_wakeup(udev
);
3277 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3279 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3280 | USB_INTRF_STAT_FUNC_RW
))
3281 status
= usb_disable_remote_wakeup(udev
);
3286 "disable remote wakeup, status %d\n",
3294 * There are some SS USB devices which take longer time for link training.
3295 * XHCI specs 4.19.4 says that when Link training is successful, port
3296 * sets CSC bit to 1. So if SW reads port status before successful link
3297 * training, then it will not find device to be present.
3298 * USB Analyzer log with such buggy devices show that in some cases
3299 * device switch on the RX termination after long delay of host enabling
3300 * the VBUS. In few other cases it has been seen that device fails to
3301 * negotiate link training in first attempt. It has been
3302 * reported till now that few devices take as long as 2000 ms to train
3303 * the link after host enabling its VBUS and termination. Following
3304 * routine implements a 2000 ms timeout for link training. If in a case
3305 * link trains before timeout, loop will exit earlier.
3307 * FIXME: If a device was connected before suspend, but was removed
3308 * while system was asleep, then the loop in the following routine will
3309 * only exit at timeout.
3311 * This routine should only be called when persist is enabled for a SS
3314 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3315 struct usb_hub
*hub
, int *port1
,
3316 u16
*portchange
, u16
*portstatus
)
3318 int status
= 0, delay_ms
= 0;
3320 while (delay_ms
< 2000) {
3321 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3325 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3331 * usb_port_resume - re-activate a suspended usb device's upstream port
3332 * @udev: device to re-activate, not a root hub
3333 * Context: must be able to sleep; device not locked; pm locks held
3335 * This will re-activate the suspended device, increasing power usage
3336 * while letting drivers communicate again with its endpoints.
3337 * USB resume explicitly guarantees that the power session between
3338 * the host and the device is the same as it was when the device
3341 * If @udev->reset_resume is set then this routine won't check that the
3342 * port is still enabled. Furthermore, finish_port_resume() above will
3343 * reset @udev. The end result is that a broken power session can be
3344 * recovered and @udev will appear to persist across a loss of VBUS power.
3346 * For example, if a host controller doesn't maintain VBUS suspend current
3347 * during a system sleep or is reset when the system wakes up, all the USB
3348 * power sessions below it will be broken. This is especially troublesome
3349 * for mass-storage devices containing mounted filesystems, since the
3350 * device will appear to have disconnected and all the memory mappings
3351 * to it will be lost. Using the USB_PERSIST facility, the device can be
3352 * made to appear as if it had not disconnected.
3354 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3355 * every effort to insure that the same device is present after the
3356 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3357 * quite possible for a device to remain unaltered but its media to be
3358 * changed. If the user replaces a flash memory card while the system is
3359 * asleep, he will have only himself to blame when the filesystem on the
3360 * new card is corrupted and the system crashes.
3362 * Returns 0 on success, else negative errno.
3364 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3366 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3367 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3368 int port1
= udev
->portnum
;
3370 u16 portchange
, portstatus
;
3372 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3373 status
= pm_runtime_get_sync(&port_dev
->dev
);
3375 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3381 usb_lock_port(port_dev
);
3383 /* Skip the initial Clear-Suspend step for a remote wakeup */
3384 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3385 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3386 goto SuspendCleared
;
3388 /* see 7.1.7.7; affects power usage, but not budgeting */
3389 if (hub_is_superspeed(hub
->hdev
))
3390 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3392 status
= usb_clear_port_feature(hub
->hdev
,
3393 port1
, USB_PORT_FEAT_SUSPEND
);
3395 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3397 /* drive resume for USB_RESUME_TIMEOUT msec */
3398 dev_dbg(&udev
->dev
, "usb %sresume\n",
3399 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3400 msleep(USB_RESUME_TIMEOUT
);
3402 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3403 * stop resume signaling. Then finish the resume
3406 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3408 /* TRSMRCY = 10 msec */
3414 udev
->port_is_suspended
= 0;
3415 if (hub_is_superspeed(hub
->hdev
)) {
3416 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3417 usb_clear_port_feature(hub
->hdev
, port1
,
3418 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3420 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3421 usb_clear_port_feature(hub
->hdev
, port1
,
3422 USB_PORT_FEAT_C_SUSPEND
);
3426 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3427 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3430 status
= check_port_resume_type(udev
,
3431 hub
, port1
, status
, portchange
, portstatus
);
3433 status
= finish_port_resume(udev
);
3435 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3436 hub_port_logical_disconnect(hub
, port1
);
3438 /* Try to enable USB2 hardware LPM */
3439 if (udev
->usb2_hw_lpm_capable
== 1)
3440 usb_set_usb2_hardware_lpm(udev
, 1);
3442 /* Try to enable USB3 LTM and LPM */
3443 usb_enable_ltm(udev
);
3444 usb_unlocked_enable_lpm(udev
);
3447 usb_unlock_port(port_dev
);
3452 int usb_remote_wakeup(struct usb_device
*udev
)
3456 usb_lock_device(udev
);
3457 if (udev
->state
== USB_STATE_SUSPENDED
) {
3458 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3459 status
= usb_autoresume_device(udev
);
3461 /* Let the drivers do their thing, then... */
3462 usb_autosuspend_device(udev
);
3465 usb_unlock_device(udev
);
3469 /* Returns 1 if there was a remote wakeup and a connect status change. */
3470 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3471 u16 portstatus
, u16 portchange
)
3472 __must_hold(&port_dev
->status_lock
)
3474 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3475 struct usb_device
*hdev
;
3476 struct usb_device
*udev
;
3477 int connect_change
= 0;
3481 udev
= port_dev
->child
;
3482 if (!hub_is_superspeed(hdev
)) {
3483 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3485 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3487 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3488 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
3494 /* TRSMRCY = 10 msec */
3497 usb_unlock_port(port_dev
);
3498 ret
= usb_remote_wakeup(udev
);
3499 usb_lock_port(port_dev
);
3504 hub_port_disable(hub
, port
, 1);
3506 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3507 return connect_change
;
3510 static int check_ports_changed(struct usb_hub
*hub
)
3514 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3515 u16 portstatus
, portchange
;
3518 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3519 if (!status
&& portchange
)
3525 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3527 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3528 struct usb_device
*hdev
= hub
->hdev
;
3533 * Warn if children aren't already suspended.
3534 * Also, add up the number of wakeup-enabled descendants.
3536 hub
->wakeup_enabled_descendants
= 0;
3537 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3538 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3539 struct usb_device
*udev
= port_dev
->child
;
3541 if (udev
&& udev
->can_submit
) {
3542 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3543 dev_name(&udev
->dev
));
3544 if (PMSG_IS_AUTO(msg
))
3548 hub
->wakeup_enabled_descendants
+=
3549 wakeup_enabled_descendants(udev
);
3552 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3553 /* check if there are changes pending on hub ports */
3554 if (check_ports_changed(hub
)) {
3555 if (PMSG_IS_AUTO(msg
))
3557 pm_wakeup_event(&hdev
->dev
, 2000);
3561 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3562 /* Enable hub to send remote wakeup for all ports. */
3563 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3564 status
= set_port_feature(hdev
,
3566 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3567 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3568 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3569 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3573 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3575 /* stop hub_wq and related activity */
3576 hub_quiesce(hub
, HUB_SUSPEND
);
3580 static int hub_resume(struct usb_interface
*intf
)
3582 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3584 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3585 hub_activate(hub
, HUB_RESUME
);
3589 static int hub_reset_resume(struct usb_interface
*intf
)
3591 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3593 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3594 hub_activate(hub
, HUB_RESET_RESUME
);
3599 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3600 * @rhdev: struct usb_device for the root hub
3602 * The USB host controller driver calls this function when its root hub
3603 * is resumed and Vbus power has been interrupted or the controller
3604 * has been reset. The routine marks @rhdev as having lost power.
3605 * When the hub driver is resumed it will take notice and carry out
3606 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3607 * the others will be disconnected.
3609 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3611 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3612 rhdev
->reset_resume
= 1;
3614 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3616 static const char * const usb3_lpm_names
[] = {
3624 * Send a Set SEL control transfer to the device, prior to enabling
3625 * device-initiated U1 or U2. This lets the device know the exit latencies from
3626 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3627 * packet from the host.
3629 * This function will fail if the SEL or PEL values for udev are greater than
3630 * the maximum allowed values for the link state to be enabled.
3632 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3634 struct usb_set_sel_req
*sel_values
;
3635 unsigned long long u1_sel
;
3636 unsigned long long u1_pel
;
3637 unsigned long long u2_sel
;
3638 unsigned long long u2_pel
;
3641 if (udev
->state
!= USB_STATE_CONFIGURED
)
3644 /* Convert SEL and PEL stored in ns to us */
3645 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3646 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3647 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3648 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3651 * Make sure that the calculated SEL and PEL values for the link
3652 * state we're enabling aren't bigger than the max SEL/PEL
3653 * value that will fit in the SET SEL control transfer.
3654 * Otherwise the device would get an incorrect idea of the exit
3655 * latency for the link state, and could start a device-initiated
3656 * U1/U2 when the exit latencies are too high.
3658 if ((state
== USB3_LPM_U1
&&
3659 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3660 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3661 (state
== USB3_LPM_U2
&&
3662 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3663 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3664 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3665 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3670 * If we're enabling device-initiated LPM for one link state,
3671 * but the other link state has a too high SEL or PEL value,
3672 * just set those values to the max in the Set SEL request.
3674 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3675 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3677 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3678 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3680 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3681 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3683 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3684 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3687 * usb_enable_lpm() can be called as part of a failed device reset,
3688 * which may be initiated by an error path of a mass storage driver.
3689 * Therefore, use GFP_NOIO.
3691 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3695 sel_values
->u1_sel
= u1_sel
;
3696 sel_values
->u1_pel
= u1_pel
;
3697 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3698 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3700 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3704 sel_values
, sizeof *(sel_values
),
3705 USB_CTRL_SET_TIMEOUT
);
3711 * Enable or disable device-initiated U1 or U2 transitions.
3713 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3714 enum usb3_link_state state
, bool enable
)
3721 feature
= USB_DEVICE_U1_ENABLE
;
3724 feature
= USB_DEVICE_U2_ENABLE
;
3727 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3728 __func__
, enable
? "enable" : "disable");
3732 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3733 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3734 "for unconfigured device.\n",
3735 __func__
, enable
? "enable" : "disable",
3736 usb3_lpm_names
[state
]);
3742 * Now send the control transfer to enable device-initiated LPM
3743 * for either U1 or U2.
3745 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3746 USB_REQ_SET_FEATURE
,
3750 USB_CTRL_SET_TIMEOUT
);
3752 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3753 USB_REQ_CLEAR_FEATURE
,
3757 USB_CTRL_SET_TIMEOUT
);
3760 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3761 enable
? "Enable" : "Disable",
3762 usb3_lpm_names
[state
]);
3768 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3769 enum usb3_link_state state
, int timeout
)
3776 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3779 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3782 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3787 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3788 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3789 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3790 "which is a reserved value.\n",
3791 usb3_lpm_names
[state
], timeout
);
3795 ret
= set_port_feature(udev
->parent
,
3796 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3799 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3800 "error code %i\n", usb3_lpm_names
[state
],
3804 if (state
== USB3_LPM_U1
)
3805 udev
->u1_params
.timeout
= timeout
;
3807 udev
->u2_params
.timeout
= timeout
;
3812 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3815 * We will attempt to enable U1 or U2, but there are no guarantees that the
3816 * control transfers to set the hub timeout or enable device-initiated U1/U2
3817 * will be successful.
3819 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3820 * driver know about it. If that call fails, it should be harmless, and just
3821 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3823 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3824 enum usb3_link_state state
)
3827 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3828 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3830 /* If the device says it doesn't have *any* exit latency to come out of
3831 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3834 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3835 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3839 * First, let the device know about the exit latencies
3840 * associated with the link state we're about to enable.
3842 ret
= usb_req_set_sel(udev
, state
);
3844 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3845 usb3_lpm_names
[state
]);
3849 /* We allow the host controller to set the U1/U2 timeout internally
3850 * first, so that it can change its schedule to account for the
3851 * additional latency to send data to a device in a lower power
3854 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3856 /* xHCI host controller doesn't want to enable this LPM state. */
3861 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3862 "xHCI error %i.\n", usb3_lpm_names
[state
],
3867 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
3868 /* If we can't set the parent hub U1/U2 timeout,
3869 * device-initiated LPM won't be allowed either, so let the xHCI
3870 * host know that this link state won't be enabled.
3872 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3874 /* Only a configured device will accept the Set Feature
3877 if (udev
->actconfig
)
3878 usb_set_device_initiated_lpm(udev
, state
, true);
3880 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3881 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3882 * matter the result of usb_set_device_initiated_lpm().
3883 * The only difference is whether device is able to initiate
3886 if (state
== USB3_LPM_U1
)
3887 udev
->usb3_lpm_u1_enabled
= 1;
3888 else if (state
== USB3_LPM_U2
)
3889 udev
->usb3_lpm_u2_enabled
= 1;
3894 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3897 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3898 * If zero is returned, the parent will not allow the link to go into U1/U2.
3900 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3901 * it won't have an effect on the bus link state because the parent hub will
3902 * still disallow device-initiated U1/U2 entry.
3904 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3905 * possible. The result will be slightly more bus bandwidth will be taken up
3906 * (to account for U1/U2 exit latency), but it should be harmless.
3908 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3909 enum usb3_link_state state
)
3916 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3921 if (usb_set_lpm_timeout(udev
, state
, 0))
3924 usb_set_device_initiated_lpm(udev
, state
, false);
3926 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3927 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3928 "bus schedule bandwidth may be impacted.\n",
3929 usb3_lpm_names
[state
]);
3931 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3932 * is disabled. Hub will disallows link to enter U1/U2 as well,
3933 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3934 * timeout set to 0, no matter device-initiated LPM is disabled or
3937 if (state
== USB3_LPM_U1
)
3938 udev
->usb3_lpm_u1_enabled
= 0;
3939 else if (state
== USB3_LPM_U2
)
3940 udev
->usb3_lpm_u2_enabled
= 0;
3946 * Disable hub-initiated and device-initiated U1 and U2 entry.
3947 * Caller must own the bandwidth_mutex.
3949 * This will call usb_enable_lpm() on failure, which will decrement
3950 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3952 int usb_disable_lpm(struct usb_device
*udev
)
3954 struct usb_hcd
*hcd
;
3956 if (!udev
|| !udev
->parent
||
3957 udev
->speed
< USB_SPEED_SUPER
||
3958 !udev
->lpm_capable
||
3959 udev
->state
< USB_STATE_DEFAULT
)
3962 hcd
= bus_to_hcd(udev
->bus
);
3963 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3966 udev
->lpm_disable_count
++;
3967 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3970 /* If LPM is enabled, attempt to disable it. */
3971 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3973 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3979 usb_enable_lpm(udev
);
3982 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3984 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3985 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3987 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3993 mutex_lock(hcd
->bandwidth_mutex
);
3994 ret
= usb_disable_lpm(udev
);
3995 mutex_unlock(hcd
->bandwidth_mutex
);
3999 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4002 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4003 * xHCI host policy may prevent U1 or U2 from being enabled.
4005 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4006 * until the lpm_disable_count drops to zero. Caller must own the
4009 void usb_enable_lpm(struct usb_device
*udev
)
4011 struct usb_hcd
*hcd
;
4013 if (!udev
|| !udev
->parent
||
4014 udev
->speed
< USB_SPEED_SUPER
||
4015 !udev
->lpm_capable
||
4016 udev
->state
< USB_STATE_DEFAULT
)
4019 udev
->lpm_disable_count
--;
4020 hcd
= bus_to_hcd(udev
->bus
);
4021 /* Double check that we can both enable and disable LPM.
4022 * Device must be configured to accept set feature U1/U2 timeout.
4024 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4025 !hcd
->driver
->disable_usb3_lpm_timeout
)
4028 if (udev
->lpm_disable_count
> 0)
4031 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4032 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4034 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4036 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4037 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4039 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4044 mutex_lock(hcd
->bandwidth_mutex
);
4045 usb_enable_lpm(udev
);
4046 mutex_unlock(hcd
->bandwidth_mutex
);
4048 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4050 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4051 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4052 struct usb_port
*port_dev
)
4054 struct usb_device
*udev
= port_dev
->child
;
4057 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4058 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4061 msleep(USB_RESUME_TIMEOUT
);
4062 ret
= usb_disable_remote_wakeup(udev
);
4065 dev_warn(&udev
->dev
,
4066 "Port disable: can't disable remote wake\n");
4067 udev
->do_remote_wakeup
= 0;
4071 #else /* CONFIG_PM */
4073 #define hub_suspend NULL
4074 #define hub_resume NULL
4075 #define hub_reset_resume NULL
4077 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4078 struct usb_port
*port_dev
) { }
4080 int usb_disable_lpm(struct usb_device
*udev
)
4084 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4086 void usb_enable_lpm(struct usb_device
*udev
) { }
4087 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4089 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4093 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4095 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4096 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4098 int usb_disable_ltm(struct usb_device
*udev
)
4102 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4104 void usb_enable_ltm(struct usb_device
*udev
) { }
4105 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4107 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4108 u16 portstatus
, u16 portchange
)
4113 #endif /* CONFIG_PM */
4116 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4117 * a connection with a plugged-in cable but will signal the host when the cable
4118 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4120 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4122 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4123 struct usb_device
*hdev
= hub
->hdev
;
4127 if (hub_is_superspeed(hub
->hdev
)) {
4128 hub_usb3_port_prepare_disable(hub
, port_dev
);
4129 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4132 ret
= usb_clear_port_feature(hdev
, port1
,
4133 USB_PORT_FEAT_ENABLE
);
4136 if (port_dev
->child
&& set_state
)
4137 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4138 if (ret
&& ret
!= -ENODEV
)
4139 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4144 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4146 * Between connect detection and reset signaling there must be a delay
4147 * of 100ms at least for debounce and power-settling. The corresponding
4148 * timer shall restart whenever the downstream port detects a disconnect.
4150 * Apparently there are some bluetooth and irda-dongles and a number of
4151 * low-speed devices for which this debounce period may last over a second.
4152 * Not covered by the spec - but easy to deal with.
4154 * This implementation uses a 1500ms total debounce timeout; if the
4155 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4156 * every 25ms for transient disconnects. When the port status has been
4157 * unchanged for 100ms it returns the port status.
4159 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4162 u16 portchange
, portstatus
;
4163 unsigned connection
= 0xffff;
4164 int total_time
, stable_time
= 0;
4165 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4167 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4168 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4172 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4173 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4174 if (!must_be_connected
||
4175 (connection
== USB_PORT_STAT_CONNECTION
))
4176 stable_time
+= HUB_DEBOUNCE_STEP
;
4177 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4181 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4184 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4185 usb_clear_port_feature(hub
->hdev
, port1
,
4186 USB_PORT_FEAT_C_CONNECTION
);
4189 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4191 msleep(HUB_DEBOUNCE_STEP
);
4194 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4195 total_time
, stable_time
, portstatus
);
4197 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4202 void usb_ep0_reinit(struct usb_device
*udev
)
4204 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4205 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4206 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4208 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4210 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4211 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4213 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4216 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4219 * The host controller will choose the device address,
4220 * instead of the core having chosen it earlier
4222 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4224 if (udev
->state
== USB_STATE_ADDRESS
)
4226 if (udev
->state
!= USB_STATE_DEFAULT
)
4228 if (hcd
->driver
->address_device
)
4229 retval
= hcd
->driver
->address_device(hcd
, udev
);
4231 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4232 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4233 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4235 update_devnum(udev
, devnum
);
4236 /* Device now using proper address. */
4237 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4238 usb_ep0_reinit(udev
);
4244 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4245 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4248 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4249 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4250 * support bit in the BOS descriptor.
4252 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4254 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4255 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4257 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4261 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4263 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4264 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4265 udev
->usb2_hw_lpm_allowed
= 1;
4266 usb_set_usb2_hardware_lpm(udev
, 1);
4270 static int hub_enable_device(struct usb_device
*udev
)
4272 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4274 if (!hcd
->driver
->enable_device
)
4276 if (udev
->state
== USB_STATE_ADDRESS
)
4278 if (udev
->state
!= USB_STATE_DEFAULT
)
4281 return hcd
->driver
->enable_device(hcd
, udev
);
4284 /* Reset device, (re)assign address, get device descriptor.
4285 * Device connection must be stable, no more debouncing needed.
4286 * Returns device in USB_STATE_ADDRESS, except on error.
4288 * If this is called for an already-existing device (as part of
4289 * usb_reset_and_verify_device), the caller must own the device lock and
4290 * the port lock. For a newly detected device that is not accessible
4291 * through any global pointers, it's not necessary to lock the device,
4292 * but it is still necessary to lock the port.
4295 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4298 struct usb_device
*hdev
= hub
->hdev
;
4299 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4300 int retries
, operations
, retval
, i
;
4301 unsigned delay
= HUB_SHORT_RESET_TIME
;
4302 enum usb_device_speed oldspeed
= udev
->speed
;
4304 int devnum
= udev
->devnum
;
4306 /* root hub ports have a slightly longer reset period
4307 * (from USB 2.0 spec, section 7.1.7.5)
4309 if (!hdev
->parent
) {
4310 delay
= HUB_ROOT_RESET_TIME
;
4311 if (port1
== hdev
->bus
->otg_port
)
4312 hdev
->bus
->b_hnp_enable
= 0;
4315 /* Some low speed devices have problems with the quick delay, so */
4316 /* be a bit pessimistic with those devices. RHbug #23670 */
4317 if (oldspeed
== USB_SPEED_LOW
)
4318 delay
= HUB_LONG_RESET_TIME
;
4320 mutex_lock(hcd
->address0_mutex
);
4322 /* Reset the device; full speed may morph to high speed */
4323 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4324 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4325 if (retval
< 0) /* error or disconnect */
4327 /* success, speed is known */
4331 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4332 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4333 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4334 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4337 oldspeed
= udev
->speed
;
4339 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4340 * it's fixed size except for full speed devices.
4341 * For Wireless USB devices, ep0 max packet is always 512 (tho
4342 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4344 switch (udev
->speed
) {
4345 case USB_SPEED_SUPER_PLUS
:
4346 case USB_SPEED_SUPER
:
4347 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4348 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4350 case USB_SPEED_HIGH
: /* fixed at 64 */
4351 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4353 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4354 /* to determine the ep0 maxpacket size, try to read
4355 * the device descriptor to get bMaxPacketSize0 and
4356 * then correct our initial guess.
4358 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4360 case USB_SPEED_LOW
: /* fixed at 8 */
4361 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4367 if (udev
->speed
== USB_SPEED_WIRELESS
)
4368 speed
= "variable speed Wireless";
4370 speed
= usb_speed_string(udev
->speed
);
4372 if (udev
->speed
< USB_SPEED_SUPER
)
4373 dev_info(&udev
->dev
,
4374 "%s %s USB device number %d using %s\n",
4375 (udev
->config
) ? "reset" : "new", speed
,
4376 devnum
, udev
->bus
->controller
->driver
->name
);
4378 /* Set up TT records, if needed */
4380 udev
->tt
= hdev
->tt
;
4381 udev
->ttport
= hdev
->ttport
;
4382 } else if (udev
->speed
!= USB_SPEED_HIGH
4383 && hdev
->speed
== USB_SPEED_HIGH
) {
4385 dev_err(&udev
->dev
, "parent hub has no TT\n");
4389 udev
->tt
= &hub
->tt
;
4390 udev
->ttport
= port1
;
4393 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4394 * Because device hardware and firmware is sometimes buggy in
4395 * this area, and this is how Linux has done it for ages.
4396 * Change it cautiously.
4398 * NOTE: If use_new_scheme() is true we will start by issuing
4399 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4400 * so it may help with some non-standards-compliant devices.
4401 * Otherwise we start with SET_ADDRESS and then try to read the
4402 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4405 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4406 bool did_new_scheme
= false;
4408 if (use_new_scheme(udev
, retry_counter
)) {
4409 struct usb_device_descriptor
*buf
;
4412 did_new_scheme
= true;
4413 retval
= hub_enable_device(udev
);
4416 "hub failed to enable device, error %d\n",
4421 #define GET_DESCRIPTOR_BUFSIZE 64
4422 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4428 /* Retry on all errors; some devices are flakey.
4429 * 255 is for WUSB devices, we actually need to use
4430 * 512 (WUSB1.0[4.8.1]).
4432 for (operations
= 0; operations
< 3; ++operations
) {
4433 buf
->bMaxPacketSize0
= 0;
4434 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4435 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4436 USB_DT_DEVICE
<< 8, 0,
4437 buf
, GET_DESCRIPTOR_BUFSIZE
,
4438 initial_descriptor_timeout
);
4439 switch (buf
->bMaxPacketSize0
) {
4440 case 8: case 16: case 32: case 64: case 255:
4441 if (buf
->bDescriptorType
==
4453 * Some devices time out if they are powered on
4454 * when already connected. They need a second
4455 * reset. But only on the first attempt,
4456 * lest we get into a time out/reset loop
4458 if (r
== 0 || (r
== -ETIMEDOUT
&& retries
== 0))
4461 udev
->descriptor
.bMaxPacketSize0
=
4462 buf
->bMaxPacketSize0
;
4465 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4466 if (retval
< 0) /* error or disconnect */
4468 if (oldspeed
!= udev
->speed
) {
4470 "device reset changed speed!\n");
4476 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4481 #undef GET_DESCRIPTOR_BUFSIZE
4485 * If device is WUSB, we already assigned an
4486 * unauthorized address in the Connect Ack sequence;
4487 * authorization will assign the final address.
4489 if (udev
->wusb
== 0) {
4490 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4491 retval
= hub_set_address(udev
, devnum
);
4497 if (retval
!= -ENODEV
)
4498 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4502 if (udev
->speed
>= USB_SPEED_SUPER
) {
4503 devnum
= udev
->devnum
;
4504 dev_info(&udev
->dev
,
4505 "%s SuperSpeed%s USB device number %d using %s\n",
4506 (udev
->config
) ? "reset" : "new",
4507 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ? "Plus" : "",
4508 devnum
, udev
->bus
->controller
->driver
->name
);
4511 /* cope with hardware quirkiness:
4512 * - let SET_ADDRESS settle, some device hardware wants it
4513 * - read ep0 maxpacket even for high and low speed,
4516 /* use_new_scheme() checks the speed which may have
4517 * changed since the initial look so we cache the result
4524 retval
= usb_get_device_descriptor(udev
, 8);
4526 if (retval
!= -ENODEV
)
4528 "device descriptor read/8, error %d\n",
4541 * Some superspeed devices have finished the link training process
4542 * and attached to a superspeed hub port, but the device descriptor
4543 * got from those devices show they aren't superspeed devices. Warm
4544 * reset the port attached by the devices can fix them.
4546 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4547 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4548 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4549 "warm reset device\n");
4550 hub_port_reset(hub
, port1
, udev
,
4551 HUB_BH_RESET_TIME
, true);
4556 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4557 udev
->speed
>= USB_SPEED_SUPER
)
4560 i
= udev
->descriptor
.bMaxPacketSize0
;
4561 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4562 if (udev
->speed
== USB_SPEED_LOW
||
4563 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4564 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4568 if (udev
->speed
== USB_SPEED_FULL
)
4569 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4571 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4572 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4573 usb_ep0_reinit(udev
);
4576 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4577 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4578 if (retval
!= -ENODEV
)
4579 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4586 usb_detect_quirks(udev
);
4588 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4589 retval
= usb_get_bos_descriptor(udev
);
4591 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4592 usb_set_lpm_parameters(udev
);
4598 /* notify HCD that we have a device connected and addressed */
4599 if (hcd
->driver
->update_device
)
4600 hcd
->driver
->update_device(hcd
, udev
);
4601 hub_set_initial_usb2_lpm_policy(udev
);
4604 hub_port_disable(hub
, port1
, 0);
4605 update_devnum(udev
, devnum
); /* for disconnect processing */
4607 mutex_unlock(hcd
->address0_mutex
);
4612 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4614 struct usb_qualifier_descriptor
*qual
;
4617 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4620 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4624 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4625 qual
, sizeof *qual
);
4626 if (status
== sizeof *qual
) {
4627 dev_info(&udev
->dev
, "not running at top speed; "
4628 "connect to a high speed hub\n");
4629 /* hub LEDs are probably harder to miss than syslog */
4630 if (hub
->has_indicators
) {
4631 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4632 queue_delayed_work(system_power_efficient_wq
,
4640 hub_power_remaining(struct usb_hub
*hub
)
4642 struct usb_device
*hdev
= hub
->hdev
;
4646 if (!hub
->limited_power
)
4649 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4650 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4651 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4652 struct usb_device
*udev
= port_dev
->child
;
4658 if (hub_is_superspeed(udev
))
4664 * Unconfigured devices may not use more than one unit load,
4665 * or 8mA for OTG ports
4667 if (udev
->actconfig
)
4668 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4669 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4673 if (delta
> hub
->mA_per_port
)
4674 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4675 delta
, hub
->mA_per_port
);
4678 if (remaining
< 0) {
4679 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4686 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4689 int status
= -ENODEV
;
4692 struct usb_device
*hdev
= hub
->hdev
;
4693 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4694 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4695 struct usb_device
*udev
= port_dev
->child
;
4696 static int unreliable_port
= -1;
4697 #ifdef CONFIG_USB_DEBUG_DETAILED_LOG
4698 dev_info (&port_dev
->dev
,
4699 "port %d, status %04x, change %04x, %s\n",
4700 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4703 /* Disconnect any existing devices under this port */
4705 if (hcd
->usb_phy
&& !hdev
->parent
)
4706 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4707 usb_disconnect(&port_dev
->child
);
4710 /* We can forget about a "removed" device when there's a physical
4711 * disconnect or the connect status changes.
4713 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4714 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4715 clear_bit(port1
, hub
->removed_bits
);
4717 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4718 USB_PORT_STAT_C_ENABLE
)) {
4719 status
= hub_port_debounce_be_stable(hub
, port1
);
4721 if (status
!= -ENODEV
&&
4722 port1
!= unreliable_port
&&
4724 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4725 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4726 unreliable_port
= port1
;
4728 portstatus
= status
;
4732 /* Return now if debouncing failed or nothing is connected or
4733 * the device was "removed".
4735 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4736 test_bit(port1
, hub
->removed_bits
)) {
4739 * maybe switch power back on (e.g. root hub was reset)
4740 * but only if the port isn't owned by someone else.
4742 if (hub_is_port_power_switchable(hub
)
4743 && !port_is_power_on(hub
, portstatus
)
4744 && !port_dev
->port_owner
)
4745 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4747 if (portstatus
& USB_PORT_STAT_ENABLE
)
4753 dev_err(&port_dev
->dev
, "denied insert of USB device on port %d\n", port1
);
4757 if (hub_is_superspeed(hub
->hdev
))
4763 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4765 /* reallocate for each attempt, since references
4766 * to the previous one can escape in various ways
4768 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4770 dev_err(&port_dev
->dev
,
4771 "couldn't allocate usb_device\n");
4775 usb_set_device_state(udev
, USB_STATE_POWERED
);
4776 udev
->bus_mA
= hub
->mA_per_port
;
4777 udev
->level
= hdev
->level
+ 1;
4778 udev
->wusb
= hub_is_wusb(hub
);
4780 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4781 if (hub_is_superspeed(hub
->hdev
))
4782 udev
->speed
= USB_SPEED_SUPER
;
4784 udev
->speed
= USB_SPEED_UNKNOWN
;
4786 choose_devnum(udev
);
4787 if (udev
->devnum
<= 0) {
4788 status
= -ENOTCONN
; /* Don't retry */
4792 /* reset (non-USB 3.0 devices) and get descriptor */
4793 usb_lock_port(port_dev
);
4794 status
= hub_port_init(hub
, udev
, port1
, i
);
4795 usb_unlock_port(port_dev
);
4799 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4802 /* consecutive bus-powered hubs aren't reliable; they can
4803 * violate the voltage drop budget. if the new child has
4804 * a "powered" LED, users should notice we didn't enable it
4805 * (without reading syslog), even without per-port LEDs
4808 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4809 && udev
->bus_mA
<= unit_load
) {
4812 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4815 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4818 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4820 "can't connect bus-powered hub "
4822 if (hub
->has_indicators
) {
4823 hub
->indicator
[port1
-1] =
4824 INDICATOR_AMBER_BLINK
;
4826 system_power_efficient_wq
,
4829 status
= -ENOTCONN
; /* Don't retry */
4834 /* check for devices running slower than they could */
4835 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4836 && udev
->speed
== USB_SPEED_FULL
4837 && highspeed_hubs
!= 0)
4838 check_highspeed(hub
, udev
, port1
);
4840 /* Store the parent's children[] pointer. At this point
4841 * udev becomes globally accessible, although presumably
4842 * no one will look at it until hdev is unlocked.
4846 mutex_lock(&usb_port_peer_mutex
);
4848 /* We mustn't add new devices if the parent hub has
4849 * been disconnected; we would race with the
4850 * recursively_mark_NOTATTACHED() routine.
4852 spin_lock_irq(&device_state_lock
);
4853 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4856 port_dev
->child
= udev
;
4857 spin_unlock_irq(&device_state_lock
);
4858 mutex_unlock(&usb_port_peer_mutex
);
4860 /* Run it through the hoops (find a driver, etc) */
4862 status
= usb_new_device(udev
);
4864 mutex_lock(&usb_port_peer_mutex
);
4865 spin_lock_irq(&device_state_lock
);
4866 port_dev
->child
= NULL
;
4867 spin_unlock_irq(&device_state_lock
);
4868 mutex_unlock(&usb_port_peer_mutex
);
4870 if (hcd
->usb_phy
&& !hdev
->parent
)
4871 usb_phy_notify_connect(hcd
->usb_phy
,
4879 status
= hub_power_remaining(hub
);
4881 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
4886 hub_port_disable(hub
, port1
, 1);
4888 usb_ep0_reinit(udev
);
4889 release_devnum(udev
);
4892 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4895 /* When halfway through our retry count, power-cycle the port */
4896 if (i
== (SET_CONFIG_TRIES
/ 2) - 1) {
4897 dev_info(&port_dev
->dev
, "attempt power cycle\n");
4898 usb_hub_set_port_power(hdev
, hub
, port1
, false);
4899 msleep(2 * hub_power_on_good_delay(hub
));
4900 usb_hub_set_port_power(hdev
, hub
, port1
, true);
4901 msleep(hub_power_on_good_delay(hub
));
4904 if (hub
->hdev
->parent
||
4905 !hcd
->driver
->port_handed_over
||
4906 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4907 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4908 dev_err(&port_dev
->dev
,
4909 "unable to enumerate USB device\n");
4913 hub_port_disable(hub
, port1
, 1);
4914 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
4915 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4916 hcd
->driver
->relinquish_port(hcd
, port1
);
4920 /* Handle physical or logical connection change events.
4921 * This routine is called when:
4922 * a port connection-change occurs;
4923 * a port enable-change occurs (often caused by EMI);
4924 * usb_reset_and_verify_device() encounters changed descriptors (as from
4925 * a firmware download)
4926 * caller already locked the hub
4928 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4929 u16 portstatus
, u16 portchange
)
4930 __must_hold(&port_dev
->status_lock
)
4932 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4933 struct usb_device
*udev
= port_dev
->child
;
4934 int status
= -ENODEV
;
4936 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
4937 portchange
, portspeed(hub
, portstatus
));
4939 if (hub
->has_indicators
) {
4940 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4941 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4944 #ifdef CONFIG_USB_OTG
4945 /* during HNP, don't repeat the debounce */
4946 if (hub
->hdev
->bus
->is_b_host
)
4947 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4948 USB_PORT_STAT_C_ENABLE
);
4951 /* Try to resuscitate an existing device */
4952 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4953 udev
->state
!= USB_STATE_NOTATTACHED
) {
4954 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4955 status
= 0; /* Nothing to do */
4957 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4958 udev
->persist_enabled
) {
4959 /* For a suspended device, treat this as a
4960 * remote wakeup event.
4962 usb_unlock_port(port_dev
);
4963 status
= usb_remote_wakeup(udev
);
4964 usb_lock_port(port_dev
);
4967 /* Don't resuscitate */;
4970 clear_bit(port1
, hub
->change_bits
);
4972 /* successfully revalidated the connection */
4976 usb_unlock_port(port_dev
);
4977 hub_port_connect(hub
, port1
, portstatus
, portchange
);
4978 usb_lock_port(port_dev
);
4981 static void port_event(struct usb_hub
*hub
, int port1
)
4982 __must_hold(&port_dev
->status_lock
)
4985 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4986 struct usb_device
*udev
= port_dev
->child
;
4987 struct usb_device
*hdev
= hub
->hdev
;
4988 u16 portstatus
, portchange
;
4990 connect_change
= test_bit(port1
, hub
->change_bits
);
4991 clear_bit(port1
, hub
->event_bits
);
4992 clear_bit(port1
, hub
->wakeup_bits
);
4994 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
4997 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4998 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5002 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5003 if (!connect_change
)
5004 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5006 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5009 * EM interference sometimes causes badly shielded USB devices
5010 * to be shutdown by the hub, this hack enables them again.
5011 * Works at least with mouse driver.
5013 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5014 && !connect_change
&& udev
) {
5015 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5020 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5021 u16 status
= 0, unused
;
5023 dev_dbg(&port_dev
->dev
, "over-current change\n");
5024 usb_clear_port_feature(hdev
, port1
,
5025 USB_PORT_FEAT_C_OVER_CURRENT
);
5026 msleep(100); /* Cool down */
5027 hub_power_on(hub
, true);
5028 hub_port_status(hub
, port1
, &status
, &unused
);
5029 if (status
& USB_PORT_STAT_OVERCURRENT
)
5030 dev_err(&port_dev
->dev
, "over-current condition\n");
5033 if (portchange
& USB_PORT_STAT_C_RESET
) {
5034 dev_dbg(&port_dev
->dev
, "reset change\n");
5035 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5037 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5038 && hub_is_superspeed(hdev
)) {
5039 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5040 usb_clear_port_feature(hdev
, port1
,
5041 USB_PORT_FEAT_C_BH_PORT_RESET
);
5043 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5044 dev_dbg(&port_dev
->dev
, "link state change\n");
5045 usb_clear_port_feature(hdev
, port1
,
5046 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5048 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5049 dev_warn(&port_dev
->dev
, "config error\n");
5050 usb_clear_port_feature(hdev
, port1
,
5051 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5054 /* skip port actions that require the port to be powered on */
5055 if (!pm_runtime_active(&port_dev
->dev
))
5058 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5062 * Warm reset a USB3 protocol port if it's in
5063 * SS.Inactive state.
5065 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5066 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5067 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5068 || udev
->state
== USB_STATE_NOTATTACHED
) {
5069 if (hub_port_reset(hub
, port1
, NULL
,
5070 HUB_BH_RESET_TIME
, true) < 0)
5071 hub_port_disable(hub
, port1
, 1);
5073 usb_unlock_port(port_dev
);
5074 usb_lock_device(udev
);
5075 usb_reset_device(udev
);
5076 usb_unlock_device(udev
);
5077 usb_lock_port(port_dev
);
5083 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5086 static void hub_event(struct work_struct
*work
)
5088 struct usb_device
*hdev
;
5089 struct usb_interface
*intf
;
5090 struct usb_hub
*hub
;
5091 struct device
*hub_dev
;
5092 struct usb_hcd
*hcd
;
5097 hub
= container_of(work
, struct usb_hub
, events
);
5099 hub_dev
= hub
->intfdev
;
5100 hcd
= bus_to_hcd(hdev
->bus
);
5101 intf
= to_usb_interface(hub_dev
);
5103 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5104 hdev
->state
, hdev
->maxchild
,
5105 /* NOTE: expects max 15 ports... */
5106 (u16
) hub
->change_bits
[0],
5107 (u16
) hub
->event_bits
[0]);
5109 /* Lock the device, then check to see if we were
5110 * disconnected while waiting for the lock to succeed. */
5111 usb_lock_device(hdev
);
5112 hcd
->is_in_hub_event
= true;
5113 if (unlikely(hub
->disconnected
))
5116 /* If the hub has died, clean up after it */
5117 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5118 hub
->error
= -ENODEV
;
5119 hub_quiesce(hub
, HUB_DISCONNECT
);
5124 ret
= usb_autopm_get_interface(intf
);
5126 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5130 /* If this is an inactive hub, do nothing */
5135 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5137 ret
= usb_reset_device(hdev
);
5139 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5147 /* deal with port status changes */
5148 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5149 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5151 if (test_bit(i
, hub
->event_bits
)
5152 || test_bit(i
, hub
->change_bits
)
5153 || test_bit(i
, hub
->wakeup_bits
)) {
5155 * The get_noresume and barrier ensure that if
5156 * the port was in the process of resuming, we
5157 * flush that work and keep the port active for
5158 * the duration of the port_event(). However,
5159 * if the port is runtime pm suspended
5160 * (powered-off), we leave it in that state, run
5161 * an abbreviated port_event(), and move on.
5163 pm_runtime_get_noresume(&port_dev
->dev
);
5164 pm_runtime_barrier(&port_dev
->dev
);
5165 usb_lock_port(port_dev
);
5167 usb_unlock_port(port_dev
);
5168 pm_runtime_put_sync(&port_dev
->dev
);
5172 /* deal with hub status changes */
5173 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5175 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5176 dev_err(hub_dev
, "get_hub_status failed\n");
5178 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5179 dev_dbg(hub_dev
, "power change\n");
5180 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5181 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5182 /* FIXME: Is this always true? */
5183 hub
->limited_power
= 1;
5185 hub
->limited_power
= 0;
5187 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5191 dev_dbg(hub_dev
, "over-current change\n");
5192 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5193 msleep(500); /* Cool down */
5194 hub_power_on(hub
, true);
5195 hub_hub_status(hub
, &status
, &unused
);
5196 if (status
& HUB_STATUS_OVERCURRENT
)
5197 dev_err(hub_dev
, "over-current condition\n");
5202 /* Balance the usb_autopm_get_interface() above */
5203 usb_autopm_put_interface_no_suspend(intf
);
5205 hcd
->is_in_hub_event
= false;
5206 usb_unlock_device(hdev
);
5208 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5209 usb_autopm_put_interface(intf
);
5210 kref_put(&hub
->kref
, hub_release
);
5213 static const struct usb_device_id hub_id_table
[] = {
5214 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5215 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5216 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5217 .bInterfaceClass
= USB_CLASS_HUB
,
5218 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5219 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5220 .bDeviceClass
= USB_CLASS_HUB
},
5221 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5222 .bInterfaceClass
= USB_CLASS_HUB
},
5223 { } /* Terminating entry */
5226 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5228 static struct usb_driver hub_driver
= {
5231 .disconnect
= hub_disconnect
,
5232 .suspend
= hub_suspend
,
5233 .resume
= hub_resume
,
5234 .reset_resume
= hub_reset_resume
,
5235 .pre_reset
= hub_pre_reset
,
5236 .post_reset
= hub_post_reset
,
5237 .unlocked_ioctl
= hub_ioctl
,
5238 .id_table
= hub_id_table
,
5239 .supports_autosuspend
= 1,
5242 int usb_hub_init(void)
5244 if (usb_register(&hub_driver
) < 0) {
5245 printk(KERN_ERR
"%s: can't register hub driver\n",
5251 * The workqueue needs to be freezable to avoid interfering with
5252 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5253 * device was gone before the EHCI controller had handed its port
5254 * over to the companion full-speed controller.
5256 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5260 /* Fall through if kernel_thread failed */
5261 usb_deregister(&hub_driver
);
5262 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5267 void usb_hub_cleanup(void)
5269 destroy_workqueue(hub_wq
);
5272 * Hub resources are freed for us by usb_deregister. It calls
5273 * usb_driver_purge on every device which in turn calls that
5274 * devices disconnect function if it is using this driver.
5275 * The hub_disconnect function takes care of releasing the
5276 * individual hub resources. -greg
5278 usb_deregister(&hub_driver
);
5279 } /* usb_hub_cleanup() */
5281 static int descriptors_changed(struct usb_device
*udev
,
5282 struct usb_device_descriptor
*old_device_descriptor
,
5283 struct usb_host_bos
*old_bos
)
5287 unsigned serial_len
= 0;
5289 unsigned old_length
;
5293 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5294 sizeof(*old_device_descriptor
)) != 0)
5297 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5300 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5301 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5303 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5307 /* Since the idVendor, idProduct, and bcdDevice values in the
5308 * device descriptor haven't changed, we will assume the
5309 * Manufacturer and Product strings haven't changed either.
5310 * But the SerialNumber string could be different (e.g., a
5311 * different flash card of the same brand).
5314 serial_len
= strlen(udev
->serial
) + 1;
5317 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5318 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5319 len
= max(len
, old_length
);
5322 buf
= kmalloc(len
, GFP_NOIO
);
5324 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5325 /* assume the worst */
5328 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5329 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5330 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5332 if (length
!= old_length
) {
5333 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5338 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5340 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5342 ((struct usb_config_descriptor
*) buf
)->
5343 bConfigurationValue
);
5349 if (!changed
&& serial_len
) {
5350 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5352 if (length
+ 1 != serial_len
) {
5353 dev_dbg(&udev
->dev
, "serial string error %d\n",
5356 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5357 dev_dbg(&udev
->dev
, "serial string changed\n");
5367 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5368 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5370 * WARNING - don't use this routine to reset a composite device
5371 * (one with multiple interfaces owned by separate drivers)!
5372 * Use usb_reset_device() instead.
5374 * Do a port reset, reassign the device's address, and establish its
5375 * former operating configuration. If the reset fails, or the device's
5376 * descriptors change from their values before the reset, or the original
5377 * configuration and altsettings cannot be restored, a flag will be set
5378 * telling hub_wq to pretend the device has been disconnected and then
5379 * re-connected. All drivers will be unbound, and the device will be
5380 * re-enumerated and probed all over again.
5382 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5383 * flagged for logical disconnection, or some other negative error code
5384 * if the reset wasn't even attempted.
5387 * The caller must own the device lock and the port lock, the latter is
5388 * taken by usb_reset_device(). For example, it's safe to use
5389 * usb_reset_device() from a driver probe() routine after downloading
5390 * new firmware. For calls that might not occur during probe(), drivers
5391 * should lock the device using usb_lock_device_for_reset().
5393 * Locking exception: This routine may also be called from within an
5394 * autoresume handler. Such usage won't conflict with other tasks
5395 * holding the device lock because these tasks should always call
5396 * usb_autopm_resume_device(), thereby preventing any unwanted
5397 * autoresume. The autoresume handler is expected to have already
5398 * acquired the port lock before calling this routine.
5400 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5402 struct usb_device
*parent_hdev
= udev
->parent
;
5403 struct usb_hub
*parent_hub
;
5404 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5405 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5406 struct usb_host_bos
*bos
;
5408 int port1
= udev
->portnum
;
5410 if (udev
->state
== USB_STATE_NOTATTACHED
||
5411 udev
->state
== USB_STATE_SUSPENDED
) {
5412 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5420 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5422 /* Disable USB2 hardware LPM.
5423 * It will be re-enabled by the enumeration process.
5425 if (udev
->usb2_hw_lpm_enabled
== 1)
5426 usb_set_usb2_hardware_lpm(udev
, 0);
5428 /* Disable LPM and LTM while we reset the device and reinstall the alt
5429 * settings. Device-initiated LPM settings, and system exit latency
5430 * settings are cleared when the device is reset, so we have to set
5433 ret
= usb_unlocked_disable_lpm(udev
);
5435 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5436 goto re_enumerate_no_bos
;
5438 ret
= usb_disable_ltm(udev
);
5440 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5442 goto re_enumerate_no_bos
;
5448 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5450 /* ep0 maxpacket size may change; let the HCD know about it.
5451 * Other endpoints will be handled by re-enumeration. */
5452 usb_ep0_reinit(udev
);
5453 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5454 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5461 /* Device might have changed firmware (DFU or similar) */
5462 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5463 dev_info(&udev
->dev
, "device firmware changed\n");
5464 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5468 /* Restore the device's previous configuration */
5469 if (!udev
->actconfig
)
5472 mutex_lock(hcd
->bandwidth_mutex
);
5473 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5475 dev_warn(&udev
->dev
,
5476 "Busted HC? Not enough HCD resources for "
5477 "old configuration.\n");
5478 mutex_unlock(hcd
->bandwidth_mutex
);
5481 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5482 USB_REQ_SET_CONFIGURATION
, 0,
5483 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5484 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5487 "can't restore configuration #%d (error=%d)\n",
5488 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5489 mutex_unlock(hcd
->bandwidth_mutex
);
5492 mutex_unlock(hcd
->bandwidth_mutex
);
5493 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5495 /* Put interfaces back into the same altsettings as before.
5496 * Don't bother to send the Set-Interface request for interfaces
5497 * that were already in altsetting 0; besides being unnecessary,
5498 * many devices can't handle it. Instead just reset the host-side
5501 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5502 struct usb_host_config
*config
= udev
->actconfig
;
5503 struct usb_interface
*intf
= config
->interface
[i
];
5504 struct usb_interface_descriptor
*desc
;
5506 desc
= &intf
->cur_altsetting
->desc
;
5507 if (desc
->bAlternateSetting
== 0) {
5508 usb_disable_interface(udev
, intf
, true);
5509 usb_enable_interface(udev
, intf
, true);
5512 /* Let the bandwidth allocation function know that this
5513 * device has been reset, and it will have to use
5514 * alternate setting 0 as the current alternate setting.
5516 intf
->resetting_device
= 1;
5517 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5518 desc
->bAlternateSetting
);
5519 intf
->resetting_device
= 0;
5522 dev_err(&udev
->dev
, "failed to restore interface %d "
5523 "altsetting %d (error=%d)\n",
5524 desc
->bInterfaceNumber
,
5525 desc
->bAlternateSetting
,
5529 /* Resetting also frees any allocated streams */
5530 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5531 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5535 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5536 usb_set_usb2_hardware_lpm(udev
, 1);
5537 usb_unlocked_enable_lpm(udev
);
5538 usb_enable_ltm(udev
);
5539 usb_release_bos_descriptor(udev
);
5544 usb_release_bos_descriptor(udev
);
5546 re_enumerate_no_bos
:
5547 /* LPM state doesn't matter when we're about to destroy the device. */
5548 hub_port_logical_disconnect(parent_hub
, port1
);
5553 * usb_reset_device - warn interface drivers and perform a USB port reset
5554 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5556 * Warns all drivers bound to registered interfaces (using their pre_reset
5557 * method), performs the port reset, and then lets the drivers know that
5558 * the reset is over (using their post_reset method).
5560 * Return: The same as for usb_reset_and_verify_device().
5563 * The caller must own the device lock. For example, it's safe to use
5564 * this from a driver probe() routine after downloading new firmware.
5565 * For calls that might not occur during probe(), drivers should lock
5566 * the device using usb_lock_device_for_reset().
5568 * If an interface is currently being probed or disconnected, we assume
5569 * its driver knows how to handle resets. For all other interfaces,
5570 * if the driver doesn't have pre_reset and post_reset methods then
5571 * we attempt to unbind it and rebind afterward.
5573 int usb_reset_device(struct usb_device
*udev
)
5577 unsigned int noio_flag
;
5578 struct usb_port
*port_dev
;
5579 struct usb_host_config
*config
= udev
->actconfig
;
5580 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5582 if (udev
->state
== USB_STATE_NOTATTACHED
||
5583 udev
->state
== USB_STATE_SUSPENDED
) {
5584 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5589 if (!udev
->parent
) {
5590 /* this requires hcd-specific logic; see ohci_restart() */
5591 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5595 port_dev
= hub
->ports
[udev
->portnum
- 1];
5598 * Don't allocate memory with GFP_KERNEL in current
5599 * context to avoid possible deadlock if usb mass
5600 * storage interface or usbnet interface(iSCSI case)
5601 * is included in current configuration. The easist
5602 * approach is to do it for every device reset,
5603 * because the device 'memalloc_noio' flag may have
5604 * not been set before reseting the usb device.
5606 noio_flag
= memalloc_noio_save();
5608 /* Prevent autosuspend during the reset */
5609 usb_autoresume_device(udev
);
5612 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5613 struct usb_interface
*cintf
= config
->interface
[i
];
5614 struct usb_driver
*drv
;
5617 if (cintf
->dev
.driver
) {
5618 drv
= to_usb_driver(cintf
->dev
.driver
);
5619 if (drv
->pre_reset
&& drv
->post_reset
)
5620 unbind
= (drv
->pre_reset
)(cintf
);
5621 else if (cintf
->condition
==
5622 USB_INTERFACE_BOUND
)
5625 usb_forced_unbind_intf(cintf
);
5630 usb_lock_port(port_dev
);
5631 ret
= usb_reset_and_verify_device(udev
);
5632 usb_unlock_port(port_dev
);
5635 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5636 struct usb_interface
*cintf
= config
->interface
[i
];
5637 struct usb_driver
*drv
;
5638 int rebind
= cintf
->needs_binding
;
5640 if (!rebind
&& cintf
->dev
.driver
) {
5641 drv
= to_usb_driver(cintf
->dev
.driver
);
5642 if (drv
->post_reset
)
5643 rebind
= (drv
->post_reset
)(cintf
);
5644 else if (cintf
->condition
==
5645 USB_INTERFACE_BOUND
)
5648 cintf
->needs_binding
= 1;
5651 usb_unbind_and_rebind_marked_interfaces(udev
);
5654 usb_autosuspend_device(udev
);
5655 memalloc_noio_restore(noio_flag
);
5658 EXPORT_SYMBOL_GPL(usb_reset_device
);
5662 * usb_queue_reset_device - Reset a USB device from an atomic context
5663 * @iface: USB interface belonging to the device to reset
5665 * This function can be used to reset a USB device from an atomic
5666 * context, where usb_reset_device() won't work (as it blocks).
5668 * Doing a reset via this method is functionally equivalent to calling
5669 * usb_reset_device(), except for the fact that it is delayed to a
5670 * workqueue. This means that any drivers bound to other interfaces
5671 * might be unbound, as well as users from usbfs in user space.
5675 * - Scheduling two resets at the same time from two different drivers
5676 * attached to two different interfaces of the same device is
5677 * possible; depending on how the driver attached to each interface
5678 * handles ->pre_reset(), the second reset might happen or not.
5680 * - If the reset is delayed so long that the interface is unbound from
5681 * its driver, the reset will be skipped.
5683 * - This function can be called during .probe(). It can also be called
5684 * during .disconnect(), but doing so is pointless because the reset
5685 * will not occur. If you really want to reset the device during
5686 * .disconnect(), call usb_reset_device() directly -- but watch out
5687 * for nested unbinding issues!
5689 void usb_queue_reset_device(struct usb_interface
*iface
)
5691 if (schedule_work(&iface
->reset_ws
))
5692 usb_get_intf(iface
);
5694 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5697 * usb_hub_find_child - Get the pointer of child device
5698 * attached to the port which is specified by @port1.
5699 * @hdev: USB device belonging to the usb hub
5700 * @port1: port num to indicate which port the child device
5703 * USB drivers call this function to get hub's child device
5706 * Return: %NULL if input param is invalid and
5707 * child's usb_device pointer if non-NULL.
5709 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5712 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5714 if (port1
< 1 || port1
> hdev
->maxchild
)
5716 return hub
->ports
[port1
- 1]->child
;
5718 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5720 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5721 struct usb_hub_descriptor
*desc
)
5723 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5724 enum usb_port_connect_type connect_type
;
5730 if (!hub_is_superspeed(hdev
)) {
5731 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5732 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5734 connect_type
= port_dev
->connect_type
;
5735 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5736 u8 mask
= 1 << (i
%8);
5738 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5739 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5740 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5745 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5747 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5748 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5750 connect_type
= port_dev
->connect_type
;
5751 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5754 if (!(port_removable
& mask
)) {
5755 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5756 port_removable
|= mask
;
5761 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5767 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5768 * @hdev: USB device belonging to the usb hub
5769 * @port1: port num of the port
5771 * Return: Port's acpi handle if successful, %NULL if params are
5774 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5777 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5782 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);