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
);
558 dev_err(hub
->intfdev
,
559 "%s failed (err = %d)\n", __func__
, ret
);
563 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
564 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
568 mutex_unlock(&hub
->status_mutex
);
572 static void kick_khubd(struct usb_hub
*hub
)
576 spin_lock_irqsave(&hub_event_lock
, flags
);
577 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
578 list_add_tail(&hub
->event_list
, &hub_event_list
);
580 /* Suppress autosuspend until khubd runs */
581 usb_autopm_get_interface_no_resume(
582 to_usb_interface(hub
->intfdev
));
583 wake_up(&khubd_wait
);
585 spin_unlock_irqrestore(&hub_event_lock
, flags
);
588 void usb_kick_khubd(struct usb_device
*hdev
)
590 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
597 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
598 * Notification, which indicates it had initiated remote wakeup.
600 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
601 * device initiates resume, so the USB core will not receive notice of the
602 * resume through the normal hub interrupt URB.
604 void usb_wakeup_notification(struct usb_device
*hdev
,
605 unsigned int portnum
)
612 hub
= usb_hub_to_struct_hub(hdev
);
614 set_bit(portnum
, hub
->wakeup_bits
);
618 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
620 /* completion function, fires on port status changes and various faults */
621 static void hub_irq(struct urb
*urb
)
623 struct usb_hub
*hub
= urb
->context
;
624 int status
= urb
->status
;
629 case -ENOENT
: /* synchronous unlink */
630 case -ECONNRESET
: /* async unlink */
631 case -ESHUTDOWN
: /* hardware going away */
634 default: /* presumably an error */
635 /* Cause a hub reset after 10 consecutive errors */
636 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
637 if ((++hub
->nerrors
< 10) || hub
->error
)
642 /* let khubd handle things */
643 case 0: /* we got data: port status changed */
645 for (i
= 0; i
< urb
->actual_length
; ++i
)
646 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
648 hub
->event_bits
[0] = bits
;
654 /* Something happened, let khubd figure it out */
661 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
662 && status
!= -ENODEV
&& status
!= -EPERM
)
663 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
666 /* USB 2.0 spec Section 11.24.2.3 */
668 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
670 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
671 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
676 * enumeration blocks khubd for a long time. we use keventd instead, since
677 * long blocking there is the exception, not the rule. accordingly, HCDs
678 * talking to TTs must queue control transfers (not just bulk and iso), so
679 * both can talk to the same hub concurrently.
681 static void hub_tt_work(struct work_struct
*work
)
683 struct usb_hub
*hub
=
684 container_of(work
, struct usb_hub
, tt
.clear_work
);
687 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
688 while (!list_empty(&hub
->tt
.clear_list
)) {
689 struct list_head
*next
;
690 struct usb_tt_clear
*clear
;
691 struct usb_device
*hdev
= hub
->hdev
;
692 const struct hc_driver
*drv
;
695 next
= hub
->tt
.clear_list
.next
;
696 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
697 list_del (&clear
->clear_list
);
699 /* drop lock so HCD can concurrently report other TT errors */
700 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
701 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
704 "clear tt %d (%04x) error %d\n",
705 clear
->tt
, clear
->devinfo
, status
);
707 /* Tell the HCD, even if the operation failed */
708 drv
= clear
->hcd
->driver
;
709 if (drv
->clear_tt_buffer_complete
)
710 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
713 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
715 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
719 * usb_hub_set_port_power - control hub port's power state
722 * @set: expected status
724 * call this function to control port's power via setting or
725 * clearing the port's PORT_POWER feature.
727 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
731 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
732 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
735 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
737 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
740 port_dev
->power_is_on
= set
;
745 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
746 * @urb: an URB associated with the failed or incomplete split transaction
748 * High speed HCDs use this to tell the hub driver that some split control or
749 * bulk transaction failed in a way that requires clearing internal state of
750 * a transaction translator. This is normally detected (and reported) from
753 * It may not be possible for that hub to handle additional full (or low)
754 * speed transactions until that state is fully cleared out.
756 int usb_hub_clear_tt_buffer(struct urb
*urb
)
758 struct usb_device
*udev
= urb
->dev
;
759 int pipe
= urb
->pipe
;
760 struct usb_tt
*tt
= udev
->tt
;
762 struct usb_tt_clear
*clear
;
764 /* we've got to cope with an arbitrary number of pending TT clears,
765 * since each TT has "at least two" buffers that can need it (and
766 * there can be many TTs per hub). even if they're uncommon.
768 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
769 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
770 /* FIXME recover somehow ... RESET_TT? */
774 /* info that CLEAR_TT_BUFFER needs */
775 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
776 clear
->devinfo
= usb_pipeendpoint (pipe
);
777 clear
->devinfo
|= udev
->devnum
<< 4;
778 clear
->devinfo
|= usb_pipecontrol (pipe
)
779 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
780 : (USB_ENDPOINT_XFER_BULK
<< 11);
781 if (usb_pipein (pipe
))
782 clear
->devinfo
|= 1 << 15;
784 /* info for completion callback */
785 clear
->hcd
= bus_to_hcd(udev
->bus
);
788 /* tell keventd to clear state for this TT */
789 spin_lock_irqsave (&tt
->lock
, flags
);
790 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
791 schedule_work(&tt
->clear_work
);
792 spin_unlock_irqrestore (&tt
->lock
, flags
);
795 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
797 /* If do_delay is false, return the number of milliseconds the caller
800 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
803 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
805 u16 wHubCharacteristics
=
806 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
808 /* Enable power on each port. Some hubs have reserved values
809 * of LPSM (> 2) in their descriptors, even though they are
810 * USB 2.0 hubs. Some hubs do not implement port-power switching
811 * but only emulate it. In all cases, the ports won't work
812 * unless we send these messages to the hub.
814 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
815 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
817 dev_dbg(hub
->intfdev
, "trying to enable port power on "
818 "non-switchable hub\n");
819 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
820 if (hub
->ports
[port1
- 1]->power_is_on
)
821 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
823 usb_clear_port_feature(hub
->hdev
, port1
,
824 USB_PORT_FEAT_POWER
);
826 /* Wait at least 100 msec for power to become stable */
827 delay
= max(pgood_delay
, (unsigned) 100);
833 static int hub_hub_status(struct usb_hub
*hub
,
834 u16
*status
, u16
*change
)
838 mutex_lock(&hub
->status_mutex
);
839 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
841 dev_err (hub
->intfdev
,
842 "%s failed (err = %d)\n", __func__
, ret
);
844 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
845 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
848 mutex_unlock(&hub
->status_mutex
);
852 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
853 unsigned int link_status
)
855 return set_port_feature(hub
->hdev
,
856 port1
| (link_status
<< 3),
857 USB_PORT_FEAT_LINK_STATE
);
861 * If USB 3.0 ports are placed into the Disabled state, they will no longer
862 * detect any device connects or disconnects. This is generally not what the
863 * USB core wants, since it expects a disabled port to produce a port status
864 * change event when a new device connects.
866 * Instead, set the link state to Disabled, wait for the link to settle into
867 * that state, clear any change bits, and then put the port into the RxDetect
870 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
874 u16 portchange
, portstatus
;
876 if (!hub_is_superspeed(hub
->hdev
))
879 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
881 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
886 /* Wait for the link to enter the disabled state. */
887 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
888 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
892 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
893 USB_SS_PORT_LS_SS_DISABLED
)
895 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
897 msleep(HUB_DEBOUNCE_STEP
);
899 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
900 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
903 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
906 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
908 struct usb_device
*hdev
= hub
->hdev
;
911 if (hub
->ports
[port1
- 1]->child
&& set_state
)
912 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
913 USB_STATE_NOTATTACHED
);
915 if (hub_is_superspeed(hub
->hdev
))
916 ret
= hub_usb3_port_disable(hub
, port1
);
918 ret
= usb_clear_port_feature(hdev
, port1
,
919 USB_PORT_FEAT_ENABLE
);
922 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
928 * Disable a port and mark a logical connect-change event, so that some
929 * time later khubd will disconnect() any existing usb_device on the port
930 * and will re-enumerate if there actually is a device attached.
932 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
934 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
935 hub_port_disable(hub
, port1
, 1);
937 /* FIXME let caller ask to power down the port:
938 * - some devices won't enumerate without a VBUS power cycle
939 * - SRP saves power that way
940 * - ... new call, TBD ...
941 * That's easy if this hub can switch power per-port, and
942 * khubd reactivates the port later (timer, SRP, etc).
943 * Powerdown must be optional, because of reset/DFU.
946 set_bit(port1
, hub
->change_bits
);
951 * usb_remove_device - disable a device's port on its parent hub
952 * @udev: device to be disabled and removed
953 * Context: @udev locked, must be able to sleep.
955 * After @udev's port has been disabled, khubd is notified and it will
956 * see that the device has been disconnected. When the device is
957 * physically unplugged and something is plugged in, the events will
958 * be received and processed normally.
960 int usb_remove_device(struct usb_device
*udev
)
963 struct usb_interface
*intf
;
965 if (!udev
->parent
) /* Can't remove a root hub */
967 hub
= usb_hub_to_struct_hub(udev
->parent
);
968 intf
= to_usb_interface(hub
->intfdev
);
970 usb_autopm_get_interface(intf
);
971 set_bit(udev
->portnum
, hub
->removed_bits
);
972 hub_port_logical_disconnect(hub
, udev
->portnum
);
973 usb_autopm_put_interface(intf
);
977 enum hub_activation_type
{
978 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
979 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
982 static void hub_init_func2(struct work_struct
*ws
);
983 static void hub_init_func3(struct work_struct
*ws
);
985 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
987 struct usb_device
*hdev
= hub
->hdev
;
992 bool need_debounce_delay
= false;
995 /* Continue a partial initialization */
996 if (type
== HUB_INIT2
)
998 if (type
== HUB_INIT3
)
1001 /* The superspeed hub except for root hub has to use Hub Depth
1002 * value as an offset into the route string to locate the bits
1003 * it uses to determine the downstream port number. So hub driver
1004 * should send a set hub depth request to superspeed hub after
1005 * the superspeed hub is set configuration in initialization or
1008 * After a resume, port power should still be on.
1009 * For any other type of activation, turn it on.
1011 if (type
!= HUB_RESUME
) {
1012 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1013 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1014 HUB_SET_DEPTH
, USB_RT_HUB
,
1015 hdev
->level
- 1, 0, NULL
, 0,
1016 USB_CTRL_SET_TIMEOUT
);
1018 dev_err(hub
->intfdev
,
1019 "set hub depth failed\n");
1022 /* Speed up system boot by using a delayed_work for the
1023 * hub's initial power-up delays. This is pretty awkward
1024 * and the implementation looks like a home-brewed sort of
1025 * setjmp/longjmp, but it saves at least 100 ms for each
1026 * root hub (assuming usbcore is compiled into the kernel
1027 * rather than as a module). It adds up.
1029 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1030 * because for those activation types the ports have to be
1031 * operational when we return. In theory this could be done
1032 * for HUB_POST_RESET, but it's easier not to.
1034 if (type
== HUB_INIT
) {
1035 delay
= hub_power_on(hub
, false);
1036 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1037 schedule_delayed_work(&hub
->init_work
,
1038 msecs_to_jiffies(delay
));
1040 /* Suppress autosuspend until init is done */
1041 usb_autopm_get_interface_no_resume(
1042 to_usb_interface(hub
->intfdev
));
1043 return; /* Continues at init2: below */
1044 } else if (type
== HUB_RESET_RESUME
) {
1045 /* The internal host controller state for the hub device
1046 * may be gone after a host power loss on system resume.
1047 * Update the device's info so the HW knows it's a hub.
1049 hcd
= bus_to_hcd(hdev
->bus
);
1050 if (hcd
->driver
->update_hub_device
) {
1051 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1052 &hub
->tt
, GFP_NOIO
);
1054 dev_err(hub
->intfdev
, "Host not "
1055 "accepting hub info "
1057 dev_err(hub
->intfdev
, "LS/FS devices "
1058 "and hubs may not work "
1059 "under this hub\n.");
1062 hub_power_on(hub
, true);
1064 hub_power_on(hub
, true);
1069 /* Check each port and set hub->change_bits to let khubd know
1070 * which ports need attention.
1072 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1073 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1074 u16 portstatus
, portchange
;
1076 portstatus
= portchange
= 0;
1077 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1078 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1079 dev_dbg(hub
->intfdev
,
1080 "port %d: status %04x change %04x\n",
1081 port1
, portstatus
, portchange
);
1083 /* After anything other than HUB_RESUME (i.e., initialization
1084 * or any sort of reset), every port should be disabled.
1085 * Unconnected ports should likewise be disabled (paranoia),
1086 * and so should ports for which we have no usb_device.
1088 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1089 type
!= HUB_RESUME
||
1090 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1092 udev
->state
== USB_STATE_NOTATTACHED
)) {
1094 * USB3 protocol ports will automatically transition
1095 * to Enabled state when detect an USB3.0 device attach.
1096 * Do not disable USB3 protocol ports.
1098 if (!hub_is_superspeed(hdev
)) {
1099 usb_clear_port_feature(hdev
, port1
,
1100 USB_PORT_FEAT_ENABLE
);
1101 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1103 /* Pretend that power was lost for USB3 devs */
1104 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1108 /* Clear status-change flags; we'll debounce later */
1109 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1110 need_debounce_delay
= true;
1111 usb_clear_port_feature(hub
->hdev
, port1
,
1112 USB_PORT_FEAT_C_CONNECTION
);
1114 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1115 need_debounce_delay
= true;
1116 usb_clear_port_feature(hub
->hdev
, port1
,
1117 USB_PORT_FEAT_C_ENABLE
);
1119 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1120 hub_is_superspeed(hub
->hdev
)) {
1121 need_debounce_delay
= true;
1122 usb_clear_port_feature(hub
->hdev
, port1
,
1123 USB_PORT_FEAT_C_BH_PORT_RESET
);
1125 /* We can forget about a "removed" device when there's a
1126 * physical disconnect or the connect status changes.
1128 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1129 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1130 clear_bit(port1
, hub
->removed_bits
);
1132 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1133 /* Tell khubd to disconnect the device or
1134 * check for a new connection
1136 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1137 set_bit(port1
, hub
->change_bits
);
1139 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1140 bool port_resumed
= (portstatus
&
1141 USB_PORT_STAT_LINK_STATE
) ==
1143 /* The power session apparently survived the resume.
1144 * If there was an overcurrent or suspend change
1145 * (i.e., remote wakeup request), have khubd
1146 * take care of it. Look at the port link state
1147 * for USB 3.0 hubs, since they don't have a suspend
1148 * change bit, and they don't set the port link change
1149 * bit on device-initiated resume.
1151 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1153 set_bit(port1
, hub
->change_bits
);
1155 } else if (udev
->persist_enabled
) {
1156 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1159 udev
->reset_resume
= 1;
1161 /* Don't set the change_bits when the device
1164 if (port_dev
->power_is_on
)
1165 set_bit(port1
, hub
->change_bits
);
1168 /* The power session is gone; tell khubd */
1169 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1170 set_bit(port1
, hub
->change_bits
);
1174 /* If no port-status-change flags were set, we don't need any
1175 * debouncing. If flags were set we can try to debounce the
1176 * ports all at once right now, instead of letting khubd do them
1177 * one at a time later on.
1179 * If any port-status changes do occur during this delay, khubd
1180 * will see them later and handle them normally.
1182 if (need_debounce_delay
) {
1183 delay
= HUB_DEBOUNCE_STABLE
;
1185 /* Don't do a long sleep inside a workqueue routine */
1186 if (type
== HUB_INIT2
) {
1187 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1188 schedule_delayed_work(&hub
->init_work
,
1189 msecs_to_jiffies(delay
));
1190 return; /* Continues at init3: below */
1198 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1200 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1201 if (hub
->has_indicators
&& blinkenlights
)
1202 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1204 /* Scan all ports that need attention */
1207 /* Allow autosuspend if it was suppressed */
1208 if (type
<= HUB_INIT3
)
1209 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1212 /* Implement the continuations for the delays above */
1213 static void hub_init_func2(struct work_struct
*ws
)
1215 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1217 hub_activate(hub
, HUB_INIT2
);
1220 static void hub_init_func3(struct work_struct
*ws
)
1222 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1224 hub_activate(hub
, HUB_INIT3
);
1227 enum hub_quiescing_type
{
1228 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1231 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1233 struct usb_device
*hdev
= hub
->hdev
;
1236 cancel_delayed_work_sync(&hub
->init_work
);
1238 /* khubd and related activity won't re-trigger */
1241 if (type
!= HUB_SUSPEND
) {
1242 /* Disconnect all the children */
1243 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1244 if (hub
->ports
[i
]->child
)
1245 usb_disconnect(&hub
->ports
[i
]->child
);
1249 /* Stop khubd and related activity */
1250 usb_kill_urb(hub
->urb
);
1251 if (hub
->has_indicators
)
1252 cancel_delayed_work_sync(&hub
->leds
);
1254 flush_work(&hub
->tt
.clear_work
);
1257 /* caller has locked the hub device */
1258 static int hub_pre_reset(struct usb_interface
*intf
)
1260 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1262 hub_quiesce(hub
, HUB_PRE_RESET
);
1266 /* caller has locked the hub device */
1267 static int hub_post_reset(struct usb_interface
*intf
)
1269 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1271 hub_activate(hub
, HUB_POST_RESET
);
1275 static int hub_configure(struct usb_hub
*hub
,
1276 struct usb_endpoint_descriptor
*endpoint
)
1278 struct usb_hcd
*hcd
;
1279 struct usb_device
*hdev
= hub
->hdev
;
1280 struct device
*hub_dev
= hub
->intfdev
;
1281 u16 hubstatus
, hubchange
;
1282 u16 wHubCharacteristics
;
1285 char *message
= "out of memory";
1289 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1295 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1300 mutex_init(&hub
->status_mutex
);
1302 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1303 if (!hub
->descriptor
) {
1308 /* Request the entire hub descriptor.
1309 * hub->descriptor can handle USB_MAXCHILDREN ports,
1310 * but the hub can/will return fewer bytes here.
1312 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1314 message
= "can't read hub descriptor";
1316 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1317 message
= "hub has too many ports!";
1322 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1323 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1324 (hdev
->maxchild
== 1) ? "" : "s");
1326 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1333 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1334 if (hub_is_superspeed(hdev
)) {
1342 /* FIXME for USB 3.0, skip for now */
1343 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1344 !(hub_is_superspeed(hdev
))) {
1346 char portstr
[USB_MAXCHILDREN
+ 1];
1348 for (i
= 0; i
< hdev
->maxchild
; i
++)
1349 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1350 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1352 portstr
[hdev
->maxchild
] = 0;
1353 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1355 dev_dbg(hub_dev
, "standalone hub\n");
1357 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1358 case HUB_CHAR_COMMON_LPSM
:
1359 dev_dbg(hub_dev
, "ganged power switching\n");
1361 case HUB_CHAR_INDV_PORT_LPSM
:
1362 dev_dbg(hub_dev
, "individual port power switching\n");
1364 case HUB_CHAR_NO_LPSM
:
1366 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1370 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1371 case HUB_CHAR_COMMON_OCPM
:
1372 dev_dbg(hub_dev
, "global over-current protection\n");
1374 case HUB_CHAR_INDV_PORT_OCPM
:
1375 dev_dbg(hub_dev
, "individual port over-current protection\n");
1377 case HUB_CHAR_NO_OCPM
:
1379 dev_dbg(hub_dev
, "no over-current protection\n");
1383 spin_lock_init (&hub
->tt
.lock
);
1384 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1385 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1386 switch (hdev
->descriptor
.bDeviceProtocol
) {
1389 case USB_HUB_PR_HS_SINGLE_TT
:
1390 dev_dbg(hub_dev
, "Single TT\n");
1393 case USB_HUB_PR_HS_MULTI_TT
:
1394 ret
= usb_set_interface(hdev
, 0, 1);
1396 dev_dbg(hub_dev
, "TT per port\n");
1399 dev_err(hub_dev
, "Using single TT (err %d)\n",
1404 /* USB 3.0 hubs don't have a TT */
1407 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1408 hdev
->descriptor
.bDeviceProtocol
);
1412 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1413 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1414 case HUB_TTTT_8_BITS
:
1415 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1416 hub
->tt
.think_time
= 666;
1417 dev_dbg(hub_dev
, "TT requires at most %d "
1418 "FS bit times (%d ns)\n",
1419 8, hub
->tt
.think_time
);
1422 case HUB_TTTT_16_BITS
:
1423 hub
->tt
.think_time
= 666 * 2;
1424 dev_dbg(hub_dev
, "TT requires at most %d "
1425 "FS bit times (%d ns)\n",
1426 16, hub
->tt
.think_time
);
1428 case HUB_TTTT_24_BITS
:
1429 hub
->tt
.think_time
= 666 * 3;
1430 dev_dbg(hub_dev
, "TT requires at most %d "
1431 "FS bit times (%d ns)\n",
1432 24, hub
->tt
.think_time
);
1434 case HUB_TTTT_32_BITS
:
1435 hub
->tt
.think_time
= 666 * 4;
1436 dev_dbg(hub_dev
, "TT requires at most %d "
1437 "FS bit times (%d ns)\n",
1438 32, hub
->tt
.think_time
);
1442 /* probe() zeroes hub->indicator[] */
1443 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1444 hub
->has_indicators
= 1;
1445 dev_dbg(hub_dev
, "Port indicators are supported\n");
1448 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1449 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1451 /* power budgeting mostly matters with bus-powered hubs,
1452 * and battery-powered root hubs (may provide just 8 mA).
1454 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1456 message
= "can't get hub status";
1459 le16_to_cpus(&hubstatus
);
1460 hcd
= bus_to_hcd(hdev
->bus
);
1461 if (hdev
== hdev
->bus
->root_hub
) {
1462 if (hcd
->power_budget
> 0)
1463 hdev
->bus_mA
= hcd
->power_budget
;
1465 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1466 if (hdev
->bus_mA
>= full_load
)
1467 hub
->mA_per_port
= full_load
;
1469 hub
->mA_per_port
= hdev
->bus_mA
;
1470 hub
->limited_power
= 1;
1472 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1473 int remaining
= hdev
->bus_mA
-
1474 hub
->descriptor
->bHubContrCurrent
;
1476 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1477 hub
->descriptor
->bHubContrCurrent
);
1478 hub
->limited_power
= 1;
1480 if (remaining
< hdev
->maxchild
* unit_load
)
1482 "insufficient power available "
1483 "to use all downstream ports\n");
1484 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1486 } else { /* Self-powered external hub */
1487 /* FIXME: What about battery-powered external hubs that
1488 * provide less current per port? */
1489 hub
->mA_per_port
= full_load
;
1491 if (hub
->mA_per_port
< full_load
)
1492 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1495 /* Update the HCD's internal representation of this hub before khubd
1496 * starts getting port status changes for devices under the hub.
1498 if (hcd
->driver
->update_hub_device
) {
1499 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1500 &hub
->tt
, GFP_KERNEL
);
1502 message
= "can't update HCD hub info";
1507 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1509 message
= "can't get hub status";
1513 /* local power status reports aren't always correct */
1514 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1515 dev_dbg(hub_dev
, "local power source is %s\n",
1516 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1517 ? "lost (inactive)" : "good");
1519 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1520 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1521 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1523 /* set up the interrupt endpoint
1524 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1525 * bytes as USB2.0[11.12.3] says because some hubs are known
1526 * to send more data (and thus cause overflow). For root hubs,
1527 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1528 * to be big enough for at least USB_MAXCHILDREN ports. */
1529 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1530 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1532 if (maxp
> sizeof(*hub
->buffer
))
1533 maxp
= sizeof(*hub
->buffer
);
1535 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1541 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1542 hub
, endpoint
->bInterval
);
1544 /* maybe cycle the hub leds */
1545 if (hub
->has_indicators
&& blinkenlights
)
1546 hub
->indicator
[0] = INDICATOR_CYCLE
;
1548 for (i
= 0; i
< hdev
->maxchild
; i
++)
1549 if (usb_hub_create_port_device(hub
, i
+ 1) < 0)
1550 dev_err(hub
->intfdev
,
1551 "couldn't create port%d device.\n", i
+ 1);
1553 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1555 hub_activate(hub
, HUB_INIT
);
1559 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1561 /* hub_disconnect() frees urb and descriptor */
1565 static void hub_release(struct kref
*kref
)
1567 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1569 usb_put_intf(to_usb_interface(hub
->intfdev
));
1573 static unsigned highspeed_hubs
;
1575 static void hub_disconnect(struct usb_interface
*intf
)
1577 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1578 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1581 /* Take the hub off the event list and don't let it be added again */
1582 spin_lock_irq(&hub_event_lock
);
1583 if (!list_empty(&hub
->event_list
)) {
1584 list_del_init(&hub
->event_list
);
1585 usb_autopm_put_interface_no_suspend(intf
);
1587 hub
->disconnected
= 1;
1588 spin_unlock_irq(&hub_event_lock
);
1590 /* Disconnect all children and quiesce the hub */
1592 hub_quiesce(hub
, HUB_DISCONNECT
);
1594 usb_set_intfdata (intf
, NULL
);
1596 for (i
= 0; i
< hdev
->maxchild
; i
++)
1597 usb_hub_remove_port_device(hub
, i
+ 1);
1598 hub
->hdev
->maxchild
= 0;
1600 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1603 usb_free_urb(hub
->urb
);
1605 kfree(hub
->descriptor
);
1609 pm_suspend_ignore_children(&intf
->dev
, false);
1610 kref_put(&hub
->kref
, hub_release
);
1613 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1615 struct usb_host_interface
*desc
;
1616 struct usb_endpoint_descriptor
*endpoint
;
1617 struct usb_device
*hdev
;
1618 struct usb_hub
*hub
;
1620 desc
= intf
->cur_altsetting
;
1621 hdev
= interface_to_usbdev(intf
);
1624 * Set default autosuspend delay as 0 to speedup bus suspend,
1625 * based on the below considerations:
1627 * - Unlike other drivers, the hub driver does not rely on the
1628 * autosuspend delay to provide enough time to handle a wakeup
1629 * event, and the submitted status URB is just to check future
1630 * change on hub downstream ports, so it is safe to do it.
1632 * - The patch might cause one or more auto supend/resume for
1633 * below very rare devices when they are plugged into hub
1636 * devices having trouble initializing, and disconnect
1637 * themselves from the bus and then reconnect a second
1640 * devices just for downloading firmware, and disconnects
1641 * themselves after completing it
1643 * For these quite rare devices, their drivers may change the
1644 * autosuspend delay of their parent hub in the probe() to one
1645 * appropriate value to avoid the subtle problem if someone
1648 * - The patch may cause one or more auto suspend/resume on
1649 * hub during running 'lsusb', but it is probably too
1650 * infrequent to worry about.
1652 * - Change autosuspend delay of hub can avoid unnecessary auto
1653 * suspend timer for hub, also may decrease power consumption
1656 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1658 /* Hubs have proper suspend/resume support. */
1659 usb_enable_autosuspend(hdev
);
1661 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1663 "Unsupported bus topology: hub nested too deep\n");
1667 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1669 dev_warn(&intf
->dev
, "ignoring external hub\n");
1674 /* Some hubs have a subclass of 1, which AFAICT according to the */
1675 /* specs is not defined, but it works */
1676 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1677 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1679 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1683 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1684 if (desc
->desc
.bNumEndpoints
!= 1)
1685 goto descriptor_error
;
1687 endpoint
= &desc
->endpoint
[0].desc
;
1689 /* If it's not an interrupt in endpoint, we'd better punt! */
1690 if (!usb_endpoint_is_int_in(endpoint
))
1691 goto descriptor_error
;
1693 /* We found a hub */
1694 dev_info (&intf
->dev
, "USB hub found\n");
1696 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1698 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1702 kref_init(&hub
->kref
);
1703 INIT_LIST_HEAD(&hub
->event_list
);
1704 hub
->intfdev
= &intf
->dev
;
1706 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1707 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1710 usb_set_intfdata (intf
, hub
);
1711 intf
->needs_remote_wakeup
= 1;
1712 pm_suspend_ignore_children(&intf
->dev
, true);
1714 if (hdev
->speed
== USB_SPEED_HIGH
)
1717 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1718 hub
->quirk_check_port_auto_suspend
= 1;
1720 if (hub_configure(hub
, endpoint
) >= 0)
1723 hub_disconnect (intf
);
1728 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1730 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1731 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1733 /* assert ifno == 0 (part of hub spec) */
1735 case USBDEVFS_HUB_PORTINFO
: {
1736 struct usbdevfs_hub_portinfo
*info
= user_data
;
1739 spin_lock_irq(&device_state_lock
);
1740 if (hdev
->devnum
<= 0)
1743 info
->nports
= hdev
->maxchild
;
1744 for (i
= 0; i
< info
->nports
; i
++) {
1745 if (hub
->ports
[i
]->child
== NULL
)
1749 hub
->ports
[i
]->child
->devnum
;
1752 spin_unlock_irq(&device_state_lock
);
1754 return info
->nports
+ 1;
1763 * Allow user programs to claim ports on a hub. When a device is attached
1764 * to one of these "claimed" ports, the program will "own" the device.
1766 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1767 struct dev_state
***ppowner
)
1769 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1771 if (port1
== 0 || port1
> hdev
->maxchild
)
1774 /* This assumes that devices not managed by the hub driver
1775 * will always have maxchild equal to 0.
1777 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1781 /* In the following three functions, the caller must hold hdev's lock */
1782 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1783 struct dev_state
*owner
)
1786 struct dev_state
**powner
;
1788 rc
= find_port_owner(hdev
, port1
, &powner
);
1797 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1798 struct dev_state
*owner
)
1801 struct dev_state
**powner
;
1803 rc
= find_port_owner(hdev
, port1
, &powner
);
1806 if (*powner
!= owner
)
1812 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1814 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1817 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1818 if (hub
->ports
[n
]->port_owner
== owner
)
1819 hub
->ports
[n
]->port_owner
= NULL
;
1824 /* The caller must hold udev's lock */
1825 bool usb_device_is_owned(struct usb_device
*udev
)
1827 struct usb_hub
*hub
;
1829 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1831 hub
= usb_hub_to_struct_hub(udev
->parent
);
1832 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1835 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1837 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1840 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1841 if (hub
->ports
[i
]->child
)
1842 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1844 if (udev
->state
== USB_STATE_SUSPENDED
)
1845 udev
->active_duration
-= jiffies
;
1846 udev
->state
= USB_STATE_NOTATTACHED
;
1850 * usb_set_device_state - change a device's current state (usbcore, hcds)
1851 * @udev: pointer to device whose state should be changed
1852 * @new_state: new state value to be stored
1854 * udev->state is _not_ fully protected by the device lock. Although
1855 * most transitions are made only while holding the lock, the state can
1856 * can change to USB_STATE_NOTATTACHED at almost any time. This
1857 * is so that devices can be marked as disconnected as soon as possible,
1858 * without having to wait for any semaphores to be released. As a result,
1859 * all changes to any device's state must be protected by the
1860 * device_state_lock spinlock.
1862 * Once a device has been added to the device tree, all changes to its state
1863 * should be made using this routine. The state should _not_ be set directly.
1865 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1866 * Otherwise udev->state is set to new_state, and if new_state is
1867 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1868 * to USB_STATE_NOTATTACHED.
1870 void usb_set_device_state(struct usb_device
*udev
,
1871 enum usb_device_state new_state
)
1873 unsigned long flags
;
1876 spin_lock_irqsave(&device_state_lock
, flags
);
1877 if (udev
->state
== USB_STATE_NOTATTACHED
)
1879 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1881 /* root hub wakeup capabilities are managed out-of-band
1882 * and may involve silicon errata ... ignore them here.
1885 if (udev
->state
== USB_STATE_SUSPENDED
1886 || new_state
== USB_STATE_SUSPENDED
)
1887 ; /* No change to wakeup settings */
1888 else if (new_state
== USB_STATE_CONFIGURED
)
1889 wakeup
= udev
->actconfig
->desc
.bmAttributes
1890 & USB_CONFIG_ATT_WAKEUP
;
1894 if (udev
->state
== USB_STATE_SUSPENDED
&&
1895 new_state
!= USB_STATE_SUSPENDED
)
1896 udev
->active_duration
-= jiffies
;
1897 else if (new_state
== USB_STATE_SUSPENDED
&&
1898 udev
->state
!= USB_STATE_SUSPENDED
)
1899 udev
->active_duration
+= jiffies
;
1900 udev
->state
= new_state
;
1902 recursively_mark_NOTATTACHED(udev
);
1903 spin_unlock_irqrestore(&device_state_lock
, flags
);
1905 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1907 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1910 * Choose a device number.
1912 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1913 * USB-2.0 buses they are also used as device addresses, however on
1914 * USB-3.0 buses the address is assigned by the controller hardware
1915 * and it usually is not the same as the device number.
1917 * WUSB devices are simple: they have no hubs behind, so the mapping
1918 * device <-> virtual port number becomes 1:1. Why? to simplify the
1919 * life of the device connection logic in
1920 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1921 * handshake we need to assign a temporary address in the unauthorized
1922 * space. For simplicity we use the first virtual port number found to
1923 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1924 * and that becomes it's address [X < 128] or its unauthorized address
1927 * We add 1 as an offset to the one-based USB-stack port number
1928 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1929 * 0 is reserved by USB for default address; (b) Linux's USB stack
1930 * uses always #1 for the root hub of the controller. So USB stack's
1931 * port #1, which is wusb virtual-port #0 has address #2.
1933 * Devices connected under xHCI are not as simple. The host controller
1934 * supports virtualization, so the hardware assigns device addresses and
1935 * the HCD must setup data structures before issuing a set address
1936 * command to the hardware.
1938 static void choose_devnum(struct usb_device
*udev
)
1941 struct usb_bus
*bus
= udev
->bus
;
1943 /* If khubd ever becomes multithreaded, this will need a lock */
1945 devnum
= udev
->portnum
+ 1;
1946 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1948 /* Try to allocate the next devnum beginning at
1949 * bus->devnum_next. */
1950 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1953 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1955 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1958 set_bit(devnum
, bus
->devmap
.devicemap
);
1959 udev
->devnum
= devnum
;
1963 static void release_devnum(struct usb_device
*udev
)
1965 if (udev
->devnum
> 0) {
1966 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1971 static void update_devnum(struct usb_device
*udev
, int devnum
)
1973 /* The address for a WUSB device is managed by wusbcore. */
1975 udev
->devnum
= devnum
;
1978 static void hub_free_dev(struct usb_device
*udev
)
1980 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1982 /* Root hubs aren't real devices, so don't free HCD resources */
1983 if (hcd
->driver
->free_dev
&& udev
->parent
)
1984 hcd
->driver
->free_dev(hcd
, udev
);
1988 * usb_disconnect - disconnect a device (usbcore-internal)
1989 * @pdev: pointer to device being disconnected
1990 * Context: !in_interrupt ()
1992 * Something got disconnected. Get rid of it and all of its children.
1994 * If *pdev is a normal device then the parent hub must already be locked.
1995 * If *pdev is a root hub then this routine will acquire the
1996 * usb_bus_list_lock on behalf of the caller.
1998 * Only hub drivers (including virtual root hub drivers for host
1999 * controllers) should ever call this.
2001 * This call is synchronous, and may not be used in an interrupt context.
2003 void usb_disconnect(struct usb_device
**pdev
)
2005 struct usb_device
*udev
= *pdev
;
2006 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2009 /* mark the device as inactive, so any further urb submissions for
2010 * this device (and any of its children) will fail immediately.
2011 * this quiesces everything except pending urbs.
2013 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2014 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2017 usb_lock_device(udev
);
2019 /* Free up all the children before we remove this device */
2020 for (i
= 0; i
< udev
->maxchild
; i
++) {
2021 if (hub
->ports
[i
]->child
)
2022 usb_disconnect(&hub
->ports
[i
]->child
);
2025 /* deallocate hcd/hardware state ... nuking all pending urbs and
2026 * cleaning up all state associated with the current configuration
2027 * so that the hardware is now fully quiesced.
2029 dev_dbg (&udev
->dev
, "unregistering device\n");
2030 usb_disable_device(udev
, 0);
2031 usb_hcd_synchronize_unlinks(udev
);
2034 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2035 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2037 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2038 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2040 if (!port_dev
->did_runtime_put
)
2041 pm_runtime_put(&port_dev
->dev
);
2043 port_dev
->did_runtime_put
= false;
2046 usb_remove_ep_devs(&udev
->ep0
);
2047 usb_unlock_device(udev
);
2049 /* Unregister the device. The device driver is responsible
2050 * for de-configuring the device and invoking the remove-device
2051 * notifier chain (used by usbfs and possibly others).
2053 device_del(&udev
->dev
);
2055 /* Free the device number and delete the parent's children[]
2056 * (or root_hub) pointer.
2058 release_devnum(udev
);
2060 /* Avoid races with recursively_mark_NOTATTACHED() */
2061 spin_lock_irq(&device_state_lock
);
2063 spin_unlock_irq(&device_state_lock
);
2067 put_device(&udev
->dev
);
2070 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2071 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2075 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2078 static void announce_device(struct usb_device
*udev
)
2080 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2081 le16_to_cpu(udev
->descriptor
.idVendor
),
2082 le16_to_cpu(udev
->descriptor
.idProduct
));
2083 dev_info(&udev
->dev
,
2084 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2085 udev
->descriptor
.iManufacturer
,
2086 udev
->descriptor
.iProduct
,
2087 udev
->descriptor
.iSerialNumber
);
2088 show_string(udev
, "Product", udev
->product
);
2089 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2090 show_string(udev
, "SerialNumber", udev
->serial
);
2093 static inline void announce_device(struct usb_device
*udev
) { }
2096 #ifdef CONFIG_USB_OTG
2097 #include "otg_whitelist.h"
2101 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2102 * @udev: newly addressed device (in ADDRESS state)
2104 * Finish enumeration for On-The-Go devices
2106 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2110 #ifdef CONFIG_USB_OTG
2112 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2113 * to wake us after we've powered off VBUS; and HNP, switching roles
2114 * "host" to "peripheral". The OTG descriptor helps figure this out.
2116 if (!udev
->bus
->is_b_host
2118 && udev
->parent
== udev
->bus
->root_hub
) {
2119 struct usb_otg_descriptor
*desc
= NULL
;
2120 struct usb_bus
*bus
= udev
->bus
;
2122 /* descriptor may appear anywhere in config */
2123 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2124 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2125 USB_DT_OTG
, (void **) &desc
) == 0) {
2126 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2127 unsigned port1
= udev
->portnum
;
2129 dev_info(&udev
->dev
,
2130 "Dual-Role OTG device on %sHNP port\n",
2131 (port1
== bus
->otg_port
)
2134 /* enable HNP before suspend, it's simpler */
2135 if (port1
== bus
->otg_port
)
2136 bus
->b_hnp_enable
= 1;
2137 err
= usb_control_msg(udev
,
2138 usb_sndctrlpipe(udev
, 0),
2139 USB_REQ_SET_FEATURE
, 0,
2141 ? USB_DEVICE_B_HNP_ENABLE
2142 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2143 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2145 /* OTG MESSAGE: report errors here,
2146 * customize to match your product.
2148 dev_info(&udev
->dev
,
2149 "can't set HNP mode: %d\n",
2151 bus
->b_hnp_enable
= 0;
2157 if (!is_targeted(udev
)) {
2159 /* Maybe it can talk to us, though we can't talk to it.
2160 * (Includes HNP test device.)
2162 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2163 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2165 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2177 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2178 * @udev: newly addressed device (in ADDRESS state)
2180 * This is only called by usb_new_device() and usb_authorize_device()
2181 * and FIXME -- all comments that apply to them apply here wrt to
2184 * If the device is WUSB and not authorized, we don't attempt to read
2185 * the string descriptors, as they will be errored out by the device
2186 * until it has been authorized.
2188 static int usb_enumerate_device(struct usb_device
*udev
)
2192 if (udev
->config
== NULL
) {
2193 err
= usb_get_configuration(udev
);
2195 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2200 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
2201 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2202 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2203 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2206 /* read the standard strings and cache them if present */
2207 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2208 udev
->manufacturer
= usb_cache_string(udev
,
2209 udev
->descriptor
.iManufacturer
);
2210 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2212 err
= usb_enumerate_device_otg(udev
);
2216 usb_detect_interface_quirks(udev
);
2221 static void set_usb_port_removable(struct usb_device
*udev
)
2223 struct usb_device
*hdev
= udev
->parent
;
2224 struct usb_hub
*hub
;
2225 u8 port
= udev
->portnum
;
2226 u16 wHubCharacteristics
;
2227 bool removable
= true;
2232 hub
= usb_hub_to_struct_hub(udev
->parent
);
2234 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2236 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2239 if (hub_is_superspeed(hdev
)) {
2240 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2244 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2249 udev
->removable
= USB_DEVICE_REMOVABLE
;
2251 udev
->removable
= USB_DEVICE_FIXED
;
2255 * usb_new_device - perform initial device setup (usbcore-internal)
2256 * @udev: newly addressed device (in ADDRESS state)
2258 * This is called with devices which have been detected but not fully
2259 * enumerated. The device descriptor is available, but not descriptors
2260 * for any device configuration. The caller must have locked either
2261 * the parent hub (if udev is a normal device) or else the
2262 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2263 * udev has already been installed, but udev is not yet visible through
2264 * sysfs or other filesystem code.
2266 * It will return if the device is configured properly or not. Zero if
2267 * the interface was registered with the driver core; else a negative
2270 * This call is synchronous, and may not be used in an interrupt context.
2272 * Only the hub driver or root-hub registrar should ever call this.
2274 int usb_new_device(struct usb_device
*udev
)
2279 /* Initialize non-root-hub device wakeup to disabled;
2280 * device (un)configuration controls wakeup capable
2281 * sysfs power/wakeup controls wakeup enabled/disabled
2283 device_init_wakeup(&udev
->dev
, 0);
2286 /* Tell the runtime-PM framework the device is active */
2287 pm_runtime_set_active(&udev
->dev
);
2288 pm_runtime_get_noresume(&udev
->dev
);
2289 pm_runtime_use_autosuspend(&udev
->dev
);
2290 pm_runtime_enable(&udev
->dev
);
2292 /* By default, forbid autosuspend for all devices. It will be
2293 * allowed for hubs during binding.
2295 usb_disable_autosuspend(udev
);
2297 err
= usb_enumerate_device(udev
); /* Read descriptors */
2300 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2301 udev
->devnum
, udev
->bus
->busnum
,
2302 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2303 /* export the usbdev device-node for libusb */
2304 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2305 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2307 /* Tell the world! */
2308 announce_device(udev
);
2311 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2313 add_device_randomness(udev
->product
, strlen(udev
->product
));
2314 if (udev
->manufacturer
)
2315 add_device_randomness(udev
->manufacturer
,
2316 strlen(udev
->manufacturer
));
2318 device_enable_async_suspend(&udev
->dev
);
2321 * check whether the hub marks this port as non-removable. Do it
2322 * now so that platform-specific data can override it in
2326 set_usb_port_removable(udev
);
2328 /* Register the device. The device driver is responsible
2329 * for configuring the device and invoking the add-device
2330 * notifier chain (used by usbfs and possibly others).
2332 err
= device_add(&udev
->dev
);
2334 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2338 /* Create link files between child device and usb port device. */
2340 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2341 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2343 err
= sysfs_create_link(&udev
->dev
.kobj
,
2344 &port_dev
->dev
.kobj
, "port");
2348 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2349 &udev
->dev
.kobj
, "device");
2351 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2355 pm_runtime_get_sync(&port_dev
->dev
);
2358 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2359 usb_mark_last_busy(udev
);
2360 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2364 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2365 pm_runtime_disable(&udev
->dev
);
2366 pm_runtime_set_suspended(&udev
->dev
);
2372 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2373 * @usb_dev: USB device
2375 * Move the USB device to a very basic state where interfaces are disabled
2376 * and the device is in fact unconfigured and unusable.
2378 * We share a lock (that we have) with device_del(), so we need to
2381 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2383 usb_lock_device(usb_dev
);
2384 if (usb_dev
->authorized
== 0)
2385 goto out_unauthorized
;
2387 usb_dev
->authorized
= 0;
2388 usb_set_configuration(usb_dev
, -1);
2390 kfree(usb_dev
->product
);
2391 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2392 kfree(usb_dev
->manufacturer
);
2393 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2394 kfree(usb_dev
->serial
);
2395 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2397 usb_destroy_configuration(usb_dev
);
2398 usb_dev
->descriptor
.bNumConfigurations
= 0;
2401 usb_unlock_device(usb_dev
);
2406 int usb_authorize_device(struct usb_device
*usb_dev
)
2410 usb_lock_device(usb_dev
);
2411 if (usb_dev
->authorized
== 1)
2412 goto out_authorized
;
2414 result
= usb_autoresume_device(usb_dev
);
2416 dev_err(&usb_dev
->dev
,
2417 "can't autoresume for authorization: %d\n", result
);
2418 goto error_autoresume
;
2420 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2422 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2423 "authorization: %d\n", result
);
2424 goto error_device_descriptor
;
2427 kfree(usb_dev
->product
);
2428 usb_dev
->product
= NULL
;
2429 kfree(usb_dev
->manufacturer
);
2430 usb_dev
->manufacturer
= NULL
;
2431 kfree(usb_dev
->serial
);
2432 usb_dev
->serial
= NULL
;
2434 usb_dev
->authorized
= 1;
2435 result
= usb_enumerate_device(usb_dev
);
2437 goto error_enumerate
;
2438 /* Choose and set the configuration. This registers the interfaces
2439 * with the driver core and lets interface drivers bind to them.
2441 c
= usb_choose_configuration(usb_dev
);
2443 result
= usb_set_configuration(usb_dev
, c
);
2445 dev_err(&usb_dev
->dev
,
2446 "can't set config #%d, error %d\n", c
, result
);
2447 /* This need not be fatal. The user can try to
2448 * set other configurations. */
2451 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2454 error_device_descriptor
:
2455 usb_autosuspend_device(usb_dev
);
2458 usb_unlock_device(usb_dev
); // complements locktree
2463 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2464 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2466 struct usb_hcd
*hcd
;
2467 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2469 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2470 return hcd
->wireless
;
2474 #define PORT_RESET_TRIES 5
2475 #define SET_ADDRESS_TRIES 2
2476 #define GET_DESCRIPTOR_TRIES 2
2477 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2478 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2480 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2481 #define HUB_SHORT_RESET_TIME 10
2482 #define HUB_BH_RESET_TIME 50
2483 #define HUB_LONG_RESET_TIME 200
2484 #define HUB_RESET_TIMEOUT 800
2486 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2487 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2489 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2490 * Port worm reset is required to recover
2492 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2494 return hub_is_superspeed(hub
->hdev
) &&
2495 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2496 USB_SS_PORT_LS_SS_INACTIVE
) ||
2497 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2498 USB_SS_PORT_LS_COMP_MOD
)) ;
2501 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2502 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2504 int delay_time
, ret
;
2508 for (delay_time
= 0;
2509 delay_time
< HUB_RESET_TIMEOUT
;
2510 delay_time
+= delay
) {
2511 /* wait to give the device a chance to reset */
2514 /* read and decode port status */
2515 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2519 /* The port state is unknown until the reset completes. */
2520 if (!(portstatus
& USB_PORT_STAT_RESET
))
2523 /* switch to the long delay after two short delay failures */
2524 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2525 delay
= HUB_LONG_RESET_TIME
;
2527 dev_dbg (hub
->intfdev
,
2528 "port %d not %sreset yet, waiting %dms\n",
2529 port1
, warm
? "warm " : "", delay
);
2532 if ((portstatus
& USB_PORT_STAT_RESET
))
2535 if (hub_port_warm_reset_required(hub
, portstatus
))
2538 /* Device went away? */
2539 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2542 /* bomb out completely if the connection bounced. A USB 3.0
2543 * connection may bounce if multiple warm resets were issued,
2544 * but the device may have successfully re-connected. Ignore it.
2546 if (!hub_is_superspeed(hub
->hdev
) &&
2547 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2550 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2556 if (hub_is_wusb(hub
))
2557 udev
->speed
= USB_SPEED_WIRELESS
;
2558 else if (hub_is_superspeed(hub
->hdev
))
2559 udev
->speed
= USB_SPEED_SUPER
;
2560 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2561 udev
->speed
= USB_SPEED_HIGH
;
2562 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2563 udev
->speed
= USB_SPEED_LOW
;
2565 udev
->speed
= USB_SPEED_FULL
;
2569 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2570 struct usb_device
*udev
, int *status
)
2574 /* TRSTRCY = 10 ms; plus some extra */
2577 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2579 update_devnum(udev
, 0);
2580 /* The xHC may think the device is already reset,
2581 * so ignore the status.
2583 if (hcd
->driver
->reset_device
)
2584 hcd
->driver
->reset_device(hcd
, udev
);
2589 usb_clear_port_feature(hub
->hdev
,
2590 port1
, USB_PORT_FEAT_C_RESET
);
2591 if (hub_is_superspeed(hub
->hdev
)) {
2592 usb_clear_port_feature(hub
->hdev
, port1
,
2593 USB_PORT_FEAT_C_BH_PORT_RESET
);
2594 usb_clear_port_feature(hub
->hdev
, port1
,
2595 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2596 usb_clear_port_feature(hub
->hdev
, port1
,
2597 USB_PORT_FEAT_C_CONNECTION
);
2600 usb_set_device_state(udev
, *status
2601 ? USB_STATE_NOTATTACHED
2602 : USB_STATE_DEFAULT
);
2607 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2608 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2609 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2612 u16 portchange
, portstatus
;
2614 if (!hub_is_superspeed(hub
->hdev
)) {
2616 dev_err(hub
->intfdev
, "only USB3 hub support "
2620 /* Block EHCI CF initialization during the port reset.
2621 * Some companion controllers don't like it when they mix.
2623 down_read(&ehci_cf_port_reset_rwsem
);
2626 * If the caller hasn't explicitly requested a warm reset,
2627 * double check and see if one is needed.
2629 status
= hub_port_status(hub
, port1
,
2630 &portstatus
, &portchange
);
2634 if (hub_port_warm_reset_required(hub
, portstatus
))
2638 /* Reset the port */
2639 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2640 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2641 USB_PORT_FEAT_BH_PORT_RESET
:
2642 USB_PORT_FEAT_RESET
));
2644 dev_err(hub
->intfdev
,
2645 "cannot %sreset port %d (err = %d)\n",
2646 warm
? "warm " : "", port1
, status
);
2648 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2650 if (status
&& status
!= -ENOTCONN
)
2651 dev_dbg(hub
->intfdev
,
2652 "port_wait_reset: err = %d\n",
2656 /* Check for disconnect or reset */
2657 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2658 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2660 if (!hub_is_superspeed(hub
->hdev
))
2664 * If a USB 3.0 device migrates from reset to an error
2665 * state, re-issue the warm reset.
2667 if (hub_port_status(hub
, port1
,
2668 &portstatus
, &portchange
) < 0)
2671 if (!hub_port_warm_reset_required(hub
, portstatus
))
2675 * If the port is in SS.Inactive or Compliance Mode, the
2676 * hot or warm reset failed. Try another warm reset.
2679 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2685 dev_dbg (hub
->intfdev
,
2686 "port %d not enabled, trying %sreset again...\n",
2687 port1
, warm
? "warm " : "");
2688 delay
= HUB_LONG_RESET_TIME
;
2691 dev_err (hub
->intfdev
,
2692 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2696 if (!hub_is_superspeed(hub
->hdev
))
2697 up_read(&ehci_cf_port_reset_rwsem
);
2702 /* Check if a port is power on */
2703 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2707 if (hub_is_superspeed(hub
->hdev
)) {
2708 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2711 if (portstatus
& USB_PORT_STAT_POWER
)
2720 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2721 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2725 if (hub_is_superspeed(hub
->hdev
)) {
2726 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2727 == USB_SS_PORT_LS_U3
)
2730 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2737 /* Determine whether the device on a port is ready for a normal resume,
2738 * is ready for a reset-resume, or should be disconnected.
2740 static int check_port_resume_type(struct usb_device
*udev
,
2741 struct usb_hub
*hub
, int port1
,
2742 int status
, unsigned portchange
, unsigned portstatus
)
2744 /* Is the device still present? */
2745 if (status
|| port_is_suspended(hub
, portstatus
) ||
2746 !port_is_power_on(hub
, portstatus
) ||
2747 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2752 /* Can't do a normal resume if the port isn't enabled,
2753 * so try a reset-resume instead.
2755 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2756 if (udev
->persist_enabled
)
2757 udev
->reset_resume
= 1;
2763 dev_dbg(hub
->intfdev
,
2764 "port %d status %04x.%04x after resume, %d\n",
2765 port1
, portchange
, portstatus
, status
);
2766 } else if (udev
->reset_resume
) {
2768 /* Late port handoff can set status-change bits */
2769 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2770 usb_clear_port_feature(hub
->hdev
, port1
,
2771 USB_PORT_FEAT_C_CONNECTION
);
2772 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2773 usb_clear_port_feature(hub
->hdev
, port1
,
2774 USB_PORT_FEAT_C_ENABLE
);
2780 int usb_disable_ltm(struct usb_device
*udev
)
2782 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2784 /* Check if the roothub and device supports LTM. */
2785 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2786 !usb_device_supports_ltm(udev
))
2789 /* Clear Feature LTM Enable can only be sent if the device is
2792 if (!udev
->actconfig
)
2795 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2796 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2797 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2798 USB_CTRL_SET_TIMEOUT
);
2800 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2802 void usb_enable_ltm(struct usb_device
*udev
)
2804 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2806 /* Check if the roothub and device supports LTM. */
2807 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2808 !usb_device_supports_ltm(udev
))
2811 /* Set Feature LTM Enable can only be sent if the device is
2814 if (!udev
->actconfig
)
2817 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2818 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2819 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2820 USB_CTRL_SET_TIMEOUT
);
2822 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2824 #ifdef CONFIG_USB_SUSPEND
2827 * usb_port_suspend - suspend a usb device's upstream port
2828 * @udev: device that's no longer in active use, not a root hub
2829 * Context: must be able to sleep; device not locked; pm locks held
2831 * Suspends a USB device that isn't in active use, conserving power.
2832 * Devices may wake out of a suspend, if anything important happens,
2833 * using the remote wakeup mechanism. They may also be taken out of
2834 * suspend by the host, using usb_port_resume(). It's also routine
2835 * to disconnect devices while they are suspended.
2837 * This only affects the USB hardware for a device; its interfaces
2838 * (and, for hubs, child devices) must already have been suspended.
2840 * Selective port suspend reduces power; most suspended devices draw
2841 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2842 * All devices below the suspended port are also suspended.
2844 * Devices leave suspend state when the host wakes them up. Some devices
2845 * also support "remote wakeup", where the device can activate the USB
2846 * tree above them to deliver data, such as a keypress or packet. In
2847 * some cases, this wakes the USB host.
2849 * Suspending OTG devices may trigger HNP, if that's been enabled
2850 * between a pair of dual-role devices. That will change roles, such
2851 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2853 * Devices on USB hub ports have only one "suspend" state, corresponding
2854 * to ACPI D2, "may cause the device to lose some context".
2855 * State transitions include:
2857 * - suspend, resume ... when the VBUS power link stays live
2858 * - suspend, disconnect ... VBUS lost
2860 * Once VBUS drop breaks the circuit, the port it's using has to go through
2861 * normal re-enumeration procedures, starting with enabling VBUS power.
2862 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2863 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2864 * timer, no SRP, no requests through sysfs.
2866 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2867 * the root hub for their bus goes into global suspend ... so we don't
2868 * (falsely) update the device power state to say it suspended.
2870 * Returns 0 on success, else negative errno.
2872 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2874 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2875 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2876 enum pm_qos_flags_status pm_qos_stat
;
2877 int port1
= udev
->portnum
;
2880 /* enable remote wakeup when appropriate; this lets the device
2881 * wake up the upstream hub (including maybe the root hub).
2883 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2884 * we don't explicitly enable it here.
2886 if (udev
->do_remote_wakeup
) {
2887 if (!hub_is_superspeed(hub
->hdev
)) {
2888 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2889 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2890 USB_DEVICE_REMOTE_WAKEUP
, 0,
2892 USB_CTRL_SET_TIMEOUT
);
2894 /* Assume there's only one function on the USB 3.0
2895 * device and enable remote wake for the first
2896 * interface. FIXME if the interface association
2897 * descriptor shows there's more than one function.
2899 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2900 USB_REQ_SET_FEATURE
,
2901 USB_RECIP_INTERFACE
,
2902 USB_INTRF_FUNC_SUSPEND
,
2903 USB_INTRF_FUNC_SUSPEND_RW
|
2904 USB_INTRF_FUNC_SUSPEND_LP
,
2906 USB_CTRL_SET_TIMEOUT
);
2909 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2911 /* bail if autosuspend is requested */
2912 if (PMSG_IS_AUTO(msg
))
2917 /* disable USB2 hardware LPM */
2918 if (udev
->usb2_hw_lpm_enabled
== 1)
2919 usb_set_usb2_hardware_lpm(udev
, 0);
2921 if (usb_disable_ltm(udev
)) {
2922 dev_err(&udev
->dev
, "%s Failed to disable LTM before suspend\n.",
2926 if (usb_unlocked_disable_lpm(udev
)) {
2927 dev_err(&udev
->dev
, "%s Failed to disable LPM before suspend\n.",
2933 if (hub_is_superspeed(hub
->hdev
))
2934 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
2936 status
= set_port_feature(hub
->hdev
, port1
,
2937 USB_PORT_FEAT_SUSPEND
);
2939 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2941 /* paranoia: "should not happen" */
2942 if (udev
->do_remote_wakeup
)
2943 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2944 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2945 USB_DEVICE_REMOTE_WAKEUP
, 0,
2947 USB_CTRL_SET_TIMEOUT
);
2949 /* Try to enable USB2 hardware LPM again */
2950 if (udev
->usb2_hw_lpm_capable
== 1)
2951 usb_set_usb2_hardware_lpm(udev
, 1);
2953 /* Try to enable USB3 LTM and LPM again */
2954 usb_enable_ltm(udev
);
2955 usb_unlocked_enable_lpm(udev
);
2957 /* System sleep transitions should never fail */
2958 if (!PMSG_IS_AUTO(msg
))
2961 /* device has up to 10 msec to fully suspend */
2962 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
2963 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
2964 udev
->do_remote_wakeup
);
2965 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2966 udev
->port_is_suspended
= 1;
2971 * Check whether current status meets the requirement of
2972 * usb port power off mechanism
2974 pm_qos_stat
= dev_pm_qos_flags(&port_dev
->dev
,
2975 PM_QOS_FLAG_NO_POWER_OFF
);
2976 if (!udev
->do_remote_wakeup
2977 && pm_qos_stat
!= PM_QOS_FLAGS_ALL
2978 && udev
->persist_enabled
2980 pm_runtime_put_sync(&port_dev
->dev
);
2981 port_dev
->did_runtime_put
= true;
2984 usb_mark_last_busy(hub
->hdev
);
2989 * If the USB "suspend" state is in use (rather than "global suspend"),
2990 * many devices will be individually taken out of suspend state using
2991 * special "resume" signaling. This routine kicks in shortly after
2992 * hardware resume signaling is finished, either because of selective
2993 * resume (by host) or remote wakeup (by device) ... now see what changed
2994 * in the tree that's rooted at this device.
2996 * If @udev->reset_resume is set then the device is reset before the
2997 * status check is done.
2999 static int finish_port_resume(struct usb_device
*udev
)
3004 /* caller owns the udev device lock */
3005 dev_dbg(&udev
->dev
, "%s\n",
3006 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3008 /* usb ch9 identifies four variants of SUSPENDED, based on what
3009 * state the device resumes to. Linux currently won't see the
3010 * first two on the host side; they'd be inside hub_port_init()
3011 * during many timeouts, but khubd can't suspend until later.
3013 usb_set_device_state(udev
, udev
->actconfig
3014 ? USB_STATE_CONFIGURED
3015 : USB_STATE_ADDRESS
);
3017 /* 10.5.4.5 says not to reset a suspended port if the attached
3018 * device is enabled for remote wakeup. Hence the reset
3019 * operation is carried out here, after the port has been
3022 if (udev
->reset_resume
)
3024 status
= usb_reset_and_verify_device(udev
);
3026 /* 10.5.4.5 says be sure devices in the tree are still there.
3027 * For now let's assume the device didn't go crazy on resume,
3028 * and device drivers will know about any resume quirks.
3032 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3034 status
= (status
> 0 ? 0 : -ENODEV
);
3036 /* If a normal resume failed, try doing a reset-resume */
3037 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3038 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3039 udev
->reset_resume
= 1;
3040 goto retry_reset_resume
;
3045 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3048 * There are a few quirky devices which violate the standard
3049 * by claiming to have remote wakeup enabled after a reset,
3050 * which crash if the feature is cleared, hence check for
3051 * udev->reset_resume
3053 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3054 le16_to_cpus(&devstatus
);
3055 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
3056 status
= usb_control_msg(udev
,
3057 usb_sndctrlpipe(udev
, 0),
3058 USB_REQ_CLEAR_FEATURE
,
3060 USB_DEVICE_REMOTE_WAKEUP
, 0,
3062 USB_CTRL_SET_TIMEOUT
);
3065 "disable remote wakeup, status %d\n",
3074 * usb_port_resume - re-activate a suspended usb device's upstream port
3075 * @udev: device to re-activate, not a root hub
3076 * Context: must be able to sleep; device not locked; pm locks held
3078 * This will re-activate the suspended device, increasing power usage
3079 * while letting drivers communicate again with its endpoints.
3080 * USB resume explicitly guarantees that the power session between
3081 * the host and the device is the same as it was when the device
3084 * If @udev->reset_resume is set then this routine won't check that the
3085 * port is still enabled. Furthermore, finish_port_resume() above will
3086 * reset @udev. The end result is that a broken power session can be
3087 * recovered and @udev will appear to persist across a loss of VBUS power.
3089 * For example, if a host controller doesn't maintain VBUS suspend current
3090 * during a system sleep or is reset when the system wakes up, all the USB
3091 * power sessions below it will be broken. This is especially troublesome
3092 * for mass-storage devices containing mounted filesystems, since the
3093 * device will appear to have disconnected and all the memory mappings
3094 * to it will be lost. Using the USB_PERSIST facility, the device can be
3095 * made to appear as if it had not disconnected.
3097 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3098 * every effort to insure that the same device is present after the
3099 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3100 * quite possible for a device to remain unaltered but its media to be
3101 * changed. If the user replaces a flash memory card while the system is
3102 * asleep, he will have only himself to blame when the filesystem on the
3103 * new card is corrupted and the system crashes.
3105 * Returns 0 on success, else negative errno.
3107 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3109 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3110 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3111 int port1
= udev
->portnum
;
3113 u16 portchange
, portstatus
;
3115 if (port_dev
->did_runtime_put
) {
3116 status
= pm_runtime_get_sync(&port_dev
->dev
);
3117 port_dev
->did_runtime_put
= false;
3119 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3125 /* Skip the initial Clear-Suspend step for a remote wakeup */
3126 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3127 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3128 goto SuspendCleared
;
3130 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3132 set_bit(port1
, hub
->busy_bits
);
3134 /* see 7.1.7.7; affects power usage, but not budgeting */
3135 if (hub_is_superspeed(hub
->hdev
))
3136 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3138 status
= usb_clear_port_feature(hub
->hdev
,
3139 port1
, USB_PORT_FEAT_SUSPEND
);
3141 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3144 /* drive resume for at least 20 msec */
3145 dev_dbg(&udev
->dev
, "usb %sresume\n",
3146 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3149 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3150 * stop resume signaling. Then finish the resume
3153 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3155 /* TRSMRCY = 10 msec */
3161 udev
->port_is_suspended
= 0;
3162 if (hub_is_superspeed(hub
->hdev
)) {
3163 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3164 usb_clear_port_feature(hub
->hdev
, port1
,
3165 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3167 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3168 usb_clear_port_feature(hub
->hdev
, port1
,
3169 USB_PORT_FEAT_C_SUSPEND
);
3173 clear_bit(port1
, hub
->busy_bits
);
3175 status
= check_port_resume_type(udev
,
3176 hub
, port1
, status
, portchange
, portstatus
);
3178 status
= finish_port_resume(udev
);
3180 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3181 hub_port_logical_disconnect(hub
, port1
);
3183 /* Try to enable USB2 hardware LPM */
3184 if (udev
->usb2_hw_lpm_capable
== 1)
3185 usb_set_usb2_hardware_lpm(udev
, 1);
3187 /* Try to enable USB3 LTM and LPM */
3188 usb_enable_ltm(udev
);
3189 usb_unlocked_enable_lpm(udev
);
3195 /* caller has locked udev */
3196 int usb_remote_wakeup(struct usb_device
*udev
)
3200 if (udev
->state
== USB_STATE_SUSPENDED
) {
3201 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3202 status
= usb_autoresume_device(udev
);
3204 /* Let the drivers do their thing, then... */
3205 usb_autosuspend_device(udev
);
3211 #else /* CONFIG_USB_SUSPEND */
3213 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3215 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3220 /* However we may need to do a reset-resume */
3222 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3224 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3225 int port1
= udev
->portnum
;
3227 u16 portchange
, portstatus
;
3229 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3230 status
= check_port_resume_type(udev
,
3231 hub
, port1
, status
, portchange
, portstatus
);
3234 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3235 hub_port_logical_disconnect(hub
, port1
);
3236 } else if (udev
->reset_resume
) {
3237 dev_dbg(&udev
->dev
, "reset-resume\n");
3238 status
= usb_reset_and_verify_device(udev
);
3245 static int check_ports_changed(struct usb_hub
*hub
)
3249 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3250 u16 portstatus
, portchange
;
3253 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3254 if (!status
&& portchange
)
3260 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3262 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3263 struct usb_device
*hdev
= hub
->hdev
;
3267 /* Warn if children aren't already suspended */
3268 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3269 struct usb_device
*udev
;
3271 udev
= hub
->ports
[port1
- 1]->child
;
3272 if (udev
&& udev
->can_submit
) {
3273 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3274 if (PMSG_IS_AUTO(msg
))
3279 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3280 /* check if there are changes pending on hub ports */
3281 if (check_ports_changed(hub
)) {
3282 if (PMSG_IS_AUTO(msg
))
3284 pm_wakeup_event(&hdev
->dev
, 2000);
3288 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3289 /* Enable hub to send remote wakeup for all ports. */
3290 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3291 status
= set_port_feature(hdev
,
3293 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3294 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3295 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3296 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3300 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3302 /* stop khubd and related activity */
3303 hub_quiesce(hub
, HUB_SUSPEND
);
3307 static int hub_resume(struct usb_interface
*intf
)
3309 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3311 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3312 hub_activate(hub
, HUB_RESUME
);
3316 static int hub_reset_resume(struct usb_interface
*intf
)
3318 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3320 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3321 hub_activate(hub
, HUB_RESET_RESUME
);
3326 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3327 * @rhdev: struct usb_device for the root hub
3329 * The USB host controller driver calls this function when its root hub
3330 * is resumed and Vbus power has been interrupted or the controller
3331 * has been reset. The routine marks @rhdev as having lost power.
3332 * When the hub driver is resumed it will take notice and carry out
3333 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3334 * the others will be disconnected.
3336 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3338 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3339 rhdev
->reset_resume
= 1;
3341 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3343 static const char * const usb3_lpm_names
[] = {
3351 * Send a Set SEL control transfer to the device, prior to enabling
3352 * device-initiated U1 or U2. This lets the device know the exit latencies from
3353 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3354 * packet from the host.
3356 * This function will fail if the SEL or PEL values for udev are greater than
3357 * the maximum allowed values for the link state to be enabled.
3359 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3361 struct usb_set_sel_req
*sel_values
;
3362 unsigned long long u1_sel
;
3363 unsigned long long u1_pel
;
3364 unsigned long long u2_sel
;
3365 unsigned long long u2_pel
;
3368 /* Convert SEL and PEL stored in ns to us */
3369 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3370 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3371 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3372 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3375 * Make sure that the calculated SEL and PEL values for the link
3376 * state we're enabling aren't bigger than the max SEL/PEL
3377 * value that will fit in the SET SEL control transfer.
3378 * Otherwise the device would get an incorrect idea of the exit
3379 * latency for the link state, and could start a device-initiated
3380 * U1/U2 when the exit latencies are too high.
3382 if ((state
== USB3_LPM_U1
&&
3383 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3384 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3385 (state
== USB3_LPM_U2
&&
3386 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3387 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3388 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3389 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3394 * If we're enabling device-initiated LPM for one link state,
3395 * but the other link state has a too high SEL or PEL value,
3396 * just set those values to the max in the Set SEL request.
3398 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3399 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3401 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3402 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3404 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3405 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3407 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3408 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3411 * usb_enable_lpm() can be called as part of a failed device reset,
3412 * which may be initiated by an error path of a mass storage driver.
3413 * Therefore, use GFP_NOIO.
3415 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3419 sel_values
->u1_sel
= u1_sel
;
3420 sel_values
->u1_pel
= u1_pel
;
3421 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3422 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3424 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3428 sel_values
, sizeof *(sel_values
),
3429 USB_CTRL_SET_TIMEOUT
);
3435 * Enable or disable device-initiated U1 or U2 transitions.
3437 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3438 enum usb3_link_state state
, bool enable
)
3445 feature
= USB_DEVICE_U1_ENABLE
;
3448 feature
= USB_DEVICE_U2_ENABLE
;
3451 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3452 __func__
, enable
? "enable" : "disable");
3456 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3457 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3458 "for unconfigured device.\n",
3459 __func__
, enable
? "enable" : "disable",
3460 usb3_lpm_names
[state
]);
3466 * Now send the control transfer to enable device-initiated LPM
3467 * for either U1 or U2.
3469 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3470 USB_REQ_SET_FEATURE
,
3474 USB_CTRL_SET_TIMEOUT
);
3476 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3477 USB_REQ_CLEAR_FEATURE
,
3481 USB_CTRL_SET_TIMEOUT
);
3484 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3485 enable
? "Enable" : "Disable",
3486 usb3_lpm_names
[state
]);
3492 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3493 enum usb3_link_state state
, int timeout
)
3500 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3503 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3506 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3511 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3512 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3513 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3514 "which is a reserved value.\n",
3515 usb3_lpm_names
[state
], timeout
);
3519 ret
= set_port_feature(udev
->parent
,
3520 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3523 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3524 "error code %i\n", usb3_lpm_names
[state
],
3528 if (state
== USB3_LPM_U1
)
3529 udev
->u1_params
.timeout
= timeout
;
3531 udev
->u2_params
.timeout
= timeout
;
3536 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3539 * We will attempt to enable U1 or U2, but there are no guarantees that the
3540 * control transfers to set the hub timeout or enable device-initiated U1/U2
3541 * will be successful.
3543 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3544 * driver know about it. If that call fails, it should be harmless, and just
3545 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3547 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3548 enum usb3_link_state state
)
3551 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3552 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3554 /* If the device says it doesn't have *any* exit latency to come out of
3555 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3558 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3559 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3563 * First, let the device know about the exit latencies
3564 * associated with the link state we're about to enable.
3566 ret
= usb_req_set_sel(udev
, state
);
3568 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3569 usb3_lpm_names
[state
]);
3573 /* We allow the host controller to set the U1/U2 timeout internally
3574 * first, so that it can change its schedule to account for the
3575 * additional latency to send data to a device in a lower power
3578 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3580 /* xHCI host controller doesn't want to enable this LPM state. */
3585 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3586 "xHCI error %i.\n", usb3_lpm_names
[state
],
3591 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3592 /* If we can't set the parent hub U1/U2 timeout,
3593 * device-initiated LPM won't be allowed either, so let the xHCI
3594 * host know that this link state won't be enabled.
3596 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3598 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3599 else if (udev
->actconfig
)
3600 usb_set_device_initiated_lpm(udev
, state
, true);
3605 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3608 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3609 * If zero is returned, the parent will not allow the link to go into U1/U2.
3611 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3612 * it won't have an effect on the bus link state because the parent hub will
3613 * still disallow device-initiated U1/U2 entry.
3615 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3616 * possible. The result will be slightly more bus bandwidth will be taken up
3617 * (to account for U1/U2 exit latency), but it should be harmless.
3619 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3620 enum usb3_link_state state
)
3626 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3629 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3632 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3637 if (usb_set_lpm_timeout(udev
, state
, 0))
3640 usb_set_device_initiated_lpm(udev
, state
, false);
3642 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3643 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3644 "bus schedule bandwidth may be impacted.\n",
3645 usb3_lpm_names
[state
]);
3650 * Disable hub-initiated and device-initiated U1 and U2 entry.
3651 * Caller must own the bandwidth_mutex.
3653 * This will call usb_enable_lpm() on failure, which will decrement
3654 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3656 int usb_disable_lpm(struct usb_device
*udev
)
3658 struct usb_hcd
*hcd
;
3660 if (!udev
|| !udev
->parent
||
3661 udev
->speed
!= USB_SPEED_SUPER
||
3665 hcd
= bus_to_hcd(udev
->bus
);
3666 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3669 udev
->lpm_disable_count
++;
3670 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3673 /* If LPM is enabled, attempt to disable it. */
3674 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3676 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3682 usb_enable_lpm(udev
);
3685 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3687 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3688 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3690 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3696 mutex_lock(hcd
->bandwidth_mutex
);
3697 ret
= usb_disable_lpm(udev
);
3698 mutex_unlock(hcd
->bandwidth_mutex
);
3702 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3705 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3706 * xHCI host policy may prevent U1 or U2 from being enabled.
3708 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3709 * until the lpm_disable_count drops to zero. Caller must own the
3712 void usb_enable_lpm(struct usb_device
*udev
)
3714 struct usb_hcd
*hcd
;
3716 if (!udev
|| !udev
->parent
||
3717 udev
->speed
!= USB_SPEED_SUPER
||
3721 udev
->lpm_disable_count
--;
3722 hcd
= bus_to_hcd(udev
->bus
);
3723 /* Double check that we can both enable and disable LPM.
3724 * Device must be configured to accept set feature U1/U2 timeout.
3726 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3727 !hcd
->driver
->disable_usb3_lpm_timeout
)
3730 if (udev
->lpm_disable_count
> 0)
3733 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3734 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3736 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3738 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3739 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3741 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3746 mutex_lock(hcd
->bandwidth_mutex
);
3747 usb_enable_lpm(udev
);
3748 mutex_unlock(hcd
->bandwidth_mutex
);
3750 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3753 #else /* CONFIG_PM */
3755 #define hub_suspend NULL
3756 #define hub_resume NULL
3757 #define hub_reset_resume NULL
3759 int usb_disable_lpm(struct usb_device
*udev
)
3763 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3765 void usb_enable_lpm(struct usb_device
*udev
) { }
3766 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3768 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3772 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3774 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3775 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3777 int usb_disable_ltm(struct usb_device
*udev
)
3781 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3783 void usb_enable_ltm(struct usb_device
*udev
) { }
3784 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3788 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3790 * Between connect detection and reset signaling there must be a delay
3791 * of 100ms at least for debounce and power-settling. The corresponding
3792 * timer shall restart whenever the downstream port detects a disconnect.
3794 * Apparently there are some bluetooth and irda-dongles and a number of
3795 * low-speed devices for which this debounce period may last over a second.
3796 * Not covered by the spec - but easy to deal with.
3798 * This implementation uses a 1500ms total debounce timeout; if the
3799 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3800 * every 25ms for transient disconnects. When the port status has been
3801 * unchanged for 100ms it returns the port status.
3803 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3806 int total_time
, stable_time
= 0;
3807 u16 portchange
, portstatus
;
3808 unsigned connection
= 0xffff;
3810 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3811 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3815 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3816 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3817 if (!must_be_connected
||
3818 (connection
== USB_PORT_STAT_CONNECTION
))
3819 stable_time
+= HUB_DEBOUNCE_STEP
;
3820 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3824 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3827 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3828 usb_clear_port_feature(hub
->hdev
, port1
,
3829 USB_PORT_FEAT_C_CONNECTION
);
3832 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3834 msleep(HUB_DEBOUNCE_STEP
);
3837 dev_dbg (hub
->intfdev
,
3838 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3839 port1
, total_time
, stable_time
, portstatus
);
3841 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3846 void usb_ep0_reinit(struct usb_device
*udev
)
3848 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3849 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3850 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3852 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3854 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3855 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3857 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3860 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3863 * The host controller will choose the device address,
3864 * instead of the core having chosen it earlier
3866 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3868 if (udev
->state
== USB_STATE_ADDRESS
)
3870 if (udev
->state
!= USB_STATE_DEFAULT
)
3872 if (hcd
->driver
->address_device
)
3873 retval
= hcd
->driver
->address_device(hcd
, udev
);
3875 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3876 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3877 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3879 update_devnum(udev
, devnum
);
3880 /* Device now using proper address. */
3881 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3882 usb_ep0_reinit(udev
);
3887 /* Reset device, (re)assign address, get device descriptor.
3888 * Device connection must be stable, no more debouncing needed.
3889 * Returns device in USB_STATE_ADDRESS, except on error.
3891 * If this is called for an already-existing device (as part of
3892 * usb_reset_and_verify_device), the caller must own the device lock. For a
3893 * newly detected device that is not accessible through any global
3894 * pointers, it's not necessary to lock the device.
3897 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
3900 static DEFINE_MUTEX(usb_address0_mutex
);
3902 struct usb_device
*hdev
= hub
->hdev
;
3903 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3905 unsigned delay
= HUB_SHORT_RESET_TIME
;
3906 enum usb_device_speed oldspeed
= udev
->speed
;
3908 int devnum
= udev
->devnum
;
3910 /* root hub ports have a slightly longer reset period
3911 * (from USB 2.0 spec, section 7.1.7.5)
3913 if (!hdev
->parent
) {
3914 delay
= HUB_ROOT_RESET_TIME
;
3915 if (port1
== hdev
->bus
->otg_port
)
3916 hdev
->bus
->b_hnp_enable
= 0;
3919 /* Some low speed devices have problems with the quick delay, so */
3920 /* be a bit pessimistic with those devices. RHbug #23670 */
3921 if (oldspeed
== USB_SPEED_LOW
)
3922 delay
= HUB_LONG_RESET_TIME
;
3924 mutex_lock(&usb_address0_mutex
);
3926 /* Reset the device; full speed may morph to high speed */
3927 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3928 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
3929 if (retval
< 0) /* error or disconnect */
3931 /* success, speed is known */
3935 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
3936 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
3939 oldspeed
= udev
->speed
;
3941 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3942 * it's fixed size except for full speed devices.
3943 * For Wireless USB devices, ep0 max packet is always 512 (tho
3944 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3946 switch (udev
->speed
) {
3947 case USB_SPEED_SUPER
:
3948 case USB_SPEED_WIRELESS
: /* fixed at 512 */
3949 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
3951 case USB_SPEED_HIGH
: /* fixed at 64 */
3952 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
3954 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
3955 /* to determine the ep0 maxpacket size, try to read
3956 * the device descriptor to get bMaxPacketSize0 and
3957 * then correct our initial guess.
3959 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
3961 case USB_SPEED_LOW
: /* fixed at 8 */
3962 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
3968 if (udev
->speed
== USB_SPEED_WIRELESS
)
3969 speed
= "variable speed Wireless";
3971 speed
= usb_speed_string(udev
->speed
);
3973 if (udev
->speed
!= USB_SPEED_SUPER
)
3974 dev_info(&udev
->dev
,
3975 "%s %s USB device number %d using %s\n",
3976 (udev
->config
) ? "reset" : "new", speed
,
3977 devnum
, udev
->bus
->controller
->driver
->name
);
3979 /* Set up TT records, if needed */
3981 udev
->tt
= hdev
->tt
;
3982 udev
->ttport
= hdev
->ttport
;
3983 } else if (udev
->speed
!= USB_SPEED_HIGH
3984 && hdev
->speed
== USB_SPEED_HIGH
) {
3986 dev_err(&udev
->dev
, "parent hub has no TT\n");
3990 udev
->tt
= &hub
->tt
;
3991 udev
->ttport
= port1
;
3994 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3995 * Because device hardware and firmware is sometimes buggy in
3996 * this area, and this is how Linux has done it for ages.
3997 * Change it cautiously.
3999 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4000 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4001 * so it may help with some non-standards-compliant devices.
4002 * Otherwise we start with SET_ADDRESS and then try to read the
4003 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4006 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4007 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4008 struct usb_device_descriptor
*buf
;
4011 #define GET_DESCRIPTOR_BUFSIZE 64
4012 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4018 /* Retry on all errors; some devices are flakey.
4019 * 255 is for WUSB devices, we actually need to use
4020 * 512 (WUSB1.0[4.8.1]).
4022 for (j
= 0; j
< 3; ++j
) {
4023 buf
->bMaxPacketSize0
= 0;
4024 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4025 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4026 USB_DT_DEVICE
<< 8, 0,
4027 buf
, GET_DESCRIPTOR_BUFSIZE
,
4028 initial_descriptor_timeout
);
4029 switch (buf
->bMaxPacketSize0
) {
4030 case 8: case 16: case 32: case 64: case 255:
4031 if (buf
->bDescriptorType
==
4045 udev
->descriptor
.bMaxPacketSize0
=
4046 buf
->bMaxPacketSize0
;
4049 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4050 if (retval
< 0) /* error or disconnect */
4052 if (oldspeed
!= udev
->speed
) {
4054 "device reset changed speed!\n");
4060 "device descriptor read/64, error %d\n",
4065 #undef GET_DESCRIPTOR_BUFSIZE
4069 * If device is WUSB, we already assigned an
4070 * unauthorized address in the Connect Ack sequence;
4071 * authorization will assign the final address.
4073 if (udev
->wusb
== 0) {
4074 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4075 retval
= hub_set_address(udev
, devnum
);
4082 "device not accepting address %d, error %d\n",
4086 if (udev
->speed
== USB_SPEED_SUPER
) {
4087 devnum
= udev
->devnum
;
4088 dev_info(&udev
->dev
,
4089 "%s SuperSpeed USB device number %d using %s\n",
4090 (udev
->config
) ? "reset" : "new",
4091 devnum
, udev
->bus
->controller
->driver
->name
);
4094 /* cope with hardware quirkiness:
4095 * - let SET_ADDRESS settle, some device hardware wants it
4096 * - read ep0 maxpacket even for high and low speed,
4099 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4103 retval
= usb_get_device_descriptor(udev
, 8);
4106 "device descriptor read/8, error %d\n",
4118 if (hcd
->phy
&& !hdev
->parent
)
4119 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4122 * Some superspeed devices have finished the link training process
4123 * and attached to a superspeed hub port, but the device descriptor
4124 * got from those devices show they aren't superspeed devices. Warm
4125 * reset the port attached by the devices can fix them.
4127 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4128 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4129 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4130 "warm reset device\n");
4131 hub_port_reset(hub
, port1
, udev
,
4132 HUB_BH_RESET_TIME
, true);
4137 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4138 udev
->speed
== USB_SPEED_SUPER
)
4141 i
= udev
->descriptor
.bMaxPacketSize0
;
4142 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4143 if (udev
->speed
== USB_SPEED_LOW
||
4144 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4145 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4149 if (udev
->speed
== USB_SPEED_FULL
)
4150 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4152 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4153 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4154 usb_ep0_reinit(udev
);
4157 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4158 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4159 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4166 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4167 retval
= usb_get_bos_descriptor(udev
);
4169 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4170 usb_set_lpm_parameters(udev
);
4175 /* notify HCD that we have a device connected and addressed */
4176 if (hcd
->driver
->update_device
)
4177 hcd
->driver
->update_device(hcd
, udev
);
4180 hub_port_disable(hub
, port1
, 0);
4181 update_devnum(udev
, devnum
); /* for disconnect processing */
4183 mutex_unlock(&usb_address0_mutex
);
4188 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4190 struct usb_qualifier_descriptor
*qual
;
4193 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4197 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4198 qual
, sizeof *qual
);
4199 if (status
== sizeof *qual
) {
4200 dev_info(&udev
->dev
, "not running at top speed; "
4201 "connect to a high speed hub\n");
4202 /* hub LEDs are probably harder to miss than syslog */
4203 if (hub
->has_indicators
) {
4204 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4205 schedule_delayed_work (&hub
->leds
, 0);
4212 hub_power_remaining (struct usb_hub
*hub
)
4214 struct usb_device
*hdev
= hub
->hdev
;
4218 if (!hub
->limited_power
)
4221 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4222 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4223 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4229 if (hub_is_superspeed(udev
))
4235 * Unconfigured devices may not use more than one unit load,
4236 * or 8mA for OTG ports
4238 if (udev
->actconfig
)
4239 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4240 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4244 if (delta
> hub
->mA_per_port
)
4245 dev_warn(&udev
->dev
,
4246 "%dmA is over %umA budget for port %d!\n",
4247 delta
, hub
->mA_per_port
, port1
);
4250 if (remaining
< 0) {
4251 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4258 /* Handle physical or logical connection change events.
4259 * This routine is called when:
4260 * a port connection-change occurs;
4261 * a port enable-change occurs (often caused by EMI);
4262 * usb_reset_and_verify_device() encounters changed descriptors (as from
4263 * a firmware download)
4264 * caller already locked the hub
4266 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4267 u16 portstatus
, u16 portchange
)
4269 struct usb_device
*hdev
= hub
->hdev
;
4270 struct device
*hub_dev
= hub
->intfdev
;
4271 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4272 unsigned wHubCharacteristics
=
4273 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4274 struct usb_device
*udev
;
4279 "port %d, status %04x, change %04x, %s\n",
4280 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4282 if (hub
->has_indicators
) {
4283 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4284 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4287 #ifdef CONFIG_USB_OTG
4288 /* during HNP, don't repeat the debounce */
4289 if (hdev
->bus
->is_b_host
)
4290 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4291 USB_PORT_STAT_C_ENABLE
);
4294 /* Try to resuscitate an existing device */
4295 udev
= hub
->ports
[port1
- 1]->child
;
4296 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4297 udev
->state
!= USB_STATE_NOTATTACHED
) {
4298 usb_lock_device(udev
);
4299 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4300 status
= 0; /* Nothing to do */
4302 #ifdef CONFIG_USB_SUSPEND
4303 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4304 udev
->persist_enabled
) {
4305 /* For a suspended device, treat this as a
4306 * remote wakeup event.
4308 status
= usb_remote_wakeup(udev
);
4312 status
= -ENODEV
; /* Don't resuscitate */
4314 usb_unlock_device(udev
);
4317 clear_bit(port1
, hub
->change_bits
);
4322 /* Disconnect any existing devices under this port */
4324 if (hcd
->phy
&& !hdev
->parent
&&
4325 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4326 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4327 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4329 clear_bit(port1
, hub
->change_bits
);
4331 /* We can forget about a "removed" device when there's a physical
4332 * disconnect or the connect status changes.
4334 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4335 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4336 clear_bit(port1
, hub
->removed_bits
);
4338 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4339 USB_PORT_STAT_C_ENABLE
)) {
4340 status
= hub_port_debounce_be_stable(hub
, port1
);
4342 if (printk_ratelimit())
4343 dev_err(hub_dev
, "connect-debounce failed, "
4344 "port %d disabled\n", port1
);
4345 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4347 portstatus
= status
;
4351 /* Return now if debouncing failed or nothing is connected or
4352 * the device was "removed".
4354 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4355 test_bit(port1
, hub
->removed_bits
)) {
4357 /* maybe switch power back on (e.g. root hub was reset) */
4358 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4359 && !port_is_power_on(hub
, portstatus
))
4360 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4362 if (portstatus
& USB_PORT_STAT_ENABLE
)
4366 if (hub_is_superspeed(hub
->hdev
))
4371 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4373 /* reallocate for each attempt, since references
4374 * to the previous one can escape in various ways
4376 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4379 "couldn't allocate port %d usb_device\n",
4384 usb_set_device_state(udev
, USB_STATE_POWERED
);
4385 udev
->bus_mA
= hub
->mA_per_port
;
4386 udev
->level
= hdev
->level
+ 1;
4387 udev
->wusb
= hub_is_wusb(hub
);
4389 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4390 if (hub_is_superspeed(hub
->hdev
))
4391 udev
->speed
= USB_SPEED_SUPER
;
4393 udev
->speed
= USB_SPEED_UNKNOWN
;
4395 choose_devnum(udev
);
4396 if (udev
->devnum
<= 0) {
4397 status
= -ENOTCONN
; /* Don't retry */
4401 /* reset (non-USB 3.0 devices) and get descriptor */
4402 status
= hub_port_init(hub
, udev
, port1
, i
);
4406 usb_detect_quirks(udev
);
4407 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4410 /* consecutive bus-powered hubs aren't reliable; they can
4411 * violate the voltage drop budget. if the new child has
4412 * a "powered" LED, users should notice we didn't enable it
4413 * (without reading syslog), even without per-port LEDs
4416 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4417 && udev
->bus_mA
<= unit_load
) {
4420 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4423 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4426 le16_to_cpus(&devstat
);
4427 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4429 "can't connect bus-powered hub "
4431 if (hub
->has_indicators
) {
4432 hub
->indicator
[port1
-1] =
4433 INDICATOR_AMBER_BLINK
;
4434 schedule_delayed_work (&hub
->leds
, 0);
4436 status
= -ENOTCONN
; /* Don't retry */
4441 /* check for devices running slower than they could */
4442 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4443 && udev
->speed
== USB_SPEED_FULL
4444 && highspeed_hubs
!= 0)
4445 check_highspeed (hub
, udev
, port1
);
4447 /* Store the parent's children[] pointer. At this point
4448 * udev becomes globally accessible, although presumably
4449 * no one will look at it until hdev is unlocked.
4453 /* We mustn't add new devices if the parent hub has
4454 * been disconnected; we would race with the
4455 * recursively_mark_NOTATTACHED() routine.
4457 spin_lock_irq(&device_state_lock
);
4458 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4461 hub
->ports
[port1
- 1]->child
= udev
;
4462 spin_unlock_irq(&device_state_lock
);
4464 /* Run it through the hoops (find a driver, etc) */
4466 status
= usb_new_device(udev
);
4468 spin_lock_irq(&device_state_lock
);
4469 hub
->ports
[port1
- 1]->child
= NULL
;
4470 spin_unlock_irq(&device_state_lock
);
4477 status
= hub_power_remaining(hub
);
4479 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4484 hub_port_disable(hub
, port1
, 1);
4486 usb_ep0_reinit(udev
);
4487 release_devnum(udev
);
4490 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4493 if (hub
->hdev
->parent
||
4494 !hcd
->driver
->port_handed_over
||
4495 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
4496 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4500 hub_port_disable(hub
, port1
, 1);
4501 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4502 hcd
->driver
->relinquish_port(hcd
, port1
);
4505 /* Returns 1 if there was a remote wakeup and a connect status change. */
4506 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4507 u16 portstatus
, u16 portchange
)
4509 struct usb_device
*hdev
;
4510 struct usb_device
*udev
;
4511 int connect_change
= 0;
4515 udev
= hub
->ports
[port
- 1]->child
;
4516 if (!hub_is_superspeed(hdev
)) {
4517 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4519 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4521 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4522 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4528 /* TRSMRCY = 10 msec */
4531 usb_lock_device(udev
);
4532 ret
= usb_remote_wakeup(udev
);
4533 usb_unlock_device(udev
);
4538 hub_port_disable(hub
, port
, 1);
4540 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4542 return connect_change
;
4545 static void hub_events(void)
4547 struct list_head
*tmp
;
4548 struct usb_device
*hdev
;
4549 struct usb_interface
*intf
;
4550 struct usb_hub
*hub
;
4551 struct device
*hub_dev
;
4557 int connect_change
, wakeup_change
;
4560 * We restart the list every time to avoid a deadlock with
4561 * deleting hubs downstream from this one. This should be
4562 * safe since we delete the hub from the event list.
4563 * Not the most efficient, but avoids deadlocks.
4567 /* Grab the first entry at the beginning of the list */
4568 spin_lock_irq(&hub_event_lock
);
4569 if (list_empty(&hub_event_list
)) {
4570 spin_unlock_irq(&hub_event_lock
);
4574 tmp
= hub_event_list
.next
;
4577 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4578 kref_get(&hub
->kref
);
4579 spin_unlock_irq(&hub_event_lock
);
4582 hub_dev
= hub
->intfdev
;
4583 intf
= to_usb_interface(hub_dev
);
4584 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4585 hdev
->state
, hub
->descriptor
4586 ? hub
->descriptor
->bNbrPorts
4588 /* NOTE: expects max 15 ports... */
4589 (u16
) hub
->change_bits
[0],
4590 (u16
) hub
->event_bits
[0]);
4592 /* Lock the device, then check to see if we were
4593 * disconnected while waiting for the lock to succeed. */
4594 usb_lock_device(hdev
);
4595 if (unlikely(hub
->disconnected
))
4596 goto loop_disconnected
;
4598 /* If the hub has died, clean up after it */
4599 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4600 hub
->error
= -ENODEV
;
4601 hub_quiesce(hub
, HUB_DISCONNECT
);
4606 ret
= usb_autopm_get_interface(intf
);
4608 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4612 /* If this is an inactive hub, do nothing */
4617 dev_dbg (hub_dev
, "resetting for error %d\n",
4620 ret
= usb_reset_device(hdev
);
4623 "error resetting hub: %d\n", ret
);
4631 /* deal with port status changes */
4632 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4633 if (test_bit(i
, hub
->busy_bits
))
4635 connect_change
= test_bit(i
, hub
->change_bits
);
4636 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4637 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4638 !connect_change
&& !wakeup_change
)
4641 ret
= hub_port_status(hub
, i
,
4642 &portstatus
, &portchange
);
4646 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4647 usb_clear_port_feature(hdev
, i
,
4648 USB_PORT_FEAT_C_CONNECTION
);
4652 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4653 if (!connect_change
)
4655 "port %d enable change, "
4658 usb_clear_port_feature(hdev
, i
,
4659 USB_PORT_FEAT_C_ENABLE
);
4662 * EM interference sometimes causes badly
4663 * shielded USB devices to be shutdown by
4664 * the hub, this hack enables them again.
4665 * Works at least with mouse driver.
4667 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4669 && hub
->ports
[i
- 1]->child
) {
4672 "disabled by hub (EMI?), "
4679 if (hub_handle_remote_wakeup(hub
, i
,
4680 portstatus
, portchange
))
4683 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4687 dev_dbg(hub_dev
, "over-current change on port "
4689 usb_clear_port_feature(hdev
, i
,
4690 USB_PORT_FEAT_C_OVER_CURRENT
);
4691 msleep(100); /* Cool down */
4692 hub_power_on(hub
, true);
4693 hub_port_status(hub
, i
, &status
, &unused
);
4694 if (status
& USB_PORT_STAT_OVERCURRENT
)
4695 dev_err(hub_dev
, "over-current "
4696 "condition on port %d\n", i
);
4699 if (portchange
& USB_PORT_STAT_C_RESET
) {
4701 "reset change on port %d\n",
4703 usb_clear_port_feature(hdev
, i
,
4704 USB_PORT_FEAT_C_RESET
);
4706 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4707 hub_is_superspeed(hub
->hdev
)) {
4709 "warm reset change on port %d\n",
4711 usb_clear_port_feature(hdev
, i
,
4712 USB_PORT_FEAT_C_BH_PORT_RESET
);
4714 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4715 usb_clear_port_feature(hub
->hdev
, i
,
4716 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4718 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4720 "config error on port %d\n",
4722 usb_clear_port_feature(hub
->hdev
, i
,
4723 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4726 /* Warm reset a USB3 protocol port if it's in
4727 * SS.Inactive state.
4729 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4731 struct usb_device
*udev
=
4732 hub
->ports
[i
- 1]->child
;
4734 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4736 status
= hub_port_reset(hub
, i
,
4737 NULL
, HUB_BH_RESET_TIME
,
4740 hub_port_disable(hub
, i
, 1);
4742 usb_lock_device(udev
);
4743 status
= usb_reset_device(udev
);
4744 usb_unlock_device(udev
);
4750 hub_port_connect_change(hub
, i
,
4751 portstatus
, portchange
);
4754 /* deal with hub status changes */
4755 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4757 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4758 dev_err (hub_dev
, "get_hub_status failed\n");
4760 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4761 dev_dbg (hub_dev
, "power change\n");
4762 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4763 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4764 /* FIXME: Is this always true? */
4765 hub
->limited_power
= 1;
4767 hub
->limited_power
= 0;
4769 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4773 dev_dbg(hub_dev
, "over-current change\n");
4774 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4775 msleep(500); /* Cool down */
4776 hub_power_on(hub
, true);
4777 hub_hub_status(hub
, &status
, &unused
);
4778 if (status
& HUB_STATUS_OVERCURRENT
)
4779 dev_err(hub_dev
, "over-current "
4785 /* Balance the usb_autopm_get_interface() above */
4786 usb_autopm_put_interface_no_suspend(intf
);
4788 /* Balance the usb_autopm_get_interface_no_resume() in
4789 * kick_khubd() and allow autosuspend.
4791 usb_autopm_put_interface(intf
);
4793 usb_unlock_device(hdev
);
4794 kref_put(&hub
->kref
, hub_release
);
4796 } /* end while (1) */
4799 static int hub_thread(void *__unused
)
4801 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4802 * port handover. Otherwise it might see that a full-speed device
4803 * was gone before the EHCI controller had handed its port over to
4804 * the companion full-speed controller.
4810 wait_event_freezable(khubd_wait
,
4811 !list_empty(&hub_event_list
) ||
4812 kthread_should_stop());
4813 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4815 pr_debug("%s: khubd exiting\n", usbcore_name
);
4819 static const struct usb_device_id hub_id_table
[] = {
4820 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4821 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4822 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4823 .bInterfaceClass
= USB_CLASS_HUB
,
4824 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4825 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4826 .bDeviceClass
= USB_CLASS_HUB
},
4827 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4828 .bInterfaceClass
= USB_CLASS_HUB
},
4829 { } /* Terminating entry */
4832 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4834 static struct usb_driver hub_driver
= {
4837 .disconnect
= hub_disconnect
,
4838 .suspend
= hub_suspend
,
4839 .resume
= hub_resume
,
4840 .reset_resume
= hub_reset_resume
,
4841 .pre_reset
= hub_pre_reset
,
4842 .post_reset
= hub_post_reset
,
4843 .unlocked_ioctl
= hub_ioctl
,
4844 .id_table
= hub_id_table
,
4845 .supports_autosuspend
= 1,
4848 int usb_hub_init(void)
4850 if (usb_register(&hub_driver
) < 0) {
4851 printk(KERN_ERR
"%s: can't register hub driver\n",
4856 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4857 if (!IS_ERR(khubd_task
))
4860 /* Fall through if kernel_thread failed */
4861 usb_deregister(&hub_driver
);
4862 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4867 void usb_hub_cleanup(void)
4869 kthread_stop(khubd_task
);
4872 * Hub resources are freed for us by usb_deregister. It calls
4873 * usb_driver_purge on every device which in turn calls that
4874 * devices disconnect function if it is using this driver.
4875 * The hub_disconnect function takes care of releasing the
4876 * individual hub resources. -greg
4878 usb_deregister(&hub_driver
);
4879 } /* usb_hub_cleanup() */
4881 static int descriptors_changed(struct usb_device
*udev
,
4882 struct usb_device_descriptor
*old_device_descriptor
)
4886 unsigned serial_len
= 0;
4888 unsigned old_length
;
4892 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4893 sizeof(*old_device_descriptor
)) != 0)
4896 /* Since the idVendor, idProduct, and bcdDevice values in the
4897 * device descriptor haven't changed, we will assume the
4898 * Manufacturer and Product strings haven't changed either.
4899 * But the SerialNumber string could be different (e.g., a
4900 * different flash card of the same brand).
4903 serial_len
= strlen(udev
->serial
) + 1;
4906 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4907 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4908 len
= max(len
, old_length
);
4911 buf
= kmalloc(len
, GFP_NOIO
);
4913 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
4914 /* assume the worst */
4917 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4918 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4919 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
4921 if (length
!= old_length
) {
4922 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
4927 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
4929 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
4931 ((struct usb_config_descriptor
*) buf
)->
4932 bConfigurationValue
);
4938 if (!changed
&& serial_len
) {
4939 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
4941 if (length
+ 1 != serial_len
) {
4942 dev_dbg(&udev
->dev
, "serial string error %d\n",
4945 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
4946 dev_dbg(&udev
->dev
, "serial string changed\n");
4956 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4957 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4959 * WARNING - don't use this routine to reset a composite device
4960 * (one with multiple interfaces owned by separate drivers)!
4961 * Use usb_reset_device() instead.
4963 * Do a port reset, reassign the device's address, and establish its
4964 * former operating configuration. If the reset fails, or the device's
4965 * descriptors change from their values before the reset, or the original
4966 * configuration and altsettings cannot be restored, a flag will be set
4967 * telling khubd to pretend the device has been disconnected and then
4968 * re-connected. All drivers will be unbound, and the device will be
4969 * re-enumerated and probed all over again.
4971 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4972 * flagged for logical disconnection, or some other negative error code
4973 * if the reset wasn't even attempted.
4975 * The caller must own the device lock. For example, it's safe to use
4976 * this from a driver probe() routine after downloading new firmware.
4977 * For calls that might not occur during probe(), drivers should lock
4978 * the device using usb_lock_device_for_reset().
4980 * Locking exception: This routine may also be called from within an
4981 * autoresume handler. Such usage won't conflict with other tasks
4982 * holding the device lock because these tasks should always call
4983 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4985 static int usb_reset_and_verify_device(struct usb_device
*udev
)
4987 struct usb_device
*parent_hdev
= udev
->parent
;
4988 struct usb_hub
*parent_hub
;
4989 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4990 struct usb_device_descriptor descriptor
= udev
->descriptor
;
4992 int port1
= udev
->portnum
;
4994 if (udev
->state
== USB_STATE_NOTATTACHED
||
4995 udev
->state
== USB_STATE_SUSPENDED
) {
4996 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5002 /* this requires hcd-specific logic; see ohci_restart() */
5003 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5006 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5008 /* Disable LPM and LTM while we reset the device and reinstall the alt
5009 * settings. Device-initiated LPM settings, and system exit latency
5010 * settings are cleared when the device is reset, so we have to set
5013 ret
= usb_unlocked_disable_lpm(udev
);
5015 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5018 ret
= usb_disable_ltm(udev
);
5020 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5025 set_bit(port1
, parent_hub
->busy_bits
);
5026 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5028 /* ep0 maxpacket size may change; let the HCD know about it.
5029 * Other endpoints will be handled by re-enumeration. */
5030 usb_ep0_reinit(udev
);
5031 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5032 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5035 clear_bit(port1
, parent_hub
->busy_bits
);
5040 /* Device might have changed firmware (DFU or similar) */
5041 if (descriptors_changed(udev
, &descriptor
)) {
5042 dev_info(&udev
->dev
, "device firmware changed\n");
5043 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5047 /* Restore the device's previous configuration */
5048 if (!udev
->actconfig
)
5051 mutex_lock(hcd
->bandwidth_mutex
);
5052 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5054 dev_warn(&udev
->dev
,
5055 "Busted HC? Not enough HCD resources for "
5056 "old configuration.\n");
5057 mutex_unlock(hcd
->bandwidth_mutex
);
5060 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5061 USB_REQ_SET_CONFIGURATION
, 0,
5062 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5063 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5066 "can't restore configuration #%d (error=%d)\n",
5067 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5068 mutex_unlock(hcd
->bandwidth_mutex
);
5071 mutex_unlock(hcd
->bandwidth_mutex
);
5072 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5074 /* Put interfaces back into the same altsettings as before.
5075 * Don't bother to send the Set-Interface request for interfaces
5076 * that were already in altsetting 0; besides being unnecessary,
5077 * many devices can't handle it. Instead just reset the host-side
5080 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5081 struct usb_host_config
*config
= udev
->actconfig
;
5082 struct usb_interface
*intf
= config
->interface
[i
];
5083 struct usb_interface_descriptor
*desc
;
5085 desc
= &intf
->cur_altsetting
->desc
;
5086 if (desc
->bAlternateSetting
== 0) {
5087 usb_disable_interface(udev
, intf
, true);
5088 usb_enable_interface(udev
, intf
, true);
5091 /* Let the bandwidth allocation function know that this
5092 * device has been reset, and it will have to use
5093 * alternate setting 0 as the current alternate setting.
5095 intf
->resetting_device
= 1;
5096 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5097 desc
->bAlternateSetting
);
5098 intf
->resetting_device
= 0;
5101 dev_err(&udev
->dev
, "failed to restore interface %d "
5102 "altsetting %d (error=%d)\n",
5103 desc
->bInterfaceNumber
,
5104 desc
->bAlternateSetting
,
5111 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5112 usb_unlocked_enable_lpm(udev
);
5113 usb_enable_ltm(udev
);
5117 /* LPM state doesn't matter when we're about to destroy the device. */
5118 hub_port_logical_disconnect(parent_hub
, port1
);
5123 * usb_reset_device - warn interface drivers and perform a USB port reset
5124 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5126 * Warns all drivers bound to registered interfaces (using their pre_reset
5127 * method), performs the port reset, and then lets the drivers know that
5128 * the reset is over (using their post_reset method).
5130 * Return value is the same as for usb_reset_and_verify_device().
5132 * The caller must own the device lock. For example, it's safe to use
5133 * this from a driver probe() routine after downloading new firmware.
5134 * For calls that might not occur during probe(), drivers should lock
5135 * the device using usb_lock_device_for_reset().
5137 * If an interface is currently being probed or disconnected, we assume
5138 * its driver knows how to handle resets. For all other interfaces,
5139 * if the driver doesn't have pre_reset and post_reset methods then
5140 * we attempt to unbind it and rebind afterward.
5142 int usb_reset_device(struct usb_device
*udev
)
5146 struct usb_host_config
*config
= udev
->actconfig
;
5148 if (udev
->state
== USB_STATE_NOTATTACHED
||
5149 udev
->state
== USB_STATE_SUSPENDED
) {
5150 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5155 /* Prevent autosuspend during the reset */
5156 usb_autoresume_device(udev
);
5159 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5160 struct usb_interface
*cintf
= config
->interface
[i
];
5161 struct usb_driver
*drv
;
5164 if (cintf
->dev
.driver
) {
5165 drv
= to_usb_driver(cintf
->dev
.driver
);
5166 if (drv
->pre_reset
&& drv
->post_reset
)
5167 unbind
= (drv
->pre_reset
)(cintf
);
5168 else if (cintf
->condition
==
5169 USB_INTERFACE_BOUND
)
5172 usb_forced_unbind_intf(cintf
);
5177 ret
= usb_reset_and_verify_device(udev
);
5180 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5181 struct usb_interface
*cintf
= config
->interface
[i
];
5182 struct usb_driver
*drv
;
5183 int rebind
= cintf
->needs_binding
;
5185 if (!rebind
&& cintf
->dev
.driver
) {
5186 drv
= to_usb_driver(cintf
->dev
.driver
);
5187 if (drv
->post_reset
)
5188 rebind
= (drv
->post_reset
)(cintf
);
5189 else if (cintf
->condition
==
5190 USB_INTERFACE_BOUND
)
5193 if (ret
== 0 && rebind
)
5194 usb_rebind_intf(cintf
);
5198 usb_autosuspend_device(udev
);
5201 EXPORT_SYMBOL_GPL(usb_reset_device
);
5205 * usb_queue_reset_device - Reset a USB device from an atomic context
5206 * @iface: USB interface belonging to the device to reset
5208 * This function can be used to reset a USB device from an atomic
5209 * context, where usb_reset_device() won't work (as it blocks).
5211 * Doing a reset via this method is functionally equivalent to calling
5212 * usb_reset_device(), except for the fact that it is delayed to a
5213 * workqueue. This means that any drivers bound to other interfaces
5214 * might be unbound, as well as users from usbfs in user space.
5218 * - Scheduling two resets at the same time from two different drivers
5219 * attached to two different interfaces of the same device is
5220 * possible; depending on how the driver attached to each interface
5221 * handles ->pre_reset(), the second reset might happen or not.
5223 * - If a driver is unbound and it had a pending reset, the reset will
5226 * - This function can be called during .probe() or .disconnect()
5227 * times. On return from .disconnect(), any pending resets will be
5230 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5233 * NOTE: We don't do any reference count tracking because it is not
5234 * needed. The lifecycle of the work_struct is tied to the
5235 * usb_interface. Before destroying the interface we cancel the
5236 * work_struct, so the fact that work_struct is queued and or
5237 * running means the interface (and thus, the device) exist and
5240 void usb_queue_reset_device(struct usb_interface
*iface
)
5242 schedule_work(&iface
->reset_ws
);
5244 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5247 * usb_hub_find_child - Get the pointer of child device
5248 * attached to the port which is specified by @port1.
5249 * @hdev: USB device belonging to the usb hub
5250 * @port1: port num to indicate which port the child device
5253 * USB drivers call this function to get hub's child device
5256 * Return NULL if input param is invalid and
5257 * child's usb_device pointer if non-NULL.
5259 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5262 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5264 if (port1
< 1 || port1
> hdev
->maxchild
)
5266 return hub
->ports
[port1
- 1]->child
;
5268 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5271 * usb_set_hub_port_connect_type - set hub port connect type.
5272 * @hdev: USB device belonging to the usb hub
5273 * @port1: port num of the port
5274 * @type: connect type of the port
5276 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5277 enum usb_port_connect_type type
)
5279 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5281 hub
->ports
[port1
- 1]->connect_type
= type
;
5285 * usb_get_hub_port_connect_type - Get the port's connect type
5286 * @hdev: USB device belonging to the usb hub
5287 * @port1: port num of the port
5289 * Return connect type of the port and if input params are
5290 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5292 enum usb_port_connect_type
5293 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5295 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5297 return hub
->ports
[port1
- 1]->connect_type
;
5300 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5301 struct usb_hub_descriptor
*desc
)
5303 enum usb_port_connect_type connect_type
;
5306 if (!hub_is_superspeed(hdev
)) {
5307 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5308 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5310 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5311 u8 mask
= 1 << (i
%8);
5313 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5314 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5316 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5321 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5323 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5324 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5326 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5329 if (!(port_removable
& mask
)) {
5330 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5332 port_removable
|= mask
;
5337 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5343 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5344 * @hdev: USB device belonging to the usb hub
5345 * @port1: port num of the port
5347 * Return port's acpi handle if successful, NULL if params are
5350 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5353 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5355 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);