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 /* USB 2.1 (and greater) devices indicate LPM support through
141 * their USB 2.0 Extended Capabilities BOS descriptor.
143 if (udev
->speed
== USB_SPEED_HIGH
) {
144 if (udev
->bos
->ext_cap
&&
146 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
151 /* All USB 3.0 must support LPM, but we need their max exit latency
152 * information from the SuperSpeed Extended Capabilities BOS descriptor.
154 if (!udev
->bos
->ss_cap
) {
155 dev_warn(&udev
->dev
, "No LPM exit latency info found. "
156 "Power management will be impacted.\n");
159 if (udev
->parent
->lpm_capable
)
162 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
163 "Power management will be impacted.\n");
168 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
171 static void usb_set_lpm_mel(struct usb_device
*udev
,
172 struct usb3_lpm_parameters
*udev_lpm_params
,
173 unsigned int udev_exit_latency
,
175 struct usb3_lpm_parameters
*hub_lpm_params
,
176 unsigned int hub_exit_latency
)
178 unsigned int total_mel
;
179 unsigned int device_mel
;
180 unsigned int hub_mel
;
183 * Calculate the time it takes to transition all links from the roothub
184 * to the parent hub into U0. The parent hub must then decode the
185 * packet (hub header decode latency) to figure out which port it was
188 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
189 * means 0.1us). Multiply that by 100 to get nanoseconds.
191 total_mel
= hub_lpm_params
->mel
+
192 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
195 * How long will it take to transition the downstream hub's port into
196 * U0? The greater of either the hub exit latency or the device exit
199 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
200 * Multiply that by 1000 to get nanoseconds.
202 device_mel
= udev_exit_latency
* 1000;
203 hub_mel
= hub_exit_latency
* 1000;
204 if (device_mel
> hub_mel
)
205 total_mel
+= device_mel
;
207 total_mel
+= hub_mel
;
209 udev_lpm_params
->mel
= total_mel
;
213 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
214 * a transition from either U1 or U2.
216 static void usb_set_lpm_pel(struct usb_device
*udev
,
217 struct usb3_lpm_parameters
*udev_lpm_params
,
218 unsigned int udev_exit_latency
,
220 struct usb3_lpm_parameters
*hub_lpm_params
,
221 unsigned int hub_exit_latency
,
222 unsigned int port_to_port_exit_latency
)
224 unsigned int first_link_pel
;
225 unsigned int hub_pel
;
228 * First, the device sends an LFPS to transition the link between the
229 * device and the parent hub into U0. The exit latency is the bigger of
230 * the device exit latency or the hub exit latency.
232 if (udev_exit_latency
> hub_exit_latency
)
233 first_link_pel
= udev_exit_latency
* 1000;
235 first_link_pel
= hub_exit_latency
* 1000;
238 * When the hub starts to receive the LFPS, there is a slight delay for
239 * it to figure out that one of the ports is sending an LFPS. Then it
240 * will forward the LFPS to its upstream link. The exit latency is the
241 * delay, plus the PEL that we calculated for this hub.
243 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
246 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
247 * is the greater of the two exit latencies.
249 if (first_link_pel
> hub_pel
)
250 udev_lpm_params
->pel
= first_link_pel
;
252 udev_lpm_params
->pel
= hub_pel
;
256 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
257 * when a device initiates a transition to U0, until when it will receive the
258 * first packet from the host controller.
260 * Section C.1.5.1 describes the four components to this:
262 * - t2: time for the ERDY to make it from the device to the host.
263 * - t3: a host-specific delay to process the ERDY.
264 * - t4: time for the packet to make it from the host to the device.
266 * t3 is specific to both the xHCI host and the platform the host is integrated
267 * into. The Intel HW folks have said it's negligible, FIXME if a different
268 * vendor says otherwise.
270 static void usb_set_lpm_sel(struct usb_device
*udev
,
271 struct usb3_lpm_parameters
*udev_lpm_params
)
273 struct usb_device
*parent
;
274 unsigned int num_hubs
;
275 unsigned int total_sel
;
277 /* t1 = device PEL */
278 total_sel
= udev_lpm_params
->pel
;
279 /* How many external hubs are in between the device & the root port. */
280 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
281 parent
= parent
->parent
)
283 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
285 total_sel
+= 2100 + 250 * (num_hubs
- 1);
287 /* t4 = 250ns * num_hubs */
288 total_sel
+= 250 * num_hubs
;
290 udev_lpm_params
->sel
= total_sel
;
293 static void usb_set_lpm_parameters(struct usb_device
*udev
)
296 unsigned int port_to_port_delay
;
297 unsigned int udev_u1_del
;
298 unsigned int udev_u2_del
;
299 unsigned int hub_u1_del
;
300 unsigned int hub_u2_del
;
302 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
305 hub
= usb_hub_to_struct_hub(udev
->parent
);
306 /* It doesn't take time to transition the roothub into U0, since it
307 * doesn't have an upstream link.
312 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
313 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
314 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
315 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
317 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
318 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
320 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
321 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
324 * Appendix C, section C.2.2.2, says that there is a slight delay from
325 * when the parent hub notices the downstream port is trying to
326 * transition to U0 to when the hub initiates a U0 transition on its
327 * upstream port. The section says the delays are tPort2PortU1EL and
328 * tPort2PortU2EL, but it doesn't define what they are.
330 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
331 * about the same delays. Use the maximum delay calculations from those
332 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
333 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
334 * assume the device exit latencies they are talking about are the hub
337 * What do we do if the U2 exit latency is less than the U1 exit
338 * latency? It's possible, although not likely...
340 port_to_port_delay
= 1;
342 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
343 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
346 if (hub_u2_del
> hub_u1_del
)
347 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
349 port_to_port_delay
= 1 + hub_u1_del
;
351 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
352 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
355 /* Now that we've got PEL, calculate SEL. */
356 usb_set_lpm_sel(udev
, &udev
->u1_params
);
357 usb_set_lpm_sel(udev
, &udev
->u2_params
);
360 /* USB 2.0 spec Section 11.24.4.5 */
361 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
366 if (hub_is_superspeed(hdev
)) {
367 dtype
= USB_DT_SS_HUB
;
368 size
= USB_DT_SS_HUB_SIZE
;
371 size
= sizeof(struct usb_hub_descriptor
);
374 for (i
= 0; i
< 3; i
++) {
375 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
376 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
377 dtype
<< 8, 0, data
, size
,
378 USB_CTRL_GET_TIMEOUT
);
379 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
386 * USB 2.0 spec Section 11.24.2.1
388 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
390 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
391 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
395 * USB 2.0 spec Section 11.24.2.2
397 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
399 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
400 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
405 * USB 2.0 spec Section 11.24.2.13
407 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
409 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
410 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
415 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
416 * for info about using port indicators
418 static void set_port_led(
424 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
425 USB_PORT_FEAT_INDICATOR
);
427 dev_dbg (hub
->intfdev
,
428 "port %d indicator %s status %d\n",
430 ({ char *s
; switch (selector
) {
431 case HUB_LED_AMBER
: s
= "amber"; break;
432 case HUB_LED_GREEN
: s
= "green"; break;
433 case HUB_LED_OFF
: s
= "off"; break;
434 case HUB_LED_AUTO
: s
= "auto"; break;
435 default: s
= "??"; break;
440 #define LED_CYCLE_PERIOD ((2*HZ)/3)
442 static void led_work (struct work_struct
*work
)
444 struct usb_hub
*hub
=
445 container_of(work
, struct usb_hub
, leds
.work
);
446 struct usb_device
*hdev
= hub
->hdev
;
448 unsigned changed
= 0;
451 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
454 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
455 unsigned selector
, mode
;
457 /* 30%-50% duty cycle */
459 switch (hub
->indicator
[i
]) {
461 case INDICATOR_CYCLE
:
463 selector
= HUB_LED_AUTO
;
464 mode
= INDICATOR_AUTO
;
466 /* blinking green = sw attention */
467 case INDICATOR_GREEN_BLINK
:
468 selector
= HUB_LED_GREEN
;
469 mode
= INDICATOR_GREEN_BLINK_OFF
;
471 case INDICATOR_GREEN_BLINK_OFF
:
472 selector
= HUB_LED_OFF
;
473 mode
= INDICATOR_GREEN_BLINK
;
475 /* blinking amber = hw attention */
476 case INDICATOR_AMBER_BLINK
:
477 selector
= HUB_LED_AMBER
;
478 mode
= INDICATOR_AMBER_BLINK_OFF
;
480 case INDICATOR_AMBER_BLINK_OFF
:
481 selector
= HUB_LED_OFF
;
482 mode
= INDICATOR_AMBER_BLINK
;
484 /* blink green/amber = reserved */
485 case INDICATOR_ALT_BLINK
:
486 selector
= HUB_LED_GREEN
;
487 mode
= INDICATOR_ALT_BLINK_OFF
;
489 case INDICATOR_ALT_BLINK_OFF
:
490 selector
= HUB_LED_AMBER
;
491 mode
= INDICATOR_ALT_BLINK
;
496 if (selector
!= HUB_LED_AUTO
)
498 set_port_led(hub
, i
+ 1, selector
);
499 hub
->indicator
[i
] = mode
;
501 if (!changed
&& blinkenlights
) {
503 cursor
%= hub
->descriptor
->bNbrPorts
;
504 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
505 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
509 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
512 /* use a short timeout for hub/port status fetches */
513 #define USB_STS_TIMEOUT 1000
514 #define USB_STS_RETRIES 5
517 * USB 2.0 spec Section 11.24.2.6
519 static int get_hub_status(struct usb_device
*hdev
,
520 struct usb_hub_status
*data
)
522 int i
, status
= -ETIMEDOUT
;
524 for (i
= 0; i
< USB_STS_RETRIES
&&
525 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
526 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
527 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
528 data
, sizeof(*data
), USB_STS_TIMEOUT
);
534 * USB 2.0 spec Section 11.24.2.7
536 static int get_port_status(struct usb_device
*hdev
, int port1
,
537 struct usb_port_status
*data
)
539 int i
, status
= -ETIMEDOUT
;
541 for (i
= 0; i
< USB_STS_RETRIES
&&
542 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
543 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
544 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
545 data
, sizeof(*data
), USB_STS_TIMEOUT
);
550 static int hub_port_status(struct usb_hub
*hub
, int port1
,
551 u16
*status
, u16
*change
)
555 mutex_lock(&hub
->status_mutex
);
556 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
559 dev_err(hub
->intfdev
,
560 "%s failed (err = %d)\n", __func__
, ret
);
564 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
565 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
569 mutex_unlock(&hub
->status_mutex
);
573 static void kick_khubd(struct usb_hub
*hub
)
577 spin_lock_irqsave(&hub_event_lock
, flags
);
578 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
579 list_add_tail(&hub
->event_list
, &hub_event_list
);
581 /* Suppress autosuspend until khubd runs */
582 usb_autopm_get_interface_no_resume(
583 to_usb_interface(hub
->intfdev
));
584 wake_up(&khubd_wait
);
586 spin_unlock_irqrestore(&hub_event_lock
, flags
);
589 void usb_kick_khubd(struct usb_device
*hdev
)
591 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
598 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
599 * Notification, which indicates it had initiated remote wakeup.
601 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
602 * device initiates resume, so the USB core will not receive notice of the
603 * resume through the normal hub interrupt URB.
605 void usb_wakeup_notification(struct usb_device
*hdev
,
606 unsigned int portnum
)
613 hub
= usb_hub_to_struct_hub(hdev
);
615 set_bit(portnum
, hub
->wakeup_bits
);
619 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
621 /* completion function, fires on port status changes and various faults */
622 static void hub_irq(struct urb
*urb
)
624 struct usb_hub
*hub
= urb
->context
;
625 int status
= urb
->status
;
630 case -ENOENT
: /* synchronous unlink */
631 case -ECONNRESET
: /* async unlink */
632 case -ESHUTDOWN
: /* hardware going away */
635 default: /* presumably an error */
636 /* Cause a hub reset after 10 consecutive errors */
637 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
638 if ((++hub
->nerrors
< 10) || hub
->error
)
643 /* let khubd handle things */
644 case 0: /* we got data: port status changed */
646 for (i
= 0; i
< urb
->actual_length
; ++i
)
647 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
649 hub
->event_bits
[0] = bits
;
655 /* Something happened, let khubd figure it out */
662 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
663 && status
!= -ENODEV
&& status
!= -EPERM
)
664 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
667 /* USB 2.0 spec Section 11.24.2.3 */
669 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
671 /* Need to clear both directions for control ep */
672 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
673 USB_ENDPOINT_XFER_CONTROL
) {
674 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
675 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
676 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
680 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
681 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
686 * enumeration blocks khubd for a long time. we use keventd instead, since
687 * long blocking there is the exception, not the rule. accordingly, HCDs
688 * talking to TTs must queue control transfers (not just bulk and iso), so
689 * both can talk to the same hub concurrently.
691 static void hub_tt_work(struct work_struct
*work
)
693 struct usb_hub
*hub
=
694 container_of(work
, struct usb_hub
, tt
.clear_work
);
697 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
698 while (!list_empty(&hub
->tt
.clear_list
)) {
699 struct list_head
*next
;
700 struct usb_tt_clear
*clear
;
701 struct usb_device
*hdev
= hub
->hdev
;
702 const struct hc_driver
*drv
;
705 next
= hub
->tt
.clear_list
.next
;
706 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
707 list_del (&clear
->clear_list
);
709 /* drop lock so HCD can concurrently report other TT errors */
710 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
711 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
712 if (status
&& status
!= -ENODEV
)
714 "clear tt %d (%04x) error %d\n",
715 clear
->tt
, clear
->devinfo
, status
);
717 /* Tell the HCD, even if the operation failed */
718 drv
= clear
->hcd
->driver
;
719 if (drv
->clear_tt_buffer_complete
)
720 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
723 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
725 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
729 * usb_hub_set_port_power - control hub port's power state
732 * @set: expected status
734 * call this function to control port's power via setting or
735 * clearing the port's PORT_POWER feature.
737 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
741 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
742 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
745 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
747 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
750 port_dev
->power_is_on
= set
;
755 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
756 * @urb: an URB associated with the failed or incomplete split transaction
758 * High speed HCDs use this to tell the hub driver that some split control or
759 * bulk transaction failed in a way that requires clearing internal state of
760 * a transaction translator. This is normally detected (and reported) from
763 * It may not be possible for that hub to handle additional full (or low)
764 * speed transactions until that state is fully cleared out.
766 int usb_hub_clear_tt_buffer(struct urb
*urb
)
768 struct usb_device
*udev
= urb
->dev
;
769 int pipe
= urb
->pipe
;
770 struct usb_tt
*tt
= udev
->tt
;
772 struct usb_tt_clear
*clear
;
774 /* we've got to cope with an arbitrary number of pending TT clears,
775 * since each TT has "at least two" buffers that can need it (and
776 * there can be many TTs per hub). even if they're uncommon.
778 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
779 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
780 /* FIXME recover somehow ... RESET_TT? */
784 /* info that CLEAR_TT_BUFFER needs */
785 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
786 clear
->devinfo
= usb_pipeendpoint (pipe
);
787 clear
->devinfo
|= udev
->devnum
<< 4;
788 clear
->devinfo
|= usb_pipecontrol (pipe
)
789 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
790 : (USB_ENDPOINT_XFER_BULK
<< 11);
791 if (usb_pipein (pipe
))
792 clear
->devinfo
|= 1 << 15;
794 /* info for completion callback */
795 clear
->hcd
= bus_to_hcd(udev
->bus
);
798 /* tell keventd to clear state for this TT */
799 spin_lock_irqsave (&tt
->lock
, flags
);
800 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
801 schedule_work(&tt
->clear_work
);
802 spin_unlock_irqrestore (&tt
->lock
, flags
);
805 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
807 /* If do_delay is false, return the number of milliseconds the caller
810 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
813 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
815 u16 wHubCharacteristics
=
816 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
818 /* Enable power on each port. Some hubs have reserved values
819 * of LPSM (> 2) in their descriptors, even though they are
820 * USB 2.0 hubs. Some hubs do not implement port-power switching
821 * but only emulate it. In all cases, the ports won't work
822 * unless we send these messages to the hub.
824 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
825 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
827 dev_dbg(hub
->intfdev
, "trying to enable port power on "
828 "non-switchable hub\n");
829 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
830 if (hub
->ports
[port1
- 1]->power_is_on
)
831 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
833 usb_clear_port_feature(hub
->hdev
, port1
,
834 USB_PORT_FEAT_POWER
);
836 /* Wait at least 100 msec for power to become stable */
837 delay
= max(pgood_delay
, (unsigned) 100);
843 static int hub_hub_status(struct usb_hub
*hub
,
844 u16
*status
, u16
*change
)
848 mutex_lock(&hub
->status_mutex
);
849 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
852 dev_err(hub
->intfdev
,
853 "%s failed (err = %d)\n", __func__
, ret
);
855 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
856 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
859 mutex_unlock(&hub
->status_mutex
);
863 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
864 unsigned int link_status
)
866 return set_port_feature(hub
->hdev
,
867 port1
| (link_status
<< 3),
868 USB_PORT_FEAT_LINK_STATE
);
872 * If USB 3.0 ports are placed into the Disabled state, they will no longer
873 * detect any device connects or disconnects. This is generally not what the
874 * USB core wants, since it expects a disabled port to produce a port status
875 * change event when a new device connects.
877 * Instead, set the link state to Disabled, wait for the link to settle into
878 * that state, clear any change bits, and then put the port into the RxDetect
881 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
885 u16 portchange
, portstatus
;
887 if (!hub_is_superspeed(hub
->hdev
))
890 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
895 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
896 * Controller [1022:7814] will have spurious result making the following
897 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
898 * as high-speed device if we set the usb 3.0 port link state to
899 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
900 * check the state here to avoid the bug.
902 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
903 USB_SS_PORT_LS_RX_DETECT
) {
904 dev_dbg(&hub
->ports
[port1
- 1]->dev
,
905 "Not disabling port; link state is RxDetect\n");
909 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
913 /* Wait for the link to enter the disabled state. */
914 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
915 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
919 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
920 USB_SS_PORT_LS_SS_DISABLED
)
922 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
924 msleep(HUB_DEBOUNCE_STEP
);
926 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
927 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
930 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
933 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
935 struct usb_device
*hdev
= hub
->hdev
;
938 if (hub
->ports
[port1
- 1]->child
&& set_state
)
939 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
940 USB_STATE_NOTATTACHED
);
942 if (hub_is_superspeed(hub
->hdev
))
943 ret
= hub_usb3_port_disable(hub
, port1
);
945 ret
= usb_clear_port_feature(hdev
, port1
,
946 USB_PORT_FEAT_ENABLE
);
948 if (ret
&& ret
!= -ENODEV
)
949 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
955 * Disable a port and mark a logical connect-change event, so that some
956 * time later khubd will disconnect() any existing usb_device on the port
957 * and will re-enumerate if there actually is a device attached.
959 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
961 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
962 hub_port_disable(hub
, port1
, 1);
964 /* FIXME let caller ask to power down the port:
965 * - some devices won't enumerate without a VBUS power cycle
966 * - SRP saves power that way
967 * - ... new call, TBD ...
968 * That's easy if this hub can switch power per-port, and
969 * khubd reactivates the port later (timer, SRP, etc).
970 * Powerdown must be optional, because of reset/DFU.
973 set_bit(port1
, hub
->change_bits
);
978 * usb_remove_device - disable a device's port on its parent hub
979 * @udev: device to be disabled and removed
980 * Context: @udev locked, must be able to sleep.
982 * After @udev's port has been disabled, khubd is notified and it will
983 * see that the device has been disconnected. When the device is
984 * physically unplugged and something is plugged in, the events will
985 * be received and processed normally.
987 int usb_remove_device(struct usb_device
*udev
)
990 struct usb_interface
*intf
;
992 if (!udev
->parent
) /* Can't remove a root hub */
994 hub
= usb_hub_to_struct_hub(udev
->parent
);
995 intf
= to_usb_interface(hub
->intfdev
);
997 usb_autopm_get_interface(intf
);
998 set_bit(udev
->portnum
, hub
->removed_bits
);
999 hub_port_logical_disconnect(hub
, udev
->portnum
);
1000 usb_autopm_put_interface(intf
);
1004 enum hub_activation_type
{
1005 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
1006 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
1009 static void hub_init_func2(struct work_struct
*ws
);
1010 static void hub_init_func3(struct work_struct
*ws
);
1012 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1014 struct usb_device
*hdev
= hub
->hdev
;
1015 struct usb_hcd
*hcd
;
1019 bool need_debounce_delay
= false;
1022 /* Continue a partial initialization */
1023 if (type
== HUB_INIT2
)
1025 if (type
== HUB_INIT3
)
1028 /* The superspeed hub except for root hub has to use Hub Depth
1029 * value as an offset into the route string to locate the bits
1030 * it uses to determine the downstream port number. So hub driver
1031 * should send a set hub depth request to superspeed hub after
1032 * the superspeed hub is set configuration in initialization or
1035 * After a resume, port power should still be on.
1036 * For any other type of activation, turn it on.
1038 if (type
!= HUB_RESUME
) {
1039 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1040 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1041 HUB_SET_DEPTH
, USB_RT_HUB
,
1042 hdev
->level
- 1, 0, NULL
, 0,
1043 USB_CTRL_SET_TIMEOUT
);
1045 dev_err(hub
->intfdev
,
1046 "set hub depth failed\n");
1049 /* Speed up system boot by using a delayed_work for the
1050 * hub's initial power-up delays. This is pretty awkward
1051 * and the implementation looks like a home-brewed sort of
1052 * setjmp/longjmp, but it saves at least 100 ms for each
1053 * root hub (assuming usbcore is compiled into the kernel
1054 * rather than as a module). It adds up.
1056 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1057 * because for those activation types the ports have to be
1058 * operational when we return. In theory this could be done
1059 * for HUB_POST_RESET, but it's easier not to.
1061 if (type
== HUB_INIT
) {
1062 delay
= hub_power_on(hub
, false);
1063 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1064 schedule_delayed_work(&hub
->init_work
,
1065 msecs_to_jiffies(delay
));
1067 /* Suppress autosuspend until init is done */
1068 usb_autopm_get_interface_no_resume(
1069 to_usb_interface(hub
->intfdev
));
1070 return; /* Continues at init2: below */
1071 } else if (type
== HUB_RESET_RESUME
) {
1072 /* The internal host controller state for the hub device
1073 * may be gone after a host power loss on system resume.
1074 * Update the device's info so the HW knows it's a hub.
1076 hcd
= bus_to_hcd(hdev
->bus
);
1077 if (hcd
->driver
->update_hub_device
) {
1078 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1079 &hub
->tt
, GFP_NOIO
);
1081 dev_err(hub
->intfdev
, "Host not "
1082 "accepting hub info "
1084 dev_err(hub
->intfdev
, "LS/FS devices "
1085 "and hubs may not work "
1086 "under this hub\n.");
1089 hub_power_on(hub
, true);
1091 hub_power_on(hub
, true);
1096 /* Check each port and set hub->change_bits to let khubd know
1097 * which ports need attention.
1099 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1100 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1101 u16 portstatus
, portchange
;
1103 portstatus
= portchange
= 0;
1104 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1105 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1106 dev_dbg(hub
->intfdev
,
1107 "port %d: status %04x change %04x\n",
1108 port1
, portstatus
, portchange
);
1110 /* After anything other than HUB_RESUME (i.e., initialization
1111 * or any sort of reset), every port should be disabled.
1112 * Unconnected ports should likewise be disabled (paranoia),
1113 * and so should ports for which we have no usb_device.
1115 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1116 type
!= HUB_RESUME
||
1117 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1119 udev
->state
== USB_STATE_NOTATTACHED
)) {
1121 * USB3 protocol ports will automatically transition
1122 * to Enabled state when detect an USB3.0 device attach.
1123 * Do not disable USB3 protocol ports.
1125 if (!hub_is_superspeed(hdev
)) {
1126 usb_clear_port_feature(hdev
, port1
,
1127 USB_PORT_FEAT_ENABLE
);
1128 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1130 /* Pretend that power was lost for USB3 devs */
1131 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1135 /* Clear status-change flags; we'll debounce later */
1136 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1137 need_debounce_delay
= true;
1138 usb_clear_port_feature(hub
->hdev
, port1
,
1139 USB_PORT_FEAT_C_CONNECTION
);
1141 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1142 need_debounce_delay
= true;
1143 usb_clear_port_feature(hub
->hdev
, port1
,
1144 USB_PORT_FEAT_C_ENABLE
);
1146 if (portchange
& USB_PORT_STAT_C_RESET
) {
1147 need_debounce_delay
= true;
1148 usb_clear_port_feature(hub
->hdev
, port1
,
1149 USB_PORT_FEAT_C_RESET
);
1151 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1152 hub_is_superspeed(hub
->hdev
)) {
1153 need_debounce_delay
= true;
1154 usb_clear_port_feature(hub
->hdev
, port1
,
1155 USB_PORT_FEAT_C_BH_PORT_RESET
);
1157 /* We can forget about a "removed" device when there's a
1158 * physical disconnect or the connect status changes.
1160 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1161 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1162 clear_bit(port1
, hub
->removed_bits
);
1164 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1165 /* Tell khubd to disconnect the device or
1166 * check for a new connection
1168 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1169 set_bit(port1
, hub
->change_bits
);
1171 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1172 bool port_resumed
= (portstatus
&
1173 USB_PORT_STAT_LINK_STATE
) ==
1175 /* The power session apparently survived the resume.
1176 * If there was an overcurrent or suspend change
1177 * (i.e., remote wakeup request), have khubd
1178 * take care of it. Look at the port link state
1179 * for USB 3.0 hubs, since they don't have a suspend
1180 * change bit, and they don't set the port link change
1181 * bit on device-initiated resume.
1183 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1185 set_bit(port1
, hub
->change_bits
);
1187 } else if (udev
->persist_enabled
) {
1188 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1191 udev
->reset_resume
= 1;
1193 /* Don't set the change_bits when the device
1196 if (port_dev
->power_is_on
)
1197 set_bit(port1
, hub
->change_bits
);
1200 /* The power session is gone; tell khubd */
1201 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1202 set_bit(port1
, hub
->change_bits
);
1206 /* If no port-status-change flags were set, we don't need any
1207 * debouncing. If flags were set we can try to debounce the
1208 * ports all at once right now, instead of letting khubd do them
1209 * one at a time later on.
1211 * If any port-status changes do occur during this delay, khubd
1212 * will see them later and handle them normally.
1214 if (need_debounce_delay
) {
1215 delay
= HUB_DEBOUNCE_STABLE
;
1217 /* Don't do a long sleep inside a workqueue routine */
1218 if (type
== HUB_INIT2
) {
1219 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1220 schedule_delayed_work(&hub
->init_work
,
1221 msecs_to_jiffies(delay
));
1222 return; /* Continues at init3: below */
1230 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1232 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1233 if (hub
->has_indicators
&& blinkenlights
)
1234 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1236 /* Scan all ports that need attention */
1239 /* Allow autosuspend if it was suppressed */
1240 if (type
<= HUB_INIT3
)
1241 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1244 /* Implement the continuations for the delays above */
1245 static void hub_init_func2(struct work_struct
*ws
)
1247 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1249 hub_activate(hub
, HUB_INIT2
);
1252 static void hub_init_func3(struct work_struct
*ws
)
1254 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1256 hub_activate(hub
, HUB_INIT3
);
1259 enum hub_quiescing_type
{
1260 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1263 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1265 struct usb_device
*hdev
= hub
->hdev
;
1268 cancel_delayed_work_sync(&hub
->init_work
);
1270 /* khubd and related activity won't re-trigger */
1273 if (type
!= HUB_SUSPEND
) {
1274 /* Disconnect all the children */
1275 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1276 if (hub
->ports
[i
]->child
)
1277 usb_disconnect(&hub
->ports
[i
]->child
);
1281 /* Stop khubd and related activity */
1282 usb_kill_urb(hub
->urb
);
1283 if (hub
->has_indicators
)
1284 cancel_delayed_work_sync(&hub
->leds
);
1286 flush_work(&hub
->tt
.clear_work
);
1289 /* caller has locked the hub device */
1290 static int hub_pre_reset(struct usb_interface
*intf
)
1292 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1294 hub_quiesce(hub
, HUB_PRE_RESET
);
1298 /* caller has locked the hub device */
1299 static int hub_post_reset(struct usb_interface
*intf
)
1301 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1303 hub_activate(hub
, HUB_POST_RESET
);
1307 static int hub_configure(struct usb_hub
*hub
,
1308 struct usb_endpoint_descriptor
*endpoint
)
1310 struct usb_hcd
*hcd
;
1311 struct usb_device
*hdev
= hub
->hdev
;
1312 struct device
*hub_dev
= hub
->intfdev
;
1313 u16 hubstatus
, hubchange
;
1314 u16 wHubCharacteristics
;
1317 char *message
= "out of memory";
1321 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1327 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1332 mutex_init(&hub
->status_mutex
);
1334 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1335 if (!hub
->descriptor
) {
1340 /* Request the entire hub descriptor.
1341 * hub->descriptor can handle USB_MAXCHILDREN ports,
1342 * but the hub can/will return fewer bytes here.
1344 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1346 message
= "can't read hub descriptor";
1348 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1349 message
= "hub has too many ports!";
1352 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1353 message
= "hub doesn't have any ports!";
1358 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1359 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1360 (hdev
->maxchild
== 1) ? "" : "s");
1362 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1369 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1370 if (hub_is_superspeed(hdev
)) {
1378 /* FIXME for USB 3.0, skip for now */
1379 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1380 !(hub_is_superspeed(hdev
))) {
1382 char portstr
[USB_MAXCHILDREN
+ 1];
1384 for (i
= 0; i
< hdev
->maxchild
; i
++)
1385 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1386 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1388 portstr
[hdev
->maxchild
] = 0;
1389 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1391 dev_dbg(hub_dev
, "standalone hub\n");
1393 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1394 case HUB_CHAR_COMMON_LPSM
:
1395 dev_dbg(hub_dev
, "ganged power switching\n");
1397 case HUB_CHAR_INDV_PORT_LPSM
:
1398 dev_dbg(hub_dev
, "individual port power switching\n");
1400 case HUB_CHAR_NO_LPSM
:
1402 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1406 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1407 case HUB_CHAR_COMMON_OCPM
:
1408 dev_dbg(hub_dev
, "global over-current protection\n");
1410 case HUB_CHAR_INDV_PORT_OCPM
:
1411 dev_dbg(hub_dev
, "individual port over-current protection\n");
1413 case HUB_CHAR_NO_OCPM
:
1415 dev_dbg(hub_dev
, "no over-current protection\n");
1419 spin_lock_init (&hub
->tt
.lock
);
1420 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1421 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1422 switch (hdev
->descriptor
.bDeviceProtocol
) {
1425 case USB_HUB_PR_HS_SINGLE_TT
:
1426 dev_dbg(hub_dev
, "Single TT\n");
1429 case USB_HUB_PR_HS_MULTI_TT
:
1430 ret
= usb_set_interface(hdev
, 0, 1);
1432 dev_dbg(hub_dev
, "TT per port\n");
1435 dev_err(hub_dev
, "Using single TT (err %d)\n",
1440 /* USB 3.0 hubs don't have a TT */
1443 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1444 hdev
->descriptor
.bDeviceProtocol
);
1448 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1449 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1450 case HUB_TTTT_8_BITS
:
1451 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1452 hub
->tt
.think_time
= 666;
1453 dev_dbg(hub_dev
, "TT requires at most %d "
1454 "FS bit times (%d ns)\n",
1455 8, hub
->tt
.think_time
);
1458 case HUB_TTTT_16_BITS
:
1459 hub
->tt
.think_time
= 666 * 2;
1460 dev_dbg(hub_dev
, "TT requires at most %d "
1461 "FS bit times (%d ns)\n",
1462 16, hub
->tt
.think_time
);
1464 case HUB_TTTT_24_BITS
:
1465 hub
->tt
.think_time
= 666 * 3;
1466 dev_dbg(hub_dev
, "TT requires at most %d "
1467 "FS bit times (%d ns)\n",
1468 24, hub
->tt
.think_time
);
1470 case HUB_TTTT_32_BITS
:
1471 hub
->tt
.think_time
= 666 * 4;
1472 dev_dbg(hub_dev
, "TT requires at most %d "
1473 "FS bit times (%d ns)\n",
1474 32, hub
->tt
.think_time
);
1478 /* probe() zeroes hub->indicator[] */
1479 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1480 hub
->has_indicators
= 1;
1481 dev_dbg(hub_dev
, "Port indicators are supported\n");
1484 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1485 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1487 /* power budgeting mostly matters with bus-powered hubs,
1488 * and battery-powered root hubs (may provide just 8 mA).
1490 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1492 message
= "can't get hub status";
1495 le16_to_cpus(&hubstatus
);
1496 hcd
= bus_to_hcd(hdev
->bus
);
1497 if (hdev
== hdev
->bus
->root_hub
) {
1498 if (hcd
->power_budget
> 0)
1499 hdev
->bus_mA
= hcd
->power_budget
;
1501 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1502 if (hdev
->bus_mA
>= full_load
)
1503 hub
->mA_per_port
= full_load
;
1505 hub
->mA_per_port
= hdev
->bus_mA
;
1506 hub
->limited_power
= 1;
1508 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1509 int remaining
= hdev
->bus_mA
-
1510 hub
->descriptor
->bHubContrCurrent
;
1512 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1513 hub
->descriptor
->bHubContrCurrent
);
1514 hub
->limited_power
= 1;
1516 if (remaining
< hdev
->maxchild
* unit_load
)
1518 "insufficient power available "
1519 "to use all downstream ports\n");
1520 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1522 } else { /* Self-powered external hub */
1523 /* FIXME: What about battery-powered external hubs that
1524 * provide less current per port? */
1525 hub
->mA_per_port
= full_load
;
1527 if (hub
->mA_per_port
< full_load
)
1528 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1531 /* Update the HCD's internal representation of this hub before khubd
1532 * starts getting port status changes for devices under the hub.
1534 if (hcd
->driver
->update_hub_device
) {
1535 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1536 &hub
->tt
, GFP_KERNEL
);
1538 message
= "can't update HCD hub info";
1543 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1545 message
= "can't get hub status";
1549 /* local power status reports aren't always correct */
1550 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1551 dev_dbg(hub_dev
, "local power source is %s\n",
1552 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1553 ? "lost (inactive)" : "good");
1555 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1556 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1557 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1559 /* set up the interrupt endpoint
1560 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1561 * bytes as USB2.0[11.12.3] says because some hubs are known
1562 * to send more data (and thus cause overflow). For root hubs,
1563 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1564 * to be big enough for at least USB_MAXCHILDREN ports. */
1565 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1566 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1568 if (maxp
> sizeof(*hub
->buffer
))
1569 maxp
= sizeof(*hub
->buffer
);
1571 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1577 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1578 hub
, endpoint
->bInterval
);
1580 /* maybe cycle the hub leds */
1581 if (hub
->has_indicators
&& blinkenlights
)
1582 hub
->indicator
[0] = INDICATOR_CYCLE
;
1584 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1585 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1587 dev_err(hub
->intfdev
,
1588 "couldn't create port%d device.\n", i
+ 1);
1590 goto fail_keep_maxchild
;
1594 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1596 hub_activate(hub
, HUB_INIT
);
1602 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1604 /* hub_disconnect() frees urb and descriptor */
1608 static void hub_release(struct kref
*kref
)
1610 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1612 usb_put_intf(to_usb_interface(hub
->intfdev
));
1616 static unsigned highspeed_hubs
;
1618 static void hub_disconnect(struct usb_interface
*intf
)
1620 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1621 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1624 /* Take the hub off the event list and don't let it be added again */
1625 spin_lock_irq(&hub_event_lock
);
1626 if (!list_empty(&hub
->event_list
)) {
1627 list_del_init(&hub
->event_list
);
1628 usb_autopm_put_interface_no_suspend(intf
);
1630 hub
->disconnected
= 1;
1631 spin_unlock_irq(&hub_event_lock
);
1633 /* Disconnect all children and quiesce the hub */
1635 hub_quiesce(hub
, HUB_DISCONNECT
);
1637 /* Avoid races with recursively_mark_NOTATTACHED() */
1638 spin_lock_irq(&device_state_lock
);
1639 port1
= hdev
->maxchild
;
1641 usb_set_intfdata(intf
, NULL
);
1642 spin_unlock_irq(&device_state_lock
);
1644 for (; port1
> 0; --port1
)
1645 usb_hub_remove_port_device(hub
, port1
);
1647 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1650 usb_free_urb(hub
->urb
);
1652 kfree(hub
->descriptor
);
1656 pm_suspend_ignore_children(&intf
->dev
, false);
1657 kref_put(&hub
->kref
, hub_release
);
1660 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1662 struct usb_host_interface
*desc
;
1663 struct usb_endpoint_descriptor
*endpoint
;
1664 struct usb_device
*hdev
;
1665 struct usb_hub
*hub
;
1667 desc
= intf
->cur_altsetting
;
1668 hdev
= interface_to_usbdev(intf
);
1671 * Set default autosuspend delay as 0 to speedup bus suspend,
1672 * based on the below considerations:
1674 * - Unlike other drivers, the hub driver does not rely on the
1675 * autosuspend delay to provide enough time to handle a wakeup
1676 * event, and the submitted status URB is just to check future
1677 * change on hub downstream ports, so it is safe to do it.
1679 * - The patch might cause one or more auto supend/resume for
1680 * below very rare devices when they are plugged into hub
1683 * devices having trouble initializing, and disconnect
1684 * themselves from the bus and then reconnect a second
1687 * devices just for downloading firmware, and disconnects
1688 * themselves after completing it
1690 * For these quite rare devices, their drivers may change the
1691 * autosuspend delay of their parent hub in the probe() to one
1692 * appropriate value to avoid the subtle problem if someone
1695 * - The patch may cause one or more auto suspend/resume on
1696 * hub during running 'lsusb', but it is probably too
1697 * infrequent to worry about.
1699 * - Change autosuspend delay of hub can avoid unnecessary auto
1700 * suspend timer for hub, also may decrease power consumption
1703 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1706 * Hubs have proper suspend/resume support, except for root hubs
1707 * where the controller driver doesn't have bus_suspend and
1708 * bus_resume methods.
1710 if (hdev
->parent
) { /* normal device */
1711 usb_enable_autosuspend(hdev
);
1712 } else { /* root hub */
1713 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1715 if (drv
->bus_suspend
&& drv
->bus_resume
)
1716 usb_enable_autosuspend(hdev
);
1719 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1721 "Unsupported bus topology: hub nested too deep\n");
1725 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1727 dev_warn(&intf
->dev
, "ignoring external hub\n");
1732 /* Some hubs have a subclass of 1, which AFAICT according to the */
1733 /* specs is not defined, but it works */
1734 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1735 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1737 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1741 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1742 if (desc
->desc
.bNumEndpoints
!= 1)
1743 goto descriptor_error
;
1745 endpoint
= &desc
->endpoint
[0].desc
;
1747 /* If it's not an interrupt in endpoint, we'd better punt! */
1748 if (!usb_endpoint_is_int_in(endpoint
))
1749 goto descriptor_error
;
1751 /* We found a hub */
1752 dev_info (&intf
->dev
, "USB hub found\n");
1754 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1756 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1760 kref_init(&hub
->kref
);
1761 INIT_LIST_HEAD(&hub
->event_list
);
1762 hub
->intfdev
= &intf
->dev
;
1764 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1765 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1768 usb_set_intfdata (intf
, hub
);
1769 intf
->needs_remote_wakeup
= 1;
1770 pm_suspend_ignore_children(&intf
->dev
, true);
1772 if (hdev
->speed
== USB_SPEED_HIGH
)
1775 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1776 hub
->quirk_check_port_auto_suspend
= 1;
1778 if (hub_configure(hub
, endpoint
) >= 0)
1781 hub_disconnect (intf
);
1786 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1788 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1789 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1791 /* assert ifno == 0 (part of hub spec) */
1793 case USBDEVFS_HUB_PORTINFO
: {
1794 struct usbdevfs_hub_portinfo
*info
= user_data
;
1797 spin_lock_irq(&device_state_lock
);
1798 if (hdev
->devnum
<= 0)
1801 info
->nports
= hdev
->maxchild
;
1802 for (i
= 0; i
< info
->nports
; i
++) {
1803 if (hub
->ports
[i
]->child
== NULL
)
1807 hub
->ports
[i
]->child
->devnum
;
1810 spin_unlock_irq(&device_state_lock
);
1812 return info
->nports
+ 1;
1821 * Allow user programs to claim ports on a hub. When a device is attached
1822 * to one of these "claimed" ports, the program will "own" the device.
1824 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1825 struct dev_state
***ppowner
)
1827 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1829 if (port1
== 0 || port1
> hdev
->maxchild
)
1832 /* This assumes that devices not managed by the hub driver
1833 * will always have maxchild equal to 0.
1835 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1839 /* In the following three functions, the caller must hold hdev's lock */
1840 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1841 struct dev_state
*owner
)
1844 struct dev_state
**powner
;
1846 rc
= find_port_owner(hdev
, port1
, &powner
);
1855 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1856 struct dev_state
*owner
)
1859 struct dev_state
**powner
;
1861 rc
= find_port_owner(hdev
, port1
, &powner
);
1864 if (*powner
!= owner
)
1870 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1872 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1875 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1876 if (hub
->ports
[n
]->port_owner
== owner
)
1877 hub
->ports
[n
]->port_owner
= NULL
;
1882 /* The caller must hold udev's lock */
1883 bool usb_device_is_owned(struct usb_device
*udev
)
1885 struct usb_hub
*hub
;
1887 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1889 hub
= usb_hub_to_struct_hub(udev
->parent
);
1890 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1893 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1895 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1898 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1899 if (hub
->ports
[i
]->child
)
1900 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1902 if (udev
->state
== USB_STATE_SUSPENDED
)
1903 udev
->active_duration
-= jiffies
;
1904 udev
->state
= USB_STATE_NOTATTACHED
;
1908 * usb_set_device_state - change a device's current state (usbcore, hcds)
1909 * @udev: pointer to device whose state should be changed
1910 * @new_state: new state value to be stored
1912 * udev->state is _not_ fully protected by the device lock. Although
1913 * most transitions are made only while holding the lock, the state can
1914 * can change to USB_STATE_NOTATTACHED at almost any time. This
1915 * is so that devices can be marked as disconnected as soon as possible,
1916 * without having to wait for any semaphores to be released. As a result,
1917 * all changes to any device's state must be protected by the
1918 * device_state_lock spinlock.
1920 * Once a device has been added to the device tree, all changes to its state
1921 * should be made using this routine. The state should _not_ be set directly.
1923 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1924 * Otherwise udev->state is set to new_state, and if new_state is
1925 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1926 * to USB_STATE_NOTATTACHED.
1928 void usb_set_device_state(struct usb_device
*udev
,
1929 enum usb_device_state new_state
)
1931 unsigned long flags
;
1934 spin_lock_irqsave(&device_state_lock
, flags
);
1935 if (udev
->state
== USB_STATE_NOTATTACHED
)
1937 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1939 /* root hub wakeup capabilities are managed out-of-band
1940 * and may involve silicon errata ... ignore them here.
1943 if (udev
->state
== USB_STATE_SUSPENDED
1944 || new_state
== USB_STATE_SUSPENDED
)
1945 ; /* No change to wakeup settings */
1946 else if (new_state
== USB_STATE_CONFIGURED
)
1947 wakeup
= udev
->actconfig
->desc
.bmAttributes
1948 & USB_CONFIG_ATT_WAKEUP
;
1952 if (udev
->state
== USB_STATE_SUSPENDED
&&
1953 new_state
!= USB_STATE_SUSPENDED
)
1954 udev
->active_duration
-= jiffies
;
1955 else if (new_state
== USB_STATE_SUSPENDED
&&
1956 udev
->state
!= USB_STATE_SUSPENDED
)
1957 udev
->active_duration
+= jiffies
;
1958 udev
->state
= new_state
;
1960 recursively_mark_NOTATTACHED(udev
);
1961 spin_unlock_irqrestore(&device_state_lock
, flags
);
1963 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1965 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1968 * Choose a device number.
1970 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1971 * USB-2.0 buses they are also used as device addresses, however on
1972 * USB-3.0 buses the address is assigned by the controller hardware
1973 * and it usually is not the same as the device number.
1975 * WUSB devices are simple: they have no hubs behind, so the mapping
1976 * device <-> virtual port number becomes 1:1. Why? to simplify the
1977 * life of the device connection logic in
1978 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1979 * handshake we need to assign a temporary address in the unauthorized
1980 * space. For simplicity we use the first virtual port number found to
1981 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1982 * and that becomes it's address [X < 128] or its unauthorized address
1985 * We add 1 as an offset to the one-based USB-stack port number
1986 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1987 * 0 is reserved by USB for default address; (b) Linux's USB stack
1988 * uses always #1 for the root hub of the controller. So USB stack's
1989 * port #1, which is wusb virtual-port #0 has address #2.
1991 * Devices connected under xHCI are not as simple. The host controller
1992 * supports virtualization, so the hardware assigns device addresses and
1993 * the HCD must setup data structures before issuing a set address
1994 * command to the hardware.
1996 static void choose_devnum(struct usb_device
*udev
)
1999 struct usb_bus
*bus
= udev
->bus
;
2001 /* If khubd ever becomes multithreaded, this will need a lock */
2003 devnum
= udev
->portnum
+ 1;
2004 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2006 /* Try to allocate the next devnum beginning at
2007 * bus->devnum_next. */
2008 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2011 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2013 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
2016 set_bit(devnum
, bus
->devmap
.devicemap
);
2017 udev
->devnum
= devnum
;
2021 static void release_devnum(struct usb_device
*udev
)
2023 if (udev
->devnum
> 0) {
2024 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2029 static void update_devnum(struct usb_device
*udev
, int devnum
)
2031 /* The address for a WUSB device is managed by wusbcore. */
2033 udev
->devnum
= devnum
;
2036 static void hub_free_dev(struct usb_device
*udev
)
2038 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2040 /* Root hubs aren't real devices, so don't free HCD resources */
2041 if (hcd
->driver
->free_dev
&& udev
->parent
)
2042 hcd
->driver
->free_dev(hcd
, udev
);
2046 * usb_disconnect - disconnect a device (usbcore-internal)
2047 * @pdev: pointer to device being disconnected
2048 * Context: !in_interrupt ()
2050 * Something got disconnected. Get rid of it and all of its children.
2052 * If *pdev is a normal device then the parent hub must already be locked.
2053 * If *pdev is a root hub then this routine will acquire the
2054 * usb_bus_list_lock on behalf of the caller.
2056 * Only hub drivers (including virtual root hub drivers for host
2057 * controllers) should ever call this.
2059 * This call is synchronous, and may not be used in an interrupt context.
2061 void usb_disconnect(struct usb_device
**pdev
)
2063 struct usb_device
*udev
= *pdev
;
2064 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2067 /* mark the device as inactive, so any further urb submissions for
2068 * this device (and any of its children) will fail immediately.
2069 * this quiesces everything except pending urbs.
2071 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2072 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2075 usb_lock_device(udev
);
2077 /* Free up all the children before we remove this device */
2078 for (i
= 0; i
< udev
->maxchild
; i
++) {
2079 if (hub
->ports
[i
]->child
)
2080 usb_disconnect(&hub
->ports
[i
]->child
);
2083 /* deallocate hcd/hardware state ... nuking all pending urbs and
2084 * cleaning up all state associated with the current configuration
2085 * so that the hardware is now fully quiesced.
2087 dev_dbg (&udev
->dev
, "unregistering device\n");
2088 usb_disable_device(udev
, 0);
2089 usb_hcd_synchronize_unlinks(udev
);
2092 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2093 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2095 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2096 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2098 if (!port_dev
->did_runtime_put
)
2099 pm_runtime_put(&port_dev
->dev
);
2101 port_dev
->did_runtime_put
= false;
2104 usb_remove_ep_devs(&udev
->ep0
);
2105 usb_unlock_device(udev
);
2107 /* Unregister the device. The device driver is responsible
2108 * for de-configuring the device and invoking the remove-device
2109 * notifier chain (used by usbfs and possibly others).
2111 device_del(&udev
->dev
);
2113 /* Free the device number and delete the parent's children[]
2114 * (or root_hub) pointer.
2116 release_devnum(udev
);
2118 /* Avoid races with recursively_mark_NOTATTACHED() */
2119 spin_lock_irq(&device_state_lock
);
2121 spin_unlock_irq(&device_state_lock
);
2125 put_device(&udev
->dev
);
2128 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2129 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2133 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2136 static void announce_device(struct usb_device
*udev
)
2138 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2139 le16_to_cpu(udev
->descriptor
.idVendor
),
2140 le16_to_cpu(udev
->descriptor
.idProduct
));
2141 dev_info(&udev
->dev
,
2142 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2143 udev
->descriptor
.iManufacturer
,
2144 udev
->descriptor
.iProduct
,
2145 udev
->descriptor
.iSerialNumber
);
2146 show_string(udev
, "Product", udev
->product
);
2147 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2148 show_string(udev
, "SerialNumber", udev
->serial
);
2151 static inline void announce_device(struct usb_device
*udev
) { }
2154 #ifdef CONFIG_USB_OTG
2155 #include "otg_whitelist.h"
2159 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2160 * @udev: newly addressed device (in ADDRESS state)
2162 * Finish enumeration for On-The-Go devices
2164 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2168 #ifdef CONFIG_USB_OTG
2170 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2171 * to wake us after we've powered off VBUS; and HNP, switching roles
2172 * "host" to "peripheral". The OTG descriptor helps figure this out.
2174 if (!udev
->bus
->is_b_host
2176 && udev
->parent
== udev
->bus
->root_hub
) {
2177 struct usb_otg_descriptor
*desc
= NULL
;
2178 struct usb_bus
*bus
= udev
->bus
;
2180 /* descriptor may appear anywhere in config */
2181 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2182 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2183 USB_DT_OTG
, (void **) &desc
) == 0) {
2184 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2185 unsigned port1
= udev
->portnum
;
2187 dev_info(&udev
->dev
,
2188 "Dual-Role OTG device on %sHNP port\n",
2189 (port1
== bus
->otg_port
)
2192 /* enable HNP before suspend, it's simpler */
2193 if (port1
== bus
->otg_port
)
2194 bus
->b_hnp_enable
= 1;
2195 err
= usb_control_msg(udev
,
2196 usb_sndctrlpipe(udev
, 0),
2197 USB_REQ_SET_FEATURE
, 0,
2199 ? USB_DEVICE_B_HNP_ENABLE
2200 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2201 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2203 /* OTG MESSAGE: report errors here,
2204 * customize to match your product.
2206 dev_info(&udev
->dev
,
2207 "can't set HNP mode: %d\n",
2209 bus
->b_hnp_enable
= 0;
2215 if (!is_targeted(udev
)) {
2217 /* Maybe it can talk to us, though we can't talk to it.
2218 * (Includes HNP test device.)
2220 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2221 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2223 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2235 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2236 * @udev: newly addressed device (in ADDRESS state)
2238 * This is only called by usb_new_device() and usb_authorize_device()
2239 * and FIXME -- all comments that apply to them apply here wrt to
2242 * If the device is WUSB and not authorized, we don't attempt to read
2243 * the string descriptors, as they will be errored out by the device
2244 * until it has been authorized.
2246 static int usb_enumerate_device(struct usb_device
*udev
)
2250 if (udev
->config
== NULL
) {
2251 err
= usb_get_configuration(udev
);
2254 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2260 /* read the standard strings and cache them if present */
2261 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2262 udev
->manufacturer
= usb_cache_string(udev
,
2263 udev
->descriptor
.iManufacturer
);
2264 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2266 err
= usb_enumerate_device_otg(udev
);
2270 usb_detect_interface_quirks(udev
);
2275 static void set_usb_port_removable(struct usb_device
*udev
)
2277 struct usb_device
*hdev
= udev
->parent
;
2278 struct usb_hub
*hub
;
2279 u8 port
= udev
->portnum
;
2280 u16 wHubCharacteristics
;
2281 bool removable
= true;
2286 hub
= usb_hub_to_struct_hub(udev
->parent
);
2288 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2290 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2293 if (hub_is_superspeed(hdev
)) {
2294 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2298 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2303 udev
->removable
= USB_DEVICE_REMOVABLE
;
2305 udev
->removable
= USB_DEVICE_FIXED
;
2309 * usb_new_device - perform initial device setup (usbcore-internal)
2310 * @udev: newly addressed device (in ADDRESS state)
2312 * This is called with devices which have been detected but not fully
2313 * enumerated. The device descriptor is available, but not descriptors
2314 * for any device configuration. The caller must have locked either
2315 * the parent hub (if udev is a normal device) or else the
2316 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2317 * udev has already been installed, but udev is not yet visible through
2318 * sysfs or other filesystem code.
2320 * It will return if the device is configured properly or not. Zero if
2321 * the interface was registered with the driver core; else a negative
2324 * This call is synchronous, and may not be used in an interrupt context.
2326 * Only the hub driver or root-hub registrar should ever call this.
2328 int usb_new_device(struct usb_device
*udev
)
2333 /* Initialize non-root-hub device wakeup to disabled;
2334 * device (un)configuration controls wakeup capable
2335 * sysfs power/wakeup controls wakeup enabled/disabled
2337 device_init_wakeup(&udev
->dev
, 0);
2340 /* Tell the runtime-PM framework the device is active */
2341 pm_runtime_set_active(&udev
->dev
);
2342 pm_runtime_get_noresume(&udev
->dev
);
2343 pm_runtime_use_autosuspend(&udev
->dev
);
2344 pm_runtime_enable(&udev
->dev
);
2346 /* By default, forbid autosuspend for all devices. It will be
2347 * allowed for hubs during binding.
2349 usb_disable_autosuspend(udev
);
2351 err
= usb_enumerate_device(udev
); /* Read descriptors */
2354 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2355 udev
->devnum
, udev
->bus
->busnum
,
2356 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2357 /* export the usbdev device-node for libusb */
2358 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2359 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2361 /* Tell the world! */
2362 announce_device(udev
);
2365 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2367 add_device_randomness(udev
->product
, strlen(udev
->product
));
2368 if (udev
->manufacturer
)
2369 add_device_randomness(udev
->manufacturer
,
2370 strlen(udev
->manufacturer
));
2372 device_enable_async_suspend(&udev
->dev
);
2375 * check whether the hub marks this port as non-removable. Do it
2376 * now so that platform-specific data can override it in
2380 set_usb_port_removable(udev
);
2382 /* Register the device. The device driver is responsible
2383 * for configuring the device and invoking the add-device
2384 * notifier chain (used by usbfs and possibly others).
2386 err
= device_add(&udev
->dev
);
2388 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2392 /* Create link files between child device and usb port device. */
2394 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2395 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2397 err
= sysfs_create_link(&udev
->dev
.kobj
,
2398 &port_dev
->dev
.kobj
, "port");
2402 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2403 &udev
->dev
.kobj
, "device");
2405 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2409 pm_runtime_get_sync(&port_dev
->dev
);
2412 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2413 usb_mark_last_busy(udev
);
2414 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2418 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2419 pm_runtime_disable(&udev
->dev
);
2420 pm_runtime_set_suspended(&udev
->dev
);
2426 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2427 * @usb_dev: USB device
2429 * Move the USB device to a very basic state where interfaces are disabled
2430 * and the device is in fact unconfigured and unusable.
2432 * We share a lock (that we have) with device_del(), so we need to
2435 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2437 usb_lock_device(usb_dev
);
2438 if (usb_dev
->authorized
== 0)
2439 goto out_unauthorized
;
2441 usb_dev
->authorized
= 0;
2442 usb_set_configuration(usb_dev
, -1);
2445 usb_unlock_device(usb_dev
);
2450 int usb_authorize_device(struct usb_device
*usb_dev
)
2454 usb_lock_device(usb_dev
);
2455 if (usb_dev
->authorized
== 1)
2456 goto out_authorized
;
2458 result
= usb_autoresume_device(usb_dev
);
2460 dev_err(&usb_dev
->dev
,
2461 "can't autoresume for authorization: %d\n", result
);
2462 goto error_autoresume
;
2464 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2466 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2467 "authorization: %d\n", result
);
2468 goto error_device_descriptor
;
2471 usb_dev
->authorized
= 1;
2472 /* Choose and set the configuration. This registers the interfaces
2473 * with the driver core and lets interface drivers bind to them.
2475 c
= usb_choose_configuration(usb_dev
);
2477 result
= usb_set_configuration(usb_dev
, c
);
2479 dev_err(&usb_dev
->dev
,
2480 "can't set config #%d, error %d\n", c
, result
);
2481 /* This need not be fatal. The user can try to
2482 * set other configurations. */
2485 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2487 error_device_descriptor
:
2488 usb_autosuspend_device(usb_dev
);
2491 usb_unlock_device(usb_dev
); // complements locktree
2496 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2497 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2499 struct usb_hcd
*hcd
;
2500 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2502 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2503 return hcd
->wireless
;
2507 #define PORT_RESET_TRIES 5
2508 #define SET_ADDRESS_TRIES 2
2509 #define GET_DESCRIPTOR_TRIES 2
2510 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2511 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2513 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2514 #define HUB_SHORT_RESET_TIME 10
2515 #define HUB_BH_RESET_TIME 50
2516 #define HUB_LONG_RESET_TIME 200
2517 #define HUB_RESET_TIMEOUT 800
2519 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2520 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2522 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2523 * Port worm reset is required to recover
2525 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2527 return hub_is_superspeed(hub
->hdev
) &&
2528 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2529 USB_SS_PORT_LS_SS_INACTIVE
) ||
2530 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2531 USB_SS_PORT_LS_COMP_MOD
)) ;
2534 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2535 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2537 int delay_time
, ret
;
2541 for (delay_time
= 0;
2542 delay_time
< HUB_RESET_TIMEOUT
;
2543 delay_time
+= delay
) {
2544 /* wait to give the device a chance to reset */
2547 /* read and decode port status */
2548 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2552 /* The port state is unknown until the reset completes. */
2553 if (!(portstatus
& USB_PORT_STAT_RESET
))
2556 /* switch to the long delay after two short delay failures */
2557 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2558 delay
= HUB_LONG_RESET_TIME
;
2560 dev_dbg (hub
->intfdev
,
2561 "port %d not %sreset yet, waiting %dms\n",
2562 port1
, warm
? "warm " : "", delay
);
2565 if ((portstatus
& USB_PORT_STAT_RESET
))
2568 if (hub_port_warm_reset_required(hub
, portstatus
))
2571 /* Device went away? */
2572 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2575 /* bomb out completely if the connection bounced. A USB 3.0
2576 * connection may bounce if multiple warm resets were issued,
2577 * but the device may have successfully re-connected. Ignore it.
2579 if (!hub_is_superspeed(hub
->hdev
) &&
2580 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2583 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2589 if (hub_is_wusb(hub
))
2590 udev
->speed
= USB_SPEED_WIRELESS
;
2591 else if (hub_is_superspeed(hub
->hdev
))
2592 udev
->speed
= USB_SPEED_SUPER
;
2593 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2594 udev
->speed
= USB_SPEED_HIGH
;
2595 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2596 udev
->speed
= USB_SPEED_LOW
;
2598 udev
->speed
= USB_SPEED_FULL
;
2602 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2603 struct usb_device
*udev
, int *status
)
2607 /* TRSTRCY = 10 ms; plus some extra */
2610 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2612 update_devnum(udev
, 0);
2613 /* The xHC may think the device is already reset,
2614 * so ignore the status.
2616 if (hcd
->driver
->reset_device
)
2617 hcd
->driver
->reset_device(hcd
, udev
);
2622 usb_clear_port_feature(hub
->hdev
,
2623 port1
, USB_PORT_FEAT_C_RESET
);
2624 if (hub_is_superspeed(hub
->hdev
)) {
2625 usb_clear_port_feature(hub
->hdev
, port1
,
2626 USB_PORT_FEAT_C_BH_PORT_RESET
);
2627 usb_clear_port_feature(hub
->hdev
, port1
,
2628 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2629 usb_clear_port_feature(hub
->hdev
, port1
,
2630 USB_PORT_FEAT_C_CONNECTION
);
2633 usb_set_device_state(udev
, *status
2634 ? USB_STATE_NOTATTACHED
2635 : USB_STATE_DEFAULT
);
2640 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2641 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2642 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2645 u16 portchange
, portstatus
;
2647 if (!hub_is_superspeed(hub
->hdev
)) {
2649 dev_err(hub
->intfdev
, "only USB3 hub support "
2653 /* Block EHCI CF initialization during the port reset.
2654 * Some companion controllers don't like it when they mix.
2656 down_read(&ehci_cf_port_reset_rwsem
);
2659 * If the caller hasn't explicitly requested a warm reset,
2660 * double check and see if one is needed.
2662 status
= hub_port_status(hub
, port1
,
2663 &portstatus
, &portchange
);
2667 if (hub_port_warm_reset_required(hub
, portstatus
))
2671 /* Reset the port */
2672 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2673 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2674 USB_PORT_FEAT_BH_PORT_RESET
:
2675 USB_PORT_FEAT_RESET
));
2676 if (status
== -ENODEV
) {
2677 ; /* The hub is gone */
2678 } else if (status
) {
2679 dev_err(hub
->intfdev
,
2680 "cannot %sreset port %d (err = %d)\n",
2681 warm
? "warm " : "", port1
, status
);
2683 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2685 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2686 dev_dbg(hub
->intfdev
,
2687 "port_wait_reset: err = %d\n",
2691 /* Check for disconnect or reset */
2692 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2693 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2695 if (!hub_is_superspeed(hub
->hdev
))
2699 * If a USB 3.0 device migrates from reset to an error
2700 * state, re-issue the warm reset.
2702 if (hub_port_status(hub
, port1
,
2703 &portstatus
, &portchange
) < 0)
2706 if (!hub_port_warm_reset_required(hub
, portstatus
))
2710 * If the port is in SS.Inactive or Compliance Mode, the
2711 * hot or warm reset failed. Try another warm reset.
2714 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2720 dev_dbg (hub
->intfdev
,
2721 "port %d not enabled, trying %sreset again...\n",
2722 port1
, warm
? "warm " : "");
2723 delay
= HUB_LONG_RESET_TIME
;
2726 dev_err (hub
->intfdev
,
2727 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2731 if (!hub_is_superspeed(hub
->hdev
))
2732 up_read(&ehci_cf_port_reset_rwsem
);
2737 /* Check if a port is power on */
2738 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2742 if (hub_is_superspeed(hub
->hdev
)) {
2743 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2746 if (portstatus
& USB_PORT_STAT_POWER
)
2755 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2756 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2760 if (hub_is_superspeed(hub
->hdev
)) {
2761 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2762 == USB_SS_PORT_LS_U3
)
2765 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2772 /* Determine whether the device on a port is ready for a normal resume,
2773 * is ready for a reset-resume, or should be disconnected.
2775 static int check_port_resume_type(struct usb_device
*udev
,
2776 struct usb_hub
*hub
, int port1
,
2777 int status
, unsigned portchange
, unsigned portstatus
)
2779 /* Is the device still present? */
2780 if (status
|| port_is_suspended(hub
, portstatus
) ||
2781 !port_is_power_on(hub
, portstatus
) ||
2782 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2787 /* Can't do a normal resume if the port isn't enabled,
2788 * so try a reset-resume instead.
2790 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2791 if (udev
->persist_enabled
)
2792 udev
->reset_resume
= 1;
2798 dev_dbg(hub
->intfdev
,
2799 "port %d status %04x.%04x after resume, %d\n",
2800 port1
, portchange
, portstatus
, status
);
2801 } else if (udev
->reset_resume
) {
2803 /* Late port handoff can set status-change bits */
2804 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2805 usb_clear_port_feature(hub
->hdev
, port1
,
2806 USB_PORT_FEAT_C_CONNECTION
);
2807 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2808 usb_clear_port_feature(hub
->hdev
, port1
,
2809 USB_PORT_FEAT_C_ENABLE
);
2815 int usb_disable_ltm(struct usb_device
*udev
)
2817 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2819 /* Check if the roothub and device supports LTM. */
2820 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2821 !usb_device_supports_ltm(udev
))
2824 /* Clear Feature LTM Enable can only be sent if the device is
2827 if (!udev
->actconfig
)
2830 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2831 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2832 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2833 USB_CTRL_SET_TIMEOUT
);
2835 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2837 void usb_enable_ltm(struct usb_device
*udev
)
2839 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2841 /* Check if the roothub and device supports LTM. */
2842 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2843 !usb_device_supports_ltm(udev
))
2846 /* Set Feature LTM Enable can only be sent if the device is
2849 if (!udev
->actconfig
)
2852 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2853 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2854 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2855 USB_CTRL_SET_TIMEOUT
);
2857 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2861 * usb_disable_function_remotewakeup - disable usb3.0
2862 * device's function remote wakeup
2863 * @udev: target device
2865 * Assume there's only one function on the USB 3.0
2866 * device and disable remote wake for the first
2867 * interface. FIXME if the interface association
2868 * descriptor shows there's more than one function.
2870 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2872 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2873 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2874 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2875 USB_CTRL_SET_TIMEOUT
);
2878 /* Count of wakeup-enabled devices at or below udev */
2879 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2881 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2883 return udev
->do_remote_wakeup
+
2884 (hub
? hub
->wakeup_enabled_descendants
: 0);
2888 * usb_port_suspend - suspend a usb device's upstream port
2889 * @udev: device that's no longer in active use, not a root hub
2890 * Context: must be able to sleep; device not locked; pm locks held
2892 * Suspends a USB device that isn't in active use, conserving power.
2893 * Devices may wake out of a suspend, if anything important happens,
2894 * using the remote wakeup mechanism. They may also be taken out of
2895 * suspend by the host, using usb_port_resume(). It's also routine
2896 * to disconnect devices while they are suspended.
2898 * This only affects the USB hardware for a device; its interfaces
2899 * (and, for hubs, child devices) must already have been suspended.
2901 * Selective port suspend reduces power; most suspended devices draw
2902 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2903 * All devices below the suspended port are also suspended.
2905 * Devices leave suspend state when the host wakes them up. Some devices
2906 * also support "remote wakeup", where the device can activate the USB
2907 * tree above them to deliver data, such as a keypress or packet. In
2908 * some cases, this wakes the USB host.
2910 * Suspending OTG devices may trigger HNP, if that's been enabled
2911 * between a pair of dual-role devices. That will change roles, such
2912 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2914 * Devices on USB hub ports have only one "suspend" state, corresponding
2915 * to ACPI D2, "may cause the device to lose some context".
2916 * State transitions include:
2918 * - suspend, resume ... when the VBUS power link stays live
2919 * - suspend, disconnect ... VBUS lost
2921 * Once VBUS drop breaks the circuit, the port it's using has to go through
2922 * normal re-enumeration procedures, starting with enabling VBUS power.
2923 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2924 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2925 * timer, no SRP, no requests through sysfs.
2927 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2928 * suspended until their bus goes into global suspend (i.e., the root
2929 * hub is suspended). Nevertheless, we change @udev->state to
2930 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2931 * upstream port setting is stored in @udev->port_is_suspended.
2933 * Returns 0 on success, else negative errno.
2935 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2937 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2938 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2939 int port1
= udev
->portnum
;
2941 bool really_suspend
= true;
2943 /* enable remote wakeup when appropriate; this lets the device
2944 * wake up the upstream hub (including maybe the root hub).
2946 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2947 * we don't explicitly enable it here.
2949 if (udev
->do_remote_wakeup
) {
2950 if (!hub_is_superspeed(hub
->hdev
)) {
2951 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2952 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2953 USB_DEVICE_REMOTE_WAKEUP
, 0,
2955 USB_CTRL_SET_TIMEOUT
);
2957 /* Assume there's only one function on the USB 3.0
2958 * device and enable remote wake for the first
2959 * interface. FIXME if the interface association
2960 * descriptor shows there's more than one function.
2962 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2963 USB_REQ_SET_FEATURE
,
2964 USB_RECIP_INTERFACE
,
2965 USB_INTRF_FUNC_SUSPEND
,
2966 USB_INTRF_FUNC_SUSPEND_RW
|
2967 USB_INTRF_FUNC_SUSPEND_LP
,
2969 USB_CTRL_SET_TIMEOUT
);
2972 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2974 /* bail if autosuspend is requested */
2975 if (PMSG_IS_AUTO(msg
))
2980 /* disable USB2 hardware LPM */
2981 if (udev
->usb2_hw_lpm_enabled
== 1)
2982 usb_set_usb2_hardware_lpm(udev
, 0);
2984 if (usb_disable_ltm(udev
)) {
2985 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
2987 if (PMSG_IS_AUTO(msg
))
2990 if (usb_unlocked_disable_lpm(udev
)) {
2991 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
2993 if (PMSG_IS_AUTO(msg
))
2998 if (hub_is_superspeed(hub
->hdev
))
2999 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3002 * For system suspend, we do not need to enable the suspend feature
3003 * on individual USB-2 ports. The devices will automatically go
3004 * into suspend a few ms after the root hub stops sending packets.
3005 * The USB 2.0 spec calls this "global suspend".
3007 * However, many USB hubs have a bug: They don't relay wakeup requests
3008 * from a downstream port if the port's suspend feature isn't on.
3009 * Therefore we will turn on the suspend feature if udev or any of its
3010 * descendants is enabled for remote wakeup.
3012 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3013 status
= set_port_feature(hub
->hdev
, port1
,
3014 USB_PORT_FEAT_SUSPEND
);
3016 really_suspend
= false;
3020 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3023 /* Try to enable USB3 LPM and LTM again */
3024 usb_unlocked_enable_lpm(udev
);
3026 usb_enable_ltm(udev
);
3028 /* Try to enable USB2 hardware LPM again */
3029 if (udev
->usb2_hw_lpm_capable
== 1)
3030 usb_set_usb2_hardware_lpm(udev
, 1);
3032 if (udev
->do_remote_wakeup
) {
3033 if (udev
->speed
< USB_SPEED_SUPER
)
3034 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3035 USB_REQ_CLEAR_FEATURE
,
3037 USB_DEVICE_REMOTE_WAKEUP
, 0,
3038 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3040 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3041 USB_REQ_CLEAR_FEATURE
,
3042 USB_RECIP_INTERFACE
,
3043 USB_INTRF_FUNC_SUSPEND
, 0,
3044 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3048 /* System sleep transitions should never fail */
3049 if (!PMSG_IS_AUTO(msg
))
3052 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3053 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3054 udev
->do_remote_wakeup
);
3055 if (really_suspend
) {
3056 udev
->port_is_suspended
= 1;
3058 /* device has up to 10 msec to fully suspend */
3061 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3064 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3065 pm_runtime_put_sync(&port_dev
->dev
);
3066 port_dev
->did_runtime_put
= true;
3069 usb_mark_last_busy(hub
->hdev
);
3074 * If the USB "suspend" state is in use (rather than "global suspend"),
3075 * many devices will be individually taken out of suspend state using
3076 * special "resume" signaling. This routine kicks in shortly after
3077 * hardware resume signaling is finished, either because of selective
3078 * resume (by host) or remote wakeup (by device) ... now see what changed
3079 * in the tree that's rooted at this device.
3081 * If @udev->reset_resume is set then the device is reset before the
3082 * status check is done.
3084 static int finish_port_resume(struct usb_device
*udev
)
3089 /* caller owns the udev device lock */
3090 dev_dbg(&udev
->dev
, "%s\n",
3091 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3093 /* usb ch9 identifies four variants of SUSPENDED, based on what
3094 * state the device resumes to. Linux currently won't see the
3095 * first two on the host side; they'd be inside hub_port_init()
3096 * during many timeouts, but khubd can't suspend until later.
3098 usb_set_device_state(udev
, udev
->actconfig
3099 ? USB_STATE_CONFIGURED
3100 : USB_STATE_ADDRESS
);
3102 /* 10.5.4.5 says not to reset a suspended port if the attached
3103 * device is enabled for remote wakeup. Hence the reset
3104 * operation is carried out here, after the port has been
3107 if (udev
->reset_resume
)
3109 status
= usb_reset_and_verify_device(udev
);
3111 /* 10.5.4.5 says be sure devices in the tree are still there.
3112 * For now let's assume the device didn't go crazy on resume,
3113 * and device drivers will know about any resume quirks.
3117 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3119 status
= (status
> 0 ? 0 : -ENODEV
);
3121 /* If a normal resume failed, try doing a reset-resume */
3122 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3123 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3124 udev
->reset_resume
= 1;
3125 goto retry_reset_resume
;
3130 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3133 * There are a few quirky devices which violate the standard
3134 * by claiming to have remote wakeup enabled after a reset,
3135 * which crash if the feature is cleared, hence check for
3136 * udev->reset_resume
3138 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3139 if (!hub_is_superspeed(udev
->parent
)) {
3140 le16_to_cpus(&devstatus
);
3141 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3142 status
= usb_control_msg(udev
,
3143 usb_sndctrlpipe(udev
, 0),
3144 USB_REQ_CLEAR_FEATURE
,
3146 USB_DEVICE_REMOTE_WAKEUP
, 0,
3148 USB_CTRL_SET_TIMEOUT
);
3150 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3152 le16_to_cpus(&devstatus
);
3153 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3154 | USB_INTRF_STAT_FUNC_RW
))
3156 usb_disable_function_remotewakeup(udev
);
3161 "disable remote wakeup, status %d\n",
3169 * There are some SS USB devices which take longer time for link training.
3170 * XHCI specs 4.19.4 says that when Link training is successful, port
3171 * sets CSC bit to 1. So if SW reads port status before successful link
3172 * training, then it will not find device to be present.
3173 * USB Analyzer log with such buggy devices show that in some cases
3174 * device switch on the RX termination after long delay of host enabling
3175 * the VBUS. In few other cases it has been seen that device fails to
3176 * negotiate link training in first attempt. It has been
3177 * reported till now that few devices take as long as 2000 ms to train
3178 * the link after host enabling its VBUS and termination. Following
3179 * routine implements a 2000 ms timeout for link training. If in a case
3180 * link trains before timeout, loop will exit earlier.
3182 * FIXME: If a device was connected before suspend, but was removed
3183 * while system was asleep, then the loop in the following routine will
3184 * only exit at timeout.
3186 * This routine should only be called when persist is enabled for a SS
3189 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3190 struct usb_hub
*hub
, int *port1
,
3191 u16
*portchange
, u16
*portstatus
)
3193 int status
= 0, delay_ms
= 0;
3195 while (delay_ms
< 2000) {
3196 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3200 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3206 * usb_port_resume - re-activate a suspended usb device's upstream port
3207 * @udev: device to re-activate, not a root hub
3208 * Context: must be able to sleep; device not locked; pm locks held
3210 * This will re-activate the suspended device, increasing power usage
3211 * while letting drivers communicate again with its endpoints.
3212 * USB resume explicitly guarantees that the power session between
3213 * the host and the device is the same as it was when the device
3216 * If @udev->reset_resume is set then this routine won't check that the
3217 * port is still enabled. Furthermore, finish_port_resume() above will
3218 * reset @udev. The end result is that a broken power session can be
3219 * recovered and @udev will appear to persist across a loss of VBUS power.
3221 * For example, if a host controller doesn't maintain VBUS suspend current
3222 * during a system sleep or is reset when the system wakes up, all the USB
3223 * power sessions below it will be broken. This is especially troublesome
3224 * for mass-storage devices containing mounted filesystems, since the
3225 * device will appear to have disconnected and all the memory mappings
3226 * to it will be lost. Using the USB_PERSIST facility, the device can be
3227 * made to appear as if it had not disconnected.
3229 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3230 * every effort to insure that the same device is present after the
3231 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3232 * quite possible for a device to remain unaltered but its media to be
3233 * changed. If the user replaces a flash memory card while the system is
3234 * asleep, he will have only himself to blame when the filesystem on the
3235 * new card is corrupted and the system crashes.
3237 * Returns 0 on success, else negative errno.
3239 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3241 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3242 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3243 int port1
= udev
->portnum
;
3245 u16 portchange
, portstatus
;
3247 if (port_dev
->did_runtime_put
) {
3248 status
= pm_runtime_get_sync(&port_dev
->dev
);
3249 port_dev
->did_runtime_put
= false;
3251 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3257 /* Skip the initial Clear-Suspend step for a remote wakeup */
3258 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3259 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3260 goto SuspendCleared
;
3262 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3264 set_bit(port1
, hub
->busy_bits
);
3266 /* see 7.1.7.7; affects power usage, but not budgeting */
3267 if (hub_is_superspeed(hub
->hdev
))
3268 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3270 status
= usb_clear_port_feature(hub
->hdev
,
3271 port1
, USB_PORT_FEAT_SUSPEND
);
3273 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3276 /* drive resume for at least 20 msec */
3277 dev_dbg(&udev
->dev
, "usb %sresume\n",
3278 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3281 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3282 * stop resume signaling. Then finish the resume
3285 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3287 /* TRSMRCY = 10 msec */
3293 udev
->port_is_suspended
= 0;
3294 if (hub_is_superspeed(hub
->hdev
)) {
3295 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3296 usb_clear_port_feature(hub
->hdev
, port1
,
3297 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3299 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3300 usb_clear_port_feature(hub
->hdev
, port1
,
3301 USB_PORT_FEAT_C_SUSPEND
);
3305 clear_bit(port1
, hub
->busy_bits
);
3307 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3308 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3311 status
= check_port_resume_type(udev
,
3312 hub
, port1
, status
, portchange
, portstatus
);
3314 status
= finish_port_resume(udev
);
3316 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3317 hub_port_logical_disconnect(hub
, port1
);
3319 /* Try to enable USB2 hardware LPM */
3320 if (udev
->usb2_hw_lpm_capable
== 1)
3321 usb_set_usb2_hardware_lpm(udev
, 1);
3323 /* Try to enable USB3 LTM and LPM */
3324 usb_enable_ltm(udev
);
3325 usb_unlocked_enable_lpm(udev
);
3331 #endif /* CONFIG_PM */
3333 #ifdef CONFIG_PM_RUNTIME
3335 /* caller has locked udev */
3336 int usb_remote_wakeup(struct usb_device
*udev
)
3340 if (udev
->state
== USB_STATE_SUSPENDED
) {
3341 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3342 status
= usb_autoresume_device(udev
);
3344 /* Let the drivers do their thing, then... */
3345 usb_autosuspend_device(udev
);
3353 static int check_ports_changed(struct usb_hub
*hub
)
3357 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3358 u16 portstatus
, portchange
;
3361 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3362 if (!status
&& portchange
)
3368 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3370 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3371 struct usb_device
*hdev
= hub
->hdev
;
3376 * Warn if children aren't already suspended.
3377 * Also, add up the number of wakeup-enabled descendants.
3379 hub
->wakeup_enabled_descendants
= 0;
3380 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3381 struct usb_device
*udev
;
3383 udev
= hub
->ports
[port1
- 1]->child
;
3384 if (udev
&& udev
->can_submit
) {
3385 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3386 if (PMSG_IS_AUTO(msg
))
3390 hub
->wakeup_enabled_descendants
+=
3391 wakeup_enabled_descendants(udev
);
3394 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3395 /* check if there are changes pending on hub ports */
3396 if (check_ports_changed(hub
)) {
3397 if (PMSG_IS_AUTO(msg
))
3399 pm_wakeup_event(&hdev
->dev
, 2000);
3403 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3404 /* Enable hub to send remote wakeup for all ports. */
3405 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3406 status
= set_port_feature(hdev
,
3408 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3409 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3410 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3411 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3415 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3417 /* stop khubd and related activity */
3418 hub_quiesce(hub
, HUB_SUSPEND
);
3422 static int hub_resume(struct usb_interface
*intf
)
3424 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3426 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3427 hub_activate(hub
, HUB_RESUME
);
3431 static int hub_reset_resume(struct usb_interface
*intf
)
3433 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3435 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3436 hub_activate(hub
, HUB_RESET_RESUME
);
3441 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3442 * @rhdev: struct usb_device for the root hub
3444 * The USB host controller driver calls this function when its root hub
3445 * is resumed and Vbus power has been interrupted or the controller
3446 * has been reset. The routine marks @rhdev as having lost power.
3447 * When the hub driver is resumed it will take notice and carry out
3448 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3449 * the others will be disconnected.
3451 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3453 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3454 rhdev
->reset_resume
= 1;
3456 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3458 static const char * const usb3_lpm_names
[] = {
3466 * Send a Set SEL control transfer to the device, prior to enabling
3467 * device-initiated U1 or U2. This lets the device know the exit latencies from
3468 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3469 * packet from the host.
3471 * This function will fail if the SEL or PEL values for udev are greater than
3472 * the maximum allowed values for the link state to be enabled.
3474 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3476 struct usb_set_sel_req
*sel_values
;
3477 unsigned long long u1_sel
;
3478 unsigned long long u1_pel
;
3479 unsigned long long u2_sel
;
3480 unsigned long long u2_pel
;
3483 /* Convert SEL and PEL stored in ns to us */
3484 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3485 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3486 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3487 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3490 * Make sure that the calculated SEL and PEL values for the link
3491 * state we're enabling aren't bigger than the max SEL/PEL
3492 * value that will fit in the SET SEL control transfer.
3493 * Otherwise the device would get an incorrect idea of the exit
3494 * latency for the link state, and could start a device-initiated
3495 * U1/U2 when the exit latencies are too high.
3497 if ((state
== USB3_LPM_U1
&&
3498 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3499 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3500 (state
== USB3_LPM_U2
&&
3501 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3502 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3503 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3504 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3509 * If we're enabling device-initiated LPM for one link state,
3510 * but the other link state has a too high SEL or PEL value,
3511 * just set those values to the max in the Set SEL request.
3513 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3514 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3516 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3517 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3519 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3520 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3522 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3523 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3526 * usb_enable_lpm() can be called as part of a failed device reset,
3527 * which may be initiated by an error path of a mass storage driver.
3528 * Therefore, use GFP_NOIO.
3530 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3534 sel_values
->u1_sel
= u1_sel
;
3535 sel_values
->u1_pel
= u1_pel
;
3536 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3537 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3539 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3543 sel_values
, sizeof *(sel_values
),
3544 USB_CTRL_SET_TIMEOUT
);
3550 * Enable or disable device-initiated U1 or U2 transitions.
3552 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3553 enum usb3_link_state state
, bool enable
)
3560 feature
= USB_DEVICE_U1_ENABLE
;
3563 feature
= USB_DEVICE_U2_ENABLE
;
3566 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3567 __func__
, enable
? "enable" : "disable");
3571 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3572 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3573 "for unconfigured device.\n",
3574 __func__
, enable
? "enable" : "disable",
3575 usb3_lpm_names
[state
]);
3581 * Now send the control transfer to enable device-initiated LPM
3582 * for either U1 or U2.
3584 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3585 USB_REQ_SET_FEATURE
,
3589 USB_CTRL_SET_TIMEOUT
);
3591 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3592 USB_REQ_CLEAR_FEATURE
,
3596 USB_CTRL_SET_TIMEOUT
);
3599 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3600 enable
? "Enable" : "Disable",
3601 usb3_lpm_names
[state
]);
3607 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3608 enum usb3_link_state state
, int timeout
)
3615 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3618 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3621 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3626 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3627 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3628 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3629 "which is a reserved value.\n",
3630 usb3_lpm_names
[state
], timeout
);
3634 ret
= set_port_feature(udev
->parent
,
3635 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3638 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3639 "error code %i\n", usb3_lpm_names
[state
],
3643 if (state
== USB3_LPM_U1
)
3644 udev
->u1_params
.timeout
= timeout
;
3646 udev
->u2_params
.timeout
= timeout
;
3651 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3654 * We will attempt to enable U1 or U2, but there are no guarantees that the
3655 * control transfers to set the hub timeout or enable device-initiated U1/U2
3656 * will be successful.
3658 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3659 * driver know about it. If that call fails, it should be harmless, and just
3660 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3662 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3663 enum usb3_link_state state
)
3666 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3667 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3669 /* If the device says it doesn't have *any* exit latency to come out of
3670 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3673 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3674 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3678 * First, let the device know about the exit latencies
3679 * associated with the link state we're about to enable.
3681 ret
= usb_req_set_sel(udev
, state
);
3683 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3684 usb3_lpm_names
[state
]);
3688 /* We allow the host controller to set the U1/U2 timeout internally
3689 * first, so that it can change its schedule to account for the
3690 * additional latency to send data to a device in a lower power
3693 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3695 /* xHCI host controller doesn't want to enable this LPM state. */
3700 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3701 "xHCI error %i.\n", usb3_lpm_names
[state
],
3706 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3707 /* If we can't set the parent hub U1/U2 timeout,
3708 * device-initiated LPM won't be allowed either, so let the xHCI
3709 * host know that this link state won't be enabled.
3711 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3713 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3714 else if (udev
->actconfig
)
3715 usb_set_device_initiated_lpm(udev
, state
, true);
3720 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3723 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3724 * If zero is returned, the parent will not allow the link to go into U1/U2.
3726 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3727 * it won't have an effect on the bus link state because the parent hub will
3728 * still disallow device-initiated U1/U2 entry.
3730 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3731 * possible. The result will be slightly more bus bandwidth will be taken up
3732 * (to account for U1/U2 exit latency), but it should be harmless.
3734 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3735 enum usb3_link_state state
)
3741 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3744 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3747 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3752 if (usb_set_lpm_timeout(udev
, state
, 0))
3755 usb_set_device_initiated_lpm(udev
, state
, false);
3757 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3758 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3759 "bus schedule bandwidth may be impacted.\n",
3760 usb3_lpm_names
[state
]);
3765 * Disable hub-initiated and device-initiated U1 and U2 entry.
3766 * Caller must own the bandwidth_mutex.
3768 * This will call usb_enable_lpm() on failure, which will decrement
3769 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3771 int usb_disable_lpm(struct usb_device
*udev
)
3773 struct usb_hcd
*hcd
;
3775 if (!udev
|| !udev
->parent
||
3776 udev
->speed
!= USB_SPEED_SUPER
||
3780 hcd
= bus_to_hcd(udev
->bus
);
3781 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3784 udev
->lpm_disable_count
++;
3785 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3788 /* If LPM is enabled, attempt to disable it. */
3789 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3791 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3797 usb_enable_lpm(udev
);
3800 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3802 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3803 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3805 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3811 mutex_lock(hcd
->bandwidth_mutex
);
3812 ret
= usb_disable_lpm(udev
);
3813 mutex_unlock(hcd
->bandwidth_mutex
);
3817 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3820 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3821 * xHCI host policy may prevent U1 or U2 from being enabled.
3823 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3824 * until the lpm_disable_count drops to zero. Caller must own the
3827 void usb_enable_lpm(struct usb_device
*udev
)
3829 struct usb_hcd
*hcd
;
3831 if (!udev
|| !udev
->parent
||
3832 udev
->speed
!= USB_SPEED_SUPER
||
3836 udev
->lpm_disable_count
--;
3837 hcd
= bus_to_hcd(udev
->bus
);
3838 /* Double check that we can both enable and disable LPM.
3839 * Device must be configured to accept set feature U1/U2 timeout.
3841 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3842 !hcd
->driver
->disable_usb3_lpm_timeout
)
3845 if (udev
->lpm_disable_count
> 0)
3848 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3849 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3851 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3853 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3854 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3856 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3861 mutex_lock(hcd
->bandwidth_mutex
);
3862 usb_enable_lpm(udev
);
3863 mutex_unlock(hcd
->bandwidth_mutex
);
3865 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3868 #else /* CONFIG_PM */
3870 #define hub_suspend NULL
3871 #define hub_resume NULL
3872 #define hub_reset_resume NULL
3874 int usb_disable_lpm(struct usb_device
*udev
)
3878 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3880 void usb_enable_lpm(struct usb_device
*udev
) { }
3881 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3883 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3887 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3889 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3890 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3892 int usb_disable_ltm(struct usb_device
*udev
)
3896 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3898 void usb_enable_ltm(struct usb_device
*udev
) { }
3899 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3903 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3905 * Between connect detection and reset signaling there must be a delay
3906 * of 100ms at least for debounce and power-settling. The corresponding
3907 * timer shall restart whenever the downstream port detects a disconnect.
3909 * Apparently there are some bluetooth and irda-dongles and a number of
3910 * low-speed devices for which this debounce period may last over a second.
3911 * Not covered by the spec - but easy to deal with.
3913 * This implementation uses a 1500ms total debounce timeout; if the
3914 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3915 * every 25ms for transient disconnects. When the port status has been
3916 * unchanged for 100ms it returns the port status.
3918 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3921 int total_time
, stable_time
= 0;
3922 u16 portchange
, portstatus
;
3923 unsigned connection
= 0xffff;
3925 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3926 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3930 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3931 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3932 if (!must_be_connected
||
3933 (connection
== USB_PORT_STAT_CONNECTION
))
3934 stable_time
+= HUB_DEBOUNCE_STEP
;
3935 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3939 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3942 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3943 usb_clear_port_feature(hub
->hdev
, port1
,
3944 USB_PORT_FEAT_C_CONNECTION
);
3947 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3949 msleep(HUB_DEBOUNCE_STEP
);
3952 dev_dbg (hub
->intfdev
,
3953 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3954 port1
, total_time
, stable_time
, portstatus
);
3956 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3961 void usb_ep0_reinit(struct usb_device
*udev
)
3963 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3964 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3965 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3967 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3969 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3970 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3972 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3975 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3978 * The host controller will choose the device address,
3979 * instead of the core having chosen it earlier
3981 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3983 if (udev
->state
== USB_STATE_ADDRESS
)
3985 if (udev
->state
!= USB_STATE_DEFAULT
)
3987 if (hcd
->driver
->address_device
)
3988 retval
= hcd
->driver
->address_device(hcd
, udev
);
3990 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3991 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3992 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3994 update_devnum(udev
, devnum
);
3995 /* Device now using proper address. */
3996 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3997 usb_ep0_reinit(udev
);
4002 /* Reset device, (re)assign address, get device descriptor.
4003 * Device connection must be stable, no more debouncing needed.
4004 * Returns device in USB_STATE_ADDRESS, except on error.
4006 * If this is called for an already-existing device (as part of
4007 * usb_reset_and_verify_device), the caller must own the device lock. For a
4008 * newly detected device that is not accessible through any global
4009 * pointers, it's not necessary to lock the device.
4012 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4015 static DEFINE_MUTEX(usb_address0_mutex
);
4017 struct usb_device
*hdev
= hub
->hdev
;
4018 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4020 unsigned delay
= HUB_SHORT_RESET_TIME
;
4021 enum usb_device_speed oldspeed
= udev
->speed
;
4023 int devnum
= udev
->devnum
;
4025 /* root hub ports have a slightly longer reset period
4026 * (from USB 2.0 spec, section 7.1.7.5)
4028 if (!hdev
->parent
) {
4029 delay
= HUB_ROOT_RESET_TIME
;
4030 if (port1
== hdev
->bus
->otg_port
)
4031 hdev
->bus
->b_hnp_enable
= 0;
4034 /* Some low speed devices have problems with the quick delay, so */
4035 /* be a bit pessimistic with those devices. RHbug #23670 */
4036 if (oldspeed
== USB_SPEED_LOW
)
4037 delay
= HUB_LONG_RESET_TIME
;
4039 mutex_lock(&usb_address0_mutex
);
4041 /* Reset the device; full speed may morph to high speed */
4042 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4043 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4044 if (retval
< 0) /* error or disconnect */
4046 /* success, speed is known */
4050 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4051 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4054 oldspeed
= udev
->speed
;
4056 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4057 * it's fixed size except for full speed devices.
4058 * For Wireless USB devices, ep0 max packet is always 512 (tho
4059 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4061 switch (udev
->speed
) {
4062 case USB_SPEED_SUPER
:
4063 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4064 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4066 case USB_SPEED_HIGH
: /* fixed at 64 */
4067 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4069 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4070 /* to determine the ep0 maxpacket size, try to read
4071 * the device descriptor to get bMaxPacketSize0 and
4072 * then correct our initial guess.
4074 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4076 case USB_SPEED_LOW
: /* fixed at 8 */
4077 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4083 if (udev
->speed
== USB_SPEED_WIRELESS
)
4084 speed
= "variable speed Wireless";
4086 speed
= usb_speed_string(udev
->speed
);
4088 if (udev
->speed
!= USB_SPEED_SUPER
)
4089 dev_info(&udev
->dev
,
4090 "%s %s USB device number %d using %s\n",
4091 (udev
->config
) ? "reset" : "new", speed
,
4092 devnum
, udev
->bus
->controller
->driver
->name
);
4094 /* Set up TT records, if needed */
4096 udev
->tt
= hdev
->tt
;
4097 udev
->ttport
= hdev
->ttport
;
4098 } else if (udev
->speed
!= USB_SPEED_HIGH
4099 && hdev
->speed
== USB_SPEED_HIGH
) {
4101 dev_err(&udev
->dev
, "parent hub has no TT\n");
4105 udev
->tt
= &hub
->tt
;
4106 udev
->ttport
= port1
;
4109 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4110 * Because device hardware and firmware is sometimes buggy in
4111 * this area, and this is how Linux has done it for ages.
4112 * Change it cautiously.
4114 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4115 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4116 * so it may help with some non-standards-compliant devices.
4117 * Otherwise we start with SET_ADDRESS and then try to read the
4118 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4121 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4122 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4123 struct usb_device_descriptor
*buf
;
4126 #define GET_DESCRIPTOR_BUFSIZE 64
4127 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4133 /* Retry on all errors; some devices are flakey.
4134 * 255 is for WUSB devices, we actually need to use
4135 * 512 (WUSB1.0[4.8.1]).
4137 for (j
= 0; j
< 3; ++j
) {
4138 buf
->bMaxPacketSize0
= 0;
4139 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4140 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4141 USB_DT_DEVICE
<< 8, 0,
4142 buf
, GET_DESCRIPTOR_BUFSIZE
,
4143 initial_descriptor_timeout
);
4144 switch (buf
->bMaxPacketSize0
) {
4145 case 8: case 16: case 32: case 64: case 255:
4146 if (buf
->bDescriptorType
==
4160 udev
->descriptor
.bMaxPacketSize0
=
4161 buf
->bMaxPacketSize0
;
4164 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4165 if (retval
< 0) /* error or disconnect */
4167 if (oldspeed
!= udev
->speed
) {
4169 "device reset changed speed!\n");
4175 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4180 #undef GET_DESCRIPTOR_BUFSIZE
4184 * If device is WUSB, we already assigned an
4185 * unauthorized address in the Connect Ack sequence;
4186 * authorization will assign the final address.
4188 if (udev
->wusb
== 0) {
4189 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4190 retval
= hub_set_address(udev
, devnum
);
4196 if (retval
!= -ENODEV
)
4197 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4201 if (udev
->speed
== USB_SPEED_SUPER
) {
4202 devnum
= udev
->devnum
;
4203 dev_info(&udev
->dev
,
4204 "%s SuperSpeed USB device number %d using %s\n",
4205 (udev
->config
) ? "reset" : "new",
4206 devnum
, udev
->bus
->controller
->driver
->name
);
4209 /* cope with hardware quirkiness:
4210 * - let SET_ADDRESS settle, some device hardware wants it
4211 * - read ep0 maxpacket even for high and low speed,
4214 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4218 retval
= usb_get_device_descriptor(udev
, 8);
4220 if (retval
!= -ENODEV
)
4222 "device descriptor read/8, error %d\n",
4234 if (hcd
->phy
&& !hdev
->parent
)
4235 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4238 * Some superspeed devices have finished the link training process
4239 * and attached to a superspeed hub port, but the device descriptor
4240 * got from those devices show they aren't superspeed devices. Warm
4241 * reset the port attached by the devices can fix them.
4243 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4244 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4245 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4246 "warm reset device\n");
4247 hub_port_reset(hub
, port1
, udev
,
4248 HUB_BH_RESET_TIME
, true);
4253 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4254 udev
->speed
== USB_SPEED_SUPER
)
4257 i
= udev
->descriptor
.bMaxPacketSize0
;
4258 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4259 if (udev
->speed
== USB_SPEED_LOW
||
4260 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4261 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4265 if (udev
->speed
== USB_SPEED_FULL
)
4266 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4268 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4269 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4270 usb_ep0_reinit(udev
);
4273 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4274 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4275 if (retval
!= -ENODEV
)
4276 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4283 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4284 retval
= usb_get_bos_descriptor(udev
);
4286 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4287 usb_set_lpm_parameters(udev
);
4292 /* notify HCD that we have a device connected and addressed */
4293 if (hcd
->driver
->update_device
)
4294 hcd
->driver
->update_device(hcd
, udev
);
4297 hub_port_disable(hub
, port1
, 0);
4298 update_devnum(udev
, devnum
); /* for disconnect processing */
4300 mutex_unlock(&usb_address0_mutex
);
4305 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4307 struct usb_qualifier_descriptor
*qual
;
4310 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4314 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4315 qual
, sizeof *qual
);
4316 if (status
== sizeof *qual
) {
4317 dev_info(&udev
->dev
, "not running at top speed; "
4318 "connect to a high speed hub\n");
4319 /* hub LEDs are probably harder to miss than syslog */
4320 if (hub
->has_indicators
) {
4321 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4322 schedule_delayed_work (&hub
->leds
, 0);
4329 hub_power_remaining (struct usb_hub
*hub
)
4331 struct usb_device
*hdev
= hub
->hdev
;
4335 if (!hub
->limited_power
)
4338 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4339 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4340 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4346 if (hub_is_superspeed(udev
))
4352 * Unconfigured devices may not use more than one unit load,
4353 * or 8mA for OTG ports
4355 if (udev
->actconfig
)
4356 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4357 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4361 if (delta
> hub
->mA_per_port
)
4362 dev_warn(&udev
->dev
,
4363 "%dmA is over %umA budget for port %d!\n",
4364 delta
, hub
->mA_per_port
, port1
);
4367 if (remaining
< 0) {
4368 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4375 /* Handle physical or logical connection change events.
4376 * This routine is called when:
4377 * a port connection-change occurs;
4378 * a port enable-change occurs (often caused by EMI);
4379 * usb_reset_and_verify_device() encounters changed descriptors (as from
4380 * a firmware download)
4381 * caller already locked the hub
4383 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4384 u16 portstatus
, u16 portchange
)
4386 struct usb_device
*hdev
= hub
->hdev
;
4387 struct device
*hub_dev
= hub
->intfdev
;
4388 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4389 unsigned wHubCharacteristics
=
4390 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4391 struct usb_device
*udev
;
4396 "port %d, status %04x, change %04x, %s\n",
4397 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4399 if (hub
->has_indicators
) {
4400 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4401 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4404 #ifdef CONFIG_USB_OTG
4405 /* during HNP, don't repeat the debounce */
4406 if (hdev
->bus
->is_b_host
)
4407 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4408 USB_PORT_STAT_C_ENABLE
);
4411 /* Try to resuscitate an existing device */
4412 udev
= hub
->ports
[port1
- 1]->child
;
4413 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4414 udev
->state
!= USB_STATE_NOTATTACHED
) {
4415 usb_lock_device(udev
);
4416 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4417 status
= 0; /* Nothing to do */
4419 #ifdef CONFIG_PM_RUNTIME
4420 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4421 udev
->persist_enabled
) {
4422 /* For a suspended device, treat this as a
4423 * remote wakeup event.
4425 status
= usb_remote_wakeup(udev
);
4429 status
= -ENODEV
; /* Don't resuscitate */
4431 usb_unlock_device(udev
);
4434 clear_bit(port1
, hub
->change_bits
);
4439 /* Disconnect any existing devices under this port */
4441 if (hcd
->phy
&& !hdev
->parent
&&
4442 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4443 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4444 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4446 clear_bit(port1
, hub
->change_bits
);
4448 /* We can forget about a "removed" device when there's a physical
4449 * disconnect or the connect status changes.
4451 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4452 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4453 clear_bit(port1
, hub
->removed_bits
);
4455 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4456 USB_PORT_STAT_C_ENABLE
)) {
4457 status
= hub_port_debounce_be_stable(hub
, port1
);
4459 if (status
!= -ENODEV
&& printk_ratelimit())
4460 dev_err(hub_dev
, "connect-debounce failed, "
4461 "port %d disabled\n", port1
);
4462 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4464 portstatus
= status
;
4468 /* Return now if debouncing failed or nothing is connected or
4469 * the device was "removed".
4471 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4472 test_bit(port1
, hub
->removed_bits
)) {
4474 /* maybe switch power back on (e.g. root hub was reset) */
4475 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4476 && !port_is_power_on(hub
, portstatus
))
4477 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4479 if (portstatus
& USB_PORT_STAT_ENABLE
)
4483 if (hub_is_superspeed(hub
->hdev
))
4489 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4491 /* reallocate for each attempt, since references
4492 * to the previous one can escape in various ways
4494 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4497 "couldn't allocate port %d usb_device\n",
4502 usb_set_device_state(udev
, USB_STATE_POWERED
);
4503 udev
->bus_mA
= hub
->mA_per_port
;
4504 udev
->level
= hdev
->level
+ 1;
4505 udev
->wusb
= hub_is_wusb(hub
);
4507 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4508 if (hub_is_superspeed(hub
->hdev
))
4509 udev
->speed
= USB_SPEED_SUPER
;
4511 udev
->speed
= USB_SPEED_UNKNOWN
;
4513 choose_devnum(udev
);
4514 if (udev
->devnum
<= 0) {
4515 status
= -ENOTCONN
; /* Don't retry */
4519 /* reset (non-USB 3.0 devices) and get descriptor */
4520 status
= hub_port_init(hub
, udev
, port1
, i
);
4524 usb_detect_quirks(udev
);
4525 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4528 /* consecutive bus-powered hubs aren't reliable; they can
4529 * violate the voltage drop budget. if the new child has
4530 * a "powered" LED, users should notice we didn't enable it
4531 * (without reading syslog), even without per-port LEDs
4534 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4535 && udev
->bus_mA
<= unit_load
) {
4538 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4541 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4544 le16_to_cpus(&devstat
);
4545 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4547 "can't connect bus-powered hub "
4549 if (hub
->has_indicators
) {
4550 hub
->indicator
[port1
-1] =
4551 INDICATOR_AMBER_BLINK
;
4552 schedule_delayed_work (&hub
->leds
, 0);
4554 status
= -ENOTCONN
; /* Don't retry */
4559 /* check for devices running slower than they could */
4560 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4561 && udev
->speed
== USB_SPEED_FULL
4562 && highspeed_hubs
!= 0)
4563 check_highspeed (hub
, udev
, port1
);
4565 /* Store the parent's children[] pointer. At this point
4566 * udev becomes globally accessible, although presumably
4567 * no one will look at it until hdev is unlocked.
4571 /* We mustn't add new devices if the parent hub has
4572 * been disconnected; we would race with the
4573 * recursively_mark_NOTATTACHED() routine.
4575 spin_lock_irq(&device_state_lock
);
4576 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4579 hub
->ports
[port1
- 1]->child
= udev
;
4580 spin_unlock_irq(&device_state_lock
);
4582 /* Run it through the hoops (find a driver, etc) */
4584 status
= usb_new_device(udev
);
4586 spin_lock_irq(&device_state_lock
);
4587 hub
->ports
[port1
- 1]->child
= NULL
;
4588 spin_unlock_irq(&device_state_lock
);
4595 status
= hub_power_remaining(hub
);
4597 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4602 hub_port_disable(hub
, port1
, 1);
4604 usb_ep0_reinit(udev
);
4605 release_devnum(udev
);
4608 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4611 if (hub
->hdev
->parent
||
4612 !hcd
->driver
->port_handed_over
||
4613 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4614 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4615 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4620 hub_port_disable(hub
, port1
, 1);
4621 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4622 hcd
->driver
->relinquish_port(hcd
, port1
);
4625 /* Returns 1 if there was a remote wakeup and a connect status change. */
4626 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4627 u16 portstatus
, u16 portchange
)
4629 struct usb_device
*hdev
;
4630 struct usb_device
*udev
;
4631 int connect_change
= 0;
4635 udev
= hub
->ports
[port
- 1]->child
;
4636 if (!hub_is_superspeed(hdev
)) {
4637 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4639 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4641 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4642 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4648 /* TRSMRCY = 10 msec */
4651 usb_lock_device(udev
);
4652 ret
= usb_remote_wakeup(udev
);
4653 usb_unlock_device(udev
);
4658 hub_port_disable(hub
, port
, 1);
4660 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4662 return connect_change
;
4665 static void hub_events(void)
4667 struct list_head
*tmp
;
4668 struct usb_device
*hdev
;
4669 struct usb_interface
*intf
;
4670 struct usb_hub
*hub
;
4671 struct device
*hub_dev
;
4677 int connect_change
, wakeup_change
;
4680 * We restart the list every time to avoid a deadlock with
4681 * deleting hubs downstream from this one. This should be
4682 * safe since we delete the hub from the event list.
4683 * Not the most efficient, but avoids deadlocks.
4687 /* Grab the first entry at the beginning of the list */
4688 spin_lock_irq(&hub_event_lock
);
4689 if (list_empty(&hub_event_list
)) {
4690 spin_unlock_irq(&hub_event_lock
);
4694 tmp
= hub_event_list
.next
;
4697 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4698 kref_get(&hub
->kref
);
4699 spin_unlock_irq(&hub_event_lock
);
4702 hub_dev
= hub
->intfdev
;
4703 intf
= to_usb_interface(hub_dev
);
4704 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4705 hdev
->state
, hub
->descriptor
4706 ? hub
->descriptor
->bNbrPorts
4708 /* NOTE: expects max 15 ports... */
4709 (u16
) hub
->change_bits
[0],
4710 (u16
) hub
->event_bits
[0]);
4712 /* Lock the device, then check to see if we were
4713 * disconnected while waiting for the lock to succeed. */
4714 usb_lock_device(hdev
);
4715 if (unlikely(hub
->disconnected
))
4716 goto loop_disconnected
;
4718 /* If the hub has died, clean up after it */
4719 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4720 hub
->error
= -ENODEV
;
4721 hub_quiesce(hub
, HUB_DISCONNECT
);
4726 ret
= usb_autopm_get_interface(intf
);
4728 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4732 /* If this is an inactive hub, do nothing */
4737 dev_dbg (hub_dev
, "resetting for error %d\n",
4740 ret
= usb_reset_device(hdev
);
4743 "error resetting hub: %d\n", ret
);
4751 /* deal with port status changes */
4752 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4753 if (test_bit(i
, hub
->busy_bits
))
4755 connect_change
= test_bit(i
, hub
->change_bits
);
4756 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4757 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4758 !connect_change
&& !wakeup_change
)
4761 ret
= hub_port_status(hub
, i
,
4762 &portstatus
, &portchange
);
4766 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4767 usb_clear_port_feature(hdev
, i
,
4768 USB_PORT_FEAT_C_CONNECTION
);
4772 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4773 if (!connect_change
)
4775 "port %d enable change, "
4778 usb_clear_port_feature(hdev
, i
,
4779 USB_PORT_FEAT_C_ENABLE
);
4782 * EM interference sometimes causes badly
4783 * shielded USB devices to be shutdown by
4784 * the hub, this hack enables them again.
4785 * Works at least with mouse driver.
4787 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4789 && hub
->ports
[i
- 1]->child
) {
4792 "disabled by hub (EMI?), "
4799 if (hub_handle_remote_wakeup(hub
, i
,
4800 portstatus
, portchange
))
4803 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4807 dev_dbg(hub_dev
, "over-current change on port "
4809 usb_clear_port_feature(hdev
, i
,
4810 USB_PORT_FEAT_C_OVER_CURRENT
);
4811 msleep(100); /* Cool down */
4812 hub_power_on(hub
, true);
4813 hub_port_status(hub
, i
, &status
, &unused
);
4814 if (status
& USB_PORT_STAT_OVERCURRENT
)
4815 dev_err(hub_dev
, "over-current "
4816 "condition on port %d\n", i
);
4819 if (portchange
& USB_PORT_STAT_C_RESET
) {
4821 "reset change on port %d\n",
4823 usb_clear_port_feature(hdev
, i
,
4824 USB_PORT_FEAT_C_RESET
);
4826 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4827 hub_is_superspeed(hub
->hdev
)) {
4829 "warm reset change on port %d\n",
4831 usb_clear_port_feature(hdev
, i
,
4832 USB_PORT_FEAT_C_BH_PORT_RESET
);
4834 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4835 usb_clear_port_feature(hub
->hdev
, i
,
4836 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4838 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4840 "config error on port %d\n",
4842 usb_clear_port_feature(hub
->hdev
, i
,
4843 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4846 /* Warm reset a USB3 protocol port if it's in
4847 * SS.Inactive state.
4849 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4851 struct usb_device
*udev
=
4852 hub
->ports
[i
- 1]->child
;
4854 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4856 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4857 udev
->state
== USB_STATE_NOTATTACHED
) {
4858 status
= hub_port_reset(hub
, i
,
4859 NULL
, HUB_BH_RESET_TIME
,
4862 hub_port_disable(hub
, i
, 1);
4864 usb_lock_device(udev
);
4865 status
= usb_reset_device(udev
);
4866 usb_unlock_device(udev
);
4872 hub_port_connect_change(hub
, i
,
4873 portstatus
, portchange
);
4876 /* deal with hub status changes */
4877 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4879 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4880 dev_err (hub_dev
, "get_hub_status failed\n");
4882 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4883 dev_dbg (hub_dev
, "power change\n");
4884 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4885 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4886 /* FIXME: Is this always true? */
4887 hub
->limited_power
= 1;
4889 hub
->limited_power
= 0;
4891 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4895 dev_dbg(hub_dev
, "over-current change\n");
4896 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4897 msleep(500); /* Cool down */
4898 hub_power_on(hub
, true);
4899 hub_hub_status(hub
, &status
, &unused
);
4900 if (status
& HUB_STATUS_OVERCURRENT
)
4901 dev_err(hub_dev
, "over-current "
4907 /* Balance the usb_autopm_get_interface() above */
4908 usb_autopm_put_interface_no_suspend(intf
);
4910 /* Balance the usb_autopm_get_interface_no_resume() in
4911 * kick_khubd() and allow autosuspend.
4913 usb_autopm_put_interface(intf
);
4915 usb_unlock_device(hdev
);
4916 kref_put(&hub
->kref
, hub_release
);
4918 } /* end while (1) */
4921 static int hub_thread(void *__unused
)
4923 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4924 * port handover. Otherwise it might see that a full-speed device
4925 * was gone before the EHCI controller had handed its port over to
4926 * the companion full-speed controller.
4932 wait_event_freezable(khubd_wait
,
4933 !list_empty(&hub_event_list
) ||
4934 kthread_should_stop());
4935 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4937 pr_debug("%s: khubd exiting\n", usbcore_name
);
4941 static const struct usb_device_id hub_id_table
[] = {
4942 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4943 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4944 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4945 .bInterfaceClass
= USB_CLASS_HUB
,
4946 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4947 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4948 .bDeviceClass
= USB_CLASS_HUB
},
4949 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4950 .bInterfaceClass
= USB_CLASS_HUB
},
4951 { } /* Terminating entry */
4954 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4956 static struct usb_driver hub_driver
= {
4959 .disconnect
= hub_disconnect
,
4960 .suspend
= hub_suspend
,
4961 .resume
= hub_resume
,
4962 .reset_resume
= hub_reset_resume
,
4963 .pre_reset
= hub_pre_reset
,
4964 .post_reset
= hub_post_reset
,
4965 .unlocked_ioctl
= hub_ioctl
,
4966 .id_table
= hub_id_table
,
4967 .supports_autosuspend
= 1,
4970 int usb_hub_init(void)
4972 if (usb_register(&hub_driver
) < 0) {
4973 printk(KERN_ERR
"%s: can't register hub driver\n",
4978 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4979 if (!IS_ERR(khubd_task
))
4982 /* Fall through if kernel_thread failed */
4983 usb_deregister(&hub_driver
);
4984 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4989 void usb_hub_cleanup(void)
4991 kthread_stop(khubd_task
);
4994 * Hub resources are freed for us by usb_deregister. It calls
4995 * usb_driver_purge on every device which in turn calls that
4996 * devices disconnect function if it is using this driver.
4997 * The hub_disconnect function takes care of releasing the
4998 * individual hub resources. -greg
5000 usb_deregister(&hub_driver
);
5001 } /* usb_hub_cleanup() */
5003 static int descriptors_changed(struct usb_device
*udev
,
5004 struct usb_device_descriptor
*old_device_descriptor
)
5008 unsigned serial_len
= 0;
5010 unsigned old_length
;
5014 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5015 sizeof(*old_device_descriptor
)) != 0)
5018 /* Since the idVendor, idProduct, and bcdDevice values in the
5019 * device descriptor haven't changed, we will assume the
5020 * Manufacturer and Product strings haven't changed either.
5021 * But the SerialNumber string could be different (e.g., a
5022 * different flash card of the same brand).
5025 serial_len
= strlen(udev
->serial
) + 1;
5028 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5029 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5030 len
= max(len
, old_length
);
5033 buf
= kmalloc(len
, GFP_NOIO
);
5035 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5036 /* assume the worst */
5039 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5040 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5041 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5043 if (length
!= old_length
) {
5044 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5049 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5051 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5053 ((struct usb_config_descriptor
*) buf
)->
5054 bConfigurationValue
);
5060 if (!changed
&& serial_len
) {
5061 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5063 if (length
+ 1 != serial_len
) {
5064 dev_dbg(&udev
->dev
, "serial string error %d\n",
5067 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5068 dev_dbg(&udev
->dev
, "serial string changed\n");
5078 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5079 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5081 * WARNING - don't use this routine to reset a composite device
5082 * (one with multiple interfaces owned by separate drivers)!
5083 * Use usb_reset_device() instead.
5085 * Do a port reset, reassign the device's address, and establish its
5086 * former operating configuration. If the reset fails, or the device's
5087 * descriptors change from their values before the reset, or the original
5088 * configuration and altsettings cannot be restored, a flag will be set
5089 * telling khubd to pretend the device has been disconnected and then
5090 * re-connected. All drivers will be unbound, and the device will be
5091 * re-enumerated and probed all over again.
5093 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5094 * flagged for logical disconnection, or some other negative error code
5095 * if the reset wasn't even attempted.
5097 * The caller must own the device lock. For example, it's safe to use
5098 * this from a driver probe() routine after downloading new firmware.
5099 * For calls that might not occur during probe(), drivers should lock
5100 * the device using usb_lock_device_for_reset().
5102 * Locking exception: This routine may also be called from within an
5103 * autoresume handler. Such usage won't conflict with other tasks
5104 * holding the device lock because these tasks should always call
5105 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5107 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5109 struct usb_device
*parent_hdev
= udev
->parent
;
5110 struct usb_hub
*parent_hub
;
5111 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5112 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5114 int port1
= udev
->portnum
;
5116 if (udev
->state
== USB_STATE_NOTATTACHED
||
5117 udev
->state
== USB_STATE_SUSPENDED
) {
5118 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5124 /* this requires hcd-specific logic; see ohci_restart() */
5125 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5128 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5130 /* Disable LPM and LTM while we reset the device and reinstall the alt
5131 * settings. Device-initiated LPM settings, and system exit latency
5132 * settings are cleared when the device is reset, so we have to set
5135 ret
= usb_unlocked_disable_lpm(udev
);
5137 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5140 ret
= usb_disable_ltm(udev
);
5142 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5147 set_bit(port1
, parent_hub
->busy_bits
);
5148 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5150 /* ep0 maxpacket size may change; let the HCD know about it.
5151 * Other endpoints will be handled by re-enumeration. */
5152 usb_ep0_reinit(udev
);
5153 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5154 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5157 clear_bit(port1
, parent_hub
->busy_bits
);
5162 /* Device might have changed firmware (DFU or similar) */
5163 if (descriptors_changed(udev
, &descriptor
)) {
5164 dev_info(&udev
->dev
, "device firmware changed\n");
5165 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5169 /* Restore the device's previous configuration */
5170 if (!udev
->actconfig
)
5173 mutex_lock(hcd
->bandwidth_mutex
);
5174 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5176 dev_warn(&udev
->dev
,
5177 "Busted HC? Not enough HCD resources for "
5178 "old configuration.\n");
5179 mutex_unlock(hcd
->bandwidth_mutex
);
5182 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5183 USB_REQ_SET_CONFIGURATION
, 0,
5184 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5185 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5188 "can't restore configuration #%d (error=%d)\n",
5189 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5190 mutex_unlock(hcd
->bandwidth_mutex
);
5193 mutex_unlock(hcd
->bandwidth_mutex
);
5194 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5196 /* Put interfaces back into the same altsettings as before.
5197 * Don't bother to send the Set-Interface request for interfaces
5198 * that were already in altsetting 0; besides being unnecessary,
5199 * many devices can't handle it. Instead just reset the host-side
5202 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5203 struct usb_host_config
*config
= udev
->actconfig
;
5204 struct usb_interface
*intf
= config
->interface
[i
];
5205 struct usb_interface_descriptor
*desc
;
5207 desc
= &intf
->cur_altsetting
->desc
;
5208 if (desc
->bAlternateSetting
== 0) {
5209 usb_disable_interface(udev
, intf
, true);
5210 usb_enable_interface(udev
, intf
, true);
5213 /* Let the bandwidth allocation function know that this
5214 * device has been reset, and it will have to use
5215 * alternate setting 0 as the current alternate setting.
5217 intf
->resetting_device
= 1;
5218 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5219 desc
->bAlternateSetting
);
5220 intf
->resetting_device
= 0;
5223 dev_err(&udev
->dev
, "failed to restore interface %d "
5224 "altsetting %d (error=%d)\n",
5225 desc
->bInterfaceNumber
,
5226 desc
->bAlternateSetting
,
5233 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5234 usb_unlocked_enable_lpm(udev
);
5235 usb_enable_ltm(udev
);
5239 /* LPM state doesn't matter when we're about to destroy the device. */
5240 hub_port_logical_disconnect(parent_hub
, port1
);
5245 * usb_reset_device - warn interface drivers and perform a USB port reset
5246 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5248 * Warns all drivers bound to registered interfaces (using their pre_reset
5249 * method), performs the port reset, and then lets the drivers know that
5250 * the reset is over (using their post_reset method).
5252 * Return value is the same as for usb_reset_and_verify_device().
5254 * The caller must own the device lock. For example, it's safe to use
5255 * this from a driver probe() routine after downloading new firmware.
5256 * For calls that might not occur during probe(), drivers should lock
5257 * the device using usb_lock_device_for_reset().
5259 * If an interface is currently being probed or disconnected, we assume
5260 * its driver knows how to handle resets. For all other interfaces,
5261 * if the driver doesn't have pre_reset and post_reset methods then
5262 * we attempt to unbind it and rebind afterward.
5264 int usb_reset_device(struct usb_device
*udev
)
5268 unsigned int noio_flag
;
5269 struct usb_host_config
*config
= udev
->actconfig
;
5271 if (udev
->state
== USB_STATE_NOTATTACHED
||
5272 udev
->state
== USB_STATE_SUSPENDED
) {
5273 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5279 * Don't allocate memory with GFP_KERNEL in current
5280 * context to avoid possible deadlock if usb mass
5281 * storage interface or usbnet interface(iSCSI case)
5282 * is included in current configuration. The easist
5283 * approach is to do it for every device reset,
5284 * because the device 'memalloc_noio' flag may have
5285 * not been set before reseting the usb device.
5287 noio_flag
= memalloc_noio_save();
5289 /* Prevent autosuspend during the reset */
5290 usb_autoresume_device(udev
);
5293 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5294 struct usb_interface
*cintf
= config
->interface
[i
];
5295 struct usb_driver
*drv
;
5298 if (cintf
->dev
.driver
) {
5299 drv
= to_usb_driver(cintf
->dev
.driver
);
5300 if (drv
->pre_reset
&& drv
->post_reset
)
5301 unbind
= (drv
->pre_reset
)(cintf
);
5302 else if (cintf
->condition
==
5303 USB_INTERFACE_BOUND
)
5306 usb_forced_unbind_intf(cintf
);
5311 ret
= usb_reset_and_verify_device(udev
);
5314 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5315 struct usb_interface
*cintf
= config
->interface
[i
];
5316 struct usb_driver
*drv
;
5317 int rebind
= cintf
->needs_binding
;
5319 if (!rebind
&& cintf
->dev
.driver
) {
5320 drv
= to_usb_driver(cintf
->dev
.driver
);
5321 if (drv
->post_reset
)
5322 rebind
= (drv
->post_reset
)(cintf
);
5323 else if (cintf
->condition
==
5324 USB_INTERFACE_BOUND
)
5327 cintf
->needs_binding
= 1;
5330 usb_unbind_and_rebind_marked_interfaces(udev
);
5333 usb_autosuspend_device(udev
);
5334 memalloc_noio_restore(noio_flag
);
5337 EXPORT_SYMBOL_GPL(usb_reset_device
);
5341 * usb_queue_reset_device - Reset a USB device from an atomic context
5342 * @iface: USB interface belonging to the device to reset
5344 * This function can be used to reset a USB device from an atomic
5345 * context, where usb_reset_device() won't work (as it blocks).
5347 * Doing a reset via this method is functionally equivalent to calling
5348 * usb_reset_device(), except for the fact that it is delayed to a
5349 * workqueue. This means that any drivers bound to other interfaces
5350 * might be unbound, as well as users from usbfs in user space.
5354 * - Scheduling two resets at the same time from two different drivers
5355 * attached to two different interfaces of the same device is
5356 * possible; depending on how the driver attached to each interface
5357 * handles ->pre_reset(), the second reset might happen or not.
5359 * - If a driver is unbound and it had a pending reset, the reset will
5362 * - This function can be called during .probe() or .disconnect()
5363 * times. On return from .disconnect(), any pending resets will be
5366 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5369 * NOTE: We don't do any reference count tracking because it is not
5370 * needed. The lifecycle of the work_struct is tied to the
5371 * usb_interface. Before destroying the interface we cancel the
5372 * work_struct, so the fact that work_struct is queued and or
5373 * running means the interface (and thus, the device) exist and
5376 void usb_queue_reset_device(struct usb_interface
*iface
)
5378 schedule_work(&iface
->reset_ws
);
5380 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5383 * usb_hub_find_child - Get the pointer of child device
5384 * attached to the port which is specified by @port1.
5385 * @hdev: USB device belonging to the usb hub
5386 * @port1: port num to indicate which port the child device
5389 * USB drivers call this function to get hub's child device
5392 * Return NULL if input param is invalid and
5393 * child's usb_device pointer if non-NULL.
5395 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5398 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5400 if (port1
< 1 || port1
> hdev
->maxchild
)
5402 return hub
->ports
[port1
- 1]->child
;
5404 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5407 * usb_set_hub_port_connect_type - set hub port connect type.
5408 * @hdev: USB device belonging to the usb hub
5409 * @port1: port num of the port
5410 * @type: connect type of the port
5412 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5413 enum usb_port_connect_type type
)
5415 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5417 hub
->ports
[port1
- 1]->connect_type
= type
;
5421 * usb_get_hub_port_connect_type - Get the port's connect type
5422 * @hdev: USB device belonging to the usb hub
5423 * @port1: port num of the port
5425 * Return connect type of the port and if input params are
5426 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5428 enum usb_port_connect_type
5429 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5431 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5433 return hub
->ports
[port1
- 1]->connect_type
;
5436 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5437 struct usb_hub_descriptor
*desc
)
5439 enum usb_port_connect_type connect_type
;
5442 if (!hub_is_superspeed(hdev
)) {
5443 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5444 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5446 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5447 u8 mask
= 1 << (i
%8);
5449 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5450 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5452 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5457 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
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
) {
5465 if (!(port_removable
& mask
)) {
5466 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5468 port_removable
|= mask
;
5473 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5479 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5480 * @hdev: USB device belonging to the usb hub
5481 * @port1: port num of the port
5483 * Return port's acpi handle if successful, NULL if params are
5486 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5489 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5491 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);