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_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
894 /* Wait for the link to enter the disabled state. */
895 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
896 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
900 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
901 USB_SS_PORT_LS_SS_DISABLED
)
903 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
905 msleep(HUB_DEBOUNCE_STEP
);
907 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
908 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
911 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
914 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
916 struct usb_device
*hdev
= hub
->hdev
;
919 if (hub
->ports
[port1
- 1]->child
&& set_state
)
920 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
921 USB_STATE_NOTATTACHED
);
923 if (hub_is_superspeed(hub
->hdev
))
924 ret
= hub_usb3_port_disable(hub
, port1
);
926 ret
= usb_clear_port_feature(hdev
, port1
,
927 USB_PORT_FEAT_ENABLE
);
929 if (ret
&& ret
!= -ENODEV
)
930 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
936 * Disable a port and mark a logical connect-change event, so that some
937 * time later khubd will disconnect() any existing usb_device on the port
938 * and will re-enumerate if there actually is a device attached.
940 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
942 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
943 hub_port_disable(hub
, port1
, 1);
945 /* FIXME let caller ask to power down the port:
946 * - some devices won't enumerate without a VBUS power cycle
947 * - SRP saves power that way
948 * - ... new call, TBD ...
949 * That's easy if this hub can switch power per-port, and
950 * khubd reactivates the port later (timer, SRP, etc).
951 * Powerdown must be optional, because of reset/DFU.
954 set_bit(port1
, hub
->change_bits
);
959 * usb_remove_device - disable a device's port on its parent hub
960 * @udev: device to be disabled and removed
961 * Context: @udev locked, must be able to sleep.
963 * After @udev's port has been disabled, khubd is notified and it will
964 * see that the device has been disconnected. When the device is
965 * physically unplugged and something is plugged in, the events will
966 * be received and processed normally.
968 int usb_remove_device(struct usb_device
*udev
)
971 struct usb_interface
*intf
;
973 if (!udev
->parent
) /* Can't remove a root hub */
975 hub
= usb_hub_to_struct_hub(udev
->parent
);
976 intf
= to_usb_interface(hub
->intfdev
);
978 usb_autopm_get_interface(intf
);
979 set_bit(udev
->portnum
, hub
->removed_bits
);
980 hub_port_logical_disconnect(hub
, udev
->portnum
);
981 usb_autopm_put_interface(intf
);
985 enum hub_activation_type
{
986 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
987 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
990 static void hub_init_func2(struct work_struct
*ws
);
991 static void hub_init_func3(struct work_struct
*ws
);
993 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
995 struct usb_device
*hdev
= hub
->hdev
;
1000 bool need_debounce_delay
= false;
1003 /* Continue a partial initialization */
1004 if (type
== HUB_INIT2
)
1006 if (type
== HUB_INIT3
)
1009 /* The superspeed hub except for root hub has to use Hub Depth
1010 * value as an offset into the route string to locate the bits
1011 * it uses to determine the downstream port number. So hub driver
1012 * should send a set hub depth request to superspeed hub after
1013 * the superspeed hub is set configuration in initialization or
1016 * After a resume, port power should still be on.
1017 * For any other type of activation, turn it on.
1019 if (type
!= HUB_RESUME
) {
1020 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1021 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1022 HUB_SET_DEPTH
, USB_RT_HUB
,
1023 hdev
->level
- 1, 0, NULL
, 0,
1024 USB_CTRL_SET_TIMEOUT
);
1026 dev_err(hub
->intfdev
,
1027 "set hub depth failed\n");
1030 /* Speed up system boot by using a delayed_work for the
1031 * hub's initial power-up delays. This is pretty awkward
1032 * and the implementation looks like a home-brewed sort of
1033 * setjmp/longjmp, but it saves at least 100 ms for each
1034 * root hub (assuming usbcore is compiled into the kernel
1035 * rather than as a module). It adds up.
1037 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1038 * because for those activation types the ports have to be
1039 * operational when we return. In theory this could be done
1040 * for HUB_POST_RESET, but it's easier not to.
1042 if (type
== HUB_INIT
) {
1043 delay
= hub_power_on(hub
, false);
1044 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1045 schedule_delayed_work(&hub
->init_work
,
1046 msecs_to_jiffies(delay
));
1048 /* Suppress autosuspend until init is done */
1049 usb_autopm_get_interface_no_resume(
1050 to_usb_interface(hub
->intfdev
));
1051 return; /* Continues at init2: below */
1052 } else if (type
== HUB_RESET_RESUME
) {
1053 /* The internal host controller state for the hub device
1054 * may be gone after a host power loss on system resume.
1055 * Update the device's info so the HW knows it's a hub.
1057 hcd
= bus_to_hcd(hdev
->bus
);
1058 if (hcd
->driver
->update_hub_device
) {
1059 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1060 &hub
->tt
, GFP_NOIO
);
1062 dev_err(hub
->intfdev
, "Host not "
1063 "accepting hub info "
1065 dev_err(hub
->intfdev
, "LS/FS devices "
1066 "and hubs may not work "
1067 "under this hub\n.");
1070 hub_power_on(hub
, true);
1072 hub_power_on(hub
, true);
1077 /* Check each port and set hub->change_bits to let khubd know
1078 * which ports need attention.
1080 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1081 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1082 u16 portstatus
, portchange
;
1084 portstatus
= portchange
= 0;
1085 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1086 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1087 dev_dbg(hub
->intfdev
,
1088 "port %d: status %04x change %04x\n",
1089 port1
, portstatus
, portchange
);
1091 /* After anything other than HUB_RESUME (i.e., initialization
1092 * or any sort of reset), every port should be disabled.
1093 * Unconnected ports should likewise be disabled (paranoia),
1094 * and so should ports for which we have no usb_device.
1096 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1097 type
!= HUB_RESUME
||
1098 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1100 udev
->state
== USB_STATE_NOTATTACHED
)) {
1102 * USB3 protocol ports will automatically transition
1103 * to Enabled state when detect an USB3.0 device attach.
1104 * Do not disable USB3 protocol ports.
1106 if (!hub_is_superspeed(hdev
)) {
1107 usb_clear_port_feature(hdev
, port1
,
1108 USB_PORT_FEAT_ENABLE
);
1109 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1111 /* Pretend that power was lost for USB3 devs */
1112 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1116 /* Clear status-change flags; we'll debounce later */
1117 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1118 need_debounce_delay
= true;
1119 usb_clear_port_feature(hub
->hdev
, port1
,
1120 USB_PORT_FEAT_C_CONNECTION
);
1122 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1123 need_debounce_delay
= true;
1124 usb_clear_port_feature(hub
->hdev
, port1
,
1125 USB_PORT_FEAT_C_ENABLE
);
1127 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1128 hub_is_superspeed(hub
->hdev
)) {
1129 need_debounce_delay
= true;
1130 usb_clear_port_feature(hub
->hdev
, port1
,
1131 USB_PORT_FEAT_C_BH_PORT_RESET
);
1133 /* We can forget about a "removed" device when there's a
1134 * physical disconnect or the connect status changes.
1136 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1137 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1138 clear_bit(port1
, hub
->removed_bits
);
1140 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1141 /* Tell khubd to disconnect the device or
1142 * check for a new connection
1144 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1145 set_bit(port1
, hub
->change_bits
);
1147 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1148 bool port_resumed
= (portstatus
&
1149 USB_PORT_STAT_LINK_STATE
) ==
1151 /* The power session apparently survived the resume.
1152 * If there was an overcurrent or suspend change
1153 * (i.e., remote wakeup request), have khubd
1154 * take care of it. Look at the port link state
1155 * for USB 3.0 hubs, since they don't have a suspend
1156 * change bit, and they don't set the port link change
1157 * bit on device-initiated resume.
1159 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1161 set_bit(port1
, hub
->change_bits
);
1163 } else if (udev
->persist_enabled
) {
1164 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1167 udev
->reset_resume
= 1;
1169 /* Don't set the change_bits when the device
1172 if (port_dev
->power_is_on
)
1173 set_bit(port1
, hub
->change_bits
);
1176 /* The power session is gone; tell khubd */
1177 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1178 set_bit(port1
, hub
->change_bits
);
1182 /* If no port-status-change flags were set, we don't need any
1183 * debouncing. If flags were set we can try to debounce the
1184 * ports all at once right now, instead of letting khubd do them
1185 * one at a time later on.
1187 * If any port-status changes do occur during this delay, khubd
1188 * will see them later and handle them normally.
1190 if (need_debounce_delay
) {
1191 delay
= HUB_DEBOUNCE_STABLE
;
1193 /* Don't do a long sleep inside a workqueue routine */
1194 if (type
== HUB_INIT2
) {
1195 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1196 schedule_delayed_work(&hub
->init_work
,
1197 msecs_to_jiffies(delay
));
1198 return; /* Continues at init3: below */
1206 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1208 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1209 if (hub
->has_indicators
&& blinkenlights
)
1210 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1212 /* Scan all ports that need attention */
1215 /* Allow autosuspend if it was suppressed */
1216 if (type
<= HUB_INIT3
)
1217 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1220 /* Implement the continuations for the delays above */
1221 static void hub_init_func2(struct work_struct
*ws
)
1223 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1225 hub_activate(hub
, HUB_INIT2
);
1228 static void hub_init_func3(struct work_struct
*ws
)
1230 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1232 hub_activate(hub
, HUB_INIT3
);
1235 enum hub_quiescing_type
{
1236 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1239 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1241 struct usb_device
*hdev
= hub
->hdev
;
1244 cancel_delayed_work_sync(&hub
->init_work
);
1246 /* khubd and related activity won't re-trigger */
1249 if (type
!= HUB_SUSPEND
) {
1250 /* Disconnect all the children */
1251 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1252 if (hub
->ports
[i
]->child
)
1253 usb_disconnect(&hub
->ports
[i
]->child
);
1257 /* Stop khubd and related activity */
1258 usb_kill_urb(hub
->urb
);
1259 if (hub
->has_indicators
)
1260 cancel_delayed_work_sync(&hub
->leds
);
1262 flush_work(&hub
->tt
.clear_work
);
1265 /* caller has locked the hub device */
1266 static int hub_pre_reset(struct usb_interface
*intf
)
1268 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1270 hub_quiesce(hub
, HUB_PRE_RESET
);
1274 /* caller has locked the hub device */
1275 static int hub_post_reset(struct usb_interface
*intf
)
1277 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1279 hub_activate(hub
, HUB_POST_RESET
);
1283 static int hub_configure(struct usb_hub
*hub
,
1284 struct usb_endpoint_descriptor
*endpoint
)
1286 struct usb_hcd
*hcd
;
1287 struct usb_device
*hdev
= hub
->hdev
;
1288 struct device
*hub_dev
= hub
->intfdev
;
1289 u16 hubstatus
, hubchange
;
1290 u16 wHubCharacteristics
;
1293 char *message
= "out of memory";
1297 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1303 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1308 mutex_init(&hub
->status_mutex
);
1310 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1311 if (!hub
->descriptor
) {
1316 /* Request the entire hub descriptor.
1317 * hub->descriptor can handle USB_MAXCHILDREN ports,
1318 * but the hub can/will return fewer bytes here.
1320 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1322 message
= "can't read hub descriptor";
1324 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1325 message
= "hub has too many ports!";
1328 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1329 message
= "hub doesn't have any ports!";
1334 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1335 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1336 (hdev
->maxchild
== 1) ? "" : "s");
1338 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1345 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1346 if (hub_is_superspeed(hdev
)) {
1354 /* FIXME for USB 3.0, skip for now */
1355 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1356 !(hub_is_superspeed(hdev
))) {
1358 char portstr
[USB_MAXCHILDREN
+ 1];
1360 for (i
= 0; i
< hdev
->maxchild
; i
++)
1361 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1362 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1364 portstr
[hdev
->maxchild
] = 0;
1365 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1367 dev_dbg(hub_dev
, "standalone hub\n");
1369 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1370 case HUB_CHAR_COMMON_LPSM
:
1371 dev_dbg(hub_dev
, "ganged power switching\n");
1373 case HUB_CHAR_INDV_PORT_LPSM
:
1374 dev_dbg(hub_dev
, "individual port power switching\n");
1376 case HUB_CHAR_NO_LPSM
:
1378 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1382 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1383 case HUB_CHAR_COMMON_OCPM
:
1384 dev_dbg(hub_dev
, "global over-current protection\n");
1386 case HUB_CHAR_INDV_PORT_OCPM
:
1387 dev_dbg(hub_dev
, "individual port over-current protection\n");
1389 case HUB_CHAR_NO_OCPM
:
1391 dev_dbg(hub_dev
, "no over-current protection\n");
1395 spin_lock_init (&hub
->tt
.lock
);
1396 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1397 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1398 switch (hdev
->descriptor
.bDeviceProtocol
) {
1401 case USB_HUB_PR_HS_SINGLE_TT
:
1402 dev_dbg(hub_dev
, "Single TT\n");
1405 case USB_HUB_PR_HS_MULTI_TT
:
1406 ret
= usb_set_interface(hdev
, 0, 1);
1408 dev_dbg(hub_dev
, "TT per port\n");
1411 dev_err(hub_dev
, "Using single TT (err %d)\n",
1416 /* USB 3.0 hubs don't have a TT */
1419 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1420 hdev
->descriptor
.bDeviceProtocol
);
1424 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1425 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1426 case HUB_TTTT_8_BITS
:
1427 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1428 hub
->tt
.think_time
= 666;
1429 dev_dbg(hub_dev
, "TT requires at most %d "
1430 "FS bit times (%d ns)\n",
1431 8, hub
->tt
.think_time
);
1434 case HUB_TTTT_16_BITS
:
1435 hub
->tt
.think_time
= 666 * 2;
1436 dev_dbg(hub_dev
, "TT requires at most %d "
1437 "FS bit times (%d ns)\n",
1438 16, hub
->tt
.think_time
);
1440 case HUB_TTTT_24_BITS
:
1441 hub
->tt
.think_time
= 666 * 3;
1442 dev_dbg(hub_dev
, "TT requires at most %d "
1443 "FS bit times (%d ns)\n",
1444 24, hub
->tt
.think_time
);
1446 case HUB_TTTT_32_BITS
:
1447 hub
->tt
.think_time
= 666 * 4;
1448 dev_dbg(hub_dev
, "TT requires at most %d "
1449 "FS bit times (%d ns)\n",
1450 32, hub
->tt
.think_time
);
1454 /* probe() zeroes hub->indicator[] */
1455 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1456 hub
->has_indicators
= 1;
1457 dev_dbg(hub_dev
, "Port indicators are supported\n");
1460 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1461 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1463 /* power budgeting mostly matters with bus-powered hubs,
1464 * and battery-powered root hubs (may provide just 8 mA).
1466 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1468 message
= "can't get hub status";
1471 le16_to_cpus(&hubstatus
);
1472 hcd
= bus_to_hcd(hdev
->bus
);
1473 if (hdev
== hdev
->bus
->root_hub
) {
1474 if (hcd
->power_budget
> 0)
1475 hdev
->bus_mA
= hcd
->power_budget
;
1477 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1478 if (hdev
->bus_mA
>= full_load
)
1479 hub
->mA_per_port
= full_load
;
1481 hub
->mA_per_port
= hdev
->bus_mA
;
1482 hub
->limited_power
= 1;
1484 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1485 int remaining
= hdev
->bus_mA
-
1486 hub
->descriptor
->bHubContrCurrent
;
1488 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1489 hub
->descriptor
->bHubContrCurrent
);
1490 hub
->limited_power
= 1;
1492 if (remaining
< hdev
->maxchild
* unit_load
)
1494 "insufficient power available "
1495 "to use all downstream ports\n");
1496 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1498 } else { /* Self-powered external hub */
1499 /* FIXME: What about battery-powered external hubs that
1500 * provide less current per port? */
1501 hub
->mA_per_port
= full_load
;
1503 if (hub
->mA_per_port
< full_load
)
1504 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1507 /* Update the HCD's internal representation of this hub before khubd
1508 * starts getting port status changes for devices under the hub.
1510 if (hcd
->driver
->update_hub_device
) {
1511 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1512 &hub
->tt
, GFP_KERNEL
);
1514 message
= "can't update HCD hub info";
1519 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1521 message
= "can't get hub status";
1525 /* local power status reports aren't always correct */
1526 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1527 dev_dbg(hub_dev
, "local power source is %s\n",
1528 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1529 ? "lost (inactive)" : "good");
1531 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1532 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1533 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1535 /* set up the interrupt endpoint
1536 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1537 * bytes as USB2.0[11.12.3] says because some hubs are known
1538 * to send more data (and thus cause overflow). For root hubs,
1539 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1540 * to be big enough for at least USB_MAXCHILDREN ports. */
1541 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1542 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1544 if (maxp
> sizeof(*hub
->buffer
))
1545 maxp
= sizeof(*hub
->buffer
);
1547 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1553 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1554 hub
, endpoint
->bInterval
);
1556 /* maybe cycle the hub leds */
1557 if (hub
->has_indicators
&& blinkenlights
)
1558 hub
->indicator
[0] = INDICATOR_CYCLE
;
1560 for (i
= 0; i
< hdev
->maxchild
; i
++)
1561 if (usb_hub_create_port_device(hub
, i
+ 1) < 0)
1562 dev_err(hub
->intfdev
,
1563 "couldn't create port%d device.\n", i
+ 1);
1565 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1567 hub_activate(hub
, HUB_INIT
);
1572 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1574 /* hub_disconnect() frees urb and descriptor */
1578 static void hub_release(struct kref
*kref
)
1580 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1582 usb_put_intf(to_usb_interface(hub
->intfdev
));
1586 static unsigned highspeed_hubs
;
1588 static void hub_disconnect(struct usb_interface
*intf
)
1590 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1591 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1594 /* Take the hub off the event list and don't let it be added again */
1595 spin_lock_irq(&hub_event_lock
);
1596 if (!list_empty(&hub
->event_list
)) {
1597 list_del_init(&hub
->event_list
);
1598 usb_autopm_put_interface_no_suspend(intf
);
1600 hub
->disconnected
= 1;
1601 spin_unlock_irq(&hub_event_lock
);
1603 /* Disconnect all children and quiesce the hub */
1605 hub_quiesce(hub
, HUB_DISCONNECT
);
1607 usb_set_intfdata (intf
, NULL
);
1609 for (i
= 0; i
< hdev
->maxchild
; i
++)
1610 usb_hub_remove_port_device(hub
, i
+ 1);
1611 hub
->hdev
->maxchild
= 0;
1613 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1616 usb_free_urb(hub
->urb
);
1618 kfree(hub
->descriptor
);
1622 pm_suspend_ignore_children(&intf
->dev
, false);
1623 kref_put(&hub
->kref
, hub_release
);
1626 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1628 struct usb_host_interface
*desc
;
1629 struct usb_endpoint_descriptor
*endpoint
;
1630 struct usb_device
*hdev
;
1631 struct usb_hub
*hub
;
1633 desc
= intf
->cur_altsetting
;
1634 hdev
= interface_to_usbdev(intf
);
1637 * Set default autosuspend delay as 0 to speedup bus suspend,
1638 * based on the below considerations:
1640 * - Unlike other drivers, the hub driver does not rely on the
1641 * autosuspend delay to provide enough time to handle a wakeup
1642 * event, and the submitted status URB is just to check future
1643 * change on hub downstream ports, so it is safe to do it.
1645 * - The patch might cause one or more auto supend/resume for
1646 * below very rare devices when they are plugged into hub
1649 * devices having trouble initializing, and disconnect
1650 * themselves from the bus and then reconnect a second
1653 * devices just for downloading firmware, and disconnects
1654 * themselves after completing it
1656 * For these quite rare devices, their drivers may change the
1657 * autosuspend delay of their parent hub in the probe() to one
1658 * appropriate value to avoid the subtle problem if someone
1661 * - The patch may cause one or more auto suspend/resume on
1662 * hub during running 'lsusb', but it is probably too
1663 * infrequent to worry about.
1665 * - Change autosuspend delay of hub can avoid unnecessary auto
1666 * suspend timer for hub, also may decrease power consumption
1669 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1671 /* Hubs have proper suspend/resume support. */
1672 usb_enable_autosuspend(hdev
);
1674 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1676 "Unsupported bus topology: hub nested too deep\n");
1680 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1682 dev_warn(&intf
->dev
, "ignoring external hub\n");
1687 /* Some hubs have a subclass of 1, which AFAICT according to the */
1688 /* specs is not defined, but it works */
1689 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1690 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1692 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1696 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1697 if (desc
->desc
.bNumEndpoints
!= 1)
1698 goto descriptor_error
;
1700 endpoint
= &desc
->endpoint
[0].desc
;
1702 /* If it's not an interrupt in endpoint, we'd better punt! */
1703 if (!usb_endpoint_is_int_in(endpoint
))
1704 goto descriptor_error
;
1706 /* We found a hub */
1707 dev_info (&intf
->dev
, "USB hub found\n");
1709 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1711 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1715 kref_init(&hub
->kref
);
1716 INIT_LIST_HEAD(&hub
->event_list
);
1717 hub
->intfdev
= &intf
->dev
;
1719 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1720 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1723 usb_set_intfdata (intf
, hub
);
1724 intf
->needs_remote_wakeup
= 1;
1725 pm_suspend_ignore_children(&intf
->dev
, true);
1727 if (hdev
->speed
== USB_SPEED_HIGH
)
1730 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1731 hub
->quirk_check_port_auto_suspend
= 1;
1733 if (hub_configure(hub
, endpoint
) >= 0)
1736 hub_disconnect (intf
);
1741 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1743 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1744 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1746 /* assert ifno == 0 (part of hub spec) */
1748 case USBDEVFS_HUB_PORTINFO
: {
1749 struct usbdevfs_hub_portinfo
*info
= user_data
;
1752 spin_lock_irq(&device_state_lock
);
1753 if (hdev
->devnum
<= 0)
1756 info
->nports
= hdev
->maxchild
;
1757 for (i
= 0; i
< info
->nports
; i
++) {
1758 if (hub
->ports
[i
]->child
== NULL
)
1762 hub
->ports
[i
]->child
->devnum
;
1765 spin_unlock_irq(&device_state_lock
);
1767 return info
->nports
+ 1;
1776 * Allow user programs to claim ports on a hub. When a device is attached
1777 * to one of these "claimed" ports, the program will "own" the device.
1779 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1780 struct dev_state
***ppowner
)
1782 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1784 if (port1
== 0 || port1
> hdev
->maxchild
)
1787 /* This assumes that devices not managed by the hub driver
1788 * will always have maxchild equal to 0.
1790 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1794 /* In the following three functions, the caller must hold hdev's lock */
1795 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1796 struct dev_state
*owner
)
1799 struct dev_state
**powner
;
1801 rc
= find_port_owner(hdev
, port1
, &powner
);
1810 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1811 struct dev_state
*owner
)
1814 struct dev_state
**powner
;
1816 rc
= find_port_owner(hdev
, port1
, &powner
);
1819 if (*powner
!= owner
)
1825 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1827 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1830 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1831 if (hub
->ports
[n
]->port_owner
== owner
)
1832 hub
->ports
[n
]->port_owner
= NULL
;
1837 /* The caller must hold udev's lock */
1838 bool usb_device_is_owned(struct usb_device
*udev
)
1840 struct usb_hub
*hub
;
1842 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1844 hub
= usb_hub_to_struct_hub(udev
->parent
);
1845 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1848 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1850 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1853 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1854 if (hub
->ports
[i
]->child
)
1855 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1857 if (udev
->state
== USB_STATE_SUSPENDED
)
1858 udev
->active_duration
-= jiffies
;
1859 udev
->state
= USB_STATE_NOTATTACHED
;
1863 * usb_set_device_state - change a device's current state (usbcore, hcds)
1864 * @udev: pointer to device whose state should be changed
1865 * @new_state: new state value to be stored
1867 * udev->state is _not_ fully protected by the device lock. Although
1868 * most transitions are made only while holding the lock, the state can
1869 * can change to USB_STATE_NOTATTACHED at almost any time. This
1870 * is so that devices can be marked as disconnected as soon as possible,
1871 * without having to wait for any semaphores to be released. As a result,
1872 * all changes to any device's state must be protected by the
1873 * device_state_lock spinlock.
1875 * Once a device has been added to the device tree, all changes to its state
1876 * should be made using this routine. The state should _not_ be set directly.
1878 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1879 * Otherwise udev->state is set to new_state, and if new_state is
1880 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1881 * to USB_STATE_NOTATTACHED.
1883 void usb_set_device_state(struct usb_device
*udev
,
1884 enum usb_device_state new_state
)
1886 unsigned long flags
;
1889 spin_lock_irqsave(&device_state_lock
, flags
);
1890 if (udev
->state
== USB_STATE_NOTATTACHED
)
1892 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1894 /* root hub wakeup capabilities are managed out-of-band
1895 * and may involve silicon errata ... ignore them here.
1898 if (udev
->state
== USB_STATE_SUSPENDED
1899 || new_state
== USB_STATE_SUSPENDED
)
1900 ; /* No change to wakeup settings */
1901 else if (new_state
== USB_STATE_CONFIGURED
)
1902 wakeup
= udev
->actconfig
->desc
.bmAttributes
1903 & USB_CONFIG_ATT_WAKEUP
;
1907 if (udev
->state
== USB_STATE_SUSPENDED
&&
1908 new_state
!= USB_STATE_SUSPENDED
)
1909 udev
->active_duration
-= jiffies
;
1910 else if (new_state
== USB_STATE_SUSPENDED
&&
1911 udev
->state
!= USB_STATE_SUSPENDED
)
1912 udev
->active_duration
+= jiffies
;
1913 udev
->state
= new_state
;
1915 recursively_mark_NOTATTACHED(udev
);
1916 spin_unlock_irqrestore(&device_state_lock
, flags
);
1918 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1920 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1923 * Choose a device number.
1925 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1926 * USB-2.0 buses they are also used as device addresses, however on
1927 * USB-3.0 buses the address is assigned by the controller hardware
1928 * and it usually is not the same as the device number.
1930 * WUSB devices are simple: they have no hubs behind, so the mapping
1931 * device <-> virtual port number becomes 1:1. Why? to simplify the
1932 * life of the device connection logic in
1933 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1934 * handshake we need to assign a temporary address in the unauthorized
1935 * space. For simplicity we use the first virtual port number found to
1936 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1937 * and that becomes it's address [X < 128] or its unauthorized address
1940 * We add 1 as an offset to the one-based USB-stack port number
1941 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1942 * 0 is reserved by USB for default address; (b) Linux's USB stack
1943 * uses always #1 for the root hub of the controller. So USB stack's
1944 * port #1, which is wusb virtual-port #0 has address #2.
1946 * Devices connected under xHCI are not as simple. The host controller
1947 * supports virtualization, so the hardware assigns device addresses and
1948 * the HCD must setup data structures before issuing a set address
1949 * command to the hardware.
1951 static void choose_devnum(struct usb_device
*udev
)
1954 struct usb_bus
*bus
= udev
->bus
;
1956 /* If khubd ever becomes multithreaded, this will need a lock */
1958 devnum
= udev
->portnum
+ 1;
1959 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1961 /* Try to allocate the next devnum beginning at
1962 * bus->devnum_next. */
1963 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1966 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1968 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1971 set_bit(devnum
, bus
->devmap
.devicemap
);
1972 udev
->devnum
= devnum
;
1976 static void release_devnum(struct usb_device
*udev
)
1978 if (udev
->devnum
> 0) {
1979 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1984 static void update_devnum(struct usb_device
*udev
, int devnum
)
1986 /* The address for a WUSB device is managed by wusbcore. */
1988 udev
->devnum
= devnum
;
1991 static void hub_free_dev(struct usb_device
*udev
)
1993 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1995 /* Root hubs aren't real devices, so don't free HCD resources */
1996 if (hcd
->driver
->free_dev
&& udev
->parent
)
1997 hcd
->driver
->free_dev(hcd
, udev
);
2001 * usb_disconnect - disconnect a device (usbcore-internal)
2002 * @pdev: pointer to device being disconnected
2003 * Context: !in_interrupt ()
2005 * Something got disconnected. Get rid of it and all of its children.
2007 * If *pdev is a normal device then the parent hub must already be locked.
2008 * If *pdev is a root hub then this routine will acquire the
2009 * usb_bus_list_lock on behalf of the caller.
2011 * Only hub drivers (including virtual root hub drivers for host
2012 * controllers) should ever call this.
2014 * This call is synchronous, and may not be used in an interrupt context.
2016 void usb_disconnect(struct usb_device
**pdev
)
2018 struct usb_device
*udev
= *pdev
;
2019 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2022 /* mark the device as inactive, so any further urb submissions for
2023 * this device (and any of its children) will fail immediately.
2024 * this quiesces everything except pending urbs.
2026 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2027 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2030 usb_lock_device(udev
);
2032 /* Free up all the children before we remove this device */
2033 for (i
= 0; i
< udev
->maxchild
; i
++) {
2034 if (hub
->ports
[i
]->child
)
2035 usb_disconnect(&hub
->ports
[i
]->child
);
2038 /* deallocate hcd/hardware state ... nuking all pending urbs and
2039 * cleaning up all state associated with the current configuration
2040 * so that the hardware is now fully quiesced.
2042 dev_dbg (&udev
->dev
, "unregistering device\n");
2043 usb_disable_device(udev
, 0);
2044 usb_hcd_synchronize_unlinks(udev
);
2047 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2048 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2050 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2051 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2053 if (!port_dev
->did_runtime_put
)
2054 pm_runtime_put(&port_dev
->dev
);
2056 port_dev
->did_runtime_put
= false;
2059 usb_remove_ep_devs(&udev
->ep0
);
2060 usb_unlock_device(udev
);
2062 /* Unregister the device. The device driver is responsible
2063 * for de-configuring the device and invoking the remove-device
2064 * notifier chain (used by usbfs and possibly others).
2066 device_del(&udev
->dev
);
2068 /* Free the device number and delete the parent's children[]
2069 * (or root_hub) pointer.
2071 release_devnum(udev
);
2073 /* Avoid races with recursively_mark_NOTATTACHED() */
2074 spin_lock_irq(&device_state_lock
);
2076 spin_unlock_irq(&device_state_lock
);
2080 put_device(&udev
->dev
);
2083 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2084 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2088 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2091 static void announce_device(struct usb_device
*udev
)
2093 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2094 le16_to_cpu(udev
->descriptor
.idVendor
),
2095 le16_to_cpu(udev
->descriptor
.idProduct
));
2096 dev_info(&udev
->dev
,
2097 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2098 udev
->descriptor
.iManufacturer
,
2099 udev
->descriptor
.iProduct
,
2100 udev
->descriptor
.iSerialNumber
);
2101 show_string(udev
, "Product", udev
->product
);
2102 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2103 show_string(udev
, "SerialNumber", udev
->serial
);
2106 static inline void announce_device(struct usb_device
*udev
) { }
2109 #ifdef CONFIG_USB_OTG
2110 #include "otg_whitelist.h"
2114 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2115 * @udev: newly addressed device (in ADDRESS state)
2117 * Finish enumeration for On-The-Go devices
2119 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2123 #ifdef CONFIG_USB_OTG
2125 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2126 * to wake us after we've powered off VBUS; and HNP, switching roles
2127 * "host" to "peripheral". The OTG descriptor helps figure this out.
2129 if (!udev
->bus
->is_b_host
2131 && udev
->parent
== udev
->bus
->root_hub
) {
2132 struct usb_otg_descriptor
*desc
= NULL
;
2133 struct usb_bus
*bus
= udev
->bus
;
2135 /* descriptor may appear anywhere in config */
2136 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2137 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2138 USB_DT_OTG
, (void **) &desc
) == 0) {
2139 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2140 unsigned port1
= udev
->portnum
;
2142 dev_info(&udev
->dev
,
2143 "Dual-Role OTG device on %sHNP port\n",
2144 (port1
== bus
->otg_port
)
2147 /* enable HNP before suspend, it's simpler */
2148 if (port1
== bus
->otg_port
)
2149 bus
->b_hnp_enable
= 1;
2150 err
= usb_control_msg(udev
,
2151 usb_sndctrlpipe(udev
, 0),
2152 USB_REQ_SET_FEATURE
, 0,
2154 ? USB_DEVICE_B_HNP_ENABLE
2155 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2156 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2158 /* OTG MESSAGE: report errors here,
2159 * customize to match your product.
2161 dev_info(&udev
->dev
,
2162 "can't set HNP mode: %d\n",
2164 bus
->b_hnp_enable
= 0;
2170 if (!is_targeted(udev
)) {
2172 /* Maybe it can talk to us, though we can't talk to it.
2173 * (Includes HNP test device.)
2175 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2176 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2178 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2190 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2191 * @udev: newly addressed device (in ADDRESS state)
2193 * This is only called by usb_new_device() and usb_authorize_device()
2194 * and FIXME -- all comments that apply to them apply here wrt to
2197 * If the device is WUSB and not authorized, we don't attempt to read
2198 * the string descriptors, as they will be errored out by the device
2199 * until it has been authorized.
2201 static int usb_enumerate_device(struct usb_device
*udev
)
2205 if (udev
->config
== NULL
) {
2206 err
= usb_get_configuration(udev
);
2209 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2214 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
2215 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2216 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2217 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2220 /* read the standard strings and cache them if present */
2221 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2222 udev
->manufacturer
= usb_cache_string(udev
,
2223 udev
->descriptor
.iManufacturer
);
2224 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2226 err
= usb_enumerate_device_otg(udev
);
2230 usb_detect_interface_quirks(udev
);
2235 static void set_usb_port_removable(struct usb_device
*udev
)
2237 struct usb_device
*hdev
= udev
->parent
;
2238 struct usb_hub
*hub
;
2239 u8 port
= udev
->portnum
;
2240 u16 wHubCharacteristics
;
2241 bool removable
= true;
2246 hub
= usb_hub_to_struct_hub(udev
->parent
);
2248 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2250 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2253 if (hub_is_superspeed(hdev
)) {
2254 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2258 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2263 udev
->removable
= USB_DEVICE_REMOVABLE
;
2265 udev
->removable
= USB_DEVICE_FIXED
;
2269 * usb_new_device - perform initial device setup (usbcore-internal)
2270 * @udev: newly addressed device (in ADDRESS state)
2272 * This is called with devices which have been detected but not fully
2273 * enumerated. The device descriptor is available, but not descriptors
2274 * for any device configuration. The caller must have locked either
2275 * the parent hub (if udev is a normal device) or else the
2276 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2277 * udev has already been installed, but udev is not yet visible through
2278 * sysfs or other filesystem code.
2280 * It will return if the device is configured properly or not. Zero if
2281 * the interface was registered with the driver core; else a negative
2284 * This call is synchronous, and may not be used in an interrupt context.
2286 * Only the hub driver or root-hub registrar should ever call this.
2288 int usb_new_device(struct usb_device
*udev
)
2293 /* Initialize non-root-hub device wakeup to disabled;
2294 * device (un)configuration controls wakeup capable
2295 * sysfs power/wakeup controls wakeup enabled/disabled
2297 device_init_wakeup(&udev
->dev
, 0);
2300 /* Tell the runtime-PM framework the device is active */
2301 pm_runtime_set_active(&udev
->dev
);
2302 pm_runtime_get_noresume(&udev
->dev
);
2303 pm_runtime_use_autosuspend(&udev
->dev
);
2304 pm_runtime_enable(&udev
->dev
);
2306 /* By default, forbid autosuspend for all devices. It will be
2307 * allowed for hubs during binding.
2309 usb_disable_autosuspend(udev
);
2311 err
= usb_enumerate_device(udev
); /* Read descriptors */
2314 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2315 udev
->devnum
, udev
->bus
->busnum
,
2316 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2317 /* export the usbdev device-node for libusb */
2318 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2319 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2321 /* Tell the world! */
2322 announce_device(udev
);
2325 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2327 add_device_randomness(udev
->product
, strlen(udev
->product
));
2328 if (udev
->manufacturer
)
2329 add_device_randomness(udev
->manufacturer
,
2330 strlen(udev
->manufacturer
));
2332 device_enable_async_suspend(&udev
->dev
);
2335 * check whether the hub marks this port as non-removable. Do it
2336 * now so that platform-specific data can override it in
2340 set_usb_port_removable(udev
);
2342 /* Register the device. The device driver is responsible
2343 * for configuring the device and invoking the add-device
2344 * notifier chain (used by usbfs and possibly others).
2346 err
= device_add(&udev
->dev
);
2348 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2352 /* Create link files between child device and usb port device. */
2354 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2355 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2357 err
= sysfs_create_link(&udev
->dev
.kobj
,
2358 &port_dev
->dev
.kobj
, "port");
2362 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2363 &udev
->dev
.kobj
, "device");
2365 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2369 pm_runtime_get_sync(&port_dev
->dev
);
2372 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2373 usb_mark_last_busy(udev
);
2374 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2378 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2379 pm_runtime_disable(&udev
->dev
);
2380 pm_runtime_set_suspended(&udev
->dev
);
2386 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2387 * @usb_dev: USB device
2389 * Move the USB device to a very basic state where interfaces are disabled
2390 * and the device is in fact unconfigured and unusable.
2392 * We share a lock (that we have) with device_del(), so we need to
2395 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2397 usb_lock_device(usb_dev
);
2398 if (usb_dev
->authorized
== 0)
2399 goto out_unauthorized
;
2401 usb_dev
->authorized
= 0;
2402 usb_set_configuration(usb_dev
, -1);
2404 kfree(usb_dev
->product
);
2405 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2406 kfree(usb_dev
->manufacturer
);
2407 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2408 kfree(usb_dev
->serial
);
2409 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2411 usb_destroy_configuration(usb_dev
);
2412 usb_dev
->descriptor
.bNumConfigurations
= 0;
2415 usb_unlock_device(usb_dev
);
2420 int usb_authorize_device(struct usb_device
*usb_dev
)
2424 usb_lock_device(usb_dev
);
2425 if (usb_dev
->authorized
== 1)
2426 goto out_authorized
;
2428 result
= usb_autoresume_device(usb_dev
);
2430 dev_err(&usb_dev
->dev
,
2431 "can't autoresume for authorization: %d\n", result
);
2432 goto error_autoresume
;
2434 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2436 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2437 "authorization: %d\n", result
);
2438 goto error_device_descriptor
;
2441 kfree(usb_dev
->product
);
2442 usb_dev
->product
= NULL
;
2443 kfree(usb_dev
->manufacturer
);
2444 usb_dev
->manufacturer
= NULL
;
2445 kfree(usb_dev
->serial
);
2446 usb_dev
->serial
= NULL
;
2448 usb_dev
->authorized
= 1;
2449 result
= usb_enumerate_device(usb_dev
);
2451 goto error_enumerate
;
2452 /* Choose and set the configuration. This registers the interfaces
2453 * with the driver core and lets interface drivers bind to them.
2455 c
= usb_choose_configuration(usb_dev
);
2457 result
= usb_set_configuration(usb_dev
, c
);
2459 dev_err(&usb_dev
->dev
,
2460 "can't set config #%d, error %d\n", c
, result
);
2461 /* This need not be fatal. The user can try to
2462 * set other configurations. */
2465 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2468 error_device_descriptor
:
2469 usb_autosuspend_device(usb_dev
);
2472 usb_unlock_device(usb_dev
); // complements locktree
2477 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2478 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2480 struct usb_hcd
*hcd
;
2481 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2483 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2484 return hcd
->wireless
;
2488 #define PORT_RESET_TRIES 5
2489 #define SET_ADDRESS_TRIES 2
2490 #define GET_DESCRIPTOR_TRIES 2
2491 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2492 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2494 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2495 #define HUB_SHORT_RESET_TIME 10
2496 #define HUB_BH_RESET_TIME 50
2497 #define HUB_LONG_RESET_TIME 200
2498 #define HUB_RESET_TIMEOUT 800
2500 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2501 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2503 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2504 * Port worm reset is required to recover
2506 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2508 return hub_is_superspeed(hub
->hdev
) &&
2509 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2510 USB_SS_PORT_LS_SS_INACTIVE
) ||
2511 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2512 USB_SS_PORT_LS_COMP_MOD
)) ;
2515 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2516 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2518 int delay_time
, ret
;
2522 for (delay_time
= 0;
2523 delay_time
< HUB_RESET_TIMEOUT
;
2524 delay_time
+= delay
) {
2525 /* wait to give the device a chance to reset */
2528 /* read and decode port status */
2529 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2533 /* The port state is unknown until the reset completes. */
2534 if (!(portstatus
& USB_PORT_STAT_RESET
))
2537 /* switch to the long delay after two short delay failures */
2538 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2539 delay
= HUB_LONG_RESET_TIME
;
2541 dev_dbg (hub
->intfdev
,
2542 "port %d not %sreset yet, waiting %dms\n",
2543 port1
, warm
? "warm " : "", delay
);
2546 if ((portstatus
& USB_PORT_STAT_RESET
))
2549 if (hub_port_warm_reset_required(hub
, portstatus
))
2552 /* Device went away? */
2553 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2556 /* bomb out completely if the connection bounced. A USB 3.0
2557 * connection may bounce if multiple warm resets were issued,
2558 * but the device may have successfully re-connected. Ignore it.
2560 if (!hub_is_superspeed(hub
->hdev
) &&
2561 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2564 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2570 if (hub_is_wusb(hub
))
2571 udev
->speed
= USB_SPEED_WIRELESS
;
2572 else if (hub_is_superspeed(hub
->hdev
))
2573 udev
->speed
= USB_SPEED_SUPER
;
2574 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2575 udev
->speed
= USB_SPEED_HIGH
;
2576 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2577 udev
->speed
= USB_SPEED_LOW
;
2579 udev
->speed
= USB_SPEED_FULL
;
2583 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2584 struct usb_device
*udev
, int *status
)
2588 /* TRSTRCY = 10 ms; plus some extra */
2591 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2593 update_devnum(udev
, 0);
2594 /* The xHC may think the device is already reset,
2595 * so ignore the status.
2597 if (hcd
->driver
->reset_device
)
2598 hcd
->driver
->reset_device(hcd
, udev
);
2603 usb_clear_port_feature(hub
->hdev
,
2604 port1
, USB_PORT_FEAT_C_RESET
);
2605 if (hub_is_superspeed(hub
->hdev
)) {
2606 usb_clear_port_feature(hub
->hdev
, port1
,
2607 USB_PORT_FEAT_C_BH_PORT_RESET
);
2608 usb_clear_port_feature(hub
->hdev
, port1
,
2609 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2610 usb_clear_port_feature(hub
->hdev
, port1
,
2611 USB_PORT_FEAT_C_CONNECTION
);
2614 usb_set_device_state(udev
, *status
2615 ? USB_STATE_NOTATTACHED
2616 : USB_STATE_DEFAULT
);
2621 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2622 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2623 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2626 u16 portchange
, portstatus
;
2628 if (!hub_is_superspeed(hub
->hdev
)) {
2630 dev_err(hub
->intfdev
, "only USB3 hub support "
2634 /* Block EHCI CF initialization during the port reset.
2635 * Some companion controllers don't like it when they mix.
2637 down_read(&ehci_cf_port_reset_rwsem
);
2640 * If the caller hasn't explicitly requested a warm reset,
2641 * double check and see if one is needed.
2643 status
= hub_port_status(hub
, port1
,
2644 &portstatus
, &portchange
);
2648 if (hub_port_warm_reset_required(hub
, portstatus
))
2652 /* Reset the port */
2653 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2654 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2655 USB_PORT_FEAT_BH_PORT_RESET
:
2656 USB_PORT_FEAT_RESET
));
2657 if (status
== -ENODEV
) {
2658 ; /* The hub is gone */
2659 } else if (status
) {
2660 dev_err(hub
->intfdev
,
2661 "cannot %sreset port %d (err = %d)\n",
2662 warm
? "warm " : "", port1
, status
);
2664 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2666 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2667 dev_dbg(hub
->intfdev
,
2668 "port_wait_reset: err = %d\n",
2672 /* Check for disconnect or reset */
2673 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2674 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2676 if (!hub_is_superspeed(hub
->hdev
))
2680 * If a USB 3.0 device migrates from reset to an error
2681 * state, re-issue the warm reset.
2683 if (hub_port_status(hub
, port1
,
2684 &portstatus
, &portchange
) < 0)
2687 if (!hub_port_warm_reset_required(hub
, portstatus
))
2691 * If the port is in SS.Inactive or Compliance Mode, the
2692 * hot or warm reset failed. Try another warm reset.
2695 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2701 dev_dbg (hub
->intfdev
,
2702 "port %d not enabled, trying %sreset again...\n",
2703 port1
, warm
? "warm " : "");
2704 delay
= HUB_LONG_RESET_TIME
;
2707 dev_err (hub
->intfdev
,
2708 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2712 if (!hub_is_superspeed(hub
->hdev
))
2713 up_read(&ehci_cf_port_reset_rwsem
);
2718 /* Check if a port is power on */
2719 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2723 if (hub_is_superspeed(hub
->hdev
)) {
2724 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2727 if (portstatus
& USB_PORT_STAT_POWER
)
2736 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2737 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2741 if (hub_is_superspeed(hub
->hdev
)) {
2742 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2743 == USB_SS_PORT_LS_U3
)
2746 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2753 /* Determine whether the device on a port is ready for a normal resume,
2754 * is ready for a reset-resume, or should be disconnected.
2756 static int check_port_resume_type(struct usb_device
*udev
,
2757 struct usb_hub
*hub
, int port1
,
2758 int status
, unsigned portchange
, unsigned portstatus
)
2760 /* Is the device still present? */
2761 if (status
|| port_is_suspended(hub
, portstatus
) ||
2762 !port_is_power_on(hub
, portstatus
) ||
2763 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2768 /* Can't do a normal resume if the port isn't enabled,
2769 * so try a reset-resume instead.
2771 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2772 if (udev
->persist_enabled
)
2773 udev
->reset_resume
= 1;
2779 dev_dbg(hub
->intfdev
,
2780 "port %d status %04x.%04x after resume, %d\n",
2781 port1
, portchange
, portstatus
, status
);
2782 } else if (udev
->reset_resume
) {
2784 /* Late port handoff can set status-change bits */
2785 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2786 usb_clear_port_feature(hub
->hdev
, port1
,
2787 USB_PORT_FEAT_C_CONNECTION
);
2788 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2789 usb_clear_port_feature(hub
->hdev
, port1
,
2790 USB_PORT_FEAT_C_ENABLE
);
2796 int usb_disable_ltm(struct usb_device
*udev
)
2798 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2800 /* Check if the roothub and device supports LTM. */
2801 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2802 !usb_device_supports_ltm(udev
))
2805 /* Clear Feature LTM Enable can only be sent if the device is
2808 if (!udev
->actconfig
)
2811 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2812 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2813 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2814 USB_CTRL_SET_TIMEOUT
);
2816 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2818 void usb_enable_ltm(struct usb_device
*udev
)
2820 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2822 /* Check if the roothub and device supports LTM. */
2823 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2824 !usb_device_supports_ltm(udev
))
2827 /* Set Feature LTM Enable can only be sent if the device is
2830 if (!udev
->actconfig
)
2833 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2834 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2835 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2836 USB_CTRL_SET_TIMEOUT
);
2838 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2842 * usb_disable_function_remotewakeup - disable usb3.0
2843 * device's function remote wakeup
2844 * @udev: target device
2846 * Assume there's only one function on the USB 3.0
2847 * device and disable remote wake for the first
2848 * interface. FIXME if the interface association
2849 * descriptor shows there's more than one function.
2851 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2853 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2854 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2855 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2856 USB_CTRL_SET_TIMEOUT
);
2859 /* Count of wakeup-enabled devices at or below udev */
2860 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2862 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2864 return udev
->do_remote_wakeup
+
2865 (hub
? hub
->wakeup_enabled_descendants
: 0);
2869 * usb_port_suspend - suspend a usb device's upstream port
2870 * @udev: device that's no longer in active use, not a root hub
2871 * Context: must be able to sleep; device not locked; pm locks held
2873 * Suspends a USB device that isn't in active use, conserving power.
2874 * Devices may wake out of a suspend, if anything important happens,
2875 * using the remote wakeup mechanism. They may also be taken out of
2876 * suspend by the host, using usb_port_resume(). It's also routine
2877 * to disconnect devices while they are suspended.
2879 * This only affects the USB hardware for a device; its interfaces
2880 * (and, for hubs, child devices) must already have been suspended.
2882 * Selective port suspend reduces power; most suspended devices draw
2883 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2884 * All devices below the suspended port are also suspended.
2886 * Devices leave suspend state when the host wakes them up. Some devices
2887 * also support "remote wakeup", where the device can activate the USB
2888 * tree above them to deliver data, such as a keypress or packet. In
2889 * some cases, this wakes the USB host.
2891 * Suspending OTG devices may trigger HNP, if that's been enabled
2892 * between a pair of dual-role devices. That will change roles, such
2893 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2895 * Devices on USB hub ports have only one "suspend" state, corresponding
2896 * to ACPI D2, "may cause the device to lose some context".
2897 * State transitions include:
2899 * - suspend, resume ... when the VBUS power link stays live
2900 * - suspend, disconnect ... VBUS lost
2902 * Once VBUS drop breaks the circuit, the port it's using has to go through
2903 * normal re-enumeration procedures, starting with enabling VBUS power.
2904 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2905 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2906 * timer, no SRP, no requests through sysfs.
2908 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2909 * suspended until their bus goes into global suspend (i.e., the root
2910 * hub is suspended). Nevertheless, we change @udev->state to
2911 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2912 * upstream port setting is stored in @udev->port_is_suspended.
2914 * Returns 0 on success, else negative errno.
2916 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2918 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2919 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2920 int port1
= udev
->portnum
;
2922 bool really_suspend
= true;
2924 /* enable remote wakeup when appropriate; this lets the device
2925 * wake up the upstream hub (including maybe the root hub).
2927 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2928 * we don't explicitly enable it here.
2930 if (udev
->do_remote_wakeup
) {
2931 if (!hub_is_superspeed(hub
->hdev
)) {
2932 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2933 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2934 USB_DEVICE_REMOTE_WAKEUP
, 0,
2936 USB_CTRL_SET_TIMEOUT
);
2938 /* Assume there's only one function on the USB 3.0
2939 * device and enable remote wake for the first
2940 * interface. FIXME if the interface association
2941 * descriptor shows there's more than one function.
2943 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2944 USB_REQ_SET_FEATURE
,
2945 USB_RECIP_INTERFACE
,
2946 USB_INTRF_FUNC_SUSPEND
,
2947 USB_INTRF_FUNC_SUSPEND_RW
|
2948 USB_INTRF_FUNC_SUSPEND_LP
,
2950 USB_CTRL_SET_TIMEOUT
);
2953 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2955 /* bail if autosuspend is requested */
2956 if (PMSG_IS_AUTO(msg
))
2961 /* disable USB2 hardware LPM */
2962 if (udev
->usb2_hw_lpm_enabled
== 1)
2963 usb_set_usb2_hardware_lpm(udev
, 0);
2965 if (usb_disable_ltm(udev
)) {
2966 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
2968 if (PMSG_IS_AUTO(msg
))
2971 if (usb_unlocked_disable_lpm(udev
)) {
2972 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
2974 if (PMSG_IS_AUTO(msg
))
2979 if (hub_is_superspeed(hub
->hdev
))
2980 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
2983 * For system suspend, we do not need to enable the suspend feature
2984 * on individual USB-2 ports. The devices will automatically go
2985 * into suspend a few ms after the root hub stops sending packets.
2986 * The USB 2.0 spec calls this "global suspend".
2988 * However, many USB hubs have a bug: They don't relay wakeup requests
2989 * from a downstream port if the port's suspend feature isn't on.
2990 * Therefore we will turn on the suspend feature if udev or any of its
2991 * descendants is enabled for remote wakeup.
2993 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
2994 status
= set_port_feature(hub
->hdev
, port1
,
2995 USB_PORT_FEAT_SUSPEND
);
2997 really_suspend
= false;
3001 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3004 /* Try to enable USB3 LPM and LTM again */
3005 usb_unlocked_enable_lpm(udev
);
3007 usb_enable_ltm(udev
);
3009 /* Try to enable USB2 hardware LPM again */
3010 if (udev
->usb2_hw_lpm_capable
== 1)
3011 usb_set_usb2_hardware_lpm(udev
, 1);
3013 if (udev
->do_remote_wakeup
) {
3014 if (udev
->speed
< USB_SPEED_SUPER
)
3015 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3016 USB_REQ_CLEAR_FEATURE
,
3018 USB_DEVICE_REMOTE_WAKEUP
, 0,
3019 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3021 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3022 USB_REQ_CLEAR_FEATURE
,
3023 USB_RECIP_INTERFACE
,
3024 USB_INTRF_FUNC_SUSPEND
, 0,
3025 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3029 /* System sleep transitions should never fail */
3030 if (!PMSG_IS_AUTO(msg
))
3033 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3034 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3035 udev
->do_remote_wakeup
);
3036 if (really_suspend
) {
3037 udev
->port_is_suspended
= 1;
3039 /* device has up to 10 msec to fully suspend */
3042 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3045 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3046 pm_runtime_put_sync(&port_dev
->dev
);
3047 port_dev
->did_runtime_put
= true;
3050 usb_mark_last_busy(hub
->hdev
);
3055 * If the USB "suspend" state is in use (rather than "global suspend"),
3056 * many devices will be individually taken out of suspend state using
3057 * special "resume" signaling. This routine kicks in shortly after
3058 * hardware resume signaling is finished, either because of selective
3059 * resume (by host) or remote wakeup (by device) ... now see what changed
3060 * in the tree that's rooted at this device.
3062 * If @udev->reset_resume is set then the device is reset before the
3063 * status check is done.
3065 static int finish_port_resume(struct usb_device
*udev
)
3070 /* caller owns the udev device lock */
3071 dev_dbg(&udev
->dev
, "%s\n",
3072 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3074 /* usb ch9 identifies four variants of SUSPENDED, based on what
3075 * state the device resumes to. Linux currently won't see the
3076 * first two on the host side; they'd be inside hub_port_init()
3077 * during many timeouts, but khubd can't suspend until later.
3079 usb_set_device_state(udev
, udev
->actconfig
3080 ? USB_STATE_CONFIGURED
3081 : USB_STATE_ADDRESS
);
3083 /* 10.5.4.5 says not to reset a suspended port if the attached
3084 * device is enabled for remote wakeup. Hence the reset
3085 * operation is carried out here, after the port has been
3088 if (udev
->reset_resume
)
3090 status
= usb_reset_and_verify_device(udev
);
3092 /* 10.5.4.5 says be sure devices in the tree are still there.
3093 * For now let's assume the device didn't go crazy on resume,
3094 * and device drivers will know about any resume quirks.
3098 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3100 status
= (status
> 0 ? 0 : -ENODEV
);
3102 /* If a normal resume failed, try doing a reset-resume */
3103 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3104 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3105 udev
->reset_resume
= 1;
3106 goto retry_reset_resume
;
3111 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3114 * There are a few quirky devices which violate the standard
3115 * by claiming to have remote wakeup enabled after a reset,
3116 * which crash if the feature is cleared, hence check for
3117 * udev->reset_resume
3119 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3120 if (!hub_is_superspeed(udev
->parent
)) {
3121 le16_to_cpus(&devstatus
);
3122 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3123 status
= usb_control_msg(udev
,
3124 usb_sndctrlpipe(udev
, 0),
3125 USB_REQ_CLEAR_FEATURE
,
3127 USB_DEVICE_REMOTE_WAKEUP
, 0,
3129 USB_CTRL_SET_TIMEOUT
);
3131 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3133 le16_to_cpus(&devstatus
);
3134 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3135 | USB_INTRF_STAT_FUNC_RW
))
3137 usb_disable_function_remotewakeup(udev
);
3142 "disable remote wakeup, status %d\n",
3150 * usb_port_resume - re-activate a suspended usb device's upstream port
3151 * @udev: device to re-activate, not a root hub
3152 * Context: must be able to sleep; device not locked; pm locks held
3154 * This will re-activate the suspended device, increasing power usage
3155 * while letting drivers communicate again with its endpoints.
3156 * USB resume explicitly guarantees that the power session between
3157 * the host and the device is the same as it was when the device
3160 * If @udev->reset_resume is set then this routine won't check that the
3161 * port is still enabled. Furthermore, finish_port_resume() above will
3162 * reset @udev. The end result is that a broken power session can be
3163 * recovered and @udev will appear to persist across a loss of VBUS power.
3165 * For example, if a host controller doesn't maintain VBUS suspend current
3166 * during a system sleep or is reset when the system wakes up, all the USB
3167 * power sessions below it will be broken. This is especially troublesome
3168 * for mass-storage devices containing mounted filesystems, since the
3169 * device will appear to have disconnected and all the memory mappings
3170 * to it will be lost. Using the USB_PERSIST facility, the device can be
3171 * made to appear as if it had not disconnected.
3173 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3174 * every effort to insure that the same device is present after the
3175 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3176 * quite possible for a device to remain unaltered but its media to be
3177 * changed. If the user replaces a flash memory card while the system is
3178 * asleep, he will have only himself to blame when the filesystem on the
3179 * new card is corrupted and the system crashes.
3181 * Returns 0 on success, else negative errno.
3183 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3185 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3186 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3187 int port1
= udev
->portnum
;
3189 u16 portchange
, portstatus
;
3191 if (port_dev
->did_runtime_put
) {
3192 status
= pm_runtime_get_sync(&port_dev
->dev
);
3193 port_dev
->did_runtime_put
= false;
3195 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3201 /* Skip the initial Clear-Suspend step for a remote wakeup */
3202 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3203 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3204 goto SuspendCleared
;
3206 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3208 set_bit(port1
, hub
->busy_bits
);
3210 /* see 7.1.7.7; affects power usage, but not budgeting */
3211 if (hub_is_superspeed(hub
->hdev
))
3212 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3214 status
= usb_clear_port_feature(hub
->hdev
,
3215 port1
, USB_PORT_FEAT_SUSPEND
);
3217 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3220 /* drive resume for at least 20 msec */
3221 dev_dbg(&udev
->dev
, "usb %sresume\n",
3222 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3225 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3226 * stop resume signaling. Then finish the resume
3229 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3231 /* TRSMRCY = 10 msec */
3237 udev
->port_is_suspended
= 0;
3238 if (hub_is_superspeed(hub
->hdev
)) {
3239 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3240 usb_clear_port_feature(hub
->hdev
, port1
,
3241 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3243 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3244 usb_clear_port_feature(hub
->hdev
, port1
,
3245 USB_PORT_FEAT_C_SUSPEND
);
3249 clear_bit(port1
, hub
->busy_bits
);
3251 status
= check_port_resume_type(udev
,
3252 hub
, port1
, status
, portchange
, portstatus
);
3254 status
= finish_port_resume(udev
);
3256 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3257 hub_port_logical_disconnect(hub
, port1
);
3259 /* Try to enable USB2 hardware LPM */
3260 if (udev
->usb2_hw_lpm_capable
== 1)
3261 usb_set_usb2_hardware_lpm(udev
, 1);
3263 /* Try to enable USB3 LTM and LPM */
3264 usb_enable_ltm(udev
);
3265 usb_unlocked_enable_lpm(udev
);
3271 #endif /* CONFIG_PM */
3273 #ifdef CONFIG_PM_RUNTIME
3275 /* caller has locked udev */
3276 int usb_remote_wakeup(struct usb_device
*udev
)
3280 if (udev
->state
== USB_STATE_SUSPENDED
) {
3281 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3282 status
= usb_autoresume_device(udev
);
3284 /* Let the drivers do their thing, then... */
3285 usb_autosuspend_device(udev
);
3293 static int check_ports_changed(struct usb_hub
*hub
)
3297 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3298 u16 portstatus
, portchange
;
3301 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3302 if (!status
&& portchange
)
3308 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3310 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3311 struct usb_device
*hdev
= hub
->hdev
;
3316 * Warn if children aren't already suspended.
3317 * Also, add up the number of wakeup-enabled descendants.
3319 hub
->wakeup_enabled_descendants
= 0;
3320 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3321 struct usb_device
*udev
;
3323 udev
= hub
->ports
[port1
- 1]->child
;
3324 if (udev
&& udev
->can_submit
) {
3325 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3326 if (PMSG_IS_AUTO(msg
))
3330 hub
->wakeup_enabled_descendants
+=
3331 wakeup_enabled_descendants(udev
);
3334 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3335 /* check if there are changes pending on hub ports */
3336 if (check_ports_changed(hub
)) {
3337 if (PMSG_IS_AUTO(msg
))
3339 pm_wakeup_event(&hdev
->dev
, 2000);
3343 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3344 /* Enable hub to send remote wakeup for all ports. */
3345 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3346 status
= set_port_feature(hdev
,
3348 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3349 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3350 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3351 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3355 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3357 /* stop khubd and related activity */
3358 hub_quiesce(hub
, HUB_SUSPEND
);
3362 static int hub_resume(struct usb_interface
*intf
)
3364 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3366 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3367 hub_activate(hub
, HUB_RESUME
);
3371 static int hub_reset_resume(struct usb_interface
*intf
)
3373 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3375 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3376 hub_activate(hub
, HUB_RESET_RESUME
);
3381 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3382 * @rhdev: struct usb_device for the root hub
3384 * The USB host controller driver calls this function when its root hub
3385 * is resumed and Vbus power has been interrupted or the controller
3386 * has been reset. The routine marks @rhdev as having lost power.
3387 * When the hub driver is resumed it will take notice and carry out
3388 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3389 * the others will be disconnected.
3391 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3393 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3394 rhdev
->reset_resume
= 1;
3396 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3398 static const char * const usb3_lpm_names
[] = {
3406 * Send a Set SEL control transfer to the device, prior to enabling
3407 * device-initiated U1 or U2. This lets the device know the exit latencies from
3408 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3409 * packet from the host.
3411 * This function will fail if the SEL or PEL values for udev are greater than
3412 * the maximum allowed values for the link state to be enabled.
3414 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3416 struct usb_set_sel_req
*sel_values
;
3417 unsigned long long u1_sel
;
3418 unsigned long long u1_pel
;
3419 unsigned long long u2_sel
;
3420 unsigned long long u2_pel
;
3423 /* Convert SEL and PEL stored in ns to us */
3424 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3425 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3426 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3427 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3430 * Make sure that the calculated SEL and PEL values for the link
3431 * state we're enabling aren't bigger than the max SEL/PEL
3432 * value that will fit in the SET SEL control transfer.
3433 * Otherwise the device would get an incorrect idea of the exit
3434 * latency for the link state, and could start a device-initiated
3435 * U1/U2 when the exit latencies are too high.
3437 if ((state
== USB3_LPM_U1
&&
3438 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3439 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3440 (state
== USB3_LPM_U2
&&
3441 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3442 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3443 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3444 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3449 * If we're enabling device-initiated LPM for one link state,
3450 * but the other link state has a too high SEL or PEL value,
3451 * just set those values to the max in the Set SEL request.
3453 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3454 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3456 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3457 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3459 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3460 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3462 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3463 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3466 * usb_enable_lpm() can be called as part of a failed device reset,
3467 * which may be initiated by an error path of a mass storage driver.
3468 * Therefore, use GFP_NOIO.
3470 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3474 sel_values
->u1_sel
= u1_sel
;
3475 sel_values
->u1_pel
= u1_pel
;
3476 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3477 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3479 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3483 sel_values
, sizeof *(sel_values
),
3484 USB_CTRL_SET_TIMEOUT
);
3490 * Enable or disable device-initiated U1 or U2 transitions.
3492 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3493 enum usb3_link_state state
, bool enable
)
3500 feature
= USB_DEVICE_U1_ENABLE
;
3503 feature
= USB_DEVICE_U2_ENABLE
;
3506 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3507 __func__
, enable
? "enable" : "disable");
3511 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3512 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3513 "for unconfigured device.\n",
3514 __func__
, enable
? "enable" : "disable",
3515 usb3_lpm_names
[state
]);
3521 * Now send the control transfer to enable device-initiated LPM
3522 * for either U1 or U2.
3524 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3525 USB_REQ_SET_FEATURE
,
3529 USB_CTRL_SET_TIMEOUT
);
3531 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3532 USB_REQ_CLEAR_FEATURE
,
3536 USB_CTRL_SET_TIMEOUT
);
3539 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3540 enable
? "Enable" : "Disable",
3541 usb3_lpm_names
[state
]);
3547 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3548 enum usb3_link_state state
, int timeout
)
3555 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3558 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3561 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3566 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3567 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3568 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3569 "which is a reserved value.\n",
3570 usb3_lpm_names
[state
], timeout
);
3574 ret
= set_port_feature(udev
->parent
,
3575 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3578 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3579 "error code %i\n", usb3_lpm_names
[state
],
3583 if (state
== USB3_LPM_U1
)
3584 udev
->u1_params
.timeout
= timeout
;
3586 udev
->u2_params
.timeout
= timeout
;
3591 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3594 * We will attempt to enable U1 or U2, but there are no guarantees that the
3595 * control transfers to set the hub timeout or enable device-initiated U1/U2
3596 * will be successful.
3598 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3599 * driver know about it. If that call fails, it should be harmless, and just
3600 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3602 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3603 enum usb3_link_state state
)
3606 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3607 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3609 /* If the device says it doesn't have *any* exit latency to come out of
3610 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3613 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3614 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3618 * First, let the device know about the exit latencies
3619 * associated with the link state we're about to enable.
3621 ret
= usb_req_set_sel(udev
, state
);
3623 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3624 usb3_lpm_names
[state
]);
3628 /* We allow the host controller to set the U1/U2 timeout internally
3629 * first, so that it can change its schedule to account for the
3630 * additional latency to send data to a device in a lower power
3633 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3635 /* xHCI host controller doesn't want to enable this LPM state. */
3640 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3641 "xHCI error %i.\n", usb3_lpm_names
[state
],
3646 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3647 /* If we can't set the parent hub U1/U2 timeout,
3648 * device-initiated LPM won't be allowed either, so let the xHCI
3649 * host know that this link state won't be enabled.
3651 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3653 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3654 else if (udev
->actconfig
)
3655 usb_set_device_initiated_lpm(udev
, state
, true);
3660 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3663 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3664 * If zero is returned, the parent will not allow the link to go into U1/U2.
3666 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3667 * it won't have an effect on the bus link state because the parent hub will
3668 * still disallow device-initiated U1/U2 entry.
3670 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3671 * possible. The result will be slightly more bus bandwidth will be taken up
3672 * (to account for U1/U2 exit latency), but it should be harmless.
3674 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3675 enum usb3_link_state state
)
3681 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3684 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3687 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3692 if (usb_set_lpm_timeout(udev
, state
, 0))
3695 usb_set_device_initiated_lpm(udev
, state
, false);
3697 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3698 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3699 "bus schedule bandwidth may be impacted.\n",
3700 usb3_lpm_names
[state
]);
3705 * Disable hub-initiated and device-initiated U1 and U2 entry.
3706 * Caller must own the bandwidth_mutex.
3708 * This will call usb_enable_lpm() on failure, which will decrement
3709 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3711 int usb_disable_lpm(struct usb_device
*udev
)
3713 struct usb_hcd
*hcd
;
3715 if (!udev
|| !udev
->parent
||
3716 udev
->speed
!= USB_SPEED_SUPER
||
3720 hcd
= bus_to_hcd(udev
->bus
);
3721 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3724 udev
->lpm_disable_count
++;
3725 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3728 /* If LPM is enabled, attempt to disable it. */
3729 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3731 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3737 usb_enable_lpm(udev
);
3740 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3742 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3743 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3745 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3751 mutex_lock(hcd
->bandwidth_mutex
);
3752 ret
= usb_disable_lpm(udev
);
3753 mutex_unlock(hcd
->bandwidth_mutex
);
3757 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3760 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3761 * xHCI host policy may prevent U1 or U2 from being enabled.
3763 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3764 * until the lpm_disable_count drops to zero. Caller must own the
3767 void usb_enable_lpm(struct usb_device
*udev
)
3769 struct usb_hcd
*hcd
;
3771 if (!udev
|| !udev
->parent
||
3772 udev
->speed
!= USB_SPEED_SUPER
||
3776 udev
->lpm_disable_count
--;
3777 hcd
= bus_to_hcd(udev
->bus
);
3778 /* Double check that we can both enable and disable LPM.
3779 * Device must be configured to accept set feature U1/U2 timeout.
3781 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3782 !hcd
->driver
->disable_usb3_lpm_timeout
)
3785 if (udev
->lpm_disable_count
> 0)
3788 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3789 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3791 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3793 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3794 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3796 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3801 mutex_lock(hcd
->bandwidth_mutex
);
3802 usb_enable_lpm(udev
);
3803 mutex_unlock(hcd
->bandwidth_mutex
);
3805 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3808 #else /* CONFIG_PM */
3810 #define hub_suspend NULL
3811 #define hub_resume NULL
3812 #define hub_reset_resume NULL
3814 int usb_disable_lpm(struct usb_device
*udev
)
3818 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3820 void usb_enable_lpm(struct usb_device
*udev
) { }
3821 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3823 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3827 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3829 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3830 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3832 int usb_disable_ltm(struct usb_device
*udev
)
3836 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3838 void usb_enable_ltm(struct usb_device
*udev
) { }
3839 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3843 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3845 * Between connect detection and reset signaling there must be a delay
3846 * of 100ms at least for debounce and power-settling. The corresponding
3847 * timer shall restart whenever the downstream port detects a disconnect.
3849 * Apparently there are some bluetooth and irda-dongles and a number of
3850 * low-speed devices for which this debounce period may last over a second.
3851 * Not covered by the spec - but easy to deal with.
3853 * This implementation uses a 1500ms total debounce timeout; if the
3854 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3855 * every 25ms for transient disconnects. When the port status has been
3856 * unchanged for 100ms it returns the port status.
3858 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3861 int total_time
, stable_time
= 0;
3862 u16 portchange
, portstatus
;
3863 unsigned connection
= 0xffff;
3865 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3866 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3870 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3871 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3872 if (!must_be_connected
||
3873 (connection
== USB_PORT_STAT_CONNECTION
))
3874 stable_time
+= HUB_DEBOUNCE_STEP
;
3875 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3879 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3882 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3883 usb_clear_port_feature(hub
->hdev
, port1
,
3884 USB_PORT_FEAT_C_CONNECTION
);
3887 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3889 msleep(HUB_DEBOUNCE_STEP
);
3892 dev_dbg (hub
->intfdev
,
3893 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3894 port1
, total_time
, stable_time
, portstatus
);
3896 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3901 void usb_ep0_reinit(struct usb_device
*udev
)
3903 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3904 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3905 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3907 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3909 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3910 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3912 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3915 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3918 * The host controller will choose the device address,
3919 * instead of the core having chosen it earlier
3921 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3923 if (udev
->state
== USB_STATE_ADDRESS
)
3925 if (udev
->state
!= USB_STATE_DEFAULT
)
3927 if (hcd
->driver
->address_device
)
3928 retval
= hcd
->driver
->address_device(hcd
, udev
);
3930 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3931 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3932 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3934 update_devnum(udev
, devnum
);
3935 /* Device now using proper address. */
3936 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3937 usb_ep0_reinit(udev
);
3942 /* Reset device, (re)assign address, get device descriptor.
3943 * Device connection must be stable, no more debouncing needed.
3944 * Returns device in USB_STATE_ADDRESS, except on error.
3946 * If this is called for an already-existing device (as part of
3947 * usb_reset_and_verify_device), the caller must own the device lock. For a
3948 * newly detected device that is not accessible through any global
3949 * pointers, it's not necessary to lock the device.
3952 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
3955 static DEFINE_MUTEX(usb_address0_mutex
);
3957 struct usb_device
*hdev
= hub
->hdev
;
3958 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3960 unsigned delay
= HUB_SHORT_RESET_TIME
;
3961 enum usb_device_speed oldspeed
= udev
->speed
;
3963 int devnum
= udev
->devnum
;
3965 /* root hub ports have a slightly longer reset period
3966 * (from USB 2.0 spec, section 7.1.7.5)
3968 if (!hdev
->parent
) {
3969 delay
= HUB_ROOT_RESET_TIME
;
3970 if (port1
== hdev
->bus
->otg_port
)
3971 hdev
->bus
->b_hnp_enable
= 0;
3974 /* Some low speed devices have problems with the quick delay, so */
3975 /* be a bit pessimistic with those devices. RHbug #23670 */
3976 if (oldspeed
== USB_SPEED_LOW
)
3977 delay
= HUB_LONG_RESET_TIME
;
3979 mutex_lock(&usb_address0_mutex
);
3981 /* Reset the device; full speed may morph to high speed */
3982 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3983 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
3984 if (retval
< 0) /* error or disconnect */
3986 /* success, speed is known */
3990 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
3991 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
3994 oldspeed
= udev
->speed
;
3996 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3997 * it's fixed size except for full speed devices.
3998 * For Wireless USB devices, ep0 max packet is always 512 (tho
3999 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4001 switch (udev
->speed
) {
4002 case USB_SPEED_SUPER
:
4003 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4004 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4006 case USB_SPEED_HIGH
: /* fixed at 64 */
4007 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4009 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4010 /* to determine the ep0 maxpacket size, try to read
4011 * the device descriptor to get bMaxPacketSize0 and
4012 * then correct our initial guess.
4014 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4016 case USB_SPEED_LOW
: /* fixed at 8 */
4017 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4023 if (udev
->speed
== USB_SPEED_WIRELESS
)
4024 speed
= "variable speed Wireless";
4026 speed
= usb_speed_string(udev
->speed
);
4028 if (udev
->speed
!= USB_SPEED_SUPER
)
4029 dev_info(&udev
->dev
,
4030 "%s %s USB device number %d using %s\n",
4031 (udev
->config
) ? "reset" : "new", speed
,
4032 devnum
, udev
->bus
->controller
->driver
->name
);
4034 /* Set up TT records, if needed */
4036 udev
->tt
= hdev
->tt
;
4037 udev
->ttport
= hdev
->ttport
;
4038 } else if (udev
->speed
!= USB_SPEED_HIGH
4039 && hdev
->speed
== USB_SPEED_HIGH
) {
4041 dev_err(&udev
->dev
, "parent hub has no TT\n");
4045 udev
->tt
= &hub
->tt
;
4046 udev
->ttport
= port1
;
4049 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4050 * Because device hardware and firmware is sometimes buggy in
4051 * this area, and this is how Linux has done it for ages.
4052 * Change it cautiously.
4054 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4055 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4056 * so it may help with some non-standards-compliant devices.
4057 * Otherwise we start with SET_ADDRESS and then try to read the
4058 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4061 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4062 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4063 struct usb_device_descriptor
*buf
;
4066 #define GET_DESCRIPTOR_BUFSIZE 64
4067 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4073 /* Retry on all errors; some devices are flakey.
4074 * 255 is for WUSB devices, we actually need to use
4075 * 512 (WUSB1.0[4.8.1]).
4077 for (j
= 0; j
< 3; ++j
) {
4078 buf
->bMaxPacketSize0
= 0;
4079 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4080 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4081 USB_DT_DEVICE
<< 8, 0,
4082 buf
, GET_DESCRIPTOR_BUFSIZE
,
4083 initial_descriptor_timeout
);
4084 switch (buf
->bMaxPacketSize0
) {
4085 case 8: case 16: case 32: case 64: case 255:
4086 if (buf
->bDescriptorType
==
4100 udev
->descriptor
.bMaxPacketSize0
=
4101 buf
->bMaxPacketSize0
;
4104 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4105 if (retval
< 0) /* error or disconnect */
4107 if (oldspeed
!= udev
->speed
) {
4109 "device reset changed speed!\n");
4115 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4120 #undef GET_DESCRIPTOR_BUFSIZE
4124 * If device is WUSB, we already assigned an
4125 * unauthorized address in the Connect Ack sequence;
4126 * authorization will assign the final address.
4128 if (udev
->wusb
== 0) {
4129 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4130 retval
= hub_set_address(udev
, devnum
);
4136 if (retval
!= -ENODEV
)
4137 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4141 if (udev
->speed
== USB_SPEED_SUPER
) {
4142 devnum
= udev
->devnum
;
4143 dev_info(&udev
->dev
,
4144 "%s SuperSpeed USB device number %d using %s\n",
4145 (udev
->config
) ? "reset" : "new",
4146 devnum
, udev
->bus
->controller
->driver
->name
);
4149 /* cope with hardware quirkiness:
4150 * - let SET_ADDRESS settle, some device hardware wants it
4151 * - read ep0 maxpacket even for high and low speed,
4154 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4158 retval
= usb_get_device_descriptor(udev
, 8);
4160 if (retval
!= -ENODEV
)
4162 "device descriptor read/8, error %d\n",
4174 if (hcd
->phy
&& !hdev
->parent
)
4175 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4178 * Some superspeed devices have finished the link training process
4179 * and attached to a superspeed hub port, but the device descriptor
4180 * got from those devices show they aren't superspeed devices. Warm
4181 * reset the port attached by the devices can fix them.
4183 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4184 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4185 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4186 "warm reset device\n");
4187 hub_port_reset(hub
, port1
, udev
,
4188 HUB_BH_RESET_TIME
, true);
4193 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4194 udev
->speed
== USB_SPEED_SUPER
)
4197 i
= udev
->descriptor
.bMaxPacketSize0
;
4198 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4199 if (udev
->speed
== USB_SPEED_LOW
||
4200 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4201 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4205 if (udev
->speed
== USB_SPEED_FULL
)
4206 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4208 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4209 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4210 usb_ep0_reinit(udev
);
4213 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4214 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4215 if (retval
!= -ENODEV
)
4216 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4223 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4224 retval
= usb_get_bos_descriptor(udev
);
4226 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4227 usb_set_lpm_parameters(udev
);
4232 /* notify HCD that we have a device connected and addressed */
4233 if (hcd
->driver
->update_device
)
4234 hcd
->driver
->update_device(hcd
, udev
);
4237 hub_port_disable(hub
, port1
, 0);
4238 update_devnum(udev
, devnum
); /* for disconnect processing */
4240 mutex_unlock(&usb_address0_mutex
);
4245 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4247 struct usb_qualifier_descriptor
*qual
;
4250 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4254 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4255 qual
, sizeof *qual
);
4256 if (status
== sizeof *qual
) {
4257 dev_info(&udev
->dev
, "not running at top speed; "
4258 "connect to a high speed hub\n");
4259 /* hub LEDs are probably harder to miss than syslog */
4260 if (hub
->has_indicators
) {
4261 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4262 schedule_delayed_work (&hub
->leds
, 0);
4269 hub_power_remaining (struct usb_hub
*hub
)
4271 struct usb_device
*hdev
= hub
->hdev
;
4275 if (!hub
->limited_power
)
4278 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4279 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4280 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4286 if (hub_is_superspeed(udev
))
4292 * Unconfigured devices may not use more than one unit load,
4293 * or 8mA for OTG ports
4295 if (udev
->actconfig
)
4296 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4297 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4301 if (delta
> hub
->mA_per_port
)
4302 dev_warn(&udev
->dev
,
4303 "%dmA is over %umA budget for port %d!\n",
4304 delta
, hub
->mA_per_port
, port1
);
4307 if (remaining
< 0) {
4308 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4315 /* Handle physical or logical connection change events.
4316 * This routine is called when:
4317 * a port connection-change occurs;
4318 * a port enable-change occurs (often caused by EMI);
4319 * usb_reset_and_verify_device() encounters changed descriptors (as from
4320 * a firmware download)
4321 * caller already locked the hub
4323 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4324 u16 portstatus
, u16 portchange
)
4326 struct usb_device
*hdev
= hub
->hdev
;
4327 struct device
*hub_dev
= hub
->intfdev
;
4328 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4329 unsigned wHubCharacteristics
=
4330 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4331 struct usb_device
*udev
;
4336 "port %d, status %04x, change %04x, %s\n",
4337 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4339 if (hub
->has_indicators
) {
4340 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4341 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4344 #ifdef CONFIG_USB_OTG
4345 /* during HNP, don't repeat the debounce */
4346 if (hdev
->bus
->is_b_host
)
4347 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4348 USB_PORT_STAT_C_ENABLE
);
4351 /* Try to resuscitate an existing device */
4352 udev
= hub
->ports
[port1
- 1]->child
;
4353 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4354 udev
->state
!= USB_STATE_NOTATTACHED
) {
4355 usb_lock_device(udev
);
4356 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4357 status
= 0; /* Nothing to do */
4359 #ifdef CONFIG_PM_RUNTIME
4360 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4361 udev
->persist_enabled
) {
4362 /* For a suspended device, treat this as a
4363 * remote wakeup event.
4365 status
= usb_remote_wakeup(udev
);
4369 status
= -ENODEV
; /* Don't resuscitate */
4371 usb_unlock_device(udev
);
4374 clear_bit(port1
, hub
->change_bits
);
4379 /* Disconnect any existing devices under this port */
4381 if (hcd
->phy
&& !hdev
->parent
&&
4382 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4383 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4384 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4386 clear_bit(port1
, hub
->change_bits
);
4388 /* We can forget about a "removed" device when there's a physical
4389 * disconnect or the connect status changes.
4391 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4392 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4393 clear_bit(port1
, hub
->removed_bits
);
4395 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4396 USB_PORT_STAT_C_ENABLE
)) {
4397 status
= hub_port_debounce_be_stable(hub
, port1
);
4399 if (status
!= -ENODEV
&& printk_ratelimit())
4400 dev_err(hub_dev
, "connect-debounce failed, "
4401 "port %d disabled\n", port1
);
4402 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4404 portstatus
= status
;
4408 /* Return now if debouncing failed or nothing is connected or
4409 * the device was "removed".
4411 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4412 test_bit(port1
, hub
->removed_bits
)) {
4414 /* maybe switch power back on (e.g. root hub was reset) */
4415 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4416 && !port_is_power_on(hub
, portstatus
))
4417 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4419 if (portstatus
& USB_PORT_STAT_ENABLE
)
4423 if (hub_is_superspeed(hub
->hdev
))
4429 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4431 /* reallocate for each attempt, since references
4432 * to the previous one can escape in various ways
4434 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4437 "couldn't allocate port %d usb_device\n",
4442 usb_set_device_state(udev
, USB_STATE_POWERED
);
4443 udev
->bus_mA
= hub
->mA_per_port
;
4444 udev
->level
= hdev
->level
+ 1;
4445 udev
->wusb
= hub_is_wusb(hub
);
4447 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4448 if (hub_is_superspeed(hub
->hdev
))
4449 udev
->speed
= USB_SPEED_SUPER
;
4451 udev
->speed
= USB_SPEED_UNKNOWN
;
4453 choose_devnum(udev
);
4454 if (udev
->devnum
<= 0) {
4455 status
= -ENOTCONN
; /* Don't retry */
4459 /* reset (non-USB 3.0 devices) and get descriptor */
4460 status
= hub_port_init(hub
, udev
, port1
, i
);
4464 usb_detect_quirks(udev
);
4465 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4468 /* consecutive bus-powered hubs aren't reliable; they can
4469 * violate the voltage drop budget. if the new child has
4470 * a "powered" LED, users should notice we didn't enable it
4471 * (without reading syslog), even without per-port LEDs
4474 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4475 && udev
->bus_mA
<= unit_load
) {
4478 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4481 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4484 le16_to_cpus(&devstat
);
4485 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4487 "can't connect bus-powered hub "
4489 if (hub
->has_indicators
) {
4490 hub
->indicator
[port1
-1] =
4491 INDICATOR_AMBER_BLINK
;
4492 schedule_delayed_work (&hub
->leds
, 0);
4494 status
= -ENOTCONN
; /* Don't retry */
4499 /* check for devices running slower than they could */
4500 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4501 && udev
->speed
== USB_SPEED_FULL
4502 && highspeed_hubs
!= 0)
4503 check_highspeed (hub
, udev
, port1
);
4505 /* Store the parent's children[] pointer. At this point
4506 * udev becomes globally accessible, although presumably
4507 * no one will look at it until hdev is unlocked.
4511 /* We mustn't add new devices if the parent hub has
4512 * been disconnected; we would race with the
4513 * recursively_mark_NOTATTACHED() routine.
4515 spin_lock_irq(&device_state_lock
);
4516 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4519 hub
->ports
[port1
- 1]->child
= udev
;
4520 spin_unlock_irq(&device_state_lock
);
4522 /* Run it through the hoops (find a driver, etc) */
4524 status
= usb_new_device(udev
);
4526 spin_lock_irq(&device_state_lock
);
4527 hub
->ports
[port1
- 1]->child
= NULL
;
4528 spin_unlock_irq(&device_state_lock
);
4535 status
= hub_power_remaining(hub
);
4537 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4542 hub_port_disable(hub
, port1
, 1);
4544 usb_ep0_reinit(udev
);
4545 release_devnum(udev
);
4548 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4551 if (hub
->hdev
->parent
||
4552 !hcd
->driver
->port_handed_over
||
4553 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4554 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4555 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4560 hub_port_disable(hub
, port1
, 1);
4561 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4562 hcd
->driver
->relinquish_port(hcd
, port1
);
4565 /* Returns 1 if there was a remote wakeup and a connect status change. */
4566 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4567 u16 portstatus
, u16 portchange
)
4569 struct usb_device
*hdev
;
4570 struct usb_device
*udev
;
4571 int connect_change
= 0;
4575 udev
= hub
->ports
[port
- 1]->child
;
4576 if (!hub_is_superspeed(hdev
)) {
4577 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4579 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4581 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4582 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4588 /* TRSMRCY = 10 msec */
4591 usb_lock_device(udev
);
4592 ret
= usb_remote_wakeup(udev
);
4593 usb_unlock_device(udev
);
4598 hub_port_disable(hub
, port
, 1);
4600 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4602 return connect_change
;
4605 static void hub_events(void)
4607 struct list_head
*tmp
;
4608 struct usb_device
*hdev
;
4609 struct usb_interface
*intf
;
4610 struct usb_hub
*hub
;
4611 struct device
*hub_dev
;
4617 int connect_change
, wakeup_change
;
4620 * We restart the list every time to avoid a deadlock with
4621 * deleting hubs downstream from this one. This should be
4622 * safe since we delete the hub from the event list.
4623 * Not the most efficient, but avoids deadlocks.
4627 /* Grab the first entry at the beginning of the list */
4628 spin_lock_irq(&hub_event_lock
);
4629 if (list_empty(&hub_event_list
)) {
4630 spin_unlock_irq(&hub_event_lock
);
4634 tmp
= hub_event_list
.next
;
4637 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4638 kref_get(&hub
->kref
);
4639 spin_unlock_irq(&hub_event_lock
);
4642 hub_dev
= hub
->intfdev
;
4643 intf
= to_usb_interface(hub_dev
);
4644 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4645 hdev
->state
, hub
->descriptor
4646 ? hub
->descriptor
->bNbrPorts
4648 /* NOTE: expects max 15 ports... */
4649 (u16
) hub
->change_bits
[0],
4650 (u16
) hub
->event_bits
[0]);
4652 /* Lock the device, then check to see if we were
4653 * disconnected while waiting for the lock to succeed. */
4654 usb_lock_device(hdev
);
4655 if (unlikely(hub
->disconnected
))
4656 goto loop_disconnected
;
4658 /* If the hub has died, clean up after it */
4659 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4660 hub
->error
= -ENODEV
;
4661 hub_quiesce(hub
, HUB_DISCONNECT
);
4666 ret
= usb_autopm_get_interface(intf
);
4668 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4672 /* If this is an inactive hub, do nothing */
4677 dev_dbg (hub_dev
, "resetting for error %d\n",
4680 ret
= usb_reset_device(hdev
);
4683 "error resetting hub: %d\n", ret
);
4691 /* deal with port status changes */
4692 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4693 if (test_bit(i
, hub
->busy_bits
))
4695 connect_change
= test_bit(i
, hub
->change_bits
);
4696 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4697 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4698 !connect_change
&& !wakeup_change
)
4701 ret
= hub_port_status(hub
, i
,
4702 &portstatus
, &portchange
);
4706 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4707 usb_clear_port_feature(hdev
, i
,
4708 USB_PORT_FEAT_C_CONNECTION
);
4712 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4713 if (!connect_change
)
4715 "port %d enable change, "
4718 usb_clear_port_feature(hdev
, i
,
4719 USB_PORT_FEAT_C_ENABLE
);
4722 * EM interference sometimes causes badly
4723 * shielded USB devices to be shutdown by
4724 * the hub, this hack enables them again.
4725 * Works at least with mouse driver.
4727 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4729 && hub
->ports
[i
- 1]->child
) {
4732 "disabled by hub (EMI?), "
4739 if (hub_handle_remote_wakeup(hub
, i
,
4740 portstatus
, portchange
))
4743 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4747 dev_dbg(hub_dev
, "over-current change on port "
4749 usb_clear_port_feature(hdev
, i
,
4750 USB_PORT_FEAT_C_OVER_CURRENT
);
4751 msleep(100); /* Cool down */
4752 hub_power_on(hub
, true);
4753 hub_port_status(hub
, i
, &status
, &unused
);
4754 if (status
& USB_PORT_STAT_OVERCURRENT
)
4755 dev_err(hub_dev
, "over-current "
4756 "condition on port %d\n", i
);
4759 if (portchange
& USB_PORT_STAT_C_RESET
) {
4761 "reset change on port %d\n",
4763 usb_clear_port_feature(hdev
, i
,
4764 USB_PORT_FEAT_C_RESET
);
4766 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4767 hub_is_superspeed(hub
->hdev
)) {
4769 "warm reset change on port %d\n",
4771 usb_clear_port_feature(hdev
, i
,
4772 USB_PORT_FEAT_C_BH_PORT_RESET
);
4774 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4775 usb_clear_port_feature(hub
->hdev
, i
,
4776 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4778 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4780 "config error on port %d\n",
4782 usb_clear_port_feature(hub
->hdev
, i
,
4783 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4786 /* Warm reset a USB3 protocol port if it's in
4787 * SS.Inactive state.
4789 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4791 struct usb_device
*udev
=
4792 hub
->ports
[i
- 1]->child
;
4794 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4795 if (!udev
|| !(portstatus
&
4796 USB_PORT_STAT_CONNECTION
)) {
4797 status
= hub_port_reset(hub
, i
,
4798 NULL
, HUB_BH_RESET_TIME
,
4801 hub_port_disable(hub
, i
, 1);
4803 usb_lock_device(udev
);
4804 status
= usb_reset_device(udev
);
4805 usb_unlock_device(udev
);
4811 hub_port_connect_change(hub
, i
,
4812 portstatus
, portchange
);
4815 /* deal with hub status changes */
4816 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4818 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4819 dev_err (hub_dev
, "get_hub_status failed\n");
4821 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4822 dev_dbg (hub_dev
, "power change\n");
4823 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4824 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4825 /* FIXME: Is this always true? */
4826 hub
->limited_power
= 1;
4828 hub
->limited_power
= 0;
4830 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4834 dev_dbg(hub_dev
, "over-current change\n");
4835 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4836 msleep(500); /* Cool down */
4837 hub_power_on(hub
, true);
4838 hub_hub_status(hub
, &status
, &unused
);
4839 if (status
& HUB_STATUS_OVERCURRENT
)
4840 dev_err(hub_dev
, "over-current "
4846 /* Balance the usb_autopm_get_interface() above */
4847 usb_autopm_put_interface_no_suspend(intf
);
4849 /* Balance the usb_autopm_get_interface_no_resume() in
4850 * kick_khubd() and allow autosuspend.
4852 usb_autopm_put_interface(intf
);
4854 usb_unlock_device(hdev
);
4855 kref_put(&hub
->kref
, hub_release
);
4857 } /* end while (1) */
4860 static int hub_thread(void *__unused
)
4862 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4863 * port handover. Otherwise it might see that a full-speed device
4864 * was gone before the EHCI controller had handed its port over to
4865 * the companion full-speed controller.
4871 wait_event_freezable(khubd_wait
,
4872 !list_empty(&hub_event_list
) ||
4873 kthread_should_stop());
4874 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4876 pr_debug("%s: khubd exiting\n", usbcore_name
);
4880 static const struct usb_device_id hub_id_table
[] = {
4881 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4882 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4883 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4884 .bInterfaceClass
= USB_CLASS_HUB
,
4885 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4886 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4887 .bDeviceClass
= USB_CLASS_HUB
},
4888 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4889 .bInterfaceClass
= USB_CLASS_HUB
},
4890 { } /* Terminating entry */
4893 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4895 static struct usb_driver hub_driver
= {
4898 .disconnect
= hub_disconnect
,
4899 .suspend
= hub_suspend
,
4900 .resume
= hub_resume
,
4901 .reset_resume
= hub_reset_resume
,
4902 .pre_reset
= hub_pre_reset
,
4903 .post_reset
= hub_post_reset
,
4904 .unlocked_ioctl
= hub_ioctl
,
4905 .id_table
= hub_id_table
,
4906 .supports_autosuspend
= 1,
4909 int usb_hub_init(void)
4911 if (usb_register(&hub_driver
) < 0) {
4912 printk(KERN_ERR
"%s: can't register hub driver\n",
4917 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4918 if (!IS_ERR(khubd_task
))
4921 /* Fall through if kernel_thread failed */
4922 usb_deregister(&hub_driver
);
4923 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4928 void usb_hub_cleanup(void)
4930 kthread_stop(khubd_task
);
4933 * Hub resources are freed for us by usb_deregister. It calls
4934 * usb_driver_purge on every device which in turn calls that
4935 * devices disconnect function if it is using this driver.
4936 * The hub_disconnect function takes care of releasing the
4937 * individual hub resources. -greg
4939 usb_deregister(&hub_driver
);
4940 } /* usb_hub_cleanup() */
4942 static int descriptors_changed(struct usb_device
*udev
,
4943 struct usb_device_descriptor
*old_device_descriptor
)
4947 unsigned serial_len
= 0;
4949 unsigned old_length
;
4953 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4954 sizeof(*old_device_descriptor
)) != 0)
4957 /* Since the idVendor, idProduct, and bcdDevice values in the
4958 * device descriptor haven't changed, we will assume the
4959 * Manufacturer and Product strings haven't changed either.
4960 * But the SerialNumber string could be different (e.g., a
4961 * different flash card of the same brand).
4964 serial_len
= strlen(udev
->serial
) + 1;
4967 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4968 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4969 len
= max(len
, old_length
);
4972 buf
= kmalloc(len
, GFP_NOIO
);
4974 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
4975 /* assume the worst */
4978 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4979 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4980 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
4982 if (length
!= old_length
) {
4983 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
4988 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
4990 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
4992 ((struct usb_config_descriptor
*) buf
)->
4993 bConfigurationValue
);
4999 if (!changed
&& serial_len
) {
5000 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5002 if (length
+ 1 != serial_len
) {
5003 dev_dbg(&udev
->dev
, "serial string error %d\n",
5006 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5007 dev_dbg(&udev
->dev
, "serial string changed\n");
5017 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5018 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5020 * WARNING - don't use this routine to reset a composite device
5021 * (one with multiple interfaces owned by separate drivers)!
5022 * Use usb_reset_device() instead.
5024 * Do a port reset, reassign the device's address, and establish its
5025 * former operating configuration. If the reset fails, or the device's
5026 * descriptors change from their values before the reset, or the original
5027 * configuration and altsettings cannot be restored, a flag will be set
5028 * telling khubd to pretend the device has been disconnected and then
5029 * re-connected. All drivers will be unbound, and the device will be
5030 * re-enumerated and probed all over again.
5032 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5033 * flagged for logical disconnection, or some other negative error code
5034 * if the reset wasn't even attempted.
5036 * The caller must own the device lock. For example, it's safe to use
5037 * this from a driver probe() routine after downloading new firmware.
5038 * For calls that might not occur during probe(), drivers should lock
5039 * the device using usb_lock_device_for_reset().
5041 * Locking exception: This routine may also be called from within an
5042 * autoresume handler. Such usage won't conflict with other tasks
5043 * holding the device lock because these tasks should always call
5044 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5046 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5048 struct usb_device
*parent_hdev
= udev
->parent
;
5049 struct usb_hub
*parent_hub
;
5050 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5051 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5053 int port1
= udev
->portnum
;
5055 if (udev
->state
== USB_STATE_NOTATTACHED
||
5056 udev
->state
== USB_STATE_SUSPENDED
) {
5057 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5063 /* this requires hcd-specific logic; see ohci_restart() */
5064 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5067 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5069 /* Disable LPM and LTM while we reset the device and reinstall the alt
5070 * settings. Device-initiated LPM settings, and system exit latency
5071 * settings are cleared when the device is reset, so we have to set
5074 ret
= usb_unlocked_disable_lpm(udev
);
5076 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5079 ret
= usb_disable_ltm(udev
);
5081 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5086 set_bit(port1
, parent_hub
->busy_bits
);
5087 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5089 /* ep0 maxpacket size may change; let the HCD know about it.
5090 * Other endpoints will be handled by re-enumeration. */
5091 usb_ep0_reinit(udev
);
5092 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5093 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5096 clear_bit(port1
, parent_hub
->busy_bits
);
5101 /* Device might have changed firmware (DFU or similar) */
5102 if (descriptors_changed(udev
, &descriptor
)) {
5103 dev_info(&udev
->dev
, "device firmware changed\n");
5104 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5108 /* Restore the device's previous configuration */
5109 if (!udev
->actconfig
)
5112 mutex_lock(hcd
->bandwidth_mutex
);
5113 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5115 dev_warn(&udev
->dev
,
5116 "Busted HC? Not enough HCD resources for "
5117 "old configuration.\n");
5118 mutex_unlock(hcd
->bandwidth_mutex
);
5121 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5122 USB_REQ_SET_CONFIGURATION
, 0,
5123 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5124 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5127 "can't restore configuration #%d (error=%d)\n",
5128 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5129 mutex_unlock(hcd
->bandwidth_mutex
);
5132 mutex_unlock(hcd
->bandwidth_mutex
);
5133 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5135 /* Put interfaces back into the same altsettings as before.
5136 * Don't bother to send the Set-Interface request for interfaces
5137 * that were already in altsetting 0; besides being unnecessary,
5138 * many devices can't handle it. Instead just reset the host-side
5141 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5142 struct usb_host_config
*config
= udev
->actconfig
;
5143 struct usb_interface
*intf
= config
->interface
[i
];
5144 struct usb_interface_descriptor
*desc
;
5146 desc
= &intf
->cur_altsetting
->desc
;
5147 if (desc
->bAlternateSetting
== 0) {
5148 usb_disable_interface(udev
, intf
, true);
5149 usb_enable_interface(udev
, intf
, true);
5152 /* Let the bandwidth allocation function know that this
5153 * device has been reset, and it will have to use
5154 * alternate setting 0 as the current alternate setting.
5156 intf
->resetting_device
= 1;
5157 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5158 desc
->bAlternateSetting
);
5159 intf
->resetting_device
= 0;
5162 dev_err(&udev
->dev
, "failed to restore interface %d "
5163 "altsetting %d (error=%d)\n",
5164 desc
->bInterfaceNumber
,
5165 desc
->bAlternateSetting
,
5172 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5173 usb_unlocked_enable_lpm(udev
);
5174 usb_enable_ltm(udev
);
5178 /* LPM state doesn't matter when we're about to destroy the device. */
5179 hub_port_logical_disconnect(parent_hub
, port1
);
5184 * usb_reset_device - warn interface drivers and perform a USB port reset
5185 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5187 * Warns all drivers bound to registered interfaces (using their pre_reset
5188 * method), performs the port reset, and then lets the drivers know that
5189 * the reset is over (using their post_reset method).
5191 * Return value is the same as for usb_reset_and_verify_device().
5193 * The caller must own the device lock. For example, it's safe to use
5194 * this from a driver probe() routine after downloading new firmware.
5195 * For calls that might not occur during probe(), drivers should lock
5196 * the device using usb_lock_device_for_reset().
5198 * If an interface is currently being probed or disconnected, we assume
5199 * its driver knows how to handle resets. For all other interfaces,
5200 * if the driver doesn't have pre_reset and post_reset methods then
5201 * we attempt to unbind it and rebind afterward.
5203 int usb_reset_device(struct usb_device
*udev
)
5207 unsigned int noio_flag
;
5208 struct usb_host_config
*config
= udev
->actconfig
;
5210 if (udev
->state
== USB_STATE_NOTATTACHED
||
5211 udev
->state
== USB_STATE_SUSPENDED
) {
5212 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5218 * Don't allocate memory with GFP_KERNEL in current
5219 * context to avoid possible deadlock if usb mass
5220 * storage interface or usbnet interface(iSCSI case)
5221 * is included in current configuration. The easist
5222 * approach is to do it for every device reset,
5223 * because the device 'memalloc_noio' flag may have
5224 * not been set before reseting the usb device.
5226 noio_flag
= memalloc_noio_save();
5228 /* Prevent autosuspend during the reset */
5229 usb_autoresume_device(udev
);
5232 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5233 struct usb_interface
*cintf
= config
->interface
[i
];
5234 struct usb_driver
*drv
;
5237 if (cintf
->dev
.driver
) {
5238 drv
= to_usb_driver(cintf
->dev
.driver
);
5239 if (drv
->pre_reset
&& drv
->post_reset
)
5240 unbind
= (drv
->pre_reset
)(cintf
);
5241 else if (cintf
->condition
==
5242 USB_INTERFACE_BOUND
)
5245 usb_forced_unbind_intf(cintf
);
5250 ret
= usb_reset_and_verify_device(udev
);
5253 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5254 struct usb_interface
*cintf
= config
->interface
[i
];
5255 struct usb_driver
*drv
;
5256 int rebind
= cintf
->needs_binding
;
5258 if (!rebind
&& cintf
->dev
.driver
) {
5259 drv
= to_usb_driver(cintf
->dev
.driver
);
5260 if (drv
->post_reset
)
5261 rebind
= (drv
->post_reset
)(cintf
);
5262 else if (cintf
->condition
==
5263 USB_INTERFACE_BOUND
)
5266 if (ret
== 0 && rebind
)
5267 usb_rebind_intf(cintf
);
5271 usb_autosuspend_device(udev
);
5272 memalloc_noio_restore(noio_flag
);
5275 EXPORT_SYMBOL_GPL(usb_reset_device
);
5279 * usb_queue_reset_device - Reset a USB device from an atomic context
5280 * @iface: USB interface belonging to the device to reset
5282 * This function can be used to reset a USB device from an atomic
5283 * context, where usb_reset_device() won't work (as it blocks).
5285 * Doing a reset via this method is functionally equivalent to calling
5286 * usb_reset_device(), except for the fact that it is delayed to a
5287 * workqueue. This means that any drivers bound to other interfaces
5288 * might be unbound, as well as users from usbfs in user space.
5292 * - Scheduling two resets at the same time from two different drivers
5293 * attached to two different interfaces of the same device is
5294 * possible; depending on how the driver attached to each interface
5295 * handles ->pre_reset(), the second reset might happen or not.
5297 * - If a driver is unbound and it had a pending reset, the reset will
5300 * - This function can be called during .probe() or .disconnect()
5301 * times. On return from .disconnect(), any pending resets will be
5304 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5307 * NOTE: We don't do any reference count tracking because it is not
5308 * needed. The lifecycle of the work_struct is tied to the
5309 * usb_interface. Before destroying the interface we cancel the
5310 * work_struct, so the fact that work_struct is queued and or
5311 * running means the interface (and thus, the device) exist and
5314 void usb_queue_reset_device(struct usb_interface
*iface
)
5316 schedule_work(&iface
->reset_ws
);
5318 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5321 * usb_hub_find_child - Get the pointer of child device
5322 * attached to the port which is specified by @port1.
5323 * @hdev: USB device belonging to the usb hub
5324 * @port1: port num to indicate which port the child device
5327 * USB drivers call this function to get hub's child device
5330 * Return NULL if input param is invalid and
5331 * child's usb_device pointer if non-NULL.
5333 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5336 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5338 if (port1
< 1 || port1
> hdev
->maxchild
)
5340 return hub
->ports
[port1
- 1]->child
;
5342 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5345 * usb_set_hub_port_connect_type - set hub port connect type.
5346 * @hdev: USB device belonging to the usb hub
5347 * @port1: port num of the port
5348 * @type: connect type of the port
5350 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5351 enum usb_port_connect_type type
)
5353 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5355 hub
->ports
[port1
- 1]->connect_type
= type
;
5359 * usb_get_hub_port_connect_type - Get the port's connect type
5360 * @hdev: USB device belonging to the usb hub
5361 * @port1: port num of the port
5363 * Return connect type of the port and if input params are
5364 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5366 enum usb_port_connect_type
5367 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5369 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5371 return hub
->ports
[port1
- 1]->connect_type
;
5374 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5375 struct usb_hub_descriptor
*desc
)
5377 enum usb_port_connect_type connect_type
;
5380 if (!hub_is_superspeed(hdev
)) {
5381 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5382 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5384 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5385 u8 mask
= 1 << (i
%8);
5387 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5388 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5390 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5395 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5397 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5398 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5400 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5403 if (!(port_removable
& mask
)) {
5404 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5406 port_removable
|= mask
;
5411 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5417 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5418 * @hdev: USB device belonging to the usb hub
5419 * @port1: port num of the port
5421 * Return port's acpi handle if successful, NULL if params are
5424 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5427 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5429 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);