4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/workqueue.h>
26 #include <linux/mutex.h>
27 #include <linux/random.h>
28 #include <linux/pm_qos.h>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
34 #include "otg_whitelist.h"
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->dev.sem, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock
);
44 /* workqueue to process hub events */
45 static struct workqueue_struct
*hub_wq
;
46 static void hub_event(struct work_struct
*work
);
48 /* synchronize hub-port add/remove and peering operations */
49 DEFINE_MUTEX(usb_port_peer_mutex
);
51 /* cycle leds on hubs that aren't blinking for attention */
52 static bool blinkenlights
= 0;
53 module_param (blinkenlights
, bool, S_IRUGO
);
54 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
57 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
58 * 10 seconds to send reply for the initial 64-byte descriptor request.
60 /* define initial 64-byte descriptor request timeout in milliseconds */
61 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
62 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
63 MODULE_PARM_DESC(initial_descriptor_timeout
,
64 "initial 64-byte descriptor request timeout in milliseconds "
65 "(default 5000 - 5.0 seconds)");
68 * As of 2.6.10 we introduce a new USB device initialization scheme which
69 * closely resembles the way Windows works. Hopefully it will be compatible
70 * with a wider range of devices than the old scheme. However some previously
71 * working devices may start giving rise to "device not accepting address"
72 * errors; if that happens the user can try the old scheme by adjusting the
73 * following module parameters.
75 * For maximum flexibility there are two boolean parameters to control the
76 * hub driver's behavior. On the first initialization attempt, if the
77 * "old_scheme_first" parameter is set then the old scheme will be used,
78 * otherwise the new scheme is used. If that fails and "use_both_schemes"
79 * is set, then the driver will make another attempt, using the other scheme.
81 static bool old_scheme_first
= 0;
82 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
83 MODULE_PARM_DESC(old_scheme_first
,
84 "start with the old device initialization scheme");
86 static bool use_both_schemes
= 1;
87 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
88 MODULE_PARM_DESC(use_both_schemes
,
89 "try the other device initialization scheme if the "
92 /* Mutual exclusion for EHCI CF initialization. This interferes with
93 * port reset on some companion controllers.
95 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
96 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
98 #define HUB_DEBOUNCE_TIMEOUT 2000
99 #define HUB_DEBOUNCE_STEP 25
100 #define HUB_DEBOUNCE_STABLE 100
102 static void hub_release(struct kref
*kref
);
103 static int usb_reset_and_verify_device(struct usb_device
*udev
);
105 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
107 if (hub_is_superspeed(hub
->hdev
))
109 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
111 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
117 /* Note that hdev or one of its children must be locked! */
118 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
120 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
122 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
125 static int usb_device_supports_lpm(struct usb_device
*udev
)
127 /* USB 2.1 (and greater) devices indicate LPM support through
128 * their USB 2.0 Extended Capabilities BOS descriptor.
130 if (udev
->speed
== USB_SPEED_HIGH
) {
131 if (udev
->bos
->ext_cap
&&
133 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
139 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
140 * However, there are some that don't, and they set the U1/U2 exit
143 if (!udev
->bos
->ss_cap
) {
144 dev_info(&udev
->dev
, "No LPM exit latency info found, disabling LPM.\n");
148 if (udev
->bos
->ss_cap
->bU1devExitLat
== 0 &&
149 udev
->bos
->ss_cap
->bU2DevExitLat
== 0) {
151 dev_info(&udev
->dev
, "LPM exit latency is zeroed, disabling LPM.\n");
153 dev_info(&udev
->dev
, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
157 if (!udev
->parent
|| udev
->parent
->lpm_capable
)
163 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
166 static void usb_set_lpm_mel(struct usb_device
*udev
,
167 struct usb3_lpm_parameters
*udev_lpm_params
,
168 unsigned int udev_exit_latency
,
170 struct usb3_lpm_parameters
*hub_lpm_params
,
171 unsigned int hub_exit_latency
)
173 unsigned int total_mel
;
174 unsigned int device_mel
;
175 unsigned int hub_mel
;
178 * Calculate the time it takes to transition all links from the roothub
179 * to the parent hub into U0. The parent hub must then decode the
180 * packet (hub header decode latency) to figure out which port it was
183 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
184 * means 0.1us). Multiply that by 100 to get nanoseconds.
186 total_mel
= hub_lpm_params
->mel
+
187 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
190 * How long will it take to transition the downstream hub's port into
191 * U0? The greater of either the hub exit latency or the device exit
194 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
195 * Multiply that by 1000 to get nanoseconds.
197 device_mel
= udev_exit_latency
* 1000;
198 hub_mel
= hub_exit_latency
* 1000;
199 if (device_mel
> hub_mel
)
200 total_mel
+= device_mel
;
202 total_mel
+= hub_mel
;
204 udev_lpm_params
->mel
= total_mel
;
208 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
209 * a transition from either U1 or U2.
211 static void usb_set_lpm_pel(struct usb_device
*udev
,
212 struct usb3_lpm_parameters
*udev_lpm_params
,
213 unsigned int udev_exit_latency
,
215 struct usb3_lpm_parameters
*hub_lpm_params
,
216 unsigned int hub_exit_latency
,
217 unsigned int port_to_port_exit_latency
)
219 unsigned int first_link_pel
;
220 unsigned int hub_pel
;
223 * First, the device sends an LFPS to transition the link between the
224 * device and the parent hub into U0. The exit latency is the bigger of
225 * the device exit latency or the hub exit latency.
227 if (udev_exit_latency
> hub_exit_latency
)
228 first_link_pel
= udev_exit_latency
* 1000;
230 first_link_pel
= hub_exit_latency
* 1000;
233 * When the hub starts to receive the LFPS, there is a slight delay for
234 * it to figure out that one of the ports is sending an LFPS. Then it
235 * will forward the LFPS to its upstream link. The exit latency is the
236 * delay, plus the PEL that we calculated for this hub.
238 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
241 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
242 * is the greater of the two exit latencies.
244 if (first_link_pel
> hub_pel
)
245 udev_lpm_params
->pel
= first_link_pel
;
247 udev_lpm_params
->pel
= hub_pel
;
251 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
252 * when a device initiates a transition to U0, until when it will receive the
253 * first packet from the host controller.
255 * Section C.1.5.1 describes the four components to this:
257 * - t2: time for the ERDY to make it from the device to the host.
258 * - t3: a host-specific delay to process the ERDY.
259 * - t4: time for the packet to make it from the host to the device.
261 * t3 is specific to both the xHCI host and the platform the host is integrated
262 * into. The Intel HW folks have said it's negligible, FIXME if a different
263 * vendor says otherwise.
265 static void usb_set_lpm_sel(struct usb_device
*udev
,
266 struct usb3_lpm_parameters
*udev_lpm_params
)
268 struct usb_device
*parent
;
269 unsigned int num_hubs
;
270 unsigned int total_sel
;
272 /* t1 = device PEL */
273 total_sel
= udev_lpm_params
->pel
;
274 /* How many external hubs are in between the device & the root port. */
275 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
276 parent
= parent
->parent
)
278 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
280 total_sel
+= 2100 + 250 * (num_hubs
- 1);
282 /* t4 = 250ns * num_hubs */
283 total_sel
+= 250 * num_hubs
;
285 udev_lpm_params
->sel
= total_sel
;
288 static void usb_set_lpm_parameters(struct usb_device
*udev
)
291 unsigned int port_to_port_delay
;
292 unsigned int udev_u1_del
;
293 unsigned int udev_u2_del
;
294 unsigned int hub_u1_del
;
295 unsigned int hub_u2_del
;
297 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
300 hub
= usb_hub_to_struct_hub(udev
->parent
);
301 /* It doesn't take time to transition the roothub into U0, since it
302 * doesn't have an upstream link.
307 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
308 udev_u2_del
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
);
309 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
310 hub_u2_del
= le16_to_cpu(udev
->parent
->bos
->ss_cap
->bU2DevExitLat
);
312 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
313 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
315 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
316 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
319 * Appendix C, section C.2.2.2, says that there is a slight delay from
320 * when the parent hub notices the downstream port is trying to
321 * transition to U0 to when the hub initiates a U0 transition on its
322 * upstream port. The section says the delays are tPort2PortU1EL and
323 * tPort2PortU2EL, but it doesn't define what they are.
325 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
326 * about the same delays. Use the maximum delay calculations from those
327 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
328 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
329 * assume the device exit latencies they are talking about are the hub
332 * What do we do if the U2 exit latency is less than the U1 exit
333 * latency? It's possible, although not likely...
335 port_to_port_delay
= 1;
337 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
338 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
341 if (hub_u2_del
> hub_u1_del
)
342 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
344 port_to_port_delay
= 1 + hub_u1_del
;
346 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
347 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
350 /* Now that we've got PEL, calculate SEL. */
351 usb_set_lpm_sel(udev
, &udev
->u1_params
);
352 usb_set_lpm_sel(udev
, &udev
->u2_params
);
355 /* USB 2.0 spec Section 11.24.4.5 */
356 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
361 if (hub_is_superspeed(hdev
)) {
362 dtype
= USB_DT_SS_HUB
;
363 size
= USB_DT_SS_HUB_SIZE
;
366 size
= sizeof(struct usb_hub_descriptor
);
369 for (i
= 0; i
< 3; i
++) {
370 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
371 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
372 dtype
<< 8, 0, data
, size
,
373 USB_CTRL_GET_TIMEOUT
);
374 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
381 * USB 2.0 spec Section 11.24.2.1
383 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
385 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
386 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
390 * USB 2.0 spec Section 11.24.2.2
392 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
394 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
395 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
400 * USB 2.0 spec Section 11.24.2.13
402 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
404 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
405 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
409 static char *to_led_name(int selector
)
426 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
427 * for info about using port indicators
429 static void set_port_led(struct usb_hub
*hub
, int port1
, int selector
)
431 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
434 status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
435 USB_PORT_FEAT_INDICATOR
);
436 dev_dbg(&port_dev
->dev
, "indicator %s status %d\n",
437 to_led_name(selector
), status
);
440 #define LED_CYCLE_PERIOD ((2*HZ)/3)
442 static void led_work (struct work_struct
*work
)
444 struct usb_hub
*hub
=
445 container_of(work
, struct usb_hub
, leds
.work
);
446 struct usb_device
*hdev
= hub
->hdev
;
448 unsigned changed
= 0;
451 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
454 for (i
= 0; i
< hdev
->maxchild
; i
++) {
455 unsigned selector
, mode
;
457 /* 30%-50% duty cycle */
459 switch (hub
->indicator
[i
]) {
461 case INDICATOR_CYCLE
:
463 selector
= HUB_LED_AUTO
;
464 mode
= INDICATOR_AUTO
;
466 /* blinking green = sw attention */
467 case INDICATOR_GREEN_BLINK
:
468 selector
= HUB_LED_GREEN
;
469 mode
= INDICATOR_GREEN_BLINK_OFF
;
471 case INDICATOR_GREEN_BLINK_OFF
:
472 selector
= HUB_LED_OFF
;
473 mode
= INDICATOR_GREEN_BLINK
;
475 /* blinking amber = hw attention */
476 case INDICATOR_AMBER_BLINK
:
477 selector
= HUB_LED_AMBER
;
478 mode
= INDICATOR_AMBER_BLINK_OFF
;
480 case INDICATOR_AMBER_BLINK_OFF
:
481 selector
= HUB_LED_OFF
;
482 mode
= INDICATOR_AMBER_BLINK
;
484 /* blink green/amber = reserved */
485 case INDICATOR_ALT_BLINK
:
486 selector
= HUB_LED_GREEN
;
487 mode
= INDICATOR_ALT_BLINK_OFF
;
489 case INDICATOR_ALT_BLINK_OFF
:
490 selector
= HUB_LED_AMBER
;
491 mode
= INDICATOR_ALT_BLINK
;
496 if (selector
!= HUB_LED_AUTO
)
498 set_port_led(hub
, i
+ 1, selector
);
499 hub
->indicator
[i
] = mode
;
501 if (!changed
&& blinkenlights
) {
503 cursor
%= hdev
->maxchild
;
504 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
505 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
509 queue_delayed_work(system_power_efficient_wq
,
510 &hub
->leds
, LED_CYCLE_PERIOD
);
513 /* use a short timeout for hub/port status fetches */
514 #define USB_STS_TIMEOUT 1000
515 #define USB_STS_RETRIES 5
518 * USB 2.0 spec Section 11.24.2.6
520 static int get_hub_status(struct usb_device
*hdev
,
521 struct usb_hub_status
*data
)
523 int i
, status
= -ETIMEDOUT
;
525 for (i
= 0; i
< USB_STS_RETRIES
&&
526 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
527 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
528 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
529 data
, sizeof(*data
), USB_STS_TIMEOUT
);
535 * USB 2.0 spec Section 11.24.2.7
537 static int get_port_status(struct usb_device
*hdev
, int port1
,
538 struct usb_port_status
*data
)
540 int i
, status
= -ETIMEDOUT
;
542 for (i
= 0; i
< USB_STS_RETRIES
&&
543 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
544 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
545 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
546 data
, sizeof(*data
), USB_STS_TIMEOUT
);
551 static int hub_port_status(struct usb_hub
*hub
, int port1
,
552 u16
*status
, u16
*change
)
556 mutex_lock(&hub
->status_mutex
);
557 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
560 dev_err(hub
->intfdev
,
561 "%s failed (err = %d)\n", __func__
, ret
);
565 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
566 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
570 mutex_unlock(&hub
->status_mutex
);
574 static void kick_hub_wq(struct usb_hub
*hub
)
576 struct usb_interface
*intf
;
578 if (hub
->disconnected
|| work_pending(&hub
->events
))
582 * Suppress autosuspend until the event is proceed.
584 * Be careful and make sure that the symmetric operation is
585 * always called. We are here only when there is no pending
586 * work for this hub. Therefore put the interface either when
587 * the new work is called or when it is canceled.
589 intf
= to_usb_interface(hub
->intfdev
);
590 usb_autopm_get_interface_no_resume(intf
);
591 kref_get(&hub
->kref
);
593 if (queue_work(hub_wq
, &hub
->events
))
596 /* the work has already been scheduled */
597 usb_autopm_put_interface_async(intf
);
598 kref_put(&hub
->kref
, hub_release
);
601 void usb_kick_hub_wq(struct usb_device
*hdev
)
603 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
610 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
611 * Notification, which indicates it had initiated remote wakeup.
613 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
614 * device initiates resume, so the USB core will not receive notice of the
615 * resume through the normal hub interrupt URB.
617 void usb_wakeup_notification(struct usb_device
*hdev
,
618 unsigned int portnum
)
625 hub
= usb_hub_to_struct_hub(hdev
);
627 set_bit(portnum
, hub
->wakeup_bits
);
631 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
633 /* completion function, fires on port status changes and various faults */
634 static void hub_irq(struct urb
*urb
)
636 struct usb_hub
*hub
= urb
->context
;
637 int status
= urb
->status
;
642 case -ENOENT
: /* synchronous unlink */
643 case -ECONNRESET
: /* async unlink */
644 case -ESHUTDOWN
: /* hardware going away */
647 default: /* presumably an error */
648 /* Cause a hub reset after 10 consecutive errors */
649 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
650 if ((++hub
->nerrors
< 10) || hub
->error
)
655 /* let hub_wq handle things */
656 case 0: /* we got data: port status changed */
658 for (i
= 0; i
< urb
->actual_length
; ++i
)
659 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
661 hub
->event_bits
[0] = bits
;
667 /* Something happened, let hub_wq figure it out */
674 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
675 && status
!= -ENODEV
&& status
!= -EPERM
)
676 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
679 /* USB 2.0 spec Section 11.24.2.3 */
681 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
683 /* Need to clear both directions for control ep */
684 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
685 USB_ENDPOINT_XFER_CONTROL
) {
686 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
687 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
688 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
692 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
693 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
698 * enumeration blocks hub_wq for a long time. we use keventd instead, since
699 * long blocking there is the exception, not the rule. accordingly, HCDs
700 * talking to TTs must queue control transfers (not just bulk and iso), so
701 * both can talk to the same hub concurrently.
703 static void hub_tt_work(struct work_struct
*work
)
705 struct usb_hub
*hub
=
706 container_of(work
, struct usb_hub
, tt
.clear_work
);
709 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
710 while (!list_empty(&hub
->tt
.clear_list
)) {
711 struct list_head
*next
;
712 struct usb_tt_clear
*clear
;
713 struct usb_device
*hdev
= hub
->hdev
;
714 const struct hc_driver
*drv
;
717 next
= hub
->tt
.clear_list
.next
;
718 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
719 list_del (&clear
->clear_list
);
721 /* drop lock so HCD can concurrently report other TT errors */
722 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
723 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
724 if (status
&& status
!= -ENODEV
)
726 "clear tt %d (%04x) error %d\n",
727 clear
->tt
, clear
->devinfo
, status
);
729 /* Tell the HCD, even if the operation failed */
730 drv
= clear
->hcd
->driver
;
731 if (drv
->clear_tt_buffer_complete
)
732 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
735 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
737 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
741 * usb_hub_set_port_power - control hub port's power state
742 * @hdev: USB device belonging to the usb hub
745 * @set: expected status
747 * call this function to control port's power via setting or
748 * clearing the port's PORT_POWER feature.
750 * Return: 0 if successful. A negative error code otherwise.
752 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
758 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
760 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
766 set_bit(port1
, hub
->power_bits
);
768 clear_bit(port1
, hub
->power_bits
);
773 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
774 * @urb: an URB associated with the failed or incomplete split transaction
776 * High speed HCDs use this to tell the hub driver that some split control or
777 * bulk transaction failed in a way that requires clearing internal state of
778 * a transaction translator. This is normally detected (and reported) from
781 * It may not be possible for that hub to handle additional full (or low)
782 * speed transactions until that state is fully cleared out.
784 * Return: 0 if successful. A negative error code otherwise.
786 int usb_hub_clear_tt_buffer(struct urb
*urb
)
788 struct usb_device
*udev
= urb
->dev
;
789 int pipe
= urb
->pipe
;
790 struct usb_tt
*tt
= udev
->tt
;
792 struct usb_tt_clear
*clear
;
794 /* we've got to cope with an arbitrary number of pending TT clears,
795 * since each TT has "at least two" buffers that can need it (and
796 * there can be many TTs per hub). even if they're uncommon.
798 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
799 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
800 /* FIXME recover somehow ... RESET_TT? */
804 /* info that CLEAR_TT_BUFFER needs */
805 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
806 clear
->devinfo
= usb_pipeendpoint (pipe
);
807 clear
->devinfo
|= udev
->devnum
<< 4;
808 clear
->devinfo
|= usb_pipecontrol (pipe
)
809 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
810 : (USB_ENDPOINT_XFER_BULK
<< 11);
811 if (usb_pipein (pipe
))
812 clear
->devinfo
|= 1 << 15;
814 /* info for completion callback */
815 clear
->hcd
= bus_to_hcd(udev
->bus
);
818 /* tell keventd to clear state for this TT */
819 spin_lock_irqsave (&tt
->lock
, flags
);
820 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
821 schedule_work(&tt
->clear_work
);
822 spin_unlock_irqrestore (&tt
->lock
, flags
);
825 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
827 static void hub_power_on(struct usb_hub
*hub
, bool do_delay
)
831 /* Enable power on each port. Some hubs have reserved values
832 * of LPSM (> 2) in their descriptors, even though they are
833 * USB 2.0 hubs. Some hubs do not implement port-power switching
834 * but only emulate it. In all cases, the ports won't work
835 * unless we send these messages to the hub.
837 if (hub_is_port_power_switchable(hub
))
838 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
840 dev_dbg(hub
->intfdev
, "trying to enable port power on "
841 "non-switchable hub\n");
842 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; port1
++)
843 if (test_bit(port1
, hub
->power_bits
))
844 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
846 usb_clear_port_feature(hub
->hdev
, port1
,
847 USB_PORT_FEAT_POWER
);
849 msleep(hub_power_on_good_delay(hub
));
852 static int hub_hub_status(struct usb_hub
*hub
,
853 u16
*status
, u16
*change
)
857 mutex_lock(&hub
->status_mutex
);
858 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
861 dev_err(hub
->intfdev
,
862 "%s failed (err = %d)\n", __func__
, ret
);
864 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
865 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
868 mutex_unlock(&hub
->status_mutex
);
872 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
873 unsigned int link_status
)
875 return set_port_feature(hub
->hdev
,
876 port1
| (link_status
<< 3),
877 USB_PORT_FEAT_LINK_STATE
);
881 * If USB 3.0 ports are placed into the Disabled state, they will no longer
882 * detect any device connects or disconnects. This is generally not what the
883 * USB core wants, since it expects a disabled port to produce a port status
884 * change event when a new device connects.
886 * Instead, set the link state to Disabled, wait for the link to settle into
887 * that state, clear any change bits, and then put the port into the RxDetect
890 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
894 u16 portchange
, portstatus
;
896 if (!hub_is_superspeed(hub
->hdev
))
899 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
904 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
905 * Controller [1022:7814] will have spurious result making the following
906 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
907 * as high-speed device if we set the usb 3.0 port link state to
908 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
909 * check the state here to avoid the bug.
911 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
912 USB_SS_PORT_LS_RX_DETECT
) {
913 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
914 "Not disabling port; link state is RxDetect\n");
918 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
922 /* Wait for the link to enter the disabled state. */
923 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
924 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
928 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
929 USB_SS_PORT_LS_SS_DISABLED
)
931 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
933 msleep(HUB_DEBOUNCE_STEP
);
935 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
936 dev_warn(&hub
->ports
[port1
- 1]->dev
,
937 "Could not disable after %d ms\n", total_time
);
939 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
942 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
944 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
945 struct usb_device
*hdev
= hub
->hdev
;
948 if (port_dev
->child
&& set_state
)
949 usb_set_device_state(port_dev
->child
, USB_STATE_NOTATTACHED
);
951 if (hub_is_superspeed(hub
->hdev
))
952 ret
= hub_usb3_port_disable(hub
, port1
);
954 ret
= usb_clear_port_feature(hdev
, port1
,
955 USB_PORT_FEAT_ENABLE
);
957 if (ret
&& ret
!= -ENODEV
)
958 dev_err(&port_dev
->dev
, "cannot disable (err = %d)\n", ret
);
963 * Disable a port and mark a logical connect-change event, so that some
964 * time later hub_wq will disconnect() any existing usb_device on the port
965 * and will re-enumerate if there actually is a device attached.
967 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
969 dev_dbg(&hub
->ports
[port1
- 1]->dev
, "logical disconnect\n");
970 hub_port_disable(hub
, port1
, 1);
972 /* FIXME let caller ask to power down the port:
973 * - some devices won't enumerate without a VBUS power cycle
974 * - SRP saves power that way
975 * - ... new call, TBD ...
976 * That's easy if this hub can switch power per-port, and
977 * hub_wq reactivates the port later (timer, SRP, etc).
978 * Powerdown must be optional, because of reset/DFU.
981 set_bit(port1
, hub
->change_bits
);
986 * usb_remove_device - disable a device's port on its parent hub
987 * @udev: device to be disabled and removed
988 * Context: @udev locked, must be able to sleep.
990 * After @udev's port has been disabled, hub_wq is notified and it will
991 * see that the device has been disconnected. When the device is
992 * physically unplugged and something is plugged in, the events will
993 * be received and processed normally.
995 * Return: 0 if successful. A negative error code otherwise.
997 int usb_remove_device(struct usb_device
*udev
)
1000 struct usb_interface
*intf
;
1002 if (!udev
->parent
) /* Can't remove a root hub */
1004 hub
= usb_hub_to_struct_hub(udev
->parent
);
1005 intf
= to_usb_interface(hub
->intfdev
);
1007 usb_autopm_get_interface(intf
);
1008 set_bit(udev
->portnum
, hub
->removed_bits
);
1009 hub_port_logical_disconnect(hub
, udev
->portnum
);
1010 usb_autopm_put_interface(intf
);
1014 enum hub_activation_type
{
1015 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1016 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1019 static void hub_init_func2(struct work_struct
*ws
);
1020 static void hub_init_func3(struct work_struct
*ws
);
1022 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1024 struct usb_device
*hdev
= hub
->hdev
;
1025 struct usb_hcd
*hcd
;
1029 bool need_debounce_delay
= false;
1032 /* Continue a partial initialization */
1033 if (type
== HUB_INIT2
)
1035 if (type
== HUB_INIT3
)
1038 /* The superspeed hub except for root hub has to use Hub Depth
1039 * value as an offset into the route string to locate the bits
1040 * it uses to determine the downstream port number. So hub driver
1041 * should send a set hub depth request to superspeed hub after
1042 * the superspeed hub is set configuration in initialization or
1045 * After a resume, port power should still be on.
1046 * For any other type of activation, turn it on.
1048 if (type
!= HUB_RESUME
) {
1049 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1050 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1051 HUB_SET_DEPTH
, USB_RT_HUB
,
1052 hdev
->level
- 1, 0, NULL
, 0,
1053 USB_CTRL_SET_TIMEOUT
);
1055 dev_err(hub
->intfdev
,
1056 "set hub depth failed\n");
1059 /* Speed up system boot by using a delayed_work for the
1060 * hub's initial power-up delays. This is pretty awkward
1061 * and the implementation looks like a home-brewed sort of
1062 * setjmp/longjmp, but it saves at least 100 ms for each
1063 * root hub (assuming usbcore is compiled into the kernel
1064 * rather than as a module). It adds up.
1066 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1067 * because for those activation types the ports have to be
1068 * operational when we return. In theory this could be done
1069 * for HUB_POST_RESET, but it's easier not to.
1071 if (type
== HUB_INIT
) {
1072 unsigned delay
= hub_power_on_good_delay(hub
);
1074 hub_power_on(hub
, false);
1075 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1076 queue_delayed_work(system_power_efficient_wq
,
1078 msecs_to_jiffies(delay
));
1080 /* Suppress autosuspend until init is done */
1081 usb_autopm_get_interface_no_resume(
1082 to_usb_interface(hub
->intfdev
));
1083 return; /* Continues at init2: below */
1084 } else if (type
== HUB_RESET_RESUME
) {
1085 /* The internal host controller state for the hub device
1086 * may be gone after a host power loss on system resume.
1087 * Update the device's info so the HW knows it's a hub.
1089 hcd
= bus_to_hcd(hdev
->bus
);
1090 if (hcd
->driver
->update_hub_device
) {
1091 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1092 &hub
->tt
, GFP_NOIO
);
1094 dev_err(hub
->intfdev
, "Host not "
1095 "accepting hub info "
1097 dev_err(hub
->intfdev
, "LS/FS devices "
1098 "and hubs may not work "
1099 "under this hub\n.");
1102 hub_power_on(hub
, true);
1104 hub_power_on(hub
, true);
1110 * Check each port and set hub->change_bits to let hub_wq know
1111 * which ports need attention.
1113 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1114 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1115 struct usb_device
*udev
= port_dev
->child
;
1116 u16 portstatus
, portchange
;
1118 portstatus
= portchange
= 0;
1119 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1120 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1121 dev_dbg(&port_dev
->dev
, "status %04x change %04x\n",
1122 portstatus
, portchange
);
1125 * After anything other than HUB_RESUME (i.e., initialization
1126 * or any sort of reset), every port should be disabled.
1127 * Unconnected ports should likewise be disabled (paranoia),
1128 * and so should ports for which we have no usb_device.
1130 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1131 type
!= HUB_RESUME
||
1132 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1134 udev
->state
== USB_STATE_NOTATTACHED
)) {
1136 * USB3 protocol ports will automatically transition
1137 * to Enabled state when detect an USB3.0 device attach.
1138 * Do not disable USB3 protocol ports, just pretend
1141 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1142 if (!hub_is_superspeed(hdev
))
1143 usb_clear_port_feature(hdev
, port1
,
1144 USB_PORT_FEAT_ENABLE
);
1147 /* Clear status-change flags; we'll debounce later */
1148 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1149 need_debounce_delay
= true;
1150 usb_clear_port_feature(hub
->hdev
, port1
,
1151 USB_PORT_FEAT_C_CONNECTION
);
1153 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1154 need_debounce_delay
= true;
1155 usb_clear_port_feature(hub
->hdev
, port1
,
1156 USB_PORT_FEAT_C_ENABLE
);
1158 if (portchange
& USB_PORT_STAT_C_RESET
) {
1159 need_debounce_delay
= true;
1160 usb_clear_port_feature(hub
->hdev
, port1
,
1161 USB_PORT_FEAT_C_RESET
);
1163 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1164 hub_is_superspeed(hub
->hdev
)) {
1165 need_debounce_delay
= true;
1166 usb_clear_port_feature(hub
->hdev
, port1
,
1167 USB_PORT_FEAT_C_BH_PORT_RESET
);
1169 /* We can forget about a "removed" device when there's a
1170 * physical disconnect or the connect status changes.
1172 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1173 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1174 clear_bit(port1
, hub
->removed_bits
);
1176 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1177 /* Tell hub_wq to disconnect the device or
1178 * check for a new connection
1180 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1181 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1182 set_bit(port1
, hub
->change_bits
);
1184 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1185 bool port_resumed
= (portstatus
&
1186 USB_PORT_STAT_LINK_STATE
) ==
1188 /* The power session apparently survived the resume.
1189 * If there was an overcurrent or suspend change
1190 * (i.e., remote wakeup request), have hub_wq
1191 * take care of it. Look at the port link state
1192 * for USB 3.0 hubs, since they don't have a suspend
1193 * change bit, and they don't set the port link change
1194 * bit on device-initiated resume.
1196 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1198 set_bit(port1
, hub
->change_bits
);
1200 } else if (udev
->persist_enabled
) {
1202 udev
->reset_resume
= 1;
1204 /* Don't set the change_bits when the device
1207 if (test_bit(port1
, hub
->power_bits
))
1208 set_bit(port1
, hub
->change_bits
);
1211 /* The power session is gone; tell hub_wq */
1212 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1213 set_bit(port1
, hub
->change_bits
);
1217 /* If no port-status-change flags were set, we don't need any
1218 * debouncing. If flags were set we can try to debounce the
1219 * ports all at once right now, instead of letting hub_wq do them
1220 * one at a time later on.
1222 * If any port-status changes do occur during this delay, hub_wq
1223 * will see them later and handle them normally.
1225 if (need_debounce_delay
) {
1226 delay
= HUB_DEBOUNCE_STABLE
;
1228 /* Don't do a long sleep inside a workqueue routine */
1229 if (type
== HUB_INIT2
) {
1230 INIT_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1231 queue_delayed_work(system_power_efficient_wq
,
1233 msecs_to_jiffies(delay
));
1234 return; /* Continues at init3: below */
1242 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1244 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1245 if (hub
->has_indicators
&& blinkenlights
)
1246 queue_delayed_work(system_power_efficient_wq
,
1247 &hub
->leds
, LED_CYCLE_PERIOD
);
1249 /* Scan all ports that need attention */
1252 /* Allow autosuspend if it was suppressed */
1253 if (type
<= HUB_INIT3
)
1254 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1257 /* Implement the continuations for the delays above */
1258 static void hub_init_func2(struct work_struct
*ws
)
1260 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1262 hub_activate(hub
, HUB_INIT2
);
1265 static void hub_init_func3(struct work_struct
*ws
)
1267 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1269 hub_activate(hub
, HUB_INIT3
);
1272 enum hub_quiescing_type
{
1273 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1276 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1278 struct usb_device
*hdev
= hub
->hdev
;
1281 cancel_delayed_work_sync(&hub
->init_work
);
1283 /* hub_wq and related activity won't re-trigger */
1286 if (type
!= HUB_SUSPEND
) {
1287 /* Disconnect all the children */
1288 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1289 if (hub
->ports
[i
]->child
)
1290 usb_disconnect(&hub
->ports
[i
]->child
);
1294 /* Stop hub_wq and related activity */
1295 usb_kill_urb(hub
->urb
);
1296 if (hub
->has_indicators
)
1297 cancel_delayed_work_sync(&hub
->leds
);
1299 flush_work(&hub
->tt
.clear_work
);
1302 static void hub_pm_barrier_for_all_ports(struct usb_hub
*hub
)
1306 for (i
= 0; i
< hub
->hdev
->maxchild
; ++i
)
1307 pm_runtime_barrier(&hub
->ports
[i
]->dev
);
1310 /* caller has locked the hub device */
1311 static int hub_pre_reset(struct usb_interface
*intf
)
1313 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1315 hub_quiesce(hub
, HUB_PRE_RESET
);
1317 hub_pm_barrier_for_all_ports(hub
);
1321 /* caller has locked the hub device */
1322 static int hub_post_reset(struct usb_interface
*intf
)
1324 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1327 hub_pm_barrier_for_all_ports(hub
);
1328 hub_activate(hub
, HUB_POST_RESET
);
1332 static int hub_configure(struct usb_hub
*hub
,
1333 struct usb_endpoint_descriptor
*endpoint
)
1335 struct usb_hcd
*hcd
;
1336 struct usb_device
*hdev
= hub
->hdev
;
1337 struct device
*hub_dev
= hub
->intfdev
;
1338 u16 hubstatus
, hubchange
;
1339 u16 wHubCharacteristics
;
1342 char *message
= "out of memory";
1347 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1353 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1358 mutex_init(&hub
->status_mutex
);
1360 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1361 if (!hub
->descriptor
) {
1366 /* Request the entire hub descriptor.
1367 * hub->descriptor can handle USB_MAXCHILDREN ports,
1368 * but the hub can/will return fewer bytes here.
1370 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1372 message
= "can't read hub descriptor";
1374 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1375 message
= "hub has too many ports!";
1378 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1379 message
= "hub doesn't have any ports!";
1384 maxchild
= hub
->descriptor
->bNbrPorts
;
1385 dev_info(hub_dev
, "%d port%s detected\n", maxchild
,
1386 (maxchild
== 1) ? "" : "s");
1388 hub
->ports
= kzalloc(maxchild
* sizeof(struct usb_port
*), GFP_KERNEL
);
1394 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1395 if (hub_is_superspeed(hdev
)) {
1403 /* FIXME for USB 3.0, skip for now */
1404 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1405 !(hub_is_superspeed(hdev
))) {
1407 char portstr
[USB_MAXCHILDREN
+ 1];
1409 for (i
= 0; i
< maxchild
; i
++)
1410 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1411 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1413 portstr
[maxchild
] = 0;
1414 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1416 dev_dbg(hub_dev
, "standalone hub\n");
1418 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1419 case HUB_CHAR_COMMON_LPSM
:
1420 dev_dbg(hub_dev
, "ganged power switching\n");
1422 case HUB_CHAR_INDV_PORT_LPSM
:
1423 dev_dbg(hub_dev
, "individual port power switching\n");
1425 case HUB_CHAR_NO_LPSM
:
1427 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1431 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1432 case HUB_CHAR_COMMON_OCPM
:
1433 dev_dbg(hub_dev
, "global over-current protection\n");
1435 case HUB_CHAR_INDV_PORT_OCPM
:
1436 dev_dbg(hub_dev
, "individual port over-current protection\n");
1438 case HUB_CHAR_NO_OCPM
:
1440 dev_dbg(hub_dev
, "no over-current protection\n");
1444 spin_lock_init (&hub
->tt
.lock
);
1445 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1446 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1447 switch (hdev
->descriptor
.bDeviceProtocol
) {
1450 case USB_HUB_PR_HS_SINGLE_TT
:
1451 dev_dbg(hub_dev
, "Single TT\n");
1454 case USB_HUB_PR_HS_MULTI_TT
:
1455 ret
= usb_set_interface(hdev
, 0, 1);
1457 dev_dbg(hub_dev
, "TT per port\n");
1460 dev_err(hub_dev
, "Using single TT (err %d)\n",
1465 /* USB 3.0 hubs don't have a TT */
1468 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1469 hdev
->descriptor
.bDeviceProtocol
);
1473 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1474 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1475 case HUB_TTTT_8_BITS
:
1476 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1477 hub
->tt
.think_time
= 666;
1478 dev_dbg(hub_dev
, "TT requires at most %d "
1479 "FS bit times (%d ns)\n",
1480 8, hub
->tt
.think_time
);
1483 case HUB_TTTT_16_BITS
:
1484 hub
->tt
.think_time
= 666 * 2;
1485 dev_dbg(hub_dev
, "TT requires at most %d "
1486 "FS bit times (%d ns)\n",
1487 16, hub
->tt
.think_time
);
1489 case HUB_TTTT_24_BITS
:
1490 hub
->tt
.think_time
= 666 * 3;
1491 dev_dbg(hub_dev
, "TT requires at most %d "
1492 "FS bit times (%d ns)\n",
1493 24, hub
->tt
.think_time
);
1495 case HUB_TTTT_32_BITS
:
1496 hub
->tt
.think_time
= 666 * 4;
1497 dev_dbg(hub_dev
, "TT requires at most %d "
1498 "FS bit times (%d ns)\n",
1499 32, hub
->tt
.think_time
);
1503 /* probe() zeroes hub->indicator[] */
1504 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1505 hub
->has_indicators
= 1;
1506 dev_dbg(hub_dev
, "Port indicators are supported\n");
1509 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1510 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1512 /* power budgeting mostly matters with bus-powered hubs,
1513 * and battery-powered root hubs (may provide just 8 mA).
1515 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1517 message
= "can't get hub status";
1520 hcd
= bus_to_hcd(hdev
->bus
);
1521 if (hdev
== hdev
->bus
->root_hub
) {
1522 if (hcd
->power_budget
> 0)
1523 hdev
->bus_mA
= hcd
->power_budget
;
1525 hdev
->bus_mA
= full_load
* maxchild
;
1526 if (hdev
->bus_mA
>= full_load
)
1527 hub
->mA_per_port
= full_load
;
1529 hub
->mA_per_port
= hdev
->bus_mA
;
1530 hub
->limited_power
= 1;
1532 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1533 int remaining
= hdev
->bus_mA
-
1534 hub
->descriptor
->bHubContrCurrent
;
1536 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1537 hub
->descriptor
->bHubContrCurrent
);
1538 hub
->limited_power
= 1;
1540 if (remaining
< maxchild
* unit_load
)
1542 "insufficient power available "
1543 "to use all downstream ports\n");
1544 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1546 } else { /* Self-powered external hub */
1547 /* FIXME: What about battery-powered external hubs that
1548 * provide less current per port? */
1549 hub
->mA_per_port
= full_load
;
1551 if (hub
->mA_per_port
< full_load
)
1552 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1555 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1557 message
= "can't get hub status";
1561 /* local power status reports aren't always correct */
1562 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1563 dev_dbg(hub_dev
, "local power source is %s\n",
1564 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1565 ? "lost (inactive)" : "good");
1567 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1568 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1569 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1571 /* set up the interrupt endpoint
1572 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1573 * bytes as USB2.0[11.12.3] says because some hubs are known
1574 * to send more data (and thus cause overflow). For root hubs,
1575 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1576 * to be big enough for at least USB_MAXCHILDREN ports. */
1577 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1578 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1580 if (maxp
> sizeof(*hub
->buffer
))
1581 maxp
= sizeof(*hub
->buffer
);
1583 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1589 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1590 hub
, endpoint
->bInterval
);
1592 /* maybe cycle the hub leds */
1593 if (hub
->has_indicators
&& blinkenlights
)
1594 hub
->indicator
[0] = INDICATOR_CYCLE
;
1596 mutex_lock(&usb_port_peer_mutex
);
1597 for (i
= 0; i
< maxchild
; i
++) {
1598 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1600 dev_err(hub
->intfdev
,
1601 "couldn't create port%d device.\n", i
+ 1);
1606 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1607 struct usb_port
*port_dev
= hub
->ports
[i
];
1609 pm_runtime_put(&port_dev
->dev
);
1612 mutex_unlock(&usb_port_peer_mutex
);
1616 /* Update the HCD's internal representation of this hub before hub_wq
1617 * starts getting port status changes for devices under the hub.
1619 if (hcd
->driver
->update_hub_device
) {
1620 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1621 &hub
->tt
, GFP_KERNEL
);
1623 message
= "can't update HCD hub info";
1628 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1630 hub_activate(hub
, HUB_INIT
);
1634 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1636 /* hub_disconnect() frees urb and descriptor */
1640 static void hub_release(struct kref
*kref
)
1642 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1644 usb_put_dev(hub
->hdev
);
1645 usb_put_intf(to_usb_interface(hub
->intfdev
));
1649 static unsigned highspeed_hubs
;
1651 static void hub_disconnect(struct usb_interface
*intf
)
1653 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1654 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1658 * Stop adding new hub events. We do not want to block here and thus
1659 * will not try to remove any pending work item.
1661 hub
->disconnected
= 1;
1663 /* Disconnect all children and quiesce the hub */
1665 hub_quiesce(hub
, HUB_DISCONNECT
);
1667 mutex_lock(&usb_port_peer_mutex
);
1669 /* Avoid races with recursively_mark_NOTATTACHED() */
1670 spin_lock_irq(&device_state_lock
);
1671 port1
= hdev
->maxchild
;
1673 usb_set_intfdata(intf
, NULL
);
1674 spin_unlock_irq(&device_state_lock
);
1676 for (; port1
> 0; --port1
)
1677 usb_hub_remove_port_device(hub
, port1
);
1679 mutex_unlock(&usb_port_peer_mutex
);
1681 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1684 usb_free_urb(hub
->urb
);
1686 kfree(hub
->descriptor
);
1690 pm_suspend_ignore_children(&intf
->dev
, false);
1691 kref_put(&hub
->kref
, hub_release
);
1694 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1696 struct usb_host_interface
*desc
;
1697 struct usb_endpoint_descriptor
*endpoint
;
1698 struct usb_device
*hdev
;
1699 struct usb_hub
*hub
;
1701 desc
= intf
->cur_altsetting
;
1702 hdev
= interface_to_usbdev(intf
);
1705 * Set default autosuspend delay as 0 to speedup bus suspend,
1706 * based on the below considerations:
1708 * - Unlike other drivers, the hub driver does not rely on the
1709 * autosuspend delay to provide enough time to handle a wakeup
1710 * event, and the submitted status URB is just to check future
1711 * change on hub downstream ports, so it is safe to do it.
1713 * - The patch might cause one or more auto supend/resume for
1714 * below very rare devices when they are plugged into hub
1717 * devices having trouble initializing, and disconnect
1718 * themselves from the bus and then reconnect a second
1721 * devices just for downloading firmware, and disconnects
1722 * themselves after completing it
1724 * For these quite rare devices, their drivers may change the
1725 * autosuspend delay of their parent hub in the probe() to one
1726 * appropriate value to avoid the subtle problem if someone
1729 * - The patch may cause one or more auto suspend/resume on
1730 * hub during running 'lsusb', but it is probably too
1731 * infrequent to worry about.
1733 * - Change autosuspend delay of hub can avoid unnecessary auto
1734 * suspend timer for hub, also may decrease power consumption
1737 * - If user has indicated to prevent autosuspend by passing
1738 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1741 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1742 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1746 * Hubs have proper suspend/resume support, except for root hubs
1747 * where the controller driver doesn't have bus_suspend and
1748 * bus_resume methods.
1750 if (hdev
->parent
) { /* normal device */
1751 usb_enable_autosuspend(hdev
);
1752 } else { /* root hub */
1753 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1755 if (drv
->bus_suspend
&& drv
->bus_resume
)
1756 usb_enable_autosuspend(hdev
);
1759 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1761 "Unsupported bus topology: hub nested too deep\n");
1765 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1767 dev_warn(&intf
->dev
, "ignoring external hub\n");
1772 /* Some hubs have a subclass of 1, which AFAICT according to the */
1773 /* specs is not defined, but it works */
1774 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1775 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1777 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1781 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1782 if (desc
->desc
.bNumEndpoints
!= 1)
1783 goto descriptor_error
;
1785 endpoint
= &desc
->endpoint
[0].desc
;
1787 /* If it's not an interrupt in endpoint, we'd better punt! */
1788 if (!usb_endpoint_is_int_in(endpoint
))
1789 goto descriptor_error
;
1791 /* We found a hub */
1792 dev_info (&intf
->dev
, "USB hub found\n");
1794 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1796 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1800 kref_init(&hub
->kref
);
1801 hub
->intfdev
= &intf
->dev
;
1803 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1804 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1805 INIT_WORK(&hub
->events
, hub_event
);
1809 usb_set_intfdata (intf
, hub
);
1810 intf
->needs_remote_wakeup
= 1;
1811 pm_suspend_ignore_children(&intf
->dev
, true);
1813 if (hdev
->speed
== USB_SPEED_HIGH
)
1816 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1817 hub
->quirk_check_port_auto_suspend
= 1;
1819 if (hub_configure(hub
, endpoint
) >= 0)
1822 hub_disconnect (intf
);
1827 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1829 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1830 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1832 /* assert ifno == 0 (part of hub spec) */
1834 case USBDEVFS_HUB_PORTINFO
: {
1835 struct usbdevfs_hub_portinfo
*info
= user_data
;
1838 spin_lock_irq(&device_state_lock
);
1839 if (hdev
->devnum
<= 0)
1842 info
->nports
= hdev
->maxchild
;
1843 for (i
= 0; i
< info
->nports
; i
++) {
1844 if (hub
->ports
[i
]->child
== NULL
)
1848 hub
->ports
[i
]->child
->devnum
;
1851 spin_unlock_irq(&device_state_lock
);
1853 return info
->nports
+ 1;
1862 * Allow user programs to claim ports on a hub. When a device is attached
1863 * to one of these "claimed" ports, the program will "own" the device.
1865 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1866 struct usb_dev_state
***ppowner
)
1868 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1870 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1872 if (port1
== 0 || port1
> hdev
->maxchild
)
1875 /* Devices not managed by the hub driver
1876 * will always have maxchild equal to 0.
1878 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1882 /* In the following three functions, the caller must hold hdev's lock */
1883 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1884 struct usb_dev_state
*owner
)
1887 struct usb_dev_state
**powner
;
1889 rc
= find_port_owner(hdev
, port1
, &powner
);
1897 EXPORT_SYMBOL_GPL(usb_hub_claim_port
);
1899 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1900 struct usb_dev_state
*owner
)
1903 struct usb_dev_state
**powner
;
1905 rc
= find_port_owner(hdev
, port1
, &powner
);
1908 if (*powner
!= owner
)
1913 EXPORT_SYMBOL_GPL(usb_hub_release_port
);
1915 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct usb_dev_state
*owner
)
1917 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1920 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1921 if (hub
->ports
[n
]->port_owner
== owner
)
1922 hub
->ports
[n
]->port_owner
= NULL
;
1927 /* The caller must hold udev's lock */
1928 bool usb_device_is_owned(struct usb_device
*udev
)
1930 struct usb_hub
*hub
;
1932 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1934 hub
= usb_hub_to_struct_hub(udev
->parent
);
1935 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1938 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1940 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1943 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1944 if (hub
->ports
[i
]->child
)
1945 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1947 if (udev
->state
== USB_STATE_SUSPENDED
)
1948 udev
->active_duration
-= jiffies
;
1949 udev
->state
= USB_STATE_NOTATTACHED
;
1953 * usb_set_device_state - change a device's current state (usbcore, hcds)
1954 * @udev: pointer to device whose state should be changed
1955 * @new_state: new state value to be stored
1957 * udev->state is _not_ fully protected by the device lock. Although
1958 * most transitions are made only while holding the lock, the state can
1959 * can change to USB_STATE_NOTATTACHED at almost any time. This
1960 * is so that devices can be marked as disconnected as soon as possible,
1961 * without having to wait for any semaphores to be released. As a result,
1962 * all changes to any device's state must be protected by the
1963 * device_state_lock spinlock.
1965 * Once a device has been added to the device tree, all changes to its state
1966 * should be made using this routine. The state should _not_ be set directly.
1968 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1969 * Otherwise udev->state is set to new_state, and if new_state is
1970 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1971 * to USB_STATE_NOTATTACHED.
1973 void usb_set_device_state(struct usb_device
*udev
,
1974 enum usb_device_state new_state
)
1976 unsigned long flags
;
1979 spin_lock_irqsave(&device_state_lock
, flags
);
1980 if (udev
->state
== USB_STATE_NOTATTACHED
)
1982 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1984 /* root hub wakeup capabilities are managed out-of-band
1985 * and may involve silicon errata ... ignore them here.
1988 if (udev
->state
== USB_STATE_SUSPENDED
1989 || new_state
== USB_STATE_SUSPENDED
)
1990 ; /* No change to wakeup settings */
1991 else if (new_state
== USB_STATE_CONFIGURED
)
1992 wakeup
= (udev
->quirks
&
1993 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1994 udev
->actconfig
->desc
.bmAttributes
&
1995 USB_CONFIG_ATT_WAKEUP
;
1999 if (udev
->state
== USB_STATE_SUSPENDED
&&
2000 new_state
!= USB_STATE_SUSPENDED
)
2001 udev
->active_duration
-= jiffies
;
2002 else if (new_state
== USB_STATE_SUSPENDED
&&
2003 udev
->state
!= USB_STATE_SUSPENDED
)
2004 udev
->active_duration
+= jiffies
;
2005 udev
->state
= new_state
;
2007 recursively_mark_NOTATTACHED(udev
);
2008 spin_unlock_irqrestore(&device_state_lock
, flags
);
2010 device_set_wakeup_capable(&udev
->dev
, wakeup
);
2012 EXPORT_SYMBOL_GPL(usb_set_device_state
);
2015 * Choose a device number.
2017 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2018 * USB-2.0 buses they are also used as device addresses, however on
2019 * USB-3.0 buses the address is assigned by the controller hardware
2020 * and it usually is not the same as the device number.
2022 * WUSB devices are simple: they have no hubs behind, so the mapping
2023 * device <-> virtual port number becomes 1:1. Why? to simplify the
2024 * life of the device connection logic in
2025 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2026 * handshake we need to assign a temporary address in the unauthorized
2027 * space. For simplicity we use the first virtual port number found to
2028 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2029 * and that becomes it's address [X < 128] or its unauthorized address
2032 * We add 1 as an offset to the one-based USB-stack port number
2033 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2034 * 0 is reserved by USB for default address; (b) Linux's USB stack
2035 * uses always #1 for the root hub of the controller. So USB stack's
2036 * port #1, which is wusb virtual-port #0 has address #2.
2038 * Devices connected under xHCI are not as simple. The host controller
2039 * supports virtualization, so the hardware assigns device addresses and
2040 * the HCD must setup data structures before issuing a set address
2041 * command to the hardware.
2043 static void choose_devnum(struct usb_device
*udev
)
2046 struct usb_bus
*bus
= udev
->bus
;
2048 /* be safe when more hub events are proceed in parallel */
2049 mutex_lock(&bus
->usb_address0_mutex
);
2051 devnum
= udev
->portnum
+ 1;
2052 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2054 /* Try to allocate the next devnum beginning at
2055 * bus->devnum_next. */
2056 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2059 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2061 bus
->devnum_next
= (devnum
>= 127 ? 1 : devnum
+ 1);
2064 set_bit(devnum
, bus
->devmap
.devicemap
);
2065 udev
->devnum
= devnum
;
2067 mutex_unlock(&bus
->usb_address0_mutex
);
2070 static void release_devnum(struct usb_device
*udev
)
2072 if (udev
->devnum
> 0) {
2073 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2078 static void update_devnum(struct usb_device
*udev
, int devnum
)
2080 /* The address for a WUSB device is managed by wusbcore. */
2082 udev
->devnum
= devnum
;
2085 static void hub_free_dev(struct usb_device
*udev
)
2087 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2089 /* Root hubs aren't real devices, so don't free HCD resources */
2090 if (hcd
->driver
->free_dev
&& udev
->parent
)
2091 hcd
->driver
->free_dev(hcd
, udev
);
2094 static void hub_disconnect_children(struct usb_device
*udev
)
2096 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2099 /* Free up all the children before we remove this device */
2100 for (i
= 0; i
< udev
->maxchild
; i
++) {
2101 if (hub
->ports
[i
]->child
)
2102 usb_disconnect(&hub
->ports
[i
]->child
);
2107 * usb_disconnect - disconnect a device (usbcore-internal)
2108 * @pdev: pointer to device being disconnected
2109 * Context: !in_interrupt ()
2111 * Something got disconnected. Get rid of it and all of its children.
2113 * If *pdev is a normal device then the parent hub must already be locked.
2114 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2115 * which protects the set of root hubs as well as the list of buses.
2117 * Only hub drivers (including virtual root hub drivers for host
2118 * controllers) should ever call this.
2120 * This call is synchronous, and may not be used in an interrupt context.
2122 void usb_disconnect(struct usb_device
**pdev
)
2124 struct usb_port
*port_dev
= NULL
;
2125 struct usb_device
*udev
= *pdev
;
2126 struct usb_hub
*hub
= NULL
;
2129 /* mark the device as inactive, so any further urb submissions for
2130 * this device (and any of its children) will fail immediately.
2131 * this quiesces everything except pending urbs.
2133 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2134 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2137 usb_lock_device(udev
);
2139 hub_disconnect_children(udev
);
2141 /* deallocate hcd/hardware state ... nuking all pending urbs and
2142 * cleaning up all state associated with the current configuration
2143 * so that the hardware is now fully quiesced.
2145 dev_dbg (&udev
->dev
, "unregistering device\n");
2146 usb_disable_device(udev
, 0);
2147 usb_hcd_synchronize_unlinks(udev
);
2150 port1
= udev
->portnum
;
2151 hub
= usb_hub_to_struct_hub(udev
->parent
);
2152 port_dev
= hub
->ports
[port1
- 1];
2154 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2155 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2158 * As usb_port_runtime_resume() de-references udev, make
2159 * sure no resumes occur during removal
2161 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2162 pm_runtime_get_sync(&port_dev
->dev
);
2165 usb_remove_ep_devs(&udev
->ep0
);
2166 usb_unlock_device(udev
);
2168 /* Unregister the device. The device driver is responsible
2169 * for de-configuring the device and invoking the remove-device
2170 * notifier chain (used by usbfs and possibly others).
2172 device_del(&udev
->dev
);
2174 /* Free the device number and delete the parent's children[]
2175 * (or root_hub) pointer.
2177 release_devnum(udev
);
2179 /* Avoid races with recursively_mark_NOTATTACHED() */
2180 spin_lock_irq(&device_state_lock
);
2182 spin_unlock_irq(&device_state_lock
);
2184 if (port_dev
&& test_and_clear_bit(port1
, hub
->child_usage_bits
))
2185 pm_runtime_put(&port_dev
->dev
);
2189 put_device(&udev
->dev
);
2192 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2193 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2197 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2200 static void announce_device(struct usb_device
*udev
)
2202 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2203 le16_to_cpu(udev
->descriptor
.idVendor
),
2204 le16_to_cpu(udev
->descriptor
.idProduct
));
2205 dev_info(&udev
->dev
,
2206 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2207 udev
->descriptor
.iManufacturer
,
2208 udev
->descriptor
.iProduct
,
2209 udev
->descriptor
.iSerialNumber
);
2210 show_string(udev
, "Product", udev
->product
);
2211 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2212 show_string(udev
, "SerialNumber", udev
->serial
);
2215 static inline void announce_device(struct usb_device
*udev
) { }
2220 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2221 * @udev: newly addressed device (in ADDRESS state)
2223 * Finish enumeration for On-The-Go devices
2225 * Return: 0 if successful. A negative error code otherwise.
2227 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2231 #ifdef CONFIG_USB_OTG
2233 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2234 * to wake us after we've powered off VBUS; and HNP, switching roles
2235 * "host" to "peripheral". The OTG descriptor helps figure this out.
2237 if (!udev
->bus
->is_b_host
2239 && udev
->parent
== udev
->bus
->root_hub
) {
2240 struct usb_otg_descriptor
*desc
= NULL
;
2241 struct usb_bus
*bus
= udev
->bus
;
2243 /* descriptor may appear anywhere in config */
2244 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2245 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2246 USB_DT_OTG
, (void **) &desc
) == 0) {
2247 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2248 unsigned port1
= udev
->portnum
;
2250 dev_info(&udev
->dev
,
2251 "Dual-Role OTG device on %sHNP port\n",
2252 (port1
== bus
->otg_port
)
2255 /* enable HNP before suspend, it's simpler */
2256 if (port1
== bus
->otg_port
)
2257 bus
->b_hnp_enable
= 1;
2258 err
= usb_control_msg(udev
,
2259 usb_sndctrlpipe(udev
, 0),
2260 USB_REQ_SET_FEATURE
, 0,
2262 ? USB_DEVICE_B_HNP_ENABLE
2263 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2264 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2266 /* OTG MESSAGE: report errors here,
2267 * customize to match your product.
2269 dev_info(&udev
->dev
,
2270 "can't set HNP mode: %d\n",
2272 bus
->b_hnp_enable
= 0;
2283 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2284 * @udev: newly addressed device (in ADDRESS state)
2286 * This is only called by usb_new_device() and usb_authorize_device()
2287 * and FIXME -- all comments that apply to them apply here wrt to
2290 * If the device is WUSB and not authorized, we don't attempt to read
2291 * the string descriptors, as they will be errored out by the device
2292 * until it has been authorized.
2294 * Return: 0 if successful. A negative error code otherwise.
2296 static int usb_enumerate_device(struct usb_device
*udev
)
2299 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2301 if (udev
->config
== NULL
) {
2302 err
= usb_get_configuration(udev
);
2305 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2311 /* read the standard strings and cache them if present */
2312 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2313 udev
->manufacturer
= usb_cache_string(udev
,
2314 udev
->descriptor
.iManufacturer
);
2315 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2317 err
= usb_enumerate_device_otg(udev
);
2321 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST
) && hcd
->tpl_support
&&
2322 !is_targeted(udev
)) {
2323 /* Maybe it can talk to us, though we can't talk to it.
2324 * (Includes HNP test device.)
2326 if (IS_ENABLED(CONFIG_USB_OTG
) && (udev
->bus
->b_hnp_enable
2327 || udev
->bus
->is_b_host
)) {
2328 err
= usb_port_suspend(udev
, PMSG_AUTO_SUSPEND
);
2330 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2335 usb_detect_interface_quirks(udev
);
2340 static void set_usb_port_removable(struct usb_device
*udev
)
2342 struct usb_device
*hdev
= udev
->parent
;
2343 struct usb_hub
*hub
;
2344 u8 port
= udev
->portnum
;
2345 u16 wHubCharacteristics
;
2346 bool removable
= true;
2351 hub
= usb_hub_to_struct_hub(udev
->parent
);
2354 * If the platform firmware has provided information about a port,
2355 * use that to determine whether it's removable.
2357 switch (hub
->ports
[udev
->portnum
- 1]->connect_type
) {
2358 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
2359 udev
->removable
= USB_DEVICE_REMOVABLE
;
2361 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
2362 case USB_PORT_NOT_USED
:
2363 udev
->removable
= USB_DEVICE_FIXED
;
2370 * Otherwise, check whether the hub knows whether a port is removable
2373 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2375 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2378 if (hub_is_superspeed(hdev
)) {
2379 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2383 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2388 udev
->removable
= USB_DEVICE_REMOVABLE
;
2390 udev
->removable
= USB_DEVICE_FIXED
;
2395 * usb_new_device - perform initial device setup (usbcore-internal)
2396 * @udev: newly addressed device (in ADDRESS state)
2398 * This is called with devices which have been detected but not fully
2399 * enumerated. The device descriptor is available, but not descriptors
2400 * for any device configuration. The caller must have locked either
2401 * the parent hub (if udev is a normal device) or else the
2402 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2403 * udev has already been installed, but udev is not yet visible through
2404 * sysfs or other filesystem code.
2406 * This call is synchronous, and may not be used in an interrupt context.
2408 * Only the hub driver or root-hub registrar should ever call this.
2410 * Return: Whether the device is configured properly or not. Zero if the
2411 * interface was registered with the driver core; else a negative errno
2415 int usb_new_device(struct usb_device
*udev
)
2420 /* Initialize non-root-hub device wakeup to disabled;
2421 * device (un)configuration controls wakeup capable
2422 * sysfs power/wakeup controls wakeup enabled/disabled
2424 device_init_wakeup(&udev
->dev
, 0);
2427 /* Tell the runtime-PM framework the device is active */
2428 pm_runtime_set_active(&udev
->dev
);
2429 pm_runtime_get_noresume(&udev
->dev
);
2430 pm_runtime_use_autosuspend(&udev
->dev
);
2431 pm_runtime_enable(&udev
->dev
);
2433 /* By default, forbid autosuspend for all devices. It will be
2434 * allowed for hubs during binding.
2436 usb_disable_autosuspend(udev
);
2438 err
= usb_enumerate_device(udev
); /* Read descriptors */
2441 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2442 udev
->devnum
, udev
->bus
->busnum
,
2443 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2444 /* export the usbdev device-node for libusb */
2445 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2446 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2448 /* Tell the world! */
2449 announce_device(udev
);
2452 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2454 add_device_randomness(udev
->product
, strlen(udev
->product
));
2455 if (udev
->manufacturer
)
2456 add_device_randomness(udev
->manufacturer
,
2457 strlen(udev
->manufacturer
));
2459 device_enable_async_suspend(&udev
->dev
);
2461 /* check whether the hub or firmware marks this port as non-removable */
2463 set_usb_port_removable(udev
);
2465 /* Register the device. The device driver is responsible
2466 * for configuring the device and invoking the add-device
2467 * notifier chain (used by usbfs and possibly others).
2469 err
= device_add(&udev
->dev
);
2471 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2475 /* Create link files between child device and usb port device. */
2477 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2478 int port1
= udev
->portnum
;
2479 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2481 err
= sysfs_create_link(&udev
->dev
.kobj
,
2482 &port_dev
->dev
.kobj
, "port");
2486 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2487 &udev
->dev
.kobj
, "device");
2489 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2493 if (!test_and_set_bit(port1
, hub
->child_usage_bits
))
2494 pm_runtime_get_sync(&port_dev
->dev
);
2497 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2498 usb_mark_last_busy(udev
);
2499 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2503 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2504 pm_runtime_disable(&udev
->dev
);
2505 pm_runtime_set_suspended(&udev
->dev
);
2511 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2512 * @usb_dev: USB device
2514 * Move the USB device to a very basic state where interfaces are disabled
2515 * and the device is in fact unconfigured and unusable.
2517 * We share a lock (that we have) with device_del(), so we need to
2522 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2524 usb_lock_device(usb_dev
);
2525 if (usb_dev
->authorized
== 0)
2526 goto out_unauthorized
;
2528 usb_dev
->authorized
= 0;
2529 usb_set_configuration(usb_dev
, -1);
2532 usb_unlock_device(usb_dev
);
2537 int usb_authorize_device(struct usb_device
*usb_dev
)
2541 usb_lock_device(usb_dev
);
2542 if (usb_dev
->authorized
== 1)
2543 goto out_authorized
;
2545 result
= usb_autoresume_device(usb_dev
);
2547 dev_err(&usb_dev
->dev
,
2548 "can't autoresume for authorization: %d\n", result
);
2549 goto error_autoresume
;
2552 if (usb_dev
->wusb
) {
2553 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2555 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2556 "authorization: %d\n", result
);
2557 goto error_device_descriptor
;
2561 usb_dev
->authorized
= 1;
2562 /* Choose and set the configuration. This registers the interfaces
2563 * with the driver core and lets interface drivers bind to them.
2565 c
= usb_choose_configuration(usb_dev
);
2567 result
= usb_set_configuration(usb_dev
, c
);
2569 dev_err(&usb_dev
->dev
,
2570 "can't set config #%d, error %d\n", c
, result
);
2571 /* This need not be fatal. The user can try to
2572 * set other configurations. */
2575 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2577 error_device_descriptor
:
2578 usb_autosuspend_device(usb_dev
);
2581 usb_unlock_device(usb_dev
); /* complements locktree */
2586 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2587 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2589 struct usb_hcd
*hcd
;
2590 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2592 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2593 return hcd
->wireless
;
2597 #define PORT_RESET_TRIES 5
2598 #define SET_ADDRESS_TRIES 2
2599 #define GET_DESCRIPTOR_TRIES 2
2600 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2601 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2603 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2604 #define HUB_SHORT_RESET_TIME 10
2605 #define HUB_BH_RESET_TIME 50
2606 #define HUB_LONG_RESET_TIME 200
2607 #define HUB_RESET_TIMEOUT 800
2610 * "New scheme" enumeration causes an extra state transition to be
2611 * exposed to an xhci host and causes USB3 devices to receive control
2612 * commands in the default state. This has been seen to cause
2613 * enumeration failures, so disable this enumeration scheme for USB3
2616 static bool use_new_scheme(struct usb_device
*udev
, int retry
)
2618 if (udev
->speed
== USB_SPEED_SUPER
)
2621 return USE_NEW_SCHEME(retry
);
2624 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2625 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2627 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2628 * Port worm reset is required to recover
2630 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, int port1
,
2635 if (!hub_is_superspeed(hub
->hdev
))
2638 if (test_bit(port1
, hub
->warm_reset_bits
))
2641 link_state
= portstatus
& USB_PORT_STAT_LINK_STATE
;
2642 return link_state
== USB_SS_PORT_LS_SS_INACTIVE
2643 || link_state
== USB_SS_PORT_LS_COMP_MOD
;
2646 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2647 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2649 int delay_time
, ret
;
2653 for (delay_time
= 0;
2654 delay_time
< HUB_RESET_TIMEOUT
;
2655 delay_time
+= delay
) {
2656 /* wait to give the device a chance to reset */
2659 /* read and decode port status */
2660 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2664 /* The port state is unknown until the reset completes. */
2665 if (!(portstatus
& USB_PORT_STAT_RESET
))
2668 /* switch to the long delay after two short delay failures */
2669 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2670 delay
= HUB_LONG_RESET_TIME
;
2672 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
2673 "not %sreset yet, waiting %dms\n",
2674 warm
? "warm " : "", delay
);
2677 if ((portstatus
& USB_PORT_STAT_RESET
))
2680 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2683 /* Device went away? */
2684 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2687 /* bomb out completely if the connection bounced. A USB 3.0
2688 * connection may bounce if multiple warm resets were issued,
2689 * but the device may have successfully re-connected. Ignore it.
2691 if (!hub_is_superspeed(hub
->hdev
) &&
2692 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2695 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2701 if (hub_is_wusb(hub
))
2702 udev
->speed
= USB_SPEED_WIRELESS
;
2703 else if (hub_is_superspeed(hub
->hdev
))
2704 udev
->speed
= USB_SPEED_SUPER
;
2705 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2706 udev
->speed
= USB_SPEED_HIGH
;
2707 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2708 udev
->speed
= USB_SPEED_LOW
;
2710 udev
->speed
= USB_SPEED_FULL
;
2714 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2715 struct usb_device
*udev
, int *status
)
2719 /* TRSTRCY = 10 ms; plus some extra */
2722 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2724 update_devnum(udev
, 0);
2725 /* The xHC may think the device is already reset,
2726 * so ignore the status.
2728 if (hcd
->driver
->reset_device
)
2729 hcd
->driver
->reset_device(hcd
, udev
);
2734 usb_clear_port_feature(hub
->hdev
,
2735 port1
, USB_PORT_FEAT_C_RESET
);
2736 if (hub_is_superspeed(hub
->hdev
)) {
2737 usb_clear_port_feature(hub
->hdev
, port1
,
2738 USB_PORT_FEAT_C_BH_PORT_RESET
);
2739 usb_clear_port_feature(hub
->hdev
, port1
,
2740 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2741 usb_clear_port_feature(hub
->hdev
, port1
,
2742 USB_PORT_FEAT_C_CONNECTION
);
2745 usb_set_device_state(udev
, *status
2746 ? USB_STATE_NOTATTACHED
2747 : USB_STATE_DEFAULT
);
2752 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2753 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2754 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2757 u16 portchange
, portstatus
;
2758 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2760 if (!hub_is_superspeed(hub
->hdev
)) {
2762 dev_err(hub
->intfdev
, "only USB3 hub support "
2766 /* Block EHCI CF initialization during the port reset.
2767 * Some companion controllers don't like it when they mix.
2769 down_read(&ehci_cf_port_reset_rwsem
);
2772 * If the caller hasn't explicitly requested a warm reset,
2773 * double check and see if one is needed.
2775 status
= hub_port_status(hub
, port1
,
2776 &portstatus
, &portchange
);
2780 if (hub_port_warm_reset_required(hub
, port1
, portstatus
))
2783 clear_bit(port1
, hub
->warm_reset_bits
);
2785 /* Reset the port */
2786 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2787 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2788 USB_PORT_FEAT_BH_PORT_RESET
:
2789 USB_PORT_FEAT_RESET
));
2790 if (status
== -ENODEV
) {
2791 ; /* The hub is gone */
2792 } else if (status
) {
2793 dev_err(&port_dev
->dev
,
2794 "cannot %sreset (err = %d)\n",
2795 warm
? "warm " : "", status
);
2797 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2799 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2800 dev_dbg(hub
->intfdev
,
2801 "port_wait_reset: err = %d\n",
2805 /* Check for disconnect or reset */
2806 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2807 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2809 if (!hub_is_superspeed(hub
->hdev
))
2813 * If a USB 3.0 device migrates from reset to an error
2814 * state, re-issue the warm reset.
2816 if (hub_port_status(hub
, port1
,
2817 &portstatus
, &portchange
) < 0)
2820 if (!hub_port_warm_reset_required(hub
, port1
,
2825 * If the port is in SS.Inactive or Compliance Mode, the
2826 * hot or warm reset failed. Try another warm reset.
2829 dev_dbg(&port_dev
->dev
,
2830 "hot reset failed, warm reset\n");
2835 dev_dbg(&port_dev
->dev
,
2836 "not enabled, trying %sreset again...\n",
2837 warm
? "warm " : "");
2838 delay
= HUB_LONG_RESET_TIME
;
2841 dev_err(&port_dev
->dev
, "Cannot enable. Maybe the USB cable is bad?\n");
2844 if (!hub_is_superspeed(hub
->hdev
))
2845 up_read(&ehci_cf_port_reset_rwsem
);
2850 /* Check if a port is power on */
2851 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2855 if (hub_is_superspeed(hub
->hdev
)) {
2856 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2859 if (portstatus
& USB_PORT_STAT_POWER
)
2866 static void usb_lock_port(struct usb_port
*port_dev
)
2867 __acquires(&port_dev
->status_lock
)
2869 mutex_lock(&port_dev
->status_lock
);
2870 __acquire(&port_dev
->status_lock
);
2873 static void usb_unlock_port(struct usb_port
*port_dev
)
2874 __releases(&port_dev
->status_lock
)
2876 mutex_unlock(&port_dev
->status_lock
);
2877 __release(&port_dev
->status_lock
);
2882 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2883 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2887 if (hub_is_superspeed(hub
->hdev
)) {
2888 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2889 == USB_SS_PORT_LS_U3
)
2892 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2899 /* Determine whether the device on a port is ready for a normal resume,
2900 * is ready for a reset-resume, or should be disconnected.
2902 static int check_port_resume_type(struct usb_device
*udev
,
2903 struct usb_hub
*hub
, int port1
,
2904 int status
, u16 portchange
, u16 portstatus
)
2906 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
2910 /* Is a warm reset needed to recover the connection? */
2911 if (status
== 0 && udev
->reset_resume
2912 && hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
2915 /* Is the device still present? */
2916 else if (status
|| port_is_suspended(hub
, portstatus
) ||
2917 !port_is_power_on(hub
, portstatus
)) {
2920 } else if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2922 usleep_range(200, 300);
2923 status
= hub_port_status(hub
, port1
, &portstatus
,
2930 /* Can't do a normal resume if the port isn't enabled,
2931 * so try a reset-resume instead.
2933 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2934 if (udev
->persist_enabled
)
2935 udev
->reset_resume
= 1;
2941 dev_dbg(&port_dev
->dev
, "status %04x.%04x after resume, %d\n",
2942 portchange
, portstatus
, status
);
2943 } else if (udev
->reset_resume
) {
2945 /* Late port handoff can set status-change bits */
2946 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2947 usb_clear_port_feature(hub
->hdev
, port1
,
2948 USB_PORT_FEAT_C_CONNECTION
);
2949 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2950 usb_clear_port_feature(hub
->hdev
, port1
,
2951 USB_PORT_FEAT_C_ENABLE
);
2957 int usb_disable_ltm(struct usb_device
*udev
)
2959 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2961 /* Check if the roothub and device supports LTM. */
2962 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2963 !usb_device_supports_ltm(udev
))
2966 /* Clear Feature LTM Enable can only be sent if the device is
2969 if (!udev
->actconfig
)
2972 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2973 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2974 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2975 USB_CTRL_SET_TIMEOUT
);
2977 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2979 void usb_enable_ltm(struct usb_device
*udev
)
2981 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2983 /* Check if the roothub and device supports LTM. */
2984 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2985 !usb_device_supports_ltm(udev
))
2988 /* Set Feature LTM Enable can only be sent if the device is
2991 if (!udev
->actconfig
)
2994 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2995 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2996 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2997 USB_CTRL_SET_TIMEOUT
);
2999 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3002 * usb_enable_remote_wakeup - enable remote wakeup for a device
3003 * @udev: target device
3005 * For USB-2 devices: Set the device's remote wakeup feature.
3007 * For USB-3 devices: Assume there's only one function on the device and
3008 * enable remote wake for the first interface. FIXME if the interface
3009 * association descriptor shows there's more than one function.
3011 static int usb_enable_remote_wakeup(struct usb_device
*udev
)
3013 if (udev
->speed
< USB_SPEED_SUPER
)
3014 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3015 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
3016 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3017 USB_CTRL_SET_TIMEOUT
);
3019 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3020 USB_REQ_SET_FEATURE
, USB_RECIP_INTERFACE
,
3021 USB_INTRF_FUNC_SUSPEND
,
3022 USB_INTRF_FUNC_SUSPEND_RW
|
3023 USB_INTRF_FUNC_SUSPEND_LP
,
3024 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3028 * usb_disable_remote_wakeup - disable remote wakeup for a device
3029 * @udev: target device
3031 * For USB-2 devices: Clear the device's remote wakeup feature.
3033 * For USB-3 devices: Assume there's only one function on the device and
3034 * disable remote wake for the first interface. FIXME if the interface
3035 * association descriptor shows there's more than one function.
3037 static int usb_disable_remote_wakeup(struct usb_device
*udev
)
3039 if (udev
->speed
< USB_SPEED_SUPER
)
3040 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3041 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
3042 USB_DEVICE_REMOTE_WAKEUP
, 0, NULL
, 0,
3043 USB_CTRL_SET_TIMEOUT
);
3045 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3046 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
3047 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
3048 USB_CTRL_SET_TIMEOUT
);
3051 /* Count of wakeup-enabled devices at or below udev */
3052 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
3054 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
3056 return udev
->do_remote_wakeup
+
3057 (hub
? hub
->wakeup_enabled_descendants
: 0);
3061 * usb_port_suspend - suspend a usb device's upstream port
3062 * @udev: device that's no longer in active use, not a root hub
3063 * Context: must be able to sleep; device not locked; pm locks held
3065 * Suspends a USB device that isn't in active use, conserving power.
3066 * Devices may wake out of a suspend, if anything important happens,
3067 * using the remote wakeup mechanism. They may also be taken out of
3068 * suspend by the host, using usb_port_resume(). It's also routine
3069 * to disconnect devices while they are suspended.
3071 * This only affects the USB hardware for a device; its interfaces
3072 * (and, for hubs, child devices) must already have been suspended.
3074 * Selective port suspend reduces power; most suspended devices draw
3075 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3076 * All devices below the suspended port are also suspended.
3078 * Devices leave suspend state when the host wakes them up. Some devices
3079 * also support "remote wakeup", where the device can activate the USB
3080 * tree above them to deliver data, such as a keypress or packet. In
3081 * some cases, this wakes the USB host.
3083 * Suspending OTG devices may trigger HNP, if that's been enabled
3084 * between a pair of dual-role devices. That will change roles, such
3085 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3087 * Devices on USB hub ports have only one "suspend" state, corresponding
3088 * to ACPI D2, "may cause the device to lose some context".
3089 * State transitions include:
3091 * - suspend, resume ... when the VBUS power link stays live
3092 * - suspend, disconnect ... VBUS lost
3094 * Once VBUS drop breaks the circuit, the port it's using has to go through
3095 * normal re-enumeration procedures, starting with enabling VBUS power.
3096 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3097 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3098 * timer, no SRP, no requests through sysfs.
3100 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3101 * suspended until their bus goes into global suspend (i.e., the root
3102 * hub is suspended). Nevertheless, we change @udev->state to
3103 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3104 * upstream port setting is stored in @udev->port_is_suspended.
3106 * Returns 0 on success, else negative errno.
3108 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3110 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3111 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3112 int port1
= udev
->portnum
;
3114 bool really_suspend
= true;
3116 usb_lock_port(port_dev
);
3118 /* enable remote wakeup when appropriate; this lets the device
3119 * wake up the upstream hub (including maybe the root hub).
3121 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3122 * we don't explicitly enable it here.
3124 if (udev
->do_remote_wakeup
) {
3125 status
= usb_enable_remote_wakeup(udev
);
3127 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
3129 /* bail if autosuspend is requested */
3130 if (PMSG_IS_AUTO(msg
))
3135 /* disable USB2 hardware LPM */
3136 if (udev
->usb2_hw_lpm_enabled
== 1)
3137 usb_set_usb2_hardware_lpm(udev
, 0);
3139 if (usb_disable_ltm(udev
)) {
3140 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3142 if (PMSG_IS_AUTO(msg
))
3145 if (usb_unlocked_disable_lpm(udev
)) {
3146 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3148 if (PMSG_IS_AUTO(msg
))
3153 if (hub_is_superspeed(hub
->hdev
))
3154 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3157 * For system suspend, we do not need to enable the suspend feature
3158 * on individual USB-2 ports. The devices will automatically go
3159 * into suspend a few ms after the root hub stops sending packets.
3160 * The USB 2.0 spec calls this "global suspend".
3162 * However, many USB hubs have a bug: They don't relay wakeup requests
3163 * from a downstream port if the port's suspend feature isn't on.
3164 * Therefore we will turn on the suspend feature if udev or any of its
3165 * descendants is enabled for remote wakeup.
3167 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3168 status
= set_port_feature(hub
->hdev
, port1
,
3169 USB_PORT_FEAT_SUSPEND
);
3171 really_suspend
= false;
3175 dev_dbg(&port_dev
->dev
, "can't suspend, status %d\n", status
);
3177 /* Try to enable USB3 LPM and LTM again */
3178 usb_unlocked_enable_lpm(udev
);
3180 usb_enable_ltm(udev
);
3182 /* Try to enable USB2 hardware LPM again */
3183 if (udev
->usb2_hw_lpm_capable
== 1)
3184 usb_set_usb2_hardware_lpm(udev
, 1);
3186 if (udev
->do_remote_wakeup
)
3187 (void) usb_disable_remote_wakeup(udev
);
3190 /* System sleep transitions should never fail */
3191 if (!PMSG_IS_AUTO(msg
))
3194 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3195 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3196 udev
->do_remote_wakeup
);
3197 if (really_suspend
) {
3198 udev
->port_is_suspended
= 1;
3200 /* device has up to 10 msec to fully suspend */
3203 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3206 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
3207 && test_and_clear_bit(port1
, hub
->child_usage_bits
))
3208 pm_runtime_put_sync(&port_dev
->dev
);
3210 usb_mark_last_busy(hub
->hdev
);
3212 usb_unlock_port(port_dev
);
3217 * If the USB "suspend" state is in use (rather than "global suspend"),
3218 * many devices will be individually taken out of suspend state using
3219 * special "resume" signaling. This routine kicks in shortly after
3220 * hardware resume signaling is finished, either because of selective
3221 * resume (by host) or remote wakeup (by device) ... now see what changed
3222 * in the tree that's rooted at this device.
3224 * If @udev->reset_resume is set then the device is reset before the
3225 * status check is done.
3227 static int finish_port_resume(struct usb_device
*udev
)
3232 /* caller owns the udev device lock */
3233 dev_dbg(&udev
->dev
, "%s\n",
3234 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3236 /* usb ch9 identifies four variants of SUSPENDED, based on what
3237 * state the device resumes to. Linux currently won't see the
3238 * first two on the host side; they'd be inside hub_port_init()
3239 * during many timeouts, but hub_wq can't suspend until later.
3241 usb_set_device_state(udev
, udev
->actconfig
3242 ? USB_STATE_CONFIGURED
3243 : USB_STATE_ADDRESS
);
3245 /* 10.5.4.5 says not to reset a suspended port if the attached
3246 * device is enabled for remote wakeup. Hence the reset
3247 * operation is carried out here, after the port has been
3250 if (udev
->reset_resume
) {
3252 * If the device morphs or switches modes when it is reset,
3253 * we don't want to perform a reset-resume. We'll fail the
3254 * resume, which will cause a logical disconnect, and then
3255 * the device will be rediscovered.
3258 if (udev
->quirks
& USB_QUIRK_RESET
)
3261 status
= usb_reset_and_verify_device(udev
);
3264 /* 10.5.4.5 says be sure devices in the tree are still there.
3265 * For now let's assume the device didn't go crazy on resume,
3266 * and device drivers will know about any resume quirks.
3270 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3272 /* If a normal resume failed, try doing a reset-resume */
3273 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3274 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3275 udev
->reset_resume
= 1;
3276 goto retry_reset_resume
;
3281 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3284 * There are a few quirky devices which violate the standard
3285 * by claiming to have remote wakeup enabled after a reset,
3286 * which crash if the feature is cleared, hence check for
3287 * udev->reset_resume
3289 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3290 if (udev
->speed
< USB_SPEED_SUPER
) {
3291 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3292 status
= usb_disable_remote_wakeup(udev
);
3294 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3296 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3297 | USB_INTRF_STAT_FUNC_RW
))
3298 status
= usb_disable_remote_wakeup(udev
);
3303 "disable remote wakeup, status %d\n",
3311 * There are some SS USB devices which take longer time for link training.
3312 * XHCI specs 4.19.4 says that when Link training is successful, port
3313 * sets CSC bit to 1. So if SW reads port status before successful link
3314 * training, then it will not find device to be present.
3315 * USB Analyzer log with such buggy devices show that in some cases
3316 * device switch on the RX termination after long delay of host enabling
3317 * the VBUS. In few other cases it has been seen that device fails to
3318 * negotiate link training in first attempt. It has been
3319 * reported till now that few devices take as long as 2000 ms to train
3320 * the link after host enabling its VBUS and termination. Following
3321 * routine implements a 2000 ms timeout for link training. If in a case
3322 * link trains before timeout, loop will exit earlier.
3324 * FIXME: If a device was connected before suspend, but was removed
3325 * while system was asleep, then the loop in the following routine will
3326 * only exit at timeout.
3328 * This routine should only be called when persist is enabled for a SS
3331 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3332 struct usb_hub
*hub
, int *port1
,
3333 u16
*portchange
, u16
*portstatus
)
3335 int status
= 0, delay_ms
= 0;
3337 while (delay_ms
< 2000) {
3338 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3342 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3348 * usb_port_resume - re-activate a suspended usb device's upstream port
3349 * @udev: device to re-activate, not a root hub
3350 * Context: must be able to sleep; device not locked; pm locks held
3352 * This will re-activate the suspended device, increasing power usage
3353 * while letting drivers communicate again with its endpoints.
3354 * USB resume explicitly guarantees that the power session between
3355 * the host and the device is the same as it was when the device
3358 * If @udev->reset_resume is set then this routine won't check that the
3359 * port is still enabled. Furthermore, finish_port_resume() above will
3360 * reset @udev. The end result is that a broken power session can be
3361 * recovered and @udev will appear to persist across a loss of VBUS power.
3363 * For example, if a host controller doesn't maintain VBUS suspend current
3364 * during a system sleep or is reset when the system wakes up, all the USB
3365 * power sessions below it will be broken. This is especially troublesome
3366 * for mass-storage devices containing mounted filesystems, since the
3367 * device will appear to have disconnected and all the memory mappings
3368 * to it will be lost. Using the USB_PERSIST facility, the device can be
3369 * made to appear as if it had not disconnected.
3371 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3372 * every effort to insure that the same device is present after the
3373 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3374 * quite possible for a device to remain unaltered but its media to be
3375 * changed. If the user replaces a flash memory card while the system is
3376 * asleep, he will have only himself to blame when the filesystem on the
3377 * new card is corrupted and the system crashes.
3379 * Returns 0 on success, else negative errno.
3381 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3383 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3384 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3385 int port1
= udev
->portnum
;
3387 u16 portchange
, portstatus
;
3389 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
3390 status
= pm_runtime_get_sync(&port_dev
->dev
);
3392 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3398 usb_lock_port(port_dev
);
3400 /* Skip the initial Clear-Suspend step for a remote wakeup */
3401 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3402 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3403 goto SuspendCleared
;
3405 /* see 7.1.7.7; affects power usage, but not budgeting */
3406 if (hub_is_superspeed(hub
->hdev
))
3407 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3409 status
= usb_clear_port_feature(hub
->hdev
,
3410 port1
, USB_PORT_FEAT_SUSPEND
);
3412 dev_dbg(&port_dev
->dev
, "can't resume, status %d\n", status
);
3414 /* drive resume for USB_RESUME_TIMEOUT msec */
3415 dev_dbg(&udev
->dev
, "usb %sresume\n",
3416 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3417 msleep(USB_RESUME_TIMEOUT
);
3419 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3420 * stop resume signaling. Then finish the resume
3423 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3425 /* TRSMRCY = 10 msec */
3431 udev
->port_is_suspended
= 0;
3432 if (hub_is_superspeed(hub
->hdev
)) {
3433 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3434 usb_clear_port_feature(hub
->hdev
, port1
,
3435 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3437 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3438 usb_clear_port_feature(hub
->hdev
, port1
,
3439 USB_PORT_FEAT_C_SUSPEND
);
3443 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3444 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3447 status
= check_port_resume_type(udev
,
3448 hub
, port1
, status
, portchange
, portstatus
);
3450 status
= finish_port_resume(udev
);
3452 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3453 hub_port_logical_disconnect(hub
, port1
);
3455 /* Try to enable USB2 hardware LPM */
3456 if (udev
->usb2_hw_lpm_capable
== 1)
3457 usb_set_usb2_hardware_lpm(udev
, 1);
3459 /* Try to enable USB3 LTM and LPM */
3460 usb_enable_ltm(udev
);
3461 usb_unlocked_enable_lpm(udev
);
3464 usb_unlock_port(port_dev
);
3469 int usb_remote_wakeup(struct usb_device
*udev
)
3473 usb_lock_device(udev
);
3474 if (udev
->state
== USB_STATE_SUSPENDED
) {
3475 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3476 status
= usb_autoresume_device(udev
);
3478 /* Let the drivers do their thing, then... */
3479 usb_autosuspend_device(udev
);
3482 usb_unlock_device(udev
);
3486 /* Returns 1 if there was a remote wakeup and a connect status change. */
3487 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
3488 u16 portstatus
, u16 portchange
)
3489 __must_hold(&port_dev
->status_lock
)
3491 struct usb_port
*port_dev
= hub
->ports
[port
- 1];
3492 struct usb_device
*hdev
;
3493 struct usb_device
*udev
;
3494 int connect_change
= 0;
3498 udev
= port_dev
->child
;
3499 if (!hub_is_superspeed(hdev
)) {
3500 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
3502 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
3504 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
3505 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
3511 /* TRSMRCY = 10 msec */
3514 usb_unlock_port(port_dev
);
3515 ret
= usb_remote_wakeup(udev
);
3516 usb_lock_port(port_dev
);
3521 hub_port_disable(hub
, port
, 1);
3523 dev_dbg(&port_dev
->dev
, "resume, status %d\n", ret
);
3524 return connect_change
;
3527 static int check_ports_changed(struct usb_hub
*hub
)
3531 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3532 u16 portstatus
, portchange
;
3535 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3536 if (!status
&& portchange
)
3542 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3544 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3545 struct usb_device
*hdev
= hub
->hdev
;
3550 * Warn if children aren't already suspended.
3551 * Also, add up the number of wakeup-enabled descendants.
3553 hub
->wakeup_enabled_descendants
= 0;
3554 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3555 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
3556 struct usb_device
*udev
= port_dev
->child
;
3558 if (udev
&& udev
->can_submit
) {
3559 dev_warn(&port_dev
->dev
, "device %s not suspended yet\n",
3560 dev_name(&udev
->dev
));
3561 if (PMSG_IS_AUTO(msg
))
3565 hub
->wakeup_enabled_descendants
+=
3566 wakeup_enabled_descendants(udev
);
3569 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3570 /* check if there are changes pending on hub ports */
3571 if (check_ports_changed(hub
)) {
3572 if (PMSG_IS_AUTO(msg
))
3574 pm_wakeup_event(&hdev
->dev
, 2000);
3578 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3579 /* Enable hub to send remote wakeup for all ports. */
3580 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3581 status
= set_port_feature(hdev
,
3583 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3584 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3585 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3586 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3590 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3592 /* stop hub_wq and related activity */
3593 hub_quiesce(hub
, HUB_SUSPEND
);
3597 static int hub_resume(struct usb_interface
*intf
)
3599 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3601 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3602 hub_activate(hub
, HUB_RESUME
);
3606 static int hub_reset_resume(struct usb_interface
*intf
)
3608 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3610 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3611 hub_activate(hub
, HUB_RESET_RESUME
);
3616 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3617 * @rhdev: struct usb_device for the root hub
3619 * The USB host controller driver calls this function when its root hub
3620 * is resumed and Vbus power has been interrupted or the controller
3621 * has been reset. The routine marks @rhdev as having lost power.
3622 * When the hub driver is resumed it will take notice and carry out
3623 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3624 * the others will be disconnected.
3626 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3628 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3629 rhdev
->reset_resume
= 1;
3631 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3633 static const char * const usb3_lpm_names
[] = {
3641 * Send a Set SEL control transfer to the device, prior to enabling
3642 * device-initiated U1 or U2. This lets the device know the exit latencies from
3643 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3644 * packet from the host.
3646 * This function will fail if the SEL or PEL values for udev are greater than
3647 * the maximum allowed values for the link state to be enabled.
3649 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3651 struct usb_set_sel_req
*sel_values
;
3652 unsigned long long u1_sel
;
3653 unsigned long long u1_pel
;
3654 unsigned long long u2_sel
;
3655 unsigned long long u2_pel
;
3658 if (udev
->state
!= USB_STATE_CONFIGURED
)
3661 /* Convert SEL and PEL stored in ns to us */
3662 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3663 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3664 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3665 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3668 * Make sure that the calculated SEL and PEL values for the link
3669 * state we're enabling aren't bigger than the max SEL/PEL
3670 * value that will fit in the SET SEL control transfer.
3671 * Otherwise the device would get an incorrect idea of the exit
3672 * latency for the link state, and could start a device-initiated
3673 * U1/U2 when the exit latencies are too high.
3675 if ((state
== USB3_LPM_U1
&&
3676 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3677 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3678 (state
== USB3_LPM_U2
&&
3679 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3680 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3681 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3682 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3687 * If we're enabling device-initiated LPM for one link state,
3688 * but the other link state has a too high SEL or PEL value,
3689 * just set those values to the max in the Set SEL request.
3691 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3692 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3694 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3695 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3697 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3698 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3700 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3701 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3704 * usb_enable_lpm() can be called as part of a failed device reset,
3705 * which may be initiated by an error path of a mass storage driver.
3706 * Therefore, use GFP_NOIO.
3708 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3712 sel_values
->u1_sel
= u1_sel
;
3713 sel_values
->u1_pel
= u1_pel
;
3714 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3715 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3717 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3721 sel_values
, sizeof *(sel_values
),
3722 USB_CTRL_SET_TIMEOUT
);
3728 * Enable or disable device-initiated U1 or U2 transitions.
3730 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3731 enum usb3_link_state state
, bool enable
)
3738 feature
= USB_DEVICE_U1_ENABLE
;
3741 feature
= USB_DEVICE_U2_ENABLE
;
3744 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3745 __func__
, enable
? "enable" : "disable");
3749 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3750 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3751 "for unconfigured device.\n",
3752 __func__
, enable
? "enable" : "disable",
3753 usb3_lpm_names
[state
]);
3759 * Now send the control transfer to enable device-initiated LPM
3760 * for either U1 or U2.
3762 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3763 USB_REQ_SET_FEATURE
,
3767 USB_CTRL_SET_TIMEOUT
);
3769 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3770 USB_REQ_CLEAR_FEATURE
,
3774 USB_CTRL_SET_TIMEOUT
);
3777 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3778 enable
? "Enable" : "Disable",
3779 usb3_lpm_names
[state
]);
3785 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3786 enum usb3_link_state state
, int timeout
)
3793 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3796 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3799 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3804 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3805 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3806 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3807 "which is a reserved value.\n",
3808 usb3_lpm_names
[state
], timeout
);
3812 ret
= set_port_feature(udev
->parent
,
3813 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3816 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3817 "error code %i\n", usb3_lpm_names
[state
],
3821 if (state
== USB3_LPM_U1
)
3822 udev
->u1_params
.timeout
= timeout
;
3824 udev
->u2_params
.timeout
= timeout
;
3829 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3832 * We will attempt to enable U1 or U2, but there are no guarantees that the
3833 * control transfers to set the hub timeout or enable device-initiated U1/U2
3834 * will be successful.
3836 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3837 * driver know about it. If that call fails, it should be harmless, and just
3838 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3840 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3841 enum usb3_link_state state
)
3844 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3845 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3847 /* If the device says it doesn't have *any* exit latency to come out of
3848 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3851 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3852 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3856 * First, let the device know about the exit latencies
3857 * associated with the link state we're about to enable.
3859 ret
= usb_req_set_sel(udev
, state
);
3861 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3862 usb3_lpm_names
[state
]);
3866 /* We allow the host controller to set the U1/U2 timeout internally
3867 * first, so that it can change its schedule to account for the
3868 * additional latency to send data to a device in a lower power
3871 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3873 /* xHCI host controller doesn't want to enable this LPM state. */
3878 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3879 "xHCI error %i.\n", usb3_lpm_names
[state
],
3884 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3885 /* If we can't set the parent hub U1/U2 timeout,
3886 * device-initiated LPM won't be allowed either, so let the xHCI
3887 * host know that this link state won't be enabled.
3889 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3891 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3892 else if (udev
->actconfig
)
3893 usb_set_device_initiated_lpm(udev
, state
, true);
3898 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3901 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3902 * If zero is returned, the parent will not allow the link to go into U1/U2.
3904 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3905 * it won't have an effect on the bus link state because the parent hub will
3906 * still disallow device-initiated U1/U2 entry.
3908 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3909 * possible. The result will be slightly more bus bandwidth will be taken up
3910 * (to account for U1/U2 exit latency), but it should be harmless.
3912 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3913 enum usb3_link_state state
)
3920 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3925 if (usb_set_lpm_timeout(udev
, state
, 0))
3928 usb_set_device_initiated_lpm(udev
, state
, false);
3930 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3931 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3932 "bus schedule bandwidth may be impacted.\n",
3933 usb3_lpm_names
[state
]);
3938 * Disable hub-initiated and device-initiated U1 and U2 entry.
3939 * Caller must own the bandwidth_mutex.
3941 * This will call usb_enable_lpm() on failure, which will decrement
3942 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3944 int usb_disable_lpm(struct usb_device
*udev
)
3946 struct usb_hcd
*hcd
;
3948 if (!udev
|| !udev
->parent
||
3949 udev
->speed
!= USB_SPEED_SUPER
||
3950 !udev
->lpm_capable
||
3951 udev
->state
< USB_STATE_DEFAULT
)
3954 hcd
= bus_to_hcd(udev
->bus
);
3955 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3958 udev
->lpm_disable_count
++;
3959 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3962 /* If LPM is enabled, attempt to disable it. */
3963 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3965 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3971 usb_enable_lpm(udev
);
3974 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3976 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3977 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3979 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3985 mutex_lock(hcd
->bandwidth_mutex
);
3986 ret
= usb_disable_lpm(udev
);
3987 mutex_unlock(hcd
->bandwidth_mutex
);
3991 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3994 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3995 * xHCI host policy may prevent U1 or U2 from being enabled.
3997 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3998 * until the lpm_disable_count drops to zero. Caller must own the
4001 void usb_enable_lpm(struct usb_device
*udev
)
4003 struct usb_hcd
*hcd
;
4005 if (!udev
|| !udev
->parent
||
4006 udev
->speed
!= USB_SPEED_SUPER
||
4007 !udev
->lpm_capable
||
4008 udev
->state
< USB_STATE_DEFAULT
)
4011 udev
->lpm_disable_count
--;
4012 hcd
= bus_to_hcd(udev
->bus
);
4013 /* Double check that we can both enable and disable LPM.
4014 * Device must be configured to accept set feature U1/U2 timeout.
4016 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
4017 !hcd
->driver
->disable_usb3_lpm_timeout
)
4020 if (udev
->lpm_disable_count
> 0)
4023 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
4024 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
4026 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4028 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4029 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
4031 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4036 mutex_lock(hcd
->bandwidth_mutex
);
4037 usb_enable_lpm(udev
);
4038 mutex_unlock(hcd
->bandwidth_mutex
);
4040 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4043 #else /* CONFIG_PM */
4045 #define hub_suspend NULL
4046 #define hub_resume NULL
4047 #define hub_reset_resume NULL
4049 int usb_disable_lpm(struct usb_device
*udev
)
4053 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
4055 void usb_enable_lpm(struct usb_device
*udev
) { }
4056 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
4058 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
4062 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
4064 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
4065 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
4067 int usb_disable_ltm(struct usb_device
*udev
)
4071 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
4073 void usb_enable_ltm(struct usb_device
*udev
) { }
4074 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
4076 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4077 u16 portstatus
, u16 portchange
)
4082 #endif /* CONFIG_PM */
4085 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4087 * Between connect detection and reset signaling there must be a delay
4088 * of 100ms at least for debounce and power-settling. The corresponding
4089 * timer shall restart whenever the downstream port detects a disconnect.
4091 * Apparently there are some bluetooth and irda-dongles and a number of
4092 * low-speed devices for which this debounce period may last over a second.
4093 * Not covered by the spec - but easy to deal with.
4095 * This implementation uses a 1500ms total debounce timeout; if the
4096 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4097 * every 25ms for transient disconnects. When the port status has been
4098 * unchanged for 100ms it returns the port status.
4100 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
4103 u16 portchange
, portstatus
;
4104 unsigned connection
= 0xffff;
4105 int total_time
, stable_time
= 0;
4106 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4108 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
4109 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
4113 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
4114 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
4115 if (!must_be_connected
||
4116 (connection
== USB_PORT_STAT_CONNECTION
))
4117 stable_time
+= HUB_DEBOUNCE_STEP
;
4118 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
4122 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
4125 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4126 usb_clear_port_feature(hub
->hdev
, port1
,
4127 USB_PORT_FEAT_C_CONNECTION
);
4130 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
4132 msleep(HUB_DEBOUNCE_STEP
);
4135 dev_dbg(&port_dev
->dev
, "debounce total %dms stable %dms status 0x%x\n",
4136 total_time
, stable_time
, portstatus
);
4138 if (stable_time
< HUB_DEBOUNCE_STABLE
)
4143 void usb_ep0_reinit(struct usb_device
*udev
)
4145 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
4146 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
4147 usb_enable_endpoint(udev
, &udev
->ep0
, true);
4149 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
4151 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4152 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4154 static int hub_set_address(struct usb_device
*udev
, int devnum
)
4157 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4160 * The host controller will choose the device address,
4161 * instead of the core having chosen it earlier
4163 if (!hcd
->driver
->address_device
&& devnum
<= 1)
4165 if (udev
->state
== USB_STATE_ADDRESS
)
4167 if (udev
->state
!= USB_STATE_DEFAULT
)
4169 if (hcd
->driver
->address_device
)
4170 retval
= hcd
->driver
->address_device(hcd
, udev
);
4172 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4173 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4174 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4176 update_devnum(udev
, devnum
);
4177 /* Device now using proper address. */
4178 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4179 usb_ep0_reinit(udev
);
4185 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4186 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4189 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4190 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4191 * support bit in the BOS descriptor.
4193 static void hub_set_initial_usb2_lpm_policy(struct usb_device
*udev
)
4195 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
4196 int connect_type
= USB_PORT_CONNECT_TYPE_UNKNOWN
;
4198 if (!udev
->usb2_hw_lpm_capable
)
4202 connect_type
= hub
->ports
[udev
->portnum
- 1]->connect_type
;
4204 if ((udev
->bos
->ext_cap
->bmAttributes
& cpu_to_le32(USB_BESL_SUPPORT
)) ||
4205 connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
4206 udev
->usb2_hw_lpm_allowed
= 1;
4207 usb_set_usb2_hardware_lpm(udev
, 1);
4211 static int hub_enable_device(struct usb_device
*udev
)
4213 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4215 if (!hcd
->driver
->enable_device
)
4217 if (udev
->state
== USB_STATE_ADDRESS
)
4219 if (udev
->state
!= USB_STATE_DEFAULT
)
4222 return hcd
->driver
->enable_device(hcd
, udev
);
4225 /* Reset device, (re)assign address, get device descriptor.
4226 * Device connection must be stable, no more debouncing needed.
4227 * Returns device in USB_STATE_ADDRESS, except on error.
4229 * If this is called for an already-existing device (as part of
4230 * usb_reset_and_verify_device), the caller must own the device lock and
4231 * the port lock. For a newly detected device that is not accessible
4232 * through any global pointers, it's not necessary to lock the device,
4233 * but it is still necessary to lock the port.
4236 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4239 struct usb_device
*hdev
= hub
->hdev
;
4240 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4242 unsigned delay
= HUB_SHORT_RESET_TIME
;
4243 enum usb_device_speed oldspeed
= udev
->speed
;
4245 int devnum
= udev
->devnum
;
4247 /* root hub ports have a slightly longer reset period
4248 * (from USB 2.0 spec, section 7.1.7.5)
4250 if (!hdev
->parent
) {
4251 delay
= HUB_ROOT_RESET_TIME
;
4252 if (port1
== hdev
->bus
->otg_port
)
4253 hdev
->bus
->b_hnp_enable
= 0;
4256 /* Some low speed devices have problems with the quick delay, so */
4257 /* be a bit pessimistic with those devices. RHbug #23670 */
4258 if (oldspeed
== USB_SPEED_LOW
)
4259 delay
= HUB_LONG_RESET_TIME
;
4261 mutex_lock(&hdev
->bus
->usb_address0_mutex
);
4263 /* Reset the device; full speed may morph to high speed */
4264 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4265 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4266 if (retval
< 0) /* error or disconnect */
4268 /* success, speed is known */
4272 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4273 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4276 oldspeed
= udev
->speed
;
4278 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4279 * it's fixed size except for full speed devices.
4280 * For Wireless USB devices, ep0 max packet is always 512 (tho
4281 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4283 switch (udev
->speed
) {
4284 case USB_SPEED_SUPER
:
4285 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4286 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4288 case USB_SPEED_HIGH
: /* fixed at 64 */
4289 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4291 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4292 /* to determine the ep0 maxpacket size, try to read
4293 * the device descriptor to get bMaxPacketSize0 and
4294 * then correct our initial guess.
4296 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4298 case USB_SPEED_LOW
: /* fixed at 8 */
4299 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4305 if (udev
->speed
== USB_SPEED_WIRELESS
)
4306 speed
= "variable speed Wireless";
4308 speed
= usb_speed_string(udev
->speed
);
4310 if (udev
->speed
!= USB_SPEED_SUPER
)
4311 dev_info(&udev
->dev
,
4312 "%s %s USB device number %d using %s\n",
4313 (udev
->config
) ? "reset" : "new", speed
,
4314 devnum
, udev
->bus
->controller
->driver
->name
);
4316 /* Set up TT records, if needed */
4318 udev
->tt
= hdev
->tt
;
4319 udev
->ttport
= hdev
->ttport
;
4320 } else if (udev
->speed
!= USB_SPEED_HIGH
4321 && hdev
->speed
== USB_SPEED_HIGH
) {
4323 dev_err(&udev
->dev
, "parent hub has no TT\n");
4327 udev
->tt
= &hub
->tt
;
4328 udev
->ttport
= port1
;
4331 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4332 * Because device hardware and firmware is sometimes buggy in
4333 * this area, and this is how Linux has done it for ages.
4334 * Change it cautiously.
4336 * NOTE: If use_new_scheme() is true we will start by issuing
4337 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4338 * so it may help with some non-standards-compliant devices.
4339 * Otherwise we start with SET_ADDRESS and then try to read the
4340 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4343 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4344 bool did_new_scheme
= false;
4346 if (use_new_scheme(udev
, retry_counter
)) {
4347 struct usb_device_descriptor
*buf
;
4350 did_new_scheme
= true;
4351 retval
= hub_enable_device(udev
);
4354 "hub failed to enable device, error %d\n",
4359 #define GET_DESCRIPTOR_BUFSIZE 64
4360 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4366 /* Retry on all errors; some devices are flakey.
4367 * 255 is for WUSB devices, we actually need to use
4368 * 512 (WUSB1.0[4.8.1]).
4370 for (j
= 0; j
< 3; ++j
) {
4371 buf
->bMaxPacketSize0
= 0;
4372 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4373 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4374 USB_DT_DEVICE
<< 8, 0,
4375 buf
, GET_DESCRIPTOR_BUFSIZE
,
4376 initial_descriptor_timeout
);
4377 switch (buf
->bMaxPacketSize0
) {
4378 case 8: case 16: case 32: case 64: case 255:
4379 if (buf
->bDescriptorType
==
4393 udev
->descriptor
.bMaxPacketSize0
=
4394 buf
->bMaxPacketSize0
;
4397 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4398 if (retval
< 0) /* error or disconnect */
4400 if (oldspeed
!= udev
->speed
) {
4402 "device reset changed speed!\n");
4408 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4413 #undef GET_DESCRIPTOR_BUFSIZE
4417 * If device is WUSB, we already assigned an
4418 * unauthorized address in the Connect Ack sequence;
4419 * authorization will assign the final address.
4421 if (udev
->wusb
== 0) {
4422 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4423 retval
= hub_set_address(udev
, devnum
);
4429 if (retval
!= -ENODEV
)
4430 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4434 if (udev
->speed
== USB_SPEED_SUPER
) {
4435 devnum
= udev
->devnum
;
4436 dev_info(&udev
->dev
,
4437 "%s SuperSpeed USB device number %d using %s\n",
4438 (udev
->config
) ? "reset" : "new",
4439 devnum
, udev
->bus
->controller
->driver
->name
);
4442 /* cope with hardware quirkiness:
4443 * - let SET_ADDRESS settle, some device hardware wants it
4444 * - read ep0 maxpacket even for high and low speed,
4447 /* use_new_scheme() checks the speed which may have
4448 * changed since the initial look so we cache the result
4455 retval
= usb_get_device_descriptor(udev
, 8);
4457 if (retval
!= -ENODEV
)
4459 "device descriptor read/8, error %d\n",
4472 * Some superspeed devices have finished the link training process
4473 * and attached to a superspeed hub port, but the device descriptor
4474 * got from those devices show they aren't superspeed devices. Warm
4475 * reset the port attached by the devices can fix them.
4477 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4478 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4479 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4480 "warm reset device\n");
4481 hub_port_reset(hub
, port1
, udev
,
4482 HUB_BH_RESET_TIME
, true);
4487 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4488 udev
->speed
== USB_SPEED_SUPER
)
4491 i
= udev
->descriptor
.bMaxPacketSize0
;
4492 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4493 if (udev
->speed
== USB_SPEED_LOW
||
4494 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4495 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4499 if (udev
->speed
== USB_SPEED_FULL
)
4500 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4502 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4503 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4504 usb_ep0_reinit(udev
);
4507 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4508 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4509 if (retval
!= -ENODEV
)
4510 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4517 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4518 retval
= usb_get_bos_descriptor(udev
);
4520 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4521 usb_set_lpm_parameters(udev
);
4526 /* notify HCD that we have a device connected and addressed */
4527 if (hcd
->driver
->update_device
)
4528 hcd
->driver
->update_device(hcd
, udev
);
4529 hub_set_initial_usb2_lpm_policy(udev
);
4532 hub_port_disable(hub
, port1
, 0);
4533 update_devnum(udev
, devnum
); /* for disconnect processing */
4535 mutex_unlock(&hdev
->bus
->usb_address0_mutex
);
4540 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4542 struct usb_qualifier_descriptor
*qual
;
4545 if (udev
->quirks
& USB_QUIRK_DEVICE_QUALIFIER
)
4548 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4552 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4553 qual
, sizeof *qual
);
4554 if (status
== sizeof *qual
) {
4555 dev_info(&udev
->dev
, "not running at top speed; "
4556 "connect to a high speed hub\n");
4557 /* hub LEDs are probably harder to miss than syslog */
4558 if (hub
->has_indicators
) {
4559 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4560 queue_delayed_work(system_power_efficient_wq
,
4568 hub_power_remaining (struct usb_hub
*hub
)
4570 struct usb_device
*hdev
= hub
->hdev
;
4574 if (!hub
->limited_power
)
4577 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4578 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4579 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4580 struct usb_device
*udev
= port_dev
->child
;
4586 if (hub_is_superspeed(udev
))
4592 * Unconfigured devices may not use more than one unit load,
4593 * or 8mA for OTG ports
4595 if (udev
->actconfig
)
4596 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4597 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4601 if (delta
> hub
->mA_per_port
)
4602 dev_warn(&port_dev
->dev
, "%dmA is over %umA budget!\n",
4603 delta
, hub
->mA_per_port
);
4606 if (remaining
< 0) {
4607 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4614 static void hub_port_connect(struct usb_hub
*hub
, int port1
, u16 portstatus
,
4619 struct usb_device
*hdev
= hub
->hdev
;
4620 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4621 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4622 struct usb_device
*udev
= port_dev
->child
;
4623 static int unreliable_port
= -1;
4625 /* Disconnect any existing devices under this port */
4627 if (hcd
->usb_phy
&& !hdev
->parent
)
4628 usb_phy_notify_disconnect(hcd
->usb_phy
, udev
->speed
);
4629 usb_disconnect(&port_dev
->child
);
4632 /* We can forget about a "removed" device when there's a physical
4633 * disconnect or the connect status changes.
4635 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4636 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4637 clear_bit(port1
, hub
->removed_bits
);
4639 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4640 USB_PORT_STAT_C_ENABLE
)) {
4641 status
= hub_port_debounce_be_stable(hub
, port1
);
4643 if (status
!= -ENODEV
&&
4644 port1
!= unreliable_port
&&
4646 dev_err(&port_dev
->dev
, "connect-debounce failed\n");
4647 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4648 unreliable_port
= port1
;
4650 portstatus
= status
;
4654 /* Return now if debouncing failed or nothing is connected or
4655 * the device was "removed".
4657 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4658 test_bit(port1
, hub
->removed_bits
)) {
4661 * maybe switch power back on (e.g. root hub was reset)
4662 * but only if the port isn't owned by someone else.
4664 if (hub_is_port_power_switchable(hub
)
4665 && !port_is_power_on(hub
, portstatus
)
4666 && !port_dev
->port_owner
)
4667 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4669 if (portstatus
& USB_PORT_STAT_ENABLE
)
4673 if (hub_is_superspeed(hub
->hdev
))
4679 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4681 /* reallocate for each attempt, since references
4682 * to the previous one can escape in various ways
4684 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4686 dev_err(&port_dev
->dev
,
4687 "couldn't allocate usb_device\n");
4691 usb_set_device_state(udev
, USB_STATE_POWERED
);
4692 udev
->bus_mA
= hub
->mA_per_port
;
4693 udev
->level
= hdev
->level
+ 1;
4694 udev
->wusb
= hub_is_wusb(hub
);
4696 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4697 if (hub_is_superspeed(hub
->hdev
))
4698 udev
->speed
= USB_SPEED_SUPER
;
4700 udev
->speed
= USB_SPEED_UNKNOWN
;
4702 choose_devnum(udev
);
4703 if (udev
->devnum
<= 0) {
4704 status
= -ENOTCONN
; /* Don't retry */
4708 /* reset (non-USB 3.0 devices) and get descriptor */
4709 usb_lock_port(port_dev
);
4710 status
= hub_port_init(hub
, udev
, port1
, i
);
4711 usb_unlock_port(port_dev
);
4715 usb_detect_quirks(udev
);
4716 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4719 /* consecutive bus-powered hubs aren't reliable; they can
4720 * violate the voltage drop budget. if the new child has
4721 * a "powered" LED, users should notice we didn't enable it
4722 * (without reading syslog), even without per-port LEDs
4725 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4726 && udev
->bus_mA
<= unit_load
) {
4729 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4732 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4735 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4737 "can't connect bus-powered hub "
4739 if (hub
->has_indicators
) {
4740 hub
->indicator
[port1
-1] =
4741 INDICATOR_AMBER_BLINK
;
4743 system_power_efficient_wq
,
4746 status
= -ENOTCONN
; /* Don't retry */
4751 /* check for devices running slower than they could */
4752 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4753 && udev
->speed
== USB_SPEED_FULL
4754 && highspeed_hubs
!= 0)
4755 check_highspeed (hub
, udev
, port1
);
4757 /* Store the parent's children[] pointer. At this point
4758 * udev becomes globally accessible, although presumably
4759 * no one will look at it until hdev is unlocked.
4763 mutex_lock(&usb_port_peer_mutex
);
4765 /* We mustn't add new devices if the parent hub has
4766 * been disconnected; we would race with the
4767 * recursively_mark_NOTATTACHED() routine.
4769 spin_lock_irq(&device_state_lock
);
4770 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4773 port_dev
->child
= udev
;
4774 spin_unlock_irq(&device_state_lock
);
4775 mutex_unlock(&usb_port_peer_mutex
);
4777 /* Run it through the hoops (find a driver, etc) */
4779 status
= usb_new_device(udev
);
4781 mutex_lock(&usb_port_peer_mutex
);
4782 spin_lock_irq(&device_state_lock
);
4783 port_dev
->child
= NULL
;
4784 spin_unlock_irq(&device_state_lock
);
4785 mutex_unlock(&usb_port_peer_mutex
);
4787 if (hcd
->usb_phy
&& !hdev
->parent
)
4788 usb_phy_notify_connect(hcd
->usb_phy
,
4796 status
= hub_power_remaining(hub
);
4798 dev_dbg(hub
->intfdev
, "%dmA power budget left\n", status
);
4803 hub_port_disable(hub
, port1
, 1);
4805 usb_ep0_reinit(udev
);
4806 release_devnum(udev
);
4809 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4812 if (hub
->hdev
->parent
||
4813 !hcd
->driver
->port_handed_over
||
4814 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4815 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4816 dev_err(&port_dev
->dev
,
4817 "unable to enumerate USB device\n");
4821 hub_port_disable(hub
, port1
, 1);
4822 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4823 hcd
->driver
->relinquish_port(hcd
, port1
);
4827 /* Handle physical or logical connection change events.
4828 * This routine is called when:
4829 * a port connection-change occurs;
4830 * a port enable-change occurs (often caused by EMI);
4831 * usb_reset_and_verify_device() encounters changed descriptors (as from
4832 * a firmware download)
4833 * caller already locked the hub
4835 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4836 u16 portstatus
, u16 portchange
)
4837 __must_hold(&port_dev
->status_lock
)
4839 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4840 struct usb_device
*udev
= port_dev
->child
;
4841 int status
= -ENODEV
;
4843 dev_dbg(&port_dev
->dev
, "status %04x, change %04x, %s\n", portstatus
,
4844 portchange
, portspeed(hub
, portstatus
));
4846 if (hub
->has_indicators
) {
4847 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4848 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4851 #ifdef CONFIG_USB_OTG
4852 /* during HNP, don't repeat the debounce */
4853 if (hub
->hdev
->bus
->is_b_host
)
4854 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4855 USB_PORT_STAT_C_ENABLE
);
4858 /* Try to resuscitate an existing device */
4859 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4860 udev
->state
!= USB_STATE_NOTATTACHED
) {
4861 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4862 status
= 0; /* Nothing to do */
4864 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4865 udev
->persist_enabled
) {
4866 /* For a suspended device, treat this as a
4867 * remote wakeup event.
4869 usb_unlock_port(port_dev
);
4870 status
= usb_remote_wakeup(udev
);
4871 usb_lock_port(port_dev
);
4874 /* Don't resuscitate */;
4877 clear_bit(port1
, hub
->change_bits
);
4879 /* successfully revalidated the connection */
4883 usb_unlock_port(port_dev
);
4884 hub_port_connect(hub
, port1
, portstatus
, portchange
);
4885 usb_lock_port(port_dev
);
4888 static void port_event(struct usb_hub
*hub
, int port1
)
4889 __must_hold(&port_dev
->status_lock
)
4892 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
4893 struct usb_device
*udev
= port_dev
->child
;
4894 struct usb_device
*hdev
= hub
->hdev
;
4895 u16 portstatus
, portchange
;
4897 connect_change
= test_bit(port1
, hub
->change_bits
);
4898 clear_bit(port1
, hub
->event_bits
);
4899 clear_bit(port1
, hub
->wakeup_bits
);
4901 if (hub_port_status(hub
, port1
, &portstatus
, &portchange
) < 0)
4904 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4905 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
4909 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4910 if (!connect_change
)
4911 dev_dbg(&port_dev
->dev
, "enable change, status %08x\n",
4913 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
4916 * EM interference sometimes causes badly shielded USB devices
4917 * to be shutdown by the hub, this hack enables them again.
4918 * Works at least with mouse driver.
4920 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4921 && !connect_change
&& udev
) {
4922 dev_err(&port_dev
->dev
, "disabled by hub (EMI?), re-enabling...\n");
4927 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4928 u16 status
= 0, unused
;
4930 dev_dbg(&port_dev
->dev
, "over-current change\n");
4931 usb_clear_port_feature(hdev
, port1
,
4932 USB_PORT_FEAT_C_OVER_CURRENT
);
4933 msleep(100); /* Cool down */
4934 hub_power_on(hub
, true);
4935 hub_port_status(hub
, port1
, &status
, &unused
);
4936 if (status
& USB_PORT_STAT_OVERCURRENT
)
4937 dev_err(&port_dev
->dev
, "over-current condition\n");
4940 if (portchange
& USB_PORT_STAT_C_RESET
) {
4941 dev_dbg(&port_dev
->dev
, "reset change\n");
4942 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_RESET
);
4944 if ((portchange
& USB_PORT_STAT_C_BH_RESET
)
4945 && hub_is_superspeed(hdev
)) {
4946 dev_dbg(&port_dev
->dev
, "warm reset change\n");
4947 usb_clear_port_feature(hdev
, port1
,
4948 USB_PORT_FEAT_C_BH_PORT_RESET
);
4950 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4951 dev_dbg(&port_dev
->dev
, "link state change\n");
4952 usb_clear_port_feature(hdev
, port1
,
4953 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4955 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4956 dev_warn(&port_dev
->dev
, "config error\n");
4957 usb_clear_port_feature(hdev
, port1
,
4958 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4961 /* skip port actions that require the port to be powered on */
4962 if (!pm_runtime_active(&port_dev
->dev
))
4965 if (hub_handle_remote_wakeup(hub
, port1
, portstatus
, portchange
))
4969 * Warm reset a USB3 protocol port if it's in
4970 * SS.Inactive state.
4972 if (hub_port_warm_reset_required(hub
, port1
, portstatus
)) {
4973 dev_dbg(&port_dev
->dev
, "do warm reset\n");
4974 if (!udev
|| !(portstatus
& USB_PORT_STAT_CONNECTION
)
4975 || udev
->state
== USB_STATE_NOTATTACHED
) {
4976 if (hub_port_reset(hub
, port1
, NULL
,
4977 HUB_BH_RESET_TIME
, true) < 0)
4978 hub_port_disable(hub
, port1
, 1);
4980 usb_unlock_port(port_dev
);
4981 usb_lock_device(udev
);
4982 usb_reset_device(udev
);
4983 usb_unlock_device(udev
);
4984 usb_lock_port(port_dev
);
4990 hub_port_connect_change(hub
, port1
, portstatus
, portchange
);
4993 static void hub_event(struct work_struct
*work
)
4995 struct usb_device
*hdev
;
4996 struct usb_interface
*intf
;
4997 struct usb_hub
*hub
;
4998 struct device
*hub_dev
;
5003 hub
= container_of(work
, struct usb_hub
, events
);
5005 hub_dev
= hub
->intfdev
;
5006 intf
= to_usb_interface(hub_dev
);
5008 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
5009 hdev
->state
, hdev
->maxchild
,
5010 /* NOTE: expects max 15 ports... */
5011 (u16
) hub
->change_bits
[0],
5012 (u16
) hub
->event_bits
[0]);
5014 /* Lock the device, then check to see if we were
5015 * disconnected while waiting for the lock to succeed. */
5016 usb_lock_device(hdev
);
5017 if (unlikely(hub
->disconnected
))
5020 /* If the hub has died, clean up after it */
5021 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
5022 hub
->error
= -ENODEV
;
5023 hub_quiesce(hub
, HUB_DISCONNECT
);
5028 ret
= usb_autopm_get_interface(intf
);
5030 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
5034 /* If this is an inactive hub, do nothing */
5039 dev_dbg(hub_dev
, "resetting for error %d\n", hub
->error
);
5041 ret
= usb_reset_device(hdev
);
5043 dev_dbg(hub_dev
, "error resetting hub: %d\n", ret
);
5051 /* deal with port status changes */
5052 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5053 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5055 if (test_bit(i
, hub
->event_bits
)
5056 || test_bit(i
, hub
->change_bits
)
5057 || test_bit(i
, hub
->wakeup_bits
)) {
5059 * The get_noresume and barrier ensure that if
5060 * the port was in the process of resuming, we
5061 * flush that work and keep the port active for
5062 * the duration of the port_event(). However,
5063 * if the port is runtime pm suspended
5064 * (powered-off), we leave it in that state, run
5065 * an abbreviated port_event(), and move on.
5067 pm_runtime_get_noresume(&port_dev
->dev
);
5068 pm_runtime_barrier(&port_dev
->dev
);
5069 usb_lock_port(port_dev
);
5071 usb_unlock_port(port_dev
);
5072 pm_runtime_put_sync(&port_dev
->dev
);
5076 /* deal with hub status changes */
5077 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
5079 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
5080 dev_err(hub_dev
, "get_hub_status failed\n");
5082 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
5083 dev_dbg(hub_dev
, "power change\n");
5084 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
5085 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
5086 /* FIXME: Is this always true? */
5087 hub
->limited_power
= 1;
5089 hub
->limited_power
= 0;
5091 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
5095 dev_dbg(hub_dev
, "over-current change\n");
5096 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
5097 msleep(500); /* Cool down */
5098 hub_power_on(hub
, true);
5099 hub_hub_status(hub
, &status
, &unused
);
5100 if (status
& HUB_STATUS_OVERCURRENT
)
5101 dev_err(hub_dev
, "over-current condition\n");
5106 /* Balance the usb_autopm_get_interface() above */
5107 usb_autopm_put_interface_no_suspend(intf
);
5109 usb_unlock_device(hdev
);
5111 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5112 usb_autopm_put_interface(intf
);
5113 kref_put(&hub
->kref
, hub_release
);
5116 static const struct usb_device_id hub_id_table
[] = {
5117 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
5118 | USB_DEVICE_ID_MATCH_INT_CLASS
,
5119 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
5120 .bInterfaceClass
= USB_CLASS_HUB
,
5121 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
5122 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
5123 .bDeviceClass
= USB_CLASS_HUB
},
5124 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
5125 .bInterfaceClass
= USB_CLASS_HUB
},
5126 { } /* Terminating entry */
5129 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
5131 static struct usb_driver hub_driver
= {
5134 .disconnect
= hub_disconnect
,
5135 .suspend
= hub_suspend
,
5136 .resume
= hub_resume
,
5137 .reset_resume
= hub_reset_resume
,
5138 .pre_reset
= hub_pre_reset
,
5139 .post_reset
= hub_post_reset
,
5140 .unlocked_ioctl
= hub_ioctl
,
5141 .id_table
= hub_id_table
,
5142 .supports_autosuspend
= 1,
5145 int usb_hub_init(void)
5147 if (usb_register(&hub_driver
) < 0) {
5148 printk(KERN_ERR
"%s: can't register hub driver\n",
5154 * The workqueue needs to be freezable to avoid interfering with
5155 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5156 * device was gone before the EHCI controller had handed its port
5157 * over to the companion full-speed controller.
5159 hub_wq
= alloc_workqueue("usb_hub_wq", WQ_FREEZABLE
, 0);
5163 /* Fall through if kernel_thread failed */
5164 usb_deregister(&hub_driver
);
5165 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name
);
5170 void usb_hub_cleanup(void)
5172 destroy_workqueue(hub_wq
);
5175 * Hub resources are freed for us by usb_deregister. It calls
5176 * usb_driver_purge on every device which in turn calls that
5177 * devices disconnect function if it is using this driver.
5178 * The hub_disconnect function takes care of releasing the
5179 * individual hub resources. -greg
5181 usb_deregister(&hub_driver
);
5182 } /* usb_hub_cleanup() */
5184 static int descriptors_changed(struct usb_device
*udev
,
5185 struct usb_device_descriptor
*old_device_descriptor
,
5186 struct usb_host_bos
*old_bos
)
5190 unsigned serial_len
= 0;
5192 unsigned old_length
;
5196 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5197 sizeof(*old_device_descriptor
)) != 0)
5200 if ((old_bos
&& !udev
->bos
) || (!old_bos
&& udev
->bos
))
5203 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
5204 if (len
!= le16_to_cpu(old_bos
->desc
->wTotalLength
))
5206 if (memcmp(udev
->bos
->desc
, old_bos
->desc
, len
))
5210 /* Since the idVendor, idProduct, and bcdDevice values in the
5211 * device descriptor haven't changed, we will assume the
5212 * Manufacturer and Product strings haven't changed either.
5213 * But the SerialNumber string could be different (e.g., a
5214 * different flash card of the same brand).
5217 serial_len
= strlen(udev
->serial
) + 1;
5220 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5221 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5222 len
= max(len
, old_length
);
5225 buf
= kmalloc(len
, GFP_NOIO
);
5227 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5228 /* assume the worst */
5231 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5232 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5233 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5235 if (length
!= old_length
) {
5236 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5241 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5243 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5245 ((struct usb_config_descriptor
*) buf
)->
5246 bConfigurationValue
);
5252 if (!changed
&& serial_len
) {
5253 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5255 if (length
+ 1 != serial_len
) {
5256 dev_dbg(&udev
->dev
, "serial string error %d\n",
5259 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5260 dev_dbg(&udev
->dev
, "serial string changed\n");
5270 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5271 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5273 * WARNING - don't use this routine to reset a composite device
5274 * (one with multiple interfaces owned by separate drivers)!
5275 * Use usb_reset_device() instead.
5277 * Do a port reset, reassign the device's address, and establish its
5278 * former operating configuration. If the reset fails, or the device's
5279 * descriptors change from their values before the reset, or the original
5280 * configuration and altsettings cannot be restored, a flag will be set
5281 * telling hub_wq to pretend the device has been disconnected and then
5282 * re-connected. All drivers will be unbound, and the device will be
5283 * re-enumerated and probed all over again.
5285 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5286 * flagged for logical disconnection, or some other negative error code
5287 * if the reset wasn't even attempted.
5290 * The caller must own the device lock and the port lock, the latter is
5291 * taken by usb_reset_device(). For example, it's safe to use
5292 * usb_reset_device() from a driver probe() routine after downloading
5293 * new firmware. For calls that might not occur during probe(), drivers
5294 * should lock the device using usb_lock_device_for_reset().
5296 * Locking exception: This routine may also be called from within an
5297 * autoresume handler. Such usage won't conflict with other tasks
5298 * holding the device lock because these tasks should always call
5299 * usb_autopm_resume_device(), thereby preventing any unwanted
5300 * autoresume. The autoresume handler is expected to have already
5301 * acquired the port lock before calling this routine.
5303 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5305 struct usb_device
*parent_hdev
= udev
->parent
;
5306 struct usb_hub
*parent_hub
;
5307 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5308 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5309 struct usb_host_bos
*bos
;
5311 int port1
= udev
->portnum
;
5313 if (udev
->state
== USB_STATE_NOTATTACHED
||
5314 udev
->state
== USB_STATE_SUSPENDED
) {
5315 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5323 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5325 /* Disable USB2 hardware LPM.
5326 * It will be re-enabled by the enumeration process.
5328 if (udev
->usb2_hw_lpm_enabled
== 1)
5329 usb_set_usb2_hardware_lpm(udev
, 0);
5334 /* Disable LPM and LTM while we reset the device and reinstall the alt
5335 * settings. Device-initiated LPM settings, and system exit latency
5336 * settings are cleared when the device is reset, so we have to set
5339 ret
= usb_unlocked_disable_lpm(udev
);
5341 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5344 ret
= usb_disable_ltm(udev
);
5346 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5351 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5353 /* ep0 maxpacket size may change; let the HCD know about it.
5354 * Other endpoints will be handled by re-enumeration. */
5355 usb_ep0_reinit(udev
);
5356 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5357 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5364 /* Device might have changed firmware (DFU or similar) */
5365 if (descriptors_changed(udev
, &descriptor
, bos
)) {
5366 dev_info(&udev
->dev
, "device firmware changed\n");
5367 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5371 /* Restore the device's previous configuration */
5372 if (!udev
->actconfig
)
5375 mutex_lock(hcd
->bandwidth_mutex
);
5376 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5378 dev_warn(&udev
->dev
,
5379 "Busted HC? Not enough HCD resources for "
5380 "old configuration.\n");
5381 mutex_unlock(hcd
->bandwidth_mutex
);
5384 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5385 USB_REQ_SET_CONFIGURATION
, 0,
5386 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5387 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5390 "can't restore configuration #%d (error=%d)\n",
5391 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5392 mutex_unlock(hcd
->bandwidth_mutex
);
5395 mutex_unlock(hcd
->bandwidth_mutex
);
5396 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5398 /* Put interfaces back into the same altsettings as before.
5399 * Don't bother to send the Set-Interface request for interfaces
5400 * that were already in altsetting 0; besides being unnecessary,
5401 * many devices can't handle it. Instead just reset the host-side
5404 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5405 struct usb_host_config
*config
= udev
->actconfig
;
5406 struct usb_interface
*intf
= config
->interface
[i
];
5407 struct usb_interface_descriptor
*desc
;
5409 desc
= &intf
->cur_altsetting
->desc
;
5410 if (desc
->bAlternateSetting
== 0) {
5411 usb_disable_interface(udev
, intf
, true);
5412 usb_enable_interface(udev
, intf
, true);
5415 /* Let the bandwidth allocation function know that this
5416 * device has been reset, and it will have to use
5417 * alternate setting 0 as the current alternate setting.
5419 intf
->resetting_device
= 1;
5420 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5421 desc
->bAlternateSetting
);
5422 intf
->resetting_device
= 0;
5425 dev_err(&udev
->dev
, "failed to restore interface %d "
5426 "altsetting %d (error=%d)\n",
5427 desc
->bInterfaceNumber
,
5428 desc
->bAlternateSetting
,
5432 /* Resetting also frees any allocated streams */
5433 for (j
= 0; j
< intf
->cur_altsetting
->desc
.bNumEndpoints
; j
++)
5434 intf
->cur_altsetting
->endpoint
[j
].streams
= 0;
5438 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5439 usb_set_usb2_hardware_lpm(udev
, 1);
5440 usb_unlocked_enable_lpm(udev
);
5441 usb_enable_ltm(udev
);
5442 usb_release_bos_descriptor(udev
);
5447 /* LPM state doesn't matter when we're about to destroy the device. */
5448 hub_port_logical_disconnect(parent_hub
, port1
);
5449 usb_release_bos_descriptor(udev
);
5455 * usb_reset_device - warn interface drivers and perform a USB port reset
5456 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5458 * Warns all drivers bound to registered interfaces (using their pre_reset
5459 * method), performs the port reset, and then lets the drivers know that
5460 * the reset is over (using their post_reset method).
5462 * Return: The same as for usb_reset_and_verify_device().
5465 * The caller must own the device lock. For example, it's safe to use
5466 * this from a driver probe() routine after downloading new firmware.
5467 * For calls that might not occur during probe(), drivers should lock
5468 * the device using usb_lock_device_for_reset().
5470 * If an interface is currently being probed or disconnected, we assume
5471 * its driver knows how to handle resets. For all other interfaces,
5472 * if the driver doesn't have pre_reset and post_reset methods then
5473 * we attempt to unbind it and rebind afterward.
5475 int usb_reset_device(struct usb_device
*udev
)
5479 unsigned int noio_flag
;
5480 struct usb_port
*port_dev
;
5481 struct usb_host_config
*config
= udev
->actconfig
;
5482 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
5484 if (udev
->state
== USB_STATE_NOTATTACHED
||
5485 udev
->state
== USB_STATE_SUSPENDED
) {
5486 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5491 if (!udev
->parent
) {
5492 /* this requires hcd-specific logic; see ohci_restart() */
5493 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5497 port_dev
= hub
->ports
[udev
->portnum
- 1];
5500 * Don't allocate memory with GFP_KERNEL in current
5501 * context to avoid possible deadlock if usb mass
5502 * storage interface or usbnet interface(iSCSI case)
5503 * is included in current configuration. The easist
5504 * approach is to do it for every device reset,
5505 * because the device 'memalloc_noio' flag may have
5506 * not been set before reseting the usb device.
5508 noio_flag
= memalloc_noio_save();
5510 /* Prevent autosuspend during the reset */
5511 usb_autoresume_device(udev
);
5514 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5515 struct usb_interface
*cintf
= config
->interface
[i
];
5516 struct usb_driver
*drv
;
5519 if (cintf
->dev
.driver
) {
5520 drv
= to_usb_driver(cintf
->dev
.driver
);
5521 if (drv
->pre_reset
&& drv
->post_reset
)
5522 unbind
= (drv
->pre_reset
)(cintf
);
5523 else if (cintf
->condition
==
5524 USB_INTERFACE_BOUND
)
5527 usb_forced_unbind_intf(cintf
);
5532 usb_lock_port(port_dev
);
5533 ret
= usb_reset_and_verify_device(udev
);
5534 usb_unlock_port(port_dev
);
5537 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5538 struct usb_interface
*cintf
= config
->interface
[i
];
5539 struct usb_driver
*drv
;
5540 int rebind
= cintf
->needs_binding
;
5542 if (!rebind
&& cintf
->dev
.driver
) {
5543 drv
= to_usb_driver(cintf
->dev
.driver
);
5544 if (drv
->post_reset
)
5545 rebind
= (drv
->post_reset
)(cintf
);
5546 else if (cintf
->condition
==
5547 USB_INTERFACE_BOUND
)
5550 cintf
->needs_binding
= 1;
5553 usb_unbind_and_rebind_marked_interfaces(udev
);
5556 usb_autosuspend_device(udev
);
5557 memalloc_noio_restore(noio_flag
);
5560 EXPORT_SYMBOL_GPL(usb_reset_device
);
5564 * usb_queue_reset_device - Reset a USB device from an atomic context
5565 * @iface: USB interface belonging to the device to reset
5567 * This function can be used to reset a USB device from an atomic
5568 * context, where usb_reset_device() won't work (as it blocks).
5570 * Doing a reset via this method is functionally equivalent to calling
5571 * usb_reset_device(), except for the fact that it is delayed to a
5572 * workqueue. This means that any drivers bound to other interfaces
5573 * might be unbound, as well as users from usbfs in user space.
5577 * - Scheduling two resets at the same time from two different drivers
5578 * attached to two different interfaces of the same device is
5579 * possible; depending on how the driver attached to each interface
5580 * handles ->pre_reset(), the second reset might happen or not.
5582 * - If the reset is delayed so long that the interface is unbound from
5583 * its driver, the reset will be skipped.
5585 * - This function can be called during .probe(). It can also be called
5586 * during .disconnect(), but doing so is pointless because the reset
5587 * will not occur. If you really want to reset the device during
5588 * .disconnect(), call usb_reset_device() directly -- but watch out
5589 * for nested unbinding issues!
5591 void usb_queue_reset_device(struct usb_interface
*iface
)
5593 if (schedule_work(&iface
->reset_ws
))
5594 usb_get_intf(iface
);
5596 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5599 * usb_hub_find_child - Get the pointer of child device
5600 * attached to the port which is specified by @port1.
5601 * @hdev: USB device belonging to the usb hub
5602 * @port1: port num to indicate which port the child device
5605 * USB drivers call this function to get hub's child device
5608 * Return: %NULL if input param is invalid and
5609 * child's usb_device pointer if non-NULL.
5611 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5614 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5616 if (port1
< 1 || port1
> hdev
->maxchild
)
5618 return hub
->ports
[port1
- 1]->child
;
5620 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5622 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5623 struct usb_hub_descriptor
*desc
)
5625 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5626 enum usb_port_connect_type connect_type
;
5632 if (!hub_is_superspeed(hdev
)) {
5633 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5634 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5636 connect_type
= port_dev
->connect_type
;
5637 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5638 u8 mask
= 1 << (i
%8);
5640 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5641 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5642 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5647 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5649 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5650 struct usb_port
*port_dev
= hub
->ports
[i
- 1];
5652 connect_type
= port_dev
->connect_type
;
5653 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5656 if (!(port_removable
& mask
)) {
5657 dev_dbg(&port_dev
->dev
, "DeviceRemovable is changed to 1 according to platform information.\n");
5658 port_removable
|= mask
;
5663 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5669 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5670 * @hdev: USB device belonging to the usb hub
5671 * @port1: port num of the port
5673 * Return: Port's acpi handle if successful, %NULL if params are
5676 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5679 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5684 return ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);