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/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 /* if we are in debug mode, always announce new devices */
38 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
39 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
43 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
44 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
46 static inline int hub_is_superspeed(struct usb_device
*hdev
)
48 return (hdev
->descriptor
.bDeviceProtocol
== USB_HUB_PR_SS
);
51 /* Protect struct usb_device->state and ->children members
52 * Note: Both are also protected by ->dev.sem, except that ->state can
53 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
54 static DEFINE_SPINLOCK(device_state_lock
);
56 /* khubd's worklist and its lock */
57 static DEFINE_SPINLOCK(hub_event_lock
);
58 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
61 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
63 static struct task_struct
*khubd_task
;
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights
= 0;
67 module_param (blinkenlights
, bool, S_IRUGO
);
68 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
76 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
77 MODULE_PARM_DESC(initial_descriptor_timeout
,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first
= 0;
96 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
97 MODULE_PARM_DESC(old_scheme_first
,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes
= 1;
101 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
102 MODULE_PARM_DESC(use_both_schemes
,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static int usb_reset_and_verify_device(struct usb_device
*udev
);
118 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
120 if (hub_is_superspeed(hub
->hdev
))
122 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
124 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
130 /* Note that hdev or one of its children must be locked! */
131 struct usb_hub
*usb_hub_to_struct_hub(struct usb_device
*hdev
)
133 if (!hdev
|| !hdev
->actconfig
|| !hdev
->maxchild
)
135 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
138 static int usb_device_supports_lpm(struct usb_device
*udev
)
140 /* Some devices have trouble with LPM */
141 if (udev
->quirks
& USB_QUIRK_NO_LPM
)
144 /* USB 2.1 (and greater) devices indicate LPM support through
145 * their USB 2.0 Extended Capabilities BOS descriptor.
147 if (udev
->speed
== USB_SPEED_HIGH
) {
148 if (udev
->bos
->ext_cap
&&
150 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
155 /* All USB 3.0 must support LPM, but we need their max exit latency
156 * information from the SuperSpeed Extended Capabilities BOS descriptor.
158 if (!udev
->bos
->ss_cap
) {
159 dev_warn(&udev
->dev
, "No LPM exit latency info found. "
160 "Power management will be impacted.\n");
163 if (udev
->parent
->lpm_capable
)
166 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
167 "Power management will be impacted.\n");
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device
*udev
,
176 struct usb3_lpm_parameters
*udev_lpm_params
,
177 unsigned int udev_exit_latency
,
179 struct usb3_lpm_parameters
*hub_lpm_params
,
180 unsigned int hub_exit_latency
)
182 unsigned int total_mel
;
183 unsigned int device_mel
;
184 unsigned int hub_mel
;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel
= hub_lpm_params
->mel
+
196 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel
= udev_exit_latency
* 1000;
207 hub_mel
= hub_exit_latency
* 1000;
208 if (device_mel
> hub_mel
)
209 total_mel
+= device_mel
;
211 total_mel
+= hub_mel
;
213 udev_lpm_params
->mel
= total_mel
;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device
*udev
,
221 struct usb3_lpm_parameters
*udev_lpm_params
,
222 unsigned int udev_exit_latency
,
224 struct usb3_lpm_parameters
*hub_lpm_params
,
225 unsigned int hub_exit_latency
,
226 unsigned int port_to_port_exit_latency
)
228 unsigned int first_link_pel
;
229 unsigned int hub_pel
;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency
> hub_exit_latency
)
237 first_link_pel
= udev_exit_latency
* 1000;
239 first_link_pel
= hub_exit_latency
* 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel
> hub_pel
)
254 udev_lpm_params
->pel
= first_link_pel
;
256 udev_lpm_params
->pel
= hub_pel
;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device
*udev
,
275 struct usb3_lpm_parameters
*udev_lpm_params
)
277 struct usb_device
*parent
;
278 unsigned int num_hubs
;
279 unsigned int total_sel
;
281 /* t1 = device PEL */
282 total_sel
= udev_lpm_params
->pel
;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
285 parent
= parent
->parent
)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel
+= 2100 + 250 * (num_hubs
- 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel
+= 250 * num_hubs
;
294 udev_lpm_params
->sel
= total_sel
;
297 static void usb_set_lpm_parameters(struct usb_device
*udev
)
300 unsigned int port_to_port_delay
;
301 unsigned int udev_u1_del
;
302 unsigned int udev_u2_del
;
303 unsigned int hub_u1_del
;
304 unsigned int hub_u2_del
;
306 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
309 hub
= usb_hub_to_struct_hub(udev
->parent
);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
317 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
318 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
319 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
321 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
322 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
324 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
325 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay
= 1;
346 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
347 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
350 if (hub_u2_del
> hub_u1_del
)
351 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
353 port_to_port_delay
= 1 + hub_u1_del
;
355 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
356 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev
, &udev
->u1_params
);
361 usb_set_lpm_sel(udev
, &udev
->u2_params
);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
370 if (hub_is_superspeed(hdev
)) {
371 dtype
= USB_DT_SS_HUB
;
372 size
= USB_DT_SS_HUB_SIZE
;
375 size
= sizeof(struct usb_hub_descriptor
);
378 for (i
= 0; i
< 3; i
++) {
379 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
380 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
381 dtype
<< 8, 0, data
, size
,
382 USB_CTRL_GET_TIMEOUT
);
383 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
390 * USB 2.0 spec Section 11.24.2.1
392 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
394 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
395 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
399 * USB 2.0 spec Section 11.24.2.2
401 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
403 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
404 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
409 * USB 2.0 spec Section 11.24.2.13
411 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
413 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
414 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
419 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
420 * for info about using port indicators
422 static void set_port_led(
428 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
429 USB_PORT_FEAT_INDICATOR
);
431 dev_dbg (hub
->intfdev
,
432 "port %d indicator %s status %d\n",
434 ({ char *s
; switch (selector
) {
435 case HUB_LED_AMBER
: s
= "amber"; break;
436 case HUB_LED_GREEN
: s
= "green"; break;
437 case HUB_LED_OFF
: s
= "off"; break;
438 case HUB_LED_AUTO
: s
= "auto"; break;
439 default: s
= "??"; break;
444 #define LED_CYCLE_PERIOD ((2*HZ)/3)
446 static void led_work (struct work_struct
*work
)
448 struct usb_hub
*hub
=
449 container_of(work
, struct usb_hub
, leds
.work
);
450 struct usb_device
*hdev
= hub
->hdev
;
452 unsigned changed
= 0;
455 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
458 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
459 unsigned selector
, mode
;
461 /* 30%-50% duty cycle */
463 switch (hub
->indicator
[i
]) {
465 case INDICATOR_CYCLE
:
467 selector
= HUB_LED_AUTO
;
468 mode
= INDICATOR_AUTO
;
470 /* blinking green = sw attention */
471 case INDICATOR_GREEN_BLINK
:
472 selector
= HUB_LED_GREEN
;
473 mode
= INDICATOR_GREEN_BLINK_OFF
;
475 case INDICATOR_GREEN_BLINK_OFF
:
476 selector
= HUB_LED_OFF
;
477 mode
= INDICATOR_GREEN_BLINK
;
479 /* blinking amber = hw attention */
480 case INDICATOR_AMBER_BLINK
:
481 selector
= HUB_LED_AMBER
;
482 mode
= INDICATOR_AMBER_BLINK_OFF
;
484 case INDICATOR_AMBER_BLINK_OFF
:
485 selector
= HUB_LED_OFF
;
486 mode
= INDICATOR_AMBER_BLINK
;
488 /* blink green/amber = reserved */
489 case INDICATOR_ALT_BLINK
:
490 selector
= HUB_LED_GREEN
;
491 mode
= INDICATOR_ALT_BLINK_OFF
;
493 case INDICATOR_ALT_BLINK_OFF
:
494 selector
= HUB_LED_AMBER
;
495 mode
= INDICATOR_ALT_BLINK
;
500 if (selector
!= HUB_LED_AUTO
)
502 set_port_led(hub
, i
+ 1, selector
);
503 hub
->indicator
[i
] = mode
;
505 if (!changed
&& blinkenlights
) {
507 cursor
%= hub
->descriptor
->bNbrPorts
;
508 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
509 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
513 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
516 /* use a short timeout for hub/port status fetches */
517 #define USB_STS_TIMEOUT 1000
518 #define USB_STS_RETRIES 5
521 * USB 2.0 spec Section 11.24.2.6
523 static int get_hub_status(struct usb_device
*hdev
,
524 struct usb_hub_status
*data
)
526 int i
, status
= -ETIMEDOUT
;
528 for (i
= 0; i
< USB_STS_RETRIES
&&
529 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
530 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
531 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
532 data
, sizeof(*data
), USB_STS_TIMEOUT
);
538 * USB 2.0 spec Section 11.24.2.7
540 static int get_port_status(struct usb_device
*hdev
, int port1
,
541 struct usb_port_status
*data
)
543 int i
, status
= -ETIMEDOUT
;
545 for (i
= 0; i
< USB_STS_RETRIES
&&
546 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
547 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
548 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
549 data
, sizeof(*data
), USB_STS_TIMEOUT
);
554 static int hub_port_status(struct usb_hub
*hub
, int port1
,
555 u16
*status
, u16
*change
)
559 mutex_lock(&hub
->status_mutex
);
560 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
563 dev_err(hub
->intfdev
,
564 "%s failed (err = %d)\n", __func__
, ret
);
568 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
569 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
573 mutex_unlock(&hub
->status_mutex
);
577 static void kick_khubd(struct usb_hub
*hub
)
581 spin_lock_irqsave(&hub_event_lock
, flags
);
582 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
583 list_add_tail(&hub
->event_list
, &hub_event_list
);
585 /* Suppress autosuspend until khubd runs */
586 usb_autopm_get_interface_no_resume(
587 to_usb_interface(hub
->intfdev
));
588 wake_up(&khubd_wait
);
590 spin_unlock_irqrestore(&hub_event_lock
, flags
);
593 void usb_kick_khubd(struct usb_device
*hdev
)
595 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
602 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
603 * Notification, which indicates it had initiated remote wakeup.
605 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
606 * device initiates resume, so the USB core will not receive notice of the
607 * resume through the normal hub interrupt URB.
609 void usb_wakeup_notification(struct usb_device
*hdev
,
610 unsigned int portnum
)
617 hub
= usb_hub_to_struct_hub(hdev
);
619 set_bit(portnum
, hub
->wakeup_bits
);
623 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
625 /* completion function, fires on port status changes and various faults */
626 static void hub_irq(struct urb
*urb
)
628 struct usb_hub
*hub
= urb
->context
;
629 int status
= urb
->status
;
634 case -ENOENT
: /* synchronous unlink */
635 case -ECONNRESET
: /* async unlink */
636 case -ESHUTDOWN
: /* hardware going away */
639 default: /* presumably an error */
640 /* Cause a hub reset after 10 consecutive errors */
641 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
642 if ((++hub
->nerrors
< 10) || hub
->error
)
647 /* let khubd handle things */
648 case 0: /* we got data: port status changed */
650 for (i
= 0; i
< urb
->actual_length
; ++i
)
651 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
653 hub
->event_bits
[0] = bits
;
659 /* Something happened, let khubd figure it out */
666 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
667 && status
!= -ENODEV
&& status
!= -EPERM
)
668 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
671 /* USB 2.0 spec Section 11.24.2.3 */
673 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
675 /* Need to clear both directions for control ep */
676 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
677 USB_ENDPOINT_XFER_CONTROL
) {
678 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
679 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
680 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
684 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
685 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
690 * enumeration blocks khubd for a long time. we use keventd instead, since
691 * long blocking there is the exception, not the rule. accordingly, HCDs
692 * talking to TTs must queue control transfers (not just bulk and iso), so
693 * both can talk to the same hub concurrently.
695 static void hub_tt_work(struct work_struct
*work
)
697 struct usb_hub
*hub
=
698 container_of(work
, struct usb_hub
, tt
.clear_work
);
701 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
702 while (!list_empty(&hub
->tt
.clear_list
)) {
703 struct list_head
*next
;
704 struct usb_tt_clear
*clear
;
705 struct usb_device
*hdev
= hub
->hdev
;
706 const struct hc_driver
*drv
;
709 next
= hub
->tt
.clear_list
.next
;
710 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
711 list_del (&clear
->clear_list
);
713 /* drop lock so HCD can concurrently report other TT errors */
714 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
715 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
716 if (status
&& status
!= -ENODEV
)
718 "clear tt %d (%04x) error %d\n",
719 clear
->tt
, clear
->devinfo
, status
);
721 /* Tell the HCD, even if the operation failed */
722 drv
= clear
->hcd
->driver
;
723 if (drv
->clear_tt_buffer_complete
)
724 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
727 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
729 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
733 * usb_hub_set_port_power - control hub port's power state
736 * @set: expected status
738 * call this function to control port's power via setting or
739 * clearing the port's PORT_POWER feature.
741 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
745 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
746 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
749 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
751 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
754 port_dev
->power_is_on
= set
;
759 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
760 * @urb: an URB associated with the failed or incomplete split transaction
762 * High speed HCDs use this to tell the hub driver that some split control or
763 * bulk transaction failed in a way that requires clearing internal state of
764 * a transaction translator. This is normally detected (and reported) from
767 * It may not be possible for that hub to handle additional full (or low)
768 * speed transactions until that state is fully cleared out.
770 int usb_hub_clear_tt_buffer(struct urb
*urb
)
772 struct usb_device
*udev
= urb
->dev
;
773 int pipe
= urb
->pipe
;
774 struct usb_tt
*tt
= udev
->tt
;
776 struct usb_tt_clear
*clear
;
778 /* we've got to cope with an arbitrary number of pending TT clears,
779 * since each TT has "at least two" buffers that can need it (and
780 * there can be many TTs per hub). even if they're uncommon.
782 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
783 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
784 /* FIXME recover somehow ... RESET_TT? */
788 /* info that CLEAR_TT_BUFFER needs */
789 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
790 clear
->devinfo
= usb_pipeendpoint (pipe
);
791 clear
->devinfo
|= udev
->devnum
<< 4;
792 clear
->devinfo
|= usb_pipecontrol (pipe
)
793 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
794 : (USB_ENDPOINT_XFER_BULK
<< 11);
795 if (usb_pipein (pipe
))
796 clear
->devinfo
|= 1 << 15;
798 /* info for completion callback */
799 clear
->hcd
= bus_to_hcd(udev
->bus
);
802 /* tell keventd to clear state for this TT */
803 spin_lock_irqsave (&tt
->lock
, flags
);
804 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
805 schedule_work(&tt
->clear_work
);
806 spin_unlock_irqrestore (&tt
->lock
, flags
);
809 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
811 /* If do_delay is false, return the number of milliseconds the caller
814 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
817 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
819 u16 wHubCharacteristics
=
820 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
822 /* Enable power on each port. Some hubs have reserved values
823 * of LPSM (> 2) in their descriptors, even though they are
824 * USB 2.0 hubs. Some hubs do not implement port-power switching
825 * but only emulate it. In all cases, the ports won't work
826 * unless we send these messages to the hub.
828 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
829 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
831 dev_dbg(hub
->intfdev
, "trying to enable port power on "
832 "non-switchable hub\n");
833 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
834 if (hub
->ports
[port1
- 1]->power_is_on
)
835 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
837 usb_clear_port_feature(hub
->hdev
, port1
,
838 USB_PORT_FEAT_POWER
);
840 /* Wait at least 100 msec for power to become stable */
841 delay
= max(pgood_delay
, (unsigned) 100);
847 static int hub_hub_status(struct usb_hub
*hub
,
848 u16
*status
, u16
*change
)
852 mutex_lock(&hub
->status_mutex
);
853 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
856 dev_err(hub
->intfdev
,
857 "%s failed (err = %d)\n", __func__
, ret
);
859 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
860 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
863 mutex_unlock(&hub
->status_mutex
);
867 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
868 unsigned int link_status
)
870 return set_port_feature(hub
->hdev
,
871 port1
| (link_status
<< 3),
872 USB_PORT_FEAT_LINK_STATE
);
876 * If USB 3.0 ports are placed into the Disabled state, they will no longer
877 * detect any device connects or disconnects. This is generally not what the
878 * USB core wants, since it expects a disabled port to produce a port status
879 * change event when a new device connects.
881 * Instead, set the link state to Disabled, wait for the link to settle into
882 * that state, clear any change bits, and then put the port into the RxDetect
885 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
889 u16 portchange
, portstatus
;
891 if (!hub_is_superspeed(hub
->hdev
))
894 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
899 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
900 * Controller [1022:7814] will have spurious result making the following
901 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
902 * as high-speed device if we set the usb 3.0 port link state to
903 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
904 * check the state here to avoid the bug.
906 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
907 USB_SS_PORT_LS_RX_DETECT
) {
908 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
909 "Not disabling port; link state is RxDetect\n");
913 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
917 /* Wait for the link to enter the disabled state. */
918 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
919 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
923 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
924 USB_SS_PORT_LS_SS_DISABLED
)
926 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
928 msleep(HUB_DEBOUNCE_STEP
);
930 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
931 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
934 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
937 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
939 struct usb_device
*hdev
= hub
->hdev
;
942 if (hub
->ports
[port1
- 1]->child
&& set_state
)
943 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
944 USB_STATE_NOTATTACHED
);
946 if (hub_is_superspeed(hub
->hdev
))
947 ret
= hub_usb3_port_disable(hub
, port1
);
949 ret
= usb_clear_port_feature(hdev
, port1
,
950 USB_PORT_FEAT_ENABLE
);
952 if (ret
&& ret
!= -ENODEV
)
953 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
959 * Disable a port and mark a logical connect-change event, so that some
960 * time later khubd will disconnect() any existing usb_device on the port
961 * and will re-enumerate if there actually is a device attached.
963 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
965 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
966 hub_port_disable(hub
, port1
, 1);
968 /* FIXME let caller ask to power down the port:
969 * - some devices won't enumerate without a VBUS power cycle
970 * - SRP saves power that way
971 * - ... new call, TBD ...
972 * That's easy if this hub can switch power per-port, and
973 * khubd reactivates the port later (timer, SRP, etc).
974 * Powerdown must be optional, because of reset/DFU.
977 set_bit(port1
, hub
->change_bits
);
982 * usb_remove_device - disable a device's port on its parent hub
983 * @udev: device to be disabled and removed
984 * Context: @udev locked, must be able to sleep.
986 * After @udev's port has been disabled, khubd is notified and it will
987 * see that the device has been disconnected. When the device is
988 * physically unplugged and something is plugged in, the events will
989 * be received and processed normally.
991 int usb_remove_device(struct usb_device
*udev
)
994 struct usb_interface
*intf
;
996 if (!udev
->parent
) /* Can't remove a root hub */
998 hub
= usb_hub_to_struct_hub(udev
->parent
);
999 intf
= to_usb_interface(hub
->intfdev
);
1001 usb_autopm_get_interface(intf
);
1002 set_bit(udev
->portnum
, hub
->removed_bits
);
1003 hub_port_logical_disconnect(hub
, udev
->portnum
);
1004 usb_autopm_put_interface(intf
);
1008 enum hub_activation_type
{
1009 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1010 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1013 static void hub_init_func2(struct work_struct
*ws
);
1014 static void hub_init_func3(struct work_struct
*ws
);
1016 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1018 struct usb_device
*hdev
= hub
->hdev
;
1019 struct usb_hcd
*hcd
;
1023 bool need_debounce_delay
= false;
1026 /* Continue a partial initialization */
1027 if (type
== HUB_INIT2
)
1029 if (type
== HUB_INIT3
)
1032 /* The superspeed hub except for root hub has to use Hub Depth
1033 * value as an offset into the route string to locate the bits
1034 * it uses to determine the downstream port number. So hub driver
1035 * should send a set hub depth request to superspeed hub after
1036 * the superspeed hub is set configuration in initialization or
1039 * After a resume, port power should still be on.
1040 * For any other type of activation, turn it on.
1042 if (type
!= HUB_RESUME
) {
1043 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1044 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1045 HUB_SET_DEPTH
, USB_RT_HUB
,
1046 hdev
->level
- 1, 0, NULL
, 0,
1047 USB_CTRL_SET_TIMEOUT
);
1049 dev_err(hub
->intfdev
,
1050 "set hub depth failed\n");
1053 /* Speed up system boot by using a delayed_work for the
1054 * hub's initial power-up delays. This is pretty awkward
1055 * and the implementation looks like a home-brewed sort of
1056 * setjmp/longjmp, but it saves at least 100 ms for each
1057 * root hub (assuming usbcore is compiled into the kernel
1058 * rather than as a module). It adds up.
1060 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1061 * because for those activation types the ports have to be
1062 * operational when we return. In theory this could be done
1063 * for HUB_POST_RESET, but it's easier not to.
1065 if (type
== HUB_INIT
) {
1066 delay
= hub_power_on(hub
, false);
1067 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1068 schedule_delayed_work(&hub
->init_work
,
1069 msecs_to_jiffies(delay
));
1071 /* Suppress autosuspend until init is done */
1072 usb_autopm_get_interface_no_resume(
1073 to_usb_interface(hub
->intfdev
));
1074 return; /* Continues at init2: below */
1075 } else if (type
== HUB_RESET_RESUME
) {
1076 /* The internal host controller state for the hub device
1077 * may be gone after a host power loss on system resume.
1078 * Update the device's info so the HW knows it's a hub.
1080 hcd
= bus_to_hcd(hdev
->bus
);
1081 if (hcd
->driver
->update_hub_device
) {
1082 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1083 &hub
->tt
, GFP_NOIO
);
1085 dev_err(hub
->intfdev
, "Host not "
1086 "accepting hub info "
1088 dev_err(hub
->intfdev
, "LS/FS devices "
1089 "and hubs may not work "
1090 "under this hub\n.");
1093 hub_power_on(hub
, true);
1095 hub_power_on(hub
, true);
1100 /* Check each port and set hub->change_bits to let khubd know
1101 * which ports need attention.
1103 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1104 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1105 u16 portstatus
, portchange
;
1107 portstatus
= portchange
= 0;
1108 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1109 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1110 dev_dbg(hub
->intfdev
,
1111 "port %d: status %04x change %04x\n",
1112 port1
, portstatus
, portchange
);
1114 /* After anything other than HUB_RESUME (i.e., initialization
1115 * or any sort of reset), every port should be disabled.
1116 * Unconnected ports should likewise be disabled (paranoia),
1117 * and so should ports for which we have no usb_device.
1119 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1120 type
!= HUB_RESUME
||
1121 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1123 udev
->state
== USB_STATE_NOTATTACHED
)) {
1125 * USB3 protocol ports will automatically transition
1126 * to Enabled state when detect an USB3.0 device attach.
1127 * Do not disable USB3 protocol ports.
1129 if (!hub_is_superspeed(hdev
)) {
1130 usb_clear_port_feature(hdev
, port1
,
1131 USB_PORT_FEAT_ENABLE
);
1132 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1134 /* Pretend that power was lost for USB3 devs */
1135 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1139 /* Clear status-change flags; we'll debounce later */
1140 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1141 need_debounce_delay
= true;
1142 usb_clear_port_feature(hub
->hdev
, port1
,
1143 USB_PORT_FEAT_C_CONNECTION
);
1145 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1146 need_debounce_delay
= true;
1147 usb_clear_port_feature(hub
->hdev
, port1
,
1148 USB_PORT_FEAT_C_ENABLE
);
1150 if (portchange
& USB_PORT_STAT_C_RESET
) {
1151 need_debounce_delay
= true;
1152 usb_clear_port_feature(hub
->hdev
, port1
,
1153 USB_PORT_FEAT_C_RESET
);
1155 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1156 hub_is_superspeed(hub
->hdev
)) {
1157 need_debounce_delay
= true;
1158 usb_clear_port_feature(hub
->hdev
, port1
,
1159 USB_PORT_FEAT_C_BH_PORT_RESET
);
1161 /* We can forget about a "removed" device when there's a
1162 * physical disconnect or the connect status changes.
1164 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1165 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1166 clear_bit(port1
, hub
->removed_bits
);
1168 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1169 /* Tell khubd to disconnect the device or
1170 * check for a new connection
1172 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
) ||
1173 (portstatus
& USB_PORT_STAT_OVERCURRENT
))
1174 set_bit(port1
, hub
->change_bits
);
1176 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1177 bool port_resumed
= (portstatus
&
1178 USB_PORT_STAT_LINK_STATE
) ==
1180 /* The power session apparently survived the resume.
1181 * If there was an overcurrent or suspend change
1182 * (i.e., remote wakeup request), have khubd
1183 * take care of it. Look at the port link state
1184 * for USB 3.0 hubs, since they don't have a suspend
1185 * change bit, and they don't set the port link change
1186 * bit on device-initiated resume.
1188 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1190 set_bit(port1
, hub
->change_bits
);
1192 } else if (udev
->persist_enabled
) {
1193 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1196 udev
->reset_resume
= 1;
1198 /* Don't set the change_bits when the device
1201 if (port_dev
->power_is_on
)
1202 set_bit(port1
, hub
->change_bits
);
1205 /* The power session is gone; tell khubd */
1206 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1207 set_bit(port1
, hub
->change_bits
);
1211 /* If no port-status-change flags were set, we don't need any
1212 * debouncing. If flags were set we can try to debounce the
1213 * ports all at once right now, instead of letting khubd do them
1214 * one at a time later on.
1216 * If any port-status changes do occur during this delay, khubd
1217 * will see them later and handle them normally.
1219 if (need_debounce_delay
) {
1220 delay
= HUB_DEBOUNCE_STABLE
;
1222 /* Don't do a long sleep inside a workqueue routine */
1223 if (type
== HUB_INIT2
) {
1224 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1225 schedule_delayed_work(&hub
->init_work
,
1226 msecs_to_jiffies(delay
));
1227 return; /* Continues at init3: below */
1235 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1237 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1238 if (hub
->has_indicators
&& blinkenlights
)
1239 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1241 /* Scan all ports that need attention */
1244 /* Allow autosuspend if it was suppressed */
1245 if (type
<= HUB_INIT3
)
1246 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1249 /* Implement the continuations for the delays above */
1250 static void hub_init_func2(struct work_struct
*ws
)
1252 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1254 hub_activate(hub
, HUB_INIT2
);
1257 static void hub_init_func3(struct work_struct
*ws
)
1259 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1261 hub_activate(hub
, HUB_INIT3
);
1264 enum hub_quiescing_type
{
1265 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1268 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1270 struct usb_device
*hdev
= hub
->hdev
;
1273 cancel_delayed_work_sync(&hub
->init_work
);
1275 /* khubd and related activity won't re-trigger */
1278 if (type
!= HUB_SUSPEND
) {
1279 /* Disconnect all the children */
1280 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1281 if (hub
->ports
[i
]->child
)
1282 usb_disconnect(&hub
->ports
[i
]->child
);
1286 /* Stop khubd and related activity */
1287 usb_kill_urb(hub
->urb
);
1288 if (hub
->has_indicators
)
1289 cancel_delayed_work_sync(&hub
->leds
);
1291 flush_work(&hub
->tt
.clear_work
);
1294 /* caller has locked the hub device */
1295 static int hub_pre_reset(struct usb_interface
*intf
)
1297 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1299 hub_quiesce(hub
, HUB_PRE_RESET
);
1303 /* caller has locked the hub device */
1304 static int hub_post_reset(struct usb_interface
*intf
)
1306 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1308 hub_activate(hub
, HUB_POST_RESET
);
1312 static int hub_configure(struct usb_hub
*hub
,
1313 struct usb_endpoint_descriptor
*endpoint
)
1315 struct usb_hcd
*hcd
;
1316 struct usb_device
*hdev
= hub
->hdev
;
1317 struct device
*hub_dev
= hub
->intfdev
;
1318 u16 hubstatus
, hubchange
;
1319 u16 wHubCharacteristics
;
1322 char *message
= "out of memory";
1326 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1332 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1337 mutex_init(&hub
->status_mutex
);
1339 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1340 if (!hub
->descriptor
) {
1345 /* Request the entire hub descriptor.
1346 * hub->descriptor can handle USB_MAXCHILDREN ports,
1347 * but the hub can/will return fewer bytes here.
1349 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1351 message
= "can't read hub descriptor";
1353 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1354 message
= "hub has too many ports!";
1357 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1358 message
= "hub doesn't have any ports!";
1363 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1364 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1365 (hdev
->maxchild
== 1) ? "" : "s");
1367 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1374 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1375 if (hub_is_superspeed(hdev
)) {
1383 /* FIXME for USB 3.0, skip for now */
1384 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1385 !(hub_is_superspeed(hdev
))) {
1387 char portstr
[USB_MAXCHILDREN
+ 1];
1389 for (i
= 0; i
< hdev
->maxchild
; i
++)
1390 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1391 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1393 portstr
[hdev
->maxchild
] = 0;
1394 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1396 dev_dbg(hub_dev
, "standalone hub\n");
1398 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1399 case HUB_CHAR_COMMON_LPSM
:
1400 dev_dbg(hub_dev
, "ganged power switching\n");
1402 case HUB_CHAR_INDV_PORT_LPSM
:
1403 dev_dbg(hub_dev
, "individual port power switching\n");
1405 case HUB_CHAR_NO_LPSM
:
1407 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1411 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1412 case HUB_CHAR_COMMON_OCPM
:
1413 dev_dbg(hub_dev
, "global over-current protection\n");
1415 case HUB_CHAR_INDV_PORT_OCPM
:
1416 dev_dbg(hub_dev
, "individual port over-current protection\n");
1418 case HUB_CHAR_NO_OCPM
:
1420 dev_dbg(hub_dev
, "no over-current protection\n");
1424 spin_lock_init (&hub
->tt
.lock
);
1425 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1426 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1427 switch (hdev
->descriptor
.bDeviceProtocol
) {
1430 case USB_HUB_PR_HS_SINGLE_TT
:
1431 dev_dbg(hub_dev
, "Single TT\n");
1434 case USB_HUB_PR_HS_MULTI_TT
:
1435 ret
= usb_set_interface(hdev
, 0, 1);
1437 dev_dbg(hub_dev
, "TT per port\n");
1440 dev_err(hub_dev
, "Using single TT (err %d)\n",
1445 /* USB 3.0 hubs don't have a TT */
1448 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1449 hdev
->descriptor
.bDeviceProtocol
);
1453 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1454 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1455 case HUB_TTTT_8_BITS
:
1456 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1457 hub
->tt
.think_time
= 666;
1458 dev_dbg(hub_dev
, "TT requires at most %d "
1459 "FS bit times (%d ns)\n",
1460 8, hub
->tt
.think_time
);
1463 case HUB_TTTT_16_BITS
:
1464 hub
->tt
.think_time
= 666 * 2;
1465 dev_dbg(hub_dev
, "TT requires at most %d "
1466 "FS bit times (%d ns)\n",
1467 16, hub
->tt
.think_time
);
1469 case HUB_TTTT_24_BITS
:
1470 hub
->tt
.think_time
= 666 * 3;
1471 dev_dbg(hub_dev
, "TT requires at most %d "
1472 "FS bit times (%d ns)\n",
1473 24, hub
->tt
.think_time
);
1475 case HUB_TTTT_32_BITS
:
1476 hub
->tt
.think_time
= 666 * 4;
1477 dev_dbg(hub_dev
, "TT requires at most %d "
1478 "FS bit times (%d ns)\n",
1479 32, hub
->tt
.think_time
);
1483 /* probe() zeroes hub->indicator[] */
1484 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1485 hub
->has_indicators
= 1;
1486 dev_dbg(hub_dev
, "Port indicators are supported\n");
1489 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1490 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1492 /* power budgeting mostly matters with bus-powered hubs,
1493 * and battery-powered root hubs (may provide just 8 mA).
1495 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1497 message
= "can't get hub status";
1500 le16_to_cpus(&hubstatus
);
1501 hcd
= bus_to_hcd(hdev
->bus
);
1502 if (hdev
== hdev
->bus
->root_hub
) {
1503 if (hcd
->power_budget
> 0)
1504 hdev
->bus_mA
= hcd
->power_budget
;
1506 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1507 if (hdev
->bus_mA
>= full_load
)
1508 hub
->mA_per_port
= full_load
;
1510 hub
->mA_per_port
= hdev
->bus_mA
;
1511 hub
->limited_power
= 1;
1513 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1514 int remaining
= hdev
->bus_mA
-
1515 hub
->descriptor
->bHubContrCurrent
;
1517 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1518 hub
->descriptor
->bHubContrCurrent
);
1519 hub
->limited_power
= 1;
1521 if (remaining
< hdev
->maxchild
* unit_load
)
1523 "insufficient power available "
1524 "to use all downstream ports\n");
1525 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1527 } else { /* Self-powered external hub */
1528 /* FIXME: What about battery-powered external hubs that
1529 * provide less current per port? */
1530 hub
->mA_per_port
= full_load
;
1532 if (hub
->mA_per_port
< full_load
)
1533 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1536 /* Update the HCD's internal representation of this hub before khubd
1537 * starts getting port status changes for devices under the hub.
1539 if (hcd
->driver
->update_hub_device
) {
1540 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1541 &hub
->tt
, GFP_KERNEL
);
1543 message
= "can't update HCD hub info";
1548 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1550 message
= "can't get hub status";
1554 /* local power status reports aren't always correct */
1555 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1556 dev_dbg(hub_dev
, "local power source is %s\n",
1557 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1558 ? "lost (inactive)" : "good");
1560 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1561 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1562 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1564 /* set up the interrupt endpoint
1565 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1566 * bytes as USB2.0[11.12.3] says because some hubs are known
1567 * to send more data (and thus cause overflow). For root hubs,
1568 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1569 * to be big enough for at least USB_MAXCHILDREN ports. */
1570 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1571 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1573 if (maxp
> sizeof(*hub
->buffer
))
1574 maxp
= sizeof(*hub
->buffer
);
1576 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1582 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1583 hub
, endpoint
->bInterval
);
1585 /* maybe cycle the hub leds */
1586 if (hub
->has_indicators
&& blinkenlights
)
1587 hub
->indicator
[0] = INDICATOR_CYCLE
;
1589 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1590 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1592 dev_err(hub
->intfdev
,
1593 "couldn't create port%d device.\n", i
+ 1);
1595 goto fail_keep_maxchild
;
1599 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1601 hub_activate(hub
, HUB_INIT
);
1607 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1609 /* hub_disconnect() frees urb and descriptor */
1613 static void hub_release(struct kref
*kref
)
1615 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1617 usb_put_intf(to_usb_interface(hub
->intfdev
));
1621 static unsigned highspeed_hubs
;
1623 static void hub_disconnect(struct usb_interface
*intf
)
1625 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1626 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1629 /* Take the hub off the event list and don't let it be added again */
1630 spin_lock_irq(&hub_event_lock
);
1631 if (!list_empty(&hub
->event_list
)) {
1632 list_del_init(&hub
->event_list
);
1633 usb_autopm_put_interface_no_suspend(intf
);
1635 hub
->disconnected
= 1;
1636 spin_unlock_irq(&hub_event_lock
);
1638 /* Disconnect all children and quiesce the hub */
1640 hub_quiesce(hub
, HUB_DISCONNECT
);
1642 /* Avoid races with recursively_mark_NOTATTACHED() */
1643 spin_lock_irq(&device_state_lock
);
1644 port1
= hdev
->maxchild
;
1646 usb_set_intfdata(intf
, NULL
);
1647 spin_unlock_irq(&device_state_lock
);
1649 for (; port1
> 0; --port1
)
1650 usb_hub_remove_port_device(hub
, port1
);
1652 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1655 usb_free_urb(hub
->urb
);
1657 kfree(hub
->descriptor
);
1661 pm_suspend_ignore_children(&intf
->dev
, false);
1662 kref_put(&hub
->kref
, hub_release
);
1665 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1667 struct usb_host_interface
*desc
;
1668 struct usb_endpoint_descriptor
*endpoint
;
1669 struct usb_device
*hdev
;
1670 struct usb_hub
*hub
;
1672 desc
= intf
->cur_altsetting
;
1673 hdev
= interface_to_usbdev(intf
);
1676 * Set default autosuspend delay as 0 to speedup bus suspend,
1677 * based on the below considerations:
1679 * - Unlike other drivers, the hub driver does not rely on the
1680 * autosuspend delay to provide enough time to handle a wakeup
1681 * event, and the submitted status URB is just to check future
1682 * change on hub downstream ports, so it is safe to do it.
1684 * - The patch might cause one or more auto supend/resume for
1685 * below very rare devices when they are plugged into hub
1688 * devices having trouble initializing, and disconnect
1689 * themselves from the bus and then reconnect a second
1692 * devices just for downloading firmware, and disconnects
1693 * themselves after completing it
1695 * For these quite rare devices, their drivers may change the
1696 * autosuspend delay of their parent hub in the probe() to one
1697 * appropriate value to avoid the subtle problem if someone
1700 * - The patch may cause one or more auto suspend/resume on
1701 * hub during running 'lsusb', but it is probably too
1702 * infrequent to worry about.
1704 * - Change autosuspend delay of hub can avoid unnecessary auto
1705 * suspend timer for hub, also may decrease power consumption
1708 * - If user has indicated to prevent autosuspend by passing
1709 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1711 #ifdef CONFIG_PM_RUNTIME
1712 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1713 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1717 * Hubs have proper suspend/resume support, except for root hubs
1718 * where the controller driver doesn't have bus_suspend and
1719 * bus_resume methods.
1721 if (hdev
->parent
) { /* normal device */
1722 usb_enable_autosuspend(hdev
);
1723 } else { /* root hub */
1724 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1726 if (drv
->bus_suspend
&& drv
->bus_resume
)
1727 usb_enable_autosuspend(hdev
);
1730 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1732 "Unsupported bus topology: hub nested too deep\n");
1736 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1738 dev_warn(&intf
->dev
, "ignoring external hub\n");
1743 /* Some hubs have a subclass of 1, which AFAICT according to the */
1744 /* specs is not defined, but it works */
1745 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1746 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1748 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1752 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1753 if (desc
->desc
.bNumEndpoints
!= 1)
1754 goto descriptor_error
;
1756 endpoint
= &desc
->endpoint
[0].desc
;
1758 /* If it's not an interrupt in endpoint, we'd better punt! */
1759 if (!usb_endpoint_is_int_in(endpoint
))
1760 goto descriptor_error
;
1762 /* We found a hub */
1763 dev_info (&intf
->dev
, "USB hub found\n");
1765 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1767 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1771 kref_init(&hub
->kref
);
1772 INIT_LIST_HEAD(&hub
->event_list
);
1773 hub
->intfdev
= &intf
->dev
;
1775 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1776 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1779 usb_set_intfdata (intf
, hub
);
1780 intf
->needs_remote_wakeup
= 1;
1781 pm_suspend_ignore_children(&intf
->dev
, true);
1783 if (hdev
->speed
== USB_SPEED_HIGH
)
1786 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1787 hub
->quirk_check_port_auto_suspend
= 1;
1789 if (hub_configure(hub
, endpoint
) >= 0)
1792 hub_disconnect (intf
);
1797 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1799 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1800 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1802 /* assert ifno == 0 (part of hub spec) */
1804 case USBDEVFS_HUB_PORTINFO
: {
1805 struct usbdevfs_hub_portinfo
*info
= user_data
;
1808 spin_lock_irq(&device_state_lock
);
1809 if (hdev
->devnum
<= 0)
1812 info
->nports
= hdev
->maxchild
;
1813 for (i
= 0; i
< info
->nports
; i
++) {
1814 if (hub
->ports
[i
]->child
== NULL
)
1818 hub
->ports
[i
]->child
->devnum
;
1821 spin_unlock_irq(&device_state_lock
);
1823 return info
->nports
+ 1;
1832 * Allow user programs to claim ports on a hub. When a device is attached
1833 * to one of these "claimed" ports, the program will "own" the device.
1835 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1836 struct dev_state
***ppowner
)
1838 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1840 if (port1
== 0 || port1
> hdev
->maxchild
)
1843 /* This assumes that devices not managed by the hub driver
1844 * will always have maxchild equal to 0.
1846 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1850 /* In the following three functions, the caller must hold hdev's lock */
1851 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1852 struct dev_state
*owner
)
1855 struct dev_state
**powner
;
1857 rc
= find_port_owner(hdev
, port1
, &powner
);
1866 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1867 struct dev_state
*owner
)
1870 struct dev_state
**powner
;
1872 rc
= find_port_owner(hdev
, port1
, &powner
);
1875 if (*powner
!= owner
)
1881 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1883 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1886 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1887 if (hub
->ports
[n
]->port_owner
== owner
)
1888 hub
->ports
[n
]->port_owner
= NULL
;
1893 /* The caller must hold udev's lock */
1894 bool usb_device_is_owned(struct usb_device
*udev
)
1896 struct usb_hub
*hub
;
1898 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1900 hub
= usb_hub_to_struct_hub(udev
->parent
);
1901 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1904 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1906 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1909 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1910 if (hub
->ports
[i
]->child
)
1911 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1913 if (udev
->state
== USB_STATE_SUSPENDED
)
1914 udev
->active_duration
-= jiffies
;
1915 udev
->state
= USB_STATE_NOTATTACHED
;
1919 * usb_set_device_state - change a device's current state (usbcore, hcds)
1920 * @udev: pointer to device whose state should be changed
1921 * @new_state: new state value to be stored
1923 * udev->state is _not_ fully protected by the device lock. Although
1924 * most transitions are made only while holding the lock, the state can
1925 * can change to USB_STATE_NOTATTACHED at almost any time. This
1926 * is so that devices can be marked as disconnected as soon as possible,
1927 * without having to wait for any semaphores to be released. As a result,
1928 * all changes to any device's state must be protected by the
1929 * device_state_lock spinlock.
1931 * Once a device has been added to the device tree, all changes to its state
1932 * should be made using this routine. The state should _not_ be set directly.
1934 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1935 * Otherwise udev->state is set to new_state, and if new_state is
1936 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1937 * to USB_STATE_NOTATTACHED.
1939 void usb_set_device_state(struct usb_device
*udev
,
1940 enum usb_device_state new_state
)
1942 unsigned long flags
;
1945 spin_lock_irqsave(&device_state_lock
, flags
);
1946 if (udev
->state
== USB_STATE_NOTATTACHED
)
1948 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1950 /* root hub wakeup capabilities are managed out-of-band
1951 * and may involve silicon errata ... ignore them here.
1954 if (udev
->state
== USB_STATE_SUSPENDED
1955 || new_state
== USB_STATE_SUSPENDED
)
1956 ; /* No change to wakeup settings */
1957 else if (new_state
== USB_STATE_CONFIGURED
)
1958 wakeup
= (udev
->quirks
&
1959 USB_QUIRK_IGNORE_REMOTE_WAKEUP
) ? 0 :
1960 udev
->actconfig
->desc
.bmAttributes
&
1961 USB_CONFIG_ATT_WAKEUP
;
1965 if (udev
->state
== USB_STATE_SUSPENDED
&&
1966 new_state
!= USB_STATE_SUSPENDED
)
1967 udev
->active_duration
-= jiffies
;
1968 else if (new_state
== USB_STATE_SUSPENDED
&&
1969 udev
->state
!= USB_STATE_SUSPENDED
)
1970 udev
->active_duration
+= jiffies
;
1971 udev
->state
= new_state
;
1973 recursively_mark_NOTATTACHED(udev
);
1974 spin_unlock_irqrestore(&device_state_lock
, flags
);
1976 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1978 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1981 * Choose a device number.
1983 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1984 * USB-2.0 buses they are also used as device addresses, however on
1985 * USB-3.0 buses the address is assigned by the controller hardware
1986 * and it usually is not the same as the device number.
1988 * WUSB devices are simple: they have no hubs behind, so the mapping
1989 * device <-> virtual port number becomes 1:1. Why? to simplify the
1990 * life of the device connection logic in
1991 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1992 * handshake we need to assign a temporary address in the unauthorized
1993 * space. For simplicity we use the first virtual port number found to
1994 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1995 * and that becomes it's address [X < 128] or its unauthorized address
1998 * We add 1 as an offset to the one-based USB-stack port number
1999 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2000 * 0 is reserved by USB for default address; (b) Linux's USB stack
2001 * uses always #1 for the root hub of the controller. So USB stack's
2002 * port #1, which is wusb virtual-port #0 has address #2.
2004 * Devices connected under xHCI are not as simple. The host controller
2005 * supports virtualization, so the hardware assigns device addresses and
2006 * the HCD must setup data structures before issuing a set address
2007 * command to the hardware.
2009 static void choose_devnum(struct usb_device
*udev
)
2012 struct usb_bus
*bus
= udev
->bus
;
2014 /* If khubd ever becomes multithreaded, this will need a lock */
2016 devnum
= udev
->portnum
+ 1;
2017 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2019 /* Try to allocate the next devnum beginning at
2020 * bus->devnum_next. */
2021 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2024 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2026 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
2029 set_bit(devnum
, bus
->devmap
.devicemap
);
2030 udev
->devnum
= devnum
;
2034 static void release_devnum(struct usb_device
*udev
)
2036 if (udev
->devnum
> 0) {
2037 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2042 static void update_devnum(struct usb_device
*udev
, int devnum
)
2044 /* The address for a WUSB device is managed by wusbcore. */
2046 udev
->devnum
= devnum
;
2049 static void hub_free_dev(struct usb_device
*udev
)
2051 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2053 /* Root hubs aren't real devices, so don't free HCD resources */
2054 if (hcd
->driver
->free_dev
&& udev
->parent
)
2055 hcd
->driver
->free_dev(hcd
, udev
);
2059 * usb_disconnect - disconnect a device (usbcore-internal)
2060 * @pdev: pointer to device being disconnected
2061 * Context: !in_interrupt ()
2063 * Something got disconnected. Get rid of it and all of its children.
2065 * If *pdev is a normal device then the parent hub must already be locked.
2066 * If *pdev is a root hub then this routine will acquire the
2067 * usb_bus_list_lock on behalf of the caller.
2069 * Only hub drivers (including virtual root hub drivers for host
2070 * controllers) should ever call this.
2072 * This call is synchronous, and may not be used in an interrupt context.
2074 void usb_disconnect(struct usb_device
**pdev
)
2076 struct usb_device
*udev
= *pdev
;
2077 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2080 /* mark the device as inactive, so any further urb submissions for
2081 * this device (and any of its children) will fail immediately.
2082 * this quiesces everything except pending urbs.
2084 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2085 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2088 usb_lock_device(udev
);
2090 /* Free up all the children before we remove this device */
2091 for (i
= 0; i
< udev
->maxchild
; i
++) {
2092 if (hub
->ports
[i
]->child
)
2093 usb_disconnect(&hub
->ports
[i
]->child
);
2096 /* deallocate hcd/hardware state ... nuking all pending urbs and
2097 * cleaning up all state associated with the current configuration
2098 * so that the hardware is now fully quiesced.
2100 dev_dbg (&udev
->dev
, "unregistering device\n");
2101 usb_disable_device(udev
, 0);
2102 usb_hcd_synchronize_unlinks(udev
);
2105 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2106 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2108 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2109 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2111 if (!port_dev
->did_runtime_put
)
2112 pm_runtime_put(&port_dev
->dev
);
2114 port_dev
->did_runtime_put
= false;
2117 usb_remove_ep_devs(&udev
->ep0
);
2118 usb_unlock_device(udev
);
2120 /* Unregister the device. The device driver is responsible
2121 * for de-configuring the device and invoking the remove-device
2122 * notifier chain (used by usbfs and possibly others).
2124 device_del(&udev
->dev
);
2126 /* Free the device number and delete the parent's children[]
2127 * (or root_hub) pointer.
2129 release_devnum(udev
);
2131 /* Avoid races with recursively_mark_NOTATTACHED() */
2132 spin_lock_irq(&device_state_lock
);
2134 spin_unlock_irq(&device_state_lock
);
2138 put_device(&udev
->dev
);
2141 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2142 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2146 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2149 static void announce_device(struct usb_device
*udev
)
2151 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2152 le16_to_cpu(udev
->descriptor
.idVendor
),
2153 le16_to_cpu(udev
->descriptor
.idProduct
));
2154 dev_info(&udev
->dev
,
2155 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2156 udev
->descriptor
.iManufacturer
,
2157 udev
->descriptor
.iProduct
,
2158 udev
->descriptor
.iSerialNumber
);
2159 show_string(udev
, "Product", udev
->product
);
2160 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2161 show_string(udev
, "SerialNumber", udev
->serial
);
2164 static inline void announce_device(struct usb_device
*udev
) { }
2167 #ifdef CONFIG_USB_OTG
2168 #include "otg_whitelist.h"
2172 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2173 * @udev: newly addressed device (in ADDRESS state)
2175 * Finish enumeration for On-The-Go devices
2177 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2181 #ifdef CONFIG_USB_OTG
2183 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2184 * to wake us after we've powered off VBUS; and HNP, switching roles
2185 * "host" to "peripheral". The OTG descriptor helps figure this out.
2187 if (!udev
->bus
->is_b_host
2189 && udev
->parent
== udev
->bus
->root_hub
) {
2190 struct usb_otg_descriptor
*desc
= NULL
;
2191 struct usb_bus
*bus
= udev
->bus
;
2193 /* descriptor may appear anywhere in config */
2194 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2195 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2196 USB_DT_OTG
, (void **) &desc
) == 0) {
2197 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2198 unsigned port1
= udev
->portnum
;
2200 dev_info(&udev
->dev
,
2201 "Dual-Role OTG device on %sHNP port\n",
2202 (port1
== bus
->otg_port
)
2205 /* enable HNP before suspend, it's simpler */
2206 if (port1
== bus
->otg_port
)
2207 bus
->b_hnp_enable
= 1;
2208 err
= usb_control_msg(udev
,
2209 usb_sndctrlpipe(udev
, 0),
2210 USB_REQ_SET_FEATURE
, 0,
2212 ? USB_DEVICE_B_HNP_ENABLE
2213 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2214 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2216 /* OTG MESSAGE: report errors here,
2217 * customize to match your product.
2219 dev_info(&udev
->dev
,
2220 "can't set HNP mode: %d\n",
2222 bus
->b_hnp_enable
= 0;
2228 if (!is_targeted(udev
)) {
2230 /* Maybe it can talk to us, though we can't talk to it.
2231 * (Includes HNP test device.)
2233 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2234 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2236 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2248 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2249 * @udev: newly addressed device (in ADDRESS state)
2251 * This is only called by usb_new_device() and usb_authorize_device()
2252 * and FIXME -- all comments that apply to them apply here wrt to
2255 * If the device is WUSB and not authorized, we don't attempt to read
2256 * the string descriptors, as they will be errored out by the device
2257 * until it has been authorized.
2259 static int usb_enumerate_device(struct usb_device
*udev
)
2263 if (udev
->config
== NULL
) {
2264 err
= usb_get_configuration(udev
);
2267 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2273 /* read the standard strings and cache them if present */
2274 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2275 udev
->manufacturer
= usb_cache_string(udev
,
2276 udev
->descriptor
.iManufacturer
);
2277 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2279 err
= usb_enumerate_device_otg(udev
);
2283 usb_detect_interface_quirks(udev
);
2288 static void set_usb_port_removable(struct usb_device
*udev
)
2290 struct usb_device
*hdev
= udev
->parent
;
2291 struct usb_hub
*hub
;
2292 u8 port
= udev
->portnum
;
2293 u16 wHubCharacteristics
;
2294 bool removable
= true;
2299 hub
= usb_hub_to_struct_hub(udev
->parent
);
2301 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2303 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2306 if (hub_is_superspeed(hdev
)) {
2307 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2311 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2316 udev
->removable
= USB_DEVICE_REMOVABLE
;
2318 udev
->removable
= USB_DEVICE_FIXED
;
2322 * usb_new_device - perform initial device setup (usbcore-internal)
2323 * @udev: newly addressed device (in ADDRESS state)
2325 * This is called with devices which have been detected but not fully
2326 * enumerated. The device descriptor is available, but not descriptors
2327 * for any device configuration. The caller must have locked either
2328 * the parent hub (if udev is a normal device) or else the
2329 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2330 * udev has already been installed, but udev is not yet visible through
2331 * sysfs or other filesystem code.
2333 * It will return if the device is configured properly or not. Zero if
2334 * the interface was registered with the driver core; else a negative
2337 * This call is synchronous, and may not be used in an interrupt context.
2339 * Only the hub driver or root-hub registrar should ever call this.
2341 int usb_new_device(struct usb_device
*udev
)
2346 /* Initialize non-root-hub device wakeup to disabled;
2347 * device (un)configuration controls wakeup capable
2348 * sysfs power/wakeup controls wakeup enabled/disabled
2350 device_init_wakeup(&udev
->dev
, 0);
2353 /* Tell the runtime-PM framework the device is active */
2354 pm_runtime_set_active(&udev
->dev
);
2355 pm_runtime_get_noresume(&udev
->dev
);
2356 pm_runtime_use_autosuspend(&udev
->dev
);
2357 pm_runtime_enable(&udev
->dev
);
2359 /* By default, forbid autosuspend for all devices. It will be
2360 * allowed for hubs during binding.
2362 usb_disable_autosuspend(udev
);
2364 err
= usb_enumerate_device(udev
); /* Read descriptors */
2367 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2368 udev
->devnum
, udev
->bus
->busnum
,
2369 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2370 /* export the usbdev device-node for libusb */
2371 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2372 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2374 /* Tell the world! */
2375 announce_device(udev
);
2378 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2380 add_device_randomness(udev
->product
, strlen(udev
->product
));
2381 if (udev
->manufacturer
)
2382 add_device_randomness(udev
->manufacturer
,
2383 strlen(udev
->manufacturer
));
2385 device_enable_async_suspend(&udev
->dev
);
2388 * check whether the hub marks this port as non-removable. Do it
2389 * now so that platform-specific data can override it in
2393 set_usb_port_removable(udev
);
2395 /* Register the device. The device driver is responsible
2396 * for configuring the device and invoking the add-device
2397 * notifier chain (used by usbfs and possibly others).
2399 err
= device_add(&udev
->dev
);
2401 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2405 /* Create link files between child device and usb port device. */
2407 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2408 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2410 err
= sysfs_create_link(&udev
->dev
.kobj
,
2411 &port_dev
->dev
.kobj
, "port");
2415 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2416 &udev
->dev
.kobj
, "device");
2418 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2422 pm_runtime_get_sync(&port_dev
->dev
);
2425 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2426 usb_mark_last_busy(udev
);
2427 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2431 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2432 pm_runtime_disable(&udev
->dev
);
2433 pm_runtime_set_suspended(&udev
->dev
);
2439 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2440 * @usb_dev: USB device
2442 * Move the USB device to a very basic state where interfaces are disabled
2443 * and the device is in fact unconfigured and unusable.
2445 * We share a lock (that we have) with device_del(), so we need to
2448 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2450 usb_lock_device(usb_dev
);
2451 if (usb_dev
->authorized
== 0)
2452 goto out_unauthorized
;
2454 usb_dev
->authorized
= 0;
2455 usb_set_configuration(usb_dev
, -1);
2458 usb_unlock_device(usb_dev
);
2463 int usb_authorize_device(struct usb_device
*usb_dev
)
2467 usb_lock_device(usb_dev
);
2468 if (usb_dev
->authorized
== 1)
2469 goto out_authorized
;
2471 result
= usb_autoresume_device(usb_dev
);
2473 dev_err(&usb_dev
->dev
,
2474 "can't autoresume for authorization: %d\n", result
);
2475 goto error_autoresume
;
2477 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2479 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2480 "authorization: %d\n", result
);
2481 goto error_device_descriptor
;
2484 usb_dev
->authorized
= 1;
2485 /* Choose and set the configuration. This registers the interfaces
2486 * with the driver core and lets interface drivers bind to them.
2488 c
= usb_choose_configuration(usb_dev
);
2490 result
= usb_set_configuration(usb_dev
, c
);
2492 dev_err(&usb_dev
->dev
,
2493 "can't set config #%d, error %d\n", c
, result
);
2494 /* This need not be fatal. The user can try to
2495 * set other configurations. */
2498 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2500 error_device_descriptor
:
2501 usb_autosuspend_device(usb_dev
);
2504 usb_unlock_device(usb_dev
); // complements locktree
2509 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2510 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2512 struct usb_hcd
*hcd
;
2513 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2515 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2516 return hcd
->wireless
;
2520 #define PORT_RESET_TRIES 5
2521 #define SET_ADDRESS_TRIES 2
2522 #define GET_DESCRIPTOR_TRIES 2
2523 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2524 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2526 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2527 #define HUB_SHORT_RESET_TIME 10
2528 #define HUB_BH_RESET_TIME 50
2529 #define HUB_LONG_RESET_TIME 200
2530 #define HUB_RESET_TIMEOUT 800
2532 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2533 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2535 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2536 * Port worm reset is required to recover
2538 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2540 return hub_is_superspeed(hub
->hdev
) &&
2541 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2542 USB_SS_PORT_LS_SS_INACTIVE
) ||
2543 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2544 USB_SS_PORT_LS_COMP_MOD
)) ;
2547 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2548 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2550 int delay_time
, ret
;
2554 for (delay_time
= 0;
2555 delay_time
< HUB_RESET_TIMEOUT
;
2556 delay_time
+= delay
) {
2557 /* wait to give the device a chance to reset */
2560 /* read and decode port status */
2561 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2565 /* The port state is unknown until the reset completes. */
2566 if (!(portstatus
& USB_PORT_STAT_RESET
))
2569 /* switch to the long delay after two short delay failures */
2570 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2571 delay
= HUB_LONG_RESET_TIME
;
2573 dev_dbg (hub
->intfdev
,
2574 "port %d not %sreset yet, waiting %dms\n",
2575 port1
, warm
? "warm " : "", delay
);
2578 if ((portstatus
& USB_PORT_STAT_RESET
))
2581 if (hub_port_warm_reset_required(hub
, portstatus
))
2584 /* Device went away? */
2585 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2588 /* bomb out completely if the connection bounced. A USB 3.0
2589 * connection may bounce if multiple warm resets were issued,
2590 * but the device may have successfully re-connected. Ignore it.
2592 if (!hub_is_superspeed(hub
->hdev
) &&
2593 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2596 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2602 if (hub_is_wusb(hub
))
2603 udev
->speed
= USB_SPEED_WIRELESS
;
2604 else if (hub_is_superspeed(hub
->hdev
))
2605 udev
->speed
= USB_SPEED_SUPER
;
2606 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2607 udev
->speed
= USB_SPEED_HIGH
;
2608 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2609 udev
->speed
= USB_SPEED_LOW
;
2611 udev
->speed
= USB_SPEED_FULL
;
2615 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2616 struct usb_device
*udev
, int *status
)
2620 /* TRSTRCY = 10 ms; plus some extra */
2623 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2625 update_devnum(udev
, 0);
2626 /* The xHC may think the device is already reset,
2627 * so ignore the status.
2629 if (hcd
->driver
->reset_device
)
2630 hcd
->driver
->reset_device(hcd
, udev
);
2635 usb_clear_port_feature(hub
->hdev
,
2636 port1
, USB_PORT_FEAT_C_RESET
);
2637 if (hub_is_superspeed(hub
->hdev
)) {
2638 usb_clear_port_feature(hub
->hdev
, port1
,
2639 USB_PORT_FEAT_C_BH_PORT_RESET
);
2640 usb_clear_port_feature(hub
->hdev
, port1
,
2641 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2642 usb_clear_port_feature(hub
->hdev
, port1
,
2643 USB_PORT_FEAT_C_CONNECTION
);
2646 usb_set_device_state(udev
, *status
2647 ? USB_STATE_NOTATTACHED
2648 : USB_STATE_DEFAULT
);
2653 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2654 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2655 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2658 u16 portchange
, portstatus
;
2660 if (!hub_is_superspeed(hub
->hdev
)) {
2662 dev_err(hub
->intfdev
, "only USB3 hub support "
2666 /* Block EHCI CF initialization during the port reset.
2667 * Some companion controllers don't like it when they mix.
2669 down_read(&ehci_cf_port_reset_rwsem
);
2672 * If the caller hasn't explicitly requested a warm reset,
2673 * double check and see if one is needed.
2675 status
= hub_port_status(hub
, port1
,
2676 &portstatus
, &portchange
);
2680 if (hub_port_warm_reset_required(hub
, portstatus
))
2684 /* Reset the port */
2685 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2686 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2687 USB_PORT_FEAT_BH_PORT_RESET
:
2688 USB_PORT_FEAT_RESET
));
2689 if (status
== -ENODEV
) {
2690 ; /* The hub is gone */
2691 } else if (status
) {
2692 dev_err(hub
->intfdev
,
2693 "cannot %sreset port %d (err = %d)\n",
2694 warm
? "warm " : "", port1
, status
);
2696 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2698 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2699 dev_dbg(hub
->intfdev
,
2700 "port_wait_reset: err = %d\n",
2704 /* Check for disconnect or reset */
2705 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2706 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2708 if (!hub_is_superspeed(hub
->hdev
))
2712 * If a USB 3.0 device migrates from reset to an error
2713 * state, re-issue the warm reset.
2715 if (hub_port_status(hub
, port1
,
2716 &portstatus
, &portchange
) < 0)
2719 if (!hub_port_warm_reset_required(hub
, portstatus
))
2723 * If the port is in SS.Inactive or Compliance Mode, the
2724 * hot or warm reset failed. Try another warm reset.
2727 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2733 dev_dbg (hub
->intfdev
,
2734 "port %d not enabled, trying %sreset again...\n",
2735 port1
, warm
? "warm " : "");
2736 delay
= HUB_LONG_RESET_TIME
;
2739 dev_err (hub
->intfdev
,
2740 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2744 if (!hub_is_superspeed(hub
->hdev
))
2745 up_read(&ehci_cf_port_reset_rwsem
);
2750 /* Check if a port is power on */
2751 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2755 if (hub_is_superspeed(hub
->hdev
)) {
2756 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2759 if (portstatus
& USB_PORT_STAT_POWER
)
2768 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2769 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2773 if (hub_is_superspeed(hub
->hdev
)) {
2774 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2775 == USB_SS_PORT_LS_U3
)
2778 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2785 /* Determine whether the device on a port is ready for a normal resume,
2786 * is ready for a reset-resume, or should be disconnected.
2788 static int check_port_resume_type(struct usb_device
*udev
,
2789 struct usb_hub
*hub
, int port1
,
2790 int status
, unsigned portchange
, unsigned portstatus
)
2792 /* Is the device still present? */
2793 if (status
|| port_is_suspended(hub
, portstatus
) ||
2794 !port_is_power_on(hub
, portstatus
) ||
2795 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2800 /* Can't do a normal resume if the port isn't enabled,
2801 * so try a reset-resume instead.
2803 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2804 if (udev
->persist_enabled
)
2805 udev
->reset_resume
= 1;
2811 dev_dbg(hub
->intfdev
,
2812 "port %d status %04x.%04x after resume, %d\n",
2813 port1
, portchange
, portstatus
, status
);
2814 } else if (udev
->reset_resume
) {
2816 /* Late port handoff can set status-change bits */
2817 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2818 usb_clear_port_feature(hub
->hdev
, port1
,
2819 USB_PORT_FEAT_C_CONNECTION
);
2820 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2821 usb_clear_port_feature(hub
->hdev
, port1
,
2822 USB_PORT_FEAT_C_ENABLE
);
2828 int usb_disable_ltm(struct usb_device
*udev
)
2830 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2832 /* Check if the roothub and device supports LTM. */
2833 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2834 !usb_device_supports_ltm(udev
))
2837 /* Clear Feature LTM Enable can only be sent if the device is
2840 if (!udev
->actconfig
)
2843 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2844 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2845 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2846 USB_CTRL_SET_TIMEOUT
);
2848 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2850 void usb_enable_ltm(struct usb_device
*udev
)
2852 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2854 /* Check if the roothub and device supports LTM. */
2855 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2856 !usb_device_supports_ltm(udev
))
2859 /* Set Feature LTM Enable can only be sent if the device is
2862 if (!udev
->actconfig
)
2865 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2866 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2867 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2868 USB_CTRL_SET_TIMEOUT
);
2870 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2874 * usb_disable_function_remotewakeup - disable usb3.0
2875 * device's function remote wakeup
2876 * @udev: target device
2878 * Assume there's only one function on the USB 3.0
2879 * device and disable remote wake for the first
2880 * interface. FIXME if the interface association
2881 * descriptor shows there's more than one function.
2883 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2885 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2886 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2887 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2888 USB_CTRL_SET_TIMEOUT
);
2891 /* Count of wakeup-enabled devices at or below udev */
2892 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2894 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2896 return udev
->do_remote_wakeup
+
2897 (hub
? hub
->wakeup_enabled_descendants
: 0);
2901 * usb_port_suspend - suspend a usb device's upstream port
2902 * @udev: device that's no longer in active use, not a root hub
2903 * Context: must be able to sleep; device not locked; pm locks held
2905 * Suspends a USB device that isn't in active use, conserving power.
2906 * Devices may wake out of a suspend, if anything important happens,
2907 * using the remote wakeup mechanism. They may also be taken out of
2908 * suspend by the host, using usb_port_resume(). It's also routine
2909 * to disconnect devices while they are suspended.
2911 * This only affects the USB hardware for a device; its interfaces
2912 * (and, for hubs, child devices) must already have been suspended.
2914 * Selective port suspend reduces power; most suspended devices draw
2915 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2916 * All devices below the suspended port are also suspended.
2918 * Devices leave suspend state when the host wakes them up. Some devices
2919 * also support "remote wakeup", where the device can activate the USB
2920 * tree above them to deliver data, such as a keypress or packet. In
2921 * some cases, this wakes the USB host.
2923 * Suspending OTG devices may trigger HNP, if that's been enabled
2924 * between a pair of dual-role devices. That will change roles, such
2925 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2927 * Devices on USB hub ports have only one "suspend" state, corresponding
2928 * to ACPI D2, "may cause the device to lose some context".
2929 * State transitions include:
2931 * - suspend, resume ... when the VBUS power link stays live
2932 * - suspend, disconnect ... VBUS lost
2934 * Once VBUS drop breaks the circuit, the port it's using has to go through
2935 * normal re-enumeration procedures, starting with enabling VBUS power.
2936 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2937 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2938 * timer, no SRP, no requests through sysfs.
2940 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2941 * suspended until their bus goes into global suspend (i.e., the root
2942 * hub is suspended). Nevertheless, we change @udev->state to
2943 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2944 * upstream port setting is stored in @udev->port_is_suspended.
2946 * Returns 0 on success, else negative errno.
2948 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2950 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2951 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2952 int port1
= udev
->portnum
;
2954 bool really_suspend
= true;
2956 /* enable remote wakeup when appropriate; this lets the device
2957 * wake up the upstream hub (including maybe the root hub).
2959 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2960 * we don't explicitly enable it here.
2962 if (udev
->do_remote_wakeup
) {
2963 if (!hub_is_superspeed(hub
->hdev
)) {
2964 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2965 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2966 USB_DEVICE_REMOTE_WAKEUP
, 0,
2968 USB_CTRL_SET_TIMEOUT
);
2970 /* Assume there's only one function on the USB 3.0
2971 * device and enable remote wake for the first
2972 * interface. FIXME if the interface association
2973 * descriptor shows there's more than one function.
2975 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2976 USB_REQ_SET_FEATURE
,
2977 USB_RECIP_INTERFACE
,
2978 USB_INTRF_FUNC_SUSPEND
,
2979 USB_INTRF_FUNC_SUSPEND_RW
|
2980 USB_INTRF_FUNC_SUSPEND_LP
,
2982 USB_CTRL_SET_TIMEOUT
);
2985 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2987 /* bail if autosuspend is requested */
2988 if (PMSG_IS_AUTO(msg
))
2993 /* disable USB2 hardware LPM */
2994 if (udev
->usb2_hw_lpm_enabled
== 1)
2995 usb_set_usb2_hardware_lpm(udev
, 0);
2997 if (usb_disable_ltm(udev
)) {
2998 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
3000 if (PMSG_IS_AUTO(msg
))
3003 if (usb_unlocked_disable_lpm(udev
)) {
3004 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
3006 if (PMSG_IS_AUTO(msg
))
3011 if (hub_is_superspeed(hub
->hdev
))
3012 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3015 * For system suspend, we do not need to enable the suspend feature
3016 * on individual USB-2 ports. The devices will automatically go
3017 * into suspend a few ms after the root hub stops sending packets.
3018 * The USB 2.0 spec calls this "global suspend".
3020 * However, many USB hubs have a bug: They don't relay wakeup requests
3021 * from a downstream port if the port's suspend feature isn't on.
3022 * Therefore we will turn on the suspend feature if udev or any of its
3023 * descendants is enabled for remote wakeup.
3025 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3026 status
= set_port_feature(hub
->hdev
, port1
,
3027 USB_PORT_FEAT_SUSPEND
);
3029 really_suspend
= false;
3033 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3036 /* Try to enable USB3 LPM and LTM again */
3037 usb_unlocked_enable_lpm(udev
);
3039 usb_enable_ltm(udev
);
3041 /* Try to enable USB2 hardware LPM again */
3042 if (udev
->usb2_hw_lpm_capable
== 1)
3043 usb_set_usb2_hardware_lpm(udev
, 1);
3045 if (udev
->do_remote_wakeup
) {
3046 if (udev
->speed
< USB_SPEED_SUPER
)
3047 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3048 USB_REQ_CLEAR_FEATURE
,
3050 USB_DEVICE_REMOTE_WAKEUP
, 0,
3051 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3053 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3054 USB_REQ_CLEAR_FEATURE
,
3055 USB_RECIP_INTERFACE
,
3056 USB_INTRF_FUNC_SUSPEND
, 0,
3057 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3061 /* System sleep transitions should never fail */
3062 if (!PMSG_IS_AUTO(msg
))
3065 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3066 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3067 udev
->do_remote_wakeup
);
3068 if (really_suspend
) {
3069 udev
->port_is_suspended
= 1;
3071 /* device has up to 10 msec to fully suspend */
3074 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3077 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3078 pm_runtime_put_sync(&port_dev
->dev
);
3079 port_dev
->did_runtime_put
= true;
3082 usb_mark_last_busy(hub
->hdev
);
3087 * If the USB "suspend" state is in use (rather than "global suspend"),
3088 * many devices will be individually taken out of suspend state using
3089 * special "resume" signaling. This routine kicks in shortly after
3090 * hardware resume signaling is finished, either because of selective
3091 * resume (by host) or remote wakeup (by device) ... now see what changed
3092 * in the tree that's rooted at this device.
3094 * If @udev->reset_resume is set then the device is reset before the
3095 * status check is done.
3097 static int finish_port_resume(struct usb_device
*udev
)
3102 /* caller owns the udev device lock */
3103 dev_dbg(&udev
->dev
, "%s\n",
3104 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3106 /* usb ch9 identifies four variants of SUSPENDED, based on what
3107 * state the device resumes to. Linux currently won't see the
3108 * first two on the host side; they'd be inside hub_port_init()
3109 * during many timeouts, but khubd can't suspend until later.
3111 usb_set_device_state(udev
, udev
->actconfig
3112 ? USB_STATE_CONFIGURED
3113 : USB_STATE_ADDRESS
);
3115 /* 10.5.4.5 says not to reset a suspended port if the attached
3116 * device is enabled for remote wakeup. Hence the reset
3117 * operation is carried out here, after the port has been
3120 if (udev
->reset_resume
)
3122 status
= usb_reset_and_verify_device(udev
);
3124 /* 10.5.4.5 says be sure devices in the tree are still there.
3125 * For now let's assume the device didn't go crazy on resume,
3126 * and device drivers will know about any resume quirks.
3130 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3132 status
= (status
> 0 ? 0 : -ENODEV
);
3134 /* If a normal resume failed, try doing a reset-resume */
3135 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3136 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3137 udev
->reset_resume
= 1;
3138 goto retry_reset_resume
;
3143 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3146 * There are a few quirky devices which violate the standard
3147 * by claiming to have remote wakeup enabled after a reset,
3148 * which crash if the feature is cleared, hence check for
3149 * udev->reset_resume
3151 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3152 if (!hub_is_superspeed(udev
->parent
)) {
3153 le16_to_cpus(&devstatus
);
3154 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3155 status
= usb_control_msg(udev
,
3156 usb_sndctrlpipe(udev
, 0),
3157 USB_REQ_CLEAR_FEATURE
,
3159 USB_DEVICE_REMOTE_WAKEUP
, 0,
3161 USB_CTRL_SET_TIMEOUT
);
3163 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3165 le16_to_cpus(&devstatus
);
3166 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3167 | USB_INTRF_STAT_FUNC_RW
))
3169 usb_disable_function_remotewakeup(udev
);
3174 "disable remote wakeup, status %d\n",
3182 * There are some SS USB devices which take longer time for link training.
3183 * XHCI specs 4.19.4 says that when Link training is successful, port
3184 * sets CSC bit to 1. So if SW reads port status before successful link
3185 * training, then it will not find device to be present.
3186 * USB Analyzer log with such buggy devices show that in some cases
3187 * device switch on the RX termination after long delay of host enabling
3188 * the VBUS. In few other cases it has been seen that device fails to
3189 * negotiate link training in first attempt. It has been
3190 * reported till now that few devices take as long as 2000 ms to train
3191 * the link after host enabling its VBUS and termination. Following
3192 * routine implements a 2000 ms timeout for link training. If in a case
3193 * link trains before timeout, loop will exit earlier.
3195 * FIXME: If a device was connected before suspend, but was removed
3196 * while system was asleep, then the loop in the following routine will
3197 * only exit at timeout.
3199 * This routine should only be called when persist is enabled for a SS
3202 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3203 struct usb_hub
*hub
, int *port1
,
3204 u16
*portchange
, u16
*portstatus
)
3206 int status
= 0, delay_ms
= 0;
3208 while (delay_ms
< 2000) {
3209 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3213 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3219 * usb_port_resume - re-activate a suspended usb device's upstream port
3220 * @udev: device to re-activate, not a root hub
3221 * Context: must be able to sleep; device not locked; pm locks held
3223 * This will re-activate the suspended device, increasing power usage
3224 * while letting drivers communicate again with its endpoints.
3225 * USB resume explicitly guarantees that the power session between
3226 * the host and the device is the same as it was when the device
3229 * If @udev->reset_resume is set then this routine won't check that the
3230 * port is still enabled. Furthermore, finish_port_resume() above will
3231 * reset @udev. The end result is that a broken power session can be
3232 * recovered and @udev will appear to persist across a loss of VBUS power.
3234 * For example, if a host controller doesn't maintain VBUS suspend current
3235 * during a system sleep or is reset when the system wakes up, all the USB
3236 * power sessions below it will be broken. This is especially troublesome
3237 * for mass-storage devices containing mounted filesystems, since the
3238 * device will appear to have disconnected and all the memory mappings
3239 * to it will be lost. Using the USB_PERSIST facility, the device can be
3240 * made to appear as if it had not disconnected.
3242 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3243 * every effort to insure that the same device is present after the
3244 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3245 * quite possible for a device to remain unaltered but its media to be
3246 * changed. If the user replaces a flash memory card while the system is
3247 * asleep, he will have only himself to blame when the filesystem on the
3248 * new card is corrupted and the system crashes.
3250 * Returns 0 on success, else negative errno.
3252 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3254 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3255 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3256 int port1
= udev
->portnum
;
3258 u16 portchange
, portstatus
;
3260 if (port_dev
->did_runtime_put
) {
3261 status
= pm_runtime_get_sync(&port_dev
->dev
);
3262 port_dev
->did_runtime_put
= false;
3264 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3270 /* Skip the initial Clear-Suspend step for a remote wakeup */
3271 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3272 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3273 goto SuspendCleared
;
3275 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3277 set_bit(port1
, hub
->busy_bits
);
3279 /* see 7.1.7.7; affects power usage, but not budgeting */
3280 if (hub_is_superspeed(hub
->hdev
))
3281 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3283 status
= usb_clear_port_feature(hub
->hdev
,
3284 port1
, USB_PORT_FEAT_SUSPEND
);
3286 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3289 /* drive resume for USB_RESUME_TIMEOUT msec */
3290 dev_dbg(&udev
->dev
, "usb %sresume\n",
3291 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3292 msleep(USB_RESUME_TIMEOUT
);
3294 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3295 * stop resume signaling. Then finish the resume
3298 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3300 /* TRSMRCY = 10 msec */
3306 udev
->port_is_suspended
= 0;
3307 if (hub_is_superspeed(hub
->hdev
)) {
3308 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3309 usb_clear_port_feature(hub
->hdev
, port1
,
3310 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3312 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3313 usb_clear_port_feature(hub
->hdev
, port1
,
3314 USB_PORT_FEAT_C_SUSPEND
);
3318 clear_bit(port1
, hub
->busy_bits
);
3320 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3321 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3324 status
= check_port_resume_type(udev
,
3325 hub
, port1
, status
, portchange
, portstatus
);
3327 status
= finish_port_resume(udev
);
3329 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3330 hub_port_logical_disconnect(hub
, port1
);
3332 /* Try to enable USB2 hardware LPM */
3333 if (udev
->usb2_hw_lpm_capable
== 1)
3334 usb_set_usb2_hardware_lpm(udev
, 1);
3336 /* Try to enable USB3 LTM and LPM */
3337 usb_enable_ltm(udev
);
3338 usb_unlocked_enable_lpm(udev
);
3344 #endif /* CONFIG_PM */
3346 #ifdef CONFIG_PM_RUNTIME
3348 /* caller has locked udev */
3349 int usb_remote_wakeup(struct usb_device
*udev
)
3353 if (udev
->state
== USB_STATE_SUSPENDED
) {
3354 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3355 status
= usb_autoresume_device(udev
);
3357 /* Let the drivers do their thing, then... */
3358 usb_autosuspend_device(udev
);
3366 static int check_ports_changed(struct usb_hub
*hub
)
3370 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3371 u16 portstatus
, portchange
;
3374 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3375 if (!status
&& portchange
)
3381 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3383 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3384 struct usb_device
*hdev
= hub
->hdev
;
3389 * Warn if children aren't already suspended.
3390 * Also, add up the number of wakeup-enabled descendants.
3392 hub
->wakeup_enabled_descendants
= 0;
3393 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3394 struct usb_device
*udev
;
3396 udev
= hub
->ports
[port1
- 1]->child
;
3397 if (udev
&& udev
->can_submit
) {
3398 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3399 if (PMSG_IS_AUTO(msg
))
3403 hub
->wakeup_enabled_descendants
+=
3404 wakeup_enabled_descendants(udev
);
3407 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3408 /* check if there are changes pending on hub ports */
3409 if (check_ports_changed(hub
)) {
3410 if (PMSG_IS_AUTO(msg
))
3412 pm_wakeup_event(&hdev
->dev
, 2000);
3416 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3417 /* Enable hub to send remote wakeup for all ports. */
3418 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3419 status
= set_port_feature(hdev
,
3421 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3422 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3423 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3424 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3428 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3430 /* stop khubd and related activity */
3431 hub_quiesce(hub
, HUB_SUSPEND
);
3435 static int hub_resume(struct usb_interface
*intf
)
3437 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3439 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3440 hub_activate(hub
, HUB_RESUME
);
3444 static int hub_reset_resume(struct usb_interface
*intf
)
3446 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3448 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3449 hub_activate(hub
, HUB_RESET_RESUME
);
3454 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3455 * @rhdev: struct usb_device for the root hub
3457 * The USB host controller driver calls this function when its root hub
3458 * is resumed and Vbus power has been interrupted or the controller
3459 * has been reset. The routine marks @rhdev as having lost power.
3460 * When the hub driver is resumed it will take notice and carry out
3461 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3462 * the others will be disconnected.
3464 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3466 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3467 rhdev
->reset_resume
= 1;
3469 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3471 static const char * const usb3_lpm_names
[] = {
3479 * Send a Set SEL control transfer to the device, prior to enabling
3480 * device-initiated U1 or U2. This lets the device know the exit latencies from
3481 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3482 * packet from the host.
3484 * This function will fail if the SEL or PEL values for udev are greater than
3485 * the maximum allowed values for the link state to be enabled.
3487 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3489 struct usb_set_sel_req
*sel_values
;
3490 unsigned long long u1_sel
;
3491 unsigned long long u1_pel
;
3492 unsigned long long u2_sel
;
3493 unsigned long long u2_pel
;
3496 /* Convert SEL and PEL stored in ns to us */
3497 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3498 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3499 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3500 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3503 * Make sure that the calculated SEL and PEL values for the link
3504 * state we're enabling aren't bigger than the max SEL/PEL
3505 * value that will fit in the SET SEL control transfer.
3506 * Otherwise the device would get an incorrect idea of the exit
3507 * latency for the link state, and could start a device-initiated
3508 * U1/U2 when the exit latencies are too high.
3510 if ((state
== USB3_LPM_U1
&&
3511 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3512 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3513 (state
== USB3_LPM_U2
&&
3514 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3515 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3516 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3517 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3522 * If we're enabling device-initiated LPM for one link state,
3523 * but the other link state has a too high SEL or PEL value,
3524 * just set those values to the max in the Set SEL request.
3526 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3527 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3529 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3530 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3532 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3533 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3535 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3536 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3539 * usb_enable_lpm() can be called as part of a failed device reset,
3540 * which may be initiated by an error path of a mass storage driver.
3541 * Therefore, use GFP_NOIO.
3543 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3547 sel_values
->u1_sel
= u1_sel
;
3548 sel_values
->u1_pel
= u1_pel
;
3549 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3550 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3552 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3556 sel_values
, sizeof *(sel_values
),
3557 USB_CTRL_SET_TIMEOUT
);
3563 * Enable or disable device-initiated U1 or U2 transitions.
3565 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3566 enum usb3_link_state state
, bool enable
)
3573 feature
= USB_DEVICE_U1_ENABLE
;
3576 feature
= USB_DEVICE_U2_ENABLE
;
3579 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3580 __func__
, enable
? "enable" : "disable");
3584 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3585 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3586 "for unconfigured device.\n",
3587 __func__
, enable
? "enable" : "disable",
3588 usb3_lpm_names
[state
]);
3594 * Now send the control transfer to enable device-initiated LPM
3595 * for either U1 or U2.
3597 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3598 USB_REQ_SET_FEATURE
,
3602 USB_CTRL_SET_TIMEOUT
);
3604 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3605 USB_REQ_CLEAR_FEATURE
,
3609 USB_CTRL_SET_TIMEOUT
);
3612 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3613 enable
? "Enable" : "Disable",
3614 usb3_lpm_names
[state
]);
3620 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3621 enum usb3_link_state state
, int timeout
)
3628 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3631 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3634 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3639 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3640 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3641 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3642 "which is a reserved value.\n",
3643 usb3_lpm_names
[state
], timeout
);
3647 ret
= set_port_feature(udev
->parent
,
3648 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3651 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3652 "error code %i\n", usb3_lpm_names
[state
],
3656 if (state
== USB3_LPM_U1
)
3657 udev
->u1_params
.timeout
= timeout
;
3659 udev
->u2_params
.timeout
= timeout
;
3664 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3667 * We will attempt to enable U1 or U2, but there are no guarantees that the
3668 * control transfers to set the hub timeout or enable device-initiated U1/U2
3669 * will be successful.
3671 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3672 * driver know about it. If that call fails, it should be harmless, and just
3673 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3675 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3676 enum usb3_link_state state
)
3679 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3680 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3682 /* If the device says it doesn't have *any* exit latency to come out of
3683 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3686 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3687 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3691 * First, let the device know about the exit latencies
3692 * associated with the link state we're about to enable.
3694 ret
= usb_req_set_sel(udev
, state
);
3696 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3697 usb3_lpm_names
[state
]);
3701 /* We allow the host controller to set the U1/U2 timeout internally
3702 * first, so that it can change its schedule to account for the
3703 * additional latency to send data to a device in a lower power
3706 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3708 /* xHCI host controller doesn't want to enable this LPM state. */
3713 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3714 "xHCI error %i.\n", usb3_lpm_names
[state
],
3719 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3720 /* If we can't set the parent hub U1/U2 timeout,
3721 * device-initiated LPM won't be allowed either, so let the xHCI
3722 * host know that this link state won't be enabled.
3724 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3726 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3727 else if (udev
->actconfig
)
3728 usb_set_device_initiated_lpm(udev
, state
, true);
3733 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3736 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3737 * If zero is returned, the parent will not allow the link to go into U1/U2.
3739 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3740 * it won't have an effect on the bus link state because the parent hub will
3741 * still disallow device-initiated U1/U2 entry.
3743 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3744 * possible. The result will be slightly more bus bandwidth will be taken up
3745 * (to account for U1/U2 exit latency), but it should be harmless.
3747 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3748 enum usb3_link_state state
)
3754 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3757 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3760 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3765 if (usb_set_lpm_timeout(udev
, state
, 0))
3768 usb_set_device_initiated_lpm(udev
, state
, false);
3770 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3771 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3772 "bus schedule bandwidth may be impacted.\n",
3773 usb3_lpm_names
[state
]);
3778 * Disable hub-initiated and device-initiated U1 and U2 entry.
3779 * Caller must own the bandwidth_mutex.
3781 * This will call usb_enable_lpm() on failure, which will decrement
3782 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3784 int usb_disable_lpm(struct usb_device
*udev
)
3786 struct usb_hcd
*hcd
;
3788 if (!udev
|| !udev
->parent
||
3789 udev
->speed
!= USB_SPEED_SUPER
||
3793 hcd
= bus_to_hcd(udev
->bus
);
3794 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3797 udev
->lpm_disable_count
++;
3798 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3801 /* If LPM is enabled, attempt to disable it. */
3802 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3804 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3810 usb_enable_lpm(udev
);
3813 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3815 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3816 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3818 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3824 mutex_lock(hcd
->bandwidth_mutex
);
3825 ret
= usb_disable_lpm(udev
);
3826 mutex_unlock(hcd
->bandwidth_mutex
);
3830 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3833 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3834 * xHCI host policy may prevent U1 or U2 from being enabled.
3836 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3837 * until the lpm_disable_count drops to zero. Caller must own the
3840 void usb_enable_lpm(struct usb_device
*udev
)
3842 struct usb_hcd
*hcd
;
3844 if (!udev
|| !udev
->parent
||
3845 udev
->speed
!= USB_SPEED_SUPER
||
3849 udev
->lpm_disable_count
--;
3850 hcd
= bus_to_hcd(udev
->bus
);
3851 /* Double check that we can both enable and disable LPM.
3852 * Device must be configured to accept set feature U1/U2 timeout.
3854 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3855 !hcd
->driver
->disable_usb3_lpm_timeout
)
3858 if (udev
->lpm_disable_count
> 0)
3861 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3862 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3864 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3866 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3867 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3869 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3874 mutex_lock(hcd
->bandwidth_mutex
);
3875 usb_enable_lpm(udev
);
3876 mutex_unlock(hcd
->bandwidth_mutex
);
3878 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3881 #else /* CONFIG_PM */
3883 #define hub_suspend NULL
3884 #define hub_resume NULL
3885 #define hub_reset_resume NULL
3887 int usb_disable_lpm(struct usb_device
*udev
)
3891 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3893 void usb_enable_lpm(struct usb_device
*udev
) { }
3894 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3896 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3900 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3902 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3903 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3905 int usb_disable_ltm(struct usb_device
*udev
)
3909 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3911 void usb_enable_ltm(struct usb_device
*udev
) { }
3912 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3916 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3918 * Between connect detection and reset signaling there must be a delay
3919 * of 100ms at least for debounce and power-settling. The corresponding
3920 * timer shall restart whenever the downstream port detects a disconnect.
3922 * Apparently there are some bluetooth and irda-dongles and a number of
3923 * low-speed devices for which this debounce period may last over a second.
3924 * Not covered by the spec - but easy to deal with.
3926 * This implementation uses a 1500ms total debounce timeout; if the
3927 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3928 * every 25ms for transient disconnects. When the port status has been
3929 * unchanged for 100ms it returns the port status.
3931 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3934 int total_time
, stable_time
= 0;
3935 u16 portchange
, portstatus
;
3936 unsigned connection
= 0xffff;
3938 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3939 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3943 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3944 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3945 if (!must_be_connected
||
3946 (connection
== USB_PORT_STAT_CONNECTION
))
3947 stable_time
+= HUB_DEBOUNCE_STEP
;
3948 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3952 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3955 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3956 usb_clear_port_feature(hub
->hdev
, port1
,
3957 USB_PORT_FEAT_C_CONNECTION
);
3960 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3962 msleep(HUB_DEBOUNCE_STEP
);
3965 dev_dbg (hub
->intfdev
,
3966 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3967 port1
, total_time
, stable_time
, portstatus
);
3969 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3974 void usb_ep0_reinit(struct usb_device
*udev
)
3976 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3977 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3978 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3980 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3982 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3983 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3985 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3988 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3991 * The host controller will choose the device address,
3992 * instead of the core having chosen it earlier
3994 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3996 if (udev
->state
== USB_STATE_ADDRESS
)
3998 if (udev
->state
!= USB_STATE_DEFAULT
)
4000 if (hcd
->driver
->address_device
)
4001 retval
= hcd
->driver
->address_device(hcd
, udev
);
4003 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
4004 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
4005 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4007 update_devnum(udev
, devnum
);
4008 /* Device now using proper address. */
4009 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4010 usb_ep0_reinit(udev
);
4015 /* Reset device, (re)assign address, get device descriptor.
4016 * Device connection must be stable, no more debouncing needed.
4017 * Returns device in USB_STATE_ADDRESS, except on error.
4019 * If this is called for an already-existing device (as part of
4020 * usb_reset_and_verify_device), the caller must own the device lock. For a
4021 * newly detected device that is not accessible through any global
4022 * pointers, it's not necessary to lock the device.
4025 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4028 static DEFINE_MUTEX(usb_address0_mutex
);
4030 struct usb_device
*hdev
= hub
->hdev
;
4031 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4033 unsigned delay
= HUB_SHORT_RESET_TIME
;
4034 enum usb_device_speed oldspeed
= udev
->speed
;
4036 int devnum
= udev
->devnum
;
4038 /* root hub ports have a slightly longer reset period
4039 * (from USB 2.0 spec, section 7.1.7.5)
4041 if (!hdev
->parent
) {
4042 delay
= HUB_ROOT_RESET_TIME
;
4043 if (port1
== hdev
->bus
->otg_port
)
4044 hdev
->bus
->b_hnp_enable
= 0;
4047 /* Some low speed devices have problems with the quick delay, so */
4048 /* be a bit pessimistic with those devices. RHbug #23670 */
4049 if (oldspeed
== USB_SPEED_LOW
)
4050 delay
= HUB_LONG_RESET_TIME
;
4052 mutex_lock(&usb_address0_mutex
);
4054 /* Reset the device; full speed may morph to high speed */
4055 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4056 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4057 if (retval
< 0) /* error or disconnect */
4059 /* success, speed is known */
4063 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4064 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4067 oldspeed
= udev
->speed
;
4069 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4070 * it's fixed size except for full speed devices.
4071 * For Wireless USB devices, ep0 max packet is always 512 (tho
4072 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4074 switch (udev
->speed
) {
4075 case USB_SPEED_SUPER
:
4076 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4077 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4079 case USB_SPEED_HIGH
: /* fixed at 64 */
4080 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4082 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4083 /* to determine the ep0 maxpacket size, try to read
4084 * the device descriptor to get bMaxPacketSize0 and
4085 * then correct our initial guess.
4087 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4089 case USB_SPEED_LOW
: /* fixed at 8 */
4090 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4096 if (udev
->speed
== USB_SPEED_WIRELESS
)
4097 speed
= "variable speed Wireless";
4099 speed
= usb_speed_string(udev
->speed
);
4101 if (udev
->speed
!= USB_SPEED_SUPER
)
4102 dev_info(&udev
->dev
,
4103 "%s %s USB device number %d using %s\n",
4104 (udev
->config
) ? "reset" : "new", speed
,
4105 devnum
, udev
->bus
->controller
->driver
->name
);
4107 /* Set up TT records, if needed */
4109 udev
->tt
= hdev
->tt
;
4110 udev
->ttport
= hdev
->ttport
;
4111 } else if (udev
->speed
!= USB_SPEED_HIGH
4112 && hdev
->speed
== USB_SPEED_HIGH
) {
4114 dev_err(&udev
->dev
, "parent hub has no TT\n");
4118 udev
->tt
= &hub
->tt
;
4119 udev
->ttport
= port1
;
4122 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4123 * Because device hardware and firmware is sometimes buggy in
4124 * this area, and this is how Linux has done it for ages.
4125 * Change it cautiously.
4127 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4128 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4129 * so it may help with some non-standards-compliant devices.
4130 * Otherwise we start with SET_ADDRESS and then try to read the
4131 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4134 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4135 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4136 struct usb_device_descriptor
*buf
;
4139 #define GET_DESCRIPTOR_BUFSIZE 64
4140 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4146 /* Retry on all errors; some devices are flakey.
4147 * 255 is for WUSB devices, we actually need to use
4148 * 512 (WUSB1.0[4.8.1]).
4150 for (j
= 0; j
< 3; ++j
) {
4151 buf
->bMaxPacketSize0
= 0;
4152 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4153 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4154 USB_DT_DEVICE
<< 8, 0,
4155 buf
, GET_DESCRIPTOR_BUFSIZE
,
4156 initial_descriptor_timeout
);
4157 switch (buf
->bMaxPacketSize0
) {
4158 case 8: case 16: case 32: case 64: case 255:
4159 if (buf
->bDescriptorType
==
4173 udev
->descriptor
.bMaxPacketSize0
=
4174 buf
->bMaxPacketSize0
;
4177 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4178 if (retval
< 0) /* error or disconnect */
4180 if (oldspeed
!= udev
->speed
) {
4182 "device reset changed speed!\n");
4188 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4193 #undef GET_DESCRIPTOR_BUFSIZE
4197 * If device is WUSB, we already assigned an
4198 * unauthorized address in the Connect Ack sequence;
4199 * authorization will assign the final address.
4201 if (udev
->wusb
== 0) {
4202 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4203 retval
= hub_set_address(udev
, devnum
);
4209 if (retval
!= -ENODEV
)
4210 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4214 if (udev
->speed
== USB_SPEED_SUPER
) {
4215 devnum
= udev
->devnum
;
4216 dev_info(&udev
->dev
,
4217 "%s SuperSpeed USB device number %d using %s\n",
4218 (udev
->config
) ? "reset" : "new",
4219 devnum
, udev
->bus
->controller
->driver
->name
);
4222 /* cope with hardware quirkiness:
4223 * - let SET_ADDRESS settle, some device hardware wants it
4224 * - read ep0 maxpacket even for high and low speed,
4227 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4231 retval
= usb_get_device_descriptor(udev
, 8);
4233 if (retval
!= -ENODEV
)
4235 "device descriptor read/8, error %d\n",
4247 if (hcd
->phy
&& !hdev
->parent
)
4248 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4251 * Some superspeed devices have finished the link training process
4252 * and attached to a superspeed hub port, but the device descriptor
4253 * got from those devices show they aren't superspeed devices. Warm
4254 * reset the port attached by the devices can fix them.
4256 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4257 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4258 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4259 "warm reset device\n");
4260 hub_port_reset(hub
, port1
, udev
,
4261 HUB_BH_RESET_TIME
, true);
4266 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4267 udev
->speed
== USB_SPEED_SUPER
)
4270 i
= udev
->descriptor
.bMaxPacketSize0
;
4271 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4272 if (udev
->speed
== USB_SPEED_LOW
||
4273 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4274 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4278 if (udev
->speed
== USB_SPEED_FULL
)
4279 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4281 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4282 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4283 usb_ep0_reinit(udev
);
4286 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4287 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4288 if (retval
!= -ENODEV
)
4289 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4296 usb_detect_quirks(udev
);
4298 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4299 retval
= usb_get_bos_descriptor(udev
);
4301 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4302 usb_set_lpm_parameters(udev
);
4307 /* notify HCD that we have a device connected and addressed */
4308 if (hcd
->driver
->update_device
)
4309 hcd
->driver
->update_device(hcd
, udev
);
4312 hub_port_disable(hub
, port1
, 0);
4313 update_devnum(udev
, devnum
); /* for disconnect processing */
4315 mutex_unlock(&usb_address0_mutex
);
4320 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4322 struct usb_qualifier_descriptor
*qual
;
4325 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4329 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4330 qual
, sizeof *qual
);
4331 if (status
== sizeof *qual
) {
4332 dev_info(&udev
->dev
, "not running at top speed; "
4333 "connect to a high speed hub\n");
4334 /* hub LEDs are probably harder to miss than syslog */
4335 if (hub
->has_indicators
) {
4336 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4337 schedule_delayed_work (&hub
->leds
, 0);
4344 hub_power_remaining (struct usb_hub
*hub
)
4346 struct usb_device
*hdev
= hub
->hdev
;
4350 if (!hub
->limited_power
)
4353 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4354 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4355 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4361 if (hub_is_superspeed(udev
))
4367 * Unconfigured devices may not use more than one unit load,
4368 * or 8mA for OTG ports
4370 if (udev
->actconfig
)
4371 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4372 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4376 if (delta
> hub
->mA_per_port
)
4377 dev_warn(&udev
->dev
,
4378 "%dmA is over %umA budget for port %d!\n",
4379 delta
, hub
->mA_per_port
, port1
);
4382 if (remaining
< 0) {
4383 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4390 /* Handle physical or logical connection change events.
4391 * This routine is called when:
4392 * a port connection-change occurs;
4393 * a port enable-change occurs (often caused by EMI);
4394 * usb_reset_and_verify_device() encounters changed descriptors (as from
4395 * a firmware download)
4396 * caller already locked the hub
4398 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4399 u16 portstatus
, u16 portchange
)
4401 struct usb_device
*hdev
= hub
->hdev
;
4402 struct device
*hub_dev
= hub
->intfdev
;
4403 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4404 unsigned wHubCharacteristics
=
4405 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4406 struct usb_device
*udev
;
4411 "port %d, status %04x, change %04x, %s\n",
4412 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4414 if (hub
->has_indicators
) {
4415 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4416 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4419 #ifdef CONFIG_USB_OTG
4420 /* during HNP, don't repeat the debounce */
4421 if (hdev
->bus
->is_b_host
)
4422 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4423 USB_PORT_STAT_C_ENABLE
);
4426 /* Try to resuscitate an existing device */
4427 udev
= hub
->ports
[port1
- 1]->child
;
4428 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4429 udev
->state
!= USB_STATE_NOTATTACHED
) {
4430 usb_lock_device(udev
);
4431 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4432 status
= 0; /* Nothing to do */
4434 #ifdef CONFIG_PM_RUNTIME
4435 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4436 udev
->persist_enabled
) {
4437 /* For a suspended device, treat this as a
4438 * remote wakeup event.
4440 status
= usb_remote_wakeup(udev
);
4444 status
= -ENODEV
; /* Don't resuscitate */
4446 usb_unlock_device(udev
);
4449 clear_bit(port1
, hub
->change_bits
);
4454 /* Disconnect any existing devices under this port */
4456 if (hcd
->phy
&& !hdev
->parent
&&
4457 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4458 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4459 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4461 clear_bit(port1
, hub
->change_bits
);
4463 /* We can forget about a "removed" device when there's a physical
4464 * disconnect or the connect status changes.
4466 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4467 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4468 clear_bit(port1
, hub
->removed_bits
);
4470 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4471 USB_PORT_STAT_C_ENABLE
)) {
4472 status
= hub_port_debounce_be_stable(hub
, port1
);
4474 if (status
!= -ENODEV
&& printk_ratelimit())
4475 dev_err(hub_dev
, "connect-debounce failed, "
4476 "port %d disabled\n", port1
);
4477 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4479 portstatus
= status
;
4483 /* Return now if debouncing failed or nothing is connected or
4484 * the device was "removed".
4486 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4487 test_bit(port1
, hub
->removed_bits
)) {
4489 /* maybe switch power back on (e.g. root hub was reset) */
4490 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4491 && !port_is_power_on(hub
, portstatus
))
4492 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4494 if (portstatus
& USB_PORT_STAT_ENABLE
)
4498 if (hub_is_superspeed(hub
->hdev
))
4504 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4506 /* reallocate for each attempt, since references
4507 * to the previous one can escape in various ways
4509 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4512 "couldn't allocate port %d usb_device\n",
4517 usb_set_device_state(udev
, USB_STATE_POWERED
);
4518 udev
->bus_mA
= hub
->mA_per_port
;
4519 udev
->level
= hdev
->level
+ 1;
4520 udev
->wusb
= hub_is_wusb(hub
);
4522 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4523 if (hub_is_superspeed(hub
->hdev
))
4524 udev
->speed
= USB_SPEED_SUPER
;
4526 udev
->speed
= USB_SPEED_UNKNOWN
;
4528 choose_devnum(udev
);
4529 if (udev
->devnum
<= 0) {
4530 status
= -ENOTCONN
; /* Don't retry */
4534 /* reset (non-USB 3.0 devices) and get descriptor */
4535 status
= hub_port_init(hub
, udev
, port1
, i
);
4539 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4542 /* consecutive bus-powered hubs aren't reliable; they can
4543 * violate the voltage drop budget. if the new child has
4544 * a "powered" LED, users should notice we didn't enable it
4545 * (without reading syslog), even without per-port LEDs
4548 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4549 && udev
->bus_mA
<= unit_load
) {
4552 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4555 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4558 le16_to_cpus(&devstat
);
4559 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4561 "can't connect bus-powered hub "
4563 if (hub
->has_indicators
) {
4564 hub
->indicator
[port1
-1] =
4565 INDICATOR_AMBER_BLINK
;
4566 schedule_delayed_work (&hub
->leds
, 0);
4568 status
= -ENOTCONN
; /* Don't retry */
4573 /* check for devices running slower than they could */
4574 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4575 && udev
->speed
== USB_SPEED_FULL
4576 && highspeed_hubs
!= 0)
4577 check_highspeed (hub
, udev
, port1
);
4579 /* Store the parent's children[] pointer. At this point
4580 * udev becomes globally accessible, although presumably
4581 * no one will look at it until hdev is unlocked.
4585 /* We mustn't add new devices if the parent hub has
4586 * been disconnected; we would race with the
4587 * recursively_mark_NOTATTACHED() routine.
4589 spin_lock_irq(&device_state_lock
);
4590 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4593 hub
->ports
[port1
- 1]->child
= udev
;
4594 spin_unlock_irq(&device_state_lock
);
4596 /* Run it through the hoops (find a driver, etc) */
4598 status
= usb_new_device(udev
);
4600 spin_lock_irq(&device_state_lock
);
4601 hub
->ports
[port1
- 1]->child
= NULL
;
4602 spin_unlock_irq(&device_state_lock
);
4609 status
= hub_power_remaining(hub
);
4611 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4616 hub_port_disable(hub
, port1
, 1);
4618 usb_ep0_reinit(udev
);
4619 release_devnum(udev
);
4622 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4625 if (hub
->hdev
->parent
||
4626 !hcd
->driver
->port_handed_over
||
4627 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4628 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4629 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4634 hub_port_disable(hub
, port1
, 1);
4635 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4636 hcd
->driver
->relinquish_port(hcd
, port1
);
4639 /* Returns 1 if there was a remote wakeup and a connect status change. */
4640 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4641 u16 portstatus
, u16 portchange
)
4643 struct usb_device
*hdev
;
4644 struct usb_device
*udev
;
4645 int connect_change
= 0;
4649 udev
= hub
->ports
[port
- 1]->child
;
4650 if (!hub_is_superspeed(hdev
)) {
4651 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4653 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4655 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4656 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4662 /* TRSMRCY = 10 msec */
4665 usb_lock_device(udev
);
4666 ret
= usb_remote_wakeup(udev
);
4667 usb_unlock_device(udev
);
4672 hub_port_disable(hub
, port
, 1);
4674 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4676 return connect_change
;
4679 static void hub_events(void)
4681 struct list_head
*tmp
;
4682 struct usb_device
*hdev
;
4683 struct usb_interface
*intf
;
4684 struct usb_hub
*hub
;
4685 struct device
*hub_dev
;
4691 int connect_change
, wakeup_change
;
4694 * We restart the list every time to avoid a deadlock with
4695 * deleting hubs downstream from this one. This should be
4696 * safe since we delete the hub from the event list.
4697 * Not the most efficient, but avoids deadlocks.
4701 /* Grab the first entry at the beginning of the list */
4702 spin_lock_irq(&hub_event_lock
);
4703 if (list_empty(&hub_event_list
)) {
4704 spin_unlock_irq(&hub_event_lock
);
4708 tmp
= hub_event_list
.next
;
4711 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4712 kref_get(&hub
->kref
);
4715 spin_unlock_irq(&hub_event_lock
);
4717 hub_dev
= hub
->intfdev
;
4718 intf
= to_usb_interface(hub_dev
);
4719 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4720 hdev
->state
, hub
->descriptor
4721 ? hub
->descriptor
->bNbrPorts
4723 /* NOTE: expects max 15 ports... */
4724 (u16
) hub
->change_bits
[0],
4725 (u16
) hub
->event_bits
[0]);
4727 /* Lock the device, then check to see if we were
4728 * disconnected while waiting for the lock to succeed. */
4729 usb_lock_device(hdev
);
4730 if (unlikely(hub
->disconnected
))
4731 goto loop_disconnected
;
4733 /* If the hub has died, clean up after it */
4734 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4735 hub
->error
= -ENODEV
;
4736 hub_quiesce(hub
, HUB_DISCONNECT
);
4741 ret
= usb_autopm_get_interface(intf
);
4743 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4747 /* If this is an inactive hub, do nothing */
4752 dev_dbg (hub_dev
, "resetting for error %d\n",
4755 ret
= usb_reset_device(hdev
);
4758 "error resetting hub: %d\n", ret
);
4766 /* deal with port status changes */
4767 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4768 if (test_bit(i
, hub
->busy_bits
))
4770 connect_change
= test_bit(i
, hub
->change_bits
);
4771 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4772 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4773 !connect_change
&& !wakeup_change
)
4776 ret
= hub_port_status(hub
, i
,
4777 &portstatus
, &portchange
);
4781 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4782 usb_clear_port_feature(hdev
, i
,
4783 USB_PORT_FEAT_C_CONNECTION
);
4787 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4788 if (!connect_change
)
4790 "port %d enable change, "
4793 usb_clear_port_feature(hdev
, i
,
4794 USB_PORT_FEAT_C_ENABLE
);
4797 * EM interference sometimes causes badly
4798 * shielded USB devices to be shutdown by
4799 * the hub, this hack enables them again.
4800 * Works at least with mouse driver.
4802 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4804 && hub
->ports
[i
- 1]->child
) {
4807 "disabled by hub (EMI?), "
4814 if (hub_handle_remote_wakeup(hub
, i
,
4815 portstatus
, portchange
))
4818 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4822 dev_dbg(hub_dev
, "over-current change on port "
4824 usb_clear_port_feature(hdev
, i
,
4825 USB_PORT_FEAT_C_OVER_CURRENT
);
4826 msleep(100); /* Cool down */
4827 hub_power_on(hub
, true);
4828 hub_port_status(hub
, i
, &status
, &unused
);
4829 if (status
& USB_PORT_STAT_OVERCURRENT
)
4830 dev_err(hub_dev
, "over-current "
4831 "condition on port %d\n", i
);
4834 if (portchange
& USB_PORT_STAT_C_RESET
) {
4836 "reset change on port %d\n",
4838 usb_clear_port_feature(hdev
, i
,
4839 USB_PORT_FEAT_C_RESET
);
4841 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4842 hub_is_superspeed(hub
->hdev
)) {
4844 "warm reset change on port %d\n",
4846 usb_clear_port_feature(hdev
, i
,
4847 USB_PORT_FEAT_C_BH_PORT_RESET
);
4849 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4850 usb_clear_port_feature(hub
->hdev
, i
,
4851 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4853 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4855 "config error on port %d\n",
4857 usb_clear_port_feature(hub
->hdev
, i
,
4858 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4861 /* Warm reset a USB3 protocol port if it's in
4862 * SS.Inactive state.
4864 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4866 struct usb_device
*udev
=
4867 hub
->ports
[i
- 1]->child
;
4869 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4871 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4872 udev
->state
== USB_STATE_NOTATTACHED
) {
4873 status
= hub_port_reset(hub
, i
,
4874 NULL
, HUB_BH_RESET_TIME
,
4877 hub_port_disable(hub
, i
, 1);
4879 usb_lock_device(udev
);
4880 status
= usb_reset_device(udev
);
4881 usb_unlock_device(udev
);
4887 hub_port_connect_change(hub
, i
,
4888 portstatus
, portchange
);
4891 /* deal with hub status changes */
4892 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4894 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4895 dev_err (hub_dev
, "get_hub_status failed\n");
4897 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4898 dev_dbg (hub_dev
, "power change\n");
4899 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4900 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4901 /* FIXME: Is this always true? */
4902 hub
->limited_power
= 1;
4904 hub
->limited_power
= 0;
4906 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4910 dev_dbg(hub_dev
, "over-current change\n");
4911 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4912 msleep(500); /* Cool down */
4913 hub_power_on(hub
, true);
4914 hub_hub_status(hub
, &status
, &unused
);
4915 if (status
& HUB_STATUS_OVERCURRENT
)
4916 dev_err(hub_dev
, "over-current "
4922 /* Balance the usb_autopm_get_interface() above */
4923 usb_autopm_put_interface_no_suspend(intf
);
4925 /* Balance the usb_autopm_get_interface_no_resume() in
4926 * kick_khubd() and allow autosuspend.
4928 usb_autopm_put_interface(intf
);
4930 usb_unlock_device(hdev
);
4932 kref_put(&hub
->kref
, hub_release
);
4934 } /* end while (1) */
4937 static int hub_thread(void *__unused
)
4939 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4940 * port handover. Otherwise it might see that a full-speed device
4941 * was gone before the EHCI controller had handed its port over to
4942 * the companion full-speed controller.
4948 wait_event_freezable(khubd_wait
,
4949 !list_empty(&hub_event_list
) ||
4950 kthread_should_stop());
4951 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4953 pr_debug("%s: khubd exiting\n", usbcore_name
);
4957 static const struct usb_device_id hub_id_table
[] = {
4958 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4959 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4960 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4961 .bInterfaceClass
= USB_CLASS_HUB
,
4962 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4963 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4964 .bDeviceClass
= USB_CLASS_HUB
},
4965 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4966 .bInterfaceClass
= USB_CLASS_HUB
},
4967 { } /* Terminating entry */
4970 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4972 static struct usb_driver hub_driver
= {
4975 .disconnect
= hub_disconnect
,
4976 .suspend
= hub_suspend
,
4977 .resume
= hub_resume
,
4978 .reset_resume
= hub_reset_resume
,
4979 .pre_reset
= hub_pre_reset
,
4980 .post_reset
= hub_post_reset
,
4981 .unlocked_ioctl
= hub_ioctl
,
4982 .id_table
= hub_id_table
,
4983 .supports_autosuspend
= 1,
4986 int usb_hub_init(void)
4988 if (usb_register(&hub_driver
) < 0) {
4989 printk(KERN_ERR
"%s: can't register hub driver\n",
4994 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4995 if (!IS_ERR(khubd_task
))
4998 /* Fall through if kernel_thread failed */
4999 usb_deregister(&hub_driver
);
5000 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
5005 void usb_hub_cleanup(void)
5007 kthread_stop(khubd_task
);
5010 * Hub resources are freed for us by usb_deregister. It calls
5011 * usb_driver_purge on every device which in turn calls that
5012 * devices disconnect function if it is using this driver.
5013 * The hub_disconnect function takes care of releasing the
5014 * individual hub resources. -greg
5016 usb_deregister(&hub_driver
);
5017 } /* usb_hub_cleanup() */
5019 static int descriptors_changed(struct usb_device
*udev
,
5020 struct usb_device_descriptor
*old_device_descriptor
)
5024 unsigned serial_len
= 0;
5026 unsigned old_length
;
5030 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5031 sizeof(*old_device_descriptor
)) != 0)
5034 /* Since the idVendor, idProduct, and bcdDevice values in the
5035 * device descriptor haven't changed, we will assume the
5036 * Manufacturer and Product strings haven't changed either.
5037 * But the SerialNumber string could be different (e.g., a
5038 * different flash card of the same brand).
5041 serial_len
= strlen(udev
->serial
) + 1;
5044 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5045 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5046 len
= max(len
, old_length
);
5049 buf
= kmalloc(len
, GFP_NOIO
);
5051 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5052 /* assume the worst */
5055 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5056 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5057 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5059 if (length
!= old_length
) {
5060 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5065 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5067 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5069 ((struct usb_config_descriptor
*) buf
)->
5070 bConfigurationValue
);
5076 if (!changed
&& serial_len
) {
5077 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5079 if (length
+ 1 != serial_len
) {
5080 dev_dbg(&udev
->dev
, "serial string error %d\n",
5083 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5084 dev_dbg(&udev
->dev
, "serial string changed\n");
5094 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5095 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5097 * WARNING - don't use this routine to reset a composite device
5098 * (one with multiple interfaces owned by separate drivers)!
5099 * Use usb_reset_device() instead.
5101 * Do a port reset, reassign the device's address, and establish its
5102 * former operating configuration. If the reset fails, or the device's
5103 * descriptors change from their values before the reset, or the original
5104 * configuration and altsettings cannot be restored, a flag will be set
5105 * telling khubd to pretend the device has been disconnected and then
5106 * re-connected. All drivers will be unbound, and the device will be
5107 * re-enumerated and probed all over again.
5109 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5110 * flagged for logical disconnection, or some other negative error code
5111 * if the reset wasn't even attempted.
5113 * The caller must own the device lock. For example, it's safe to use
5114 * this from a driver probe() routine after downloading new firmware.
5115 * For calls that might not occur during probe(), drivers should lock
5116 * the device using usb_lock_device_for_reset().
5118 * Locking exception: This routine may also be called from within an
5119 * autoresume handler. Such usage won't conflict with other tasks
5120 * holding the device lock because these tasks should always call
5121 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5123 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5125 struct usb_device
*parent_hdev
= udev
->parent
;
5126 struct usb_hub
*parent_hub
;
5127 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5128 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5130 int port1
= udev
->portnum
;
5132 if (udev
->state
== USB_STATE_NOTATTACHED
||
5133 udev
->state
== USB_STATE_SUSPENDED
) {
5134 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5140 /* this requires hcd-specific logic; see ohci_restart() */
5141 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5144 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5146 /* Disable LPM and LTM while we reset the device and reinstall the alt
5147 * settings. Device-initiated LPM settings, and system exit latency
5148 * settings are cleared when the device is reset, so we have to set
5151 ret
= usb_unlocked_disable_lpm(udev
);
5153 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5156 ret
= usb_disable_ltm(udev
);
5158 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5163 set_bit(port1
, parent_hub
->busy_bits
);
5164 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5166 /* ep0 maxpacket size may change; let the HCD know about it.
5167 * Other endpoints will be handled by re-enumeration. */
5168 usb_ep0_reinit(udev
);
5169 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5170 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5173 clear_bit(port1
, parent_hub
->busy_bits
);
5178 /* Device might have changed firmware (DFU or similar) */
5179 if (descriptors_changed(udev
, &descriptor
)) {
5180 dev_info(&udev
->dev
, "device firmware changed\n");
5181 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5185 /* Restore the device's previous configuration */
5186 if (!udev
->actconfig
)
5189 mutex_lock(hcd
->bandwidth_mutex
);
5190 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5192 dev_warn(&udev
->dev
,
5193 "Busted HC? Not enough HCD resources for "
5194 "old configuration.\n");
5195 mutex_unlock(hcd
->bandwidth_mutex
);
5198 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5199 USB_REQ_SET_CONFIGURATION
, 0,
5200 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5201 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5204 "can't restore configuration #%d (error=%d)\n",
5205 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5206 mutex_unlock(hcd
->bandwidth_mutex
);
5209 mutex_unlock(hcd
->bandwidth_mutex
);
5210 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5212 /* Put interfaces back into the same altsettings as before.
5213 * Don't bother to send the Set-Interface request for interfaces
5214 * that were already in altsetting 0; besides being unnecessary,
5215 * many devices can't handle it. Instead just reset the host-side
5218 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5219 struct usb_host_config
*config
= udev
->actconfig
;
5220 struct usb_interface
*intf
= config
->interface
[i
];
5221 struct usb_interface_descriptor
*desc
;
5223 desc
= &intf
->cur_altsetting
->desc
;
5224 if (desc
->bAlternateSetting
== 0) {
5225 usb_disable_interface(udev
, intf
, true);
5226 usb_enable_interface(udev
, intf
, true);
5229 /* Let the bandwidth allocation function know that this
5230 * device has been reset, and it will have to use
5231 * alternate setting 0 as the current alternate setting.
5233 intf
->resetting_device
= 1;
5234 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5235 desc
->bAlternateSetting
);
5236 intf
->resetting_device
= 0;
5239 dev_err(&udev
->dev
, "failed to restore interface %d "
5240 "altsetting %d (error=%d)\n",
5241 desc
->bInterfaceNumber
,
5242 desc
->bAlternateSetting
,
5249 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5250 usb_unlocked_enable_lpm(udev
);
5251 usb_enable_ltm(udev
);
5255 /* LPM state doesn't matter when we're about to destroy the device. */
5256 hub_port_logical_disconnect(parent_hub
, port1
);
5261 * usb_reset_device - warn interface drivers and perform a USB port reset
5262 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5264 * Warns all drivers bound to registered interfaces (using their pre_reset
5265 * method), performs the port reset, and then lets the drivers know that
5266 * the reset is over (using their post_reset method).
5268 * Return value is the same as for usb_reset_and_verify_device().
5270 * The caller must own the device lock. For example, it's safe to use
5271 * this from a driver probe() routine after downloading new firmware.
5272 * For calls that might not occur during probe(), drivers should lock
5273 * the device using usb_lock_device_for_reset().
5275 * If an interface is currently being probed or disconnected, we assume
5276 * its driver knows how to handle resets. For all other interfaces,
5277 * if the driver doesn't have pre_reset and post_reset methods then
5278 * we attempt to unbind it and rebind afterward.
5280 int usb_reset_device(struct usb_device
*udev
)
5284 unsigned int noio_flag
;
5285 struct usb_host_config
*config
= udev
->actconfig
;
5287 if (udev
->state
== USB_STATE_NOTATTACHED
||
5288 udev
->state
== USB_STATE_SUSPENDED
) {
5289 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5295 * Don't allocate memory with GFP_KERNEL in current
5296 * context to avoid possible deadlock if usb mass
5297 * storage interface or usbnet interface(iSCSI case)
5298 * is included in current configuration. The easist
5299 * approach is to do it for every device reset,
5300 * because the device 'memalloc_noio' flag may have
5301 * not been set before reseting the usb device.
5303 noio_flag
= memalloc_noio_save();
5305 /* Prevent autosuspend during the reset */
5306 usb_autoresume_device(udev
);
5309 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5310 struct usb_interface
*cintf
= config
->interface
[i
];
5311 struct usb_driver
*drv
;
5314 if (cintf
->dev
.driver
) {
5315 drv
= to_usb_driver(cintf
->dev
.driver
);
5316 if (drv
->pre_reset
&& drv
->post_reset
)
5317 unbind
= (drv
->pre_reset
)(cintf
);
5318 else if (cintf
->condition
==
5319 USB_INTERFACE_BOUND
)
5322 usb_forced_unbind_intf(cintf
);
5327 ret
= usb_reset_and_verify_device(udev
);
5330 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5331 struct usb_interface
*cintf
= config
->interface
[i
];
5332 struct usb_driver
*drv
;
5333 int rebind
= cintf
->needs_binding
;
5335 if (!rebind
&& cintf
->dev
.driver
) {
5336 drv
= to_usb_driver(cintf
->dev
.driver
);
5337 if (drv
->post_reset
)
5338 rebind
= (drv
->post_reset
)(cintf
);
5339 else if (cintf
->condition
==
5340 USB_INTERFACE_BOUND
)
5343 cintf
->needs_binding
= 1;
5346 usb_unbind_and_rebind_marked_interfaces(udev
);
5349 usb_autosuspend_device(udev
);
5350 memalloc_noio_restore(noio_flag
);
5353 EXPORT_SYMBOL_GPL(usb_reset_device
);
5357 * usb_queue_reset_device - Reset a USB device from an atomic context
5358 * @iface: USB interface belonging to the device to reset
5360 * This function can be used to reset a USB device from an atomic
5361 * context, where usb_reset_device() won't work (as it blocks).
5363 * Doing a reset via this method is functionally equivalent to calling
5364 * usb_reset_device(), except for the fact that it is delayed to a
5365 * workqueue. This means that any drivers bound to other interfaces
5366 * might be unbound, as well as users from usbfs in user space.
5370 * - Scheduling two resets at the same time from two different drivers
5371 * attached to two different interfaces of the same device is
5372 * possible; depending on how the driver attached to each interface
5373 * handles ->pre_reset(), the second reset might happen or not.
5375 * - If a driver is unbound and it had a pending reset, the reset will
5378 * - This function can be called during .probe() or .disconnect()
5379 * times. On return from .disconnect(), any pending resets will be
5382 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5385 * NOTE: We don't do any reference count tracking because it is not
5386 * needed. The lifecycle of the work_struct is tied to the
5387 * usb_interface. Before destroying the interface we cancel the
5388 * work_struct, so the fact that work_struct is queued and or
5389 * running means the interface (and thus, the device) exist and
5392 void usb_queue_reset_device(struct usb_interface
*iface
)
5394 schedule_work(&iface
->reset_ws
);
5396 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5399 * usb_hub_find_child - Get the pointer of child device
5400 * attached to the port which is specified by @port1.
5401 * @hdev: USB device belonging to the usb hub
5402 * @port1: port num to indicate which port the child device
5405 * USB drivers call this function to get hub's child device
5408 * Return NULL if input param is invalid and
5409 * child's usb_device pointer if non-NULL.
5411 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5414 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5416 if (port1
< 1 || port1
> hdev
->maxchild
)
5418 return hub
->ports
[port1
- 1]->child
;
5420 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5423 * usb_set_hub_port_connect_type - set hub port connect type.
5424 * @hdev: USB device belonging to the usb hub
5425 * @port1: port num of the port
5426 * @type: connect type of the port
5428 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5429 enum usb_port_connect_type type
)
5431 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5433 hub
->ports
[port1
- 1]->connect_type
= type
;
5437 * usb_get_hub_port_connect_type - Get the port's connect type
5438 * @hdev: USB device belonging to the usb hub
5439 * @port1: port num of the port
5441 * Return connect type of the port and if input params are
5442 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5444 enum usb_port_connect_type
5445 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5447 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5449 return hub
->ports
[port1
- 1]->connect_type
;
5452 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5453 struct usb_hub_descriptor
*desc
)
5455 enum usb_port_connect_type connect_type
;
5458 if (!hub_is_superspeed(hdev
)) {
5459 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5460 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5462 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5463 u8 mask
= 1 << (i
%8);
5465 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5466 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5468 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5473 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5475 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5476 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5478 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5481 if (!(port_removable
& mask
)) {
5482 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5484 port_removable
|= mask
;
5489 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5495 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5496 * @hdev: USB device belonging to the usb hub
5497 * @port1: port num of the port
5499 * Return port's acpi handle if successful, NULL if params are
5502 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5505 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5507 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);