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_hub
*hub
, int port1
, bool set
)
791 struct usb_device
*hdev
= hub
->hdev
;
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
);
1114 * Add debounce if USB3 link is in polling/link training state.
1115 * Link will automatically transition to Enabled state after
1116 * link training completes.
1118 if (hub_is_superspeed(hdev
) &&
1119 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
1120 USB_SS_PORT_LS_POLLING
))
1121 need_debounce_delay
= true;
1123 /* Clear status-change flags; we'll debounce later */
1124 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1125 need_debounce_delay
= true;
1126 usb_clear_port_feature(hub
->hdev
, port1
,
1127 USB_PORT_FEAT_C_CONNECTION
);
1129 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1130 need_debounce_delay
= true;
1131 usb_clear_port_feature(hub
->hdev
, port1
,
1132 USB_PORT_FEAT_C_ENABLE
);
1134 if (portchange
& USB_PORT_STAT_C_RESET
) {
1135 need_debounce_delay
= true;
1136 usb_clear_port_feature(hub
->hdev
, port1
,
1137 USB_PORT_FEAT_C_RESET
);
1139 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1140 hub_is_superspeed(hub
->hdev
)) {
1141 need_debounce_delay
= true;
1142 usb_clear_port_feature(hub
->hdev
, port1
,
1143 USB_PORT_FEAT_C_BH_PORT_RESET
);
1145 /* We can forget about a "removed" device when there's a
1146 * physical disconnect or the connect status changes.
1148 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1149 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1150 clear_bit(port1
, hub
->removed_bits
);
1152 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1153 /* Tell hub_wq to disconnect the device or
1154 * check for a new connection or over current condition.
1155 * Based on USB2.0 Spec Section 11.12.5,
1156 * C_PORT_OVER_CURRENT could be set while
1157 * PORT_OVER_CURRENT is not. So check for any of them.
1159 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1160 (portstatus
& USB_PORT_STAT_OVERCURRENT
) ||
1161 (portchange
& USB_PORT_STAT_C_OVERCURRENT
))
1162 set_bit(port1
, hub
->change_bits
);
1164 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1165 bool port_resumed
= (portstatus
&
1166 USB_PORT_STAT_LINK_STATE
) ==
1168 /* The power session apparently survived the resume.
1169 * If there was an overcurrent or suspend change
1170 * (i.e., remote wakeup request), have hub_wq
1171 * take care of it. Look at the port link state
1172 * for USB 3.0 hubs, since they don't have a suspend
1173 * change bit, and they don't set the port link change
1174 * bit on device-initiated resume.
1176 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1178 set_bit(port1
, hub
->change_bits
);
1180 } else if (udev
->persist_enabled
) {
1182 udev
->reset_resume
= 1;
1184 /* Don't set the change_bits when the device
1187 if (test_bit(port1
, hub
->power_bits
))
1188 set_bit(port1
, hub
->change_bits
);
1191 /* The power session is gone; tell hub_wq */
1192 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1193 set_bit(port1
, hub
->change_bits
);
1197 /* If no port-status-change flags were set, we don't need any
1198 * debouncing. If flags were set we can try to debounce the
1199 * ports all at once right now, instead of letting hub_wq do them
1200 * one at a time later on.
1202 * If any port-status changes do occur during this delay, hub_wq
1203 * will see them later and handle them normally.
1205 if (need_debounce_delay
) {
1206 delay
= HUB_DEBOUNCE_STABLE
;
1208 /* Don't do a long sleep inside a workqueue routine */
1209 if (type
== HUB_INIT2
) {
1210 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1211 queue_delayed_work(system_power_efficient_wq
,
1213 msecs_to_jiffies(delay
));
1214 device_unlock(&hdev
->dev
);
1215 return; /* Continues at init3: below */
1223 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1225 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1226 if (hub
->has_indicators
&& blinkenlights
)
1227 queue_delayed_work(system_power_efficient_wq
,
1228 &hub
->leds
, LED_CYCLE_PERIOD
);
1230 /* Scan all ports that need attention */
1233 if (type
== HUB_INIT2
|| type
== HUB_INIT3
) {
1234 /* Allow autosuspend if it was suppressed */
1236 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1237 device_unlock(&hdev
->dev
);
1240 kref_put(&hub
->kref
, hub_release
);
1243 /* Implement the continuations for the delays above */
1244 static void hub_init_func2(struct work_struct
*ws
)
1246 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1248 hub_activate(hub
, HUB_INIT2
);
1251 static void hub_init_func3(struct work_struct
*ws
)
1253 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1255 hub_activate(hub
, HUB_INIT3
);
1258 enum hub_quiescing_type
{
1259 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1262 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1264 struct usb_device
*hdev
= hub
->hdev
;
1267 /* hub_wq and related activity won't re-trigger */
1270 if (type
!= HUB_SUSPEND
) {
1271 /* Disconnect all the children */
1272 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1273 if (hub
->ports
[i
]->child
)
1274 usb_disconnect(&hub
->ports
[i
]->child
);
1278 /* Stop hub_wq and related activity */
1279 usb_kill_urb(hub
->urb
);
1280 if (hub
->has_indicators
)
1281 cancel_delayed_work_sync(&hub
->leds
);
1283 flush_work(&hub
->tt
.clear_work
);
1286 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1290 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1291 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1294 /* caller has locked the hub device */
1295 static int hub_pre_reset(struct usb_interface
*intf
)
1297 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1299 hub_quiesce(hub
, HUB_PRE_RESET
);
1301 hub_pm_barrier_for_all_ports(hub
);
1305 /* caller has locked the hub device */
1306 static int hub_post_reset(struct usb_interface
*intf
)
1308 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1311 hub_pm_barrier_for_all_ports(hub
);
1312 hub_activate(hub
, HUB_POST_RESET
);
1316 static int hub_configure(struct usb_hub
*hub
,
1317 struct usb_endpoint_descriptor
*endpoint
)
1319 struct usb_hcd
*hcd
;
1320 struct usb_device
*hdev
= hub
->hdev
;
1321 struct device
*hub_dev
= hub
->intfdev
;
1322 u16 hubstatus
, hubchange
;
1323 u16 wHubCharacteristics
;
1326 char *message
= "out of memory";
1331 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1337 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1342 mutex_init(&hub
->status_mutex
);
1344 hub
->descriptor
= kzalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1345 if (!hub
->descriptor
) {
1350 /* Request the entire hub descriptor.
1351 * hub->descriptor can handle USB_MAXCHILDREN ports,
1352 * but a (non-SS) hub can/will return fewer bytes here.
1354 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1356 message
= "can't read hub descriptor";
1360 maxchild
= USB_MAXCHILDREN
;
1361 if (hub_is_superspeed(hdev
))
1362 maxchild
= min_t(unsigned, maxchild
, USB_SS_MAXPORTS
);
1364 if (hub
->descriptor
->bNbrPorts
> maxchild
) {
1365 message
= "hub has too many ports!";
1368 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1369 message
= "hub doesn't have any ports!";
1374 maxchild
= hub
->descriptor
->bNbrPorts
;
1375 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1376 (maxchild
== 1) ? "" : "s");
1378 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1384 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1385 if (hub_is_superspeed(hdev
)) {
1393 /* FIXME for USB 3.0, skip for now */
1394 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1395 !(hub_is_superspeed(hdev
))) {
1396 char portstr
[USB_MAXCHILDREN
+ 1];
1398 for (i
= 0; i
< maxchild
; i
++)
1399 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1400 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1402 portstr
[maxchild
] = 0;
1403 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1405 dev_dbg(hub_dev
, "standalone hub\n");
1407 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1408 case HUB_CHAR_COMMON_LPSM
:
1409 dev_dbg(hub_dev
, "ganged power switching\n");
1411 case HUB_CHAR_INDV_PORT_LPSM
:
1412 dev_dbg(hub_dev
, "individual port power switching\n");
1414 case HUB_CHAR_NO_LPSM
:
1416 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1420 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1421 case HUB_CHAR_COMMON_OCPM
:
1422 dev_dbg(hub_dev
, "global over-current protection\n");
1424 case HUB_CHAR_INDV_PORT_OCPM
:
1425 dev_dbg(hub_dev
, "individual port over-current protection\n");
1427 case HUB_CHAR_NO_OCPM
:
1429 dev_dbg(hub_dev
, "no over-current protection\n");
1433 spin_lock_init(&hub
->tt
.lock
);
1434 INIT_LIST_HEAD(&hub
->tt
.clear_list
);
1435 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1436 switch (hdev
->descriptor
.bDeviceProtocol
) {
1439 case USB_HUB_PR_HS_SINGLE_TT
:
1440 dev_dbg(hub_dev
, "Single TT\n");
1443 case USB_HUB_PR_HS_MULTI_TT
:
1444 ret
= usb_set_interface(hdev
, 0, 1);
1446 dev_dbg(hub_dev
, "TT per port\n");
1449 dev_err(hub_dev
, "Using single TT (err %d)\n",
1454 /* USB 3.0 hubs don't have a TT */
1457 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1458 hdev
->descriptor
.bDeviceProtocol
);
1462 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1463 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1464 case HUB_TTTT_8_BITS
:
1465 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1466 hub
->tt
.think_time
= 666;
1467 dev_dbg(hub_dev
, "TT requires at most %d "
1468 "FS bit times (%d ns)\n",
1469 8, hub
->tt
.think_time
);
1472 case HUB_TTTT_16_BITS
:
1473 hub
->tt
.think_time
= 666 * 2;
1474 dev_dbg(hub_dev
, "TT requires at most %d "
1475 "FS bit times (%d ns)\n",
1476 16, hub
->tt
.think_time
);
1478 case HUB_TTTT_24_BITS
:
1479 hub
->tt
.think_time
= 666 * 3;
1480 dev_dbg(hub_dev
, "TT requires at most %d "
1481 "FS bit times (%d ns)\n",
1482 24, hub
->tt
.think_time
);
1484 case HUB_TTTT_32_BITS
:
1485 hub
->tt
.think_time
= 666 * 4;
1486 dev_dbg(hub_dev
, "TT requires at most %d "
1487 "FS bit times (%d ns)\n",
1488 32, hub
->tt
.think_time
);
1492 /* probe() zeroes hub->indicator[] */
1493 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1494 hub
->has_indicators
= 1;
1495 dev_dbg(hub_dev
, "Port indicators are supported\n");
1498 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1499 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1501 /* power budgeting mostly matters with bus-powered hubs,
1502 * and battery-powered root hubs (may provide just 8 mA).
1504 ret
= usb_get_std_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1506 message
= "can't get hub status";
1509 hcd
= bus_to_hcd(hdev
->bus
);
1510 if (hdev
== hdev
->bus
->root_hub
) {
1511 if (hcd
->power_budget
> 0)
1512 hdev
->bus_mA
= hcd
->power_budget
;
1514 hdev
->bus_mA
= full_load
* maxchild
;
1515 if (hdev
->bus_mA
>= full_load
)
1516 hub
->mA_per_port
= full_load
;
1518 hub
->mA_per_port
= hdev
->bus_mA
;
1519 hub
->limited_power
= 1;
1521 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1522 int remaining
= hdev
->bus_mA
-
1523 hub
->descriptor
->bHubContrCurrent
;
1525 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1526 hub
->descriptor
->bHubContrCurrent
);
1527 hub
->limited_power
= 1;
1529 if (remaining
< maxchild
* unit_load
)
1531 "insufficient power available "
1532 "to use all downstream ports\n");
1533 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1535 } else { /* Self-powered external hub */
1536 /* FIXME: What about battery-powered external hubs that
1537 * provide less current per port? */
1538 hub
->mA_per_port
= full_load
;
1540 if (hub
->mA_per_port
< full_load
)
1541 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1544 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1546 message
= "can't get hub status";
1550 /* local power status reports aren't always correct */
1551 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1552 dev_dbg(hub_dev
, "local power source is %s\n",
1553 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1554 ? "lost (inactive)" : "good");
1556 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1557 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1558 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1560 /* set up the interrupt endpoint
1561 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1562 * bytes as USB2.0[11.12.3] says because some hubs are known
1563 * to send more data (and thus cause overflow). For root hubs,
1564 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1565 * to be big enough for at least USB_MAXCHILDREN ports. */
1566 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1567 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1569 if (maxp
> sizeof(*hub
->buffer
))
1570 maxp
= sizeof(*hub
->buffer
);
1572 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1578 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1579 hub
, endpoint
->bInterval
);
1581 /* maybe cycle the hub leds */
1582 if (hub
->has_indicators
&& blinkenlights
)
1583 hub
->indicator
[0] = INDICATOR_CYCLE
;
1585 mutex_lock(&usb_port_peer_mutex
);
1586 for (i
= 0; i
< maxchild
; i
++) {
1587 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1589 dev_err(hub
->intfdev
,
1590 "couldn't create port%d device.\n", i
+ 1);
1595 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1596 struct usb_port
*port_dev
= hub
->ports
[i
];
1598 pm_runtime_put(&port_dev
->dev
);
1601 mutex_unlock(&usb_port_peer_mutex
);
1605 /* Update the HCD's internal representation of this hub before hub_wq
1606 * starts getting port status changes for devices under the hub.
1608 if (hcd
->driver
->update_hub_device
) {
1609 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1610 &hub
->tt
, GFP_KERNEL
);
1612 message
= "can't update HCD hub info";
1617 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1619 hub_activate(hub
, HUB_INIT
);
1623 dev_err(hub_dev
, "config failed, %s (err %d)\n",
1625 /* hub_disconnect() frees urb and descriptor */
1629 static void hub_release(struct kref
*kref
)
1631 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1633 usb_put_dev(hub
->hdev
);
1634 usb_put_intf(to_usb_interface(hub
->intfdev
));
1638 static unsigned highspeed_hubs
;
1640 static void hub_disconnect(struct usb_interface
*intf
)
1642 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1643 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1647 * Stop adding new hub events. We do not want to block here and thus
1648 * will not try to remove any pending work item.
1650 hub
->disconnected
= 1;
1652 /* Disconnect all children and quiesce the hub */
1654 hub_quiesce(hub
, HUB_DISCONNECT
);
1656 mutex_lock(&usb_port_peer_mutex
);
1658 /* Avoid races with recursively_mark_NOTATTACHED() */
1659 spin_lock_irq(&device_state_lock
);
1660 port1
= hdev
->maxchild
;
1662 usb_set_intfdata(intf
, NULL
);
1663 spin_unlock_irq(&device_state_lock
);
1665 for (; port1
> 0; --port1
)
1666 usb_hub_remove_port_device(hub
, port1
);
1668 mutex_unlock(&usb_port_peer_mutex
);
1670 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1673 usb_free_urb(hub
->urb
);
1675 kfree(hub
->descriptor
);
1679 pm_suspend_ignore_children(&intf
->dev
, false);
1680 kref_put(&hub
->kref
, hub_release
);
1683 static bool hub_descriptor_is_sane(struct usb_host_interface
*desc
)
1685 /* Some hubs have a subclass of 1, which AFAICT according to the */
1686 /* specs is not defined, but it works */
1687 if (desc
->desc
.bInterfaceSubClass
!= 0 &&
1688 desc
->desc
.bInterfaceSubClass
!= 1)
1691 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1692 if (desc
->desc
.bNumEndpoints
!= 1)
1695 /* If the first endpoint is not interrupt IN, we'd better punt! */
1696 if (!usb_endpoint_is_int_in(&desc
->endpoint
[0].desc
))
1702 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1704 struct usb_host_interface
*desc
;
1705 struct usb_device
*hdev
;
1706 struct usb_hub
*hub
;
1708 desc
= intf
->cur_altsetting
;
1709 hdev
= interface_to_usbdev(intf
);
1712 * Set default autosuspend delay as 0 to speedup bus suspend,
1713 * based on the below considerations:
1715 * - Unlike other drivers, the hub driver does not rely on the
1716 * autosuspend delay to provide enough time to handle a wakeup
1717 * event, and the submitted status URB is just to check future
1718 * change on hub downstream ports, so it is safe to do it.
1720 * - The patch might cause one or more auto supend/resume for
1721 * below very rare devices when they are plugged into hub
1724 * devices having trouble initializing, and disconnect
1725 * themselves from the bus and then reconnect a second
1728 * devices just for downloading firmware, and disconnects
1729 * themselves after completing it
1731 * For these quite rare devices, their drivers may change the
1732 * autosuspend delay of their parent hub in the probe() to one
1733 * appropriate value to avoid the subtle problem if someone
1736 * - The patch may cause one or more auto suspend/resume on
1737 * hub during running 'lsusb', but it is probably too
1738 * infrequent to worry about.
1740 * - Change autosuspend delay of hub can avoid unnecessary auto
1741 * suspend timer for hub, also may decrease power consumption
1744 * - If user has indicated to prevent autosuspend by passing
1745 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1748 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1749 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1753 * Hubs have proper suspend/resume support, except for root hubs
1754 * where the controller driver doesn't have bus_suspend and
1755 * bus_resume methods.
1757 if (hdev
->parent
) { /* normal device */
1758 usb_enable_autosuspend(hdev
);
1759 } else { /* root hub */
1760 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1762 if (drv
->bus_suspend
&& drv
->bus_resume
)
1763 usb_enable_autosuspend(hdev
);
1766 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1768 "Unsupported bus topology: hub nested too deep\n");
1772 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1774 dev_warn(&intf
->dev
, "ignoring external hub\n");
1779 if (!hub_descriptor_is_sane(desc
)) {
1780 dev_err(&intf
->dev
, "bad descriptor, ignoring hub\n");
1784 /* We found a hub */
1785 dev_info(&intf
->dev
, "USB hub found\n");
1787 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1791 kref_init(&hub
->kref
);
1792 hub
->intfdev
= &intf
->dev
;
1794 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1795 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1796 INIT_WORK(&hub
->events
, hub_event
);
1800 usb_set_intfdata(intf
, hub
);
1801 intf
->needs_remote_wakeup
= 1;
1802 pm_suspend_ignore_children(&intf
->dev
, true);
1804 if (hdev
->speed
== USB_SPEED_HIGH
)
1807 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1808 hub
->quirk_check_port_auto_suspend
= 1;
1810 if (hub_configure(hub
, &desc
->endpoint
[0].desc
) >= 0)
1813 hub_disconnect(intf
);
1818 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1820 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1821 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1823 /* assert ifno == 0 (part of hub spec) */
1825 case USBDEVFS_HUB_PORTINFO
: {
1826 struct usbdevfs_hub_portinfo
*info
= user_data
;
1829 spin_lock_irq(&device_state_lock
);
1830 if (hdev
->devnum
<= 0)
1833 info
->nports
= hdev
->maxchild
;
1834 for (i
= 0; i
< info
->nports
; i
++) {
1835 if (hub
->ports
[i
]->child
== NULL
)
1839 hub
->ports
[i
]->child
->devnum
;
1842 spin_unlock_irq(&device_state_lock
);
1844 return info
->nports
+ 1;
1853 * Allow user programs to claim ports on a hub. When a device is attached
1854 * to one of these "claimed" ports, the program will "own" the device.
1856 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1857 struct usb_dev_state
***ppowner
)
1859 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1861 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1863 if (port1
== 0 || port1
> hdev
->maxchild
)
1866 /* Devices not managed by the hub driver
1867 * will always have maxchild equal to 0.
1869 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1873 /* In the following three functions, the caller must hold hdev's lock */
1874 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1875 struct usb_dev_state
*owner
)
1878 struct usb_dev_state
**powner
;
1880 rc
= find_port_owner(hdev
, port1
, &powner
);
1888 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1890 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1891 struct usb_dev_state
*owner
)
1894 struct usb_dev_state
**powner
;
1896 rc
= find_port_owner(hdev
, port1
, &powner
);
1899 if (*powner
!= owner
)
1904 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1906 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1908 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1911 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1912 if (hub
->ports
[n
]->port_owner
== owner
)
1913 hub
->ports
[n
]->port_owner
= NULL
;
1918 /* The caller must hold udev's lock */
1919 bool usb_device_is_owned(struct usb_device
*udev
)
1921 struct usb_hub
*hub
;
1923 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1925 hub
= usb_hub_to_struct_hub(udev
->parent
);
1926 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1929 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1931 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1934 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1935 if (hub
->ports
[i
]->child
)
1936 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1938 if (udev
->state
== USB_STATE_SUSPENDED
)
1939 udev
->active_duration
-= jiffies
;
1940 udev
->state
= USB_STATE_NOTATTACHED
;
1944 * usb_set_device_state - change a device's current state (usbcore, hcds)
1945 * @udev: pointer to device whose state should be changed
1946 * @new_state: new state value to be stored
1948 * udev->state is _not_ fully protected by the device lock. Although
1949 * most transitions are made only while holding the lock, the state can
1950 * can change to USB_STATE_NOTATTACHED at almost any time. This
1951 * is so that devices can be marked as disconnected as soon as possible,
1952 * without having to wait for any semaphores to be released. As a result,
1953 * all changes to any device's state must be protected by the
1954 * device_state_lock spinlock.
1956 * Once a device has been added to the device tree, all changes to its state
1957 * should be made using this routine. The state should _not_ be set directly.
1959 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1960 * Otherwise udev->state is set to new_state, and if new_state is
1961 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1962 * to USB_STATE_NOTATTACHED.
1964 void usb_set_device_state(struct usb_device
*udev
,
1965 enum usb_device_state new_state
)
1967 unsigned long flags
;
1970 spin_lock_irqsave(&device_state_lock
, flags
);
1971 if (udev
->state
== USB_STATE_NOTATTACHED
)
1973 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1975 /* root hub wakeup capabilities are managed out-of-band
1976 * and may involve silicon errata ... ignore them here.
1979 if (udev
->state
== USB_STATE_SUSPENDED
1980 || new_state
== USB_STATE_SUSPENDED
)
1981 ; /* No change to wakeup settings */
1982 else if (new_state
== USB_STATE_CONFIGURED
)
1983 wakeup
= (udev
->quirks
&
1984 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1985 udev
->actconfig
->desc
.bmAttributes
&
1986 USB_CONFIG_ATT_WAKEUP
;
1990 if (udev
->state
== USB_STATE_SUSPENDED
&&
1991 new_state
!= USB_STATE_SUSPENDED
)
1992 udev
->active_duration
-= jiffies
;
1993 else if (new_state
== USB_STATE_SUSPENDED
&&
1994 udev
->state
!= USB_STATE_SUSPENDED
)
1995 udev
->active_duration
+= jiffies
;
1996 udev
->state
= new_state
;
1998 recursively_mark_NOTATTACHED(udev
);
1999 spin_unlock_irqrestore(&device_state_lock
, flags
);
2001 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2003 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2006 * Choose a device number.
2008 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2009 * USB-2.0 buses they are also used as device addresses, however on
2010 * USB-3.0 buses the address is assigned by the controller hardware
2011 * and it usually is not the same as the device number.
2013 * WUSB devices are simple: they have no hubs behind, so the mapping
2014 * device <-> virtual port number becomes 1:1. Why? to simplify the
2015 * life of the device connection logic in
2016 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2017 * handshake we need to assign a temporary address in the unauthorized
2018 * space. For simplicity we use the first virtual port number found to
2019 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2020 * and that becomes it's address [X < 128] or its unauthorized address
2023 * We add 1 as an offset to the one-based USB-stack port number
2024 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2025 * 0 is reserved by USB for default address; (b) Linux's USB stack
2026 * uses always #1 for the root hub of the controller. So USB stack's
2027 * port #1, which is wusb virtual-port #0 has address #2.
2029 * Devices connected under xHCI are not as simple. The host controller
2030 * supports virtualization, so the hardware assigns device addresses and
2031 * the HCD must setup data structures before issuing a set address
2032 * command to the hardware.
2034 static void choose_devnum(struct usb_device
*udev
)
2037 struct usb_bus
*bus
= udev
->bus
;
2039 /* be safe when more hub events are proceed in parallel */
2040 mutex_lock(&bus
->devnum_next_mutex
);
2042 devnum
= udev
->portnum
+ 1;
2043 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2045 /* Try to allocate the next devnum beginning at
2046 * bus->devnum_next. */
2047 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2050 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2052 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2055 set_bit(devnum
, bus
->devmap
.devicemap
);
2056 udev
->devnum
= devnum
;
2058 mutex_unlock(&bus
->devnum_next_mutex
);
2061 static void release_devnum(struct usb_device
*udev
)
2063 if (udev
->devnum
> 0) {
2064 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2069 static void update_devnum(struct usb_device
*udev
, int devnum
)
2071 /* The address for a WUSB device is managed by wusbcore. */
2073 udev
->devnum
= devnum
;
2076 static void hub_free_dev(struct usb_device
*udev
)
2078 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2080 /* Root hubs aren't real devices, so don't free HCD resources */
2081 if (hcd
->driver
->free_dev
&& udev
->parent
)
2082 hcd
->driver
->free_dev(hcd
, udev
);
2085 static void hub_disconnect_children(struct usb_device
*udev
)
2087 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2090 /* Free up all the children before we remove this device */
2091 for (i
= 0; i
< udev
->maxchild
; i
++) {
2092 if (hub
->ports
[i
]->child
)
2093 usb_disconnect(&hub
->ports
[i
]->child
);
2098 * usb_disconnect - disconnect a device (usbcore-internal)
2099 * @pdev: pointer to device being disconnected
2100 * Context: !in_interrupt ()
2102 * Something got disconnected. Get rid of it and all of its children.
2104 * If *pdev is a normal device then the parent hub must already be locked.
2105 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2106 * which protects the set of root hubs as well as the list of buses.
2108 * Only hub drivers (including virtual root hub drivers for host
2109 * controllers) should ever call this.
2111 * This call is synchronous, and may not be used in an interrupt context.
2113 void usb_disconnect(struct usb_device
**pdev
)
2115 struct usb_port
*port_dev
= NULL
;
2116 struct usb_device
*udev
= *pdev
;
2117 struct usb_hub
*hub
= NULL
;
2120 /* mark the device as inactive, so any further urb submissions for
2121 * this device (and any of its children) will fail immediately.
2122 * this quiesces everything except pending urbs.
2124 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2125 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2129 * Ensure that the pm runtime code knows that the USB device
2130 * is in the process of being disconnected.
2132 pm_runtime_barrier(&udev
->dev
);
2134 usb_lock_device(udev
);
2136 hub_disconnect_children(udev
);
2138 /* deallocate hcd/hardware state ... nuking all pending urbs and
2139 * cleaning up all state associated with the current configuration
2140 * so that the hardware is now fully quiesced.
2142 dev_dbg(&udev
->dev
, "unregistering device\n");
2143 usb_disable_device(udev
, 0);
2144 usb_hcd_synchronize_unlinks(udev
);
2147 port1
= udev
->portnum
;
2148 hub
= usb_hub_to_struct_hub(udev
->parent
);
2149 port_dev
= hub
->ports
[port1
- 1];
2151 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2152 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2155 * As usb_port_runtime_resume() de-references udev, make
2156 * sure no resumes occur during removal
2158 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2159 pm_runtime_get_sync(&port_dev
->dev
);
2162 usb_remove_ep_devs(&udev
->ep0
);
2163 usb_unlock_device(udev
);
2165 /* Unregister the device. The device driver is responsible
2166 * for de-configuring the device and invoking the remove-device
2167 * notifier chain (used by usbfs and possibly others).
2169 device_del(&udev
->dev
);
2171 /* Free the device number and delete the parent's children[]
2172 * (or root_hub) pointer.
2174 release_devnum(udev
);
2176 /* Avoid races with recursively_mark_NOTATTACHED() */
2177 spin_lock_irq(&device_state_lock
);
2179 spin_unlock_irq(&device_state_lock
);
2181 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2182 pm_runtime_put(&port_dev
->dev
);
2186 put_device(&udev
->dev
);
2189 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2190 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2194 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2197 static void announce_device(struct usb_device
*udev
)
2199 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2200 le16_to_cpu(udev
->descriptor
.idVendor
),
2201 le16_to_cpu(udev
->descriptor
.idProduct
));
2202 dev_info(&udev
->dev
,
2203 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2204 udev
->descriptor
.iManufacturer
,
2205 udev
->descriptor
.iProduct
,
2206 udev
->descriptor
.iSerialNumber
);
2207 show_string(udev
, "Product", udev
->product
);
2208 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2209 show_string(udev
, "SerialNumber", udev
->serial
);
2212 static inline void announce_device(struct usb_device
*udev
) { }
2217 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2218 * @udev: newly addressed device (in ADDRESS state)
2220 * Finish enumeration for On-The-Go devices
2222 * Return: 0 if successful. A negative error code otherwise.
2224 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2228 #ifdef CONFIG_USB_OTG
2230 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2231 * to wake us after we've powered off VBUS; and HNP, switching roles
2232 * "host" to "peripheral". The OTG descriptor helps figure this out.
2234 if (!udev
->bus
->is_b_host
2236 && udev
->parent
== udev
->bus
->root_hub
) {
2237 struct usb_otg_descriptor
*desc
= NULL
;
2238 struct usb_bus
*bus
= udev
->bus
;
2239 unsigned port1
= udev
->portnum
;
2241 /* descriptor may appear anywhere in config */
2242 err
= __usb_get_extra_descriptor(udev
->rawdescriptors
[0],
2243 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2244 USB_DT_OTG
, (void **) &desc
, sizeof(*desc
));
2245 if (err
|| !(desc
->bmAttributes
& USB_OTG_HNP
))
2248 dev_info(&udev
->dev
, "Dual-Role OTG device on %sHNP port\n",
2249 (port1
== bus
->otg_port
) ? "" : "non-");
2251 /* enable HNP before suspend, it's simpler */
2252 if (port1
== bus
->otg_port
) {
2253 bus
->b_hnp_enable
= 1;
2254 err
= usb_control_msg(udev
,
2255 usb_sndctrlpipe(udev
, 0),
2256 USB_REQ_SET_FEATURE
, 0,
2257 USB_DEVICE_B_HNP_ENABLE
,
2259 USB_CTRL_SET_TIMEOUT
);
2262 * OTG MESSAGE: report errors here,
2263 * customize to match your product.
2265 dev_err(&udev
->dev
, "can't set HNP mode: %d\n",
2267 bus
->b_hnp_enable
= 0;
2269 } else if (desc
->bLength
== sizeof
2270 (struct usb_otg_descriptor
)) {
2271 /* Set a_alt_hnp_support for legacy otg device */
2272 err
= usb_control_msg(udev
,
2273 usb_sndctrlpipe(udev
, 0),
2274 USB_REQ_SET_FEATURE
, 0,
2275 USB_DEVICE_A_ALT_HNP_SUPPORT
,
2277 USB_CTRL_SET_TIMEOUT
);
2280 "set a_alt_hnp_support failed: %d\n",
2290 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2291 * @udev: newly addressed device (in ADDRESS state)
2293 * This is only called by usb_new_device() and usb_authorize_device()
2294 * and FIXME -- all comments that apply to them apply here wrt to
2297 * If the device is WUSB and not authorized, we don't attempt to read
2298 * the string descriptors, as they will be errored out by the device
2299 * until it has been authorized.
2301 * Return: 0 if successful. A negative error code otherwise.
2303 static int usb_enumerate_device(struct usb_device
*udev
)
2306 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2308 if (udev
->config
== NULL
) {
2309 err
= usb_get_configuration(udev
);
2312 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2318 /* read the standard strings and cache them if present */
2319 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2320 udev
->manufacturer
= usb_cache_string(udev
,
2321 udev
->descriptor
.iManufacturer
);
2322 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2324 err
= usb_enumerate_device_otg(udev
);
2328 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2329 !is_targeted(udev
)) {
2330 /* Maybe it can talk to us, though we can't talk to it.
2331 * (Includes HNP test device.)
2333 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2334 || udev
->bus
->is_b_host
)) {
2335 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2337 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2342 usb_detect_interface_quirks(udev
);
2347 static void set_usb_port_removable(struct usb_device
*udev
)
2349 struct usb_device
*hdev
= udev
->parent
;
2350 struct usb_hub
*hub
;
2351 u8 port
= udev
->portnum
;
2352 u16 wHubCharacteristics
;
2353 bool removable
= true;
2358 hub
= usb_hub_to_struct_hub(udev
->parent
);
2361 * If the platform firmware has provided information about a port,
2362 * use that to determine whether it's removable.
2364 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2365 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2366 udev
->removable
= USB_DEVICE_REMOVABLE
;
2368 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2369 case USB_PORT_NOT_USED
:
2370 udev
->removable
= USB_DEVICE_FIXED
;
2377 * Otherwise, check whether the hub knows whether a port is removable
2380 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2382 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2385 if (hub_is_superspeed(hdev
)) {
2386 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2390 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2395 udev
->removable
= USB_DEVICE_REMOVABLE
;
2397 udev
->removable
= USB_DEVICE_FIXED
;
2402 * usb_new_device - perform initial device setup (usbcore-internal)
2403 * @udev: newly addressed device (in ADDRESS state)
2405 * This is called with devices which have been detected but not fully
2406 * enumerated. The device descriptor is available, but not descriptors
2407 * for any device configuration. The caller must have locked either
2408 * the parent hub (if udev is a normal device) or else the
2409 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2410 * udev has already been installed, but udev is not yet visible through
2411 * sysfs or other filesystem code.
2413 * This call is synchronous, and may not be used in an interrupt context.
2415 * Only the hub driver or root-hub registrar should ever call this.
2417 * Return: Whether the device is configured properly or not. Zero if the
2418 * interface was registered with the driver core; else a negative errno
2422 int usb_new_device(struct usb_device
*udev
)
2427 /* Initialize non-root-hub device wakeup to disabled;
2428 * device (un)configuration controls wakeup capable
2429 * sysfs power/wakeup controls wakeup enabled/disabled
2431 device_init_wakeup(&udev
->dev
, 0);
2434 /* Tell the runtime-PM framework the device is active */
2435 pm_runtime_set_active(&udev
->dev
);
2436 pm_runtime_get_noresume(&udev
->dev
);
2437 pm_runtime_use_autosuspend(&udev
->dev
);
2438 pm_runtime_enable(&udev
->dev
);
2440 /* By default, forbid autosuspend for all devices. It will be
2441 * allowed for hubs during binding.
2443 usb_disable_autosuspend(udev
);
2445 err
= usb_enumerate_device(udev
); /* Read descriptors */
2448 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2449 udev
->devnum
, udev
->bus
->busnum
,
2450 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2451 /* export the usbdev device-node for libusb */
2452 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2453 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2455 /* Tell the world! */
2456 announce_device(udev
);
2459 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2461 add_device_randomness(udev
->product
, strlen(udev
->product
));
2462 if (udev
->manufacturer
)
2463 add_device_randomness(udev
->manufacturer
,
2464 strlen(udev
->manufacturer
));
2466 device_enable_async_suspend(&udev
->dev
);
2468 /* check whether the hub or firmware marks this port as non-removable */
2470 set_usb_port_removable(udev
);
2472 /* Register the device. The device driver is responsible
2473 * for configuring the device and invoking the add-device
2474 * notifier chain (used by usbfs and possibly others).
2476 err
= device_add(&udev
->dev
);
2478 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2482 /* Create link files between child device and usb port device. */
2484 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2485 int port1
= udev
->portnum
;
2486 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2488 err
= sysfs_create_link(&udev
->dev
.kobj
,
2489 &port_dev
->dev
.kobj
, "port");
2493 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2494 &udev
->dev
.kobj
, "device");
2496 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2500 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2501 pm_runtime_get_sync(&port_dev
->dev
);
2504 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2505 usb_mark_last_busy(udev
);
2506 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2510 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2511 pm_runtime_disable(&udev
->dev
);
2512 pm_runtime_set_suspended(&udev
->dev
);
2518 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2519 * @usb_dev: USB device
2521 * Move the USB device to a very basic state where interfaces are disabled
2522 * and the device is in fact unconfigured and unusable.
2524 * We share a lock (that we have) with device_del(), so we need to
2529 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2531 usb_lock_device(usb_dev
);
2532 if (usb_dev
->authorized
== 0)
2533 goto out_unauthorized
;
2535 usb_dev
->authorized
= 0;
2536 usb_set_configuration(usb_dev
, -1);
2539 usb_unlock_device(usb_dev
);
2544 int usb_authorize_device(struct usb_device
*usb_dev
)
2548 usb_lock_device(usb_dev
);
2549 if (usb_dev
->authorized
== 1)
2550 goto out_authorized
;
2552 result
= usb_autoresume_device(usb_dev
);
2554 dev_err(&usb_dev
->dev
,
2555 "can't autoresume for authorization: %d\n", result
);
2556 goto error_autoresume
;
2559 if (usb_dev
->wusb
) {
2560 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2562 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2563 "authorization: %d\n", result
);
2564 goto error_device_descriptor
;
2568 usb_dev
->authorized
= 1;
2569 /* Choose and set the configuration. This registers the interfaces
2570 * with the driver core and lets interface drivers bind to them.
2572 c
= usb_choose_configuration(usb_dev
);
2574 result
= usb_set_configuration(usb_dev
, c
);
2576 dev_err(&usb_dev
->dev
,
2577 "can't set config #%d, error %d\n", c
, result
);
2578 /* This need not be fatal. The user can try to
2579 * set other configurations. */
2582 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2584 error_device_descriptor
:
2585 usb_autosuspend_device(usb_dev
);
2588 usb_unlock_device(usb_dev
); /* complements locktree */
2593 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2594 * check it from the link protocol field of the current speed ID attribute.
2595 * current speed ID is got from ext port status request. Sublink speed attribute
2596 * table is returned with the hub BOS SSP device capability descriptor
2598 static int port_speed_is_ssp(struct usb_device
*hdev
, int speed_id
)
2603 struct usb_ssp_cap_descriptor
*ssp_cap
= hdev
->bos
->ssp_cap
;
2608 ssa_count
= le32_to_cpu(ssp_cap
->bmAttributes
) &
2609 USB_SSP_SUBLINK_SPEED_ATTRIBS
;
2611 for (i
= 0; i
<= ssa_count
; i
++) {
2612 ss_attr
= le32_to_cpu(ssp_cap
->bmSublinkSpeedAttr
[i
]);
2613 if (speed_id
== (ss_attr
& USB_SSP_SUBLINK_SPEED_SSID
))
2614 return !!(ss_attr
& USB_SSP_SUBLINK_SPEED_LP
);
2619 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2620 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2622 struct usb_hcd
*hcd
;
2623 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2625 hcd
= bus_to_hcd(hub
->hdev
->bus
);
2626 return hcd
->wireless
;
2630 #define PORT_RESET_TRIES 5
2631 #define SET_ADDRESS_TRIES 2
2632 #define GET_DESCRIPTOR_TRIES 2
2633 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2634 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2636 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2637 #define HUB_SHORT_RESET_TIME 10
2638 #define HUB_BH_RESET_TIME 50
2639 #define HUB_LONG_RESET_TIME 200
2640 #define HUB_RESET_TIMEOUT 800
2643 * "New scheme" enumeration causes an extra state transition to be
2644 * exposed to an xhci host and causes USB3 devices to receive control
2645 * commands in the default state. This has been seen to cause
2646 * enumeration failures, so disable this enumeration scheme for USB3
2649 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2651 if (udev
->speed
>= USB_SPEED_SUPER
)
2654 return USE_NEW_SCHEME(retry
);
2657 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2658 * Port worm reset is required to recover
2660 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2665 if (!hub_is_superspeed(hub
->hdev
))
2668 if (test_bit(port1
, hub
->warm_reset_bits
))
2671 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2672 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2673 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2676 static void hub_port_power_cycle(struct usb_hub
*hub
, int port1
)
2678 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2681 ret
= usb_hub_set_port_power(hub
, port1
, false);
2683 dev_info(&port_dev
->dev
, "failed to disable port power\n");
2687 msleep(2 * hub_power_on_good_delay(hub
));
2688 ret
= usb_hub_set_port_power(hub
, port1
, true);
2690 dev_info(&port_dev
->dev
, "failed to enable port power\n");
2694 msleep(hub_power_on_good_delay(hub
));
2697 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2698 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2700 int delay_time
, ret
;
2703 u32 ext_portstatus
= 0;
2705 for (delay_time
= 0;
2706 delay_time
< HUB_RESET_TIMEOUT
;
2707 delay_time
+= delay
) {
2708 /* wait to give the device a chance to reset */
2711 /* read and decode port status */
2712 if (hub_is_superspeedplus(hub
->hdev
))
2713 ret
= hub_ext_port_status(hub
, port1
,
2714 HUB_EXT_PORT_STATUS
,
2715 &portstatus
, &portchange
,
2718 ret
= hub_port_status(hub
, port1
, &portstatus
,
2724 * The port state is unknown until the reset completes.
2726 * On top of that, some chips may require additional time
2727 * to re-establish a connection after the reset is complete,
2728 * so also wait for the connection to be re-established.
2730 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2731 (portstatus
& USB_PORT_STAT_CONNECTION
))
2734 /* switch to the long delay after two short delay failures */
2735 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2736 delay
= HUB_LONG_RESET_TIME
;
2738 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2739 "not %sreset yet, waiting %dms\n",
2740 warm
? "warm " : "", delay
);
2743 if ((portstatus
& USB_PORT_STAT_RESET
))
2746 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2749 /* Device went away? */
2750 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2753 /* Retry if connect change is set but status is still connected.
2754 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2755 * but the device may have successfully re-connected. Ignore it.
2757 if (!hub_is_superspeed(hub
->hdev
) &&
2758 (portchange
& USB_PORT_STAT_C_CONNECTION
)) {
2759 usb_clear_port_feature(hub
->hdev
, port1
,
2760 USB_PORT_FEAT_C_CONNECTION
);
2764 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2770 if (hub_is_wusb(hub
))
2771 udev
->speed
= USB_SPEED_WIRELESS
;
2772 else if (hub_is_superspeedplus(hub
->hdev
) &&
2773 port_speed_is_ssp(hub
->hdev
, ext_portstatus
&
2774 USB_EXT_PORT_STAT_RX_SPEED_ID
))
2775 udev
->speed
= USB_SPEED_SUPER_PLUS
;
2776 else if (hub_is_superspeed(hub
->hdev
))
2777 udev
->speed
= USB_SPEED_SUPER
;
2778 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2779 udev
->speed
= USB_SPEED_HIGH
;
2780 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2781 udev
->speed
= USB_SPEED_LOW
;
2783 udev
->speed
= USB_SPEED_FULL
;
2787 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2788 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2789 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2792 u16 portchange
, portstatus
;
2793 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2794 int reset_recovery_time
;
2796 if (!hub_is_superspeed(hub
->hdev
)) {
2798 dev_err(hub
->intfdev
, "only USB3 hub support "
2802 /* Block EHCI CF initialization during the port reset.
2803 * Some companion controllers don't like it when they mix.
2805 down_read(&ehci_cf_port_reset_rwsem
);
2808 * If the caller hasn't explicitly requested a warm reset,
2809 * double check and see if one is needed.
2811 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) == 0)
2812 if (hub_port_warm_reset_required(hub
, port1
,
2816 clear_bit(port1
, hub
->warm_reset_bits
);
2818 /* Reset the port */
2819 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2820 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2821 USB_PORT_FEAT_BH_PORT_RESET
:
2822 USB_PORT_FEAT_RESET
));
2823 if (status
== -ENODEV
) {
2824 ; /* The hub is gone */
2825 } else if (status
) {
2826 dev_err(&port_dev
->dev
,
2827 "cannot %sreset (err = %d)\n",
2828 warm
? "warm " : "", status
);
2830 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2832 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2833 dev_dbg(hub
->intfdev
,
2834 "port_wait_reset: err = %d\n",
2838 /* Check for disconnect or reset */
2839 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2840 usb_clear_port_feature(hub
->hdev
, port1
,
2841 USB_PORT_FEAT_C_RESET
);
2843 if (!hub_is_superspeed(hub
->hdev
))
2846 usb_clear_port_feature(hub
->hdev
, port1
,
2847 USB_PORT_FEAT_C_BH_PORT_RESET
);
2848 usb_clear_port_feature(hub
->hdev
, port1
,
2849 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2852 usb_clear_port_feature(hub
->hdev
, port1
,
2853 USB_PORT_FEAT_C_CONNECTION
);
2856 * If a USB 3.0 device migrates from reset to an error
2857 * state, re-issue the warm reset.
2859 if (hub_port_status(hub
, port1
,
2860 &portstatus
, &portchange
) < 0)
2863 if (!hub_port_warm_reset_required(hub
, port1
,
2868 * If the port is in SS.Inactive or Compliance Mode, the
2869 * hot or warm reset failed. Try another warm reset.
2872 dev_dbg(&port_dev
->dev
,
2873 "hot reset failed, warm reset\n");
2878 dev_dbg(&port_dev
->dev
,
2879 "not enabled, trying %sreset again...\n",
2880 warm
? "warm " : "");
2881 delay
= HUB_LONG_RESET_TIME
;
2884 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2888 /* TRSTRCY = 10 ms; plus some extra */
2889 reset_recovery_time
= 10 + 40;
2891 /* Hub needs extra delay after resetting its port. */
2892 if (hub
->hdev
->quirks
& USB_QUIRK_HUB_SLOW_RESET
)
2893 reset_recovery_time
+= 100;
2895 msleep(reset_recovery_time
);
2898 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2900 update_devnum(udev
, 0);
2901 /* The xHC may think the device is already reset,
2902 * so ignore the status.
2904 if (hcd
->driver
->reset_device
)
2905 hcd
->driver
->reset_device(hcd
, udev
);
2907 usb_set_device_state(udev
, USB_STATE_DEFAULT
);
2911 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2914 if (!hub_is_superspeed(hub
->hdev
))
2915 up_read(&ehci_cf_port_reset_rwsem
);
2920 /* Check if a port is power on */
2921 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2925 if (hub_is_superspeed(hub
->hdev
)) {
2926 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2929 if (portstatus
& USB_PORT_STAT_POWER
)
2936 static void usb_lock_port(struct usb_port
*port_dev
)
2937 __acquires(&port_dev
->status_lock
)
2939 mutex_lock(&port_dev
->status_lock
);
2940 __acquire(&port_dev
->status_lock
);
2943 static void usb_unlock_port(struct usb_port
*port_dev
)
2944 __releases(&port_dev
->status_lock
)
2946 mutex_unlock(&port_dev
->status_lock
);
2947 __release(&port_dev
->status_lock
);
2952 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2953 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2957 if (hub_is_superspeed(hub
->hdev
)) {
2958 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2959 == USB_SS_PORT_LS_U3
)
2962 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2969 /* Determine whether the device on a port is ready for a normal resume,
2970 * is ready for a reset-resume, or should be disconnected.
2972 static int check_port_resume_type(struct usb_device
*udev
,
2973 struct usb_hub
*hub
, int port1
,
2974 int status
, u16 portchange
, u16 portstatus
)
2976 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2980 /* Is a warm reset needed to recover the connection? */
2981 if (status
== 0 && udev
->reset_resume
2982 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2985 /* Is the device still present? */
2986 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2987 !port_is_power_on(hub
, portstatus
)) {
2990 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2992 usleep_range(200, 300);
2993 status
= hub_port_status(hub
, port1
, &portstatus
,
3000 /* Can't do a normal resume if the port isn't enabled,
3001 * so try a reset-resume instead.
3003 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
3004 if (udev
->persist_enabled
)
3005 udev
->reset_resume
= 1;
3011 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
3012 portchange
, portstatus
, status
);
3013 } else if (udev
->reset_resume
) {
3015 /* Late port handoff can set status-change bits */
3016 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
3017 usb_clear_port_feature(hub
->hdev
, port1
,
3018 USB_PORT_FEAT_C_CONNECTION
);
3019 if (portchange
& USB_PORT_STAT_C_ENABLE
)
3020 usb_clear_port_feature(hub
->hdev
, port1
,
3021 USB_PORT_FEAT_C_ENABLE
);
3027 int usb_disable_ltm(struct usb_device
*udev
)
3029 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3031 /* Check if the roothub and device supports LTM. */
3032 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3033 !usb_device_supports_ltm(udev
))
3036 /* Clear Feature LTM Enable can only be sent if the device is
3039 if (!udev
->actconfig
)
3042 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3043 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3044 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3045 USB_CTRL_SET_TIMEOUT
);
3047 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3049 void usb_enable_ltm(struct usb_device
*udev
)
3051 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3053 /* Check if the roothub and device supports LTM. */
3054 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
3055 !usb_device_supports_ltm(udev
))
3058 /* Set Feature LTM Enable can only be sent if the device is
3061 if (!udev
->actconfig
)
3064 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3065 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3066 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
3067 USB_CTRL_SET_TIMEOUT
);
3069 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3072 * usb_enable_remote_wakeup - enable remote wakeup for a device
3073 * @udev: target device
3075 * For USB-2 devices: Set the device's remote wakeup feature.
3077 * For USB-3 devices: Assume there's only one function on the device and
3078 * enable remote wake for the first interface. FIXME if the interface
3079 * association descriptor shows there's more than one function.
3081 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3083 if (udev
->speed
< USB_SPEED_SUPER
)
3084 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3085 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3086 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3087 USB_CTRL_SET_TIMEOUT
);
3089 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3090 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3091 USB_INTRF_FUNC_SUSPEND
,
3092 USB_INTRF_FUNC_SUSPEND_RW
|
3093 USB_INTRF_FUNC_SUSPEND_LP
,
3094 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3098 * usb_disable_remote_wakeup - disable remote wakeup for a device
3099 * @udev: target device
3101 * For USB-2 devices: Clear the device's remote wakeup feature.
3103 * For USB-3 devices: Assume there's only one function on the device and
3104 * disable remote wake for the first interface. FIXME if the interface
3105 * association descriptor shows there's more than one function.
3107 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3109 if (udev
->speed
< USB_SPEED_SUPER
)
3110 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3111 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3112 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3113 USB_CTRL_SET_TIMEOUT
);
3115 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3116 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3117 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3118 USB_CTRL_SET_TIMEOUT
);
3121 /* Count of wakeup-enabled devices at or below udev */
3122 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3124 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3126 return udev
->do_remote_wakeup
+
3127 (hub
? hub
->wakeup_enabled_descendants
: 0);
3131 * usb_port_suspend - suspend a usb device's upstream port
3132 * @udev: device that's no longer in active use, not a root hub
3133 * Context: must be able to sleep; device not locked; pm locks held
3135 * Suspends a USB device that isn't in active use, conserving power.
3136 * Devices may wake out of a suspend, if anything important happens,
3137 * using the remote wakeup mechanism. They may also be taken out of
3138 * suspend by the host, using usb_port_resume(). It's also routine
3139 * to disconnect devices while they are suspended.
3141 * This only affects the USB hardware for a device; its interfaces
3142 * (and, for hubs, child devices) must already have been suspended.
3144 * Selective port suspend reduces power; most suspended devices draw
3145 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3146 * All devices below the suspended port are also suspended.
3148 * Devices leave suspend state when the host wakes them up. Some devices
3149 * also support "remote wakeup", where the device can activate the USB
3150 * tree above them to deliver data, such as a keypress or packet. In
3151 * some cases, this wakes the USB host.
3153 * Suspending OTG devices may trigger HNP, if that's been enabled
3154 * between a pair of dual-role devices. That will change roles, such
3155 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3157 * Devices on USB hub ports have only one "suspend" state, corresponding
3158 * to ACPI D2, "may cause the device to lose some context".
3159 * State transitions include:
3161 * - suspend, resume ... when the VBUS power link stays live
3162 * - suspend, disconnect ... VBUS lost
3164 * Once VBUS drop breaks the circuit, the port it's using has to go through
3165 * normal re-enumeration procedures, starting with enabling VBUS power.
3166 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3167 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3168 * timer, no SRP, no requests through sysfs.
3170 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3171 * suspended until their bus goes into global suspend (i.e., the root
3172 * hub is suspended). Nevertheless, we change @udev->state to
3173 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3174 * upstream port setting is stored in @udev->port_is_suspended.
3176 * Returns 0 on success, else negative errno.
3178 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3180 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3181 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3182 int port1
= udev
->portnum
;
3184 bool really_suspend
= true;
3186 usb_lock_port(port_dev
);
3188 /* enable remote wakeup when appropriate; this lets the device
3189 * wake up the upstream hub (including maybe the root hub).
3191 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3192 * we don't explicitly enable it here.
3194 if (udev
->do_remote_wakeup
) {
3195 status
= usb_enable_remote_wakeup(udev
);
3197 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3199 /* bail if autosuspend is requested */
3200 if (PMSG_IS_AUTO(msg
))
3205 /* disable USB2 hardware LPM */
3206 usb_disable_usb2_hardware_lpm(udev
);
3208 if (usb_disable_ltm(udev
)) {
3209 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3211 if (PMSG_IS_AUTO(msg
))
3216 if (hub_is_superspeed(hub
->hdev
))
3217 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3220 * For system suspend, we do not need to enable the suspend feature
3221 * on individual USB-2 ports. The devices will automatically go
3222 * into suspend a few ms after the root hub stops sending packets.
3223 * The USB 2.0 spec calls this "global suspend".
3225 * However, many USB hubs have a bug: They don't relay wakeup requests
3226 * from a downstream port if the port's suspend feature isn't on.
3227 * Therefore we will turn on the suspend feature if udev or any of its
3228 * descendants is enabled for remote wakeup.
3230 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3231 status
= set_port_feature(hub
->hdev
, port1
,
3232 USB_PORT_FEAT_SUSPEND
);
3234 really_suspend
= false;
3238 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3240 /* Try to enable USB3 LTM again */
3241 usb_enable_ltm(udev
);
3243 /* Try to enable USB2 hardware LPM again */
3244 usb_enable_usb2_hardware_lpm(udev
);
3246 if (udev
->do_remote_wakeup
)
3247 (void) usb_disable_remote_wakeup(udev
);
3250 /* System sleep transitions should never fail */
3251 if (!PMSG_IS_AUTO(msg
))
3254 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3255 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3256 udev
->do_remote_wakeup
);
3257 if (really_suspend
) {
3258 udev
->port_is_suspended
= 1;
3260 /* device has up to 10 msec to fully suspend */
3263 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3266 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3267 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3268 pm_runtime_put_sync(&port_dev
->dev
);
3270 usb_mark_last_busy(hub
->hdev
);
3272 usb_unlock_port(port_dev
);
3277 * If the USB "suspend" state is in use (rather than "global suspend"),
3278 * many devices will be individually taken out of suspend state using
3279 * special "resume" signaling. This routine kicks in shortly after
3280 * hardware resume signaling is finished, either because of selective
3281 * resume (by host) or remote wakeup (by device) ... now see what changed
3282 * in the tree that's rooted at this device.
3284 * If @udev->reset_resume is set then the device is reset before the
3285 * status check is done.
3287 static int finish_port_resume(struct usb_device
*udev
)
3292 /* caller owns the udev device lock */
3293 dev_dbg(&udev
->dev
, "%s\n",
3294 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3296 /* usb ch9 identifies four variants of SUSPENDED, based on what
3297 * state the device resumes to. Linux currently won't see the
3298 * first two on the host side; they'd be inside hub_port_init()
3299 * during many timeouts, but hub_wq can't suspend until later.
3301 usb_set_device_state(udev
, udev
->actconfig
3302 ? USB_STATE_CONFIGURED
3303 : USB_STATE_ADDRESS
);
3305 /* 10.5.4.5 says not to reset a suspended port if the attached
3306 * device is enabled for remote wakeup. Hence the reset
3307 * operation is carried out here, after the port has been
3310 if (udev
->reset_resume
) {
3312 * If the device morphs or switches modes when it is reset,
3313 * we don't want to perform a reset-resume. We'll fail the
3314 * resume, which will cause a logical disconnect, and then
3315 * the device will be rediscovered.
3318 if (udev
->quirks
& USB_QUIRK_RESET
)
3321 status
= usb_reset_and_verify_device(udev
);
3324 /* 10.5.4.5 says be sure devices in the tree are still there.
3325 * For now let's assume the device didn't go crazy on resume,
3326 * and device drivers will know about any resume quirks.
3330 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3332 /* If a normal resume failed, try doing a reset-resume */
3333 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3334 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3335 udev
->reset_resume
= 1;
3336 goto retry_reset_resume
;
3341 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3344 * There are a few quirky devices which violate the standard
3345 * by claiming to have remote wakeup enabled after a reset,
3346 * which crash if the feature is cleared, hence check for
3347 * udev->reset_resume
3349 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3350 if (udev
->speed
< USB_SPEED_SUPER
) {
3351 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3352 status
= usb_disable_remote_wakeup(udev
);
3354 status
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
, 0,
3356 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3357 | USB_INTRF_STAT_FUNC_RW
))
3358 status
= usb_disable_remote_wakeup(udev
);
3363 "disable remote wakeup, status %d\n",
3371 * There are some SS USB devices which take longer time for link training.
3372 * XHCI specs 4.19.4 says that when Link training is successful, port
3373 * sets CCS bit to 1. So if SW reads port status before successful link
3374 * training, then it will not find device to be present.
3375 * USB Analyzer log with such buggy devices show that in some cases
3376 * device switch on the RX termination after long delay of host enabling
3377 * the VBUS. In few other cases it has been seen that device fails to
3378 * negotiate link training in first attempt. It has been
3379 * reported till now that few devices take as long as 2000 ms to train
3380 * the link after host enabling its VBUS and termination. Following
3381 * routine implements a 2000 ms timeout for link training. If in a case
3382 * link trains before timeout, loop will exit earlier.
3384 * There are also some 2.0 hard drive based devices and 3.0 thumb
3385 * drives that, when plugged into a 2.0 only port, take a long
3386 * time to set CCS after VBUS enable.
3388 * FIXME: If a device was connected before suspend, but was removed
3389 * while system was asleep, then the loop in the following routine will
3390 * only exit at timeout.
3392 * This routine should only be called when persist is enabled.
3394 static int wait_for_connected(struct usb_device
*udev
,
3395 struct usb_hub
*hub
, int *port1
,
3396 u16
*portchange
, u16
*portstatus
)
3398 int status
= 0, delay_ms
= 0;
3400 while (delay_ms
< 2000) {
3401 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3403 if (!port_is_power_on(hub
, *portstatus
)) {
3409 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3411 dev_dbg(&udev
->dev
, "Waited %dms for CONNECT\n", delay_ms
);
3416 * usb_port_resume - re-activate a suspended usb device's upstream port
3417 * @udev: device to re-activate, not a root hub
3418 * Context: must be able to sleep; device not locked; pm locks held
3420 * This will re-activate the suspended device, increasing power usage
3421 * while letting drivers communicate again with its endpoints.
3422 * USB resume explicitly guarantees that the power session between
3423 * the host and the device is the same as it was when the device
3426 * If @udev->reset_resume is set then this routine won't check that the
3427 * port is still enabled. Furthermore, finish_port_resume() above will
3428 * reset @udev. The end result is that a broken power session can be
3429 * recovered and @udev will appear to persist across a loss of VBUS power.
3431 * For example, if a host controller doesn't maintain VBUS suspend current
3432 * during a system sleep or is reset when the system wakes up, all the USB
3433 * power sessions below it will be broken. This is especially troublesome
3434 * for mass-storage devices containing mounted filesystems, since the
3435 * device will appear to have disconnected and all the memory mappings
3436 * to it will be lost. Using the USB_PERSIST facility, the device can be
3437 * made to appear as if it had not disconnected.
3439 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3440 * every effort to insure that the same device is present after the
3441 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3442 * quite possible for a device to remain unaltered but its media to be
3443 * changed. If the user replaces a flash memory card while the system is
3444 * asleep, he will have only himself to blame when the filesystem on the
3445 * new card is corrupted and the system crashes.
3447 * Returns 0 on success, else negative errno.
3449 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3451 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3452 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3453 int port1
= udev
->portnum
;
3455 u16 portchange
, portstatus
;
3457 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3458 status
= pm_runtime_get_sync(&port_dev
->dev
);
3460 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3466 usb_lock_port(port_dev
);
3468 /* Skip the initial Clear-Suspend step for a remote wakeup */
3469 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3470 if (status
== 0 && !port_is_suspended(hub
, portstatus
)) {
3471 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3472 pm_wakeup_event(&udev
->dev
, 0);
3473 goto SuspendCleared
;
3476 /* see 7.1.7.7; affects power usage, but not budgeting */
3477 if (hub_is_superspeed(hub
->hdev
))
3478 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3480 status
= usb_clear_port_feature(hub
->hdev
,
3481 port1
, USB_PORT_FEAT_SUSPEND
);
3483 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3485 /* drive resume for USB_RESUME_TIMEOUT msec */
3486 dev_dbg(&udev
->dev
, "usb %sresume\n",
3487 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3488 msleep(USB_RESUME_TIMEOUT
);
3490 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3491 * stop resume signaling. Then finish the resume
3494 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3496 /* TRSMRCY = 10 msec */
3502 udev
->port_is_suspended
= 0;
3503 if (hub_is_superspeed(hub
->hdev
)) {
3504 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3505 usb_clear_port_feature(hub
->hdev
, port1
,
3506 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3508 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3509 usb_clear_port_feature(hub
->hdev
, port1
,
3510 USB_PORT_FEAT_C_SUSPEND
);
3514 if (udev
->persist_enabled
)
3515 status
= wait_for_connected(udev
, hub
, &port1
, &portchange
,
3518 status
= check_port_resume_type(udev
,
3519 hub
, port1
, status
, portchange
, portstatus
);
3521 status
= finish_port_resume(udev
);
3523 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3524 hub_port_logical_disconnect(hub
, port1
);
3526 /* Try to enable USB2 hardware LPM */
3527 usb_enable_usb2_hardware_lpm(udev
);
3529 /* Try to enable USB3 LTM */
3530 usb_enable_ltm(udev
);
3533 usb_unlock_port(port_dev
);
3538 int usb_remote_wakeup(struct usb_device
*udev
)
3542 usb_lock_device(udev
);
3543 if (udev
->state
== USB_STATE_SUSPENDED
) {
3544 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3545 status
= usb_autoresume_device(udev
);
3547 /* Let the drivers do their thing, then... */
3548 usb_autosuspend_device(udev
);
3551 usb_unlock_device(udev
);
3555 /* Returns 1 if there was a remote wakeup and a connect status change. */
3556 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3557 u16 portstatus
, u16 portchange
)
3558 __must_hold(&port_dev
->status_lock
)
3560 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3561 struct usb_device
*hdev
;
3562 struct usb_device
*udev
;
3563 int connect_change
= 0;
3568 udev
= port_dev
->child
;
3569 if (!hub_is_superspeed(hdev
)) {
3570 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3572 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3574 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
3575 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3576 (link_state
!= USB_SS_PORT_LS_U0
&&
3577 link_state
!= USB_SS_PORT_LS_U1
&&
3578 link_state
!= USB_SS_PORT_LS_U2
))
3583 /* TRSMRCY = 10 msec */
3586 usb_unlock_port(port_dev
);
3587 ret
= usb_remote_wakeup(udev
);
3588 usb_lock_port(port_dev
);
3593 hub_port_disable(hub
, port
, 1);
3595 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3596 return connect_change
;
3599 static int check_ports_changed(struct usb_hub
*hub
)
3603 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3604 u16 portstatus
, portchange
;
3607 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3608 if (!status
&& portchange
)
3614 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3616 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3617 struct usb_device
*hdev
= hub
->hdev
;
3622 * Warn if children aren't already suspended.
3623 * Also, add up the number of wakeup-enabled descendants.
3625 hub
->wakeup_enabled_descendants
= 0;
3626 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3627 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3628 struct usb_device
*udev
= port_dev
->child
;
3630 if (udev
&& udev
->can_submit
) {
3631 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3632 dev_name(&udev
->dev
));
3633 if (PMSG_IS_AUTO(msg
))
3637 hub
->wakeup_enabled_descendants
+=
3638 wakeup_enabled_descendants(udev
);
3641 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3642 /* check if there are changes pending on hub ports */
3643 if (check_ports_changed(hub
)) {
3644 if (PMSG_IS_AUTO(msg
))
3646 pm_wakeup_event(&hdev
->dev
, 2000);
3650 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3651 /* Enable hub to send remote wakeup for all ports. */
3652 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3653 status
= set_port_feature(hdev
,
3655 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3656 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3657 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3658 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3662 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3664 /* stop hub_wq and related activity */
3665 hub_quiesce(hub
, HUB_SUSPEND
);
3669 static int hub_resume(struct usb_interface
*intf
)
3671 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3673 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3674 hub_activate(hub
, HUB_RESUME
);
3678 static int hub_reset_resume(struct usb_interface
*intf
)
3680 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3682 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3683 hub_activate(hub
, HUB_RESET_RESUME
);
3688 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3689 * @rhdev: struct usb_device for the root hub
3691 * The USB host controller driver calls this function when its root hub
3692 * is resumed and Vbus power has been interrupted or the controller
3693 * has been reset. The routine marks @rhdev as having lost power.
3694 * When the hub driver is resumed it will take notice and carry out
3695 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3696 * the others will be disconnected.
3698 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3700 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3701 rhdev
->reset_resume
= 1;
3703 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3705 static const char * const usb3_lpm_names
[] = {
3713 * Send a Set SEL control transfer to the device, prior to enabling
3714 * device-initiated U1 or U2. This lets the device know the exit latencies from
3715 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3716 * packet from the host.
3718 * This function will fail if the SEL or PEL values for udev are greater than
3719 * the maximum allowed values for the link state to be enabled.
3721 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3723 struct usb_set_sel_req
*sel_values
;
3724 unsigned long long u1_sel
;
3725 unsigned long long u1_pel
;
3726 unsigned long long u2_sel
;
3727 unsigned long long u2_pel
;
3730 if (udev
->state
!= USB_STATE_CONFIGURED
)
3733 /* Convert SEL and PEL stored in ns to us */
3734 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3735 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3736 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3737 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3740 * Make sure that the calculated SEL and PEL values for the link
3741 * state we're enabling aren't bigger than the max SEL/PEL
3742 * value that will fit in the SET SEL control transfer.
3743 * Otherwise the device would get an incorrect idea of the exit
3744 * latency for the link state, and could start a device-initiated
3745 * U1/U2 when the exit latencies are too high.
3747 if ((state
== USB3_LPM_U1
&&
3748 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3749 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3750 (state
== USB3_LPM_U2
&&
3751 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3752 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3753 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3754 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3759 * If we're enabling device-initiated LPM for one link state,
3760 * but the other link state has a too high SEL or PEL value,
3761 * just set those values to the max in the Set SEL request.
3763 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3764 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3766 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3767 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3769 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3770 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3772 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3773 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3776 * usb_enable_lpm() can be called as part of a failed device reset,
3777 * which may be initiated by an error path of a mass storage driver.
3778 * Therefore, use GFP_NOIO.
3780 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3784 sel_values
->u1_sel
= u1_sel
;
3785 sel_values
->u1_pel
= u1_pel
;
3786 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3787 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3789 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3793 sel_values
, sizeof *(sel_values
),
3794 USB_CTRL_SET_TIMEOUT
);
3800 * Enable or disable device-initiated U1 or U2 transitions.
3802 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3803 enum usb3_link_state state
, bool enable
)
3810 feature
= USB_DEVICE_U1_ENABLE
;
3813 feature
= USB_DEVICE_U2_ENABLE
;
3816 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3817 __func__
, enable
? "enable" : "disable");
3821 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3822 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3823 "for unconfigured device.\n",
3824 __func__
, enable
? "enable" : "disable",
3825 usb3_lpm_names
[state
]);
3831 * Now send the control transfer to enable device-initiated LPM
3832 * for either U1 or U2.
3834 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3835 USB_REQ_SET_FEATURE
,
3839 USB_CTRL_SET_TIMEOUT
);
3841 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3842 USB_REQ_CLEAR_FEATURE
,
3846 USB_CTRL_SET_TIMEOUT
);
3849 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3850 enable
? "Enable" : "Disable",
3851 usb3_lpm_names
[state
]);
3857 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3858 enum usb3_link_state state
, int timeout
)
3865 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3868 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3871 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3876 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3877 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3878 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3879 "which is a reserved value.\n",
3880 usb3_lpm_names
[state
], timeout
);
3884 ret
= set_port_feature(udev
->parent
,
3885 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3888 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3889 "error code %i\n", usb3_lpm_names
[state
],
3893 if (state
== USB3_LPM_U1
)
3894 udev
->u1_params
.timeout
= timeout
;
3896 udev
->u2_params
.timeout
= timeout
;
3901 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3904 * We will attempt to enable U1 or U2, but there are no guarantees that the
3905 * control transfers to set the hub timeout or enable device-initiated U1/U2
3906 * will be successful.
3908 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3909 * hub-initiated U1/U2 will be disabled.
3911 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3912 * driver know about it. If that call fails, it should be harmless, and just
3913 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3915 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3916 enum usb3_link_state state
)
3919 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3920 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3922 /* If the device says it doesn't have *any* exit latency to come out of
3923 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3926 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3927 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3931 * First, let the device know about the exit latencies
3932 * associated with the link state we're about to enable.
3934 ret
= usb_req_set_sel(udev
, state
);
3936 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3937 usb3_lpm_names
[state
]);
3941 /* We allow the host controller to set the U1/U2 timeout internally
3942 * first, so that it can change its schedule to account for the
3943 * additional latency to send data to a device in a lower power
3946 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3948 /* xHCI host controller doesn't want to enable this LPM state. */
3953 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3954 "xHCI error %i.\n", usb3_lpm_names
[state
],
3959 if (usb_set_lpm_timeout(udev
, state
, timeout
)) {
3960 /* If we can't set the parent hub U1/U2 timeout,
3961 * device-initiated LPM won't be allowed either, so let the xHCI
3962 * host know that this link state won't be enabled.
3964 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3968 /* Only a configured device will accept the Set Feature
3971 if (udev
->actconfig
&&
3972 usb_set_device_initiated_lpm(udev
, state
, true) == 0) {
3973 if (state
== USB3_LPM_U1
)
3974 udev
->usb3_lpm_u1_enabled
= 1;
3975 else if (state
== USB3_LPM_U2
)
3976 udev
->usb3_lpm_u2_enabled
= 1;
3978 /* Don't request U1/U2 entry if the device
3979 * cannot transition to U1/U2.
3981 usb_set_lpm_timeout(udev
, state
, 0);
3982 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3987 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3990 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3991 * If zero is returned, the parent will not allow the link to go into U1/U2.
3993 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3994 * it won't have an effect on the bus link state because the parent hub will
3995 * still disallow device-initiated U1/U2 entry.
3997 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3998 * possible. The result will be slightly more bus bandwidth will be taken up
3999 * (to account for U1/U2 exit latency), but it should be harmless.
4001 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
4002 enum usb3_link_state state
)
4009 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
4014 if (usb_set_lpm_timeout(udev
, state
, 0))
4017 usb_set_device_initiated_lpm(udev
, state
, false);
4019 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
4020 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
4021 "bus schedule bandwidth may be impacted.\n",
4022 usb3_lpm_names
[state
]);
4024 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4025 * is disabled. Hub will disallows link to enter U1/U2 as well,
4026 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4027 * timeout set to 0, no matter device-initiated LPM is disabled or
4030 if (state
== USB3_LPM_U1
)
4031 udev
->usb3_lpm_u1_enabled
= 0;
4032 else if (state
== USB3_LPM_U2
)
4033 udev
->usb3_lpm_u2_enabled
= 0;
4039 * Disable hub-initiated and device-initiated U1 and U2 entry.
4040 * Caller must own the bandwidth_mutex.
4042 * This will call usb_enable_lpm() on failure, which will decrement
4043 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4045 int usb_disable_lpm(struct usb_device
*udev
)
4047 struct usb_hcd
*hcd
;
4049 if (!udev
|| !udev
->parent
||
4050 udev
->speed
< USB_SPEED_SUPER
||
4051 !udev
->lpm_capable
||
4052 udev
->state
< USB_STATE_DEFAULT
)
4055 hcd
= bus_to_hcd(udev
->bus
);
4056 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
4059 udev
->lpm_disable_count
++;
4060 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
4063 /* If LPM is enabled, attempt to disable it. */
4064 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
4066 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
4072 usb_enable_lpm(udev
);
4075 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4077 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4078 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4080 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4086 mutex_lock(hcd
->bandwidth_mutex
);
4087 ret
= usb_disable_lpm(udev
);
4088 mutex_unlock(hcd
->bandwidth_mutex
);
4092 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4095 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4096 * xHCI host policy may prevent U1 or U2 from being enabled.
4098 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4099 * until the lpm_disable_count drops to zero. Caller must own the
4102 void usb_enable_lpm(struct usb_device
*udev
)
4104 struct usb_hcd
*hcd
;
4105 struct usb_hub
*hub
;
4106 struct usb_port
*port_dev
;
4108 if (!udev
|| !udev
->parent
||
4109 udev
->speed
< USB_SPEED_SUPER
||
4110 !udev
->lpm_capable
||
4111 udev
->state
< USB_STATE_DEFAULT
)
4114 udev
->lpm_disable_count
--;
4115 hcd
= bus_to_hcd(udev
->bus
);
4116 /* Double check that we can both enable and disable LPM.
4117 * Device must be configured to accept set feature U1/U2 timeout.
4119 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4120 !hcd
->driver
->disable_usb3_lpm_timeout
)
4123 if (udev
->lpm_disable_count
> 0)
4126 hub
= usb_hub_to_struct_hub(udev
->parent
);
4130 port_dev
= hub
->ports
[udev
->portnum
- 1];
4132 if (port_dev
->usb3_lpm_u1_permit
)
4133 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4135 if (port_dev
->usb3_lpm_u2_permit
)
4136 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4138 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4140 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4141 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4143 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4148 mutex_lock(hcd
->bandwidth_mutex
);
4149 usb_enable_lpm(udev
);
4150 mutex_unlock(hcd
->bandwidth_mutex
);
4152 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4154 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4155 static void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4156 struct usb_port
*port_dev
)
4158 struct usb_device
*udev
= port_dev
->child
;
4161 if (udev
&& udev
->port_is_suspended
&& udev
->do_remote_wakeup
) {
4162 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4165 msleep(USB_RESUME_TIMEOUT
);
4166 ret
= usb_disable_remote_wakeup(udev
);
4169 dev_warn(&udev
->dev
,
4170 "Port disable: can't disable remote wake\n");
4171 udev
->do_remote_wakeup
= 0;
4175 #else /* CONFIG_PM */
4177 #define hub_suspend NULL
4178 #define hub_resume NULL
4179 #define hub_reset_resume NULL
4181 static inline void hub_usb3_port_prepare_disable(struct usb_hub
*hub
,
4182 struct usb_port
*port_dev
) { }
4184 int usb_disable_lpm(struct usb_device
*udev
)
4188 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4190 void usb_enable_lpm(struct usb_device
*udev
) { }
4191 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4193 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4197 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4199 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4200 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4202 int usb_disable_ltm(struct usb_device
*udev
)
4206 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4208 void usb_enable_ltm(struct usb_device
*udev
) { }
4209 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4211 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4212 u16 portstatus
, u16 portchange
)
4217 #endif /* CONFIG_PM */
4220 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4221 * a connection with a plugged-in cable but will signal the host when the cable
4222 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4224 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
4226 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4227 struct usb_device
*hdev
= hub
->hdev
;
4231 if (hub_is_superspeed(hub
->hdev
)) {
4232 hub_usb3_port_prepare_disable(hub
, port_dev
);
4233 ret
= hub_set_port_link_state(hub
, port_dev
->portnum
,
4236 ret
= usb_clear_port_feature(hdev
, port1
,
4237 USB_PORT_FEAT_ENABLE
);
4240 if (port_dev
->child
&& set_state
)
4241 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
4242 if (ret
&& ret
!= -ENODEV
)
4243 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
4248 * usb_port_disable - disable a usb device's upstream port
4249 * @udev: device to disable
4250 * Context: @udev locked, must be able to sleep.
4252 * Disables a USB device that isn't in active use.
4254 int usb_port_disable(struct usb_device
*udev
)
4256 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4258 return hub_port_disable(hub
, udev
->portnum
, 0);
4261 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4263 * Between connect detection and reset signaling there must be a delay
4264 * of 100ms at least for debounce and power-settling. The corresponding
4265 * timer shall restart whenever the downstream port detects a disconnect.
4267 * Apparently there are some bluetooth and irda-dongles and a number of
4268 * low-speed devices for which this debounce period may last over a second.
4269 * Not covered by the spec - but easy to deal with.
4271 * This implementation uses a 1500ms total debounce timeout; if the
4272 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4273 * every 25ms for transient disconnects. When the port status has been
4274 * unchanged for 100ms it returns the port status.
4276 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4279 u16 portchange
, portstatus
;
4280 unsigned connection
= 0xffff;
4281 int total_time
, stable_time
= 0;
4282 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4284 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4285 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4289 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4290 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4291 if (!must_be_connected
||
4292 (connection
== USB_PORT_STAT_CONNECTION
))
4293 stable_time
+= HUB_DEBOUNCE_STEP
;
4294 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4298 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4301 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4302 usb_clear_port_feature(hub
->hdev
, port1
,
4303 USB_PORT_FEAT_C_CONNECTION
);
4306 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4308 msleep(HUB_DEBOUNCE_STEP
);
4311 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4312 total_time
, stable_time
, portstatus
);
4314 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4319 void usb_ep0_reinit(struct usb_device
*udev
)
4321 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4322 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4323 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4325 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4327 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4328 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4330 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4333 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4336 * The host controller will choose the device address,
4337 * instead of the core having chosen it earlier
4339 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4341 if (udev
->state
== USB_STATE_ADDRESS
)
4343 if (udev
->state
!= USB_STATE_DEFAULT
)
4345 if (hcd
->driver
->address_device
)
4346 retval
= hcd
->driver
->address_device(hcd
, udev
);
4348 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4349 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4350 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4352 update_devnum(udev
, devnum
);
4353 /* Device now using proper address. */
4354 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4355 usb_ep0_reinit(udev
);
4361 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4362 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4365 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4366 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4367 * support bit in the BOS descriptor.
4369 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4371 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4372 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4374 if (!udev
->usb2_hw_lpm_capable
|| !udev
->bos
)
4378 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4380 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4381 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4382 udev
->usb2_hw_lpm_allowed
= 1;
4383 usb_enable_usb2_hardware_lpm(udev
);
4387 static int hub_enable_device(struct usb_device
*udev
)
4389 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4391 if (!hcd
->driver
->enable_device
)
4393 if (udev
->state
== USB_STATE_ADDRESS
)
4395 if (udev
->state
!= USB_STATE_DEFAULT
)
4398 return hcd
->driver
->enable_device(hcd
, udev
);
4401 /* Reset device, (re)assign address, get device descriptor.
4402 * Device connection must be stable, no more debouncing needed.
4403 * Returns device in USB_STATE_ADDRESS, except on error.
4405 * If this is called for an already-existing device (as part of
4406 * usb_reset_and_verify_device), the caller must own the device lock and
4407 * the port lock. For a newly detected device that is not accessible
4408 * through any global pointers, it's not necessary to lock the device,
4409 * but it is still necessary to lock the port.
4412 hub_port_init(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4415 struct usb_device
*hdev
= hub
->hdev
;
4416 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4417 int retries
, operations
, retval
, i
;
4418 unsigned delay
= HUB_SHORT_RESET_TIME
;
4419 enum usb_device_speed oldspeed
= udev
->speed
;
4421 int devnum
= udev
->devnum
;
4422 const char *driver_name
;
4424 /* root hub ports have a slightly longer reset period
4425 * (from USB 2.0 spec, section 7.1.7.5)
4427 if (!hdev
->parent
) {
4428 delay
= HUB_ROOT_RESET_TIME
;
4429 if (port1
== hdev
->bus
->otg_port
)
4430 hdev
->bus
->b_hnp_enable
= 0;
4433 /* Some low speed devices have problems with the quick delay, so */
4434 /* be a bit pessimistic with those devices. RHbug #23670 */
4435 if (oldspeed
== USB_SPEED_LOW
)
4436 delay
= HUB_LONG_RESET_TIME
;
4438 mutex_lock(hcd
->address0_mutex
);
4440 /* Reset the device; full speed may morph to high speed */
4441 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4442 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4443 if (retval
< 0) /* error or disconnect */
4445 /* success, speed is known */
4449 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4450 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
&&
4451 !(oldspeed
== USB_SPEED_SUPER
&& udev
->speed
> oldspeed
)) {
4452 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4455 oldspeed
= udev
->speed
;
4457 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4458 * it's fixed size except for full speed devices.
4459 * For Wireless USB devices, ep0 max packet is always 512 (tho
4460 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4462 switch (udev
->speed
) {
4463 case USB_SPEED_SUPER_PLUS
:
4464 case USB_SPEED_SUPER
:
4465 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4466 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4468 case USB_SPEED_HIGH
: /* fixed at 64 */
4469 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4471 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4472 /* to determine the ep0 maxpacket size, try to read
4473 * the device descriptor to get bMaxPacketSize0 and
4474 * then correct our initial guess.
4476 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4478 case USB_SPEED_LOW
: /* fixed at 8 */
4479 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4485 if (udev
->speed
== USB_SPEED_WIRELESS
)
4486 speed
= "variable speed Wireless";
4488 speed
= usb_speed_string(udev
->speed
);
4491 * The controller driver may be NULL if the controller device
4492 * is the middle device between platform device and roothub.
4493 * This middle device may not need a device driver due to
4494 * all hardware control can be at platform device driver, this
4495 * platform device is usually a dual-role USB controller device.
4497 if (udev
->bus
->controller
->driver
)
4498 driver_name
= udev
->bus
->controller
->driver
->name
;
4500 driver_name
= udev
->bus
->sysdev
->driver
->name
;
4502 if (udev
->speed
< USB_SPEED_SUPER
)
4503 dev_info(&udev
->dev
,
4504 "%s %s USB device number %d using %s\n",
4505 (udev
->config
) ? "reset" : "new", speed
,
4506 devnum
, driver_name
);
4508 /* Set up TT records, if needed */
4510 udev
->tt
= hdev
->tt
;
4511 udev
->ttport
= hdev
->ttport
;
4512 } else if (udev
->speed
!= USB_SPEED_HIGH
4513 && hdev
->speed
== USB_SPEED_HIGH
) {
4515 dev_err(&udev
->dev
, "parent hub has no TT\n");
4519 udev
->tt
= &hub
->tt
;
4520 udev
->ttport
= port1
;
4523 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4524 * Because device hardware and firmware is sometimes buggy in
4525 * this area, and this is how Linux has done it for ages.
4526 * Change it cautiously.
4528 * NOTE: If use_new_scheme() is true we will start by issuing
4529 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4530 * so it may help with some non-standards-compliant devices.
4531 * Otherwise we start with SET_ADDRESS and then try to read the
4532 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4535 for (retries
= 0; retries
< GET_DESCRIPTOR_TRIES
; (++retries
, msleep(100))) {
4536 bool did_new_scheme
= false;
4538 if (use_new_scheme(udev
, retry_counter
)) {
4539 struct usb_device_descriptor
*buf
;
4542 did_new_scheme
= true;
4543 retval
= hub_enable_device(udev
);
4546 "hub failed to enable device, error %d\n",
4551 #define GET_DESCRIPTOR_BUFSIZE 64
4552 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4558 /* Retry on all errors; some devices are flakey.
4559 * 255 is for WUSB devices, we actually need to use
4560 * 512 (WUSB1.0[4.8.1]).
4562 for (operations
= 0; operations
< 3; ++operations
) {
4563 buf
->bMaxPacketSize0
= 0;
4564 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4565 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4566 USB_DT_DEVICE
<< 8, 0,
4567 buf
, GET_DESCRIPTOR_BUFSIZE
,
4568 initial_descriptor_timeout
);
4569 switch (buf
->bMaxPacketSize0
) {
4570 case 8: case 16: case 32: case 64: case 255:
4571 if (buf
->bDescriptorType
==
4583 * Some devices time out if they are powered on
4584 * when already connected. They need a second
4585 * reset. But only on the first attempt,
4586 * lest we get into a time out/reset loop
4588 if (r
== 0 || (r
== -ETIMEDOUT
&&
4590 udev
->speed
> USB_SPEED_FULL
))
4593 udev
->descriptor
.bMaxPacketSize0
=
4594 buf
->bMaxPacketSize0
;
4597 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4598 if (retval
< 0) /* error or disconnect */
4600 if (oldspeed
!= udev
->speed
) {
4602 "device reset changed speed!\n");
4608 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4613 #undef GET_DESCRIPTOR_BUFSIZE
4617 * If device is WUSB, we already assigned an
4618 * unauthorized address in the Connect Ack sequence;
4619 * authorization will assign the final address.
4621 if (udev
->wusb
== 0) {
4622 for (operations
= 0; operations
< SET_ADDRESS_TRIES
; ++operations
) {
4623 retval
= hub_set_address(udev
, devnum
);
4629 if (retval
!= -ENODEV
)
4630 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4634 if (udev
->speed
>= USB_SPEED_SUPER
) {
4635 devnum
= udev
->devnum
;
4636 dev_info(&udev
->dev
,
4637 "%s SuperSpeed%s USB device number %d using %s\n",
4638 (udev
->config
) ? "reset" : "new",
4639 (udev
->speed
== USB_SPEED_SUPER_PLUS
) ? "Plus" : "",
4640 devnum
, driver_name
);
4643 /* cope with hardware quirkiness:
4644 * - let SET_ADDRESS settle, some device hardware wants it
4645 * - read ep0 maxpacket even for high and low speed,
4648 /* use_new_scheme() checks the speed which may have
4649 * changed since the initial look so we cache the result
4656 retval
= usb_get_device_descriptor(udev
, 8);
4658 if (retval
!= -ENODEV
)
4660 "device descriptor read/8, error %d\n",
4673 * Some superspeed devices have finished the link training process
4674 * and attached to a superspeed hub port, but the device descriptor
4675 * got from those devices show they aren't superspeed devices. Warm
4676 * reset the port attached by the devices can fix them.
4678 if ((udev
->speed
>= USB_SPEED_SUPER
) &&
4679 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4680 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4681 "warm reset device\n");
4682 hub_port_reset(hub
, port1
, udev
,
4683 HUB_BH_RESET_TIME
, true);
4688 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4689 udev
->speed
>= USB_SPEED_SUPER
)
4692 i
= udev
->descriptor
.bMaxPacketSize0
;
4693 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4694 if (udev
->speed
== USB_SPEED_LOW
||
4695 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4696 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4700 if (udev
->speed
== USB_SPEED_FULL
)
4701 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4703 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4704 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4705 usb_ep0_reinit(udev
);
4708 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4709 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4710 if (retval
!= -ENODEV
)
4711 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4718 usb_detect_quirks(udev
);
4720 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4721 retval
= usb_get_bos_descriptor(udev
);
4723 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4724 usb_set_lpm_parameters(udev
);
4729 /* notify HCD that we have a device connected and addressed */
4730 if (hcd
->driver
->update_device
)
4731 hcd
->driver
->update_device(hcd
, udev
);
4732 hub_set_initial_usb2_lpm_policy(udev
);
4735 hub_port_disable(hub
, port1
, 0);
4736 update_devnum(udev
, devnum
); /* for disconnect processing */
4738 mutex_unlock(hcd
->address0_mutex
);
4743 check_highspeed(struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4745 struct usb_qualifier_descriptor
*qual
;
4748 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4751 qual
= kmalloc(sizeof *qual
, GFP_KERNEL
);
4755 status
= usb_get_descriptor(udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4756 qual
, sizeof *qual
);
4757 if (status
== sizeof *qual
) {
4758 dev_info(&udev
->dev
, "not running at top speed; "
4759 "connect to a high speed hub\n");
4760 /* hub LEDs are probably harder to miss than syslog */
4761 if (hub
->has_indicators
) {
4762 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4763 queue_delayed_work(system_power_efficient_wq
,
4771 hub_power_remaining(struct usb_hub
*hub
)
4773 struct usb_device
*hdev
= hub
->hdev
;
4777 if (!hub
->limited_power
)
4780 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4781 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4782 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4783 struct usb_device
*udev
= port_dev
->child
;
4789 if (hub_is_superspeed(udev
))
4795 * Unconfigured devices may not use more than one unit load,
4796 * or 8mA for OTG ports
4798 if (udev
->actconfig
)
4799 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4800 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4804 if (delta
> hub
->mA_per_port
)
4805 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4806 delta
, hub
->mA_per_port
);
4809 if (remaining
< 0) {
4810 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4817 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4820 int status
= -ENODEV
;
4823 struct usb_device
*hdev
= hub
->hdev
;
4824 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4825 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4826 struct usb_device
*udev
= port_dev
->child
;
4827 static int unreliable_port
= -1;
4829 /* Disconnect any existing devices under this port */
4831 if (hcd
->usb_phy
&& !hdev
->parent
)
4832 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4833 usb_disconnect(&port_dev
->child
);
4836 /* We can forget about a "removed" device when there's a physical
4837 * disconnect or the connect status changes.
4839 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4840 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4841 clear_bit(port1
, hub
->removed_bits
);
4843 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4844 USB_PORT_STAT_C_ENABLE
)) {
4845 status
= hub_port_debounce_be_stable(hub
, port1
);
4847 if (status
!= -ENODEV
&&
4848 port1
!= unreliable_port
&&
4850 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4851 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4852 unreliable_port
= port1
;
4854 portstatus
= status
;
4858 /* Return now if debouncing failed or nothing is connected or
4859 * the device was "removed".
4861 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4862 test_bit(port1
, hub
->removed_bits
)) {
4865 * maybe switch power back on (e.g. root hub was reset)
4866 * but only if the port isn't owned by someone else.
4868 if (hub_is_port_power_switchable(hub
)
4869 && !port_is_power_on(hub
, portstatus
)
4870 && !port_dev
->port_owner
)
4871 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4873 if (portstatus
& USB_PORT_STAT_ENABLE
)
4877 if (hub_is_superspeed(hub
->hdev
))
4883 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4885 /* reallocate for each attempt, since references
4886 * to the previous one can escape in various ways
4888 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4890 dev_err(&port_dev
->dev
,
4891 "couldn't allocate usb_device\n");
4895 usb_set_device_state(udev
, USB_STATE_POWERED
);
4896 udev
->bus_mA
= hub
->mA_per_port
;
4897 udev
->level
= hdev
->level
+ 1;
4898 udev
->wusb
= hub_is_wusb(hub
);
4900 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4901 if (hub_is_superspeed(hub
->hdev
))
4902 udev
->speed
= USB_SPEED_SUPER
;
4904 udev
->speed
= USB_SPEED_UNKNOWN
;
4906 choose_devnum(udev
);
4907 if (udev
->devnum
<= 0) {
4908 status
= -ENOTCONN
; /* Don't retry */
4912 /* reset (non-USB 3.0 devices) and get descriptor */
4913 usb_lock_port(port_dev
);
4914 status
= hub_port_init(hub
, udev
, port1
, i
);
4915 usb_unlock_port(port_dev
);
4919 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4922 /* consecutive bus-powered hubs aren't reliable; they can
4923 * violate the voltage drop budget. if the new child has
4924 * a "powered" LED, users should notice we didn't enable it
4925 * (without reading syslog), even without per-port LEDs
4928 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4929 && udev
->bus_mA
<= unit_load
) {
4932 status
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0,
4935 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4938 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4940 "can't connect bus-powered hub "
4942 if (hub
->has_indicators
) {
4943 hub
->indicator
[port1
-1] =
4944 INDICATOR_AMBER_BLINK
;
4946 system_power_efficient_wq
,
4949 status
= -ENOTCONN
; /* Don't retry */
4954 /* check for devices running slower than they could */
4955 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4956 && udev
->speed
== USB_SPEED_FULL
4957 && highspeed_hubs
!= 0)
4958 check_highspeed(hub
, udev
, port1
);
4960 /* Store the parent's children[] pointer. At this point
4961 * udev becomes globally accessible, although presumably
4962 * no one will look at it until hdev is unlocked.
4966 mutex_lock(&usb_port_peer_mutex
);
4968 /* We mustn't add new devices if the parent hub has
4969 * been disconnected; we would race with the
4970 * recursively_mark_NOTATTACHED() routine.
4972 spin_lock_irq(&device_state_lock
);
4973 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4976 port_dev
->child
= udev
;
4977 spin_unlock_irq(&device_state_lock
);
4978 mutex_unlock(&usb_port_peer_mutex
);
4980 /* Run it through the hoops (find a driver, etc) */
4982 status
= usb_new_device(udev
);
4984 mutex_lock(&usb_port_peer_mutex
);
4985 spin_lock_irq(&device_state_lock
);
4986 port_dev
->child
= NULL
;
4987 spin_unlock_irq(&device_state_lock
);
4988 mutex_unlock(&usb_port_peer_mutex
);
4990 if (hcd
->usb_phy
&& !hdev
->parent
)
4991 usb_phy_notify_connect(hcd
->usb_phy
,
4999 status
= hub_power_remaining(hub
);
5001 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
5006 hub_port_disable(hub
, port1
, 1);
5008 usb_ep0_reinit(udev
);
5009 release_devnum(udev
);
5012 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
5015 /* When halfway through our retry count, power-cycle the port */
5016 if (i
== (SET_CONFIG_TRIES
/ 2) - 1) {
5017 dev_info(&port_dev
->dev
, "attempt power cycle\n");
5018 hub_port_power_cycle(hub
, port1
);
5021 if (hub
->hdev
->parent
||
5022 !hcd
->driver
->port_handed_over
||
5023 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
5024 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5025 dev_err(&port_dev
->dev
,
5026 "unable to enumerate USB device\n");
5030 hub_port_disable(hub
, port1
, 1);
5031 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
) {
5032 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
5033 hcd
->driver
->relinquish_port(hcd
, port1
);
5037 /* Handle physical or logical connection change events.
5038 * This routine is called when:
5039 * a port connection-change occurs;
5040 * a port enable-change occurs (often caused by EMI);
5041 * usb_reset_and_verify_device() encounters changed descriptors (as from
5042 * a firmware download)
5043 * caller already locked the hub
5045 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
5046 u16 portstatus
, u16 portchange
)
5047 __must_hold(&port_dev
->status_lock
)
5049 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5050 struct usb_device
*udev
= port_dev
->child
;
5051 int status
= -ENODEV
;
5053 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
5054 portchange
, portspeed(hub
, portstatus
));
5056 if (hub
->has_indicators
) {
5057 set_port_led(hub
, port1
, HUB_LED_AUTO
);
5058 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
5061 #ifdef CONFIG_USB_OTG
5062 /* during HNP, don't repeat the debounce */
5063 if (hub
->hdev
->bus
->is_b_host
)
5064 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
5065 USB_PORT_STAT_C_ENABLE
);
5068 /* Try to resuscitate an existing device */
5069 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
5070 udev
->state
!= USB_STATE_NOTATTACHED
) {
5071 if (portstatus
& USB_PORT_STAT_ENABLE
) {
5072 status
= 0; /* Nothing to do */
5074 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
5075 udev
->persist_enabled
) {
5076 /* For a suspended device, treat this as a
5077 * remote wakeup event.
5079 usb_unlock_port(port_dev
);
5080 status
= usb_remote_wakeup(udev
);
5081 usb_lock_port(port_dev
);
5084 /* Don't resuscitate */;
5087 clear_bit(port1
, hub
->change_bits
);
5089 /* successfully revalidated the connection */
5093 usb_unlock_port(port_dev
);
5094 hub_port_connect(hub
, port1
, portstatus
, portchange
);
5095 usb_lock_port(port_dev
);
5098 static void port_event(struct usb_hub
*hub
, int port1
)
5099 __must_hold(&port_dev
->status_lock
)
5102 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
5103 struct usb_device
*udev
= port_dev
->child
;
5104 struct usb_device
*hdev
= hub
->hdev
;
5105 u16 portstatus
, portchange
;
5107 connect_change
= test_bit(port1
, hub
->change_bits
);
5108 clear_bit(port1
, hub
->event_bits
);
5109 clear_bit(port1
, hub
->wakeup_bits
);
5111 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
5114 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
5115 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
5119 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
5120 if (!connect_change
)
5121 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
5123 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
5126 * EM interference sometimes causes badly shielded USB devices
5127 * to be shutdown by the hub, this hack enables them again.
5128 * Works at least with mouse driver.
5130 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
5131 && !connect_change
&& udev
) {
5132 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
5137 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
5138 u16 status
= 0, unused
;
5140 dev_dbg(&port_dev
->dev
, "over-current change\n");
5141 usb_clear_port_feature(hdev
, port1
,
5142 USB_PORT_FEAT_C_OVER_CURRENT
);
5143 msleep(100); /* Cool down */
5144 hub_power_on(hub
, true);
5145 hub_port_status(hub
, port1
, &status
, &unused
);
5146 if (status
& USB_PORT_STAT_OVERCURRENT
)
5147 dev_err(&port_dev
->dev
, "over-current condition\n");
5150 if (portchange
& USB_PORT_STAT_C_RESET
) {
5151 dev_dbg(&port_dev
->dev
, "reset change\n");
5152 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
5154 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
5155 && hub_is_superspeed(hdev
)) {
5156 dev_dbg(&port_dev
->dev
, "warm reset change\n");
5157 usb_clear_port_feature(hdev
, port1
,
5158 USB_PORT_FEAT_C_BH_PORT_RESET
);
5160 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
5161 dev_dbg(&port_dev
->dev
, "link state change\n");
5162 usb_clear_port_feature(hdev
, port1
,
5163 USB_PORT_FEAT_C_PORT_LINK_STATE
);
5165 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
5166 dev_warn(&port_dev
->dev
, "config error\n");
5167 usb_clear_port_feature(hdev
, port1
,
5168 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
5171 /* skip port actions that require the port to be powered on */
5172 if (!pm_runtime_active(&port_dev
->dev
))
5175 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
5179 * Warm reset a USB3 protocol port if it's in
5180 * SS.Inactive state.
5182 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
5183 dev_dbg(&port_dev
->dev
, "do warm reset\n");
5184 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
5185 || udev
->state
== USB_STATE_NOTATTACHED
) {
5186 if (hub_port_reset(hub
, port1
, NULL
,
5187 HUB_BH_RESET_TIME
, true) < 0)
5188 hub_port_disable(hub
, port1
, 1);
5190 usb_unlock_port(port_dev
);
5191 usb_lock_device(udev
);
5192 usb_reset_device(udev
);
5193 usb_unlock_device(udev
);
5194 usb_lock_port(port_dev
);
5200 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
5203 static void hub_event(struct work_struct
*work
)
5205 struct usb_device
*hdev
;
5206 struct usb_interface
*intf
;
5207 struct usb_hub
*hub
;
5208 struct device
*hub_dev
;
5213 hub
= container_of(work
, struct usb_hub
, events
);
5215 hub_dev
= hub
->intfdev
;
5216 intf
= to_usb_interface(hub_dev
);
5218 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5219 hdev
->state
, hdev
->maxchild
,
5220 /* NOTE: expects max 15 ports... */
5221 (u16
) hub
->change_bits
[0],
5222 (u16
) hub
->event_bits
[0]);
5224 /* Lock the device, then check to see if we were
5225 * disconnected while waiting for the lock to succeed. */
5226 usb_lock_device(hdev
);
5227 if (unlikely(hub
->disconnected
))
5230 /* If the hub has died, clean up after it */
5231 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5232 hub
->error
= -ENODEV
;
5233 hub_quiesce(hub
, HUB_DISCONNECT
);
5238 ret
= usb_autopm_get_interface(intf
);
5240 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5244 /* If this is an inactive hub, do nothing */
5249 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5251 ret
= usb_reset_device(hdev
);
5253 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5261 /* deal with port status changes */
5262 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5263 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5265 if (test_bit(i
, hub
->event_bits
)
5266 || test_bit(i
, hub
->change_bits
)
5267 || test_bit(i
, hub
->wakeup_bits
)) {
5269 * The get_noresume and barrier ensure that if
5270 * the port was in the process of resuming, we
5271 * flush that work and keep the port active for
5272 * the duration of the port_event(). However,
5273 * if the port is runtime pm suspended
5274 * (powered-off), we leave it in that state, run
5275 * an abbreviated port_event(), and move on.
5277 pm_runtime_get_noresume(&port_dev
->dev
);
5278 pm_runtime_barrier(&port_dev
->dev
);
5279 usb_lock_port(port_dev
);
5281 usb_unlock_port(port_dev
);
5282 pm_runtime_put_sync(&port_dev
->dev
);
5286 /* deal with hub status changes */
5287 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5289 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5290 dev_err(hub_dev
, "get_hub_status failed\n");
5292 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5293 dev_dbg(hub_dev
, "power change\n");
5294 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5295 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5296 /* FIXME: Is this always true? */
5297 hub
->limited_power
= 1;
5299 hub
->limited_power
= 0;
5301 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5305 dev_dbg(hub_dev
, "over-current change\n");
5306 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5307 msleep(500); /* Cool down */
5308 hub_power_on(hub
, true);
5309 hub_hub_status(hub
, &status
, &unused
);
5310 if (status
& HUB_STATUS_OVERCURRENT
)
5311 dev_err(hub_dev
, "over-current condition\n");
5316 /* Balance the usb_autopm_get_interface() above */
5317 usb_autopm_put_interface_no_suspend(intf
);
5319 usb_unlock_device(hdev
);
5321 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5322 usb_autopm_put_interface(intf
);
5323 kref_put(&hub
->kref
, hub_release
);
5326 static const struct usb_device_id hub_id_table
[] = {
5327 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5328 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5329 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5330 .bInterfaceClass
= USB_CLASS_HUB
,
5331 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5332 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5333 .bDeviceClass
= USB_CLASS_HUB
},
5334 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5335 .bInterfaceClass
= USB_CLASS_HUB
},
5336 { } /* Terminating entry */
5339 MODULE_DEVICE_TABLE(usb
, hub_id_table
);
5341 static struct usb_driver hub_driver
= {
5344 .disconnect
= hub_disconnect
,
5345 .suspend
= hub_suspend
,
5346 .resume
= hub_resume
,
5347 .reset_resume
= hub_reset_resume
,
5348 .pre_reset
= hub_pre_reset
,
5349 .post_reset
= hub_post_reset
,
5350 .unlocked_ioctl
= hub_ioctl
,
5351 .id_table
= hub_id_table
,
5352 .supports_autosuspend
= 1,
5355 int usb_hub_init(void)
5357 if (usb_register(&hub_driver
) < 0) {
5358 printk(KERN_ERR
"%s: can't register hub driver\n",
5364 * The workqueue needs to be freezable to avoid interfering with
5365 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5366 * device was gone before the EHCI controller had handed its port
5367 * over to the companion full-speed controller.
5369 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5373 /* Fall through if kernel_thread failed */
5374 usb_deregister(&hub_driver
);
5375 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5380 void usb_hub_cleanup(void)
5382 destroy_workqueue(hub_wq
);
5385 * Hub resources are freed for us by usb_deregister. It calls
5386 * usb_driver_purge on every device which in turn calls that
5387 * devices disconnect function if it is using this driver.
5388 * The hub_disconnect function takes care of releasing the
5389 * individual hub resources. -greg
5391 usb_deregister(&hub_driver
);
5392 } /* usb_hub_cleanup() */
5394 static int descriptors_changed(struct usb_device
*udev
,
5395 struct usb_device_descriptor
*old_device_descriptor
,
5396 struct usb_host_bos
*old_bos
)
5400 unsigned serial_len
= 0;
5402 unsigned old_length
;
5406 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5407 sizeof(*old_device_descriptor
)) != 0)
5410 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5413 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5414 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5416 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5420 /* Since the idVendor, idProduct, and bcdDevice values in the
5421 * device descriptor haven't changed, we will assume the
5422 * Manufacturer and Product strings haven't changed either.
5423 * But the SerialNumber string could be different (e.g., a
5424 * different flash card of the same brand).
5427 serial_len
= strlen(udev
->serial
) + 1;
5430 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5431 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5432 len
= max(len
, old_length
);
5435 buf
= kmalloc(len
, GFP_NOIO
);
5437 /* assume the worst */
5440 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5441 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5442 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5444 if (length
!= old_length
) {
5445 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5450 if (memcmp(buf
, udev
->rawdescriptors
[index
], old_length
)
5452 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5454 ((struct usb_config_descriptor
*) buf
)->
5455 bConfigurationValue
);
5461 if (!changed
&& serial_len
) {
5462 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5464 if (length
+ 1 != serial_len
) {
5465 dev_dbg(&udev
->dev
, "serial string error %d\n",
5468 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5469 dev_dbg(&udev
->dev
, "serial string changed\n");
5479 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5480 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5482 * WARNING - don't use this routine to reset a composite device
5483 * (one with multiple interfaces owned by separate drivers)!
5484 * Use usb_reset_device() instead.
5486 * Do a port reset, reassign the device's address, and establish its
5487 * former operating configuration. If the reset fails, or the device's
5488 * descriptors change from their values before the reset, or the original
5489 * configuration and altsettings cannot be restored, a flag will be set
5490 * telling hub_wq to pretend the device has been disconnected and then
5491 * re-connected. All drivers will be unbound, and the device will be
5492 * re-enumerated and probed all over again.
5494 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5495 * flagged for logical disconnection, or some other negative error code
5496 * if the reset wasn't even attempted.
5499 * The caller must own the device lock and the port lock, the latter is
5500 * taken by usb_reset_device(). For example, it's safe to use
5501 * usb_reset_device() from a driver probe() routine after downloading
5502 * new firmware. For calls that might not occur during probe(), drivers
5503 * should lock the device using usb_lock_device_for_reset().
5505 * Locking exception: This routine may also be called from within an
5506 * autoresume handler. Such usage won't conflict with other tasks
5507 * holding the device lock because these tasks should always call
5508 * usb_autopm_resume_device(), thereby preventing any unwanted
5509 * autoresume. The autoresume handler is expected to have already
5510 * acquired the port lock before calling this routine.
5512 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5514 struct usb_device
*parent_hdev
= udev
->parent
;
5515 struct usb_hub
*parent_hub
;
5516 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5517 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5518 struct usb_host_bos
*bos
;
5520 int port1
= udev
->portnum
;
5522 if (udev
->state
== USB_STATE_NOTATTACHED
||
5523 udev
->state
== USB_STATE_SUSPENDED
) {
5524 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5532 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5534 /* Disable USB2 hardware LPM.
5535 * It will be re-enabled by the enumeration process.
5537 usb_disable_usb2_hardware_lpm(udev
);
5539 /* Disable LPM while we reset the device and reinstall the alt settings.
5540 * Device-initiated LPM, and system exit latency settings are cleared
5541 * when the device is reset, so we have to set them up again.
5543 ret
= usb_unlocked_disable_lpm(udev
);
5545 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5546 goto re_enumerate_no_bos
;
5552 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5554 /* ep0 maxpacket size may change; let the HCD know about it.
5555 * Other endpoints will be handled by re-enumeration. */
5556 usb_ep0_reinit(udev
);
5557 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5558 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5565 /* Device might have changed firmware (DFU or similar) */
5566 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5567 dev_info(&udev
->dev
, "device firmware changed\n");
5568 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5572 /* Restore the device's previous configuration */
5573 if (!udev
->actconfig
)
5576 mutex_lock(hcd
->bandwidth_mutex
);
5577 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5579 dev_warn(&udev
->dev
,
5580 "Busted HC? Not enough HCD resources for "
5581 "old configuration.\n");
5582 mutex_unlock(hcd
->bandwidth_mutex
);
5585 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5586 USB_REQ_SET_CONFIGURATION
, 0,
5587 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5588 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5591 "can't restore configuration #%d (error=%d)\n",
5592 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5593 mutex_unlock(hcd
->bandwidth_mutex
);
5596 mutex_unlock(hcd
->bandwidth_mutex
);
5597 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5599 /* Put interfaces back into the same altsettings as before.
5600 * Don't bother to send the Set-Interface request for interfaces
5601 * that were already in altsetting 0; besides being unnecessary,
5602 * many devices can't handle it. Instead just reset the host-side
5605 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5606 struct usb_host_config
*config
= udev
->actconfig
;
5607 struct usb_interface
*intf
= config
->interface
[i
];
5608 struct usb_interface_descriptor
*desc
;
5610 desc
= &intf
->cur_altsetting
->desc
;
5611 if (desc
->bAlternateSetting
== 0) {
5612 usb_disable_interface(udev
, intf
, true);
5613 usb_enable_interface(udev
, intf
, true);
5616 /* Let the bandwidth allocation function know that this
5617 * device has been reset, and it will have to use
5618 * alternate setting 0 as the current alternate setting.
5620 intf
->resetting_device
= 1;
5621 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5622 desc
->bAlternateSetting
);
5623 intf
->resetting_device
= 0;
5626 dev_err(&udev
->dev
, "failed to restore interface %d "
5627 "altsetting %d (error=%d)\n",
5628 desc
->bInterfaceNumber
,
5629 desc
->bAlternateSetting
,
5633 /* Resetting also frees any allocated streams */
5634 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5635 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5639 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5640 usb_enable_usb2_hardware_lpm(udev
);
5641 usb_unlocked_enable_lpm(udev
);
5642 usb_enable_ltm(udev
);
5643 usb_release_bos_descriptor(udev
);
5648 usb_release_bos_descriptor(udev
);
5650 re_enumerate_no_bos
:
5651 /* LPM state doesn't matter when we're about to destroy the device. */
5652 hub_port_logical_disconnect(parent_hub
, port1
);
5657 * usb_reset_device - warn interface drivers and perform a USB port reset
5658 * @udev: device to reset (not in NOTATTACHED state)
5660 * Warns all drivers bound to registered interfaces (using their pre_reset
5661 * method), performs the port reset, and then lets the drivers know that
5662 * the reset is over (using their post_reset method).
5664 * Return: The same as for usb_reset_and_verify_device().
5667 * The caller must own the device lock. For example, it's safe to use
5668 * this from a driver probe() routine after downloading new firmware.
5669 * For calls that might not occur during probe(), drivers should lock
5670 * the device using usb_lock_device_for_reset().
5672 * If an interface is currently being probed or disconnected, we assume
5673 * its driver knows how to handle resets. For all other interfaces,
5674 * if the driver doesn't have pre_reset and post_reset methods then
5675 * we attempt to unbind it and rebind afterward.
5677 int usb_reset_device(struct usb_device
*udev
)
5681 unsigned int noio_flag
;
5682 struct usb_port
*port_dev
;
5683 struct usb_host_config
*config
= udev
->actconfig
;
5684 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5686 if (udev
->state
== USB_STATE_NOTATTACHED
) {
5687 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5692 if (!udev
->parent
) {
5693 /* this requires hcd-specific logic; see ohci_restart() */
5694 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5698 port_dev
= hub
->ports
[udev
->portnum
- 1];
5701 * Don't allocate memory with GFP_KERNEL in current
5702 * context to avoid possible deadlock if usb mass
5703 * storage interface or usbnet interface(iSCSI case)
5704 * is included in current configuration. The easist
5705 * approach is to do it for every device reset,
5706 * because the device 'memalloc_noio' flag may have
5707 * not been set before reseting the usb device.
5709 noio_flag
= memalloc_noio_save();
5711 /* Prevent autosuspend during the reset */
5712 usb_autoresume_device(udev
);
5715 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5716 struct usb_interface
*cintf
= config
->interface
[i
];
5717 struct usb_driver
*drv
;
5720 if (cintf
->dev
.driver
) {
5721 drv
= to_usb_driver(cintf
->dev
.driver
);
5722 if (drv
->pre_reset
&& drv
->post_reset
)
5723 unbind
= (drv
->pre_reset
)(cintf
);
5724 else if (cintf
->condition
==
5725 USB_INTERFACE_BOUND
)
5728 usb_forced_unbind_intf(cintf
);
5733 usb_lock_port(port_dev
);
5734 ret
= usb_reset_and_verify_device(udev
);
5735 usb_unlock_port(port_dev
);
5738 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5739 struct usb_interface
*cintf
= config
->interface
[i
];
5740 struct usb_driver
*drv
;
5741 int rebind
= cintf
->needs_binding
;
5743 if (!rebind
&& cintf
->dev
.driver
) {
5744 drv
= to_usb_driver(cintf
->dev
.driver
);
5745 if (drv
->post_reset
)
5746 rebind
= (drv
->post_reset
)(cintf
);
5747 else if (cintf
->condition
==
5748 USB_INTERFACE_BOUND
)
5751 cintf
->needs_binding
= 1;
5755 /* If the reset failed, hub_wq will unbind drivers later */
5757 usb_unbind_and_rebind_marked_interfaces(udev
);
5760 usb_autosuspend_device(udev
);
5761 memalloc_noio_restore(noio_flag
);
5764 EXPORT_SYMBOL_GPL(usb_reset_device
);
5768 * usb_queue_reset_device - Reset a USB device from an atomic context
5769 * @iface: USB interface belonging to the device to reset
5771 * This function can be used to reset a USB device from an atomic
5772 * context, where usb_reset_device() won't work (as it blocks).
5774 * Doing a reset via this method is functionally equivalent to calling
5775 * usb_reset_device(), except for the fact that it is delayed to a
5776 * workqueue. This means that any drivers bound to other interfaces
5777 * might be unbound, as well as users from usbfs in user space.
5781 * - Scheduling two resets at the same time from two different drivers
5782 * attached to two different interfaces of the same device is
5783 * possible; depending on how the driver attached to each interface
5784 * handles ->pre_reset(), the second reset might happen or not.
5786 * - If the reset is delayed so long that the interface is unbound from
5787 * its driver, the reset will be skipped.
5789 * - This function can be called during .probe(). It can also be called
5790 * during .disconnect(), but doing so is pointless because the reset
5791 * will not occur. If you really want to reset the device during
5792 * .disconnect(), call usb_reset_device() directly -- but watch out
5793 * for nested unbinding issues!
5795 void usb_queue_reset_device(struct usb_interface
*iface
)
5797 if (schedule_work(&iface
->reset_ws
))
5798 usb_get_intf(iface
);
5800 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5803 * usb_hub_find_child - Get the pointer of child device
5804 * attached to the port which is specified by @port1.
5805 * @hdev: USB device belonging to the usb hub
5806 * @port1: port num to indicate which port the child device
5809 * USB drivers call this function to get hub's child device
5812 * Return: %NULL if input param is invalid and
5813 * child's usb_device pointer if non-NULL.
5815 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5818 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5820 if (port1
< 1 || port1
> hdev
->maxchild
)
5822 return hub
->ports
[port1
- 1]->child
;
5824 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5826 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5827 struct usb_hub_descriptor
*desc
)
5829 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5830 enum usb_port_connect_type connect_type
;
5836 if (!hub_is_superspeed(hdev
)) {
5837 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5838 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5840 connect_type
= port_dev
->connect_type
;
5841 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5842 u8 mask
= 1 << (i
%8);
5844 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5845 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5846 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5851 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5853 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5854 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5856 connect_type
= port_dev
->connect_type
;
5857 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5860 if (!(port_removable
& mask
)) {
5861 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5862 port_removable
|= mask
;
5867 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5873 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5874 * @hdev: USB device belonging to the usb hub
5875 * @port1: port num of the port
5877 * Return: Port's acpi handle if successful, %NULL if params are
5880 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5883 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5888 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);