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 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
672 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
677 * enumeration blocks khubd for a long time. we use keventd instead, since
678 * long blocking there is the exception, not the rule. accordingly, HCDs
679 * talking to TTs must queue control transfers (not just bulk and iso), so
680 * both can talk to the same hub concurrently.
682 static void hub_tt_work(struct work_struct
*work
)
684 struct usb_hub
*hub
=
685 container_of(work
, struct usb_hub
, tt
.clear_work
);
688 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
689 while (!list_empty(&hub
->tt
.clear_list
)) {
690 struct list_head
*next
;
691 struct usb_tt_clear
*clear
;
692 struct usb_device
*hdev
= hub
->hdev
;
693 const struct hc_driver
*drv
;
696 next
= hub
->tt
.clear_list
.next
;
697 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
698 list_del (&clear
->clear_list
);
700 /* drop lock so HCD can concurrently report other TT errors */
701 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
702 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
703 if (status
&& status
!= -ENODEV
)
705 "clear tt %d (%04x) error %d\n",
706 clear
->tt
, clear
->devinfo
, status
);
708 /* Tell the HCD, even if the operation failed */
709 drv
= clear
->hcd
->driver
;
710 if (drv
->clear_tt_buffer_complete
)
711 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
714 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
716 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
720 * usb_hub_set_port_power - control hub port's power state
721 * @hdev: USB device belonging to the usb hub
724 * @set: expected status
726 * call this function to control port's power via setting or
727 * clearing the port's PORT_POWER feature.
729 int usb_hub_set_port_power(struct usb_device
*hdev
, struct usb_hub
*hub
,
733 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
736 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
738 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
741 port_dev
->power_is_on
= set
;
746 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
747 * @urb: an URB associated with the failed or incomplete split transaction
749 * High speed HCDs use this to tell the hub driver that some split control or
750 * bulk transaction failed in a way that requires clearing internal state of
751 * a transaction translator. This is normally detected (and reported) from
754 * It may not be possible for that hub to handle additional full (or low)
755 * speed transactions until that state is fully cleared out.
757 int usb_hub_clear_tt_buffer(struct urb
*urb
)
759 struct usb_device
*udev
= urb
->dev
;
760 int pipe
= urb
->pipe
;
761 struct usb_tt
*tt
= udev
->tt
;
763 struct usb_tt_clear
*clear
;
765 /* we've got to cope with an arbitrary number of pending TT clears,
766 * since each TT has "at least two" buffers that can need it (and
767 * there can be many TTs per hub). even if they're uncommon.
769 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
770 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
771 /* FIXME recover somehow ... RESET_TT? */
775 /* info that CLEAR_TT_BUFFER needs */
776 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
777 clear
->devinfo
= usb_pipeendpoint (pipe
);
778 clear
->devinfo
|= udev
->devnum
<< 4;
779 clear
->devinfo
|= usb_pipecontrol (pipe
)
780 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
781 : (USB_ENDPOINT_XFER_BULK
<< 11);
782 if (usb_pipein (pipe
))
783 clear
->devinfo
|= 1 << 15;
785 /* info for completion callback */
786 clear
->hcd
= bus_to_hcd(udev
->bus
);
789 /* tell keventd to clear state for this TT */
790 spin_lock_irqsave (&tt
->lock
, flags
);
791 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
792 schedule_work(&tt
->clear_work
);
793 spin_unlock_irqrestore (&tt
->lock
, flags
);
796 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
798 /* If do_delay is false, return the number of milliseconds the caller
801 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
804 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
806 u16 wHubCharacteristics
=
807 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
809 /* Enable power on each port. Some hubs have reserved values
810 * of LPSM (> 2) in their descriptors, even though they are
811 * USB 2.0 hubs. Some hubs do not implement port-power switching
812 * but only emulate it. In all cases, the ports won't work
813 * unless we send these messages to the hub.
815 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
816 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
818 dev_dbg(hub
->intfdev
, "trying to enable port power on "
819 "non-switchable hub\n");
820 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
821 if (hub
->ports
[port1
- 1]->power_is_on
)
822 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
824 usb_clear_port_feature(hub
->hdev
, port1
,
825 USB_PORT_FEAT_POWER
);
827 /* Wait at least 100 msec for power to become stable */
828 delay
= max(pgood_delay
, (unsigned) 100);
834 static int hub_hub_status(struct usb_hub
*hub
,
835 u16
*status
, u16
*change
)
839 mutex_lock(&hub
->status_mutex
);
840 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
843 dev_err(hub
->intfdev
,
844 "%s failed (err = %d)\n", __func__
, ret
);
846 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
847 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
850 mutex_unlock(&hub
->status_mutex
);
854 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
855 unsigned int link_status
)
857 return set_port_feature(hub
->hdev
,
858 port1
| (link_status
<< 3),
859 USB_PORT_FEAT_LINK_STATE
);
863 * If USB 3.0 ports are placed into the Disabled state, they will no longer
864 * detect any device connects or disconnects. This is generally not what the
865 * USB core wants, since it expects a disabled port to produce a port status
866 * change event when a new device connects.
868 * Instead, set the link state to Disabled, wait for the link to settle into
869 * that state, clear any change bits, and then put the port into the RxDetect
872 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
876 u16 portchange
, portstatus
;
878 if (!hub_is_superspeed(hub
->hdev
))
881 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
885 /* Wait for the link to enter the disabled state. */
886 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
887 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
891 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
892 USB_SS_PORT_LS_SS_DISABLED
)
894 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
896 msleep(HUB_DEBOUNCE_STEP
);
898 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
899 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
902 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
905 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
907 struct usb_device
*hdev
= hub
->hdev
;
910 if (hub
->ports
[port1
- 1]->child
&& set_state
)
911 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
912 USB_STATE_NOTATTACHED
);
914 if (hub_is_superspeed(hub
->hdev
))
915 ret
= hub_usb3_port_disable(hub
, port1
);
917 ret
= usb_clear_port_feature(hdev
, port1
,
918 USB_PORT_FEAT_ENABLE
);
920 if (ret
&& ret
!= -ENODEV
)
921 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
927 * Disable a port and mark a logical connect-change event, so that some
928 * time later khubd will disconnect() any existing usb_device on the port
929 * and will re-enumerate if there actually is a device attached.
931 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
933 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
934 hub_port_disable(hub
, port1
, 1);
936 /* FIXME let caller ask to power down the port:
937 * - some devices won't enumerate without a VBUS power cycle
938 * - SRP saves power that way
939 * - ... new call, TBD ...
940 * That's easy if this hub can switch power per-port, and
941 * khubd reactivates the port later (timer, SRP, etc).
942 * Powerdown must be optional, because of reset/DFU.
945 set_bit(port1
, hub
->change_bits
);
950 * usb_remove_device - disable a device's port on its parent hub
951 * @udev: device to be disabled and removed
952 * Context: @udev locked, must be able to sleep.
954 * After @udev's port has been disabled, khubd is notified and it will
955 * see that the device has been disconnected. When the device is
956 * physically unplugged and something is plugged in, the events will
957 * be received and processed normally.
959 int usb_remove_device(struct usb_device
*udev
)
962 struct usb_interface
*intf
;
964 if (!udev
->parent
) /* Can't remove a root hub */
966 hub
= usb_hub_to_struct_hub(udev
->parent
);
967 intf
= to_usb_interface(hub
->intfdev
);
969 usb_autopm_get_interface(intf
);
970 set_bit(udev
->portnum
, hub
->removed_bits
);
971 hub_port_logical_disconnect(hub
, udev
->portnum
);
972 usb_autopm_put_interface(intf
);
976 enum hub_activation_type
{
977 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
978 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
981 static void hub_init_func2(struct work_struct
*ws
);
982 static void hub_init_func3(struct work_struct
*ws
);
984 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
986 struct usb_device
*hdev
= hub
->hdev
;
991 bool need_debounce_delay
= false;
994 /* Continue a partial initialization */
995 if (type
== HUB_INIT2
)
997 if (type
== HUB_INIT3
)
1000 /* The superspeed hub except for root hub has to use Hub Depth
1001 * value as an offset into the route string to locate the bits
1002 * it uses to determine the downstream port number. So hub driver
1003 * should send a set hub depth request to superspeed hub after
1004 * the superspeed hub is set configuration in initialization or
1007 * After a resume, port power should still be on.
1008 * For any other type of activation, turn it on.
1010 if (type
!= HUB_RESUME
) {
1011 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1012 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1013 HUB_SET_DEPTH
, USB_RT_HUB
,
1014 hdev
->level
- 1, 0, NULL
, 0,
1015 USB_CTRL_SET_TIMEOUT
);
1017 dev_err(hub
->intfdev
,
1018 "set hub depth failed\n");
1021 /* Speed up system boot by using a delayed_work for the
1022 * hub's initial power-up delays. This is pretty awkward
1023 * and the implementation looks like a home-brewed sort of
1024 * setjmp/longjmp, but it saves at least 100 ms for each
1025 * root hub (assuming usbcore is compiled into the kernel
1026 * rather than as a module). It adds up.
1028 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1029 * because for those activation types the ports have to be
1030 * operational when we return. In theory this could be done
1031 * for HUB_POST_RESET, but it's easier not to.
1033 if (type
== HUB_INIT
) {
1034 delay
= hub_power_on(hub
, false);
1035 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1036 schedule_delayed_work(&hub
->init_work
,
1037 msecs_to_jiffies(delay
));
1039 /* Suppress autosuspend until init is done */
1040 usb_autopm_get_interface_no_resume(
1041 to_usb_interface(hub
->intfdev
));
1042 return; /* Continues at init2: below */
1043 } else if (type
== HUB_RESET_RESUME
) {
1044 /* The internal host controller state for the hub device
1045 * may be gone after a host power loss on system resume.
1046 * Update the device's info so the HW knows it's a hub.
1048 hcd
= bus_to_hcd(hdev
->bus
);
1049 if (hcd
->driver
->update_hub_device
) {
1050 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1051 &hub
->tt
, GFP_NOIO
);
1053 dev_err(hub
->intfdev
, "Host not "
1054 "accepting hub info "
1056 dev_err(hub
->intfdev
, "LS/FS devices "
1057 "and hubs may not work "
1058 "under this hub\n.");
1061 hub_power_on(hub
, true);
1063 hub_power_on(hub
, true);
1068 /* Check each port and set hub->change_bits to let khubd know
1069 * which ports need attention.
1071 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1072 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1073 u16 portstatus
, portchange
;
1075 portstatus
= portchange
= 0;
1076 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1077 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1078 dev_dbg(hub
->intfdev
,
1079 "port %d: status %04x change %04x\n",
1080 port1
, portstatus
, portchange
);
1082 /* After anything other than HUB_RESUME (i.e., initialization
1083 * or any sort of reset), every port should be disabled.
1084 * Unconnected ports should likewise be disabled (paranoia),
1085 * and so should ports for which we have no usb_device.
1087 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1088 type
!= HUB_RESUME
||
1089 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1091 udev
->state
== USB_STATE_NOTATTACHED
)) {
1093 * USB3 protocol ports will automatically transition
1094 * to Enabled state when detect an USB3.0 device attach.
1095 * Do not disable USB3 protocol ports.
1097 if (!hub_is_superspeed(hdev
)) {
1098 usb_clear_port_feature(hdev
, port1
,
1099 USB_PORT_FEAT_ENABLE
);
1100 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1102 /* Pretend that power was lost for USB3 devs */
1103 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1107 /* Clear status-change flags; we'll debounce later */
1108 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1109 need_debounce_delay
= true;
1110 usb_clear_port_feature(hub
->hdev
, port1
,
1111 USB_PORT_FEAT_C_CONNECTION
);
1113 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1114 need_debounce_delay
= true;
1115 usb_clear_port_feature(hub
->hdev
, port1
,
1116 USB_PORT_FEAT_C_ENABLE
);
1118 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1119 hub_is_superspeed(hub
->hdev
)) {
1120 need_debounce_delay
= true;
1121 usb_clear_port_feature(hub
->hdev
, port1
,
1122 USB_PORT_FEAT_C_BH_PORT_RESET
);
1124 /* We can forget about a "removed" device when there's a
1125 * physical disconnect or the connect status changes.
1127 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1128 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1129 clear_bit(port1
, hub
->removed_bits
);
1131 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1132 /* Tell khubd to disconnect the device or
1133 * check for a new connection
1135 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1136 set_bit(port1
, hub
->change_bits
);
1138 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1139 bool port_resumed
= (portstatus
&
1140 USB_PORT_STAT_LINK_STATE
) ==
1142 /* The power session apparently survived the resume.
1143 * If there was an overcurrent or suspend change
1144 * (i.e., remote wakeup request), have khubd
1145 * take care of it. Look at the port link state
1146 * for USB 3.0 hubs, since they don't have a suspend
1147 * change bit, and they don't set the port link change
1148 * bit on device-initiated resume.
1150 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1152 set_bit(port1
, hub
->change_bits
);
1154 } else if (udev
->persist_enabled
) {
1155 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1158 udev
->reset_resume
= 1;
1160 /* Don't set the change_bits when the device
1163 if (port_dev
->power_is_on
)
1164 set_bit(port1
, hub
->change_bits
);
1167 /* The power session is gone; tell khubd */
1168 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1169 set_bit(port1
, hub
->change_bits
);
1173 /* If no port-status-change flags were set, we don't need any
1174 * debouncing. If flags were set we can try to debounce the
1175 * ports all at once right now, instead of letting khubd do them
1176 * one at a time later on.
1178 * If any port-status changes do occur during this delay, khubd
1179 * will see them later and handle them normally.
1181 if (need_debounce_delay
) {
1182 delay
= HUB_DEBOUNCE_STABLE
;
1184 /* Don't do a long sleep inside a workqueue routine */
1185 if (type
== HUB_INIT2
) {
1186 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1187 schedule_delayed_work(&hub
->init_work
,
1188 msecs_to_jiffies(delay
));
1189 return; /* Continues at init3: below */
1197 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1199 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1200 if (hub
->has_indicators
&& blinkenlights
)
1201 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1203 /* Scan all ports that need attention */
1206 /* Allow autosuspend if it was suppressed */
1207 if (type
<= HUB_INIT3
)
1208 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1211 /* Implement the continuations for the delays above */
1212 static void hub_init_func2(struct work_struct
*ws
)
1214 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1216 hub_activate(hub
, HUB_INIT2
);
1219 static void hub_init_func3(struct work_struct
*ws
)
1221 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1223 hub_activate(hub
, HUB_INIT3
);
1226 enum hub_quiescing_type
{
1227 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1230 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1232 struct usb_device
*hdev
= hub
->hdev
;
1235 cancel_delayed_work_sync(&hub
->init_work
);
1237 /* khubd and related activity won't re-trigger */
1240 if (type
!= HUB_SUSPEND
) {
1241 /* Disconnect all the children */
1242 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1243 if (hub
->ports
[i
]->child
)
1244 usb_disconnect(&hub
->ports
[i
]->child
);
1248 /* Stop khubd and related activity */
1249 usb_kill_urb(hub
->urb
);
1250 if (hub
->has_indicators
)
1251 cancel_delayed_work_sync(&hub
->leds
);
1253 flush_work(&hub
->tt
.clear_work
);
1256 /* caller has locked the hub device */
1257 static int hub_pre_reset(struct usb_interface
*intf
)
1259 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1261 hub_quiesce(hub
, HUB_PRE_RESET
);
1265 /* caller has locked the hub device */
1266 static int hub_post_reset(struct usb_interface
*intf
)
1268 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1270 hub_activate(hub
, HUB_POST_RESET
);
1274 static int hub_configure(struct usb_hub
*hub
,
1275 struct usb_endpoint_descriptor
*endpoint
)
1277 struct usb_hcd
*hcd
;
1278 struct usb_device
*hdev
= hub
->hdev
;
1279 struct device
*hub_dev
= hub
->intfdev
;
1280 u16 hubstatus
, hubchange
;
1281 u16 wHubCharacteristics
;
1284 char *message
= "out of memory";
1288 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1294 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1299 mutex_init(&hub
->status_mutex
);
1301 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1302 if (!hub
->descriptor
) {
1307 /* Request the entire hub descriptor.
1308 * hub->descriptor can handle USB_MAXCHILDREN ports,
1309 * but the hub can/will return fewer bytes here.
1311 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1313 message
= "can't read hub descriptor";
1315 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1316 message
= "hub has too many ports!";
1319 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1320 message
= "hub doesn't have any ports!";
1325 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1326 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1327 (hdev
->maxchild
== 1) ? "" : "s");
1329 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1336 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1337 if (hub_is_superspeed(hdev
)) {
1345 /* FIXME for USB 3.0, skip for now */
1346 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1347 !(hub_is_superspeed(hdev
))) {
1349 char portstr
[USB_MAXCHILDREN
+ 1];
1351 for (i
= 0; i
< hdev
->maxchild
; i
++)
1352 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1353 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1355 portstr
[hdev
->maxchild
] = 0;
1356 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1358 dev_dbg(hub_dev
, "standalone hub\n");
1360 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1361 case HUB_CHAR_COMMON_LPSM
:
1362 dev_dbg(hub_dev
, "ganged power switching\n");
1364 case HUB_CHAR_INDV_PORT_LPSM
:
1365 dev_dbg(hub_dev
, "individual port power switching\n");
1367 case HUB_CHAR_NO_LPSM
:
1369 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1373 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1374 case HUB_CHAR_COMMON_OCPM
:
1375 dev_dbg(hub_dev
, "global over-current protection\n");
1377 case HUB_CHAR_INDV_PORT_OCPM
:
1378 dev_dbg(hub_dev
, "individual port over-current protection\n");
1380 case HUB_CHAR_NO_OCPM
:
1382 dev_dbg(hub_dev
, "no over-current protection\n");
1386 spin_lock_init (&hub
->tt
.lock
);
1387 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1388 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1389 switch (hdev
->descriptor
.bDeviceProtocol
) {
1392 case USB_HUB_PR_HS_SINGLE_TT
:
1393 dev_dbg(hub_dev
, "Single TT\n");
1396 case USB_HUB_PR_HS_MULTI_TT
:
1397 ret
= usb_set_interface(hdev
, 0, 1);
1399 dev_dbg(hub_dev
, "TT per port\n");
1402 dev_err(hub_dev
, "Using single TT (err %d)\n",
1407 /* USB 3.0 hubs don't have a TT */
1410 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1411 hdev
->descriptor
.bDeviceProtocol
);
1415 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1416 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1417 case HUB_TTTT_8_BITS
:
1418 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1419 hub
->tt
.think_time
= 666;
1420 dev_dbg(hub_dev
, "TT requires at most %d "
1421 "FS bit times (%d ns)\n",
1422 8, hub
->tt
.think_time
);
1425 case HUB_TTTT_16_BITS
:
1426 hub
->tt
.think_time
= 666 * 2;
1427 dev_dbg(hub_dev
, "TT requires at most %d "
1428 "FS bit times (%d ns)\n",
1429 16, hub
->tt
.think_time
);
1431 case HUB_TTTT_24_BITS
:
1432 hub
->tt
.think_time
= 666 * 3;
1433 dev_dbg(hub_dev
, "TT requires at most %d "
1434 "FS bit times (%d ns)\n",
1435 24, hub
->tt
.think_time
);
1437 case HUB_TTTT_32_BITS
:
1438 hub
->tt
.think_time
= 666 * 4;
1439 dev_dbg(hub_dev
, "TT requires at most %d "
1440 "FS bit times (%d ns)\n",
1441 32, hub
->tt
.think_time
);
1445 /* probe() zeroes hub->indicator[] */
1446 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1447 hub
->has_indicators
= 1;
1448 dev_dbg(hub_dev
, "Port indicators are supported\n");
1451 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1452 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1454 /* power budgeting mostly matters with bus-powered hubs,
1455 * and battery-powered root hubs (may provide just 8 mA).
1457 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1459 message
= "can't get hub status";
1462 le16_to_cpus(&hubstatus
);
1463 hcd
= bus_to_hcd(hdev
->bus
);
1464 if (hdev
== hdev
->bus
->root_hub
) {
1465 if (hcd
->power_budget
> 0)
1466 hdev
->bus_mA
= hcd
->power_budget
;
1468 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1469 if (hdev
->bus_mA
>= full_load
)
1470 hub
->mA_per_port
= full_load
;
1472 hub
->mA_per_port
= hdev
->bus_mA
;
1473 hub
->limited_power
= 1;
1475 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1476 int remaining
= hdev
->bus_mA
-
1477 hub
->descriptor
->bHubContrCurrent
;
1479 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1480 hub
->descriptor
->bHubContrCurrent
);
1481 hub
->limited_power
= 1;
1483 if (remaining
< hdev
->maxchild
* unit_load
)
1485 "insufficient power available "
1486 "to use all downstream ports\n");
1487 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1489 } else { /* Self-powered external hub */
1490 /* FIXME: What about battery-powered external hubs that
1491 * provide less current per port? */
1492 hub
->mA_per_port
= full_load
;
1494 if (hub
->mA_per_port
< full_load
)
1495 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1498 /* Update the HCD's internal representation of this hub before khubd
1499 * starts getting port status changes for devices under the hub.
1501 if (hcd
->driver
->update_hub_device
) {
1502 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1503 &hub
->tt
, GFP_KERNEL
);
1505 message
= "can't update HCD hub info";
1510 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1512 message
= "can't get hub status";
1516 /* local power status reports aren't always correct */
1517 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1518 dev_dbg(hub_dev
, "local power source is %s\n",
1519 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1520 ? "lost (inactive)" : "good");
1522 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1523 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1524 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1526 /* set up the interrupt endpoint
1527 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1528 * bytes as USB2.0[11.12.3] says because some hubs are known
1529 * to send more data (and thus cause overflow). For root hubs,
1530 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1531 * to be big enough for at least USB_MAXCHILDREN ports. */
1532 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1533 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1535 if (maxp
> sizeof(*hub
->buffer
))
1536 maxp
= sizeof(*hub
->buffer
);
1538 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1544 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1545 hub
, endpoint
->bInterval
);
1547 /* maybe cycle the hub leds */
1548 if (hub
->has_indicators
&& blinkenlights
)
1549 hub
->indicator
[0] = INDICATOR_CYCLE
;
1551 for (i
= 0; i
< hdev
->maxchild
; i
++)
1552 if (usb_hub_create_port_device(hub
, i
+ 1) < 0)
1553 dev_err(hub
->intfdev
,
1554 "couldn't create port%d device.\n", i
+ 1);
1556 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1558 hub_activate(hub
, HUB_INIT
);
1562 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1564 /* hub_disconnect() frees urb and descriptor */
1568 static void hub_release(struct kref
*kref
)
1570 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1572 usb_put_intf(to_usb_interface(hub
->intfdev
));
1576 static unsigned highspeed_hubs
;
1578 static void hub_disconnect(struct usb_interface
*intf
)
1580 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1581 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1584 /* Take the hub off the event list and don't let it be added again */
1585 spin_lock_irq(&hub_event_lock
);
1586 if (!list_empty(&hub
->event_list
)) {
1587 list_del_init(&hub
->event_list
);
1588 usb_autopm_put_interface_no_suspend(intf
);
1590 hub
->disconnected
= 1;
1591 spin_unlock_irq(&hub_event_lock
);
1593 /* Disconnect all children and quiesce the hub */
1595 hub_quiesce(hub
, HUB_DISCONNECT
);
1597 usb_set_intfdata (intf
, NULL
);
1599 for (i
= 0; i
< hdev
->maxchild
; i
++)
1600 usb_hub_remove_port_device(hub
, i
+ 1);
1601 hub
->hdev
->maxchild
= 0;
1603 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1606 usb_free_urb(hub
->urb
);
1608 kfree(hub
->descriptor
);
1612 pm_suspend_ignore_children(&intf
->dev
, false);
1613 kref_put(&hub
->kref
, hub_release
);
1616 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1618 struct usb_host_interface
*desc
;
1619 struct usb_endpoint_descriptor
*endpoint
;
1620 struct usb_device
*hdev
;
1621 struct usb_hub
*hub
;
1623 desc
= intf
->cur_altsetting
;
1624 hdev
= interface_to_usbdev(intf
);
1627 * Set default autosuspend delay as 0 to speedup bus suspend,
1628 * based on the below considerations:
1630 * - Unlike other drivers, the hub driver does not rely on the
1631 * autosuspend delay to provide enough time to handle a wakeup
1632 * event, and the submitted status URB is just to check future
1633 * change on hub downstream ports, so it is safe to do it.
1635 * - The patch might cause one or more auto supend/resume for
1636 * below very rare devices when they are plugged into hub
1639 * devices having trouble initializing, and disconnect
1640 * themselves from the bus and then reconnect a second
1643 * devices just for downloading firmware, and disconnects
1644 * themselves after completing it
1646 * For these quite rare devices, their drivers may change the
1647 * autosuspend delay of their parent hub in the probe() to one
1648 * appropriate value to avoid the subtle problem if someone
1651 * - The patch may cause one or more auto suspend/resume on
1652 * hub during running 'lsusb', but it is probably too
1653 * infrequent to worry about.
1655 * - Change autosuspend delay of hub can avoid unnecessary auto
1656 * suspend timer for hub, also may decrease power consumption
1659 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1661 /* Hubs have proper suspend/resume support. */
1662 usb_enable_autosuspend(hdev
);
1664 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1666 "Unsupported bus topology: hub nested too deep\n");
1670 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1672 dev_warn(&intf
->dev
, "ignoring external hub\n");
1677 /* Some hubs have a subclass of 1, which AFAICT according to the */
1678 /* specs is not defined, but it works */
1679 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1680 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1682 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1686 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1687 if (desc
->desc
.bNumEndpoints
!= 1)
1688 goto descriptor_error
;
1690 endpoint
= &desc
->endpoint
[0].desc
;
1692 /* If it's not an interrupt in endpoint, we'd better punt! */
1693 if (!usb_endpoint_is_int_in(endpoint
))
1694 goto descriptor_error
;
1696 /* We found a hub */
1697 dev_info (&intf
->dev
, "USB hub found\n");
1699 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1701 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1705 kref_init(&hub
->kref
);
1706 INIT_LIST_HEAD(&hub
->event_list
);
1707 hub
->intfdev
= &intf
->dev
;
1709 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1710 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1713 usb_set_intfdata (intf
, hub
);
1714 intf
->needs_remote_wakeup
= 1;
1715 pm_suspend_ignore_children(&intf
->dev
, true);
1717 if (hdev
->speed
== USB_SPEED_HIGH
)
1720 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1721 hub
->quirk_check_port_auto_suspend
= 1;
1723 if (hub_configure(hub
, endpoint
) >= 0)
1726 hub_disconnect (intf
);
1731 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1733 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1734 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1736 /* assert ifno == 0 (part of hub spec) */
1738 case USBDEVFS_HUB_PORTINFO
: {
1739 struct usbdevfs_hub_portinfo
*info
= user_data
;
1742 spin_lock_irq(&device_state_lock
);
1743 if (hdev
->devnum
<= 0)
1746 info
->nports
= hdev
->maxchild
;
1747 for (i
= 0; i
< info
->nports
; i
++) {
1748 if (hub
->ports
[i
]->child
== NULL
)
1752 hub
->ports
[i
]->child
->devnum
;
1755 spin_unlock_irq(&device_state_lock
);
1757 return info
->nports
+ 1;
1766 * Allow user programs to claim ports on a hub. When a device is attached
1767 * to one of these "claimed" ports, the program will "own" the device.
1769 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1770 struct dev_state
***ppowner
)
1772 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1774 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1776 if (port1
== 0 || port1
> hdev
->maxchild
)
1779 /* Devices not managed by the hub driver
1780 * will always have maxchild equal to 0.
1782 *ppowner
= &(hub
->ports
[port1
- 1]->port_owner
);
1786 /* In the following three functions, the caller must hold hdev's lock */
1787 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1788 struct dev_state
*owner
)
1791 struct dev_state
**powner
;
1793 rc
= find_port_owner(hdev
, port1
, &powner
);
1802 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1803 struct dev_state
*owner
)
1806 struct dev_state
**powner
;
1808 rc
= find_port_owner(hdev
, port1
, &powner
);
1811 if (*powner
!= owner
)
1817 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1819 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1822 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1823 if (hub
->ports
[n
]->port_owner
== owner
)
1824 hub
->ports
[n
]->port_owner
= NULL
;
1829 /* The caller must hold udev's lock */
1830 bool usb_device_is_owned(struct usb_device
*udev
)
1832 struct usb_hub
*hub
;
1834 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1836 hub
= usb_hub_to_struct_hub(udev
->parent
);
1837 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1840 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1842 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1845 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1846 if (hub
->ports
[i
]->child
)
1847 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1849 if (udev
->state
== USB_STATE_SUSPENDED
)
1850 udev
->active_duration
-= jiffies
;
1851 udev
->state
= USB_STATE_NOTATTACHED
;
1855 * usb_set_device_state - change a device's current state (usbcore, hcds)
1856 * @udev: pointer to device whose state should be changed
1857 * @new_state: new state value to be stored
1859 * udev->state is _not_ fully protected by the device lock. Although
1860 * most transitions are made only while holding the lock, the state can
1861 * can change to USB_STATE_NOTATTACHED at almost any time. This
1862 * is so that devices can be marked as disconnected as soon as possible,
1863 * without having to wait for any semaphores to be released. As a result,
1864 * all changes to any device's state must be protected by the
1865 * device_state_lock spinlock.
1867 * Once a device has been added to the device tree, all changes to its state
1868 * should be made using this routine. The state should _not_ be set directly.
1870 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1871 * Otherwise udev->state is set to new_state, and if new_state is
1872 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1873 * to USB_STATE_NOTATTACHED.
1875 void usb_set_device_state(struct usb_device
*udev
,
1876 enum usb_device_state new_state
)
1878 unsigned long flags
;
1881 spin_lock_irqsave(&device_state_lock
, flags
);
1882 if (udev
->state
== USB_STATE_NOTATTACHED
)
1884 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1886 /* root hub wakeup capabilities are managed out-of-band
1887 * and may involve silicon errata ... ignore them here.
1890 if (udev
->state
== USB_STATE_SUSPENDED
1891 || new_state
== USB_STATE_SUSPENDED
)
1892 ; /* No change to wakeup settings */
1893 else if (new_state
== USB_STATE_CONFIGURED
)
1894 wakeup
= udev
->actconfig
->desc
.bmAttributes
1895 & USB_CONFIG_ATT_WAKEUP
;
1899 if (udev
->state
== USB_STATE_SUSPENDED
&&
1900 new_state
!= USB_STATE_SUSPENDED
)
1901 udev
->active_duration
-= jiffies
;
1902 else if (new_state
== USB_STATE_SUSPENDED
&&
1903 udev
->state
!= USB_STATE_SUSPENDED
)
1904 udev
->active_duration
+= jiffies
;
1905 udev
->state
= new_state
;
1907 recursively_mark_NOTATTACHED(udev
);
1908 spin_unlock_irqrestore(&device_state_lock
, flags
);
1910 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1912 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1915 * Choose a device number.
1917 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1918 * USB-2.0 buses they are also used as device addresses, however on
1919 * USB-3.0 buses the address is assigned by the controller hardware
1920 * and it usually is not the same as the device number.
1922 * WUSB devices are simple: they have no hubs behind, so the mapping
1923 * device <-> virtual port number becomes 1:1. Why? to simplify the
1924 * life of the device connection logic in
1925 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1926 * handshake we need to assign a temporary address in the unauthorized
1927 * space. For simplicity we use the first virtual port number found to
1928 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1929 * and that becomes it's address [X < 128] or its unauthorized address
1932 * We add 1 as an offset to the one-based USB-stack port number
1933 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1934 * 0 is reserved by USB for default address; (b) Linux's USB stack
1935 * uses always #1 for the root hub of the controller. So USB stack's
1936 * port #1, which is wusb virtual-port #0 has address #2.
1938 * Devices connected under xHCI are not as simple. The host controller
1939 * supports virtualization, so the hardware assigns device addresses and
1940 * the HCD must setup data structures before issuing a set address
1941 * command to the hardware.
1943 static void choose_devnum(struct usb_device
*udev
)
1946 struct usb_bus
*bus
= udev
->bus
;
1948 /* If khubd ever becomes multithreaded, this will need a lock */
1950 devnum
= udev
->portnum
+ 1;
1951 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1953 /* Try to allocate the next devnum beginning at
1954 * bus->devnum_next. */
1955 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1958 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1960 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1963 set_bit(devnum
, bus
->devmap
.devicemap
);
1964 udev
->devnum
= devnum
;
1968 static void release_devnum(struct usb_device
*udev
)
1970 if (udev
->devnum
> 0) {
1971 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1976 static void update_devnum(struct usb_device
*udev
, int devnum
)
1978 /* The address for a WUSB device is managed by wusbcore. */
1980 udev
->devnum
= devnum
;
1983 static void hub_free_dev(struct usb_device
*udev
)
1985 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1987 /* Root hubs aren't real devices, so don't free HCD resources */
1988 if (hcd
->driver
->free_dev
&& udev
->parent
)
1989 hcd
->driver
->free_dev(hcd
, udev
);
1993 * usb_disconnect - disconnect a device (usbcore-internal)
1994 * @pdev: pointer to device being disconnected
1995 * Context: !in_interrupt ()
1997 * Something got disconnected. Get rid of it and all of its children.
1999 * If *pdev is a normal device then the parent hub must already be locked.
2000 * If *pdev is a root hub then this routine will acquire the
2001 * usb_bus_list_lock on behalf of the caller.
2003 * Only hub drivers (including virtual root hub drivers for host
2004 * controllers) should ever call this.
2006 * This call is synchronous, and may not be used in an interrupt context.
2008 void usb_disconnect(struct usb_device
**pdev
)
2010 struct usb_device
*udev
= *pdev
;
2011 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2014 /* mark the device as inactive, so any further urb submissions for
2015 * this device (and any of its children) will fail immediately.
2016 * this quiesces everything except pending urbs.
2018 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2019 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2022 usb_lock_device(udev
);
2024 /* Free up all the children before we remove this device */
2025 for (i
= 0; i
< udev
->maxchild
; i
++) {
2026 if (hub
->ports
[i
]->child
)
2027 usb_disconnect(&hub
->ports
[i
]->child
);
2030 /* deallocate hcd/hardware state ... nuking all pending urbs and
2031 * cleaning up all state associated with the current configuration
2032 * so that the hardware is now fully quiesced.
2034 dev_dbg (&udev
->dev
, "unregistering device\n");
2035 usb_disable_device(udev
, 0);
2036 usb_hcd_synchronize_unlinks(udev
);
2039 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2040 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2042 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2043 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2045 if (!port_dev
->did_runtime_put
)
2046 pm_runtime_put(&port_dev
->dev
);
2048 port_dev
->did_runtime_put
= false;
2051 usb_remove_ep_devs(&udev
->ep0
);
2052 usb_unlock_device(udev
);
2054 /* Unregister the device. The device driver is responsible
2055 * for de-configuring the device and invoking the remove-device
2056 * notifier chain (used by usbfs and possibly others).
2058 device_del(&udev
->dev
);
2060 /* Free the device number and delete the parent's children[]
2061 * (or root_hub) pointer.
2063 release_devnum(udev
);
2065 /* Avoid races with recursively_mark_NOTATTACHED() */
2066 spin_lock_irq(&device_state_lock
);
2068 spin_unlock_irq(&device_state_lock
);
2072 put_device(&udev
->dev
);
2075 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2076 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2080 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2083 static void announce_device(struct usb_device
*udev
)
2085 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2086 le16_to_cpu(udev
->descriptor
.idVendor
),
2087 le16_to_cpu(udev
->descriptor
.idProduct
));
2088 dev_info(&udev
->dev
,
2089 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2090 udev
->descriptor
.iManufacturer
,
2091 udev
->descriptor
.iProduct
,
2092 udev
->descriptor
.iSerialNumber
);
2093 show_string(udev
, "Product", udev
->product
);
2094 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2095 show_string(udev
, "SerialNumber", udev
->serial
);
2098 static inline void announce_device(struct usb_device
*udev
) { }
2101 #ifdef CONFIG_USB_OTG
2102 #include "otg_whitelist.h"
2106 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2107 * @udev: newly addressed device (in ADDRESS state)
2109 * Finish enumeration for On-The-Go devices
2111 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2115 #ifdef CONFIG_USB_OTG
2117 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2118 * to wake us after we've powered off VBUS; and HNP, switching roles
2119 * "host" to "peripheral". The OTG descriptor helps figure this out.
2121 if (!udev
->bus
->is_b_host
2123 && udev
->parent
== udev
->bus
->root_hub
) {
2124 struct usb_otg_descriptor
*desc
= NULL
;
2125 struct usb_bus
*bus
= udev
->bus
;
2127 /* descriptor may appear anywhere in config */
2128 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2129 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2130 USB_DT_OTG
, (void **) &desc
) == 0) {
2131 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2132 unsigned port1
= udev
->portnum
;
2134 dev_info(&udev
->dev
,
2135 "Dual-Role OTG device on %sHNP port\n",
2136 (port1
== bus
->otg_port
)
2139 /* enable HNP before suspend, it's simpler */
2140 if (port1
== bus
->otg_port
)
2141 bus
->b_hnp_enable
= 1;
2142 err
= usb_control_msg(udev
,
2143 usb_sndctrlpipe(udev
, 0),
2144 USB_REQ_SET_FEATURE
, 0,
2146 ? USB_DEVICE_B_HNP_ENABLE
2147 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2148 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2150 /* OTG MESSAGE: report errors here,
2151 * customize to match your product.
2153 dev_info(&udev
->dev
,
2154 "can't set HNP mode: %d\n",
2156 bus
->b_hnp_enable
= 0;
2162 if (!is_targeted(udev
)) {
2164 /* Maybe it can talk to us, though we can't talk to it.
2165 * (Includes HNP test device.)
2167 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2168 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2170 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2182 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2183 * @udev: newly addressed device (in ADDRESS state)
2185 * This is only called by usb_new_device() and usb_authorize_device()
2186 * and FIXME -- all comments that apply to them apply here wrt to
2189 * If the device is WUSB and not authorized, we don't attempt to read
2190 * the string descriptors, as they will be errored out by the device
2191 * until it has been authorized.
2193 static int usb_enumerate_device(struct usb_device
*udev
)
2197 if (udev
->config
== NULL
) {
2198 err
= usb_get_configuration(udev
);
2201 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2206 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
2207 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2208 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2209 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2212 /* read the standard strings and cache them if present */
2213 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2214 udev
->manufacturer
= usb_cache_string(udev
,
2215 udev
->descriptor
.iManufacturer
);
2216 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2218 err
= usb_enumerate_device_otg(udev
);
2222 usb_detect_interface_quirks(udev
);
2227 static void set_usb_port_removable(struct usb_device
*udev
)
2229 struct usb_device
*hdev
= udev
->parent
;
2230 struct usb_hub
*hub
;
2231 u8 port
= udev
->portnum
;
2232 u16 wHubCharacteristics
;
2233 bool removable
= true;
2238 hub
= usb_hub_to_struct_hub(udev
->parent
);
2240 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2242 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2245 if (hub_is_superspeed(hdev
)) {
2246 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2250 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2255 udev
->removable
= USB_DEVICE_REMOVABLE
;
2257 udev
->removable
= USB_DEVICE_FIXED
;
2261 * usb_new_device - perform initial device setup (usbcore-internal)
2262 * @udev: newly addressed device (in ADDRESS state)
2264 * This is called with devices which have been detected but not fully
2265 * enumerated. The device descriptor is available, but not descriptors
2266 * for any device configuration. The caller must have locked either
2267 * the parent hub (if udev is a normal device) or else the
2268 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2269 * udev has already been installed, but udev is not yet visible through
2270 * sysfs or other filesystem code.
2272 * It will return if the device is configured properly or not. Zero if
2273 * the interface was registered with the driver core; else a negative
2276 * This call is synchronous, and may not be used in an interrupt context.
2278 * Only the hub driver or root-hub registrar should ever call this.
2280 int usb_new_device(struct usb_device
*udev
)
2285 /* Initialize non-root-hub device wakeup to disabled;
2286 * device (un)configuration controls wakeup capable
2287 * sysfs power/wakeup controls wakeup enabled/disabled
2289 device_init_wakeup(&udev
->dev
, 0);
2292 /* Tell the runtime-PM framework the device is active */
2293 pm_runtime_set_active(&udev
->dev
);
2294 pm_runtime_get_noresume(&udev
->dev
);
2295 pm_runtime_use_autosuspend(&udev
->dev
);
2296 pm_runtime_enable(&udev
->dev
);
2298 /* By default, forbid autosuspend for all devices. It will be
2299 * allowed for hubs during binding.
2301 usb_disable_autosuspend(udev
);
2303 err
= usb_enumerate_device(udev
); /* Read descriptors */
2306 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2307 udev
->devnum
, udev
->bus
->busnum
,
2308 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2309 /* export the usbdev device-node for libusb */
2310 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2311 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2313 /* Tell the world! */
2314 announce_device(udev
);
2317 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2319 add_device_randomness(udev
->product
, strlen(udev
->product
));
2320 if (udev
->manufacturer
)
2321 add_device_randomness(udev
->manufacturer
,
2322 strlen(udev
->manufacturer
));
2324 device_enable_async_suspend(&udev
->dev
);
2327 * check whether the hub marks this port as non-removable. Do it
2328 * now so that platform-specific data can override it in
2332 set_usb_port_removable(udev
);
2334 /* Register the device. The device driver is responsible
2335 * for configuring the device and invoking the add-device
2336 * notifier chain (used by usbfs and possibly others).
2338 err
= device_add(&udev
->dev
);
2340 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2344 /* Create link files between child device and usb port device. */
2346 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2347 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2349 err
= sysfs_create_link(&udev
->dev
.kobj
,
2350 &port_dev
->dev
.kobj
, "port");
2354 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2355 &udev
->dev
.kobj
, "device");
2357 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2361 pm_runtime_get_sync(&port_dev
->dev
);
2364 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2365 usb_mark_last_busy(udev
);
2366 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2370 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2371 pm_runtime_disable(&udev
->dev
);
2372 pm_runtime_set_suspended(&udev
->dev
);
2378 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2379 * @usb_dev: USB device
2381 * Move the USB device to a very basic state where interfaces are disabled
2382 * and the device is in fact unconfigured and unusable.
2384 * We share a lock (that we have) with device_del(), so we need to
2387 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2389 usb_lock_device(usb_dev
);
2390 if (usb_dev
->authorized
== 0)
2391 goto out_unauthorized
;
2393 usb_dev
->authorized
= 0;
2394 usb_set_configuration(usb_dev
, -1);
2396 kfree(usb_dev
->product
);
2397 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2398 kfree(usb_dev
->manufacturer
);
2399 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2400 kfree(usb_dev
->serial
);
2401 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2403 usb_destroy_configuration(usb_dev
);
2404 usb_dev
->descriptor
.bNumConfigurations
= 0;
2407 usb_unlock_device(usb_dev
);
2412 int usb_authorize_device(struct usb_device
*usb_dev
)
2416 usb_lock_device(usb_dev
);
2417 if (usb_dev
->authorized
== 1)
2418 goto out_authorized
;
2420 result
= usb_autoresume_device(usb_dev
);
2422 dev_err(&usb_dev
->dev
,
2423 "can't autoresume for authorization: %d\n", result
);
2424 goto error_autoresume
;
2426 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2428 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2429 "authorization: %d\n", result
);
2430 goto error_device_descriptor
;
2433 kfree(usb_dev
->product
);
2434 usb_dev
->product
= NULL
;
2435 kfree(usb_dev
->manufacturer
);
2436 usb_dev
->manufacturer
= NULL
;
2437 kfree(usb_dev
->serial
);
2438 usb_dev
->serial
= NULL
;
2440 usb_dev
->authorized
= 1;
2441 result
= usb_enumerate_device(usb_dev
);
2443 goto error_enumerate
;
2444 /* Choose and set the configuration. This registers the interfaces
2445 * with the driver core and lets interface drivers bind to them.
2447 c
= usb_choose_configuration(usb_dev
);
2449 result
= usb_set_configuration(usb_dev
, c
);
2451 dev_err(&usb_dev
->dev
,
2452 "can't set config #%d, error %d\n", c
, result
);
2453 /* This need not be fatal. The user can try to
2454 * set other configurations. */
2457 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2460 error_device_descriptor
:
2461 usb_autosuspend_device(usb_dev
);
2464 usb_unlock_device(usb_dev
); // complements locktree
2469 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2470 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2472 struct usb_hcd
*hcd
;
2473 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2475 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2476 return hcd
->wireless
;
2480 #define PORT_RESET_TRIES 5
2481 #define SET_ADDRESS_TRIES 2
2482 #define GET_DESCRIPTOR_TRIES 2
2483 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2484 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2486 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2487 #define HUB_SHORT_RESET_TIME 10
2488 #define HUB_BH_RESET_TIME 50
2489 #define HUB_LONG_RESET_TIME 200
2490 #define HUB_RESET_TIMEOUT 800
2492 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2493 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2495 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2496 * Port worm reset is required to recover
2498 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2500 return hub_is_superspeed(hub
->hdev
) &&
2501 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2502 USB_SS_PORT_LS_SS_INACTIVE
) ||
2503 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2504 USB_SS_PORT_LS_COMP_MOD
)) ;
2507 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2508 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2510 int delay_time
, ret
;
2514 for (delay_time
= 0;
2515 delay_time
< HUB_RESET_TIMEOUT
;
2516 delay_time
+= delay
) {
2517 /* wait to give the device a chance to reset */
2520 /* read and decode port status */
2521 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2525 /* The port state is unknown until the reset completes. */
2526 if (!(portstatus
& USB_PORT_STAT_RESET
))
2529 /* switch to the long delay after two short delay failures */
2530 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2531 delay
= HUB_LONG_RESET_TIME
;
2533 dev_dbg (hub
->intfdev
,
2534 "port %d not %sreset yet, waiting %dms\n",
2535 port1
, warm
? "warm " : "", delay
);
2538 if ((portstatus
& USB_PORT_STAT_RESET
))
2541 if (hub_port_warm_reset_required(hub
, portstatus
))
2544 /* Device went away? */
2545 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2548 /* bomb out completely if the connection bounced. A USB 3.0
2549 * connection may bounce if multiple warm resets were issued,
2550 * but the device may have successfully re-connected. Ignore it.
2552 if (!hub_is_superspeed(hub
->hdev
) &&
2553 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2556 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2562 if (hub_is_wusb(hub
))
2563 udev
->speed
= USB_SPEED_WIRELESS
;
2564 else if (hub_is_superspeed(hub
->hdev
))
2565 udev
->speed
= USB_SPEED_SUPER
;
2566 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2567 udev
->speed
= USB_SPEED_HIGH
;
2568 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2569 udev
->speed
= USB_SPEED_LOW
;
2571 udev
->speed
= USB_SPEED_FULL
;
2575 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2576 struct usb_device
*udev
, int *status
)
2580 /* TRSTRCY = 10 ms; plus some extra */
2583 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2585 update_devnum(udev
, 0);
2586 /* The xHC may think the device is already reset,
2587 * so ignore the status.
2589 if (hcd
->driver
->reset_device
)
2590 hcd
->driver
->reset_device(hcd
, udev
);
2595 usb_clear_port_feature(hub
->hdev
,
2596 port1
, USB_PORT_FEAT_C_RESET
);
2597 if (hub_is_superspeed(hub
->hdev
)) {
2598 usb_clear_port_feature(hub
->hdev
, port1
,
2599 USB_PORT_FEAT_C_BH_PORT_RESET
);
2600 usb_clear_port_feature(hub
->hdev
, port1
,
2601 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2602 usb_clear_port_feature(hub
->hdev
, port1
,
2603 USB_PORT_FEAT_C_CONNECTION
);
2606 usb_set_device_state(udev
, *status
2607 ? USB_STATE_NOTATTACHED
2608 : USB_STATE_DEFAULT
);
2613 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2614 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2615 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2618 u16 portchange
, portstatus
;
2620 if (!hub_is_superspeed(hub
->hdev
)) {
2622 dev_err(hub
->intfdev
, "only USB3 hub support "
2626 /* Block EHCI CF initialization during the port reset.
2627 * Some companion controllers don't like it when they mix.
2629 down_read(&ehci_cf_port_reset_rwsem
);
2632 * If the caller hasn't explicitly requested a warm reset,
2633 * double check and see if one is needed.
2635 status
= hub_port_status(hub
, port1
,
2636 &portstatus
, &portchange
);
2640 if (hub_port_warm_reset_required(hub
, portstatus
))
2644 /* Reset the port */
2645 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2646 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2647 USB_PORT_FEAT_BH_PORT_RESET
:
2648 USB_PORT_FEAT_RESET
));
2649 if (status
== -ENODEV
) {
2650 ; /* The hub is gone */
2651 } else if (status
) {
2652 dev_err(hub
->intfdev
,
2653 "cannot %sreset port %d (err = %d)\n",
2654 warm
? "warm " : "", port1
, status
);
2656 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2658 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2659 dev_dbg(hub
->intfdev
,
2660 "port_wait_reset: err = %d\n",
2664 /* Check for disconnect or reset */
2665 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2666 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2668 if (!hub_is_superspeed(hub
->hdev
))
2672 * If a USB 3.0 device migrates from reset to an error
2673 * state, re-issue the warm reset.
2675 if (hub_port_status(hub
, port1
,
2676 &portstatus
, &portchange
) < 0)
2679 if (!hub_port_warm_reset_required(hub
, portstatus
))
2683 * If the port is in SS.Inactive or Compliance Mode, the
2684 * hot or warm reset failed. Try another warm reset.
2687 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2693 dev_dbg (hub
->intfdev
,
2694 "port %d not enabled, trying %sreset again...\n",
2695 port1
, warm
? "warm " : "");
2696 delay
= HUB_LONG_RESET_TIME
;
2699 dev_err (hub
->intfdev
,
2700 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2704 if (!hub_is_superspeed(hub
->hdev
))
2705 up_read(&ehci_cf_port_reset_rwsem
);
2710 /* Check if a port is power on */
2711 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2715 if (hub_is_superspeed(hub
->hdev
)) {
2716 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2719 if (portstatus
& USB_PORT_STAT_POWER
)
2728 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2729 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2733 if (hub_is_superspeed(hub
->hdev
)) {
2734 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2735 == USB_SS_PORT_LS_U3
)
2738 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2745 /* Determine whether the device on a port is ready for a normal resume,
2746 * is ready for a reset-resume, or should be disconnected.
2748 static int check_port_resume_type(struct usb_device
*udev
,
2749 struct usb_hub
*hub
, int port1
,
2750 int status
, unsigned portchange
, unsigned portstatus
)
2752 /* Is the device still present? */
2753 if (status
|| port_is_suspended(hub
, portstatus
) ||
2754 !port_is_power_on(hub
, portstatus
) ||
2755 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2760 /* Can't do a normal resume if the port isn't enabled,
2761 * so try a reset-resume instead.
2763 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2764 if (udev
->persist_enabled
)
2765 udev
->reset_resume
= 1;
2771 dev_dbg(hub
->intfdev
,
2772 "port %d status %04x.%04x after resume, %d\n",
2773 port1
, portchange
, portstatus
, status
);
2774 } else if (udev
->reset_resume
) {
2776 /* Late port handoff can set status-change bits */
2777 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2778 usb_clear_port_feature(hub
->hdev
, port1
,
2779 USB_PORT_FEAT_C_CONNECTION
);
2780 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2781 usb_clear_port_feature(hub
->hdev
, port1
,
2782 USB_PORT_FEAT_C_ENABLE
);
2788 int usb_disable_ltm(struct usb_device
*udev
)
2790 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2792 /* Check if the roothub and device supports LTM. */
2793 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2794 !usb_device_supports_ltm(udev
))
2797 /* Clear Feature LTM Enable can only be sent if the device is
2800 if (!udev
->actconfig
)
2803 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2804 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2805 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2806 USB_CTRL_SET_TIMEOUT
);
2808 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2810 void usb_enable_ltm(struct usb_device
*udev
)
2812 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2814 /* Check if the roothub and device supports LTM. */
2815 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2816 !usb_device_supports_ltm(udev
))
2819 /* Set Feature LTM Enable can only be sent if the device is
2822 if (!udev
->actconfig
)
2825 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2826 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2827 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2828 USB_CTRL_SET_TIMEOUT
);
2830 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2834 * usb_disable_function_remotewakeup - disable usb3.0
2835 * device's function remote wakeup
2836 * @udev: target device
2838 * Assume there's only one function on the USB 3.0
2839 * device and disable remote wake for the first
2840 * interface. FIXME if the interface association
2841 * descriptor shows there's more than one function.
2843 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2845 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2846 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2847 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2848 USB_CTRL_SET_TIMEOUT
);
2851 /* Count of wakeup-enabled devices at or below udev */
2852 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2854 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2856 return udev
->do_remote_wakeup
+
2857 (hub
? hub
->wakeup_enabled_descendants
: 0);
2861 * usb_port_suspend - suspend a usb device's upstream port
2862 * @udev: device that's no longer in active use, not a root hub
2863 * Context: must be able to sleep; device not locked; pm locks held
2865 * Suspends a USB device that isn't in active use, conserving power.
2866 * Devices may wake out of a suspend, if anything important happens,
2867 * using the remote wakeup mechanism. They may also be taken out of
2868 * suspend by the host, using usb_port_resume(). It's also routine
2869 * to disconnect devices while they are suspended.
2871 * This only affects the USB hardware for a device; its interfaces
2872 * (and, for hubs, child devices) must already have been suspended.
2874 * Selective port suspend reduces power; most suspended devices draw
2875 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2876 * All devices below the suspended port are also suspended.
2878 * Devices leave suspend state when the host wakes them up. Some devices
2879 * also support "remote wakeup", where the device can activate the USB
2880 * tree above them to deliver data, such as a keypress or packet. In
2881 * some cases, this wakes the USB host.
2883 * Suspending OTG devices may trigger HNP, if that's been enabled
2884 * between a pair of dual-role devices. That will change roles, such
2885 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2887 * Devices on USB hub ports have only one "suspend" state, corresponding
2888 * to ACPI D2, "may cause the device to lose some context".
2889 * State transitions include:
2891 * - suspend, resume ... when the VBUS power link stays live
2892 * - suspend, disconnect ... VBUS lost
2894 * Once VBUS drop breaks the circuit, the port it's using has to go through
2895 * normal re-enumeration procedures, starting with enabling VBUS power.
2896 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2897 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2898 * timer, no SRP, no requests through sysfs.
2900 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2901 * suspended until their bus goes into global suspend (i.e., the root
2902 * hub is suspended). Nevertheless, we change @udev->state to
2903 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2904 * upstream port setting is stored in @udev->port_is_suspended.
2906 * Returns 0 on success, else negative errno.
2908 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2910 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2911 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2912 enum pm_qos_flags_status pm_qos_stat
;
2913 int port1
= udev
->portnum
;
2915 bool really_suspend
= true;
2917 /* enable remote wakeup when appropriate; this lets the device
2918 * wake up the upstream hub (including maybe the root hub).
2920 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2921 * we don't explicitly enable it here.
2923 if (udev
->do_remote_wakeup
) {
2924 if (!hub_is_superspeed(hub
->hdev
)) {
2925 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2926 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2927 USB_DEVICE_REMOTE_WAKEUP
, 0,
2929 USB_CTRL_SET_TIMEOUT
);
2931 /* Assume there's only one function on the USB 3.0
2932 * device and enable remote wake for the first
2933 * interface. FIXME if the interface association
2934 * descriptor shows there's more than one function.
2936 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2937 USB_REQ_SET_FEATURE
,
2938 USB_RECIP_INTERFACE
,
2939 USB_INTRF_FUNC_SUSPEND
,
2940 USB_INTRF_FUNC_SUSPEND_RW
|
2941 USB_INTRF_FUNC_SUSPEND_LP
,
2943 USB_CTRL_SET_TIMEOUT
);
2946 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2948 /* bail if autosuspend is requested */
2949 if (PMSG_IS_AUTO(msg
))
2954 /* disable USB2 hardware LPM */
2955 if (udev
->usb2_hw_lpm_enabled
== 1)
2956 usb_set_usb2_hardware_lpm(udev
, 0);
2958 if (usb_disable_ltm(udev
)) {
2959 dev_err(&udev
->dev
, "%s Failed to disable LTM before suspend\n.",
2963 if (usb_unlocked_disable_lpm(udev
)) {
2964 dev_err(&udev
->dev
, "%s Failed to disable LPM before suspend\n.",
2970 if (hub_is_superspeed(hub
->hdev
))
2971 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
2974 * For system suspend, we do not need to enable the suspend feature
2975 * on individual USB-2 ports. The devices will automatically go
2976 * into suspend a few ms after the root hub stops sending packets.
2977 * The USB 2.0 spec calls this "global suspend".
2979 * However, many USB hubs have a bug: They don't relay wakeup requests
2980 * from a downstream port if the port's suspend feature isn't on.
2981 * Therefore we will turn on the suspend feature if udev or any of its
2982 * descendants is enabled for remote wakeup.
2984 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
2985 status
= set_port_feature(hub
->hdev
, port1
,
2986 USB_PORT_FEAT_SUSPEND
);
2988 really_suspend
= false;
2992 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2994 /* paranoia: "should not happen" */
2995 if (udev
->do_remote_wakeup
) {
2996 if (!hub_is_superspeed(hub
->hdev
)) {
2997 (void) usb_control_msg(udev
,
2998 usb_sndctrlpipe(udev
, 0),
2999 USB_REQ_CLEAR_FEATURE
,
3001 USB_DEVICE_REMOTE_WAKEUP
, 0,
3003 USB_CTRL_SET_TIMEOUT
);
3005 (void) usb_disable_function_remotewakeup(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 /* Try to enable USB3 LTM and LPM again */
3014 usb_enable_ltm(udev
);
3015 usb_unlocked_enable_lpm(udev
);
3017 /* System sleep transitions should never fail */
3018 if (!PMSG_IS_AUTO(msg
))
3021 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3022 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3023 udev
->do_remote_wakeup
);
3024 if (really_suspend
) {
3025 udev
->port_is_suspended
= 1;
3027 /* device has up to 10 msec to fully suspend */
3030 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3034 * Check whether current status meets the requirement of
3035 * usb port power off mechanism
3037 pm_qos_stat
= dev_pm_qos_flags(&port_dev
->dev
,
3038 PM_QOS_FLAG_NO_POWER_OFF
);
3039 if (!udev
->do_remote_wakeup
3040 && pm_qos_stat
!= PM_QOS_FLAGS_ALL
3041 && udev
->persist_enabled
3043 pm_runtime_put_sync(&port_dev
->dev
);
3044 port_dev
->did_runtime_put
= true;
3047 usb_mark_last_busy(hub
->hdev
);
3052 * If the USB "suspend" state is in use (rather than "global suspend"),
3053 * many devices will be individually taken out of suspend state using
3054 * special "resume" signaling. This routine kicks in shortly after
3055 * hardware resume signaling is finished, either because of selective
3056 * resume (by host) or remote wakeup (by device) ... now see what changed
3057 * in the tree that's rooted at this device.
3059 * If @udev->reset_resume is set then the device is reset before the
3060 * status check is done.
3062 static int finish_port_resume(struct usb_device
*udev
)
3067 /* caller owns the udev device lock */
3068 dev_dbg(&udev
->dev
, "%s\n",
3069 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3071 /* usb ch9 identifies four variants of SUSPENDED, based on what
3072 * state the device resumes to. Linux currently won't see the
3073 * first two on the host side; they'd be inside hub_port_init()
3074 * during many timeouts, but khubd can't suspend until later.
3076 usb_set_device_state(udev
, udev
->actconfig
3077 ? USB_STATE_CONFIGURED
3078 : USB_STATE_ADDRESS
);
3080 /* 10.5.4.5 says not to reset a suspended port if the attached
3081 * device is enabled for remote wakeup. Hence the reset
3082 * operation is carried out here, after the port has been
3085 if (udev
->reset_resume
)
3087 status
= usb_reset_and_verify_device(udev
);
3089 /* 10.5.4.5 says be sure devices in the tree are still there.
3090 * For now let's assume the device didn't go crazy on resume,
3091 * and device drivers will know about any resume quirks.
3095 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3097 status
= (status
> 0 ? 0 : -ENODEV
);
3099 /* If a normal resume failed, try doing a reset-resume */
3100 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3101 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3102 udev
->reset_resume
= 1;
3103 goto retry_reset_resume
;
3108 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3111 * There are a few quirky devices which violate the standard
3112 * by claiming to have remote wakeup enabled after a reset,
3113 * which crash if the feature is cleared, hence check for
3114 * udev->reset_resume
3116 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3117 if (!hub_is_superspeed(udev
->parent
)) {
3118 le16_to_cpus(&devstatus
);
3119 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3120 status
= usb_control_msg(udev
,
3121 usb_sndctrlpipe(udev
, 0),
3122 USB_REQ_CLEAR_FEATURE
,
3124 USB_DEVICE_REMOTE_WAKEUP
, 0,
3126 USB_CTRL_SET_TIMEOUT
);
3128 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3130 le16_to_cpus(&devstatus
);
3131 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3132 | USB_INTRF_STAT_FUNC_RW
))
3134 usb_disable_function_remotewakeup(udev
);
3139 "disable remote wakeup, status %d\n",
3147 * usb_port_resume - re-activate a suspended usb device's upstream port
3148 * @udev: device to re-activate, not a root hub
3149 * Context: must be able to sleep; device not locked; pm locks held
3151 * This will re-activate the suspended device, increasing power usage
3152 * while letting drivers communicate again with its endpoints.
3153 * USB resume explicitly guarantees that the power session between
3154 * the host and the device is the same as it was when the device
3157 * If @udev->reset_resume is set then this routine won't check that the
3158 * port is still enabled. Furthermore, finish_port_resume() above will
3159 * reset @udev. The end result is that a broken power session can be
3160 * recovered and @udev will appear to persist across a loss of VBUS power.
3162 * For example, if a host controller doesn't maintain VBUS suspend current
3163 * during a system sleep or is reset when the system wakes up, all the USB
3164 * power sessions below it will be broken. This is especially troublesome
3165 * for mass-storage devices containing mounted filesystems, since the
3166 * device will appear to have disconnected and all the memory mappings
3167 * to it will be lost. Using the USB_PERSIST facility, the device can be
3168 * made to appear as if it had not disconnected.
3170 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3171 * every effort to insure that the same device is present after the
3172 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3173 * quite possible for a device to remain unaltered but its media to be
3174 * changed. If the user replaces a flash memory card while the system is
3175 * asleep, he will have only himself to blame when the filesystem on the
3176 * new card is corrupted and the system crashes.
3178 * Returns 0 on success, else negative errno.
3180 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3182 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3183 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3184 int port1
= udev
->portnum
;
3186 u16 portchange
, portstatus
;
3188 if (port_dev
->did_runtime_put
) {
3189 status
= pm_runtime_get_sync(&port_dev
->dev
);
3190 port_dev
->did_runtime_put
= false;
3192 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3198 /* Skip the initial Clear-Suspend step for a remote wakeup */
3199 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3200 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3201 goto SuspendCleared
;
3203 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3205 set_bit(port1
, hub
->busy_bits
);
3207 /* see 7.1.7.7; affects power usage, but not budgeting */
3208 if (hub_is_superspeed(hub
->hdev
))
3209 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3211 status
= usb_clear_port_feature(hub
->hdev
,
3212 port1
, USB_PORT_FEAT_SUSPEND
);
3214 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3217 /* drive resume for at least 20 msec */
3218 dev_dbg(&udev
->dev
, "usb %sresume\n",
3219 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3222 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3223 * stop resume signaling. Then finish the resume
3226 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3228 /* TRSMRCY = 10 msec */
3234 udev
->port_is_suspended
= 0;
3235 if (hub_is_superspeed(hub
->hdev
)) {
3236 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3237 usb_clear_port_feature(hub
->hdev
, port1
,
3238 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3240 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3241 usb_clear_port_feature(hub
->hdev
, port1
,
3242 USB_PORT_FEAT_C_SUSPEND
);
3246 clear_bit(port1
, hub
->busy_bits
);
3248 status
= check_port_resume_type(udev
,
3249 hub
, port1
, status
, portchange
, portstatus
);
3251 status
= finish_port_resume(udev
);
3253 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3254 hub_port_logical_disconnect(hub
, port1
);
3256 /* Try to enable USB2 hardware LPM */
3257 if (udev
->usb2_hw_lpm_capable
== 1)
3258 usb_set_usb2_hardware_lpm(udev
, 1);
3260 /* Try to enable USB3 LTM and LPM */
3261 usb_enable_ltm(udev
);
3262 usb_unlocked_enable_lpm(udev
);
3268 #endif /* CONFIG_PM */
3270 #ifdef CONFIG_PM_RUNTIME
3272 /* caller has locked udev */
3273 int usb_remote_wakeup(struct usb_device
*udev
)
3277 if (udev
->state
== USB_STATE_SUSPENDED
) {
3278 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3279 status
= usb_autoresume_device(udev
);
3281 /* Let the drivers do their thing, then... */
3282 usb_autosuspend_device(udev
);
3290 static int check_ports_changed(struct usb_hub
*hub
)
3294 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3295 u16 portstatus
, portchange
;
3298 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3299 if (!status
&& portchange
)
3305 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3307 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3308 struct usb_device
*hdev
= hub
->hdev
;
3313 * Warn if children aren't already suspended.
3314 * Also, add up the number of wakeup-enabled descendants.
3316 hub
->wakeup_enabled_descendants
= 0;
3317 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3318 struct usb_device
*udev
;
3320 udev
= hub
->ports
[port1
- 1]->child
;
3321 if (udev
&& udev
->can_submit
) {
3322 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3323 if (PMSG_IS_AUTO(msg
))
3327 hub
->wakeup_enabled_descendants
+=
3328 wakeup_enabled_descendants(udev
);
3331 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3332 /* check if there are changes pending on hub ports */
3333 if (check_ports_changed(hub
)) {
3334 if (PMSG_IS_AUTO(msg
))
3336 pm_wakeup_event(&hdev
->dev
, 2000);
3340 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3341 /* Enable hub to send remote wakeup for all ports. */
3342 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3343 status
= set_port_feature(hdev
,
3345 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3346 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3347 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3348 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3352 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3354 /* stop khubd and related activity */
3355 hub_quiesce(hub
, HUB_SUSPEND
);
3359 static int hub_resume(struct usb_interface
*intf
)
3361 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3363 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3364 hub_activate(hub
, HUB_RESUME
);
3368 static int hub_reset_resume(struct usb_interface
*intf
)
3370 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3372 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3373 hub_activate(hub
, HUB_RESET_RESUME
);
3378 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3379 * @rhdev: struct usb_device for the root hub
3381 * The USB host controller driver calls this function when its root hub
3382 * is resumed and Vbus power has been interrupted or the controller
3383 * has been reset. The routine marks @rhdev as having lost power.
3384 * When the hub driver is resumed it will take notice and carry out
3385 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3386 * the others will be disconnected.
3388 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3390 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3391 rhdev
->reset_resume
= 1;
3393 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3395 static const char * const usb3_lpm_names
[] = {
3403 * Send a Set SEL control transfer to the device, prior to enabling
3404 * device-initiated U1 or U2. This lets the device know the exit latencies from
3405 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3406 * packet from the host.
3408 * This function will fail if the SEL or PEL values for udev are greater than
3409 * the maximum allowed values for the link state to be enabled.
3411 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3413 struct usb_set_sel_req
*sel_values
;
3414 unsigned long long u1_sel
;
3415 unsigned long long u1_pel
;
3416 unsigned long long u2_sel
;
3417 unsigned long long u2_pel
;
3420 /* Convert SEL and PEL stored in ns to us */
3421 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3422 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3423 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3424 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3427 * Make sure that the calculated SEL and PEL values for the link
3428 * state we're enabling aren't bigger than the max SEL/PEL
3429 * value that will fit in the SET SEL control transfer.
3430 * Otherwise the device would get an incorrect idea of the exit
3431 * latency for the link state, and could start a device-initiated
3432 * U1/U2 when the exit latencies are too high.
3434 if ((state
== USB3_LPM_U1
&&
3435 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3436 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3437 (state
== USB3_LPM_U2
&&
3438 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3439 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3440 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3441 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3446 * If we're enabling device-initiated LPM for one link state,
3447 * but the other link state has a too high SEL or PEL value,
3448 * just set those values to the max in the Set SEL request.
3450 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3451 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3453 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3454 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3456 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3457 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3459 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3460 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3463 * usb_enable_lpm() can be called as part of a failed device reset,
3464 * which may be initiated by an error path of a mass storage driver.
3465 * Therefore, use GFP_NOIO.
3467 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3471 sel_values
->u1_sel
= u1_sel
;
3472 sel_values
->u1_pel
= u1_pel
;
3473 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3474 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3476 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3480 sel_values
, sizeof *(sel_values
),
3481 USB_CTRL_SET_TIMEOUT
);
3487 * Enable or disable device-initiated U1 or U2 transitions.
3489 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3490 enum usb3_link_state state
, bool enable
)
3497 feature
= USB_DEVICE_U1_ENABLE
;
3500 feature
= USB_DEVICE_U2_ENABLE
;
3503 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3504 __func__
, enable
? "enable" : "disable");
3508 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3509 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3510 "for unconfigured device.\n",
3511 __func__
, enable
? "enable" : "disable",
3512 usb3_lpm_names
[state
]);
3518 * Now send the control transfer to enable device-initiated LPM
3519 * for either U1 or U2.
3521 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3522 USB_REQ_SET_FEATURE
,
3526 USB_CTRL_SET_TIMEOUT
);
3528 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3529 USB_REQ_CLEAR_FEATURE
,
3533 USB_CTRL_SET_TIMEOUT
);
3536 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3537 enable
? "Enable" : "Disable",
3538 usb3_lpm_names
[state
]);
3544 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3545 enum usb3_link_state state
, int timeout
)
3552 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3555 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3558 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3563 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3564 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3565 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3566 "which is a reserved value.\n",
3567 usb3_lpm_names
[state
], timeout
);
3571 ret
= set_port_feature(udev
->parent
,
3572 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3575 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3576 "error code %i\n", usb3_lpm_names
[state
],
3580 if (state
== USB3_LPM_U1
)
3581 udev
->u1_params
.timeout
= timeout
;
3583 udev
->u2_params
.timeout
= timeout
;
3588 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3591 * We will attempt to enable U1 or U2, but there are no guarantees that the
3592 * control transfers to set the hub timeout or enable device-initiated U1/U2
3593 * will be successful.
3595 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3596 * driver know about it. If that call fails, it should be harmless, and just
3597 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3599 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3600 enum usb3_link_state state
)
3603 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3604 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3606 /* If the device says it doesn't have *any* exit latency to come out of
3607 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3610 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3611 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3615 * First, let the device know about the exit latencies
3616 * associated with the link state we're about to enable.
3618 ret
= usb_req_set_sel(udev
, state
);
3620 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3621 usb3_lpm_names
[state
]);
3625 /* We allow the host controller to set the U1/U2 timeout internally
3626 * first, so that it can change its schedule to account for the
3627 * additional latency to send data to a device in a lower power
3630 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3632 /* xHCI host controller doesn't want to enable this LPM state. */
3637 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3638 "xHCI error %i.\n", usb3_lpm_names
[state
],
3643 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3644 /* If we can't set the parent hub U1/U2 timeout,
3645 * device-initiated LPM won't be allowed either, so let the xHCI
3646 * host know that this link state won't be enabled.
3648 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3650 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3651 else if (udev
->actconfig
)
3652 usb_set_device_initiated_lpm(udev
, state
, true);
3657 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3660 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3661 * If zero is returned, the parent will not allow the link to go into U1/U2.
3663 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3664 * it won't have an effect on the bus link state because the parent hub will
3665 * still disallow device-initiated U1/U2 entry.
3667 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3668 * possible. The result will be slightly more bus bandwidth will be taken up
3669 * (to account for U1/U2 exit latency), but it should be harmless.
3671 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3672 enum usb3_link_state state
)
3678 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3681 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3684 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3689 if (usb_set_lpm_timeout(udev
, state
, 0))
3692 usb_set_device_initiated_lpm(udev
, state
, false);
3694 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3695 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3696 "bus schedule bandwidth may be impacted.\n",
3697 usb3_lpm_names
[state
]);
3702 * Disable hub-initiated and device-initiated U1 and U2 entry.
3703 * Caller must own the bandwidth_mutex.
3705 * This will call usb_enable_lpm() on failure, which will decrement
3706 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3708 int usb_disable_lpm(struct usb_device
*udev
)
3710 struct usb_hcd
*hcd
;
3712 if (!udev
|| !udev
->parent
||
3713 udev
->speed
!= USB_SPEED_SUPER
||
3717 hcd
= bus_to_hcd(udev
->bus
);
3718 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3721 udev
->lpm_disable_count
++;
3722 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3725 /* If LPM is enabled, attempt to disable it. */
3726 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3728 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3734 usb_enable_lpm(udev
);
3737 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3739 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3740 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3742 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3748 mutex_lock(hcd
->bandwidth_mutex
);
3749 ret
= usb_disable_lpm(udev
);
3750 mutex_unlock(hcd
->bandwidth_mutex
);
3754 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3757 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3758 * xHCI host policy may prevent U1 or U2 from being enabled.
3760 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3761 * until the lpm_disable_count drops to zero. Caller must own the
3764 void usb_enable_lpm(struct usb_device
*udev
)
3766 struct usb_hcd
*hcd
;
3768 if (!udev
|| !udev
->parent
||
3769 udev
->speed
!= USB_SPEED_SUPER
||
3773 udev
->lpm_disable_count
--;
3774 hcd
= bus_to_hcd(udev
->bus
);
3775 /* Double check that we can both enable and disable LPM.
3776 * Device must be configured to accept set feature U1/U2 timeout.
3778 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3779 !hcd
->driver
->disable_usb3_lpm_timeout
)
3782 if (udev
->lpm_disable_count
> 0)
3785 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3786 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3788 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3790 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3791 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3793 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3798 mutex_lock(hcd
->bandwidth_mutex
);
3799 usb_enable_lpm(udev
);
3800 mutex_unlock(hcd
->bandwidth_mutex
);
3802 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3805 #else /* CONFIG_PM */
3807 #define hub_suspend NULL
3808 #define hub_resume NULL
3809 #define hub_reset_resume NULL
3811 int usb_disable_lpm(struct usb_device
*udev
)
3815 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3817 void usb_enable_lpm(struct usb_device
*udev
) { }
3818 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3820 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3824 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3826 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3827 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3829 int usb_disable_ltm(struct usb_device
*udev
)
3833 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3835 void usb_enable_ltm(struct usb_device
*udev
) { }
3836 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3840 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3842 * Between connect detection and reset signaling there must be a delay
3843 * of 100ms at least for debounce and power-settling. The corresponding
3844 * timer shall restart whenever the downstream port detects a disconnect.
3846 * Apparently there are some bluetooth and irda-dongles and a number of
3847 * low-speed devices for which this debounce period may last over a second.
3848 * Not covered by the spec - but easy to deal with.
3850 * This implementation uses a 1500ms total debounce timeout; if the
3851 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3852 * every 25ms for transient disconnects. When the port status has been
3853 * unchanged for 100ms it returns the port status.
3855 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3858 int total_time
, stable_time
= 0;
3859 u16 portchange
, portstatus
;
3860 unsigned connection
= 0xffff;
3862 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3863 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3867 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3868 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3869 if (!must_be_connected
||
3870 (connection
== USB_PORT_STAT_CONNECTION
))
3871 stable_time
+= HUB_DEBOUNCE_STEP
;
3872 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3876 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3879 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3880 usb_clear_port_feature(hub
->hdev
, port1
,
3881 USB_PORT_FEAT_C_CONNECTION
);
3884 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3886 msleep(HUB_DEBOUNCE_STEP
);
3889 dev_dbg (hub
->intfdev
,
3890 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3891 port1
, total_time
, stable_time
, portstatus
);
3893 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3898 void usb_ep0_reinit(struct usb_device
*udev
)
3900 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3901 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3902 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3904 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3906 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3907 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3909 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3912 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3915 * The host controller will choose the device address,
3916 * instead of the core having chosen it earlier
3918 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3920 if (udev
->state
== USB_STATE_ADDRESS
)
3922 if (udev
->state
!= USB_STATE_DEFAULT
)
3924 if (hcd
->driver
->address_device
)
3925 retval
= hcd
->driver
->address_device(hcd
, udev
);
3927 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3928 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3929 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3931 update_devnum(udev
, devnum
);
3932 /* Device now using proper address. */
3933 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3934 usb_ep0_reinit(udev
);
3939 /* Reset device, (re)assign address, get device descriptor.
3940 * Device connection must be stable, no more debouncing needed.
3941 * Returns device in USB_STATE_ADDRESS, except on error.
3943 * If this is called for an already-existing device (as part of
3944 * usb_reset_and_verify_device), the caller must own the device lock. For a
3945 * newly detected device that is not accessible through any global
3946 * pointers, it's not necessary to lock the device.
3949 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
3952 static DEFINE_MUTEX(usb_address0_mutex
);
3954 struct usb_device
*hdev
= hub
->hdev
;
3955 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3957 unsigned delay
= HUB_SHORT_RESET_TIME
;
3958 enum usb_device_speed oldspeed
= udev
->speed
;
3960 int devnum
= udev
->devnum
;
3962 /* root hub ports have a slightly longer reset period
3963 * (from USB 2.0 spec, section 7.1.7.5)
3965 if (!hdev
->parent
) {
3966 delay
= HUB_ROOT_RESET_TIME
;
3967 if (port1
== hdev
->bus
->otg_port
)
3968 hdev
->bus
->b_hnp_enable
= 0;
3971 /* Some low speed devices have problems with the quick delay, so */
3972 /* be a bit pessimistic with those devices. RHbug #23670 */
3973 if (oldspeed
== USB_SPEED_LOW
)
3974 delay
= HUB_LONG_RESET_TIME
;
3976 mutex_lock(&usb_address0_mutex
);
3978 /* Reset the device; full speed may morph to high speed */
3979 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3980 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
3981 if (retval
< 0) /* error or disconnect */
3983 /* success, speed is known */
3987 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
3988 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
3991 oldspeed
= udev
->speed
;
3993 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3994 * it's fixed size except for full speed devices.
3995 * For Wireless USB devices, ep0 max packet is always 512 (tho
3996 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3998 switch (udev
->speed
) {
3999 case USB_SPEED_SUPER
:
4000 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4001 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4003 case USB_SPEED_HIGH
: /* fixed at 64 */
4004 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4006 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4007 /* to determine the ep0 maxpacket size, try to read
4008 * the device descriptor to get bMaxPacketSize0 and
4009 * then correct our initial guess.
4011 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4013 case USB_SPEED_LOW
: /* fixed at 8 */
4014 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4020 if (udev
->speed
== USB_SPEED_WIRELESS
)
4021 speed
= "variable speed Wireless";
4023 speed
= usb_speed_string(udev
->speed
);
4025 if (udev
->speed
!= USB_SPEED_SUPER
)
4026 dev_info(&udev
->dev
,
4027 "%s %s USB device number %d using %s\n",
4028 (udev
->config
) ? "reset" : "new", speed
,
4029 devnum
, udev
->bus
->controller
->driver
->name
);
4031 /* Set up TT records, if needed */
4033 udev
->tt
= hdev
->tt
;
4034 udev
->ttport
= hdev
->ttport
;
4035 } else if (udev
->speed
!= USB_SPEED_HIGH
4036 && hdev
->speed
== USB_SPEED_HIGH
) {
4038 dev_err(&udev
->dev
, "parent hub has no TT\n");
4042 udev
->tt
= &hub
->tt
;
4043 udev
->ttport
= port1
;
4046 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4047 * Because device hardware and firmware is sometimes buggy in
4048 * this area, and this is how Linux has done it for ages.
4049 * Change it cautiously.
4051 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4052 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4053 * so it may help with some non-standards-compliant devices.
4054 * Otherwise we start with SET_ADDRESS and then try to read the
4055 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4058 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4059 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4060 struct usb_device_descriptor
*buf
;
4063 #define GET_DESCRIPTOR_BUFSIZE 64
4064 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4070 /* Retry on all errors; some devices are flakey.
4071 * 255 is for WUSB devices, we actually need to use
4072 * 512 (WUSB1.0[4.8.1]).
4074 for (j
= 0; j
< 3; ++j
) {
4075 buf
->bMaxPacketSize0
= 0;
4076 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4077 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4078 USB_DT_DEVICE
<< 8, 0,
4079 buf
, GET_DESCRIPTOR_BUFSIZE
,
4080 initial_descriptor_timeout
);
4081 switch (buf
->bMaxPacketSize0
) {
4082 case 8: case 16: case 32: case 64: case 255:
4083 if (buf
->bDescriptorType
==
4097 udev
->descriptor
.bMaxPacketSize0
=
4098 buf
->bMaxPacketSize0
;
4101 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4102 if (retval
< 0) /* error or disconnect */
4104 if (oldspeed
!= udev
->speed
) {
4106 "device reset changed speed!\n");
4112 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4117 #undef GET_DESCRIPTOR_BUFSIZE
4121 * If device is WUSB, we already assigned an
4122 * unauthorized address in the Connect Ack sequence;
4123 * authorization will assign the final address.
4125 if (udev
->wusb
== 0) {
4126 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4127 retval
= hub_set_address(udev
, devnum
);
4133 if (retval
!= -ENODEV
)
4134 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4138 if (udev
->speed
== USB_SPEED_SUPER
) {
4139 devnum
= udev
->devnum
;
4140 dev_info(&udev
->dev
,
4141 "%s SuperSpeed USB device number %d using %s\n",
4142 (udev
->config
) ? "reset" : "new",
4143 devnum
, udev
->bus
->controller
->driver
->name
);
4146 /* cope with hardware quirkiness:
4147 * - let SET_ADDRESS settle, some device hardware wants it
4148 * - read ep0 maxpacket even for high and low speed,
4151 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4155 retval
= usb_get_device_descriptor(udev
, 8);
4157 if (retval
!= -ENODEV
)
4159 "device descriptor read/8, error %d\n",
4171 if (hcd
->phy
&& !hdev
->parent
)
4172 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4175 * Some superspeed devices have finished the link training process
4176 * and attached to a superspeed hub port, but the device descriptor
4177 * got from those devices show they aren't superspeed devices. Warm
4178 * reset the port attached by the devices can fix them.
4180 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4181 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4182 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4183 "warm reset device\n");
4184 hub_port_reset(hub
, port1
, udev
,
4185 HUB_BH_RESET_TIME
, true);
4190 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4191 udev
->speed
== USB_SPEED_SUPER
)
4194 i
= udev
->descriptor
.bMaxPacketSize0
;
4195 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4196 if (udev
->speed
== USB_SPEED_LOW
||
4197 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4198 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4202 if (udev
->speed
== USB_SPEED_FULL
)
4203 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4205 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4206 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4207 usb_ep0_reinit(udev
);
4210 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4211 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4212 if (retval
!= -ENODEV
)
4213 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4220 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4221 retval
= usb_get_bos_descriptor(udev
);
4223 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4224 usb_set_lpm_parameters(udev
);
4229 /* notify HCD that we have a device connected and addressed */
4230 if (hcd
->driver
->update_device
)
4231 hcd
->driver
->update_device(hcd
, udev
);
4234 hub_port_disable(hub
, port1
, 0);
4235 update_devnum(udev
, devnum
); /* for disconnect processing */
4237 mutex_unlock(&usb_address0_mutex
);
4242 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4244 struct usb_qualifier_descriptor
*qual
;
4247 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4251 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4252 qual
, sizeof *qual
);
4253 if (status
== sizeof *qual
) {
4254 dev_info(&udev
->dev
, "not running at top speed; "
4255 "connect to a high speed hub\n");
4256 /* hub LEDs are probably harder to miss than syslog */
4257 if (hub
->has_indicators
) {
4258 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4259 schedule_delayed_work (&hub
->leds
, 0);
4266 hub_power_remaining (struct usb_hub
*hub
)
4268 struct usb_device
*hdev
= hub
->hdev
;
4272 if (!hub
->limited_power
)
4275 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4276 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4277 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4283 if (hub_is_superspeed(udev
))
4289 * Unconfigured devices may not use more than one unit load,
4290 * or 8mA for OTG ports
4292 if (udev
->actconfig
)
4293 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4294 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4298 if (delta
> hub
->mA_per_port
)
4299 dev_warn(&udev
->dev
,
4300 "%dmA is over %umA budget for port %d!\n",
4301 delta
, hub
->mA_per_port
, port1
);
4304 if (remaining
< 0) {
4305 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4312 /* Handle physical or logical connection change events.
4313 * This routine is called when:
4314 * a port connection-change occurs;
4315 * a port enable-change occurs (often caused by EMI);
4316 * usb_reset_and_verify_device() encounters changed descriptors (as from
4317 * a firmware download)
4318 * caller already locked the hub
4320 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4321 u16 portstatus
, u16 portchange
)
4323 struct usb_device
*hdev
= hub
->hdev
;
4324 struct device
*hub_dev
= hub
->intfdev
;
4325 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4326 unsigned wHubCharacteristics
=
4327 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4328 struct usb_device
*udev
;
4333 "port %d, status %04x, change %04x, %s\n",
4334 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4336 if (hub
->has_indicators
) {
4337 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4338 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4341 #ifdef CONFIG_USB_OTG
4342 /* during HNP, don't repeat the debounce */
4343 if (hdev
->bus
->is_b_host
)
4344 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4345 USB_PORT_STAT_C_ENABLE
);
4348 /* Try to resuscitate an existing device */
4349 udev
= hub
->ports
[port1
- 1]->child
;
4350 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4351 udev
->state
!= USB_STATE_NOTATTACHED
) {
4352 usb_lock_device(udev
);
4353 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4354 status
= 0; /* Nothing to do */
4356 #ifdef CONFIG_PM_RUNTIME
4357 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4358 udev
->persist_enabled
) {
4359 /* For a suspended device, treat this as a
4360 * remote wakeup event.
4362 status
= usb_remote_wakeup(udev
);
4366 status
= -ENODEV
; /* Don't resuscitate */
4368 usb_unlock_device(udev
);
4371 clear_bit(port1
, hub
->change_bits
);
4376 /* Disconnect any existing devices under this port */
4378 if (hcd
->phy
&& !hdev
->parent
&&
4379 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4380 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4381 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4383 clear_bit(port1
, hub
->change_bits
);
4385 /* We can forget about a "removed" device when there's a physical
4386 * disconnect or the connect status changes.
4388 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4389 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4390 clear_bit(port1
, hub
->removed_bits
);
4392 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4393 USB_PORT_STAT_C_ENABLE
)) {
4394 status
= hub_port_debounce_be_stable(hub
, port1
);
4396 if (status
!= -ENODEV
&& printk_ratelimit())
4397 dev_err(hub_dev
, "connect-debounce failed, "
4398 "port %d disabled\n", port1
);
4399 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4401 portstatus
= status
;
4405 /* Return now if debouncing failed or nothing is connected or
4406 * the device was "removed".
4408 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4409 test_bit(port1
, hub
->removed_bits
)) {
4411 /* maybe switch power back on (e.g. root hub was reset) */
4412 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4413 && !port_is_power_on(hub
, portstatus
))
4414 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4416 if (portstatus
& USB_PORT_STAT_ENABLE
)
4420 if (hub_is_superspeed(hub
->hdev
))
4426 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4428 /* reallocate for each attempt, since references
4429 * to the previous one can escape in various ways
4431 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4434 "couldn't allocate port %d usb_device\n",
4439 usb_set_device_state(udev
, USB_STATE_POWERED
);
4440 udev
->bus_mA
= hub
->mA_per_port
;
4441 udev
->level
= hdev
->level
+ 1;
4442 udev
->wusb
= hub_is_wusb(hub
);
4444 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4445 if (hub_is_superspeed(hub
->hdev
))
4446 udev
->speed
= USB_SPEED_SUPER
;
4448 udev
->speed
= USB_SPEED_UNKNOWN
;
4450 choose_devnum(udev
);
4451 if (udev
->devnum
<= 0) {
4452 status
= -ENOTCONN
; /* Don't retry */
4456 /* reset (non-USB 3.0 devices) and get descriptor */
4457 status
= hub_port_init(hub
, udev
, port1
, i
);
4461 usb_detect_quirks(udev
);
4462 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4465 /* consecutive bus-powered hubs aren't reliable; they can
4466 * violate the voltage drop budget. if the new child has
4467 * a "powered" LED, users should notice we didn't enable it
4468 * (without reading syslog), even without per-port LEDs
4471 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4472 && udev
->bus_mA
<= unit_load
) {
4475 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4478 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4481 le16_to_cpus(&devstat
);
4482 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4484 "can't connect bus-powered hub "
4486 if (hub
->has_indicators
) {
4487 hub
->indicator
[port1
-1] =
4488 INDICATOR_AMBER_BLINK
;
4489 schedule_delayed_work (&hub
->leds
, 0);
4491 status
= -ENOTCONN
; /* Don't retry */
4496 /* check for devices running slower than they could */
4497 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4498 && udev
->speed
== USB_SPEED_FULL
4499 && highspeed_hubs
!= 0)
4500 check_highspeed (hub
, udev
, port1
);
4502 /* Store the parent's children[] pointer. At this point
4503 * udev becomes globally accessible, although presumably
4504 * no one will look at it until hdev is unlocked.
4508 /* We mustn't add new devices if the parent hub has
4509 * been disconnected; we would race with the
4510 * recursively_mark_NOTATTACHED() routine.
4512 spin_lock_irq(&device_state_lock
);
4513 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4516 hub
->ports
[port1
- 1]->child
= udev
;
4517 spin_unlock_irq(&device_state_lock
);
4519 /* Run it through the hoops (find a driver, etc) */
4521 status
= usb_new_device(udev
);
4523 spin_lock_irq(&device_state_lock
);
4524 hub
->ports
[port1
- 1]->child
= NULL
;
4525 spin_unlock_irq(&device_state_lock
);
4532 status
= hub_power_remaining(hub
);
4534 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4539 hub_port_disable(hub
, port1
, 1);
4541 usb_ep0_reinit(udev
);
4542 release_devnum(udev
);
4545 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4548 if (hub
->hdev
->parent
||
4549 !hcd
->driver
->port_handed_over
||
4550 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4551 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4552 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4557 hub_port_disable(hub
, port1
, 1);
4558 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4559 hcd
->driver
->relinquish_port(hcd
, port1
);
4562 /* Returns 1 if there was a remote wakeup and a connect status change. */
4563 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4564 u16 portstatus
, u16 portchange
)
4566 struct usb_device
*hdev
;
4567 struct usb_device
*udev
;
4568 int connect_change
= 0;
4572 udev
= hub
->ports
[port
- 1]->child
;
4573 if (!hub_is_superspeed(hdev
)) {
4574 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4576 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4578 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4579 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4585 /* TRSMRCY = 10 msec */
4588 usb_lock_device(udev
);
4589 ret
= usb_remote_wakeup(udev
);
4590 usb_unlock_device(udev
);
4595 hub_port_disable(hub
, port
, 1);
4597 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4599 return connect_change
;
4602 static void hub_events(void)
4604 struct list_head
*tmp
;
4605 struct usb_device
*hdev
;
4606 struct usb_interface
*intf
;
4607 struct usb_hub
*hub
;
4608 struct device
*hub_dev
;
4614 int connect_change
, wakeup_change
;
4617 * We restart the list every time to avoid a deadlock with
4618 * deleting hubs downstream from this one. This should be
4619 * safe since we delete the hub from the event list.
4620 * Not the most efficient, but avoids deadlocks.
4624 /* Grab the first entry at the beginning of the list */
4625 spin_lock_irq(&hub_event_lock
);
4626 if (list_empty(&hub_event_list
)) {
4627 spin_unlock_irq(&hub_event_lock
);
4631 tmp
= hub_event_list
.next
;
4634 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4635 kref_get(&hub
->kref
);
4636 spin_unlock_irq(&hub_event_lock
);
4639 hub_dev
= hub
->intfdev
;
4640 intf
= to_usb_interface(hub_dev
);
4641 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4642 hdev
->state
, hub
->descriptor
4643 ? hub
->descriptor
->bNbrPorts
4645 /* NOTE: expects max 15 ports... */
4646 (u16
) hub
->change_bits
[0],
4647 (u16
) hub
->event_bits
[0]);
4649 /* Lock the device, then check to see if we were
4650 * disconnected while waiting for the lock to succeed. */
4651 usb_lock_device(hdev
);
4652 if (unlikely(hub
->disconnected
))
4653 goto loop_disconnected
;
4655 /* If the hub has died, clean up after it */
4656 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4657 hub
->error
= -ENODEV
;
4658 hub_quiesce(hub
, HUB_DISCONNECT
);
4663 ret
= usb_autopm_get_interface(intf
);
4665 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4669 /* If this is an inactive hub, do nothing */
4674 dev_dbg (hub_dev
, "resetting for error %d\n",
4677 ret
= usb_reset_device(hdev
);
4680 "error resetting hub: %d\n", ret
);
4688 /* deal with port status changes */
4689 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4690 if (test_bit(i
, hub
->busy_bits
))
4692 connect_change
= test_bit(i
, hub
->change_bits
);
4693 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4694 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4695 !connect_change
&& !wakeup_change
)
4698 ret
= hub_port_status(hub
, i
,
4699 &portstatus
, &portchange
);
4703 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4704 usb_clear_port_feature(hdev
, i
,
4705 USB_PORT_FEAT_C_CONNECTION
);
4709 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4710 if (!connect_change
)
4712 "port %d enable change, "
4715 usb_clear_port_feature(hdev
, i
,
4716 USB_PORT_FEAT_C_ENABLE
);
4719 * EM interference sometimes causes badly
4720 * shielded USB devices to be shutdown by
4721 * the hub, this hack enables them again.
4722 * Works at least with mouse driver.
4724 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4726 && hub
->ports
[i
- 1]->child
) {
4729 "disabled by hub (EMI?), "
4736 if (hub_handle_remote_wakeup(hub
, i
,
4737 portstatus
, portchange
))
4740 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4744 dev_dbg(hub_dev
, "over-current change on port "
4746 usb_clear_port_feature(hdev
, i
,
4747 USB_PORT_FEAT_C_OVER_CURRENT
);
4748 msleep(100); /* Cool down */
4749 hub_power_on(hub
, true);
4750 hub_port_status(hub
, i
, &status
, &unused
);
4751 if (status
& USB_PORT_STAT_OVERCURRENT
)
4752 dev_err(hub_dev
, "over-current "
4753 "condition on port %d\n", i
);
4756 if (portchange
& USB_PORT_STAT_C_RESET
) {
4758 "reset change on port %d\n",
4760 usb_clear_port_feature(hdev
, i
,
4761 USB_PORT_FEAT_C_RESET
);
4763 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4764 hub_is_superspeed(hub
->hdev
)) {
4766 "warm reset change on port %d\n",
4768 usb_clear_port_feature(hdev
, i
,
4769 USB_PORT_FEAT_C_BH_PORT_RESET
);
4771 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4772 usb_clear_port_feature(hub
->hdev
, i
,
4773 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4775 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4777 "config error on port %d\n",
4779 usb_clear_port_feature(hub
->hdev
, i
,
4780 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4783 /* Warm reset a USB3 protocol port if it's in
4784 * SS.Inactive state.
4786 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4788 struct usb_device
*udev
=
4789 hub
->ports
[i
- 1]->child
;
4791 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4793 status
= hub_port_reset(hub
, i
,
4794 NULL
, HUB_BH_RESET_TIME
,
4797 hub_port_disable(hub
, i
, 1);
4799 usb_lock_device(udev
);
4800 status
= usb_reset_device(udev
);
4801 usb_unlock_device(udev
);
4807 hub_port_connect_change(hub
, i
,
4808 portstatus
, portchange
);
4811 /* deal with hub status changes */
4812 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4814 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4815 dev_err (hub_dev
, "get_hub_status failed\n");
4817 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4818 dev_dbg (hub_dev
, "power change\n");
4819 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4820 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4821 /* FIXME: Is this always true? */
4822 hub
->limited_power
= 1;
4824 hub
->limited_power
= 0;
4826 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4830 dev_dbg(hub_dev
, "over-current change\n");
4831 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4832 msleep(500); /* Cool down */
4833 hub_power_on(hub
, true);
4834 hub_hub_status(hub
, &status
, &unused
);
4835 if (status
& HUB_STATUS_OVERCURRENT
)
4836 dev_err(hub_dev
, "over-current "
4842 /* Balance the usb_autopm_get_interface() above */
4843 usb_autopm_put_interface_no_suspend(intf
);
4845 /* Balance the usb_autopm_get_interface_no_resume() in
4846 * kick_khubd() and allow autosuspend.
4848 usb_autopm_put_interface(intf
);
4850 usb_unlock_device(hdev
);
4851 kref_put(&hub
->kref
, hub_release
);
4853 } /* end while (1) */
4856 static int hub_thread(void *__unused
)
4858 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4859 * port handover. Otherwise it might see that a full-speed device
4860 * was gone before the EHCI controller had handed its port over to
4861 * the companion full-speed controller.
4867 wait_event_freezable(khubd_wait
,
4868 !list_empty(&hub_event_list
) ||
4869 kthread_should_stop());
4870 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4872 pr_debug("%s: khubd exiting\n", usbcore_name
);
4876 static const struct usb_device_id hub_id_table
[] = {
4877 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4878 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4879 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4880 .bInterfaceClass
= USB_CLASS_HUB
,
4881 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4882 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4883 .bDeviceClass
= USB_CLASS_HUB
},
4884 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4885 .bInterfaceClass
= USB_CLASS_HUB
},
4886 { } /* Terminating entry */
4889 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4891 static struct usb_driver hub_driver
= {
4894 .disconnect
= hub_disconnect
,
4895 .suspend
= hub_suspend
,
4896 .resume
= hub_resume
,
4897 .reset_resume
= hub_reset_resume
,
4898 .pre_reset
= hub_pre_reset
,
4899 .post_reset
= hub_post_reset
,
4900 .unlocked_ioctl
= hub_ioctl
,
4901 .id_table
= hub_id_table
,
4902 .supports_autosuspend
= 1,
4905 int usb_hub_init(void)
4907 if (usb_register(&hub_driver
) < 0) {
4908 printk(KERN_ERR
"%s: can't register hub driver\n",
4913 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4914 if (!IS_ERR(khubd_task
))
4917 /* Fall through if kernel_thread failed */
4918 usb_deregister(&hub_driver
);
4919 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4924 void usb_hub_cleanup(void)
4926 kthread_stop(khubd_task
);
4929 * Hub resources are freed for us by usb_deregister. It calls
4930 * usb_driver_purge on every device which in turn calls that
4931 * devices disconnect function if it is using this driver.
4932 * The hub_disconnect function takes care of releasing the
4933 * individual hub resources. -greg
4935 usb_deregister(&hub_driver
);
4936 } /* usb_hub_cleanup() */
4938 static int descriptors_changed(struct usb_device
*udev
,
4939 struct usb_device_descriptor
*old_device_descriptor
)
4943 unsigned serial_len
= 0;
4945 unsigned old_length
;
4949 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4950 sizeof(*old_device_descriptor
)) != 0)
4953 /* Since the idVendor, idProduct, and bcdDevice values in the
4954 * device descriptor haven't changed, we will assume the
4955 * Manufacturer and Product strings haven't changed either.
4956 * But the SerialNumber string could be different (e.g., a
4957 * different flash card of the same brand).
4960 serial_len
= strlen(udev
->serial
) + 1;
4963 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4964 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4965 len
= max(len
, old_length
);
4968 buf
= kmalloc(len
, GFP_NOIO
);
4970 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
4971 /* assume the worst */
4974 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4975 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4976 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
4978 if (length
!= old_length
) {
4979 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
4984 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
4986 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
4988 ((struct usb_config_descriptor
*) buf
)->
4989 bConfigurationValue
);
4995 if (!changed
&& serial_len
) {
4996 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
4998 if (length
+ 1 != serial_len
) {
4999 dev_dbg(&udev
->dev
, "serial string error %d\n",
5002 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5003 dev_dbg(&udev
->dev
, "serial string changed\n");
5013 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5014 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5016 * WARNING - don't use this routine to reset a composite device
5017 * (one with multiple interfaces owned by separate drivers)!
5018 * Use usb_reset_device() instead.
5020 * Do a port reset, reassign the device's address, and establish its
5021 * former operating configuration. If the reset fails, or the device's
5022 * descriptors change from their values before the reset, or the original
5023 * configuration and altsettings cannot be restored, a flag will be set
5024 * telling khubd to pretend the device has been disconnected and then
5025 * re-connected. All drivers will be unbound, and the device will be
5026 * re-enumerated and probed all over again.
5028 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5029 * flagged for logical disconnection, or some other negative error code
5030 * if the reset wasn't even attempted.
5032 * The caller must own the device lock. For example, it's safe to use
5033 * this from a driver probe() routine after downloading new firmware.
5034 * For calls that might not occur during probe(), drivers should lock
5035 * the device using usb_lock_device_for_reset().
5037 * Locking exception: This routine may also be called from within an
5038 * autoresume handler. Such usage won't conflict with other tasks
5039 * holding the device lock because these tasks should always call
5040 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5042 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5044 struct usb_device
*parent_hdev
= udev
->parent
;
5045 struct usb_hub
*parent_hub
;
5046 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5047 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5049 int port1
= udev
->portnum
;
5051 if (udev
->state
== USB_STATE_NOTATTACHED
||
5052 udev
->state
== USB_STATE_SUSPENDED
) {
5053 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5059 /* this requires hcd-specific logic; see ohci_restart() */
5060 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5063 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5065 /* Disable LPM and LTM while we reset the device and reinstall the alt
5066 * settings. Device-initiated LPM settings, and system exit latency
5067 * settings are cleared when the device is reset, so we have to set
5070 ret
= usb_unlocked_disable_lpm(udev
);
5072 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5075 ret
= usb_disable_ltm(udev
);
5077 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5082 set_bit(port1
, parent_hub
->busy_bits
);
5083 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5085 /* ep0 maxpacket size may change; let the HCD know about it.
5086 * Other endpoints will be handled by re-enumeration. */
5087 usb_ep0_reinit(udev
);
5088 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5089 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5092 clear_bit(port1
, parent_hub
->busy_bits
);
5097 /* Device might have changed firmware (DFU or similar) */
5098 if (descriptors_changed(udev
, &descriptor
)) {
5099 dev_info(&udev
->dev
, "device firmware changed\n");
5100 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5104 /* Restore the device's previous configuration */
5105 if (!udev
->actconfig
)
5108 mutex_lock(hcd
->bandwidth_mutex
);
5109 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5111 dev_warn(&udev
->dev
,
5112 "Busted HC? Not enough HCD resources for "
5113 "old configuration.\n");
5114 mutex_unlock(hcd
->bandwidth_mutex
);
5117 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5118 USB_REQ_SET_CONFIGURATION
, 0,
5119 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5120 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5123 "can't restore configuration #%d (error=%d)\n",
5124 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5125 mutex_unlock(hcd
->bandwidth_mutex
);
5128 mutex_unlock(hcd
->bandwidth_mutex
);
5129 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5131 /* Put interfaces back into the same altsettings as before.
5132 * Don't bother to send the Set-Interface request for interfaces
5133 * that were already in altsetting 0; besides being unnecessary,
5134 * many devices can't handle it. Instead just reset the host-side
5137 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5138 struct usb_host_config
*config
= udev
->actconfig
;
5139 struct usb_interface
*intf
= config
->interface
[i
];
5140 struct usb_interface_descriptor
*desc
;
5142 desc
= &intf
->cur_altsetting
->desc
;
5143 if (desc
->bAlternateSetting
== 0) {
5144 usb_disable_interface(udev
, intf
, true);
5145 usb_enable_interface(udev
, intf
, true);
5148 /* Let the bandwidth allocation function know that this
5149 * device has been reset, and it will have to use
5150 * alternate setting 0 as the current alternate setting.
5152 intf
->resetting_device
= 1;
5153 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5154 desc
->bAlternateSetting
);
5155 intf
->resetting_device
= 0;
5158 dev_err(&udev
->dev
, "failed to restore interface %d "
5159 "altsetting %d (error=%d)\n",
5160 desc
->bInterfaceNumber
,
5161 desc
->bAlternateSetting
,
5168 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5169 usb_unlocked_enable_lpm(udev
);
5170 usb_enable_ltm(udev
);
5174 /* LPM state doesn't matter when we're about to destroy the device. */
5175 hub_port_logical_disconnect(parent_hub
, port1
);
5180 * usb_reset_device - warn interface drivers and perform a USB port reset
5181 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5183 * Warns all drivers bound to registered interfaces (using their pre_reset
5184 * method), performs the port reset, and then lets the drivers know that
5185 * the reset is over (using their post_reset method).
5187 * Return value is the same as for usb_reset_and_verify_device().
5189 * The caller must own the device lock. For example, it's safe to use
5190 * this from a driver probe() routine after downloading new firmware.
5191 * For calls that might not occur during probe(), drivers should lock
5192 * the device using usb_lock_device_for_reset().
5194 * If an interface is currently being probed or disconnected, we assume
5195 * its driver knows how to handle resets. For all other interfaces,
5196 * if the driver doesn't have pre_reset and post_reset methods then
5197 * we attempt to unbind it and rebind afterward.
5199 int usb_reset_device(struct usb_device
*udev
)
5203 unsigned int noio_flag
;
5204 struct usb_host_config
*config
= udev
->actconfig
;
5206 if (udev
->state
== USB_STATE_NOTATTACHED
||
5207 udev
->state
== USB_STATE_SUSPENDED
) {
5208 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5214 * Don't allocate memory with GFP_KERNEL in current
5215 * context to avoid possible deadlock if usb mass
5216 * storage interface or usbnet interface(iSCSI case)
5217 * is included in current configuration. The easist
5218 * approach is to do it for every device reset,
5219 * because the device 'memalloc_noio' flag may have
5220 * not been set before reseting the usb device.
5222 noio_flag
= memalloc_noio_save();
5224 /* Prevent autosuspend during the reset */
5225 usb_autoresume_device(udev
);
5228 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5229 struct usb_interface
*cintf
= config
->interface
[i
];
5230 struct usb_driver
*drv
;
5233 if (cintf
->dev
.driver
) {
5234 drv
= to_usb_driver(cintf
->dev
.driver
);
5235 if (drv
->pre_reset
&& drv
->post_reset
)
5236 unbind
= (drv
->pre_reset
)(cintf
);
5237 else if (cintf
->condition
==
5238 USB_INTERFACE_BOUND
)
5241 usb_forced_unbind_intf(cintf
);
5246 ret
= usb_reset_and_verify_device(udev
);
5249 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5250 struct usb_interface
*cintf
= config
->interface
[i
];
5251 struct usb_driver
*drv
;
5252 int rebind
= cintf
->needs_binding
;
5254 if (!rebind
&& cintf
->dev
.driver
) {
5255 drv
= to_usb_driver(cintf
->dev
.driver
);
5256 if (drv
->post_reset
)
5257 rebind
= (drv
->post_reset
)(cintf
);
5258 else if (cintf
->condition
==
5259 USB_INTERFACE_BOUND
)
5262 if (ret
== 0 && rebind
)
5263 usb_rebind_intf(cintf
);
5267 usb_autosuspend_device(udev
);
5268 memalloc_noio_restore(noio_flag
);
5271 EXPORT_SYMBOL_GPL(usb_reset_device
);
5275 * usb_queue_reset_device - Reset a USB device from an atomic context
5276 * @iface: USB interface belonging to the device to reset
5278 * This function can be used to reset a USB device from an atomic
5279 * context, where usb_reset_device() won't work (as it blocks).
5281 * Doing a reset via this method is functionally equivalent to calling
5282 * usb_reset_device(), except for the fact that it is delayed to a
5283 * workqueue. This means that any drivers bound to other interfaces
5284 * might be unbound, as well as users from usbfs in user space.
5288 * - Scheduling two resets at the same time from two different drivers
5289 * attached to two different interfaces of the same device is
5290 * possible; depending on how the driver attached to each interface
5291 * handles ->pre_reset(), the second reset might happen or not.
5293 * - If a driver is unbound and it had a pending reset, the reset will
5296 * - This function can be called during .probe() or .disconnect()
5297 * times. On return from .disconnect(), any pending resets will be
5300 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5303 * NOTE: We don't do any reference count tracking because it is not
5304 * needed. The lifecycle of the work_struct is tied to the
5305 * usb_interface. Before destroying the interface we cancel the
5306 * work_struct, so the fact that work_struct is queued and or
5307 * running means the interface (and thus, the device) exist and
5310 void usb_queue_reset_device(struct usb_interface
*iface
)
5312 schedule_work(&iface
->reset_ws
);
5314 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5317 * usb_hub_find_child - Get the pointer of child device
5318 * attached to the port which is specified by @port1.
5319 * @hdev: USB device belonging to the usb hub
5320 * @port1: port num to indicate which port the child device
5323 * USB drivers call this function to get hub's child device
5326 * Return NULL if input param is invalid and
5327 * child's usb_device pointer if non-NULL.
5329 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5332 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5334 if (port1
< 1 || port1
> hdev
->maxchild
)
5336 return hub
->ports
[port1
- 1]->child
;
5338 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5341 * usb_set_hub_port_connect_type - set hub port connect type.
5342 * @hdev: USB device belonging to the usb hub
5343 * @port1: port num of the port
5344 * @type: connect type of the port
5346 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5347 enum usb_port_connect_type type
)
5349 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5352 hub
->ports
[port1
- 1]->connect_type
= type
;
5356 * usb_get_hub_port_connect_type - Get the port's connect type
5357 * @hdev: USB device belonging to the usb hub
5358 * @port1: port num of the port
5360 * Return connect type of the port and if input params are
5361 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5363 enum usb_port_connect_type
5364 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5366 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5369 return USB_PORT_CONNECT_TYPE_UNKNOWN
;
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
);
5432 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);