1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
41 /* Protect struct usb_device->state and ->children members
42 * Note: Both are also protected by ->dev.sem, except that ->state can
43 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
44 static DEFINE_SPINLOCK(device_state_lock
);
46 /* workqueue to process hub events */
47 static struct workqueue_struct
*hub_wq
;
48 static void hub_event(struct work_struct
*work
);
50 /* synchronize hub-port add/remove and peering operations */
51 DEFINE_MUTEX(usb_port_peer_mutex
);
53 /* cycle leds on hubs that aren't blinking for attention */
54 static bool blinkenlights
;
55 module_param(blinkenlights
, bool, S_IRUGO
);
56 MODULE_PARM_DESC(blinkenlights
, "true to cycle leds on hubs");
59 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
60 * 10 seconds to send reply for the initial 64-byte descriptor request.
62 /* define initial 64-byte descriptor request timeout in milliseconds */
63 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
64 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
65 MODULE_PARM_DESC(initial_descriptor_timeout
,
66 "initial 64-byte descriptor request timeout in milliseconds "
67 "(default 5000 - 5.0 seconds)");
70 * As of 2.6.10 we introduce a new USB device initialization scheme which
71 * closely resembles the way Windows works. Hopefully it will be compatible
72 * with a wider range of devices than the old scheme. However some previously
73 * working devices may start giving rise to "device not accepting address"
74 * errors; if that happens the user can try the old scheme by adjusting the
75 * following module parameters.
77 * For maximum flexibility there are two boolean parameters to control the
78 * hub driver's behavior. On the first initialization attempt, if the
79 * "old_scheme_first" parameter is set then the old scheme will be used,
80 * otherwise the new scheme is used. If that fails and "use_both_schemes"
81 * is set, then the driver will make another attempt, using the other scheme.
83 static bool old_scheme_first
;
84 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
85 MODULE_PARM_DESC(old_scheme_first
,
86 "start with the old device initialization scheme");
88 static bool use_both_schemes
= 1;
89 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
90 MODULE_PARM_DESC(use_both_schemes
,
91 "try the other device initialization scheme if the "
94 /* Mutual exclusion for EHCI CF initialization. This interferes with
95 * port reset on some companion controllers.
97 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
98 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
100 #define HUB_DEBOUNCE_TIMEOUT 2000
101 #define HUB_DEBOUNCE_STEP 25
102 #define HUB_DEBOUNCE_STABLE 100
104 static void hub_release(struct kref
*kref
);
105 static int usb_reset_and_verify_device(struct usb_device
*udev
);
106 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
);
108 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
110 if (hub_is_superspeedplus(hub
->hdev
))
112 if (hub_is_superspeed(hub
->hdev
))
114 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
116 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
122 /* Note that hdev or one of its children must be locked! */
123 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
125 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
127 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
130 int usb_device_supports_lpm(struct usb_device
*udev
)
132 /* Some devices have trouble with LPM */
133 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
136 /* USB 2.1 (and greater) devices indicate LPM support through
137 * their USB 2.0 Extended Capabilities BOS descriptor.
139 if (udev
->speed
== USB_SPEED_HIGH
|| udev
->speed
== USB_SPEED_FULL
) {
140 if (udev
->bos
->ext_cap
&&
142 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
148 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
149 * However, there are some that don't, and they set the U1/U2 exit
152 if (!udev
->bos
->ss_cap
) {
153 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
157 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
158 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
160 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
162 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
166 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device
*udev
,
176 struct usb3_lpm_parameters
*udev_lpm_params
,
177 unsigned int udev_exit_latency
,
179 struct usb3_lpm_parameters
*hub_lpm_params
,
180 unsigned int hub_exit_latency
)
182 unsigned int total_mel
;
183 unsigned int device_mel
;
184 unsigned int hub_mel
;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel
= hub_lpm_params
->mel
+
196 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel
= udev_exit_latency
* 1000;
207 hub_mel
= hub_exit_latency
* 1000;
208 if (device_mel
> hub_mel
)
209 total_mel
+= device_mel
;
211 total_mel
+= hub_mel
;
213 udev_lpm_params
->mel
= total_mel
;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device
*udev
,
221 struct usb3_lpm_parameters
*udev_lpm_params
,
222 unsigned int udev_exit_latency
,
224 struct usb3_lpm_parameters
*hub_lpm_params
,
225 unsigned int hub_exit_latency
,
226 unsigned int port_to_port_exit_latency
)
228 unsigned int first_link_pel
;
229 unsigned int hub_pel
;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency
> hub_exit_latency
)
237 first_link_pel
= udev_exit_latency
* 1000;
239 first_link_pel
= hub_exit_latency
* 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel
> hub_pel
)
254 udev_lpm_params
->pel
= first_link_pel
;
256 udev_lpm_params
->pel
= hub_pel
;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device
*udev
,
275 struct usb3_lpm_parameters
*udev_lpm_params
)
277 struct usb_device
*parent
;
278 unsigned int num_hubs
;
279 unsigned int total_sel
;
281 /* t1 = device PEL */
282 total_sel
= udev_lpm_params
->pel
;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
285 parent
= parent
->parent
)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel
+= 2100 + 250 * (num_hubs
- 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel
+= 250 * num_hubs
;
294 udev_lpm_params
->sel
= total_sel
;
297 static void usb_set_lpm_parameters(struct usb_device
*udev
)
300 unsigned int port_to_port_delay
;
301 unsigned int udev_u1_del
;
302 unsigned int udev_u2_del
;
303 unsigned int hub_u1_del
;
304 unsigned int hub_u2_del
;
306 if (!udev
->lpm_capable
|| udev
->speed
< USB_SPEED_SUPER
)
309 hub
= usb_hub_to_struct_hub(udev
->parent
);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
317 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
318 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
319 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
321 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
322 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
324 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
325 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay
= 1;
346 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
347 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
350 if (hub_u2_del
> hub_u1_del
)
351 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
353 port_to_port_delay
= 1 + hub_u1_del
;
355 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
356 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev
, &udev
->u1_params
);
361 usb_set_lpm_sel(udev
, &udev
->u2_params
);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device
*hdev
,
366 struct usb_hub_descriptor
*desc
)
371 if (hub_is_superspeed(hdev
)) {
372 dtype
= USB_DT_SS_HUB
;
373 size
= USB_DT_SS_HUB_SIZE
;
376 size
= sizeof(struct usb_hub_descriptor
);
379 for (i
= 0; i
< 3; i
++) {
380 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
381 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
382 dtype
<< 8, 0, desc
, size
,
383 USB_CTRL_GET_TIMEOUT
);
384 if (hub_is_superspeed(hdev
)) {
387 } else if (ret
>= USB_DT_HUB_NONVAR_SIZE
+ 2) {
388 /* Make sure we have the DeviceRemovable field. */
389 size
= USB_DT_HUB_NONVAR_SIZE
+ desc
->bNbrPorts
/ 8 + 1;
399 * USB 2.0 spec Section 11.24.2.1
401 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
403 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
404 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
408 * USB 2.0 spec Section 11.24.2.2
410 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
412 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
413 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
418 * USB 2.0 spec Section 11.24.2.13
420 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
422 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
423 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
427 static char *to_led_name(int selector
)
444 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
445 * for info about using port indicators
447 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
449 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
452 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
453 USB_PORT_FEAT_INDICATOR
);
454 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
455 to_led_name(selector
), status
);
458 #define LED_CYCLE_PERIOD ((2*HZ)/3)
460 static void led_work(struct work_struct
*work
)
462 struct usb_hub
*hub
=
463 container_of(work
, struct usb_hub
, leds
.work
);
464 struct usb_device
*hdev
= hub
->hdev
;
466 unsigned changed
= 0;
469 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
472 for (i
= 0; i
< hdev
->maxchild
; i
++) {
473 unsigned selector
, mode
;
475 /* 30%-50% duty cycle */
477 switch (hub
->indicator
[i
]) {
479 case INDICATOR_CYCLE
:
481 selector
= HUB_LED_AUTO
;
482 mode
= INDICATOR_AUTO
;
484 /* blinking green = sw attention */
485 case INDICATOR_GREEN_BLINK
:
486 selector
= HUB_LED_GREEN
;
487 mode
= INDICATOR_GREEN_BLINK_OFF
;
489 case INDICATOR_GREEN_BLINK_OFF
:
490 selector
= HUB_LED_OFF
;
491 mode
= INDICATOR_GREEN_BLINK
;
493 /* blinking amber = hw attention */
494 case INDICATOR_AMBER_BLINK
:
495 selector
= HUB_LED_AMBER
;
496 mode
= INDICATOR_AMBER_BLINK_OFF
;
498 case INDICATOR_AMBER_BLINK_OFF
:
499 selector
= HUB_LED_OFF
;
500 mode
= INDICATOR_AMBER_BLINK
;
502 /* blink green/amber = reserved */
503 case INDICATOR_ALT_BLINK
:
504 selector
= HUB_LED_GREEN
;
505 mode
= INDICATOR_ALT_BLINK_OFF
;
507 case INDICATOR_ALT_BLINK_OFF
:
508 selector
= HUB_LED_AMBER
;
509 mode
= INDICATOR_ALT_BLINK
;
514 if (selector
!= HUB_LED_AUTO
)
516 set_port_led(hub
, i
+ 1, selector
);
517 hub
->indicator
[i
] = mode
;
519 if (!changed
&& blinkenlights
) {
521 cursor
%= hdev
->maxchild
;
522 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
523 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
527 queue_delayed_work(system_power_efficient_wq
,
528 &hub
->leds
, LED_CYCLE_PERIOD
);
531 /* use a short timeout for hub/port status fetches */
532 #define USB_STS_TIMEOUT 1000
533 #define USB_STS_RETRIES 5
536 * USB 2.0 spec Section 11.24.2.6
538 static int get_hub_status(struct usb_device
*hdev
,
539 struct usb_hub_status
*data
)
541 int i
, status
= -ETIMEDOUT
;
543 for (i
= 0; i
< USB_STS_RETRIES
&&
544 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
545 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
546 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
547 data
, sizeof(*data
), USB_STS_TIMEOUT
);
553 * USB 2.0 spec Section 11.24.2.7
554 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
556 static int get_port_status(struct usb_device
*hdev
, int port1
,
557 void *data
, u16 value
, u16 length
)
559 int i
, status
= -ETIMEDOUT
;
561 for (i
= 0; i
< USB_STS_RETRIES
&&
562 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
563 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
564 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, value
,
565 port1
, data
, length
, USB_STS_TIMEOUT
);
570 static int hub_ext_port_status(struct usb_hub
*hub
, int port1
, int type
,
571 u16
*status
, u16
*change
, u32
*ext_status
)
576 if (type
!= HUB_PORT_STATUS
)
579 mutex_lock(&hub
->status_mutex
);
580 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
, type
, len
);
583 dev_err(hub
->intfdev
,
584 "%s failed (err = %d)\n", __func__
, ret
);
588 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
589 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
590 if (type
!= HUB_PORT_STATUS
&& ext_status
)
591 *ext_status
= le32_to_cpu(
592 hub
->status
->port
.dwExtPortStatus
);
595 mutex_unlock(&hub
->status_mutex
);
599 static int hub_port_status(struct usb_hub
*hub
, int port1
,
600 u16
*status
, u16
*change
)
602 return hub_ext_port_status(hub
, port1
, HUB_PORT_STATUS
,
603 status
, change
, NULL
);
606 static void kick_hub_wq(struct usb_hub
*hub
)
608 struct usb_interface
*intf
;
610 if (hub
->disconnected
|| work_pending(&hub
->events
))
614 * Suppress autosuspend until the event is proceed.
616 * Be careful and make sure that the symmetric operation is
617 * always called. We are here only when there is no pending
618 * work for this hub. Therefore put the interface either when
619 * the new work is called or when it is canceled.
621 intf
= to_usb_interface(hub
->intfdev
);
622 usb_autopm_get_interface_no_resume(intf
);
623 kref_get(&hub
->kref
);
625 if (queue_work(hub_wq
, &hub
->events
))
628 /* the work has already been scheduled */
629 usb_autopm_put_interface_async(intf
);
630 kref_put(&hub
->kref
, hub_release
);
633 void usb_kick_hub_wq(struct usb_device
*hdev
)
635 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
642 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
643 * Notification, which indicates it had initiated remote wakeup.
645 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
646 * device initiates resume, so the USB core will not receive notice of the
647 * resume through the normal hub interrupt URB.
649 void usb_wakeup_notification(struct usb_device
*hdev
,
650 unsigned int portnum
)
653 struct usb_port
*port_dev
;
658 hub
= usb_hub_to_struct_hub(hdev
);
660 port_dev
= hub
->ports
[portnum
- 1];
661 if (port_dev
&& port_dev
->child
)
662 pm_wakeup_event(&port_dev
->child
->dev
, 0);
664 set_bit(portnum
, hub
->wakeup_bits
);
668 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
670 /* completion function, fires on port status changes and various faults */
671 static void hub_irq(struct urb
*urb
)
673 struct usb_hub
*hub
= urb
->context
;
674 int status
= urb
->status
;
679 case -ENOENT
: /* synchronous unlink */
680 case -ECONNRESET
: /* async unlink */
681 case -ESHUTDOWN
: /* hardware going away */
684 default: /* presumably an error */
685 /* Cause a hub reset after 10 consecutive errors */
686 dev_dbg(hub
->intfdev
, "transfer --> %d\n", status
);
687 if ((++hub
->nerrors
< 10) || hub
->error
)
692 /* let hub_wq handle things */
693 case 0: /* we got data: port status changed */
695 for (i
= 0; i
< urb
->actual_length
; ++i
)
696 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
698 hub
->event_bits
[0] = bits
;
704 /* Something happened, let hub_wq figure it out */
711 status
= usb_submit_urb(hub
->urb
, GFP_ATOMIC
);
712 if (status
!= 0 && status
!= -ENODEV
&& status
!= -EPERM
)
713 dev_err(hub
->intfdev
, "resubmit --> %d\n", status
);
716 /* USB 2.0 spec Section 11.24.2.3 */
718 hub_clear_tt_buffer(struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
720 /* Need to clear both directions for control ep */
721 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
722 USB_ENDPOINT_XFER_CONTROL
) {
723 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
724 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
725 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
729 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
730 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
735 * enumeration blocks hub_wq for a long time. we use keventd instead, since
736 * long blocking there is the exception, not the rule. accordingly, HCDs
737 * talking to TTs must queue control transfers (not just bulk and iso), so
738 * both can talk to the same hub concurrently.
740 static void hub_tt_work(struct work_struct
*work
)
742 struct usb_hub
*hub
=
743 container_of(work
, struct usb_hub
, tt
.clear_work
);
746 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
747 while (!list_empty(&hub
->tt
.clear_list
)) {
748 struct list_head
*next
;
749 struct usb_tt_clear
*clear
;
750 struct usb_device
*hdev
= hub
->hdev
;
751 const struct hc_driver
*drv
;
754 next
= hub
->tt
.clear_list
.next
;
755 clear
= list_entry(next
, struct usb_tt_clear
, clear_list
);
756 list_del(&clear
->clear_list
);
758 /* drop lock so HCD can concurrently report other TT errors */
759 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
760 status
= hub_clear_tt_buffer(hdev
, clear
->devinfo
, clear
->tt
);
761 if (status
&& status
!= -ENODEV
)
763 "clear tt %d (%04x) error %d\n",
764 clear
->tt
, clear
->devinfo
, status
);
766 /* Tell the HCD, even if the operation failed */
767 drv
= clear
->hcd
->driver
;
768 if (drv
->clear_tt_buffer_complete
)
769 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
772 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
774 spin_unlock_irqrestore(&hub
->tt
.lock
, flags
);
778 * usb_hub_set_port_power - control hub port's power state
779 * @hdev: USB device belonging to the usb hub
782 * @set: expected status
784 * call this function to control port's power via setting or
785 * clearing the port's PORT_POWER feature.
787 * Return: 0 if successful. A negative error code otherwise.
789 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
795 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
797 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
803 set_bit(port1
, hub
->power_bits
);
805 clear_bit(port1
, hub
->power_bits
);
810 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
811 * @urb: an URB associated with the failed or incomplete split transaction
813 * High speed HCDs use this to tell the hub driver that some split control or
814 * bulk transaction failed in a way that requires clearing internal state of
815 * a transaction translator. This is normally detected (and reported) from
818 * It may not be possible for that hub to handle additional full (or low)
819 * speed transactions until that state is fully cleared out.
821 * Return: 0 if successful. A negative error code otherwise.
823 int usb_hub_clear_tt_buffer(struct urb
*urb
)
825 struct usb_device
*udev
= urb
->dev
;
826 int pipe
= urb
->pipe
;
827 struct usb_tt
*tt
= udev
->tt
;
829 struct usb_tt_clear
*clear
;
831 /* we've got to cope with an arbitrary number of pending TT clears,
832 * since each TT has "at least two" buffers that can need it (and
833 * there can be many TTs per hub). even if they're uncommon.
835 clear
= kmalloc(sizeof *clear
, GFP_ATOMIC
);
837 dev_err(&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
838 /* FIXME recover somehow ... RESET_TT? */
842 /* info that CLEAR_TT_BUFFER needs */
843 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
844 clear
->devinfo
= usb_pipeendpoint (pipe
);
845 clear
->devinfo
|= udev
->devnum
<< 4;
846 clear
->devinfo
|= usb_pipecontrol(pipe
)
847 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
848 : (USB_ENDPOINT_XFER_BULK
<< 11);
849 if (usb_pipein(pipe
))
850 clear
->devinfo
|= 1 << 15;
852 /* info for completion callback */
853 clear
->hcd
= bus_to_hcd(udev
->bus
);
856 /* tell keventd to clear state for this TT */
857 spin_lock_irqsave(&tt
->lock
, flags
);
858 list_add_tail(&clear
->clear_list
, &tt
->clear_list
);
859 schedule_work(&tt
->clear_work
);
860 spin_unlock_irqrestore(&tt
->lock
, flags
);
863 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
865 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
869 /* Enable power on each port. Some hubs have reserved values
870 * of LPSM (> 2) in their descriptors, even though they are
871 * USB 2.0 hubs. Some hubs do not implement port-power switching
872 * but only emulate it. In all cases, the ports won't work
873 * unless we send these messages to the hub.
875 if (hub_is_port_power_switchable(hub
))
876 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
878 dev_dbg(hub
->intfdev
, "trying to enable port power on "
879 "non-switchable hub\n");
880 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
881 if (test_bit(port1
, hub
->power_bits
))
882 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
884 usb_clear_port_feature(hub
->hdev
, port1
,
885 USB_PORT_FEAT_POWER
);
887 msleep(hub_power_on_good_delay(hub
));
890 static int hub_hub_status(struct usb_hub
*hub
,
891 u16
*status
, u16
*change
)
895 mutex_lock(&hub
->status_mutex
);
896 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
899 dev_err(hub
->intfdev
,
900 "%s failed (err = %d)\n", __func__
, ret
);
902 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
903 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
906 mutex_unlock(&hub
->status_mutex
);
910 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
911 unsigned int link_status
)
913 return set_port_feature(hub
->hdev
,
914 port1
| (link_status
<< 3),
915 USB_PORT_FEAT_LINK_STATE
);
919 * Disable a port and mark a logical connect-change event, so that some
920 * time later hub_wq will disconnect() any existing usb_device on the port
921 * and will re-enumerate if there actually is a device attached.
923 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
925 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
926 hub_port_disable(hub
, port1
, 1);
928 /* FIXME let caller ask to power down the port:
929 * - some devices won't enumerate without a VBUS power cycle
930 * - SRP saves power that way
931 * - ... new call, TBD ...
932 * That's easy if this hub can switch power per-port, and
933 * hub_wq reactivates the port later (timer, SRP, etc).
934 * Powerdown must be optional, because of reset/DFU.
937 set_bit(port1
, hub
->change_bits
);
942 * usb_remove_device - disable a device's port on its parent hub
943 * @udev: device to be disabled and removed
944 * Context: @udev locked, must be able to sleep.
946 * After @udev's port has been disabled, hub_wq is notified and it will
947 * see that the device has been disconnected. When the device is
948 * physically unplugged and something is plugged in, the events will
949 * be received and processed normally.
951 * Return: 0 if successful. A negative error code otherwise.
953 int usb_remove_device(struct usb_device
*udev
)
956 struct usb_interface
*intf
;
958 if (!udev
->parent
) /* Can't remove a root hub */
960 hub
= usb_hub_to_struct_hub(udev
->parent
);
961 intf
= to_usb_interface(hub
->intfdev
);
963 usb_autopm_get_interface(intf
);
964 set_bit(udev
->portnum
, hub
->removed_bits
);
965 hub_port_logical_disconnect(hub
, udev
->portnum
);
966 usb_autopm_put_interface(intf
);
970 enum hub_activation_type
{
971 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
972 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
975 static void hub_init_func2(struct work_struct
*ws
);
976 static void hub_init_func3(struct work_struct
*ws
);
978 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
980 struct usb_device
*hdev
= hub
->hdev
;
985 bool need_debounce_delay
= false;
988 /* Continue a partial initialization */
989 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
990 device_lock(&hdev
->dev
);
992 /* Was the hub disconnected while we were waiting? */
993 if (hub
->disconnected
)
995 if (type
== HUB_INIT2
)
999 kref_get(&hub
->kref
);
1001 /* The superspeed hub except for root hub has to use Hub Depth
1002 * value as an offset into the route string to locate the bits
1003 * it uses to determine the downstream port number. So hub driver
1004 * should send a set hub depth request to superspeed hub after
1005 * the superspeed hub is set configuration in initialization or
1008 * After a resume, port power should still be on.
1009 * For any other type of activation, turn it on.
1011 if (type
!= HUB_RESUME
) {
1012 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1013 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1014 HUB_SET_DEPTH
, USB_RT_HUB
,
1015 hdev
->level
- 1, 0, NULL
, 0,
1016 USB_CTRL_SET_TIMEOUT
);
1018 dev_err(hub
->intfdev
,
1019 "set hub depth failed\n");
1022 /* Speed up system boot by using a delayed_work for the
1023 * hub's initial power-up delays. This is pretty awkward
1024 * and the implementation looks like a home-brewed sort of
1025 * setjmp/longjmp, but it saves at least 100 ms for each
1026 * root hub (assuming usbcore is compiled into the kernel
1027 * rather than as a module). It adds up.
1029 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1030 * because for those activation types the ports have to be
1031 * operational when we return. In theory this could be done
1032 * for HUB_POST_RESET, but it's easier not to.
1034 if (type
== HUB_INIT
) {
1035 delay
= hub_power_on_good_delay(hub
);
1037 hub_power_on(hub
, false);
1038 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1039 queue_delayed_work(system_power_efficient_wq
,
1041 msecs_to_jiffies(delay
));
1043 /* Suppress autosuspend until init is done */
1044 usb_autopm_get_interface_no_resume(
1045 to_usb_interface(hub
->intfdev
));
1046 return; /* Continues at init2: below */
1047 } else if (type
== HUB_RESET_RESUME
) {
1048 /* The internal host controller state for the hub device
1049 * may be gone after a host power loss on system resume.
1050 * Update the device's info so the HW knows it's a hub.
1052 hcd
= bus_to_hcd(hdev
->bus
);
1053 if (hcd
->driver
->update_hub_device
) {
1054 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1055 &hub
->tt
, GFP_NOIO
);
1057 dev_err(hub
->intfdev
, "Host not "
1058 "accepting hub info "
1060 dev_err(hub
->intfdev
, "LS/FS devices "
1061 "and hubs may not work "
1062 "under this hub\n.");
1065 hub_power_on(hub
, true);
1067 hub_power_on(hub
, true);
1073 * Check each port and set hub->change_bits to let hub_wq know
1074 * which ports need attention.
1076 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1077 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1078 struct usb_device
*udev
= port_dev
->child
;
1079 u16 portstatus
, portchange
;
1081 portstatus
= portchange
= 0;
1082 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1086 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1087 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1088 portstatus
, portchange
);
1091 * After anything other than HUB_RESUME (i.e., initialization
1092 * or any sort of reset), every port should be disabled.
1093 * Unconnected ports should likewise be disabled (paranoia),
1094 * and so should ports for which we have no usb_device.
1096 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1097 type
!= HUB_RESUME
||
1098 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1100 udev
->state
== USB_STATE_NOTATTACHED
)) {
1102 * USB3 protocol ports will automatically transition
1103 * to Enabled state when detect an USB3.0 device attach.
1104 * Do not disable USB3 protocol ports, just pretend
1107 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1108 if (!hub_is_superspeed(hdev
))
1109 usb_clear_port_feature(hdev
, port1
,
1110 USB_PORT_FEAT_ENABLE
);
1113 /* Clear status-change flags; we'll debounce later */
1114 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1115 need_debounce_delay
= true;
1116 usb_clear_port_feature(hub
->hdev
, port1
,
1117 USB_PORT_FEAT_C_CONNECTION
);
1119 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1120 need_debounce_delay
= true;
1121 usb_clear_port_feature(hub
->hdev
, port1
,
1122 USB_PORT_FEAT_C_ENABLE
);
1124 if (portchange
& USB_PORT_STAT_C_RESET
) {
1125 need_debounce_delay
= true;
1126 usb_clear_port_feature(hub
->hdev
, port1
,
1127 USB_PORT_FEAT_C_RESET
);
1129 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1130 hub_is_superspeed(hub
->hdev
)) {
1131 need_debounce_delay
= true;
1132 usb_clear_port_feature(hub
->hdev
, port1
,
1133 USB_PORT_FEAT_C_BH_PORT_RESET
);
1135 /* We can forget about a "removed" device when there's a
1136 * physical disconnect or the connect status changes.
1138 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1139 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1140 clear_bit(port1
, hub
->removed_bits
);
1142 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1143 /* Tell hub_wq to disconnect the device or
1144 * check for a new connection
1146 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1147 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1148 set_bit(port1
, hub
->change_bits
);
1150 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1151 bool port_resumed
= (portstatus
&
1152 USB_PORT_STAT_LINK_STATE
) ==
1154 /* The power session apparently survived the resume.
1155 * If there was an overcurrent or suspend change
1156 * (i.e., remote wakeup request), have hub_wq
1157 * take care of it. Look at the port link state
1158 * for USB 3.0 hubs, since they don't have a suspend
1159 * change bit, and they don't set the port link change
1160 * bit on device-initiated resume.
1162 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1164 set_bit(port1
, hub
->change_bits
);
1166 } else if (udev
->persist_enabled
) {
1168 udev
->reset_resume
= 1;
1170 /* Don't set the change_bits when the device
1173 if (test_bit(port1
, hub
->power_bits
))
1174 set_bit(port1
, hub
->change_bits
);
1177 /* The power session is gone; tell hub_wq */
1178 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1179 set_bit(port1
, hub
->change_bits
);
1183 /* If no port-status-change flags were set, we don't need any
1184 * debouncing. If flags were set we can try to debounce the
1185 * ports all at once right now, instead of letting hub_wq do them
1186 * one at a time later on.
1188 * If any port-status changes do occur during this delay, hub_wq
1189 * will see them later and handle them normally.
1191 if (need_debounce_delay
) {
1192 delay
= HUB_DEBOUNCE_STABLE
;
1194 /* Don't do a long sleep inside a workqueue routine */
1195 if (type
== HUB_INIT2
) {
1196 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1197 queue_delayed_work(system_power_efficient_wq
,
1199 msecs_to_jiffies(delay
));
1200 device_unlock(&hdev
->dev
);
1201 return; /* Continues at init3: below */
1209 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1211 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1212 if (hub
->has_indicators
&& blinkenlights
)
1213 queue_delayed_work(system_power_efficient_wq
,
1214 &hub
->leds
, LED_CYCLE_PERIOD
);
1216 /* Scan all ports that need attention */
1219 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1220 /* Allow autosuspend if it was suppressed */
1222 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1223 device_unlock(&hdev
->dev
);
1226 kref_put(&hub
->kref
, hub_release
);
1229 /* Implement the continuations for the delays above */
1230 static void hub_init_func2(struct work_struct
*ws
)
1232 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1234 hub_activate(hub
, HUB_INIT2
);
1237 static void hub_init_func3(struct work_struct
*ws
)
1239 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1241 hub_activate(hub
, HUB_INIT3
);
1244 enum hub_quiescing_type
{
1245 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1248 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1250 struct usb_device
*hdev
= hub
->hdev
;
1253 /* hub_wq and related activity won't re-trigger */
1256 if (type
!= HUB_SUSPEND
) {
1257 /* Disconnect all the children */
1258 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1259 if (hub
->ports
[i
]->child
)
1260 usb_disconnect(&hub
->ports
[i
]->child
);
1264 /* Stop hub_wq and related activity */
1265 usb_kill_urb(hub
->urb
);
1266 if (hub
->has_indicators
)
1267 cancel_delayed_work_sync(&hub
->leds
);
1269 flush_work(&hub
->tt
.clear_work
);
1272 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1276 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1277 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1280 /* caller has locked the hub device */
1281 static int hub_pre_reset(struct usb_interface
*intf
)
1283 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1285 hub_quiesce(hub
, HUB_PRE_RESET
);
1287 hub_pm_barrier_for_all_ports(hub
);
1291 /* caller has locked the hub device */
1292 static int hub_post_reset(struct usb_interface
*intf
)
1294 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1297 hub_pm_barrier_for_all_ports(hub
);
1298 hub_activate(hub
, HUB_POST_RESET
);
1302 static int hub_configure(struct usb_hub
*hub
,
1303 struct usb_endpoint_descriptor
*endpoint
)
1305 struct usb_hcd
*hcd
;
1306 struct usb_device
*hdev
= hub
->hdev
;
1307 struct device
*hub_dev
= hub
->intfdev
;
1308 u16 hubstatus
, hubchange
;
1309 u16 wHubCharacteristics
;
1312 char *message
= "out of memory";
1317 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1323 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1328 mutex_init(&hub
->status_mutex
);
1330 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1331 if (!hub
->descriptor
) {
1336 /* Request the entire hub descriptor.
1337 * hub->descriptor can handle USB_MAXCHILDREN ports,
1338 * but a (non-SS) hub can/will return fewer bytes here.
1340 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1342 message
= "can't read hub descriptor";
1346 maxchild
= USB_MAXCHILDREN
;
1347 if (hub_is_superspeed(hdev
))
1348 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1350 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1351 message
= "hub has too many ports!";
1354 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1355 message
= "hub doesn't have any ports!";
1360 maxchild
= hub
->descriptor
->bNbrPorts
;
1361 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1362 (maxchild
== 1) ? "" : "s");
1364 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1370 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1371 if (hub_is_superspeed(hdev
)) {
1379 /* FIXME for USB 3.0, skip for now */
1380 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1381 !(hub_is_superspeed(hdev
))) {
1382 char portstr
[USB_MAXCHILDREN
+ 1];
1384 for (i
= 0; i
< maxchild
; i
++)
1385 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1386 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1388 portstr
[maxchild
] = 0;
1389 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1391 dev_dbg(hub_dev
, "standalone hub\n");
1393 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1394 case HUB_CHAR_COMMON_LPSM
:
1395 dev_dbg(hub_dev
, "ganged power switching\n");
1397 case HUB_CHAR_INDV_PORT_LPSM
:
1398 dev_dbg(hub_dev
, "individual port power switching\n");
1400 case HUB_CHAR_NO_LPSM
:
1402 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1406 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1407 case HUB_CHAR_COMMON_OCPM
:
1408 dev_dbg(hub_dev
, "global over-current protection\n");
1410 case HUB_CHAR_INDV_PORT_OCPM
:
1411 dev_dbg(hub_dev
, "individual port over-current protection\n");
1413 case HUB_CHAR_NO_OCPM
:
1415 dev_dbg(hub_dev
, "no over-current protection\n");
1419 spin_lock_init(&hub
->tt
.lock
);
1420 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1421 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1422 switch (hdev
->descriptor
.bDeviceProtocol
) {
1425 case USB_HUB_PR_HS_SINGLE_TT
:
1426 dev_dbg(hub_dev
, "Single TT\n");
1429 case USB_HUB_PR_HS_MULTI_TT
:
1430 ret
= usb_set_interface(hdev
, 0, 1);
1432 dev_dbg(hub_dev
, "TT per port\n");
1435 dev_err(hub_dev
, "Using single TT (err %d)\n",
1440 /* USB 3.0 hubs don't have a TT */
1443 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1444 hdev
->descriptor
.bDeviceProtocol
);
1448 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1449 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1450 case HUB_TTTT_8_BITS
:
1451 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1452 hub
->tt
.think_time
= 666;
1453 dev_dbg(hub_dev
, "TT requires at most %d "
1454 "FS bit times (%d ns)\n",
1455 8, hub
->tt
.think_time
);
1458 case HUB_TTTT_16_BITS
:
1459 hub
->tt
.think_time
= 666 * 2;
1460 dev_dbg(hub_dev
, "TT requires at most %d "
1461 "FS bit times (%d ns)\n",
1462 16, hub
->tt
.think_time
);
1464 case HUB_TTTT_24_BITS
:
1465 hub
->tt
.think_time
= 666 * 3;
1466 dev_dbg(hub_dev
, "TT requires at most %d "
1467 "FS bit times (%d ns)\n",
1468 24, hub
->tt
.think_time
);
1470 case HUB_TTTT_32_BITS
:
1471 hub
->tt
.think_time
= 666 * 4;
1472 dev_dbg(hub_dev
, "TT requires at most %d "
1473 "FS bit times (%d ns)\n",
1474 32, hub
->tt
.think_time
);
1478 /* probe() zeroes hub->indicator[] */
1479 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1480 hub
->has_indicators
= 1;
1481 dev_dbg(hub_dev
, "Port indicators are supported\n");
1484 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1485 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1487 /* power budgeting mostly matters with bus-powered hubs,
1488 * and battery-powered root hubs (may provide just 8 mA).
1490 ret
= usb_get_std_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1492 message
= "can't get hub status";
1495 hcd
= bus_to_hcd(hdev
->bus
);
1496 if (hdev
== hdev
->bus
->root_hub
) {
1497 if (hcd
->power_budget
> 0)
1498 hdev
->bus_mA
= hcd
->power_budget
;
1500 hdev
->bus_mA
= full_load
* maxchild
;
1501 if (hdev
->bus_mA
>= full_load
)
1502 hub
->mA_per_port
= full_load
;
1504 hub
->mA_per_port
= hdev
->bus_mA
;
1505 hub
->limited_power
= 1;
1507 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1508 int remaining
= hdev
->bus_mA
-
1509 hub
->descriptor
->bHubContrCurrent
;
1511 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1512 hub
->descriptor
->bHubContrCurrent
);
1513 hub
->limited_power
= 1;
1515 if (remaining
< maxchild
* unit_load
)
1517 "insufficient power available "
1518 "to use all downstream ports\n");
1519 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1521 } else { /* Self-powered external hub */
1522 /* FIXME: What about battery-powered external hubs that
1523 * provide less current per port? */
1524 hub
->mA_per_port
= full_load
;
1526 if (hub
->mA_per_port
< full_load
)
1527 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1530 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1532 message
= "can't get hub status";
1536 /* local power status reports aren't always correct */
1537 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1538 dev_dbg(hub_dev
, "local power source is %s\n",
1539 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1540 ? "lost (inactive)" : "good");
1542 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1543 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1544 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1546 /* set up the interrupt endpoint
1547 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1548 * bytes as USB2.0[11.12.3] says because some hubs are known
1549 * to send more data (and thus cause overflow). For root hubs,
1550 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1551 * to be big enough for at least USB_MAXCHILDREN ports. */
1552 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1553 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1555 if (maxp
> sizeof(*hub
->buffer
))
1556 maxp
= sizeof(*hub
->buffer
);
1558 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1564 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1565 hub
, endpoint
->bInterval
);
1567 /* maybe cycle the hub leds */
1568 if (hub
->has_indicators
&& blinkenlights
)
1569 hub
->indicator
[0] = INDICATOR_CYCLE
;
1571 mutex_lock(&usb_port_peer_mutex
);
1572 for (i
= 0; i
< maxchild
; i
++) {
1573 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1575 dev_err(hub
->intfdev
,
1576 "couldn't create port%d device.\n", i
+ 1);
1581 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1582 struct usb_port
*port_dev
= hub
->ports
[i
];
1584 pm_runtime_put(&port_dev
->dev
);
1587 mutex_unlock(&usb_port_peer_mutex
);
1591 /* Update the HCD's internal representation of this hub before hub_wq
1592 * starts getting port status changes for devices under the hub.
1594 if (hcd
->driver
->update_hub_device
) {
1595 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1596 &hub
->tt
, GFP_KERNEL
);
1598 message
= "can't update HCD hub info";
1603 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1605 hub_activate(hub
, HUB_INIT
);
1609 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1611 /* hub_disconnect() frees urb and descriptor */
1615 static void hub_release(struct kref
*kref
)
1617 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1619 usb_put_dev(hub
->hdev
);
1620 usb_put_intf(to_usb_interface(hub
->intfdev
));
1624 static unsigned highspeed_hubs
;
1626 static void hub_disconnect(struct usb_interface
*intf
)
1628 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1629 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1633 * Stop adding new hub events. We do not want to block here and thus
1634 * will not try to remove any pending work item.
1636 hub
->disconnected
= 1;
1638 /* Disconnect all children and quiesce the hub */
1640 hub_quiesce(hub
, HUB_DISCONNECT
);
1642 mutex_lock(&usb_port_peer_mutex
);
1644 /* Avoid races with recursively_mark_NOTATTACHED() */
1645 spin_lock_irq(&device_state_lock
);
1646 port1
= hdev
->maxchild
;
1648 usb_set_intfdata(intf
, NULL
);
1649 spin_unlock_irq(&device_state_lock
);
1651 for (; port1
> 0; --port1
)
1652 usb_hub_remove_port_device(hub
, port1
);
1654 mutex_unlock(&usb_port_peer_mutex
);
1656 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1659 usb_free_urb(hub
->urb
);
1661 kfree(hub
->descriptor
);
1665 pm_suspend_ignore_children(&intf
->dev
, false);
1666 kref_put(&hub
->kref
, hub_release
);
1669 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1671 /* Some hubs have a subclass of 1, which AFAICT according to the */
1672 /* specs is not defined, but it works */
1673 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1674 desc
->desc
.bInterfaceSubClass
!= 1)
1677 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1678 if (desc
->desc
.bNumEndpoints
!= 1)
1681 /* If the first endpoint is not interrupt IN, we'd better punt! */
1682 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1688 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1690 struct usb_host_interface
*desc
;
1691 struct usb_device
*hdev
;
1692 struct usb_hub
*hub
;
1694 desc
= intf
->cur_altsetting
;
1695 hdev
= interface_to_usbdev(intf
);
1698 * Set default autosuspend delay as 0 to speedup bus suspend,
1699 * based on the below considerations:
1701 * - Unlike other drivers, the hub driver does not rely on the
1702 * autosuspend delay to provide enough time to handle a wakeup
1703 * event, and the submitted status URB is just to check future
1704 * change on hub downstream ports, so it is safe to do it.
1706 * - The patch might cause one or more auto supend/resume for
1707 * below very rare devices when they are plugged into hub
1710 * devices having trouble initializing, and disconnect
1711 * themselves from the bus and then reconnect a second
1714 * devices just for downloading firmware, and disconnects
1715 * themselves after completing it
1717 * For these quite rare devices, their drivers may change the
1718 * autosuspend delay of their parent hub in the probe() to one
1719 * appropriate value to avoid the subtle problem if someone
1722 * - The patch may cause one or more auto suspend/resume on
1723 * hub during running 'lsusb', but it is probably too
1724 * infrequent to worry about.
1726 * - Change autosuspend delay of hub can avoid unnecessary auto
1727 * suspend timer for hub, also may decrease power consumption
1730 * - If user has indicated to prevent autosuspend by passing
1731 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1734 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1735 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1739 * Hubs have proper suspend/resume support, except for root hubs
1740 * where the controller driver doesn't have bus_suspend and
1741 * bus_resume methods.
1743 if (hdev
->parent
) { /* normal device */
1744 usb_enable_autosuspend(hdev
);
1745 } else { /* root hub */
1746 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1748 if (drv
->bus_suspend
&& drv
->bus_resume
)
1749 usb_enable_autosuspend(hdev
);
1752 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1754 "Unsupported bus topology: hub nested too deep\n");
1758 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1760 dev_warn(&intf
->dev
, "ignoring external hub\n");
1765 if (!hub_descriptor_is_sane(desc
)) {
1766 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1770 /* We found a hub */
1771 dev_info(&intf
->dev
, "USB hub found\n");
1773 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1777 kref_init(&hub
->kref
);
1778 hub
->intfdev
= &intf
->dev
;
1780 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1781 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1782 INIT_WORK(&hub
->events
, hub_event
);
1786 usb_set_intfdata(intf
, hub
);
1787 intf
->needs_remote_wakeup
= 1;
1788 pm_suspend_ignore_children(&intf
->dev
, true);
1790 if (hdev
->speed
== USB_SPEED_HIGH
)
1793 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1794 hub
->quirk_check_port_auto_suspend
= 1;
1796 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0)
1799 hub_disconnect(intf
);
1804 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1806 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1807 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1809 /* assert ifno == 0 (part of hub spec) */
1811 case USBDEVFS_HUB_PORTINFO
: {
1812 struct usbdevfs_hub_portinfo
*info
= user_data
;
1815 spin_lock_irq(&device_state_lock
);
1816 if (hdev
->devnum
<= 0)
1819 info
->nports
= hdev
->maxchild
;
1820 for (i
= 0; i
< info
->nports
; i
++) {
1821 if (hub
->ports
[i
]->child
== NULL
)
1825 hub
->ports
[i
]->child
->devnum
;
1828 spin_unlock_irq(&device_state_lock
);
1830 return info
->nports
+ 1;
1839 * Allow user programs to claim ports on a hub. When a device is attached
1840 * to one of these "claimed" ports, the program will "own" the device.
1842 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1843 struct usb_dev_state
***ppowner
)
1845 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1847 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1849 if (port1
== 0 || port1
> hdev
->maxchild
)
1852 /* Devices not managed by the hub driver
1853 * will always have maxchild equal to 0.
1855 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1859 /* In the following three functions, the caller must hold hdev's lock */
1860 int usb_hub_claim_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
);
1874 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1876 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1877 struct usb_dev_state
*owner
)
1880 struct usb_dev_state
**powner
;
1882 rc
= find_port_owner(hdev
, port1
, &powner
);
1885 if (*powner
!= owner
)
1890 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1892 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1894 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1897 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1898 if (hub
->ports
[n
]->port_owner
== owner
)
1899 hub
->ports
[n
]->port_owner
= NULL
;
1904 /* The caller must hold udev's lock */
1905 bool usb_device_is_owned(struct usb_device
*udev
)
1907 struct usb_hub
*hub
;
1909 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1911 hub
= usb_hub_to_struct_hub(udev
->parent
);
1912 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1915 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1917 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1920 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1921 if (hub
->ports
[i
]->child
)
1922 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1924 if (udev
->state
== USB_STATE_SUSPENDED
)
1925 udev
->active_duration
-= jiffies
;
1926 udev
->state
= USB_STATE_NOTATTACHED
;
1930 * usb_set_device_state - change a device's current state (usbcore, hcds)
1931 * @udev: pointer to device whose state should be changed
1932 * @new_state: new state value to be stored
1934 * udev->state is _not_ fully protected by the device lock. Although
1935 * most transitions are made only while holding the lock, the state can
1936 * can change to USB_STATE_NOTATTACHED at almost any time. This
1937 * is so that devices can be marked as disconnected as soon as possible,
1938 * without having to wait for any semaphores to be released. As a result,
1939 * all changes to any device's state must be protected by the
1940 * device_state_lock spinlock.
1942 * Once a device has been added to the device tree, all changes to its state
1943 * should be made using this routine. The state should _not_ be set directly.
1945 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1946 * Otherwise udev->state is set to new_state, and if new_state is
1947 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1948 * to USB_STATE_NOTATTACHED.
1950 void usb_set_device_state(struct usb_device
*udev
,
1951 enum usb_device_state new_state
)
1953 unsigned long flags
;
1956 spin_lock_irqsave(&device_state_lock
, flags
);
1957 if (udev
->state
== USB_STATE_NOTATTACHED
)
1959 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1961 /* root hub wakeup capabilities are managed out-of-band
1962 * and may involve silicon errata ... ignore them here.
1965 if (udev
->state
== USB_STATE_SUSPENDED
1966 || new_state
== USB_STATE_SUSPENDED
)
1967 ; /* No change to wakeup settings */
1968 else if (new_state
== USB_STATE_CONFIGURED
)
1969 wakeup
= (udev
->quirks
&
1970 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1971 udev
->actconfig
->desc
.bmAttributes
&
1972 USB_CONFIG_ATT_WAKEUP
;
1976 if (udev
->state
== USB_STATE_SUSPENDED
&&
1977 new_state
!= USB_STATE_SUSPENDED
)
1978 udev
->active_duration
-= jiffies
;
1979 else if (new_state
== USB_STATE_SUSPENDED
&&
1980 udev
->state
!= USB_STATE_SUSPENDED
)
1981 udev
->active_duration
+= jiffies
;
1982 udev
->state
= new_state
;
1984 recursively_mark_NOTATTACHED(udev
);
1985 spin_unlock_irqrestore(&device_state_lock
, flags
);
1987 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1989 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1992 * Choose a device number.
1994 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1995 * USB-2.0 buses they are also used as device addresses, however on
1996 * USB-3.0 buses the address is assigned by the controller hardware
1997 * and it usually is not the same as the device number.
1999 * WUSB devices are simple: they have no hubs behind, so the mapping
2000 * device <-> virtual port number becomes 1:1. Why? to simplify the
2001 * life of the device connection logic in
2002 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2003 * handshake we need to assign a temporary address in the unauthorized
2004 * space. For simplicity we use the first virtual port number found to
2005 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2006 * and that becomes it's address [X < 128] or its unauthorized address
2009 * We add 1 as an offset to the one-based USB-stack port number
2010 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2011 * 0 is reserved by USB for default address; (b) Linux's USB stack
2012 * uses always #1 for the root hub of the controller. So USB stack's
2013 * port #1, which is wusb virtual-port #0 has address #2.
2015 * Devices connected under xHCI are not as simple. The host controller
2016 * supports virtualization, so the hardware assigns device addresses and
2017 * the HCD must setup data structures before issuing a set address
2018 * command to the hardware.
2020 static void choose_devnum(struct usb_device
*udev
)
2023 struct usb_bus
*bus
= udev
->bus
;
2025 /* be safe when more hub events are proceed in parallel */
2026 mutex_lock(&bus
->devnum_next_mutex
);
2028 devnum
= udev
->portnum
+ 1;
2029 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2031 /* Try to allocate the next devnum beginning at
2032 * bus->devnum_next. */
2033 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2036 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2038 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2041 set_bit(devnum
, bus
->devmap
.devicemap
);
2042 udev
->devnum
= devnum
;
2044 mutex_unlock(&bus
->devnum_next_mutex
);
2047 static void release_devnum(struct usb_device
*udev
)
2049 if (udev
->devnum
> 0) {
2050 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2055 static void update_devnum(struct usb_device
*udev
, int devnum
)
2057 /* The address for a WUSB device is managed by wusbcore. */
2059 udev
->devnum
= devnum
;
2062 static void hub_free_dev(struct usb_device
*udev
)
2064 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2066 /* Root hubs aren't real devices, so don't free HCD resources */
2067 if (hcd
->driver
->free_dev
&& udev
->parent
)
2068 hcd
->driver
->free_dev(hcd
, udev
);
2071 static void hub_disconnect_children(struct usb_device
*udev
)
2073 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2076 /* Free up all the children before we remove this device */
2077 for (i
= 0; i
< udev
->maxchild
; i
++) {
2078 if (hub
->ports
[i
]->child
)
2079 usb_disconnect(&hub
->ports
[i
]->child
);
2084 * usb_disconnect - disconnect a device (usbcore-internal)
2085 * @pdev: pointer to device being disconnected
2086 * Context: !in_interrupt ()
2088 * Something got disconnected. Get rid of it and all of its children.
2090 * If *pdev is a normal device then the parent hub must already be locked.
2091 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2092 * which protects the set of root hubs as well as the list of buses.
2094 * Only hub drivers (including virtual root hub drivers for host
2095 * controllers) should ever call this.
2097 * This call is synchronous, and may not be used in an interrupt context.
2099 void usb_disconnect(struct usb_device
**pdev
)
2101 struct usb_port
*port_dev
= NULL
;
2102 struct usb_device
*udev
= *pdev
;
2103 struct usb_hub
*hub
= NULL
;
2106 /* mark the device as inactive, so any further urb submissions for
2107 * this device (and any of its children) will fail immediately.
2108 * this quiesces everything except pending urbs.
2110 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2111 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2115 * Ensure that the pm runtime code knows that the USB device
2116 * is in the process of being disconnected.
2118 pm_runtime_barrier(&udev
->dev
);
2120 usb_lock_device(udev
);
2122 hub_disconnect_children(udev
);
2124 /* deallocate hcd/hardware state ... nuking all pending urbs and
2125 * cleaning up all state associated with the current configuration
2126 * so that the hardware is now fully quiesced.
2128 dev_dbg(&udev
->dev
, "unregistering device\n");
2129 usb_disable_device(udev
, 0);
2130 usb_hcd_synchronize_unlinks(udev
);
2133 port1
= udev
->portnum
;
2134 hub
= usb_hub_to_struct_hub(udev
->parent
);
2135 port_dev
= hub
->ports
[port1
- 1];
2137 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2138 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2141 * As usb_port_runtime_resume() de-references udev, make
2142 * sure no resumes occur during removal
2144 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2145 pm_runtime_get_sync(&port_dev
->dev
);
2148 usb_remove_ep_devs(&udev
->ep0
);
2149 usb_unlock_device(udev
);
2151 /* Unregister the device. The device driver is responsible
2152 * for de-configuring the device and invoking the remove-device
2153 * notifier chain (used by usbfs and possibly others).
2155 device_del(&udev
->dev
);
2157 /* Free the device number and delete the parent's children[]
2158 * (or root_hub) pointer.
2160 release_devnum(udev
);
2162 /* Avoid races with recursively_mark_NOTATTACHED() */
2163 spin_lock_irq(&device_state_lock
);
2165 spin_unlock_irq(&device_state_lock
);
2167 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2168 pm_runtime_put(&port_dev
->dev
);
2172 put_device(&udev
->dev
);
2175 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2176 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2180 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2183 static void announce_device(struct usb_device
*udev
)
2185 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2186 le16_to_cpu(udev
->descriptor
.idVendor
),
2187 le16_to_cpu(udev
->descriptor
.idProduct
));
2188 dev_info(&udev
->dev
,
2189 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2190 udev
->descriptor
.iManufacturer
,
2191 udev
->descriptor
.iProduct
,
2192 udev
->descriptor
.iSerialNumber
);
2193 show_string(udev
, "Product", udev
->product
);
2194 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2195 show_string(udev
, "SerialNumber", udev
->serial
);
2198 static inline void announce_device(struct usb_device
*udev
) { }
2203 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2204 * @udev: newly addressed device (in ADDRESS state)
2206 * Finish enumeration for On-The-Go devices
2208 * Return: 0 if successful. A negative error code otherwise.
2210 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2214 #ifdef CONFIG_USB_OTG
2216 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2217 * to wake us after we've powered off VBUS; and HNP, switching roles
2218 * "host" to "peripheral". The OTG descriptor helps figure this out.
2220 if (!udev
->bus
->is_b_host
2222 && udev
->parent
== udev
->bus
->root_hub
) {
2223 struct usb_otg_descriptor
*desc
= NULL
;
2224 struct usb_bus
*bus
= udev
->bus
;
2225 unsigned port1
= udev
->portnum
;
2227 /* descriptor may appear anywhere in config */
2228 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2229 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2230 USB_DT_OTG
, (void **) &desc
);
2231 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2234 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2235 (port1
== bus
->otg_port
) ? "" : "non-");
2237 /* enable HNP before suspend, it's simpler */
2238 if (port1
== bus
->otg_port
) {
2239 bus
->b_hnp_enable
= 1;
2240 err
= usb_control_msg(udev
,
2241 usb_sndctrlpipe(udev
, 0),
2242 USB_REQ_SET_FEATURE
, 0,
2243 USB_DEVICE_B_HNP_ENABLE
,
2245 USB_CTRL_SET_TIMEOUT
);
2248 * OTG MESSAGE: report errors here,
2249 * customize to match your product.
2251 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2253 bus
->b_hnp_enable
= 0;
2255 } else if (desc
->bLength
== sizeof
2256 (struct usb_otg_descriptor
)) {
2257 /* Set a_alt_hnp_support for legacy otg device */
2258 err
= usb_control_msg(udev
,
2259 usb_sndctrlpipe(udev
, 0),
2260 USB_REQ_SET_FEATURE
, 0,
2261 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2263 USB_CTRL_SET_TIMEOUT
);
2266 "set a_alt_hnp_support failed: %d\n",
2276 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2277 * @udev: newly addressed device (in ADDRESS state)
2279 * This is only called by usb_new_device() and usb_authorize_device()
2280 * and FIXME -- all comments that apply to them apply here wrt to
2283 * If the device is WUSB and not authorized, we don't attempt to read
2284 * the string descriptors, as they will be errored out by the device
2285 * until it has been authorized.
2287 * Return: 0 if successful. A negative error code otherwise.
2289 static int usb_enumerate_device(struct usb_device
*udev
)
2292 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2294 if (udev
->config
== NULL
) {
2295 err
= usb_get_configuration(udev
);
2298 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2304 /* read the standard strings and cache them if present */
2305 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2306 udev
->manufacturer
= usb_cache_string(udev
,
2307 udev
->descriptor
.iManufacturer
);
2308 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2310 err
= usb_enumerate_device_otg(udev
);
2314 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2315 !is_targeted(udev
)) {
2316 /* Maybe it can talk to us, though we can't talk to it.
2317 * (Includes HNP test device.)
2319 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2320 || udev
->bus
->is_b_host
)) {
2321 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2323 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2328 usb_detect_interface_quirks(udev
);
2333 static void set_usb_port_removable(struct usb_device
*udev
)
2335 struct usb_device
*hdev
= udev
->parent
;
2336 struct usb_hub
*hub
;
2337 u8 port
= udev
->portnum
;
2338 u16 wHubCharacteristics
;
2339 bool removable
= true;
2344 hub
= usb_hub_to_struct_hub(udev
->parent
);
2347 * If the platform firmware has provided information about a port,
2348 * use that to determine whether it's removable.
2350 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2351 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2352 udev
->removable
= USB_DEVICE_REMOVABLE
;
2354 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2355 case USB_PORT_NOT_USED
:
2356 udev
->removable
= USB_DEVICE_FIXED
;
2363 * Otherwise, check whether the hub knows whether a port is removable
2366 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2368 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2371 if (hub_is_superspeed(hdev
)) {
2372 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2376 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2381 udev
->removable
= USB_DEVICE_REMOVABLE
;
2383 udev
->removable
= USB_DEVICE_FIXED
;
2388 * usb_new_device - perform initial device setup (usbcore-internal)
2389 * @udev: newly addressed device (in ADDRESS state)
2391 * This is called with devices which have been detected but not fully
2392 * enumerated. The device descriptor is available, but not descriptors
2393 * for any device configuration. The caller must have locked either
2394 * the parent hub (if udev is a normal device) or else the
2395 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2396 * udev has already been installed, but udev is not yet visible through
2397 * sysfs or other filesystem code.
2399 * This call is synchronous, and may not be used in an interrupt context.
2401 * Only the hub driver or root-hub registrar should ever call this.
2403 * Return: Whether the device is configured properly or not. Zero if the
2404 * interface was registered with the driver core; else a negative errno
2408 int usb_new_device(struct usb_device
*udev
)
2413 /* Initialize non-root-hub device wakeup to disabled;
2414 * device (un)configuration controls wakeup capable
2415 * sysfs power/wakeup controls wakeup enabled/disabled
2417 device_init_wakeup(&udev
->dev
, 0);
2420 /* Tell the runtime-PM framework the device is active */
2421 pm_runtime_set_active(&udev
->dev
);
2422 pm_runtime_get_noresume(&udev
->dev
);
2423 pm_runtime_use_autosuspend(&udev
->dev
);
2424 pm_runtime_enable(&udev
->dev
);
2426 /* By default, forbid autosuspend for all devices. It will be
2427 * allowed for hubs during binding.
2429 usb_disable_autosuspend(udev
);
2431 err
= usb_enumerate_device(udev
); /* Read descriptors */
2434 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2435 udev
->devnum
, udev
->bus
->busnum
,
2436 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2437 /* export the usbdev device-node for libusb */
2438 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2439 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2441 /* Tell the world! */
2442 announce_device(udev
);
2445 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2447 add_device_randomness(udev
->product
, strlen(udev
->product
));
2448 if (udev
->manufacturer
)
2449 add_device_randomness(udev
->manufacturer
,
2450 strlen(udev
->manufacturer
));
2452 device_enable_async_suspend(&udev
->dev
);
2454 /* check whether the hub or firmware marks this port as non-removable */
2456 set_usb_port_removable(udev
);
2458 /* Register the device. The device driver is responsible
2459 * for configuring the device and invoking the add-device
2460 * notifier chain (used by usbfs and possibly others).
2462 err
= device_add(&udev
->dev
);
2464 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2468 /* Create link files between child device and usb port device. */
2470 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2471 int port1
= udev
->portnum
;
2472 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2474 err
= sysfs_create_link(&udev
->dev
.kobj
,
2475 &port_dev
->dev
.kobj
, "port");
2479 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2480 &udev
->dev
.kobj
, "device");
2482 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2486 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2487 pm_runtime_get_sync(&port_dev
->dev
);
2490 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2491 usb_mark_last_busy(udev
);
2492 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2496 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2497 pm_runtime_disable(&udev
->dev
);
2498 pm_runtime_set_suspended(&udev
->dev
);
2504 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2505 * @usb_dev: USB device
2507 * Move the USB device to a very basic state where interfaces are disabled
2508 * and the device is in fact unconfigured and unusable.
2510 * We share a lock (that we have) with device_del(), so we need to
2515 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2517 usb_lock_device(usb_dev
);
2518 if (usb_dev
->authorized
== 0)
2519 goto out_unauthorized
;
2521 usb_dev
->authorized
= 0;
2522 usb_set_configuration(usb_dev
, -1);
2525 usb_unlock_device(usb_dev
);
2530 int usb_authorize_device(struct usb_device
*usb_dev
)
2534 usb_lock_device(usb_dev
);
2535 if (usb_dev
->authorized
== 1)
2536 goto out_authorized
;
2538 result
= usb_autoresume_device(usb_dev
);
2540 dev_err(&usb_dev
->dev
,
2541 "can't autoresume for authorization: %d\n", result
);
2542 goto error_autoresume
;
2545 if (usb_dev
->wusb
) {
2546 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2548 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2549 "authorization: %d\n", result
);
2550 goto error_device_descriptor
;
2554 usb_dev
->authorized
= 1;
2555 /* Choose and set the configuration. This registers the interfaces
2556 * with the driver core and lets interface drivers bind to them.
2558 c
= usb_choose_configuration(usb_dev
);
2560 result
= usb_set_configuration(usb_dev
, c
);
2562 dev_err(&usb_dev
->dev
,
2563 "can't set config #%d, error %d\n", c
, result
);
2564 /* This need not be fatal. The user can try to
2565 * set other configurations. */
2568 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2570 error_device_descriptor
:
2571 usb_autosuspend_device(usb_dev
);
2574 usb_unlock_device(usb_dev
); /* complements locktree */
2579 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2580 * check it from the link protocol field of the current speed ID attribute.
2581 * current speed ID is got from ext port status request. Sublink speed attribute
2582 * table is returned with the hub BOS SSP device capability descriptor
2584 static int port_speed_is_ssp(struct usb_device
*hdev
, int speed_id
)
2589 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2594 ssa_count
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2595 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2597 for (i
= 0; i
<= ssa_count
; i
++) {
2598 ss_attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2599 if (speed_id
== (ss_attr
& USB_SSP_SUBLINK_SPEED_SSID
))
2600 return !!(ss_attr
& USB_SSP_SUBLINK_SPEED_LP
);
2605 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2606 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2608 struct usb_hcd
*hcd
;
2609 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2611 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2612 return hcd
->wireless
;
2616 #define PORT_RESET_TRIES 5
2617 #define SET_ADDRESS_TRIES 2
2618 #define GET_DESCRIPTOR_TRIES 2
2619 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2620 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2622 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2623 #define HUB_SHORT_RESET_TIME 10
2624 #define HUB_BH_RESET_TIME 50
2625 #define HUB_LONG_RESET_TIME 200
2626 #define HUB_RESET_TIMEOUT 800
2629 * "New scheme" enumeration causes an extra state transition to be
2630 * exposed to an xhci host and causes USB3 devices to receive control
2631 * commands in the default state. This has been seen to cause
2632 * enumeration failures, so disable this enumeration scheme for USB3
2635 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2637 if (udev
->speed
>= USB_SPEED_SUPER
)
2640 return USE_NEW_SCHEME(retry
);
2643 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2644 * Port worm reset is required to recover
2646 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2651 if (!hub_is_superspeed(hub
->hdev
))
2654 if (test_bit(port1
, hub
->warm_reset_bits
))
2657 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2658 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2659 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2662 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2663 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2665 int delay_time
, ret
;
2668 u32 ext_portstatus
= 0;
2670 for (delay_time
= 0;
2671 delay_time
< HUB_RESET_TIMEOUT
;
2672 delay_time
+= delay
) {
2673 /* wait to give the device a chance to reset */
2676 /* read and decode port status */
2677 if (hub_is_superspeedplus(hub
->hdev
))
2678 ret
= hub_ext_port_status(hub
, port1
,
2679 HUB_EXT_PORT_STATUS
,
2680 &portstatus
, &portchange
,
2683 ret
= hub_port_status(hub
, port1
, &portstatus
,
2689 * The port state is unknown until the reset completes.
2691 * On top of that, some chips may require additional time
2692 * to re-establish a connection after the reset is complete,
2693 * so also wait for the connection to be re-established.
2695 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2696 (portstatus
& USB_PORT_STAT_CONNECTION
))
2699 /* switch to the long delay after two short delay failures */
2700 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2701 delay
= HUB_LONG_RESET_TIME
;
2703 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2704 "not %sreset yet, waiting %dms\n",
2705 warm
? "warm " : "", delay
);
2708 if ((portstatus
& USB_PORT_STAT_RESET
))
2711 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2714 /* Device went away? */
2715 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2718 /* Retry if connect change is set but status is still connected.
2719 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2720 * but the device may have successfully re-connected. Ignore it.
2722 if (!hub_is_superspeed(hub
->hdev
) &&
2723 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2724 usb_clear_port_feature(hub
->hdev
, port1
,
2725 USB_PORT_FEAT_C_CONNECTION
);
2729 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2735 if (hub_is_wusb(hub
))
2736 udev
->speed
= USB_SPEED_WIRELESS
;
2737 else if (hub_is_superspeedplus(hub
->hdev
) &&
2738 port_speed_is_ssp(hub
->hdev
, ext_portstatus
&
2739 USB_EXT_PORT_STAT_RX_SPEED_ID
))
2740 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2741 else if (hub_is_superspeed(hub
->hdev
))
2742 udev
->speed
= USB_SPEED_SUPER
;
2743 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2744 udev
->speed
= USB_SPEED_HIGH
;
2745 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2746 udev
->speed
= USB_SPEED_LOW
;
2748 udev
->speed
= USB_SPEED_FULL
;
2752 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2753 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2754 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2757 u16 portchange
, portstatus
;
2758 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2760 if (!hub_is_superspeed(hub
->hdev
)) {
2762 dev_err(hub
->intfdev
, "only USB3 hub support "
2766 /* Block EHCI CF initialization during the port reset.
2767 * Some companion controllers don't like it when they mix.
2769 down_read(&ehci_cf_port_reset_rwsem
);
2772 * If the caller hasn't explicitly requested a warm reset,
2773 * double check and see if one is needed.
2775 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2776 if (hub_port_warm_reset_required(hub
, port1
,
2780 clear_bit(port1
, hub
->warm_reset_bits
);
2782 /* Reset the port */
2783 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2784 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2785 USB_PORT_FEAT_BH_PORT_RESET
:
2786 USB_PORT_FEAT_RESET
));
2787 if (status
== -ENODEV
) {
2788 ; /* The hub is gone */
2789 } else if (status
) {
2790 dev_err(&port_dev
->dev
,
2791 "cannot %sreset (err = %d)\n",
2792 warm
? "warm " : "", status
);
2794 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2796 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2797 dev_dbg(hub
->intfdev
,
2798 "port_wait_reset: err = %d\n",
2802 /* Check for disconnect or reset */
2803 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2804 usb_clear_port_feature(hub
->hdev
, port1
,
2805 USB_PORT_FEAT_C_RESET
);
2807 if (!hub_is_superspeed(hub
->hdev
))
2810 usb_clear_port_feature(hub
->hdev
, port1
,
2811 USB_PORT_FEAT_C_BH_PORT_RESET
);
2812 usb_clear_port_feature(hub
->hdev
, port1
,
2813 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2814 usb_clear_port_feature(hub
->hdev
, port1
,
2815 USB_PORT_FEAT_C_CONNECTION
);
2818 * If a USB 3.0 device migrates from reset to an error
2819 * state, re-issue the warm reset.
2821 if (hub_port_status(hub
, port1
,
2822 &portstatus
, &portchange
) < 0)
2825 if (!hub_port_warm_reset_required(hub
, port1
,
2830 * If the port is in SS.Inactive or Compliance Mode, the
2831 * hot or warm reset failed. Try another warm reset.
2834 dev_dbg(&port_dev
->dev
,
2835 "hot reset failed, warm reset\n");
2840 dev_dbg(&port_dev
->dev
,
2841 "not enabled, trying %sreset again...\n",
2842 warm
? "warm " : "");
2843 delay
= HUB_LONG_RESET_TIME
;
2846 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2850 /* TRSTRCY = 10 ms; plus some extra */
2853 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2855 update_devnum(udev
, 0);
2856 /* The xHC may think the device is already reset,
2857 * so ignore the status.
2859 if (hcd
->driver
->reset_device
)
2860 hcd
->driver
->reset_device(hcd
, udev
);
2862 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2866 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2869 if (!hub_is_superspeed(hub
->hdev
))
2870 up_read(&ehci_cf_port_reset_rwsem
);
2875 /* Check if a port is power on */
2876 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2880 if (hub_is_superspeed(hub
->hdev
)) {
2881 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2884 if (portstatus
& USB_PORT_STAT_POWER
)
2891 static void usb_lock_port(struct usb_port
*port_dev
)
2892 __acquires(&port_dev
->status_lock
)
2894 mutex_lock(&port_dev
->status_lock
);
2895 __acquire(&port_dev
->status_lock
);
2898 static void usb_unlock_port(struct usb_port
*port_dev
)
2899 __releases(&port_dev
->status_lock
)
2901 mutex_unlock(&port_dev
->status_lock
);
2902 __release(&port_dev
->status_lock
);
2907 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2908 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2912 if (hub_is_superspeed(hub
->hdev
)) {
2913 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2914 == USB_SS_PORT_LS_U3
)
2917 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2924 /* Determine whether the device on a port is ready for a normal resume,
2925 * is ready for a reset-resume, or should be disconnected.
2927 static int check_port_resume_type(struct usb_device
*udev
,
2928 struct usb_hub
*hub
, int port1
,
2929 int status
, u16 portchange
, u16 portstatus
)
2931 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2935 /* Is a warm reset needed to recover the connection? */
2936 if (status
== 0 && udev
->reset_resume
2937 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2940 /* Is the device still present? */
2941 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2942 !port_is_power_on(hub
, portstatus
)) {
2945 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2947 usleep_range(200, 300);
2948 status
= hub_port_status(hub
, port1
, &portstatus
,
2955 /* Can't do a normal resume if the port isn't enabled,
2956 * so try a reset-resume instead.
2958 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2959 if (udev
->persist_enabled
)
2960 udev
->reset_resume
= 1;
2966 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
2967 portchange
, portstatus
, status
);
2968 } else if (udev
->reset_resume
) {
2970 /* Late port handoff can set status-change bits */
2971 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2972 usb_clear_port_feature(hub
->hdev
, port1
,
2973 USB_PORT_FEAT_C_CONNECTION
);
2974 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2975 usb_clear_port_feature(hub
->hdev
, port1
,
2976 USB_PORT_FEAT_C_ENABLE
);
2982 int usb_disable_ltm(struct usb_device
*udev
)
2984 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2986 /* Check if the roothub and device supports LTM. */
2987 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2988 !usb_device_supports_ltm(udev
))
2991 /* Clear Feature LTM Enable can only be sent if the device is
2994 if (!udev
->actconfig
)
2997 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2998 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2999 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3000 USB_CTRL_SET_TIMEOUT
);
3002 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3004 void usb_enable_ltm(struct usb_device
*udev
)
3006 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3008 /* Check if the roothub and device supports LTM. */
3009 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3010 !usb_device_supports_ltm(udev
))
3013 /* Set Feature LTM Enable can only be sent if the device is
3016 if (!udev
->actconfig
)
3019 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3020 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3021 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3022 USB_CTRL_SET_TIMEOUT
);
3024 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3027 * usb_enable_remote_wakeup - enable remote wakeup for a device
3028 * @udev: target device
3030 * For USB-2 devices: Set the device's remote wakeup feature.
3032 * For USB-3 devices: Assume there's only one function on the device and
3033 * enable remote wake for the first interface. FIXME if the interface
3034 * association descriptor shows there's more than one function.
3036 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3038 if (udev
->speed
< USB_SPEED_SUPER
)
3039 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3040 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3041 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3042 USB_CTRL_SET_TIMEOUT
);
3044 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3045 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3046 USB_INTRF_FUNC_SUSPEND
,
3047 USB_INTRF_FUNC_SUSPEND_RW
|
3048 USB_INTRF_FUNC_SUSPEND_LP
,
3049 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3053 * usb_disable_remote_wakeup - disable remote wakeup for a device
3054 * @udev: target device
3056 * For USB-2 devices: Clear the device's remote wakeup feature.
3058 * For USB-3 devices: Assume there's only one function on the device and
3059 * disable remote wake for the first interface. FIXME if the interface
3060 * association descriptor shows there's more than one function.
3062 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3064 if (udev
->speed
< USB_SPEED_SUPER
)
3065 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3066 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3067 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3068 USB_CTRL_SET_TIMEOUT
);
3070 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3071 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3072 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3073 USB_CTRL_SET_TIMEOUT
);
3076 /* Count of wakeup-enabled devices at or below udev */
3077 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3079 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3081 return udev
->do_remote_wakeup
+
3082 (hub
? hub
->wakeup_enabled_descendants
: 0);
3086 * usb_port_suspend - suspend a usb device's upstream port
3087 * @udev: device that's no longer in active use, not a root hub
3088 * Context: must be able to sleep; device not locked; pm locks held
3090 * Suspends a USB device that isn't in active use, conserving power.
3091 * Devices may wake out of a suspend, if anything important happens,
3092 * using the remote wakeup mechanism. They may also be taken out of
3093 * suspend by the host, using usb_port_resume(). It's also routine
3094 * to disconnect devices while they are suspended.
3096 * This only affects the USB hardware for a device; its interfaces
3097 * (and, for hubs, child devices) must already have been suspended.
3099 * Selective port suspend reduces power; most suspended devices draw
3100 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3101 * All devices below the suspended port are also suspended.
3103 * Devices leave suspend state when the host wakes them up. Some devices
3104 * also support "remote wakeup", where the device can activate the USB
3105 * tree above them to deliver data, such as a keypress or packet. In
3106 * some cases, this wakes the USB host.
3108 * Suspending OTG devices may trigger HNP, if that's been enabled
3109 * between a pair of dual-role devices. That will change roles, such
3110 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3112 * Devices on USB hub ports have only one "suspend" state, corresponding
3113 * to ACPI D2, "may cause the device to lose some context".
3114 * State transitions include:
3116 * - suspend, resume ... when the VBUS power link stays live
3117 * - suspend, disconnect ... VBUS lost
3119 * Once VBUS drop breaks the circuit, the port it's using has to go through
3120 * normal re-enumeration procedures, starting with enabling VBUS power.
3121 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3122 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3123 * timer, no SRP, no requests through sysfs.
3125 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3126 * suspended until their bus goes into global suspend (i.e., the root
3127 * hub is suspended). Nevertheless, we change @udev->state to
3128 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3129 * upstream port setting is stored in @udev->port_is_suspended.
3131 * Returns 0 on success, else negative errno.
3133 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3135 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3136 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3137 int port1
= udev
->portnum
;
3139 bool really_suspend
= true;
3141 usb_lock_port(port_dev
);
3143 /* enable remote wakeup when appropriate; this lets the device
3144 * wake up the upstream hub (including maybe the root hub).
3146 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3147 * we don't explicitly enable it here.
3149 if (udev
->do_remote_wakeup
) {
3150 status
= usb_enable_remote_wakeup(udev
);
3152 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3154 /* bail if autosuspend is requested */
3155 if (PMSG_IS_AUTO(msg
))
3160 /* disable USB2 hardware LPM */
3161 if (udev
->usb2_hw_lpm_enabled
== 1)
3162 usb_set_usb2_hardware_lpm(udev
, 0);
3164 if (usb_disable_ltm(udev
)) {
3165 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3167 if (PMSG_IS_AUTO(msg
))
3172 if (hub_is_superspeed(hub
->hdev
))
3173 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3176 * For system suspend, we do not need to enable the suspend feature
3177 * on individual USB-2 ports. The devices will automatically go
3178 * into suspend a few ms after the root hub stops sending packets.
3179 * The USB 2.0 spec calls this "global suspend".
3181 * However, many USB hubs have a bug: They don't relay wakeup requests
3182 * from a downstream port if the port's suspend feature isn't on.
3183 * Therefore we will turn on the suspend feature if udev or any of its
3184 * descendants is enabled for remote wakeup.
3186 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3187 status
= set_port_feature(hub
->hdev
, port1
,
3188 USB_PORT_FEAT_SUSPEND
);
3190 really_suspend
= false;
3194 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3196 /* Try to enable USB3 LTM again */
3197 usb_enable_ltm(udev
);
3199 /* Try to enable USB2 hardware LPM again */
3200 if (udev
->usb2_hw_lpm_capable
== 1)
3201 usb_set_usb2_hardware_lpm(udev
, 1);
3203 if (udev
->do_remote_wakeup
)
3204 (void) usb_disable_remote_wakeup(udev
);
3207 /* System sleep transitions should never fail */
3208 if (!PMSG_IS_AUTO(msg
))
3211 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3212 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3213 udev
->do_remote_wakeup
);
3214 if (really_suspend
) {
3215 udev
->port_is_suspended
= 1;
3217 /* device has up to 10 msec to fully suspend */
3220 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3223 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3224 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3225 pm_runtime_put_sync(&port_dev
->dev
);
3227 usb_mark_last_busy(hub
->hdev
);
3229 usb_unlock_port(port_dev
);
3234 * If the USB "suspend" state is in use (rather than "global suspend"),
3235 * many devices will be individually taken out of suspend state using
3236 * special "resume" signaling. This routine kicks in shortly after
3237 * hardware resume signaling is finished, either because of selective
3238 * resume (by host) or remote wakeup (by device) ... now see what changed
3239 * in the tree that's rooted at this device.
3241 * If @udev->reset_resume is set then the device is reset before the
3242 * status check is done.
3244 static int finish_port_resume(struct usb_device
*udev
)
3249 /* caller owns the udev device lock */
3250 dev_dbg(&udev
->dev
, "%s\n",
3251 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3253 /* usb ch9 identifies four variants of SUSPENDED, based on what
3254 * state the device resumes to. Linux currently won't see the
3255 * first two on the host side; they'd be inside hub_port_init()
3256 * during many timeouts, but hub_wq can't suspend until later.
3258 usb_set_device_state(udev
, udev
->actconfig
3259 ? USB_STATE_CONFIGURED
3260 : USB_STATE_ADDRESS
);
3262 /* 10.5.4.5 says not to reset a suspended port if the attached
3263 * device is enabled for remote wakeup. Hence the reset
3264 * operation is carried out here, after the port has been
3267 if (udev
->reset_resume
) {
3269 * If the device morphs or switches modes when it is reset,
3270 * we don't want to perform a reset-resume. We'll fail the
3271 * resume, which will cause a logical disconnect, and then
3272 * the device will be rediscovered.
3275 if (udev
->quirks
& USB_QUIRK_RESET
)
3278 status
= usb_reset_and_verify_device(udev
);
3281 /* 10.5.4.5 says be sure devices in the tree are still there.
3282 * For now let's assume the device didn't go crazy on resume,
3283 * and device drivers will know about any resume quirks.
3287 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3289 /* If a normal resume failed, try doing a reset-resume */
3290 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3291 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3292 udev
->reset_resume
= 1;
3293 goto retry_reset_resume
;
3298 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3301 * There are a few quirky devices which violate the standard
3302 * by claiming to have remote wakeup enabled after a reset,
3303 * which crash if the feature is cleared, hence check for
3304 * udev->reset_resume
3306 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3307 if (udev
->speed
< USB_SPEED_SUPER
) {
3308 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3309 status
= usb_disable_remote_wakeup(udev
);
3311 status
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
, 0,
3313 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3314 | USB_INTRF_STAT_FUNC_RW
))
3315 status
= usb_disable_remote_wakeup(udev
);
3320 "disable remote wakeup, status %d\n",
3328 * There are some SS USB devices which take longer time for link training.
3329 * XHCI specs 4.19.4 says that when Link training is successful, port
3330 * sets CCS bit to 1. So if SW reads port status before successful link
3331 * training, then it will not find device to be present.
3332 * USB Analyzer log with such buggy devices show that in some cases
3333 * device switch on the RX termination after long delay of host enabling
3334 * the VBUS. In few other cases it has been seen that device fails to
3335 * negotiate link training in first attempt. It has been
3336 * reported till now that few devices take as long as 2000 ms to train
3337 * the link after host enabling its VBUS and termination. Following
3338 * routine implements a 2000 ms timeout for link training. If in a case
3339 * link trains before timeout, loop will exit earlier.
3341 * There are also some 2.0 hard drive based devices and 3.0 thumb
3342 * drives that, when plugged into a 2.0 only port, take a long
3343 * time to set CCS after VBUS enable.
3345 * FIXME: If a device was connected before suspend, but was removed
3346 * while system was asleep, then the loop in the following routine will
3347 * only exit at timeout.
3349 * This routine should only be called when persist is enabled.
3351 static int wait_for_connected(struct usb_device
*udev
,
3352 struct usb_hub
*hub
, int *port1
,
3353 u16
*portchange
, u16
*portstatus
)
3355 int status
= 0, delay_ms
= 0;
3357 while (delay_ms
< 2000) {
3358 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3362 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3364 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3369 * usb_port_resume - re-activate a suspended usb device's upstream port
3370 * @udev: device to re-activate, not a root hub
3371 * Context: must be able to sleep; device not locked; pm locks held
3373 * This will re-activate the suspended device, increasing power usage
3374 * while letting drivers communicate again with its endpoints.
3375 * USB resume explicitly guarantees that the power session between
3376 * the host and the device is the same as it was when the device
3379 * If @udev->reset_resume is set then this routine won't check that the
3380 * port is still enabled. Furthermore, finish_port_resume() above will
3381 * reset @udev. The end result is that a broken power session can be
3382 * recovered and @udev will appear to persist across a loss of VBUS power.
3384 * For example, if a host controller doesn't maintain VBUS suspend current
3385 * during a system sleep or is reset when the system wakes up, all the USB
3386 * power sessions below it will be broken. This is especially troublesome
3387 * for mass-storage devices containing mounted filesystems, since the
3388 * device will appear to have disconnected and all the memory mappings
3389 * to it will be lost. Using the USB_PERSIST facility, the device can be
3390 * made to appear as if it had not disconnected.
3392 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3393 * every effort to insure that the same device is present after the
3394 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3395 * quite possible for a device to remain unaltered but its media to be
3396 * changed. If the user replaces a flash memory card while the system is
3397 * asleep, he will have only himself to blame when the filesystem on the
3398 * new card is corrupted and the system crashes.
3400 * Returns 0 on success, else negative errno.
3402 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3404 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3405 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3406 int port1
= udev
->portnum
;
3408 u16 portchange
, portstatus
;
3410 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3411 status
= pm_runtime_get_sync(&port_dev
->dev
);
3413 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3419 usb_lock_port(port_dev
);
3421 /* Skip the initial Clear-Suspend step for a remote wakeup */
3422 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3423 if (status
== 0 && !port_is_suspended(hub
, portstatus
)) {
3424 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3425 pm_wakeup_event(&udev
->dev
, 0);
3426 goto SuspendCleared
;
3429 /* see 7.1.7.7; affects power usage, but not budgeting */
3430 if (hub_is_superspeed(hub
->hdev
))
3431 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3433 status
= usb_clear_port_feature(hub
->hdev
,
3434 port1
, USB_PORT_FEAT_SUSPEND
);
3436 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3438 /* drive resume for USB_RESUME_TIMEOUT msec */
3439 dev_dbg(&udev
->dev
, "usb %sresume\n",
3440 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3441 msleep(USB_RESUME_TIMEOUT
);
3443 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3444 * stop resume signaling. Then finish the resume
3447 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3449 /* TRSMRCY = 10 msec */
3455 udev
->port_is_suspended
= 0;
3456 if (hub_is_superspeed(hub
->hdev
)) {
3457 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3458 usb_clear_port_feature(hub
->hdev
, port1
,
3459 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3461 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3462 usb_clear_port_feature(hub
->hdev
, port1
,
3463 USB_PORT_FEAT_C_SUSPEND
);
3467 if (udev
->persist_enabled
)
3468 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3471 status
= check_port_resume_type(udev
,
3472 hub
, port1
, status
, portchange
, portstatus
);
3474 status
= finish_port_resume(udev
);
3476 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3477 hub_port_logical_disconnect(hub
, port1
);
3479 /* Try to enable USB2 hardware LPM */
3480 if (udev
->usb2_hw_lpm_capable
== 1)
3481 usb_set_usb2_hardware_lpm(udev
, 1);
3483 /* Try to enable USB3 LTM */
3484 usb_enable_ltm(udev
);
3487 usb_unlock_port(port_dev
);
3492 int usb_remote_wakeup(struct usb_device
*udev
)
3496 usb_lock_device(udev
);
3497 if (udev
->state
== USB_STATE_SUSPENDED
) {
3498 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3499 status
= usb_autoresume_device(udev
);
3501 /* Let the drivers do their thing, then... */
3502 usb_autosuspend_device(udev
);
3505 usb_unlock_device(udev
);
3509 /* Returns 1 if there was a remote wakeup and a connect status change. */
3510 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3511 u16 portstatus
, u16 portchange
)
3512 __must_hold(&port_dev
->status_lock
)
3514 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3515 struct usb_device
*hdev
;
3516 struct usb_device
*udev
;
3517 int connect_change
= 0;
3521 udev
= port_dev
->child
;
3522 if (!hub_is_superspeed(hdev
)) {
3523 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3525 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3527 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3528 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
3534 /* TRSMRCY = 10 msec */
3537 usb_unlock_port(port_dev
);
3538 ret
= usb_remote_wakeup(udev
);
3539 usb_lock_port(port_dev
);
3544 hub_port_disable(hub
, port
, 1);
3546 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3547 return connect_change
;
3550 static int check_ports_changed(struct usb_hub
*hub
)
3554 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3555 u16 portstatus
, portchange
;
3558 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3559 if (!status
&& portchange
)
3565 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3567 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3568 struct usb_device
*hdev
= hub
->hdev
;
3573 * Warn if children aren't already suspended.
3574 * Also, add up the number of wakeup-enabled descendants.
3576 hub
->wakeup_enabled_descendants
= 0;
3577 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3578 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3579 struct usb_device
*udev
= port_dev
->child
;
3581 if (udev
&& udev
->can_submit
) {
3582 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3583 dev_name(&udev
->dev
));
3584 if (PMSG_IS_AUTO(msg
))
3588 hub
->wakeup_enabled_descendants
+=
3589 wakeup_enabled_descendants(udev
);
3592 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3593 /* check if there are changes pending on hub ports */
3594 if (check_ports_changed(hub
)) {
3595 if (PMSG_IS_AUTO(msg
))
3597 pm_wakeup_event(&hdev
->dev
, 2000);
3601 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3602 /* Enable hub to send remote wakeup for all ports. */
3603 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3604 status
= set_port_feature(hdev
,
3606 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3607 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3608 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3609 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3613 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3615 /* stop hub_wq and related activity */
3616 hub_quiesce(hub
, HUB_SUSPEND
);
3620 static int hub_resume(struct usb_interface
*intf
)
3622 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3624 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3625 hub_activate(hub
, HUB_RESUME
);
3629 static int hub_reset_resume(struct usb_interface
*intf
)
3631 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3633 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3634 hub_activate(hub
, HUB_RESET_RESUME
);
3639 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3640 * @rhdev: struct usb_device for the root hub
3642 * The USB host controller driver calls this function when its root hub
3643 * is resumed and Vbus power has been interrupted or the controller
3644 * has been reset. The routine marks @rhdev as having lost power.
3645 * When the hub driver is resumed it will take notice and carry out
3646 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3647 * the others will be disconnected.
3649 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3651 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3652 rhdev
->reset_resume
= 1;
3654 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3656 static const char * const usb3_lpm_names
[] = {
3664 * Send a Set SEL control transfer to the device, prior to enabling
3665 * device-initiated U1 or U2. This lets the device know the exit latencies from
3666 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3667 * packet from the host.
3669 * This function will fail if the SEL or PEL values for udev are greater than
3670 * the maximum allowed values for the link state to be enabled.
3672 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3674 struct usb_set_sel_req
*sel_values
;
3675 unsigned long long u1_sel
;
3676 unsigned long long u1_pel
;
3677 unsigned long long u2_sel
;
3678 unsigned long long u2_pel
;
3681 if (udev
->state
!= USB_STATE_CONFIGURED
)
3684 /* Convert SEL and PEL stored in ns to us */
3685 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3686 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3687 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3688 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3691 * Make sure that the calculated SEL and PEL values for the link
3692 * state we're enabling aren't bigger than the max SEL/PEL
3693 * value that will fit in the SET SEL control transfer.
3694 * Otherwise the device would get an incorrect idea of the exit
3695 * latency for the link state, and could start a device-initiated
3696 * U1/U2 when the exit latencies are too high.
3698 if ((state
== USB3_LPM_U1
&&
3699 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3700 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3701 (state
== USB3_LPM_U2
&&
3702 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3703 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3704 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3705 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3710 * If we're enabling device-initiated LPM for one link state,
3711 * but the other link state has a too high SEL or PEL value,
3712 * just set those values to the max in the Set SEL request.
3714 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3715 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3717 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3718 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3720 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3721 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3723 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3724 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3727 * usb_enable_lpm() can be called as part of a failed device reset,
3728 * which may be initiated by an error path of a mass storage driver.
3729 * Therefore, use GFP_NOIO.
3731 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3735 sel_values
->u1_sel
= u1_sel
;
3736 sel_values
->u1_pel
= u1_pel
;
3737 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3738 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3740 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3744 sel_values
, sizeof *(sel_values
),
3745 USB_CTRL_SET_TIMEOUT
);
3751 * Enable or disable device-initiated U1 or U2 transitions.
3753 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3754 enum usb3_link_state state
, bool enable
)
3761 feature
= USB_DEVICE_U1_ENABLE
;
3764 feature
= USB_DEVICE_U2_ENABLE
;
3767 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3768 __func__
, enable
? "enable" : "disable");
3772 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3773 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3774 "for unconfigured device.\n",
3775 __func__
, enable
? "enable" : "disable",
3776 usb3_lpm_names
[state
]);
3782 * Now send the control transfer to enable device-initiated LPM
3783 * for either U1 or U2.
3785 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3786 USB_REQ_SET_FEATURE
,
3790 USB_CTRL_SET_TIMEOUT
);
3792 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3793 USB_REQ_CLEAR_FEATURE
,
3797 USB_CTRL_SET_TIMEOUT
);
3800 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3801 enable
? "Enable" : "Disable",
3802 usb3_lpm_names
[state
]);
3808 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3809 enum usb3_link_state state
, int timeout
)
3816 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3819 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3822 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3827 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3828 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3829 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3830 "which is a reserved value.\n",
3831 usb3_lpm_names
[state
], timeout
);
3835 ret
= set_port_feature(udev
->parent
,
3836 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3839 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3840 "error code %i\n", usb3_lpm_names
[state
],
3844 if (state
== USB3_LPM_U1
)
3845 udev
->u1_params
.timeout
= timeout
;
3847 udev
->u2_params
.timeout
= timeout
;
3852 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3855 * We will attempt to enable U1 or U2, but there are no guarantees that the
3856 * control transfers to set the hub timeout or enable device-initiated U1/U2
3857 * will be successful.
3859 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3860 * driver know about it. If that call fails, it should be harmless, and just
3861 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3863 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3864 enum usb3_link_state state
)
3867 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3868 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3870 /* If the device says it doesn't have *any* exit latency to come out of
3871 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3874 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3875 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3879 * First, let the device know about the exit latencies
3880 * associated with the link state we're about to enable.
3882 ret
= usb_req_set_sel(udev
, state
);
3884 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3885 usb3_lpm_names
[state
]);
3889 /* We allow the host controller to set the U1/U2 timeout internally
3890 * first, so that it can change its schedule to account for the
3891 * additional latency to send data to a device in a lower power
3894 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3896 /* xHCI host controller doesn't want to enable this LPM state. */
3901 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3902 "xHCI error %i.\n", usb3_lpm_names
[state
],
3907 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
3908 /* If we can't set the parent hub U1/U2 timeout,
3909 * device-initiated LPM won't be allowed either, so let the xHCI
3910 * host know that this link state won't be enabled.
3912 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3914 /* Only a configured device will accept the Set Feature
3917 if (udev
->actconfig
)
3918 usb_set_device_initiated_lpm(udev
, state
, true);
3920 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3921 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3922 * matter the result of usb_set_device_initiated_lpm().
3923 * The only difference is whether device is able to initiate
3926 if (state
== USB3_LPM_U1
)
3927 udev
->usb3_lpm_u1_enabled
= 1;
3928 else if (state
== USB3_LPM_U2
)
3929 udev
->usb3_lpm_u2_enabled
= 1;
3934 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3937 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3938 * If zero is returned, the parent will not allow the link to go into U1/U2.
3940 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3941 * it won't have an effect on the bus link state because the parent hub will
3942 * still disallow device-initiated U1/U2 entry.
3944 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3945 * possible. The result will be slightly more bus bandwidth will be taken up
3946 * (to account for U1/U2 exit latency), but it should be harmless.
3948 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3949 enum usb3_link_state state
)
3956 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3961 if (usb_set_lpm_timeout(udev
, state
, 0))
3964 usb_set_device_initiated_lpm(udev
, state
, false);
3966 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3967 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3968 "bus schedule bandwidth may be impacted.\n",
3969 usb3_lpm_names
[state
]);
3971 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3972 * is disabled. Hub will disallows link to enter U1/U2 as well,
3973 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3974 * timeout set to 0, no matter device-initiated LPM is disabled or
3977 if (state
== USB3_LPM_U1
)
3978 udev
->usb3_lpm_u1_enabled
= 0;
3979 else if (state
== USB3_LPM_U2
)
3980 udev
->usb3_lpm_u2_enabled
= 0;
3986 * Disable hub-initiated and device-initiated U1 and U2 entry.
3987 * Caller must own the bandwidth_mutex.
3989 * This will call usb_enable_lpm() on failure, which will decrement
3990 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3992 int usb_disable_lpm(struct usb_device
*udev
)
3994 struct usb_hcd
*hcd
;
3996 if (!udev
|| !udev
->parent
||
3997 udev
->speed
< USB_SPEED_SUPER
||
3998 !udev
->lpm_capable
||
3999 udev
->state
< USB_STATE_DEFAULT
)
4002 hcd
= bus_to_hcd(udev
->bus
);
4003 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4006 udev
->lpm_disable_count
++;
4007 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4010 /* If LPM is enabled, attempt to disable it. */
4011 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4013 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4019 usb_enable_lpm(udev
);
4022 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4024 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4025 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4027 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4033 mutex_lock(hcd
->bandwidth_mutex
);
4034 ret
= usb_disable_lpm(udev
);
4035 mutex_unlock(hcd
->bandwidth_mutex
);
4039 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4042 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4043 * xHCI host policy may prevent U1 or U2 from being enabled.
4045 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4046 * until the lpm_disable_count drops to zero. Caller must own the
4049 void usb_enable_lpm(struct usb_device
*udev
)
4051 struct usb_hcd
*hcd
;
4052 struct usb_hub
*hub
;
4053 struct usb_port
*port_dev
;
4055 if (!udev
|| !udev
->parent
||
4056 udev
->speed
< USB_SPEED_SUPER
||
4057 !udev
->lpm_capable
||
4058 udev
->state
< USB_STATE_DEFAULT
)
4061 udev
->lpm_disable_count
--;
4062 hcd
= bus_to_hcd(udev
->bus
);
4063 /* Double check that we can both enable and disable LPM.
4064 * Device must be configured to accept set feature U1/U2 timeout.
4066 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4067 !hcd
->driver
->disable_usb3_lpm_timeout
)
4070 if (udev
->lpm_disable_count
> 0)
4073 hub
= usb_hub_to_struct_hub(udev
->parent
);
4077 port_dev
= hub
->ports
[udev
->portnum
- 1];
4079 if (port_dev
->usb3_lpm_u1_permit
)
4080 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4082 if (port_dev
->usb3_lpm_u2_permit
)
4083 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4085 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4087 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4088 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4090 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4095 mutex_lock(hcd
->bandwidth_mutex
);
4096 usb_enable_lpm(udev
);
4097 mutex_unlock(hcd
->bandwidth_mutex
);
4099 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4101 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4102 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4103 struct usb_port
*port_dev
)
4105 struct usb_device
*udev
= port_dev
->child
;
4108 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4109 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4112 msleep(USB_RESUME_TIMEOUT
);
4113 ret
= usb_disable_remote_wakeup(udev
);
4116 dev_warn(&udev
->dev
,
4117 "Port disable: can't disable remote wake\n");
4118 udev
->do_remote_wakeup
= 0;
4122 #else /* CONFIG_PM */
4124 #define hub_suspend NULL
4125 #define hub_resume NULL
4126 #define hub_reset_resume NULL
4128 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4129 struct usb_port
*port_dev
) { }
4131 int usb_disable_lpm(struct usb_device
*udev
)
4135 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4137 void usb_enable_lpm(struct usb_device
*udev
) { }
4138 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4140 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4144 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4146 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4147 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4149 int usb_disable_ltm(struct usb_device
*udev
)
4153 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4155 void usb_enable_ltm(struct usb_device
*udev
) { }
4156 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4158 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4159 u16 portstatus
, u16 portchange
)
4164 #endif /* CONFIG_PM */
4167 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4168 * a connection with a plugged-in cable but will signal the host when the cable
4169 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4171 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4173 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4174 struct usb_device
*hdev
= hub
->hdev
;
4178 if (hub_is_superspeed(hub
->hdev
)) {
4179 hub_usb3_port_prepare_disable(hub
, port_dev
);
4180 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4183 ret
= usb_clear_port_feature(hdev
, port1
,
4184 USB_PORT_FEAT_ENABLE
);
4187 if (port_dev
->child
&& set_state
)
4188 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4189 if (ret
&& ret
!= -ENODEV
)
4190 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4195 * usb_port_disable - disable a usb device's upstream port
4196 * @udev: device to disable
4197 * Context: @udev locked, must be able to sleep.
4199 * Disables a USB device that isn't in active use.
4201 int usb_port_disable(struct usb_device
*udev
)
4203 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4205 return hub_port_disable(hub
, udev
->portnum
, 0);
4208 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4210 * Between connect detection and reset signaling there must be a delay
4211 * of 100ms at least for debounce and power-settling. The corresponding
4212 * timer shall restart whenever the downstream port detects a disconnect.
4214 * Apparently there are some bluetooth and irda-dongles and a number of
4215 * low-speed devices for which this debounce period may last over a second.
4216 * Not covered by the spec - but easy to deal with.
4218 * This implementation uses a 1500ms total debounce timeout; if the
4219 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4220 * every 25ms for transient disconnects. When the port status has been
4221 * unchanged for 100ms it returns the port status.
4223 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4226 u16 portchange
, portstatus
;
4227 unsigned connection
= 0xffff;
4228 int total_time
, stable_time
= 0;
4229 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4231 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4232 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4236 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4237 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4238 if (!must_be_connected
||
4239 (connection
== USB_PORT_STAT_CONNECTION
))
4240 stable_time
+= HUB_DEBOUNCE_STEP
;
4241 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4245 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4248 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4249 usb_clear_port_feature(hub
->hdev
, port1
,
4250 USB_PORT_FEAT_C_CONNECTION
);
4253 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4255 msleep(HUB_DEBOUNCE_STEP
);
4258 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4259 total_time
, stable_time
, portstatus
);
4261 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4266 void usb_ep0_reinit(struct usb_device
*udev
)
4268 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4269 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4270 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4272 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4274 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4275 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4277 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4280 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4283 * The host controller will choose the device address,
4284 * instead of the core having chosen it earlier
4286 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4288 if (udev
->state
== USB_STATE_ADDRESS
)
4290 if (udev
->state
!= USB_STATE_DEFAULT
)
4292 if (hcd
->driver
->address_device
)
4293 retval
= hcd
->driver
->address_device(hcd
, udev
);
4295 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4296 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4297 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4299 update_devnum(udev
, devnum
);
4300 /* Device now using proper address. */
4301 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4302 usb_ep0_reinit(udev
);
4308 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4309 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4312 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4313 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4314 * support bit in the BOS descriptor.
4316 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4318 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4319 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4321 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4325 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4327 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4328 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4329 udev
->usb2_hw_lpm_allowed
= 1;
4330 usb_set_usb2_hardware_lpm(udev
, 1);
4334 static int hub_enable_device(struct usb_device
*udev
)
4336 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4338 if (!hcd
->driver
->enable_device
)
4340 if (udev
->state
== USB_STATE_ADDRESS
)
4342 if (udev
->state
!= USB_STATE_DEFAULT
)
4345 return hcd
->driver
->enable_device(hcd
, udev
);
4348 /* Reset device, (re)assign address, get device descriptor.
4349 * Device connection must be stable, no more debouncing needed.
4350 * Returns device in USB_STATE_ADDRESS, except on error.
4352 * If this is called for an already-existing device (as part of
4353 * usb_reset_and_verify_device), the caller must own the device lock and
4354 * the port lock. For a newly detected device that is not accessible
4355 * through any global pointers, it's not necessary to lock the device,
4356 * but it is still necessary to lock the port.
4359 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4362 struct usb_device
*hdev
= hub
->hdev
;
4363 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4364 int retries
, operations
, retval
, i
;
4365 unsigned delay
= HUB_SHORT_RESET_TIME
;
4366 enum usb_device_speed oldspeed
= udev
->speed
;
4368 int devnum
= udev
->devnum
;
4369 const char *driver_name
;
4371 /* root hub ports have a slightly longer reset period
4372 * (from USB 2.0 spec, section 7.1.7.5)
4374 if (!hdev
->parent
) {
4375 delay
= HUB_ROOT_RESET_TIME
;
4376 if (port1
== hdev
->bus
->otg_port
)
4377 hdev
->bus
->b_hnp_enable
= 0;
4380 /* Some low speed devices have problems with the quick delay, so */
4381 /* be a bit pessimistic with those devices. RHbug #23670 */
4382 if (oldspeed
== USB_SPEED_LOW
)
4383 delay
= HUB_LONG_RESET_TIME
;
4385 mutex_lock(hcd
->address0_mutex
);
4387 /* Reset the device; full speed may morph to high speed */
4388 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4389 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4390 if (retval
< 0) /* error or disconnect */
4392 /* success, speed is known */
4396 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4397 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4398 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4399 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4402 oldspeed
= udev
->speed
;
4404 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4405 * it's fixed size except for full speed devices.
4406 * For Wireless USB devices, ep0 max packet is always 512 (tho
4407 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4409 switch (udev
->speed
) {
4410 case USB_SPEED_SUPER_PLUS
:
4411 case USB_SPEED_SUPER
:
4412 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4413 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4415 case USB_SPEED_HIGH
: /* fixed at 64 */
4416 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4418 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4419 /* to determine the ep0 maxpacket size, try to read
4420 * the device descriptor to get bMaxPacketSize0 and
4421 * then correct our initial guess.
4423 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4425 case USB_SPEED_LOW
: /* fixed at 8 */
4426 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4432 if (udev
->speed
== USB_SPEED_WIRELESS
)
4433 speed
= "variable speed Wireless";
4435 speed
= usb_speed_string(udev
->speed
);
4438 * The controller driver may be NULL if the controller device
4439 * is the middle device between platform device and roothub.
4440 * This middle device may not need a device driver due to
4441 * all hardware control can be at platform device driver, this
4442 * platform device is usually a dual-role USB controller device.
4444 if (udev
->bus
->controller
->driver
)
4445 driver_name
= udev
->bus
->controller
->driver
->name
;
4447 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4449 if (udev
->speed
< USB_SPEED_SUPER
)
4450 dev_info(&udev
->dev
,
4451 "%s %s USB device number %d using %s\n",
4452 (udev
->config
) ? "reset" : "new", speed
,
4453 devnum
, driver_name
);
4455 /* Set up TT records, if needed */
4457 udev
->tt
= hdev
->tt
;
4458 udev
->ttport
= hdev
->ttport
;
4459 } else if (udev
->speed
!= USB_SPEED_HIGH
4460 && hdev
->speed
== USB_SPEED_HIGH
) {
4462 dev_err(&udev
->dev
, "parent hub has no TT\n");
4466 udev
->tt
= &hub
->tt
;
4467 udev
->ttport
= port1
;
4470 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4471 * Because device hardware and firmware is sometimes buggy in
4472 * this area, and this is how Linux has done it for ages.
4473 * Change it cautiously.
4475 * NOTE: If use_new_scheme() is true we will start by issuing
4476 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4477 * so it may help with some non-standards-compliant devices.
4478 * Otherwise we start with SET_ADDRESS and then try to read the
4479 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4482 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4483 bool did_new_scheme
= false;
4485 if (use_new_scheme(udev
, retry_counter
)) {
4486 struct usb_device_descriptor
*buf
;
4489 did_new_scheme
= true;
4490 retval
= hub_enable_device(udev
);
4493 "hub failed to enable device, error %d\n",
4498 #define GET_DESCRIPTOR_BUFSIZE 64
4499 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4505 /* Retry on all errors; some devices are flakey.
4506 * 255 is for WUSB devices, we actually need to use
4507 * 512 (WUSB1.0[4.8.1]).
4509 for (operations
= 0; operations
< 3; ++operations
) {
4510 buf
->bMaxPacketSize0
= 0;
4511 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4512 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4513 USB_DT_DEVICE
<< 8, 0,
4514 buf
, GET_DESCRIPTOR_BUFSIZE
,
4515 initial_descriptor_timeout
);
4516 switch (buf
->bMaxPacketSize0
) {
4517 case 8: case 16: case 32: case 64: case 255:
4518 if (buf
->bDescriptorType
==
4530 * Some devices time out if they are powered on
4531 * when already connected. They need a second
4532 * reset. But only on the first attempt,
4533 * lest we get into a time out/reset loop
4535 if (r
== 0 || (r
== -ETIMEDOUT
&& retries
== 0))
4538 udev
->descriptor
.bMaxPacketSize0
=
4539 buf
->bMaxPacketSize0
;
4542 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4543 if (retval
< 0) /* error or disconnect */
4545 if (oldspeed
!= udev
->speed
) {
4547 "device reset changed speed!\n");
4553 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4558 #undef GET_DESCRIPTOR_BUFSIZE
4562 * If device is WUSB, we already assigned an
4563 * unauthorized address in the Connect Ack sequence;
4564 * authorization will assign the final address.
4566 if (udev
->wusb
== 0) {
4567 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4568 retval
= hub_set_address(udev
, devnum
);
4574 if (retval
!= -ENODEV
)
4575 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4579 if (udev
->speed
>= USB_SPEED_SUPER
) {
4580 devnum
= udev
->devnum
;
4581 dev_info(&udev
->dev
,
4582 "%s SuperSpeed%s USB device number %d using %s\n",
4583 (udev
->config
) ? "reset" : "new",
4584 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ? "Plus" : "",
4585 devnum
, driver_name
);
4588 /* cope with hardware quirkiness:
4589 * - let SET_ADDRESS settle, some device hardware wants it
4590 * - read ep0 maxpacket even for high and low speed,
4593 /* use_new_scheme() checks the speed which may have
4594 * changed since the initial look so we cache the result
4601 retval
= usb_get_device_descriptor(udev
, 8);
4603 if (retval
!= -ENODEV
)
4605 "device descriptor read/8, error %d\n",
4618 * Some superspeed devices have finished the link training process
4619 * and attached to a superspeed hub port, but the device descriptor
4620 * got from those devices show they aren't superspeed devices. Warm
4621 * reset the port attached by the devices can fix them.
4623 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4624 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4625 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4626 "warm reset device\n");
4627 hub_port_reset(hub
, port1
, udev
,
4628 HUB_BH_RESET_TIME
, true);
4633 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4634 udev
->speed
>= USB_SPEED_SUPER
)
4637 i
= udev
->descriptor
.bMaxPacketSize0
;
4638 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4639 if (udev
->speed
== USB_SPEED_LOW
||
4640 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4641 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4645 if (udev
->speed
== USB_SPEED_FULL
)
4646 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4648 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4649 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4650 usb_ep0_reinit(udev
);
4653 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4654 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4655 if (retval
!= -ENODEV
)
4656 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4663 usb_detect_quirks(udev
);
4665 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4666 retval
= usb_get_bos_descriptor(udev
);
4668 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4669 usb_set_lpm_parameters(udev
);
4674 /* notify HCD that we have a device connected and addressed */
4675 if (hcd
->driver
->update_device
)
4676 hcd
->driver
->update_device(hcd
, udev
);
4677 hub_set_initial_usb2_lpm_policy(udev
);
4680 hub_port_disable(hub
, port1
, 0);
4681 update_devnum(udev
, devnum
); /* for disconnect processing */
4683 mutex_unlock(hcd
->address0_mutex
);
4688 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4690 struct usb_qualifier_descriptor
*qual
;
4693 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4696 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4700 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4701 qual
, sizeof *qual
);
4702 if (status
== sizeof *qual
) {
4703 dev_info(&udev
->dev
, "not running at top speed; "
4704 "connect to a high speed hub\n");
4705 /* hub LEDs are probably harder to miss than syslog */
4706 if (hub
->has_indicators
) {
4707 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4708 queue_delayed_work(system_power_efficient_wq
,
4716 hub_power_remaining(struct usb_hub
*hub
)
4718 struct usb_device
*hdev
= hub
->hdev
;
4722 if (!hub
->limited_power
)
4725 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4726 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4727 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4728 struct usb_device
*udev
= port_dev
->child
;
4734 if (hub_is_superspeed(udev
))
4740 * Unconfigured devices may not use more than one unit load,
4741 * or 8mA for OTG ports
4743 if (udev
->actconfig
)
4744 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4745 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4749 if (delta
> hub
->mA_per_port
)
4750 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4751 delta
, hub
->mA_per_port
);
4754 if (remaining
< 0) {
4755 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4762 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4765 int status
= -ENODEV
;
4768 struct usb_device
*hdev
= hub
->hdev
;
4769 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4770 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4771 struct usb_device
*udev
= port_dev
->child
;
4772 static int unreliable_port
= -1;
4774 /* Disconnect any existing devices under this port */
4776 if (hcd
->usb_phy
&& !hdev
->parent
)
4777 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4778 usb_disconnect(&port_dev
->child
);
4781 /* We can forget about a "removed" device when there's a physical
4782 * disconnect or the connect status changes.
4784 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4785 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4786 clear_bit(port1
, hub
->removed_bits
);
4788 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4789 USB_PORT_STAT_C_ENABLE
)) {
4790 status
= hub_port_debounce_be_stable(hub
, port1
);
4792 if (status
!= -ENODEV
&&
4793 port1
!= unreliable_port
&&
4795 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4796 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4797 unreliable_port
= port1
;
4799 portstatus
= status
;
4803 /* Return now if debouncing failed or nothing is connected or
4804 * the device was "removed".
4806 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4807 test_bit(port1
, hub
->removed_bits
)) {
4810 * maybe switch power back on (e.g. root hub was reset)
4811 * but only if the port isn't owned by someone else.
4813 if (hub_is_port_power_switchable(hub
)
4814 && !port_is_power_on(hub
, portstatus
)
4815 && !port_dev
->port_owner
)
4816 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4818 if (portstatus
& USB_PORT_STAT_ENABLE
)
4822 if (hub_is_superspeed(hub
->hdev
))
4828 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4830 /* reallocate for each attempt, since references
4831 * to the previous one can escape in various ways
4833 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4835 dev_err(&port_dev
->dev
,
4836 "couldn't allocate usb_device\n");
4840 usb_set_device_state(udev
, USB_STATE_POWERED
);
4841 udev
->bus_mA
= hub
->mA_per_port
;
4842 udev
->level
= hdev
->level
+ 1;
4843 udev
->wusb
= hub_is_wusb(hub
);
4845 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4846 if (hub_is_superspeed(hub
->hdev
))
4847 udev
->speed
= USB_SPEED_SUPER
;
4849 udev
->speed
= USB_SPEED_UNKNOWN
;
4851 choose_devnum(udev
);
4852 if (udev
->devnum
<= 0) {
4853 status
= -ENOTCONN
; /* Don't retry */
4857 /* reset (non-USB 3.0 devices) and get descriptor */
4858 usb_lock_port(port_dev
);
4859 status
= hub_port_init(hub
, udev
, port1
, i
);
4860 usb_unlock_port(port_dev
);
4864 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4867 /* consecutive bus-powered hubs aren't reliable; they can
4868 * violate the voltage drop budget. if the new child has
4869 * a "powered" LED, users should notice we didn't enable it
4870 * (without reading syslog), even without per-port LEDs
4873 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4874 && udev
->bus_mA
<= unit_load
) {
4877 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0,
4880 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4883 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4885 "can't connect bus-powered hub "
4887 if (hub
->has_indicators
) {
4888 hub
->indicator
[port1
-1] =
4889 INDICATOR_AMBER_BLINK
;
4891 system_power_efficient_wq
,
4894 status
= -ENOTCONN
; /* Don't retry */
4899 /* check for devices running slower than they could */
4900 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4901 && udev
->speed
== USB_SPEED_FULL
4902 && highspeed_hubs
!= 0)
4903 check_highspeed(hub
, udev
, port1
);
4905 /* Store the parent's children[] pointer. At this point
4906 * udev becomes globally accessible, although presumably
4907 * no one will look at it until hdev is unlocked.
4911 mutex_lock(&usb_port_peer_mutex
);
4913 /* We mustn't add new devices if the parent hub has
4914 * been disconnected; we would race with the
4915 * recursively_mark_NOTATTACHED() routine.
4917 spin_lock_irq(&device_state_lock
);
4918 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4921 port_dev
->child
= udev
;
4922 spin_unlock_irq(&device_state_lock
);
4923 mutex_unlock(&usb_port_peer_mutex
);
4925 /* Run it through the hoops (find a driver, etc) */
4927 status
= usb_new_device(udev
);
4929 mutex_lock(&usb_port_peer_mutex
);
4930 spin_lock_irq(&device_state_lock
);
4931 port_dev
->child
= NULL
;
4932 spin_unlock_irq(&device_state_lock
);
4933 mutex_unlock(&usb_port_peer_mutex
);
4935 if (hcd
->usb_phy
&& !hdev
->parent
)
4936 usb_phy_notify_connect(hcd
->usb_phy
,
4944 status
= hub_power_remaining(hub
);
4946 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
4951 hub_port_disable(hub
, port1
, 1);
4953 usb_ep0_reinit(udev
);
4954 release_devnum(udev
);
4957 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4960 /* When halfway through our retry count, power-cycle the port */
4961 if (i
== (SET_CONFIG_TRIES
/ 2) - 1) {
4962 dev_info(&port_dev
->dev
, "attempt power cycle\n");
4963 usb_hub_set_port_power(hdev
, hub
, port1
, false);
4964 msleep(2 * hub_power_on_good_delay(hub
));
4965 usb_hub_set_port_power(hdev
, hub
, port1
, true);
4966 msleep(hub_power_on_good_delay(hub
));
4969 if (hub
->hdev
->parent
||
4970 !hcd
->driver
->port_handed_over
||
4971 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4972 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4973 dev_err(&port_dev
->dev
,
4974 "unable to enumerate USB device\n");
4978 hub_port_disable(hub
, port1
, 1);
4979 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
4980 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4981 hcd
->driver
->relinquish_port(hcd
, port1
);
4985 /* Handle physical or logical connection change events.
4986 * This routine is called when:
4987 * a port connection-change occurs;
4988 * a port enable-change occurs (often caused by EMI);
4989 * usb_reset_and_verify_device() encounters changed descriptors (as from
4990 * a firmware download)
4991 * caller already locked the hub
4993 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4994 u16 portstatus
, u16 portchange
)
4995 __must_hold(&port_dev
->status_lock
)
4997 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4998 struct usb_device
*udev
= port_dev
->child
;
4999 int status
= -ENODEV
;
5001 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
5002 portchange
, portspeed(hub
, portstatus
));
5004 if (hub
->has_indicators
) {
5005 set_port_led(hub
, port1
, HUB_LED_AUTO
);
5006 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
5009 #ifdef CONFIG_USB_OTG
5010 /* during HNP, don't repeat the debounce */
5011 if (hub
->hdev
->bus
->is_b_host
)
5012 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
5013 USB_PORT_STAT_C_ENABLE
);
5016 /* Try to resuscitate an existing device */
5017 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
5018 udev
->state
!= USB_STATE_NOTATTACHED
) {
5019 if (portstatus
& USB_PORT_STAT_ENABLE
) {
5020 status
= 0; /* Nothing to do */
5022 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
5023 udev
->persist_enabled
) {
5024 /* For a suspended device, treat this as a
5025 * remote wakeup event.
5027 usb_unlock_port(port_dev
);
5028 status
= usb_remote_wakeup(udev
);
5029 usb_lock_port(port_dev
);
5032 /* Don't resuscitate */;
5035 clear_bit(port1
, hub
->change_bits
);
5037 /* successfully revalidated the connection */
5041 usb_unlock_port(port_dev
);
5042 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5043 usb_lock_port(port_dev
);
5046 static void port_event(struct usb_hub
*hub
, int port1
)
5047 __must_hold(&port_dev
->status_lock
)
5050 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5051 struct usb_device
*udev
= port_dev
->child
;
5052 struct usb_device
*hdev
= hub
->hdev
;
5053 u16 portstatus
, portchange
;
5055 connect_change
= test_bit(port1
, hub
->change_bits
);
5056 clear_bit(port1
, hub
->event_bits
);
5057 clear_bit(port1
, hub
->wakeup_bits
);
5059 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5062 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5063 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5067 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5068 if (!connect_change
)
5069 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5071 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5074 * EM interference sometimes causes badly shielded USB devices
5075 * to be shutdown by the hub, this hack enables them again.
5076 * Works at least with mouse driver.
5078 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5079 && !connect_change
&& udev
) {
5080 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5085 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5086 u16 status
= 0, unused
;
5088 dev_dbg(&port_dev
->dev
, "over-current change\n");
5089 usb_clear_port_feature(hdev
, port1
,
5090 USB_PORT_FEAT_C_OVER_CURRENT
);
5091 msleep(100); /* Cool down */
5092 hub_power_on(hub
, true);
5093 hub_port_status(hub
, port1
, &status
, &unused
);
5094 if (status
& USB_PORT_STAT_OVERCURRENT
)
5095 dev_err(&port_dev
->dev
, "over-current condition\n");
5098 if (portchange
& USB_PORT_STAT_C_RESET
) {
5099 dev_dbg(&port_dev
->dev
, "reset change\n");
5100 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5102 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5103 && hub_is_superspeed(hdev
)) {
5104 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5105 usb_clear_port_feature(hdev
, port1
,
5106 USB_PORT_FEAT_C_BH_PORT_RESET
);
5108 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5109 dev_dbg(&port_dev
->dev
, "link state change\n");
5110 usb_clear_port_feature(hdev
, port1
,
5111 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5113 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5114 dev_warn(&port_dev
->dev
, "config error\n");
5115 usb_clear_port_feature(hdev
, port1
,
5116 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5119 /* skip port actions that require the port to be powered on */
5120 if (!pm_runtime_active(&port_dev
->dev
))
5123 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5127 * Warm reset a USB3 protocol port if it's in
5128 * SS.Inactive state.
5130 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5131 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5132 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5133 || udev
->state
== USB_STATE_NOTATTACHED
) {
5134 if (hub_port_reset(hub
, port1
, NULL
,
5135 HUB_BH_RESET_TIME
, true) < 0)
5136 hub_port_disable(hub
, port1
, 1);
5138 usb_unlock_port(port_dev
);
5139 usb_lock_device(udev
);
5140 usb_reset_device(udev
);
5141 usb_unlock_device(udev
);
5142 usb_lock_port(port_dev
);
5148 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5151 static void hub_event(struct work_struct
*work
)
5153 struct usb_device
*hdev
;
5154 struct usb_interface
*intf
;
5155 struct usb_hub
*hub
;
5156 struct device
*hub_dev
;
5161 hub
= container_of(work
, struct usb_hub
, events
);
5163 hub_dev
= hub
->intfdev
;
5164 intf
= to_usb_interface(hub_dev
);
5166 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5167 hdev
->state
, hdev
->maxchild
,
5168 /* NOTE: expects max 15 ports... */
5169 (u16
) hub
->change_bits
[0],
5170 (u16
) hub
->event_bits
[0]);
5172 /* Lock the device, then check to see if we were
5173 * disconnected while waiting for the lock to succeed. */
5174 usb_lock_device(hdev
);
5175 if (unlikely(hub
->disconnected
))
5178 /* If the hub has died, clean up after it */
5179 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5180 hub
->error
= -ENODEV
;
5181 hub_quiesce(hub
, HUB_DISCONNECT
);
5186 ret
= usb_autopm_get_interface(intf
);
5188 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5192 /* If this is an inactive hub, do nothing */
5197 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5199 ret
= usb_reset_device(hdev
);
5201 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5209 /* deal with port status changes */
5210 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5211 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5213 if (test_bit(i
, hub
->event_bits
)
5214 || test_bit(i
, hub
->change_bits
)
5215 || test_bit(i
, hub
->wakeup_bits
)) {
5217 * The get_noresume and barrier ensure that if
5218 * the port was in the process of resuming, we
5219 * flush that work and keep the port active for
5220 * the duration of the port_event(). However,
5221 * if the port is runtime pm suspended
5222 * (powered-off), we leave it in that state, run
5223 * an abbreviated port_event(), and move on.
5225 pm_runtime_get_noresume(&port_dev
->dev
);
5226 pm_runtime_barrier(&port_dev
->dev
);
5227 usb_lock_port(port_dev
);
5229 usb_unlock_port(port_dev
);
5230 pm_runtime_put_sync(&port_dev
->dev
);
5234 /* deal with hub status changes */
5235 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5237 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5238 dev_err(hub_dev
, "get_hub_status failed\n");
5240 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5241 dev_dbg(hub_dev
, "power change\n");
5242 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5243 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5244 /* FIXME: Is this always true? */
5245 hub
->limited_power
= 1;
5247 hub
->limited_power
= 0;
5249 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5253 dev_dbg(hub_dev
, "over-current change\n");
5254 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5255 msleep(500); /* Cool down */
5256 hub_power_on(hub
, true);
5257 hub_hub_status(hub
, &status
, &unused
);
5258 if (status
& HUB_STATUS_OVERCURRENT
)
5259 dev_err(hub_dev
, "over-current condition\n");
5264 /* Balance the usb_autopm_get_interface() above */
5265 usb_autopm_put_interface_no_suspend(intf
);
5267 usb_unlock_device(hdev
);
5269 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5270 usb_autopm_put_interface(intf
);
5271 kref_put(&hub
->kref
, hub_release
);
5274 static const struct usb_device_id hub_id_table
[] = {
5275 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5276 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5277 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5278 .bInterfaceClass
= USB_CLASS_HUB
,
5279 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5280 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5281 .bDeviceClass
= USB_CLASS_HUB
},
5282 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5283 .bInterfaceClass
= USB_CLASS_HUB
},
5284 { } /* Terminating entry */
5287 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5289 static struct usb_driver hub_driver
= {
5292 .disconnect
= hub_disconnect
,
5293 .suspend
= hub_suspend
,
5294 .resume
= hub_resume
,
5295 .reset_resume
= hub_reset_resume
,
5296 .pre_reset
= hub_pre_reset
,
5297 .post_reset
= hub_post_reset
,
5298 .unlocked_ioctl
= hub_ioctl
,
5299 .id_table
= hub_id_table
,
5300 .supports_autosuspend
= 1,
5303 int usb_hub_init(void)
5305 if (usb_register(&hub_driver
) < 0) {
5306 printk(KERN_ERR
"%s: can't register hub driver\n",
5312 * The workqueue needs to be freezable to avoid interfering with
5313 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5314 * device was gone before the EHCI controller had handed its port
5315 * over to the companion full-speed controller.
5317 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5321 /* Fall through if kernel_thread failed */
5322 usb_deregister(&hub_driver
);
5323 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5328 void usb_hub_cleanup(void)
5330 destroy_workqueue(hub_wq
);
5333 * Hub resources are freed for us by usb_deregister. It calls
5334 * usb_driver_purge on every device which in turn calls that
5335 * devices disconnect function if it is using this driver.
5336 * The hub_disconnect function takes care of releasing the
5337 * individual hub resources. -greg
5339 usb_deregister(&hub_driver
);
5340 } /* usb_hub_cleanup() */
5342 static int descriptors_changed(struct usb_device
*udev
,
5343 struct usb_device_descriptor
*old_device_descriptor
,
5344 struct usb_host_bos
*old_bos
)
5348 unsigned serial_len
= 0;
5350 unsigned old_length
;
5354 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5355 sizeof(*old_device_descriptor
)) != 0)
5358 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5361 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5362 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5364 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5368 /* Since the idVendor, idProduct, and bcdDevice values in the
5369 * device descriptor haven't changed, we will assume the
5370 * Manufacturer and Product strings haven't changed either.
5371 * But the SerialNumber string could be different (e.g., a
5372 * different flash card of the same brand).
5375 serial_len
= strlen(udev
->serial
) + 1;
5378 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5379 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5380 len
= max(len
, old_length
);
5383 buf
= kmalloc(len
, GFP_NOIO
);
5385 /* assume the worst */
5388 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5389 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5390 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5392 if (length
!= old_length
) {
5393 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5398 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5400 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5402 ((struct usb_config_descriptor
*) buf
)->
5403 bConfigurationValue
);
5409 if (!changed
&& serial_len
) {
5410 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5412 if (length
+ 1 != serial_len
) {
5413 dev_dbg(&udev
->dev
, "serial string error %d\n",
5416 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5417 dev_dbg(&udev
->dev
, "serial string changed\n");
5427 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5428 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5430 * WARNING - don't use this routine to reset a composite device
5431 * (one with multiple interfaces owned by separate drivers)!
5432 * Use usb_reset_device() instead.
5434 * Do a port reset, reassign the device's address, and establish its
5435 * former operating configuration. If the reset fails, or the device's
5436 * descriptors change from their values before the reset, or the original
5437 * configuration and altsettings cannot be restored, a flag will be set
5438 * telling hub_wq to pretend the device has been disconnected and then
5439 * re-connected. All drivers will be unbound, and the device will be
5440 * re-enumerated and probed all over again.
5442 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5443 * flagged for logical disconnection, or some other negative error code
5444 * if the reset wasn't even attempted.
5447 * The caller must own the device lock and the port lock, the latter is
5448 * taken by usb_reset_device(). For example, it's safe to use
5449 * usb_reset_device() from a driver probe() routine after downloading
5450 * new firmware. For calls that might not occur during probe(), drivers
5451 * should lock the device using usb_lock_device_for_reset().
5453 * Locking exception: This routine may also be called from within an
5454 * autoresume handler. Such usage won't conflict with other tasks
5455 * holding the device lock because these tasks should always call
5456 * usb_autopm_resume_device(), thereby preventing any unwanted
5457 * autoresume. The autoresume handler is expected to have already
5458 * acquired the port lock before calling this routine.
5460 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5462 struct usb_device
*parent_hdev
= udev
->parent
;
5463 struct usb_hub
*parent_hub
;
5464 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5465 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5466 struct usb_host_bos
*bos
;
5468 int port1
= udev
->portnum
;
5470 if (udev
->state
== USB_STATE_NOTATTACHED
||
5471 udev
->state
== USB_STATE_SUSPENDED
) {
5472 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5480 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5482 /* Disable USB2 hardware LPM.
5483 * It will be re-enabled by the enumeration process.
5485 if (udev
->usb2_hw_lpm_enabled
== 1)
5486 usb_set_usb2_hardware_lpm(udev
, 0);
5488 /* Disable LPM while we reset the device and reinstall the alt settings.
5489 * Device-initiated LPM, and system exit latency settings are cleared
5490 * when the device is reset, so we have to set them up again.
5492 ret
= usb_unlocked_disable_lpm(udev
);
5494 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5495 goto re_enumerate_no_bos
;
5501 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5503 /* ep0 maxpacket size may change; let the HCD know about it.
5504 * Other endpoints will be handled by re-enumeration. */
5505 usb_ep0_reinit(udev
);
5506 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5507 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5514 /* Device might have changed firmware (DFU or similar) */
5515 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5516 dev_info(&udev
->dev
, "device firmware changed\n");
5517 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5521 /* Restore the device's previous configuration */
5522 if (!udev
->actconfig
)
5525 mutex_lock(hcd
->bandwidth_mutex
);
5526 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5528 dev_warn(&udev
->dev
,
5529 "Busted HC? Not enough HCD resources for "
5530 "old configuration.\n");
5531 mutex_unlock(hcd
->bandwidth_mutex
);
5534 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5535 USB_REQ_SET_CONFIGURATION
, 0,
5536 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5537 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5540 "can't restore configuration #%d (error=%d)\n",
5541 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5542 mutex_unlock(hcd
->bandwidth_mutex
);
5545 mutex_unlock(hcd
->bandwidth_mutex
);
5546 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5548 /* Put interfaces back into the same altsettings as before.
5549 * Don't bother to send the Set-Interface request for interfaces
5550 * that were already in altsetting 0; besides being unnecessary,
5551 * many devices can't handle it. Instead just reset the host-side
5554 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5555 struct usb_host_config
*config
= udev
->actconfig
;
5556 struct usb_interface
*intf
= config
->interface
[i
];
5557 struct usb_interface_descriptor
*desc
;
5559 desc
= &intf
->cur_altsetting
->desc
;
5560 if (desc
->bAlternateSetting
== 0) {
5561 usb_disable_interface(udev
, intf
, true);
5562 usb_enable_interface(udev
, intf
, true);
5565 /* Let the bandwidth allocation function know that this
5566 * device has been reset, and it will have to use
5567 * alternate setting 0 as the current alternate setting.
5569 intf
->resetting_device
= 1;
5570 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5571 desc
->bAlternateSetting
);
5572 intf
->resetting_device
= 0;
5575 dev_err(&udev
->dev
, "failed to restore interface %d "
5576 "altsetting %d (error=%d)\n",
5577 desc
->bInterfaceNumber
,
5578 desc
->bAlternateSetting
,
5582 /* Resetting also frees any allocated streams */
5583 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5584 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5588 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5589 usb_set_usb2_hardware_lpm(udev
, 1);
5590 usb_unlocked_enable_lpm(udev
);
5591 usb_enable_ltm(udev
);
5592 usb_release_bos_descriptor(udev
);
5597 usb_release_bos_descriptor(udev
);
5599 re_enumerate_no_bos
:
5600 /* LPM state doesn't matter when we're about to destroy the device. */
5601 hub_port_logical_disconnect(parent_hub
, port1
);
5606 * usb_reset_device - warn interface drivers and perform a USB port reset
5607 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5609 * Warns all drivers bound to registered interfaces (using their pre_reset
5610 * method), performs the port reset, and then lets the drivers know that
5611 * the reset is over (using their post_reset method).
5613 * Return: The same as for usb_reset_and_verify_device().
5616 * The caller must own the device lock. For example, it's safe to use
5617 * this from a driver probe() routine after downloading new firmware.
5618 * For calls that might not occur during probe(), drivers should lock
5619 * the device using usb_lock_device_for_reset().
5621 * If an interface is currently being probed or disconnected, we assume
5622 * its driver knows how to handle resets. For all other interfaces,
5623 * if the driver doesn't have pre_reset and post_reset methods then
5624 * we attempt to unbind it and rebind afterward.
5626 int usb_reset_device(struct usb_device
*udev
)
5630 unsigned int noio_flag
;
5631 struct usb_port
*port_dev
;
5632 struct usb_host_config
*config
= udev
->actconfig
;
5633 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5635 if (udev
->state
== USB_STATE_NOTATTACHED
||
5636 udev
->state
== USB_STATE_SUSPENDED
) {
5637 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5642 if (!udev
->parent
) {
5643 /* this requires hcd-specific logic; see ohci_restart() */
5644 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5648 port_dev
= hub
->ports
[udev
->portnum
- 1];
5651 * Don't allocate memory with GFP_KERNEL in current
5652 * context to avoid possible deadlock if usb mass
5653 * storage interface or usbnet interface(iSCSI case)
5654 * is included in current configuration. The easist
5655 * approach is to do it for every device reset,
5656 * because the device 'memalloc_noio' flag may have
5657 * not been set before reseting the usb device.
5659 noio_flag
= memalloc_noio_save();
5661 /* Prevent autosuspend during the reset */
5662 usb_autoresume_device(udev
);
5665 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5666 struct usb_interface
*cintf
= config
->interface
[i
];
5667 struct usb_driver
*drv
;
5670 if (cintf
->dev
.driver
) {
5671 drv
= to_usb_driver(cintf
->dev
.driver
);
5672 if (drv
->pre_reset
&& drv
->post_reset
)
5673 unbind
= (drv
->pre_reset
)(cintf
);
5674 else if (cintf
->condition
==
5675 USB_INTERFACE_BOUND
)
5678 usb_forced_unbind_intf(cintf
);
5683 usb_lock_port(port_dev
);
5684 ret
= usb_reset_and_verify_device(udev
);
5685 usb_unlock_port(port_dev
);
5688 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5689 struct usb_interface
*cintf
= config
->interface
[i
];
5690 struct usb_driver
*drv
;
5691 int rebind
= cintf
->needs_binding
;
5693 if (!rebind
&& cintf
->dev
.driver
) {
5694 drv
= to_usb_driver(cintf
->dev
.driver
);
5695 if (drv
->post_reset
)
5696 rebind
= (drv
->post_reset
)(cintf
);
5697 else if (cintf
->condition
==
5698 USB_INTERFACE_BOUND
)
5701 cintf
->needs_binding
= 1;
5704 usb_unbind_and_rebind_marked_interfaces(udev
);
5707 usb_autosuspend_device(udev
);
5708 memalloc_noio_restore(noio_flag
);
5711 EXPORT_SYMBOL_GPL(usb_reset_device
);
5715 * usb_queue_reset_device - Reset a USB device from an atomic context
5716 * @iface: USB interface belonging to the device to reset
5718 * This function can be used to reset a USB device from an atomic
5719 * context, where usb_reset_device() won't work (as it blocks).
5721 * Doing a reset via this method is functionally equivalent to calling
5722 * usb_reset_device(), except for the fact that it is delayed to a
5723 * workqueue. This means that any drivers bound to other interfaces
5724 * might be unbound, as well as users from usbfs in user space.
5728 * - Scheduling two resets at the same time from two different drivers
5729 * attached to two different interfaces of the same device is
5730 * possible; depending on how the driver attached to each interface
5731 * handles ->pre_reset(), the second reset might happen or not.
5733 * - If the reset is delayed so long that the interface is unbound from
5734 * its driver, the reset will be skipped.
5736 * - This function can be called during .probe(). It can also be called
5737 * during .disconnect(), but doing so is pointless because the reset
5738 * will not occur. If you really want to reset the device during
5739 * .disconnect(), call usb_reset_device() directly -- but watch out
5740 * for nested unbinding issues!
5742 void usb_queue_reset_device(struct usb_interface
*iface
)
5744 if (schedule_work(&iface
->reset_ws
))
5745 usb_get_intf(iface
);
5747 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5750 * usb_hub_find_child - Get the pointer of child device
5751 * attached to the port which is specified by @port1.
5752 * @hdev: USB device belonging to the usb hub
5753 * @port1: port num to indicate which port the child device
5756 * USB drivers call this function to get hub's child device
5759 * Return: %NULL if input param is invalid and
5760 * child's usb_device pointer if non-NULL.
5762 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5765 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5767 if (port1
< 1 || port1
> hdev
->maxchild
)
5769 return hub
->ports
[port1
- 1]->child
;
5771 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5773 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5774 struct usb_hub_descriptor
*desc
)
5776 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5777 enum usb_port_connect_type connect_type
;
5783 if (!hub_is_superspeed(hdev
)) {
5784 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5785 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5787 connect_type
= port_dev
->connect_type
;
5788 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5789 u8 mask
= 1 << (i
%8);
5791 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5792 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5793 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5798 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5800 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5801 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5803 connect_type
= port_dev
->connect_type
;
5804 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5807 if (!(port_removable
& mask
)) {
5808 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5809 port_removable
|= mask
;
5814 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5820 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5821 * @hdev: USB device belonging to the usb hub
5822 * @port1: port num of the port
5824 * Return: Port's acpi handle if successful, %NULL if params are
5827 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5830 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5835 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);