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 * - If user has indicated to prevent autosuspend by passing
1704 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1706 if (hdev
->dev
.power
.autosuspend_delay
>= 0)
1707 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1710 * Hubs have proper suspend/resume support, except for root hubs
1711 * where the controller driver doesn't have bus_suspend and
1712 * bus_resume methods.
1714 if (hdev
->parent
) { /* normal device */
1715 usb_enable_autosuspend(hdev
);
1716 } else { /* root hub */
1717 const struct hc_driver
*drv
= bus_to_hcd(hdev
->bus
)->driver
;
1719 if (drv
->bus_suspend
&& drv
->bus_resume
)
1720 usb_enable_autosuspend(hdev
);
1723 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1725 "Unsupported bus topology: hub nested too deep\n");
1729 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1731 dev_warn(&intf
->dev
, "ignoring external hub\n");
1736 /* Some hubs have a subclass of 1, which AFAICT according to the */
1737 /* specs is not defined, but it works */
1738 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1739 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1741 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1745 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1746 if (desc
->desc
.bNumEndpoints
!= 1)
1747 goto descriptor_error
;
1749 endpoint
= &desc
->endpoint
[0].desc
;
1751 /* If it's not an interrupt in endpoint, we'd better punt! */
1752 if (!usb_endpoint_is_int_in(endpoint
))
1753 goto descriptor_error
;
1755 /* We found a hub */
1756 dev_info (&intf
->dev
, "USB hub found\n");
1758 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1760 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1764 kref_init(&hub
->kref
);
1765 INIT_LIST_HEAD(&hub
->event_list
);
1766 hub
->intfdev
= &intf
->dev
;
1768 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1769 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1772 usb_set_intfdata (intf
, hub
);
1773 intf
->needs_remote_wakeup
= 1;
1774 pm_suspend_ignore_children(&intf
->dev
, true);
1776 if (hdev
->speed
== USB_SPEED_HIGH
)
1779 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1780 hub
->quirk_check_port_auto_suspend
= 1;
1782 if (hub_configure(hub
, endpoint
) >= 0)
1785 hub_disconnect (intf
);
1790 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1792 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1793 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1795 /* assert ifno == 0 (part of hub spec) */
1797 case USBDEVFS_HUB_PORTINFO
: {
1798 struct usbdevfs_hub_portinfo
*info
= user_data
;
1801 spin_lock_irq(&device_state_lock
);
1802 if (hdev
->devnum
<= 0)
1805 info
->nports
= hdev
->maxchild
;
1806 for (i
= 0; i
< info
->nports
; i
++) {
1807 if (hub
->ports
[i
]->child
== NULL
)
1811 hub
->ports
[i
]->child
->devnum
;
1814 spin_unlock_irq(&device_state_lock
);
1816 return info
->nports
+ 1;
1825 * Allow user programs to claim ports on a hub. When a device is attached
1826 * to one of these "claimed" ports, the program will "own" the device.
1828 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1829 struct dev_state
***ppowner
)
1831 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1833 if (port1
== 0 || port1
> hdev
->maxchild
)
1836 /* This assumes that devices not managed by the hub driver
1837 * will always have maxchild equal to 0.
1839 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1843 /* In the following three functions, the caller must hold hdev's lock */
1844 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1845 struct dev_state
*owner
)
1848 struct dev_state
**powner
;
1850 rc
= find_port_owner(hdev
, port1
, &powner
);
1859 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1860 struct dev_state
*owner
)
1863 struct dev_state
**powner
;
1865 rc
= find_port_owner(hdev
, port1
, &powner
);
1868 if (*powner
!= owner
)
1874 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1876 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1879 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1880 if (hub
->ports
[n
]->port_owner
== owner
)
1881 hub
->ports
[n
]->port_owner
= NULL
;
1886 /* The caller must hold udev's lock */
1887 bool usb_device_is_owned(struct usb_device
*udev
)
1889 struct usb_hub
*hub
;
1891 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1893 hub
= usb_hub_to_struct_hub(udev
->parent
);
1894 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1897 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1899 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1902 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1903 if (hub
->ports
[i
]->child
)
1904 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1906 if (udev
->state
== USB_STATE_SUSPENDED
)
1907 udev
->active_duration
-= jiffies
;
1908 udev
->state
= USB_STATE_NOTATTACHED
;
1912 * usb_set_device_state - change a device's current state (usbcore, hcds)
1913 * @udev: pointer to device whose state should be changed
1914 * @new_state: new state value to be stored
1916 * udev->state is _not_ fully protected by the device lock. Although
1917 * most transitions are made only while holding the lock, the state can
1918 * can change to USB_STATE_NOTATTACHED at almost any time. This
1919 * is so that devices can be marked as disconnected as soon as possible,
1920 * without having to wait for any semaphores to be released. As a result,
1921 * all changes to any device's state must be protected by the
1922 * device_state_lock spinlock.
1924 * Once a device has been added to the device tree, all changes to its state
1925 * should be made using this routine. The state should _not_ be set directly.
1927 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1928 * Otherwise udev->state is set to new_state, and if new_state is
1929 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1930 * to USB_STATE_NOTATTACHED.
1932 void usb_set_device_state(struct usb_device
*udev
,
1933 enum usb_device_state new_state
)
1935 unsigned long flags
;
1938 spin_lock_irqsave(&device_state_lock
, flags
);
1939 if (udev
->state
== USB_STATE_NOTATTACHED
)
1941 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1943 /* root hub wakeup capabilities are managed out-of-band
1944 * and may involve silicon errata ... ignore them here.
1947 if (udev
->state
== USB_STATE_SUSPENDED
1948 || new_state
== USB_STATE_SUSPENDED
)
1949 ; /* No change to wakeup settings */
1950 else if (new_state
== USB_STATE_CONFIGURED
)
1951 wakeup
= udev
->actconfig
->desc
.bmAttributes
1952 & USB_CONFIG_ATT_WAKEUP
;
1956 if (udev
->state
== USB_STATE_SUSPENDED
&&
1957 new_state
!= USB_STATE_SUSPENDED
)
1958 udev
->active_duration
-= jiffies
;
1959 else if (new_state
== USB_STATE_SUSPENDED
&&
1960 udev
->state
!= USB_STATE_SUSPENDED
)
1961 udev
->active_duration
+= jiffies
;
1962 udev
->state
= new_state
;
1964 recursively_mark_NOTATTACHED(udev
);
1965 spin_unlock_irqrestore(&device_state_lock
, flags
);
1967 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1969 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1972 * Choose a device number.
1974 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1975 * USB-2.0 buses they are also used as device addresses, however on
1976 * USB-3.0 buses the address is assigned by the controller hardware
1977 * and it usually is not the same as the device number.
1979 * WUSB devices are simple: they have no hubs behind, so the mapping
1980 * device <-> virtual port number becomes 1:1. Why? to simplify the
1981 * life of the device connection logic in
1982 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1983 * handshake we need to assign a temporary address in the unauthorized
1984 * space. For simplicity we use the first virtual port number found to
1985 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1986 * and that becomes it's address [X < 128] or its unauthorized address
1989 * We add 1 as an offset to the one-based USB-stack port number
1990 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1991 * 0 is reserved by USB for default address; (b) Linux's USB stack
1992 * uses always #1 for the root hub of the controller. So USB stack's
1993 * port #1, which is wusb virtual-port #0 has address #2.
1995 * Devices connected under xHCI are not as simple. The host controller
1996 * supports virtualization, so the hardware assigns device addresses and
1997 * the HCD must setup data structures before issuing a set address
1998 * command to the hardware.
2000 static void choose_devnum(struct usb_device
*udev
)
2003 struct usb_bus
*bus
= udev
->bus
;
2005 /* If khubd ever becomes multithreaded, this will need a lock */
2007 devnum
= udev
->portnum
+ 1;
2008 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
2010 /* Try to allocate the next devnum beginning at
2011 * bus->devnum_next. */
2012 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
2015 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
2017 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
2020 set_bit(devnum
, bus
->devmap
.devicemap
);
2021 udev
->devnum
= devnum
;
2025 static void release_devnum(struct usb_device
*udev
)
2027 if (udev
->devnum
> 0) {
2028 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2033 static void update_devnum(struct usb_device
*udev
, int devnum
)
2035 /* The address for a WUSB device is managed by wusbcore. */
2037 udev
->devnum
= devnum
;
2040 static void hub_free_dev(struct usb_device
*udev
)
2042 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2044 /* Root hubs aren't real devices, so don't free HCD resources */
2045 if (hcd
->driver
->free_dev
&& udev
->parent
)
2046 hcd
->driver
->free_dev(hcd
, udev
);
2050 * usb_disconnect - disconnect a device (usbcore-internal)
2051 * @pdev: pointer to device being disconnected
2052 * Context: !in_interrupt ()
2054 * Something got disconnected. Get rid of it and all of its children.
2056 * If *pdev is a normal device then the parent hub must already be locked.
2057 * If *pdev is a root hub then this routine will acquire the
2058 * usb_bus_list_lock on behalf of the caller.
2060 * Only hub drivers (including virtual root hub drivers for host
2061 * controllers) should ever call this.
2063 * This call is synchronous, and may not be used in an interrupt context.
2065 void usb_disconnect(struct usb_device
**pdev
)
2067 struct usb_device
*udev
= *pdev
;
2068 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2071 /* mark the device as inactive, so any further urb submissions for
2072 * this device (and any of its children) will fail immediately.
2073 * this quiesces everything except pending urbs.
2075 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2076 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2079 usb_lock_device(udev
);
2081 /* Free up all the children before we remove this device */
2082 for (i
= 0; i
< udev
->maxchild
; i
++) {
2083 if (hub
->ports
[i
]->child
)
2084 usb_disconnect(&hub
->ports
[i
]->child
);
2087 /* deallocate hcd/hardware state ... nuking all pending urbs and
2088 * cleaning up all state associated with the current configuration
2089 * so that the hardware is now fully quiesced.
2091 dev_dbg (&udev
->dev
, "unregistering device\n");
2092 usb_disable_device(udev
, 0);
2093 usb_hcd_synchronize_unlinks(udev
);
2096 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2097 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2099 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2100 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2102 if (!port_dev
->did_runtime_put
)
2103 pm_runtime_put(&port_dev
->dev
);
2105 port_dev
->did_runtime_put
= false;
2108 usb_remove_ep_devs(&udev
->ep0
);
2109 usb_unlock_device(udev
);
2111 /* Unregister the device. The device driver is responsible
2112 * for de-configuring the device and invoking the remove-device
2113 * notifier chain (used by usbfs and possibly others).
2115 device_del(&udev
->dev
);
2117 /* Free the device number and delete the parent's children[]
2118 * (or root_hub) pointer.
2120 release_devnum(udev
);
2122 /* Avoid races with recursively_mark_NOTATTACHED() */
2123 spin_lock_irq(&device_state_lock
);
2125 spin_unlock_irq(&device_state_lock
);
2129 put_device(&udev
->dev
);
2132 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2133 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2137 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2140 static void announce_device(struct usb_device
*udev
)
2142 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2143 le16_to_cpu(udev
->descriptor
.idVendor
),
2144 le16_to_cpu(udev
->descriptor
.idProduct
));
2145 dev_info(&udev
->dev
,
2146 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2147 udev
->descriptor
.iManufacturer
,
2148 udev
->descriptor
.iProduct
,
2149 udev
->descriptor
.iSerialNumber
);
2150 show_string(udev
, "Product", udev
->product
);
2151 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2152 show_string(udev
, "SerialNumber", udev
->serial
);
2155 static inline void announce_device(struct usb_device
*udev
) { }
2158 #ifdef CONFIG_USB_OTG
2159 #include "otg_whitelist.h"
2163 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2164 * @udev: newly addressed device (in ADDRESS state)
2166 * Finish enumeration for On-The-Go devices
2168 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2172 #ifdef CONFIG_USB_OTG
2174 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2175 * to wake us after we've powered off VBUS; and HNP, switching roles
2176 * "host" to "peripheral". The OTG descriptor helps figure this out.
2178 if (!udev
->bus
->is_b_host
2180 && udev
->parent
== udev
->bus
->root_hub
) {
2181 struct usb_otg_descriptor
*desc
= NULL
;
2182 struct usb_bus
*bus
= udev
->bus
;
2184 /* descriptor may appear anywhere in config */
2185 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2186 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2187 USB_DT_OTG
, (void **) &desc
) == 0) {
2188 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2189 unsigned port1
= udev
->portnum
;
2191 dev_info(&udev
->dev
,
2192 "Dual-Role OTG device on %sHNP port\n",
2193 (port1
== bus
->otg_port
)
2196 /* enable HNP before suspend, it's simpler */
2197 if (port1
== bus
->otg_port
)
2198 bus
->b_hnp_enable
= 1;
2199 err
= usb_control_msg(udev
,
2200 usb_sndctrlpipe(udev
, 0),
2201 USB_REQ_SET_FEATURE
, 0,
2203 ? USB_DEVICE_B_HNP_ENABLE
2204 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2205 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2207 /* OTG MESSAGE: report errors here,
2208 * customize to match your product.
2210 dev_info(&udev
->dev
,
2211 "can't set HNP mode: %d\n",
2213 bus
->b_hnp_enable
= 0;
2219 if (!is_targeted(udev
)) {
2221 /* Maybe it can talk to us, though we can't talk to it.
2222 * (Includes HNP test device.)
2224 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2225 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2227 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2239 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2240 * @udev: newly addressed device (in ADDRESS state)
2242 * This is only called by usb_new_device() and usb_authorize_device()
2243 * and FIXME -- all comments that apply to them apply here wrt to
2246 * If the device is WUSB and not authorized, we don't attempt to read
2247 * the string descriptors, as they will be errored out by the device
2248 * until it has been authorized.
2250 static int usb_enumerate_device(struct usb_device
*udev
)
2254 if (udev
->config
== NULL
) {
2255 err
= usb_get_configuration(udev
);
2258 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2264 /* read the standard strings and cache them if present */
2265 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2266 udev
->manufacturer
= usb_cache_string(udev
,
2267 udev
->descriptor
.iManufacturer
);
2268 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2270 err
= usb_enumerate_device_otg(udev
);
2274 usb_detect_interface_quirks(udev
);
2279 static void set_usb_port_removable(struct usb_device
*udev
)
2281 struct usb_device
*hdev
= udev
->parent
;
2282 struct usb_hub
*hub
;
2283 u8 port
= udev
->portnum
;
2284 u16 wHubCharacteristics
;
2285 bool removable
= true;
2290 hub
= usb_hub_to_struct_hub(udev
->parent
);
2292 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2294 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2297 if (hub_is_superspeed(hdev
)) {
2298 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2302 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2307 udev
->removable
= USB_DEVICE_REMOVABLE
;
2309 udev
->removable
= USB_DEVICE_FIXED
;
2313 * usb_new_device - perform initial device setup (usbcore-internal)
2314 * @udev: newly addressed device (in ADDRESS state)
2316 * This is called with devices which have been detected but not fully
2317 * enumerated. The device descriptor is available, but not descriptors
2318 * for any device configuration. The caller must have locked either
2319 * the parent hub (if udev is a normal device) or else the
2320 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2321 * udev has already been installed, but udev is not yet visible through
2322 * sysfs or other filesystem code.
2324 * It will return if the device is configured properly or not. Zero if
2325 * the interface was registered with the driver core; else a negative
2328 * This call is synchronous, and may not be used in an interrupt context.
2330 * Only the hub driver or root-hub registrar should ever call this.
2332 int usb_new_device(struct usb_device
*udev
)
2337 /* Initialize non-root-hub device wakeup to disabled;
2338 * device (un)configuration controls wakeup capable
2339 * sysfs power/wakeup controls wakeup enabled/disabled
2341 device_init_wakeup(&udev
->dev
, 0);
2344 /* Tell the runtime-PM framework the device is active */
2345 pm_runtime_set_active(&udev
->dev
);
2346 pm_runtime_get_noresume(&udev
->dev
);
2347 pm_runtime_use_autosuspend(&udev
->dev
);
2348 pm_runtime_enable(&udev
->dev
);
2350 /* By default, forbid autosuspend for all devices. It will be
2351 * allowed for hubs during binding.
2353 usb_disable_autosuspend(udev
);
2355 err
= usb_enumerate_device(udev
); /* Read descriptors */
2358 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2359 udev
->devnum
, udev
->bus
->busnum
,
2360 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2361 /* export the usbdev device-node for libusb */
2362 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2363 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2365 /* Tell the world! */
2366 announce_device(udev
);
2369 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2371 add_device_randomness(udev
->product
, strlen(udev
->product
));
2372 if (udev
->manufacturer
)
2373 add_device_randomness(udev
->manufacturer
,
2374 strlen(udev
->manufacturer
));
2376 device_enable_async_suspend(&udev
->dev
);
2379 * check whether the hub marks this port as non-removable. Do it
2380 * now so that platform-specific data can override it in
2384 set_usb_port_removable(udev
);
2386 /* Register the device. The device driver is responsible
2387 * for configuring the device and invoking the add-device
2388 * notifier chain (used by usbfs and possibly others).
2390 err
= device_add(&udev
->dev
);
2392 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2396 /* Create link files between child device and usb port device. */
2398 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2399 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2401 err
= sysfs_create_link(&udev
->dev
.kobj
,
2402 &port_dev
->dev
.kobj
, "port");
2406 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2407 &udev
->dev
.kobj
, "device");
2409 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2413 pm_runtime_get_sync(&port_dev
->dev
);
2416 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2417 usb_mark_last_busy(udev
);
2418 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2422 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2423 pm_runtime_disable(&udev
->dev
);
2424 pm_runtime_set_suspended(&udev
->dev
);
2430 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2431 * @usb_dev: USB device
2433 * Move the USB device to a very basic state where interfaces are disabled
2434 * and the device is in fact unconfigured and unusable.
2436 * We share a lock (that we have) with device_del(), so we need to
2439 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2441 usb_lock_device(usb_dev
);
2442 if (usb_dev
->authorized
== 0)
2443 goto out_unauthorized
;
2445 usb_dev
->authorized
= 0;
2446 usb_set_configuration(usb_dev
, -1);
2449 usb_unlock_device(usb_dev
);
2454 int usb_authorize_device(struct usb_device
*usb_dev
)
2458 usb_lock_device(usb_dev
);
2459 if (usb_dev
->authorized
== 1)
2460 goto out_authorized
;
2462 result
= usb_autoresume_device(usb_dev
);
2464 dev_err(&usb_dev
->dev
,
2465 "can't autoresume for authorization: %d\n", result
);
2466 goto error_autoresume
;
2468 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2470 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2471 "authorization: %d\n", result
);
2472 goto error_device_descriptor
;
2475 usb_dev
->authorized
= 1;
2476 /* Choose and set the configuration. This registers the interfaces
2477 * with the driver core and lets interface drivers bind to them.
2479 c
= usb_choose_configuration(usb_dev
);
2481 result
= usb_set_configuration(usb_dev
, c
);
2483 dev_err(&usb_dev
->dev
,
2484 "can't set config #%d, error %d\n", c
, result
);
2485 /* This need not be fatal. The user can try to
2486 * set other configurations. */
2489 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2491 error_device_descriptor
:
2492 usb_autosuspend_device(usb_dev
);
2495 usb_unlock_device(usb_dev
); // complements locktree
2500 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2501 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2503 struct usb_hcd
*hcd
;
2504 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2506 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2507 return hcd
->wireless
;
2511 #define PORT_RESET_TRIES 5
2512 #define SET_ADDRESS_TRIES 2
2513 #define GET_DESCRIPTOR_TRIES 2
2514 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2515 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2517 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2518 #define HUB_SHORT_RESET_TIME 10
2519 #define HUB_BH_RESET_TIME 50
2520 #define HUB_LONG_RESET_TIME 200
2521 #define HUB_RESET_TIMEOUT 800
2523 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2524 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2526 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2527 * Port worm reset is required to recover
2529 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2531 return hub_is_superspeed(hub
->hdev
) &&
2532 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2533 USB_SS_PORT_LS_SS_INACTIVE
) ||
2534 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2535 USB_SS_PORT_LS_COMP_MOD
)) ;
2538 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2539 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2541 int delay_time
, ret
;
2545 for (delay_time
= 0;
2546 delay_time
< HUB_RESET_TIMEOUT
;
2547 delay_time
+= delay
) {
2548 /* wait to give the device a chance to reset */
2551 /* read and decode port status */
2552 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2556 /* The port state is unknown until the reset completes. */
2557 if (!(portstatus
& USB_PORT_STAT_RESET
))
2560 /* switch to the long delay after two short delay failures */
2561 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2562 delay
= HUB_LONG_RESET_TIME
;
2564 dev_dbg (hub
->intfdev
,
2565 "port %d not %sreset yet, waiting %dms\n",
2566 port1
, warm
? "warm " : "", delay
);
2569 if ((portstatus
& USB_PORT_STAT_RESET
))
2572 if (hub_port_warm_reset_required(hub
, portstatus
))
2575 /* Device went away? */
2576 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2579 /* bomb out completely if the connection bounced. A USB 3.0
2580 * connection may bounce if multiple warm resets were issued,
2581 * but the device may have successfully re-connected. Ignore it.
2583 if (!hub_is_superspeed(hub
->hdev
) &&
2584 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2587 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2593 if (hub_is_wusb(hub
))
2594 udev
->speed
= USB_SPEED_WIRELESS
;
2595 else if (hub_is_superspeed(hub
->hdev
))
2596 udev
->speed
= USB_SPEED_SUPER
;
2597 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2598 udev
->speed
= USB_SPEED_HIGH
;
2599 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2600 udev
->speed
= USB_SPEED_LOW
;
2602 udev
->speed
= USB_SPEED_FULL
;
2606 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2607 struct usb_device
*udev
, int *status
)
2611 /* TRSTRCY = 10 ms; plus some extra */
2614 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2616 update_devnum(udev
, 0);
2617 /* The xHC may think the device is already reset,
2618 * so ignore the status.
2620 if (hcd
->driver
->reset_device
)
2621 hcd
->driver
->reset_device(hcd
, udev
);
2626 usb_clear_port_feature(hub
->hdev
,
2627 port1
, USB_PORT_FEAT_C_RESET
);
2628 if (hub_is_superspeed(hub
->hdev
)) {
2629 usb_clear_port_feature(hub
->hdev
, port1
,
2630 USB_PORT_FEAT_C_BH_PORT_RESET
);
2631 usb_clear_port_feature(hub
->hdev
, port1
,
2632 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2633 usb_clear_port_feature(hub
->hdev
, port1
,
2634 USB_PORT_FEAT_C_CONNECTION
);
2637 usb_set_device_state(udev
, *status
2638 ? USB_STATE_NOTATTACHED
2639 : USB_STATE_DEFAULT
);
2644 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2645 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2646 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2649 u16 portchange
, portstatus
;
2651 if (!hub_is_superspeed(hub
->hdev
)) {
2653 dev_err(hub
->intfdev
, "only USB3 hub support "
2657 /* Block EHCI CF initialization during the port reset.
2658 * Some companion controllers don't like it when they mix.
2660 down_read(&ehci_cf_port_reset_rwsem
);
2663 * If the caller hasn't explicitly requested a warm reset,
2664 * double check and see if one is needed.
2666 status
= hub_port_status(hub
, port1
,
2667 &portstatus
, &portchange
);
2671 if (hub_port_warm_reset_required(hub
, portstatus
))
2675 /* Reset the port */
2676 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2677 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2678 USB_PORT_FEAT_BH_PORT_RESET
:
2679 USB_PORT_FEAT_RESET
));
2680 if (status
== -ENODEV
) {
2681 ; /* The hub is gone */
2682 } else if (status
) {
2683 dev_err(hub
->intfdev
,
2684 "cannot %sreset port %d (err = %d)\n",
2685 warm
? "warm " : "", port1
, status
);
2687 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2689 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2690 dev_dbg(hub
->intfdev
,
2691 "port_wait_reset: err = %d\n",
2695 /* Check for disconnect or reset */
2696 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2697 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2699 if (!hub_is_superspeed(hub
->hdev
))
2703 * If a USB 3.0 device migrates from reset to an error
2704 * state, re-issue the warm reset.
2706 if (hub_port_status(hub
, port1
,
2707 &portstatus
, &portchange
) < 0)
2710 if (!hub_port_warm_reset_required(hub
, portstatus
))
2714 * If the port is in SS.Inactive or Compliance Mode, the
2715 * hot or warm reset failed. Try another warm reset.
2718 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2724 dev_dbg (hub
->intfdev
,
2725 "port %d not enabled, trying %sreset again...\n",
2726 port1
, warm
? "warm " : "");
2727 delay
= HUB_LONG_RESET_TIME
;
2730 dev_err (hub
->intfdev
,
2731 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2735 if (!hub_is_superspeed(hub
->hdev
))
2736 up_read(&ehci_cf_port_reset_rwsem
);
2741 /* Check if a port is power on */
2742 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2746 if (hub_is_superspeed(hub
->hdev
)) {
2747 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2750 if (portstatus
& USB_PORT_STAT_POWER
)
2759 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2760 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2764 if (hub_is_superspeed(hub
->hdev
)) {
2765 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2766 == USB_SS_PORT_LS_U3
)
2769 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2776 /* Determine whether the device on a port is ready for a normal resume,
2777 * is ready for a reset-resume, or should be disconnected.
2779 static int check_port_resume_type(struct usb_device
*udev
,
2780 struct usb_hub
*hub
, int port1
,
2781 int status
, unsigned portchange
, unsigned portstatus
)
2783 /* Is the device still present? */
2784 if (status
|| port_is_suspended(hub
, portstatus
) ||
2785 !port_is_power_on(hub
, portstatus
) ||
2786 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2791 /* Can't do a normal resume if the port isn't enabled,
2792 * so try a reset-resume instead.
2794 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2795 if (udev
->persist_enabled
)
2796 udev
->reset_resume
= 1;
2802 dev_dbg(hub
->intfdev
,
2803 "port %d status %04x.%04x after resume, %d\n",
2804 port1
, portchange
, portstatus
, status
);
2805 } else if (udev
->reset_resume
) {
2807 /* Late port handoff can set status-change bits */
2808 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2809 usb_clear_port_feature(hub
->hdev
, port1
,
2810 USB_PORT_FEAT_C_CONNECTION
);
2811 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2812 usb_clear_port_feature(hub
->hdev
, port1
,
2813 USB_PORT_FEAT_C_ENABLE
);
2819 int usb_disable_ltm(struct usb_device
*udev
)
2821 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2823 /* Check if the roothub and device supports LTM. */
2824 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2825 !usb_device_supports_ltm(udev
))
2828 /* Clear Feature LTM Enable can only be sent if the device is
2831 if (!udev
->actconfig
)
2834 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2835 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2836 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2837 USB_CTRL_SET_TIMEOUT
);
2839 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2841 void usb_enable_ltm(struct usb_device
*udev
)
2843 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2845 /* Check if the roothub and device supports LTM. */
2846 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2847 !usb_device_supports_ltm(udev
))
2850 /* Set Feature LTM Enable can only be sent if the device is
2853 if (!udev
->actconfig
)
2856 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2857 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2858 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2859 USB_CTRL_SET_TIMEOUT
);
2861 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2865 * usb_disable_function_remotewakeup - disable usb3.0
2866 * device's function remote wakeup
2867 * @udev: target device
2869 * Assume there's only one function on the USB 3.0
2870 * device and disable remote wake for the first
2871 * interface. FIXME if the interface association
2872 * descriptor shows there's more than one function.
2874 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2876 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2877 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2878 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2879 USB_CTRL_SET_TIMEOUT
);
2882 /* Count of wakeup-enabled devices at or below udev */
2883 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2885 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2887 return udev
->do_remote_wakeup
+
2888 (hub
? hub
->wakeup_enabled_descendants
: 0);
2892 * usb_port_suspend - suspend a usb device's upstream port
2893 * @udev: device that's no longer in active use, not a root hub
2894 * Context: must be able to sleep; device not locked; pm locks held
2896 * Suspends a USB device that isn't in active use, conserving power.
2897 * Devices may wake out of a suspend, if anything important happens,
2898 * using the remote wakeup mechanism. They may also be taken out of
2899 * suspend by the host, using usb_port_resume(). It's also routine
2900 * to disconnect devices while they are suspended.
2902 * This only affects the USB hardware for a device; its interfaces
2903 * (and, for hubs, child devices) must already have been suspended.
2905 * Selective port suspend reduces power; most suspended devices draw
2906 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2907 * All devices below the suspended port are also suspended.
2909 * Devices leave suspend state when the host wakes them up. Some devices
2910 * also support "remote wakeup", where the device can activate the USB
2911 * tree above them to deliver data, such as a keypress or packet. In
2912 * some cases, this wakes the USB host.
2914 * Suspending OTG devices may trigger HNP, if that's been enabled
2915 * between a pair of dual-role devices. That will change roles, such
2916 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2918 * Devices on USB hub ports have only one "suspend" state, corresponding
2919 * to ACPI D2, "may cause the device to lose some context".
2920 * State transitions include:
2922 * - suspend, resume ... when the VBUS power link stays live
2923 * - suspend, disconnect ... VBUS lost
2925 * Once VBUS drop breaks the circuit, the port it's using has to go through
2926 * normal re-enumeration procedures, starting with enabling VBUS power.
2927 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2928 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2929 * timer, no SRP, no requests through sysfs.
2931 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2932 * suspended until their bus goes into global suspend (i.e., the root
2933 * hub is suspended). Nevertheless, we change @udev->state to
2934 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2935 * upstream port setting is stored in @udev->port_is_suspended.
2937 * Returns 0 on success, else negative errno.
2939 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2941 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2942 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2943 int port1
= udev
->portnum
;
2945 bool really_suspend
= true;
2947 /* enable remote wakeup when appropriate; this lets the device
2948 * wake up the upstream hub (including maybe the root hub).
2950 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2951 * we don't explicitly enable it here.
2953 if (udev
->do_remote_wakeup
) {
2954 if (!hub_is_superspeed(hub
->hdev
)) {
2955 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2956 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2957 USB_DEVICE_REMOTE_WAKEUP
, 0,
2959 USB_CTRL_SET_TIMEOUT
);
2961 /* Assume there's only one function on the USB 3.0
2962 * device and enable remote wake for the first
2963 * interface. FIXME if the interface association
2964 * descriptor shows there's more than one function.
2966 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2967 USB_REQ_SET_FEATURE
,
2968 USB_RECIP_INTERFACE
,
2969 USB_INTRF_FUNC_SUSPEND
,
2970 USB_INTRF_FUNC_SUSPEND_RW
|
2971 USB_INTRF_FUNC_SUSPEND_LP
,
2973 USB_CTRL_SET_TIMEOUT
);
2976 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2978 /* bail if autosuspend is requested */
2979 if (PMSG_IS_AUTO(msg
))
2984 /* disable USB2 hardware LPM */
2985 if (udev
->usb2_hw_lpm_enabled
== 1)
2986 usb_set_usb2_hardware_lpm(udev
, 0);
2988 if (usb_disable_ltm(udev
)) {
2989 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
2991 if (PMSG_IS_AUTO(msg
))
2994 if (usb_unlocked_disable_lpm(udev
)) {
2995 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
2997 if (PMSG_IS_AUTO(msg
))
3002 if (hub_is_superspeed(hub
->hdev
))
3003 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
3006 * For system suspend, we do not need to enable the suspend feature
3007 * on individual USB-2 ports. The devices will automatically go
3008 * into suspend a few ms after the root hub stops sending packets.
3009 * The USB 2.0 spec calls this "global suspend".
3011 * However, many USB hubs have a bug: They don't relay wakeup requests
3012 * from a downstream port if the port's suspend feature isn't on.
3013 * Therefore we will turn on the suspend feature if udev or any of its
3014 * descendants is enabled for remote wakeup.
3016 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3017 status
= set_port_feature(hub
->hdev
, port1
,
3018 USB_PORT_FEAT_SUSPEND
);
3020 really_suspend
= false;
3024 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3027 /* Try to enable USB3 LPM and LTM again */
3028 usb_unlocked_enable_lpm(udev
);
3030 usb_enable_ltm(udev
);
3032 /* Try to enable USB2 hardware LPM again */
3033 if (udev
->usb2_hw_lpm_capable
== 1)
3034 usb_set_usb2_hardware_lpm(udev
, 1);
3036 if (udev
->do_remote_wakeup
) {
3037 if (udev
->speed
< USB_SPEED_SUPER
)
3038 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3039 USB_REQ_CLEAR_FEATURE
,
3041 USB_DEVICE_REMOTE_WAKEUP
, 0,
3042 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3044 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3045 USB_REQ_CLEAR_FEATURE
,
3046 USB_RECIP_INTERFACE
,
3047 USB_INTRF_FUNC_SUSPEND
, 0,
3048 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3052 /* System sleep transitions should never fail */
3053 if (!PMSG_IS_AUTO(msg
))
3056 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3057 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3058 udev
->do_remote_wakeup
);
3059 if (really_suspend
) {
3060 udev
->port_is_suspended
= 1;
3062 /* device has up to 10 msec to fully suspend */
3065 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3068 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3069 pm_runtime_put_sync(&port_dev
->dev
);
3070 port_dev
->did_runtime_put
= true;
3073 usb_mark_last_busy(hub
->hdev
);
3078 * If the USB "suspend" state is in use (rather than "global suspend"),
3079 * many devices will be individually taken out of suspend state using
3080 * special "resume" signaling. This routine kicks in shortly after
3081 * hardware resume signaling is finished, either because of selective
3082 * resume (by host) or remote wakeup (by device) ... now see what changed
3083 * in the tree that's rooted at this device.
3085 * If @udev->reset_resume is set then the device is reset before the
3086 * status check is done.
3088 static int finish_port_resume(struct usb_device
*udev
)
3093 /* caller owns the udev device lock */
3094 dev_dbg(&udev
->dev
, "%s\n",
3095 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3097 /* usb ch9 identifies four variants of SUSPENDED, based on what
3098 * state the device resumes to. Linux currently won't see the
3099 * first two on the host side; they'd be inside hub_port_init()
3100 * during many timeouts, but khubd can't suspend until later.
3102 usb_set_device_state(udev
, udev
->actconfig
3103 ? USB_STATE_CONFIGURED
3104 : USB_STATE_ADDRESS
);
3106 /* 10.5.4.5 says not to reset a suspended port if the attached
3107 * device is enabled for remote wakeup. Hence the reset
3108 * operation is carried out here, after the port has been
3111 if (udev
->reset_resume
)
3113 status
= usb_reset_and_verify_device(udev
);
3115 /* 10.5.4.5 says be sure devices in the tree are still there.
3116 * For now let's assume the device didn't go crazy on resume,
3117 * and device drivers will know about any resume quirks.
3121 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3123 status
= (status
> 0 ? 0 : -ENODEV
);
3125 /* If a normal resume failed, try doing a reset-resume */
3126 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3127 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3128 udev
->reset_resume
= 1;
3129 goto retry_reset_resume
;
3134 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3137 * There are a few quirky devices which violate the standard
3138 * by claiming to have remote wakeup enabled after a reset,
3139 * which crash if the feature is cleared, hence check for
3140 * udev->reset_resume
3142 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3143 if (!hub_is_superspeed(udev
->parent
)) {
3144 le16_to_cpus(&devstatus
);
3145 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3146 status
= usb_control_msg(udev
,
3147 usb_sndctrlpipe(udev
, 0),
3148 USB_REQ_CLEAR_FEATURE
,
3150 USB_DEVICE_REMOTE_WAKEUP
, 0,
3152 USB_CTRL_SET_TIMEOUT
);
3154 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3156 le16_to_cpus(&devstatus
);
3157 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3158 | USB_INTRF_STAT_FUNC_RW
))
3160 usb_disable_function_remotewakeup(udev
);
3165 "disable remote wakeup, status %d\n",
3173 * There are some SS USB devices which take longer time for link training.
3174 * XHCI specs 4.19.4 says that when Link training is successful, port
3175 * sets CSC bit to 1. So if SW reads port status before successful link
3176 * training, then it will not find device to be present.
3177 * USB Analyzer log with such buggy devices show that in some cases
3178 * device switch on the RX termination after long delay of host enabling
3179 * the VBUS. In few other cases it has been seen that device fails to
3180 * negotiate link training in first attempt. It has been
3181 * reported till now that few devices take as long as 2000 ms to train
3182 * the link after host enabling its VBUS and termination. Following
3183 * routine implements a 2000 ms timeout for link training. If in a case
3184 * link trains before timeout, loop will exit earlier.
3186 * FIXME: If a device was connected before suspend, but was removed
3187 * while system was asleep, then the loop in the following routine will
3188 * only exit at timeout.
3190 * This routine should only be called when persist is enabled for a SS
3193 static int wait_for_ss_port_enable(struct usb_device
*udev
,
3194 struct usb_hub
*hub
, int *port1
,
3195 u16
*portchange
, u16
*portstatus
)
3197 int status
= 0, delay_ms
= 0;
3199 while (delay_ms
< 2000) {
3200 if (status
|| *portstatus
& USB_PORT_STAT_CONNECTION
)
3204 status
= hub_port_status(hub
, *port1
, portstatus
, portchange
);
3210 * usb_port_resume - re-activate a suspended usb device's upstream port
3211 * @udev: device to re-activate, not a root hub
3212 * Context: must be able to sleep; device not locked; pm locks held
3214 * This will re-activate the suspended device, increasing power usage
3215 * while letting drivers communicate again with its endpoints.
3216 * USB resume explicitly guarantees that the power session between
3217 * the host and the device is the same as it was when the device
3220 * If @udev->reset_resume is set then this routine won't check that the
3221 * port is still enabled. Furthermore, finish_port_resume() above will
3222 * reset @udev. The end result is that a broken power session can be
3223 * recovered and @udev will appear to persist across a loss of VBUS power.
3225 * For example, if a host controller doesn't maintain VBUS suspend current
3226 * during a system sleep or is reset when the system wakes up, all the USB
3227 * power sessions below it will be broken. This is especially troublesome
3228 * for mass-storage devices containing mounted filesystems, since the
3229 * device will appear to have disconnected and all the memory mappings
3230 * to it will be lost. Using the USB_PERSIST facility, the device can be
3231 * made to appear as if it had not disconnected.
3233 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3234 * every effort to insure that the same device is present after the
3235 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3236 * quite possible for a device to remain unaltered but its media to be
3237 * changed. If the user replaces a flash memory card while the system is
3238 * asleep, he will have only himself to blame when the filesystem on the
3239 * new card is corrupted and the system crashes.
3241 * Returns 0 on success, else negative errno.
3243 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3245 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3246 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3247 int port1
= udev
->portnum
;
3249 u16 portchange
, portstatus
;
3251 if (port_dev
->did_runtime_put
) {
3252 status
= pm_runtime_get_sync(&port_dev
->dev
);
3253 port_dev
->did_runtime_put
= false;
3255 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3261 /* Skip the initial Clear-Suspend step for a remote wakeup */
3262 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3263 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3264 goto SuspendCleared
;
3266 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3268 set_bit(port1
, hub
->busy_bits
);
3270 /* see 7.1.7.7; affects power usage, but not budgeting */
3271 if (hub_is_superspeed(hub
->hdev
))
3272 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3274 status
= usb_clear_port_feature(hub
->hdev
,
3275 port1
, USB_PORT_FEAT_SUSPEND
);
3277 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3280 /* drive resume for at least 20 msec */
3281 dev_dbg(&udev
->dev
, "usb %sresume\n",
3282 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3285 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3286 * stop resume signaling. Then finish the resume
3289 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3291 /* TRSMRCY = 10 msec */
3297 udev
->port_is_suspended
= 0;
3298 if (hub_is_superspeed(hub
->hdev
)) {
3299 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3300 usb_clear_port_feature(hub
->hdev
, port1
,
3301 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3303 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3304 usb_clear_port_feature(hub
->hdev
, port1
,
3305 USB_PORT_FEAT_C_SUSPEND
);
3309 clear_bit(port1
, hub
->busy_bits
);
3311 if (udev
->persist_enabled
&& hub_is_superspeed(hub
->hdev
))
3312 status
= wait_for_ss_port_enable(udev
, hub
, &port1
, &portchange
,
3315 status
= check_port_resume_type(udev
,
3316 hub
, port1
, status
, portchange
, portstatus
);
3318 status
= finish_port_resume(udev
);
3320 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3321 hub_port_logical_disconnect(hub
, port1
);
3323 /* Try to enable USB2 hardware LPM */
3324 if (udev
->usb2_hw_lpm_capable
== 1)
3325 usb_set_usb2_hardware_lpm(udev
, 1);
3327 /* Try to enable USB3 LTM and LPM */
3328 usb_enable_ltm(udev
);
3329 usb_unlocked_enable_lpm(udev
);
3335 #endif /* CONFIG_PM */
3337 #ifdef CONFIG_PM_RUNTIME
3339 /* caller has locked udev */
3340 int usb_remote_wakeup(struct usb_device
*udev
)
3344 if (udev
->state
== USB_STATE_SUSPENDED
) {
3345 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3346 status
= usb_autoresume_device(udev
);
3348 /* Let the drivers do their thing, then... */
3349 usb_autosuspend_device(udev
);
3357 static int check_ports_changed(struct usb_hub
*hub
)
3361 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3362 u16 portstatus
, portchange
;
3365 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3366 if (!status
&& portchange
)
3372 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3374 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3375 struct usb_device
*hdev
= hub
->hdev
;
3380 * Warn if children aren't already suspended.
3381 * Also, add up the number of wakeup-enabled descendants.
3383 hub
->wakeup_enabled_descendants
= 0;
3384 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3385 struct usb_device
*udev
;
3387 udev
= hub
->ports
[port1
- 1]->child
;
3388 if (udev
&& udev
->can_submit
) {
3389 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3390 if (PMSG_IS_AUTO(msg
))
3394 hub
->wakeup_enabled_descendants
+=
3395 wakeup_enabled_descendants(udev
);
3398 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3399 /* check if there are changes pending on hub ports */
3400 if (check_ports_changed(hub
)) {
3401 if (PMSG_IS_AUTO(msg
))
3403 pm_wakeup_event(&hdev
->dev
, 2000);
3407 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3408 /* Enable hub to send remote wakeup for all ports. */
3409 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3410 status
= set_port_feature(hdev
,
3412 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3413 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3414 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3415 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3419 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3421 /* stop khubd and related activity */
3422 hub_quiesce(hub
, HUB_SUSPEND
);
3426 static int hub_resume(struct usb_interface
*intf
)
3428 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3430 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3431 hub_activate(hub
, HUB_RESUME
);
3435 static int hub_reset_resume(struct usb_interface
*intf
)
3437 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3439 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3440 hub_activate(hub
, HUB_RESET_RESUME
);
3445 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3446 * @rhdev: struct usb_device for the root hub
3448 * The USB host controller driver calls this function when its root hub
3449 * is resumed and Vbus power has been interrupted or the controller
3450 * has been reset. The routine marks @rhdev as having lost power.
3451 * When the hub driver is resumed it will take notice and carry out
3452 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3453 * the others will be disconnected.
3455 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3457 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3458 rhdev
->reset_resume
= 1;
3460 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3462 static const char * const usb3_lpm_names
[] = {
3470 * Send a Set SEL control transfer to the device, prior to enabling
3471 * device-initiated U1 or U2. This lets the device know the exit latencies from
3472 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3473 * packet from the host.
3475 * This function will fail if the SEL or PEL values for udev are greater than
3476 * the maximum allowed values for the link state to be enabled.
3478 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3480 struct usb_set_sel_req
*sel_values
;
3481 unsigned long long u1_sel
;
3482 unsigned long long u1_pel
;
3483 unsigned long long u2_sel
;
3484 unsigned long long u2_pel
;
3487 /* Convert SEL and PEL stored in ns to us */
3488 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3489 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3490 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3491 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3494 * Make sure that the calculated SEL and PEL values for the link
3495 * state we're enabling aren't bigger than the max SEL/PEL
3496 * value that will fit in the SET SEL control transfer.
3497 * Otherwise the device would get an incorrect idea of the exit
3498 * latency for the link state, and could start a device-initiated
3499 * U1/U2 when the exit latencies are too high.
3501 if ((state
== USB3_LPM_U1
&&
3502 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3503 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3504 (state
== USB3_LPM_U2
&&
3505 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3506 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3507 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3508 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3513 * If we're enabling device-initiated LPM for one link state,
3514 * but the other link state has a too high SEL or PEL value,
3515 * just set those values to the max in the Set SEL request.
3517 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3518 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3520 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3521 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3523 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3524 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3526 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3527 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3530 * usb_enable_lpm() can be called as part of a failed device reset,
3531 * which may be initiated by an error path of a mass storage driver.
3532 * Therefore, use GFP_NOIO.
3534 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3538 sel_values
->u1_sel
= u1_sel
;
3539 sel_values
->u1_pel
= u1_pel
;
3540 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3541 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3543 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3547 sel_values
, sizeof *(sel_values
),
3548 USB_CTRL_SET_TIMEOUT
);
3554 * Enable or disable device-initiated U1 or U2 transitions.
3556 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3557 enum usb3_link_state state
, bool enable
)
3564 feature
= USB_DEVICE_U1_ENABLE
;
3567 feature
= USB_DEVICE_U2_ENABLE
;
3570 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3571 __func__
, enable
? "enable" : "disable");
3575 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3576 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3577 "for unconfigured device.\n",
3578 __func__
, enable
? "enable" : "disable",
3579 usb3_lpm_names
[state
]);
3585 * Now send the control transfer to enable device-initiated LPM
3586 * for either U1 or U2.
3588 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3589 USB_REQ_SET_FEATURE
,
3593 USB_CTRL_SET_TIMEOUT
);
3595 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3596 USB_REQ_CLEAR_FEATURE
,
3600 USB_CTRL_SET_TIMEOUT
);
3603 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3604 enable
? "Enable" : "Disable",
3605 usb3_lpm_names
[state
]);
3611 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3612 enum usb3_link_state state
, int timeout
)
3619 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3622 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3625 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3630 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3631 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3632 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3633 "which is a reserved value.\n",
3634 usb3_lpm_names
[state
], timeout
);
3638 ret
= set_port_feature(udev
->parent
,
3639 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3642 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3643 "error code %i\n", usb3_lpm_names
[state
],
3647 if (state
== USB3_LPM_U1
)
3648 udev
->u1_params
.timeout
= timeout
;
3650 udev
->u2_params
.timeout
= timeout
;
3655 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3658 * We will attempt to enable U1 or U2, but there are no guarantees that the
3659 * control transfers to set the hub timeout or enable device-initiated U1/U2
3660 * will be successful.
3662 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3663 * driver know about it. If that call fails, it should be harmless, and just
3664 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3666 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3667 enum usb3_link_state state
)
3670 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3671 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3673 /* If the device says it doesn't have *any* exit latency to come out of
3674 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3677 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3678 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3682 * First, let the device know about the exit latencies
3683 * associated with the link state we're about to enable.
3685 ret
= usb_req_set_sel(udev
, state
);
3687 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3688 usb3_lpm_names
[state
]);
3692 /* We allow the host controller to set the U1/U2 timeout internally
3693 * first, so that it can change its schedule to account for the
3694 * additional latency to send data to a device in a lower power
3697 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3699 /* xHCI host controller doesn't want to enable this LPM state. */
3704 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3705 "xHCI error %i.\n", usb3_lpm_names
[state
],
3710 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3711 /* If we can't set the parent hub U1/U2 timeout,
3712 * device-initiated LPM won't be allowed either, so let the xHCI
3713 * host know that this link state won't be enabled.
3715 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3717 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3718 else if (udev
->actconfig
)
3719 usb_set_device_initiated_lpm(udev
, state
, true);
3724 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3727 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3728 * If zero is returned, the parent will not allow the link to go into U1/U2.
3730 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3731 * it won't have an effect on the bus link state because the parent hub will
3732 * still disallow device-initiated U1/U2 entry.
3734 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3735 * possible. The result will be slightly more bus bandwidth will be taken up
3736 * (to account for U1/U2 exit latency), but it should be harmless.
3738 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3739 enum usb3_link_state state
)
3745 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3748 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3751 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3756 if (usb_set_lpm_timeout(udev
, state
, 0))
3759 usb_set_device_initiated_lpm(udev
, state
, false);
3761 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3762 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3763 "bus schedule bandwidth may be impacted.\n",
3764 usb3_lpm_names
[state
]);
3769 * Disable hub-initiated and device-initiated U1 and U2 entry.
3770 * Caller must own the bandwidth_mutex.
3772 * This will call usb_enable_lpm() on failure, which will decrement
3773 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3775 int usb_disable_lpm(struct usb_device
*udev
)
3777 struct usb_hcd
*hcd
;
3779 if (!udev
|| !udev
->parent
||
3780 udev
->speed
!= USB_SPEED_SUPER
||
3784 hcd
= bus_to_hcd(udev
->bus
);
3785 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3788 udev
->lpm_disable_count
++;
3789 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3792 /* If LPM is enabled, attempt to disable it. */
3793 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3795 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3801 usb_enable_lpm(udev
);
3804 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3806 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3807 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3809 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3815 mutex_lock(hcd
->bandwidth_mutex
);
3816 ret
= usb_disable_lpm(udev
);
3817 mutex_unlock(hcd
->bandwidth_mutex
);
3821 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3824 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3825 * xHCI host policy may prevent U1 or U2 from being enabled.
3827 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3828 * until the lpm_disable_count drops to zero. Caller must own the
3831 void usb_enable_lpm(struct usb_device
*udev
)
3833 struct usb_hcd
*hcd
;
3835 if (!udev
|| !udev
->parent
||
3836 udev
->speed
!= USB_SPEED_SUPER
||
3840 udev
->lpm_disable_count
--;
3841 hcd
= bus_to_hcd(udev
->bus
);
3842 /* Double check that we can both enable and disable LPM.
3843 * Device must be configured to accept set feature U1/U2 timeout.
3845 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3846 !hcd
->driver
->disable_usb3_lpm_timeout
)
3849 if (udev
->lpm_disable_count
> 0)
3852 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3853 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3855 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3857 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3858 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3860 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3865 mutex_lock(hcd
->bandwidth_mutex
);
3866 usb_enable_lpm(udev
);
3867 mutex_unlock(hcd
->bandwidth_mutex
);
3869 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3872 #else /* CONFIG_PM */
3874 #define hub_suspend NULL
3875 #define hub_resume NULL
3876 #define hub_reset_resume NULL
3878 int usb_disable_lpm(struct usb_device
*udev
)
3882 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3884 void usb_enable_lpm(struct usb_device
*udev
) { }
3885 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3887 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3891 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3893 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3894 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3896 int usb_disable_ltm(struct usb_device
*udev
)
3900 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3902 void usb_enable_ltm(struct usb_device
*udev
) { }
3903 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3907 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3909 * Between connect detection and reset signaling there must be a delay
3910 * of 100ms at least for debounce and power-settling. The corresponding
3911 * timer shall restart whenever the downstream port detects a disconnect.
3913 * Apparently there are some bluetooth and irda-dongles and a number of
3914 * low-speed devices for which this debounce period may last over a second.
3915 * Not covered by the spec - but easy to deal with.
3917 * This implementation uses a 1500ms total debounce timeout; if the
3918 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3919 * every 25ms for transient disconnects. When the port status has been
3920 * unchanged for 100ms it returns the port status.
3922 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3925 int total_time
, stable_time
= 0;
3926 u16 portchange
, portstatus
;
3927 unsigned connection
= 0xffff;
3929 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3930 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3934 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3935 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3936 if (!must_be_connected
||
3937 (connection
== USB_PORT_STAT_CONNECTION
))
3938 stable_time
+= HUB_DEBOUNCE_STEP
;
3939 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3943 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3946 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3947 usb_clear_port_feature(hub
->hdev
, port1
,
3948 USB_PORT_FEAT_C_CONNECTION
);
3951 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3953 msleep(HUB_DEBOUNCE_STEP
);
3956 dev_dbg (hub
->intfdev
,
3957 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3958 port1
, total_time
, stable_time
, portstatus
);
3960 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3965 void usb_ep0_reinit(struct usb_device
*udev
)
3967 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3968 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3969 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3971 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3973 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3974 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3976 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3979 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3982 * The host controller will choose the device address,
3983 * instead of the core having chosen it earlier
3985 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3987 if (udev
->state
== USB_STATE_ADDRESS
)
3989 if (udev
->state
!= USB_STATE_DEFAULT
)
3991 if (hcd
->driver
->address_device
)
3992 retval
= hcd
->driver
->address_device(hcd
, udev
);
3994 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3995 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3996 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3998 update_devnum(udev
, devnum
);
3999 /* Device now using proper address. */
4000 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
4001 usb_ep0_reinit(udev
);
4006 /* Reset device, (re)assign address, get device descriptor.
4007 * Device connection must be stable, no more debouncing needed.
4008 * Returns device in USB_STATE_ADDRESS, except on error.
4010 * If this is called for an already-existing device (as part of
4011 * usb_reset_and_verify_device), the caller must own the device lock. For a
4012 * newly detected device that is not accessible through any global
4013 * pointers, it's not necessary to lock the device.
4016 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
4019 static DEFINE_MUTEX(usb_address0_mutex
);
4021 struct usb_device
*hdev
= hub
->hdev
;
4022 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4024 unsigned delay
= HUB_SHORT_RESET_TIME
;
4025 enum usb_device_speed oldspeed
= udev
->speed
;
4027 int devnum
= udev
->devnum
;
4029 /* root hub ports have a slightly longer reset period
4030 * (from USB 2.0 spec, section 7.1.7.5)
4032 if (!hdev
->parent
) {
4033 delay
= HUB_ROOT_RESET_TIME
;
4034 if (port1
== hdev
->bus
->otg_port
)
4035 hdev
->bus
->b_hnp_enable
= 0;
4038 /* Some low speed devices have problems with the quick delay, so */
4039 /* be a bit pessimistic with those devices. RHbug #23670 */
4040 if (oldspeed
== USB_SPEED_LOW
)
4041 delay
= HUB_LONG_RESET_TIME
;
4043 mutex_lock(&usb_address0_mutex
);
4045 /* Reset the device; full speed may morph to high speed */
4046 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4047 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4048 if (retval
< 0) /* error or disconnect */
4050 /* success, speed is known */
4054 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4055 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4058 oldspeed
= udev
->speed
;
4060 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4061 * it's fixed size except for full speed devices.
4062 * For Wireless USB devices, ep0 max packet is always 512 (tho
4063 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4065 switch (udev
->speed
) {
4066 case USB_SPEED_SUPER
:
4067 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4068 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4070 case USB_SPEED_HIGH
: /* fixed at 64 */
4071 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4073 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4074 /* to determine the ep0 maxpacket size, try to read
4075 * the device descriptor to get bMaxPacketSize0 and
4076 * then correct our initial guess.
4078 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4080 case USB_SPEED_LOW
: /* fixed at 8 */
4081 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4087 if (udev
->speed
== USB_SPEED_WIRELESS
)
4088 speed
= "variable speed Wireless";
4090 speed
= usb_speed_string(udev
->speed
);
4092 if (udev
->speed
!= USB_SPEED_SUPER
)
4093 dev_info(&udev
->dev
,
4094 "%s %s USB device number %d using %s\n",
4095 (udev
->config
) ? "reset" : "new", speed
,
4096 devnum
, udev
->bus
->controller
->driver
->name
);
4098 /* Set up TT records, if needed */
4100 udev
->tt
= hdev
->tt
;
4101 udev
->ttport
= hdev
->ttport
;
4102 } else if (udev
->speed
!= USB_SPEED_HIGH
4103 && hdev
->speed
== USB_SPEED_HIGH
) {
4105 dev_err(&udev
->dev
, "parent hub has no TT\n");
4109 udev
->tt
= &hub
->tt
;
4110 udev
->ttport
= port1
;
4113 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4114 * Because device hardware and firmware is sometimes buggy in
4115 * this area, and this is how Linux has done it for ages.
4116 * Change it cautiously.
4118 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4119 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4120 * so it may help with some non-standards-compliant devices.
4121 * Otherwise we start with SET_ADDRESS and then try to read the
4122 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4125 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4126 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4127 struct usb_device_descriptor
*buf
;
4130 #define GET_DESCRIPTOR_BUFSIZE 64
4131 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4137 /* Retry on all errors; some devices are flakey.
4138 * 255 is for WUSB devices, we actually need to use
4139 * 512 (WUSB1.0[4.8.1]).
4141 for (j
= 0; j
< 3; ++j
) {
4142 buf
->bMaxPacketSize0
= 0;
4143 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4144 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4145 USB_DT_DEVICE
<< 8, 0,
4146 buf
, GET_DESCRIPTOR_BUFSIZE
,
4147 initial_descriptor_timeout
);
4148 switch (buf
->bMaxPacketSize0
) {
4149 case 8: case 16: case 32: case 64: case 255:
4150 if (buf
->bDescriptorType
==
4164 udev
->descriptor
.bMaxPacketSize0
=
4165 buf
->bMaxPacketSize0
;
4168 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4169 if (retval
< 0) /* error or disconnect */
4171 if (oldspeed
!= udev
->speed
) {
4173 "device reset changed speed!\n");
4179 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4184 #undef GET_DESCRIPTOR_BUFSIZE
4188 * If device is WUSB, we already assigned an
4189 * unauthorized address in the Connect Ack sequence;
4190 * authorization will assign the final address.
4192 if (udev
->wusb
== 0) {
4193 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4194 retval
= hub_set_address(udev
, devnum
);
4200 if (retval
!= -ENODEV
)
4201 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4205 if (udev
->speed
== USB_SPEED_SUPER
) {
4206 devnum
= udev
->devnum
;
4207 dev_info(&udev
->dev
,
4208 "%s SuperSpeed USB device number %d using %s\n",
4209 (udev
->config
) ? "reset" : "new",
4210 devnum
, udev
->bus
->controller
->driver
->name
);
4213 /* cope with hardware quirkiness:
4214 * - let SET_ADDRESS settle, some device hardware wants it
4215 * - read ep0 maxpacket even for high and low speed,
4218 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4222 retval
= usb_get_device_descriptor(udev
, 8);
4224 if (retval
!= -ENODEV
)
4226 "device descriptor read/8, error %d\n",
4238 if (hcd
->phy
&& !hdev
->parent
)
4239 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4242 * Some superspeed devices have finished the link training process
4243 * and attached to a superspeed hub port, but the device descriptor
4244 * got from those devices show they aren't superspeed devices. Warm
4245 * reset the port attached by the devices can fix them.
4247 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4248 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4249 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4250 "warm reset device\n");
4251 hub_port_reset(hub
, port1
, udev
,
4252 HUB_BH_RESET_TIME
, true);
4257 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4258 udev
->speed
== USB_SPEED_SUPER
)
4261 i
= udev
->descriptor
.bMaxPacketSize0
;
4262 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4263 if (udev
->speed
== USB_SPEED_LOW
||
4264 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4265 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4269 if (udev
->speed
== USB_SPEED_FULL
)
4270 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4272 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4273 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4274 usb_ep0_reinit(udev
);
4277 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4278 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4279 if (retval
!= -ENODEV
)
4280 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4287 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4288 retval
= usb_get_bos_descriptor(udev
);
4290 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4291 usb_set_lpm_parameters(udev
);
4296 /* notify HCD that we have a device connected and addressed */
4297 if (hcd
->driver
->update_device
)
4298 hcd
->driver
->update_device(hcd
, udev
);
4301 hub_port_disable(hub
, port1
, 0);
4302 update_devnum(udev
, devnum
); /* for disconnect processing */
4304 mutex_unlock(&usb_address0_mutex
);
4309 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4311 struct usb_qualifier_descriptor
*qual
;
4314 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4318 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4319 qual
, sizeof *qual
);
4320 if (status
== sizeof *qual
) {
4321 dev_info(&udev
->dev
, "not running at top speed; "
4322 "connect to a high speed hub\n");
4323 /* hub LEDs are probably harder to miss than syslog */
4324 if (hub
->has_indicators
) {
4325 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4326 schedule_delayed_work (&hub
->leds
, 0);
4333 hub_power_remaining (struct usb_hub
*hub
)
4335 struct usb_device
*hdev
= hub
->hdev
;
4339 if (!hub
->limited_power
)
4342 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4343 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4344 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4350 if (hub_is_superspeed(udev
))
4356 * Unconfigured devices may not use more than one unit load,
4357 * or 8mA for OTG ports
4359 if (udev
->actconfig
)
4360 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4361 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4365 if (delta
> hub
->mA_per_port
)
4366 dev_warn(&udev
->dev
,
4367 "%dmA is over %umA budget for port %d!\n",
4368 delta
, hub
->mA_per_port
, port1
);
4371 if (remaining
< 0) {
4372 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4379 /* Handle physical or logical connection change events.
4380 * This routine is called when:
4381 * a port connection-change occurs;
4382 * a port enable-change occurs (often caused by EMI);
4383 * usb_reset_and_verify_device() encounters changed descriptors (as from
4384 * a firmware download)
4385 * caller already locked the hub
4387 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4388 u16 portstatus
, u16 portchange
)
4390 struct usb_device
*hdev
= hub
->hdev
;
4391 struct device
*hub_dev
= hub
->intfdev
;
4392 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4393 unsigned wHubCharacteristics
=
4394 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4395 struct usb_device
*udev
;
4400 "port %d, status %04x, change %04x, %s\n",
4401 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4403 if (hub
->has_indicators
) {
4404 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4405 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4408 #ifdef CONFIG_USB_OTG
4409 /* during HNP, don't repeat the debounce */
4410 if (hdev
->bus
->is_b_host
)
4411 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4412 USB_PORT_STAT_C_ENABLE
);
4415 /* Try to resuscitate an existing device */
4416 udev
= hub
->ports
[port1
- 1]->child
;
4417 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4418 udev
->state
!= USB_STATE_NOTATTACHED
) {
4419 usb_lock_device(udev
);
4420 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4421 status
= 0; /* Nothing to do */
4423 #ifdef CONFIG_PM_RUNTIME
4424 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4425 udev
->persist_enabled
) {
4426 /* For a suspended device, treat this as a
4427 * remote wakeup event.
4429 status
= usb_remote_wakeup(udev
);
4433 status
= -ENODEV
; /* Don't resuscitate */
4435 usb_unlock_device(udev
);
4438 clear_bit(port1
, hub
->change_bits
);
4443 /* Disconnect any existing devices under this port */
4445 if (hcd
->phy
&& !hdev
->parent
&&
4446 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4447 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4448 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4450 clear_bit(port1
, hub
->change_bits
);
4452 /* We can forget about a "removed" device when there's a physical
4453 * disconnect or the connect status changes.
4455 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4456 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4457 clear_bit(port1
, hub
->removed_bits
);
4459 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4460 USB_PORT_STAT_C_ENABLE
)) {
4461 status
= hub_port_debounce_be_stable(hub
, port1
);
4463 if (status
!= -ENODEV
&& printk_ratelimit())
4464 dev_err(hub_dev
, "connect-debounce failed, "
4465 "port %d disabled\n", port1
);
4466 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4468 portstatus
= status
;
4472 /* Return now if debouncing failed or nothing is connected or
4473 * the device was "removed".
4475 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4476 test_bit(port1
, hub
->removed_bits
)) {
4478 /* maybe switch power back on (e.g. root hub was reset) */
4479 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4480 && !port_is_power_on(hub
, portstatus
))
4481 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4483 if (portstatus
& USB_PORT_STAT_ENABLE
)
4487 if (hub_is_superspeed(hub
->hdev
))
4493 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4495 /* reallocate for each attempt, since references
4496 * to the previous one can escape in various ways
4498 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4501 "couldn't allocate port %d usb_device\n",
4506 usb_set_device_state(udev
, USB_STATE_POWERED
);
4507 udev
->bus_mA
= hub
->mA_per_port
;
4508 udev
->level
= hdev
->level
+ 1;
4509 udev
->wusb
= hub_is_wusb(hub
);
4511 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4512 if (hub_is_superspeed(hub
->hdev
))
4513 udev
->speed
= USB_SPEED_SUPER
;
4515 udev
->speed
= USB_SPEED_UNKNOWN
;
4517 choose_devnum(udev
);
4518 if (udev
->devnum
<= 0) {
4519 status
= -ENOTCONN
; /* Don't retry */
4523 /* reset (non-USB 3.0 devices) and get descriptor */
4524 status
= hub_port_init(hub
, udev
, port1
, i
);
4528 usb_detect_quirks(udev
);
4529 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4532 /* consecutive bus-powered hubs aren't reliable; they can
4533 * violate the voltage drop budget. if the new child has
4534 * a "powered" LED, users should notice we didn't enable it
4535 * (without reading syslog), even without per-port LEDs
4538 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4539 && udev
->bus_mA
<= unit_load
) {
4542 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4545 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4548 le16_to_cpus(&devstat
);
4549 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4551 "can't connect bus-powered hub "
4553 if (hub
->has_indicators
) {
4554 hub
->indicator
[port1
-1] =
4555 INDICATOR_AMBER_BLINK
;
4556 schedule_delayed_work (&hub
->leds
, 0);
4558 status
= -ENOTCONN
; /* Don't retry */
4563 /* check for devices running slower than they could */
4564 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4565 && udev
->speed
== USB_SPEED_FULL
4566 && highspeed_hubs
!= 0)
4567 check_highspeed (hub
, udev
, port1
);
4569 /* Store the parent's children[] pointer. At this point
4570 * udev becomes globally accessible, although presumably
4571 * no one will look at it until hdev is unlocked.
4575 /* We mustn't add new devices if the parent hub has
4576 * been disconnected; we would race with the
4577 * recursively_mark_NOTATTACHED() routine.
4579 spin_lock_irq(&device_state_lock
);
4580 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4583 hub
->ports
[port1
- 1]->child
= udev
;
4584 spin_unlock_irq(&device_state_lock
);
4586 /* Run it through the hoops (find a driver, etc) */
4588 status
= usb_new_device(udev
);
4590 spin_lock_irq(&device_state_lock
);
4591 hub
->ports
[port1
- 1]->child
= NULL
;
4592 spin_unlock_irq(&device_state_lock
);
4599 status
= hub_power_remaining(hub
);
4601 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4606 hub_port_disable(hub
, port1
, 1);
4608 usb_ep0_reinit(udev
);
4609 release_devnum(udev
);
4612 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4615 if (hub
->hdev
->parent
||
4616 !hcd
->driver
->port_handed_over
||
4617 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4618 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4619 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4624 hub_port_disable(hub
, port1
, 1);
4625 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4626 hcd
->driver
->relinquish_port(hcd
, port1
);
4629 /* Returns 1 if there was a remote wakeup and a connect status change. */
4630 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4631 u16 portstatus
, u16 portchange
)
4633 struct usb_device
*hdev
;
4634 struct usb_device
*udev
;
4635 int connect_change
= 0;
4639 udev
= hub
->ports
[port
- 1]->child
;
4640 if (!hub_is_superspeed(hdev
)) {
4641 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4643 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4645 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4646 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4652 /* TRSMRCY = 10 msec */
4655 usb_lock_device(udev
);
4656 ret
= usb_remote_wakeup(udev
);
4657 usb_unlock_device(udev
);
4662 hub_port_disable(hub
, port
, 1);
4664 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4666 return connect_change
;
4669 static void hub_events(void)
4671 struct list_head
*tmp
;
4672 struct usb_device
*hdev
;
4673 struct usb_interface
*intf
;
4674 struct usb_hub
*hub
;
4675 struct device
*hub_dev
;
4681 int connect_change
, wakeup_change
;
4684 * We restart the list every time to avoid a deadlock with
4685 * deleting hubs downstream from this one. This should be
4686 * safe since we delete the hub from the event list.
4687 * Not the most efficient, but avoids deadlocks.
4691 /* Grab the first entry at the beginning of the list */
4692 spin_lock_irq(&hub_event_lock
);
4693 if (list_empty(&hub_event_list
)) {
4694 spin_unlock_irq(&hub_event_lock
);
4698 tmp
= hub_event_list
.next
;
4701 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4702 kref_get(&hub
->kref
);
4703 spin_unlock_irq(&hub_event_lock
);
4706 hub_dev
= hub
->intfdev
;
4707 intf
= to_usb_interface(hub_dev
);
4708 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4709 hdev
->state
, hub
->descriptor
4710 ? hub
->descriptor
->bNbrPorts
4712 /* NOTE: expects max 15 ports... */
4713 (u16
) hub
->change_bits
[0],
4714 (u16
) hub
->event_bits
[0]);
4716 /* Lock the device, then check to see if we were
4717 * disconnected while waiting for the lock to succeed. */
4718 usb_lock_device(hdev
);
4719 if (unlikely(hub
->disconnected
))
4720 goto loop_disconnected
;
4722 /* If the hub has died, clean up after it */
4723 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4724 hub
->error
= -ENODEV
;
4725 hub_quiesce(hub
, HUB_DISCONNECT
);
4730 ret
= usb_autopm_get_interface(intf
);
4732 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4736 /* If this is an inactive hub, do nothing */
4741 dev_dbg (hub_dev
, "resetting for error %d\n",
4744 ret
= usb_reset_device(hdev
);
4747 "error resetting hub: %d\n", ret
);
4755 /* deal with port status changes */
4756 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4757 if (test_bit(i
, hub
->busy_bits
))
4759 connect_change
= test_bit(i
, hub
->change_bits
);
4760 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4761 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4762 !connect_change
&& !wakeup_change
)
4765 ret
= hub_port_status(hub
, i
,
4766 &portstatus
, &portchange
);
4770 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4771 usb_clear_port_feature(hdev
, i
,
4772 USB_PORT_FEAT_C_CONNECTION
);
4776 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4777 if (!connect_change
)
4779 "port %d enable change, "
4782 usb_clear_port_feature(hdev
, i
,
4783 USB_PORT_FEAT_C_ENABLE
);
4786 * EM interference sometimes causes badly
4787 * shielded USB devices to be shutdown by
4788 * the hub, this hack enables them again.
4789 * Works at least with mouse driver.
4791 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4793 && hub
->ports
[i
- 1]->child
) {
4796 "disabled by hub (EMI?), "
4803 if (hub_handle_remote_wakeup(hub
, i
,
4804 portstatus
, portchange
))
4807 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4811 dev_dbg(hub_dev
, "over-current change on port "
4813 usb_clear_port_feature(hdev
, i
,
4814 USB_PORT_FEAT_C_OVER_CURRENT
);
4815 msleep(100); /* Cool down */
4816 hub_power_on(hub
, true);
4817 hub_port_status(hub
, i
, &status
, &unused
);
4818 if (status
& USB_PORT_STAT_OVERCURRENT
)
4819 dev_err(hub_dev
, "over-current "
4820 "condition on port %d\n", i
);
4823 if (portchange
& USB_PORT_STAT_C_RESET
) {
4825 "reset change on port %d\n",
4827 usb_clear_port_feature(hdev
, i
,
4828 USB_PORT_FEAT_C_RESET
);
4830 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4831 hub_is_superspeed(hub
->hdev
)) {
4833 "warm reset change on port %d\n",
4835 usb_clear_port_feature(hdev
, i
,
4836 USB_PORT_FEAT_C_BH_PORT_RESET
);
4838 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4839 usb_clear_port_feature(hub
->hdev
, i
,
4840 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4842 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4844 "config error on port %d\n",
4846 usb_clear_port_feature(hub
->hdev
, i
,
4847 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4850 /* Warm reset a USB3 protocol port if it's in
4851 * SS.Inactive state.
4853 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4855 struct usb_device
*udev
=
4856 hub
->ports
[i
- 1]->child
;
4858 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4860 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4861 udev
->state
== USB_STATE_NOTATTACHED
) {
4862 status
= hub_port_reset(hub
, i
,
4863 NULL
, HUB_BH_RESET_TIME
,
4866 hub_port_disable(hub
, i
, 1);
4868 usb_lock_device(udev
);
4869 status
= usb_reset_device(udev
);
4870 usb_unlock_device(udev
);
4876 hub_port_connect_change(hub
, i
,
4877 portstatus
, portchange
);
4880 /* deal with hub status changes */
4881 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4883 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4884 dev_err (hub_dev
, "get_hub_status failed\n");
4886 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4887 dev_dbg (hub_dev
, "power change\n");
4888 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4889 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4890 /* FIXME: Is this always true? */
4891 hub
->limited_power
= 1;
4893 hub
->limited_power
= 0;
4895 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4899 dev_dbg(hub_dev
, "over-current change\n");
4900 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4901 msleep(500); /* Cool down */
4902 hub_power_on(hub
, true);
4903 hub_hub_status(hub
, &status
, &unused
);
4904 if (status
& HUB_STATUS_OVERCURRENT
)
4905 dev_err(hub_dev
, "over-current "
4911 /* Balance the usb_autopm_get_interface() above */
4912 usb_autopm_put_interface_no_suspend(intf
);
4914 /* Balance the usb_autopm_get_interface_no_resume() in
4915 * kick_khubd() and allow autosuspend.
4917 usb_autopm_put_interface(intf
);
4919 usb_unlock_device(hdev
);
4920 kref_put(&hub
->kref
, hub_release
);
4922 } /* end while (1) */
4925 static int hub_thread(void *__unused
)
4927 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4928 * port handover. Otherwise it might see that a full-speed device
4929 * was gone before the EHCI controller had handed its port over to
4930 * the companion full-speed controller.
4936 wait_event_freezable(khubd_wait
,
4937 !list_empty(&hub_event_list
) ||
4938 kthread_should_stop());
4939 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4941 pr_debug("%s: khubd exiting\n", usbcore_name
);
4945 static const struct usb_device_id hub_id_table
[] = {
4946 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4947 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4948 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4949 .bInterfaceClass
= USB_CLASS_HUB
,
4950 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4951 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4952 .bDeviceClass
= USB_CLASS_HUB
},
4953 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4954 .bInterfaceClass
= USB_CLASS_HUB
},
4955 { } /* Terminating entry */
4958 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4960 static struct usb_driver hub_driver
= {
4963 .disconnect
= hub_disconnect
,
4964 .suspend
= hub_suspend
,
4965 .resume
= hub_resume
,
4966 .reset_resume
= hub_reset_resume
,
4967 .pre_reset
= hub_pre_reset
,
4968 .post_reset
= hub_post_reset
,
4969 .unlocked_ioctl
= hub_ioctl
,
4970 .id_table
= hub_id_table
,
4971 .supports_autosuspend
= 1,
4974 int usb_hub_init(void)
4976 if (usb_register(&hub_driver
) < 0) {
4977 printk(KERN_ERR
"%s: can't register hub driver\n",
4982 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4983 if (!IS_ERR(khubd_task
))
4986 /* Fall through if kernel_thread failed */
4987 usb_deregister(&hub_driver
);
4988 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4993 void usb_hub_cleanup(void)
4995 kthread_stop(khubd_task
);
4998 * Hub resources are freed for us by usb_deregister. It calls
4999 * usb_driver_purge on every device which in turn calls that
5000 * devices disconnect function if it is using this driver.
5001 * The hub_disconnect function takes care of releasing the
5002 * individual hub resources. -greg
5004 usb_deregister(&hub_driver
);
5005 } /* usb_hub_cleanup() */
5007 static int descriptors_changed(struct usb_device
*udev
,
5008 struct usb_device_descriptor
*old_device_descriptor
)
5012 unsigned serial_len
= 0;
5014 unsigned old_length
;
5018 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
5019 sizeof(*old_device_descriptor
)) != 0)
5022 /* Since the idVendor, idProduct, and bcdDevice values in the
5023 * device descriptor haven't changed, we will assume the
5024 * Manufacturer and Product strings haven't changed either.
5025 * But the SerialNumber string could be different (e.g., a
5026 * different flash card of the same brand).
5029 serial_len
= strlen(udev
->serial
) + 1;
5032 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5033 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5034 len
= max(len
, old_length
);
5037 buf
= kmalloc(len
, GFP_NOIO
);
5039 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
5040 /* assume the worst */
5043 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
5044 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
5045 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
5047 if (length
!= old_length
) {
5048 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5053 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5055 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5057 ((struct usb_config_descriptor
*) buf
)->
5058 bConfigurationValue
);
5064 if (!changed
&& serial_len
) {
5065 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5067 if (length
+ 1 != serial_len
) {
5068 dev_dbg(&udev
->dev
, "serial string error %d\n",
5071 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5072 dev_dbg(&udev
->dev
, "serial string changed\n");
5082 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5083 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5085 * WARNING - don't use this routine to reset a composite device
5086 * (one with multiple interfaces owned by separate drivers)!
5087 * Use usb_reset_device() instead.
5089 * Do a port reset, reassign the device's address, and establish its
5090 * former operating configuration. If the reset fails, or the device's
5091 * descriptors change from their values before the reset, or the original
5092 * configuration and altsettings cannot be restored, a flag will be set
5093 * telling khubd to pretend the device has been disconnected and then
5094 * re-connected. All drivers will be unbound, and the device will be
5095 * re-enumerated and probed all over again.
5097 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5098 * flagged for logical disconnection, or some other negative error code
5099 * if the reset wasn't even attempted.
5101 * The caller must own the device lock. For example, it's safe to use
5102 * this from a driver probe() routine after downloading new firmware.
5103 * For calls that might not occur during probe(), drivers should lock
5104 * the device using usb_lock_device_for_reset().
5106 * Locking exception: This routine may also be called from within an
5107 * autoresume handler. Such usage won't conflict with other tasks
5108 * holding the device lock because these tasks should always call
5109 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5111 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5113 struct usb_device
*parent_hdev
= udev
->parent
;
5114 struct usb_hub
*parent_hub
;
5115 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5116 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5118 int port1
= udev
->portnum
;
5120 if (udev
->state
== USB_STATE_NOTATTACHED
||
5121 udev
->state
== USB_STATE_SUSPENDED
) {
5122 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5128 /* this requires hcd-specific logic; see ohci_restart() */
5129 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5132 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5134 /* Disable LPM and LTM while we reset the device and reinstall the alt
5135 * settings. Device-initiated LPM settings, and system exit latency
5136 * settings are cleared when the device is reset, so we have to set
5139 ret
= usb_unlocked_disable_lpm(udev
);
5141 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5144 ret
= usb_disable_ltm(udev
);
5146 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5151 set_bit(port1
, parent_hub
->busy_bits
);
5152 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5154 /* ep0 maxpacket size may change; let the HCD know about it.
5155 * Other endpoints will be handled by re-enumeration. */
5156 usb_ep0_reinit(udev
);
5157 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5158 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5161 clear_bit(port1
, parent_hub
->busy_bits
);
5166 /* Device might have changed firmware (DFU or similar) */
5167 if (descriptors_changed(udev
, &descriptor
)) {
5168 dev_info(&udev
->dev
, "device firmware changed\n");
5169 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5173 /* Restore the device's previous configuration */
5174 if (!udev
->actconfig
)
5177 mutex_lock(hcd
->bandwidth_mutex
);
5178 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5180 dev_warn(&udev
->dev
,
5181 "Busted HC? Not enough HCD resources for "
5182 "old configuration.\n");
5183 mutex_unlock(hcd
->bandwidth_mutex
);
5186 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5187 USB_REQ_SET_CONFIGURATION
, 0,
5188 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5189 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5192 "can't restore configuration #%d (error=%d)\n",
5193 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5194 mutex_unlock(hcd
->bandwidth_mutex
);
5197 mutex_unlock(hcd
->bandwidth_mutex
);
5198 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5200 /* Put interfaces back into the same altsettings as before.
5201 * Don't bother to send the Set-Interface request for interfaces
5202 * that were already in altsetting 0; besides being unnecessary,
5203 * many devices can't handle it. Instead just reset the host-side
5206 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5207 struct usb_host_config
*config
= udev
->actconfig
;
5208 struct usb_interface
*intf
= config
->interface
[i
];
5209 struct usb_interface_descriptor
*desc
;
5211 desc
= &intf
->cur_altsetting
->desc
;
5212 if (desc
->bAlternateSetting
== 0) {
5213 usb_disable_interface(udev
, intf
, true);
5214 usb_enable_interface(udev
, intf
, true);
5217 /* Let the bandwidth allocation function know that this
5218 * device has been reset, and it will have to use
5219 * alternate setting 0 as the current alternate setting.
5221 intf
->resetting_device
= 1;
5222 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5223 desc
->bAlternateSetting
);
5224 intf
->resetting_device
= 0;
5227 dev_err(&udev
->dev
, "failed to restore interface %d "
5228 "altsetting %d (error=%d)\n",
5229 desc
->bInterfaceNumber
,
5230 desc
->bAlternateSetting
,
5237 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5238 usb_unlocked_enable_lpm(udev
);
5239 usb_enable_ltm(udev
);
5243 /* LPM state doesn't matter when we're about to destroy the device. */
5244 hub_port_logical_disconnect(parent_hub
, port1
);
5249 * usb_reset_device - warn interface drivers and perform a USB port reset
5250 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5252 * Warns all drivers bound to registered interfaces (using their pre_reset
5253 * method), performs the port reset, and then lets the drivers know that
5254 * the reset is over (using their post_reset method).
5256 * Return value is the same as for usb_reset_and_verify_device().
5258 * The caller must own the device lock. For example, it's safe to use
5259 * this from a driver probe() routine after downloading new firmware.
5260 * For calls that might not occur during probe(), drivers should lock
5261 * the device using usb_lock_device_for_reset().
5263 * If an interface is currently being probed or disconnected, we assume
5264 * its driver knows how to handle resets. For all other interfaces,
5265 * if the driver doesn't have pre_reset and post_reset methods then
5266 * we attempt to unbind it and rebind afterward.
5268 int usb_reset_device(struct usb_device
*udev
)
5272 unsigned int noio_flag
;
5273 struct usb_host_config
*config
= udev
->actconfig
;
5275 if (udev
->state
== USB_STATE_NOTATTACHED
||
5276 udev
->state
== USB_STATE_SUSPENDED
) {
5277 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5283 * Don't allocate memory with GFP_KERNEL in current
5284 * context to avoid possible deadlock if usb mass
5285 * storage interface or usbnet interface(iSCSI case)
5286 * is included in current configuration. The easist
5287 * approach is to do it for every device reset,
5288 * because the device 'memalloc_noio' flag may have
5289 * not been set before reseting the usb device.
5291 noio_flag
= memalloc_noio_save();
5293 /* Prevent autosuspend during the reset */
5294 usb_autoresume_device(udev
);
5297 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5298 struct usb_interface
*cintf
= config
->interface
[i
];
5299 struct usb_driver
*drv
;
5302 if (cintf
->dev
.driver
) {
5303 drv
= to_usb_driver(cintf
->dev
.driver
);
5304 if (drv
->pre_reset
&& drv
->post_reset
)
5305 unbind
= (drv
->pre_reset
)(cintf
);
5306 else if (cintf
->condition
==
5307 USB_INTERFACE_BOUND
)
5310 usb_forced_unbind_intf(cintf
);
5315 ret
= usb_reset_and_verify_device(udev
);
5318 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5319 struct usb_interface
*cintf
= config
->interface
[i
];
5320 struct usb_driver
*drv
;
5321 int rebind
= cintf
->needs_binding
;
5323 if (!rebind
&& cintf
->dev
.driver
) {
5324 drv
= to_usb_driver(cintf
->dev
.driver
);
5325 if (drv
->post_reset
)
5326 rebind
= (drv
->post_reset
)(cintf
);
5327 else if (cintf
->condition
==
5328 USB_INTERFACE_BOUND
)
5331 cintf
->needs_binding
= 1;
5334 usb_unbind_and_rebind_marked_interfaces(udev
);
5337 usb_autosuspend_device(udev
);
5338 memalloc_noio_restore(noio_flag
);
5341 EXPORT_SYMBOL_GPL(usb_reset_device
);
5345 * usb_queue_reset_device - Reset a USB device from an atomic context
5346 * @iface: USB interface belonging to the device to reset
5348 * This function can be used to reset a USB device from an atomic
5349 * context, where usb_reset_device() won't work (as it blocks).
5351 * Doing a reset via this method is functionally equivalent to calling
5352 * usb_reset_device(), except for the fact that it is delayed to a
5353 * workqueue. This means that any drivers bound to other interfaces
5354 * might be unbound, as well as users from usbfs in user space.
5358 * - Scheduling two resets at the same time from two different drivers
5359 * attached to two different interfaces of the same device is
5360 * possible; depending on how the driver attached to each interface
5361 * handles ->pre_reset(), the second reset might happen or not.
5363 * - If a driver is unbound and it had a pending reset, the reset will
5366 * - This function can be called during .probe() or .disconnect()
5367 * times. On return from .disconnect(), any pending resets will be
5370 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5373 * NOTE: We don't do any reference count tracking because it is not
5374 * needed. The lifecycle of the work_struct is tied to the
5375 * usb_interface. Before destroying the interface we cancel the
5376 * work_struct, so the fact that work_struct is queued and or
5377 * running means the interface (and thus, the device) exist and
5380 void usb_queue_reset_device(struct usb_interface
*iface
)
5382 schedule_work(&iface
->reset_ws
);
5384 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5387 * usb_hub_find_child - Get the pointer of child device
5388 * attached to the port which is specified by @port1.
5389 * @hdev: USB device belonging to the usb hub
5390 * @port1: port num to indicate which port the child device
5393 * USB drivers call this function to get hub's child device
5396 * Return NULL if input param is invalid and
5397 * child's usb_device pointer if non-NULL.
5399 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5402 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5404 if (port1
< 1 || port1
> hdev
->maxchild
)
5406 return hub
->ports
[port1
- 1]->child
;
5408 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5411 * usb_set_hub_port_connect_type - set hub port connect type.
5412 * @hdev: USB device belonging to the usb hub
5413 * @port1: port num of the port
5414 * @type: connect type of the port
5416 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5417 enum usb_port_connect_type type
)
5419 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5421 hub
->ports
[port1
- 1]->connect_type
= type
;
5425 * usb_get_hub_port_connect_type - Get the port's connect type
5426 * @hdev: USB device belonging to the usb hub
5427 * @port1: port num of the port
5429 * Return connect type of the port and if input params are
5430 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5432 enum usb_port_connect_type
5433 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5435 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5437 return hub
->ports
[port1
- 1]->connect_type
;
5440 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5441 struct usb_hub_descriptor
*desc
)
5443 enum usb_port_connect_type connect_type
;
5446 if (!hub_is_superspeed(hdev
)) {
5447 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5448 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5450 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5451 u8 mask
= 1 << (i
%8);
5453 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5454 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5456 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5461 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5463 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5464 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5466 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5469 if (!(port_removable
& mask
)) {
5470 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5472 port_removable
|= mask
;
5477 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5483 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5484 * @hdev: USB device belonging to the usb hub
5485 * @port1: port num of the port
5487 * Return port's acpi handle if successful, NULL if params are
5490 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5493 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5495 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);