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 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");
160 /* udev is root hub */
164 if (udev
->parent
->lpm_capable
)
167 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
168 "Power management will be impacted.\n");
173 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
176 static void usb_set_lpm_mel(struct usb_device
*udev
,
177 struct usb3_lpm_parameters
*udev_lpm_params
,
178 unsigned int udev_exit_latency
,
180 struct usb3_lpm_parameters
*hub_lpm_params
,
181 unsigned int hub_exit_latency
)
183 unsigned int total_mel
;
184 unsigned int device_mel
;
185 unsigned int hub_mel
;
188 * Calculate the time it takes to transition all links from the roothub
189 * to the parent hub into U0. The parent hub must then decode the
190 * packet (hub header decode latency) to figure out which port it was
193 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
194 * means 0.1us). Multiply that by 100 to get nanoseconds.
196 total_mel
= hub_lpm_params
->mel
+
197 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
200 * How long will it take to transition the downstream hub's port into
201 * U0? The greater of either the hub exit latency or the device exit
204 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
205 * Multiply that by 1000 to get nanoseconds.
207 device_mel
= udev_exit_latency
* 1000;
208 hub_mel
= hub_exit_latency
* 1000;
209 if (device_mel
> hub_mel
)
210 total_mel
+= device_mel
;
212 total_mel
+= hub_mel
;
214 udev_lpm_params
->mel
= total_mel
;
218 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
219 * a transition from either U1 or U2.
221 static void usb_set_lpm_pel(struct usb_device
*udev
,
222 struct usb3_lpm_parameters
*udev_lpm_params
,
223 unsigned int udev_exit_latency
,
225 struct usb3_lpm_parameters
*hub_lpm_params
,
226 unsigned int hub_exit_latency
,
227 unsigned int port_to_port_exit_latency
)
229 unsigned int first_link_pel
;
230 unsigned int hub_pel
;
233 * First, the device sends an LFPS to transition the link between the
234 * device and the parent hub into U0. The exit latency is the bigger of
235 * the device exit latency or the hub exit latency.
237 if (udev_exit_latency
> hub_exit_latency
)
238 first_link_pel
= udev_exit_latency
* 1000;
240 first_link_pel
= hub_exit_latency
* 1000;
243 * When the hub starts to receive the LFPS, there is a slight delay for
244 * it to figure out that one of the ports is sending an LFPS. Then it
245 * will forward the LFPS to its upstream link. The exit latency is the
246 * delay, plus the PEL that we calculated for this hub.
248 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
251 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
252 * is the greater of the two exit latencies.
254 if (first_link_pel
> hub_pel
)
255 udev_lpm_params
->pel
= first_link_pel
;
257 udev_lpm_params
->pel
= hub_pel
;
261 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
262 * when a device initiates a transition to U0, until when it will receive the
263 * first packet from the host controller.
265 * Section C.1.5.1 describes the four components to this:
267 * - t2: time for the ERDY to make it from the device to the host.
268 * - t3: a host-specific delay to process the ERDY.
269 * - t4: time for the packet to make it from the host to the device.
271 * t3 is specific to both the xHCI host and the platform the host is integrated
272 * into. The Intel HW folks have said it's negligible, FIXME if a different
273 * vendor says otherwise.
275 static void usb_set_lpm_sel(struct usb_device
*udev
,
276 struct usb3_lpm_parameters
*udev_lpm_params
)
278 struct usb_device
*parent
;
279 unsigned int num_hubs
;
280 unsigned int total_sel
;
282 /* t1 = device PEL */
283 total_sel
= udev_lpm_params
->pel
;
284 /* How many external hubs are in between the device & the root port. */
285 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
286 parent
= parent
->parent
)
288 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
290 total_sel
+= 2100 + 250 * (num_hubs
- 1);
292 /* t4 = 250ns * num_hubs */
293 total_sel
+= 250 * num_hubs
;
295 udev_lpm_params
->sel
= total_sel
;
298 static void usb_set_lpm_parameters(struct usb_device
*udev
)
301 unsigned int port_to_port_delay
;
302 unsigned int udev_u1_del
;
303 unsigned int udev_u2_del
;
304 unsigned int hub_u1_del
;
305 unsigned int hub_u2_del
;
307 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
310 hub
= usb_hub_to_struct_hub(udev
->parent
);
311 /* It doesn't take time to transition the roothub into U0, since it
312 * doesn't have an upstream link.
317 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
318 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
319 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
320 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
322 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
323 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
325 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
326 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
329 * Appendix C, section C.2.2.2, says that there is a slight delay from
330 * when the parent hub notices the downstream port is trying to
331 * transition to U0 to when the hub initiates a U0 transition on its
332 * upstream port. The section says the delays are tPort2PortU1EL and
333 * tPort2PortU2EL, but it doesn't define what they are.
335 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
336 * about the same delays. Use the maximum delay calculations from those
337 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
338 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
339 * assume the device exit latencies they are talking about are the hub
342 * What do we do if the U2 exit latency is less than the U1 exit
343 * latency? It's possible, although not likely...
345 port_to_port_delay
= 1;
347 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
348 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
351 if (hub_u2_del
> hub_u1_del
)
352 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
354 port_to_port_delay
= 1 + hub_u1_del
;
356 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
357 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
360 /* Now that we've got PEL, calculate SEL. */
361 usb_set_lpm_sel(udev
, &udev
->u1_params
);
362 usb_set_lpm_sel(udev
, &udev
->u2_params
);
365 /* USB 2.0 spec Section 11.24.4.5 */
366 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
371 if (hub_is_superspeed(hdev
)) {
372 dtype
= USB_DT_SS_HUB
;
373 size
= USB_DT_SS_HUB_SIZE
;
376 size
= sizeof(struct usb_hub_descriptor
);
379 for (i
= 0; i
< 3; i
++) {
380 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
381 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
382 dtype
<< 8, 0, data
, size
,
383 USB_CTRL_GET_TIMEOUT
);
384 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
391 * USB 2.0 spec Section 11.24.2.1
393 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
395 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
396 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
400 * USB 2.0 spec Section 11.24.2.2
402 int usb_clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
404 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
405 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
410 * USB 2.0 spec Section 11.24.2.13
412 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
414 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
415 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
420 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
421 * for info about using port indicators
423 static void set_port_led(
429 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
430 USB_PORT_FEAT_INDICATOR
);
432 dev_dbg (hub
->intfdev
,
433 "port %d indicator %s status %d\n",
435 ({ char *s
; switch (selector
) {
436 case HUB_LED_AMBER
: s
= "amber"; break;
437 case HUB_LED_GREEN
: s
= "green"; break;
438 case HUB_LED_OFF
: s
= "off"; break;
439 case HUB_LED_AUTO
: s
= "auto"; break;
440 default: s
= "??"; break;
445 #define LED_CYCLE_PERIOD ((2*HZ)/3)
447 static void led_work (struct work_struct
*work
)
449 struct usb_hub
*hub
=
450 container_of(work
, struct usb_hub
, leds
.work
);
451 struct usb_device
*hdev
= hub
->hdev
;
453 unsigned changed
= 0;
456 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
459 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
460 unsigned selector
, mode
;
462 /* 30%-50% duty cycle */
464 switch (hub
->indicator
[i
]) {
466 case INDICATOR_CYCLE
:
468 selector
= HUB_LED_AUTO
;
469 mode
= INDICATOR_AUTO
;
471 /* blinking green = sw attention */
472 case INDICATOR_GREEN_BLINK
:
473 selector
= HUB_LED_GREEN
;
474 mode
= INDICATOR_GREEN_BLINK_OFF
;
476 case INDICATOR_GREEN_BLINK_OFF
:
477 selector
= HUB_LED_OFF
;
478 mode
= INDICATOR_GREEN_BLINK
;
480 /* blinking amber = hw attention */
481 case INDICATOR_AMBER_BLINK
:
482 selector
= HUB_LED_AMBER
;
483 mode
= INDICATOR_AMBER_BLINK_OFF
;
485 case INDICATOR_AMBER_BLINK_OFF
:
486 selector
= HUB_LED_OFF
;
487 mode
= INDICATOR_AMBER_BLINK
;
489 /* blink green/amber = reserved */
490 case INDICATOR_ALT_BLINK
:
491 selector
= HUB_LED_GREEN
;
492 mode
= INDICATOR_ALT_BLINK_OFF
;
494 case INDICATOR_ALT_BLINK_OFF
:
495 selector
= HUB_LED_AMBER
;
496 mode
= INDICATOR_ALT_BLINK
;
501 if (selector
!= HUB_LED_AUTO
)
503 set_port_led(hub
, i
+ 1, selector
);
504 hub
->indicator
[i
] = mode
;
506 if (!changed
&& blinkenlights
) {
508 cursor
%= hub
->descriptor
->bNbrPorts
;
509 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
510 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
514 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
517 /* use a short timeout for hub/port status fetches */
518 #define USB_STS_TIMEOUT 1000
519 #define USB_STS_RETRIES 5
522 * USB 2.0 spec Section 11.24.2.6
524 static int get_hub_status(struct usb_device
*hdev
,
525 struct usb_hub_status
*data
)
527 int i
, status
= -ETIMEDOUT
;
529 for (i
= 0; i
< USB_STS_RETRIES
&&
530 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
531 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
532 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
533 data
, sizeof(*data
), USB_STS_TIMEOUT
);
539 * USB 2.0 spec Section 11.24.2.7
541 static int get_port_status(struct usb_device
*hdev
, int port1
,
542 struct usb_port_status
*data
)
544 int i
, status
= -ETIMEDOUT
;
546 for (i
= 0; i
< USB_STS_RETRIES
&&
547 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
548 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
549 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
550 data
, sizeof(*data
), USB_STS_TIMEOUT
);
555 static int hub_port_status(struct usb_hub
*hub
, int port1
,
556 u16
*status
, u16
*change
)
560 mutex_lock(&hub
->status_mutex
);
561 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
564 dev_err(hub
->intfdev
,
565 "%s failed (err = %d)\n", __func__
, ret
);
569 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
570 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
574 mutex_unlock(&hub
->status_mutex
);
578 static void kick_khubd(struct usb_hub
*hub
)
582 spin_lock_irqsave(&hub_event_lock
, flags
);
583 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
584 list_add_tail(&hub
->event_list
, &hub_event_list
);
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub
->intfdev
));
589 wake_up(&khubd_wait
);
591 spin_unlock_irqrestore(&hub_event_lock
, flags
);
594 void usb_kick_khubd(struct usb_device
*hdev
)
596 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
610 void usb_wakeup_notification(struct usb_device
*hdev
,
611 unsigned int portnum
)
618 hub
= usb_hub_to_struct_hub(hdev
);
620 set_bit(portnum
, hub
->wakeup_bits
);
624 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
626 /* completion function, fires on port status changes and various faults */
627 static void hub_irq(struct urb
*urb
)
629 struct usb_hub
*hub
= urb
->context
;
630 int status
= urb
->status
;
635 case -ENOENT
: /* synchronous unlink */
636 case -ECONNRESET
: /* async unlink */
637 case -ESHUTDOWN
: /* hardware going away */
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
642 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
643 if ((++hub
->nerrors
< 10) || hub
->error
)
648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
651 for (i
= 0; i
< urb
->actual_length
; ++i
)
652 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
654 hub
->event_bits
[0] = bits
;
660 /* Something happened, let khubd figure it out */
667 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
668 && status
!= -ENODEV
&& status
!= -EPERM
)
669 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
672 /* USB 2.0 spec Section 11.24.2.3 */
674 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
676 /* Need to clear both directions for control ep */
677 if (((devinfo
>> 11) & USB_ENDPOINT_XFERTYPE_MASK
) ==
678 USB_ENDPOINT_XFER_CONTROL
) {
679 int status
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
680 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
,
681 devinfo
^ 0x8000, tt
, NULL
, 0, 1000);
685 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
686 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
696 static void hub_tt_work(struct work_struct
*work
)
698 struct usb_hub
*hub
=
699 container_of(work
, struct usb_hub
, tt
.clear_work
);
702 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
703 while (!list_empty(&hub
->tt
.clear_list
)) {
704 struct list_head
*next
;
705 struct usb_tt_clear
*clear
;
706 struct usb_device
*hdev
= hub
->hdev
;
707 const struct hc_driver
*drv
;
710 next
= hub
->tt
.clear_list
.next
;
711 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
712 list_del (&clear
->clear_list
);
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
716 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
717 if (status
&& status
!= -ENODEV
)
719 "clear tt %d (%04x) error %d\n",
720 clear
->tt
, clear
->devinfo
, status
);
722 /* Tell the HCD, even if the operation failed */
723 drv
= clear
->hcd
->driver
;
724 if (drv
->clear_tt_buffer_complete
)
725 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
728 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
730 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
734 * usb_hub_set_port_power - control hub port's power state
737 * @set: expected status
739 * call this function to control port's power via setting or
740 * clearing the port's PORT_POWER feature.
742 int usb_hub_set_port_power(struct usb_device
*hdev
, int port1
,
746 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
747 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
750 ret
= set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
752 ret
= usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
755 port_dev
->power_is_on
= set
;
760 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
761 * @urb: an URB associated with the failed or incomplete split transaction
763 * High speed HCDs use this to tell the hub driver that some split control or
764 * bulk transaction failed in a way that requires clearing internal state of
765 * a transaction translator. This is normally detected (and reported) from
768 * It may not be possible for that hub to handle additional full (or low)
769 * speed transactions until that state is fully cleared out.
771 int usb_hub_clear_tt_buffer(struct urb
*urb
)
773 struct usb_device
*udev
= urb
->dev
;
774 int pipe
= urb
->pipe
;
775 struct usb_tt
*tt
= udev
->tt
;
777 struct usb_tt_clear
*clear
;
779 /* we've got to cope with an arbitrary number of pending TT clears,
780 * since each TT has "at least two" buffers that can need it (and
781 * there can be many TTs per hub). even if they're uncommon.
783 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
784 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
785 /* FIXME recover somehow ... RESET_TT? */
789 /* info that CLEAR_TT_BUFFER needs */
790 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
791 clear
->devinfo
= usb_pipeendpoint (pipe
);
792 clear
->devinfo
|= udev
->devnum
<< 4;
793 clear
->devinfo
|= usb_pipecontrol (pipe
)
794 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
795 : (USB_ENDPOINT_XFER_BULK
<< 11);
796 if (usb_pipein (pipe
))
797 clear
->devinfo
|= 1 << 15;
799 /* info for completion callback */
800 clear
->hcd
= bus_to_hcd(udev
->bus
);
803 /* tell keventd to clear state for this TT */
804 spin_lock_irqsave (&tt
->lock
, flags
);
805 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
806 schedule_work(&tt
->clear_work
);
807 spin_unlock_irqrestore (&tt
->lock
, flags
);
810 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
812 /* If do_delay is false, return the number of milliseconds the caller
815 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
818 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
820 u16 wHubCharacteristics
=
821 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
823 /* Enable power on each port. Some hubs have reserved values
824 * of LPSM (> 2) in their descriptors, even though they are
825 * USB 2.0 hubs. Some hubs do not implement port-power switching
826 * but only emulate it. In all cases, the ports won't work
827 * unless we send these messages to the hub.
829 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
830 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
832 dev_dbg(hub
->intfdev
, "trying to enable port power on "
833 "non-switchable hub\n");
834 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
835 if (hub
->ports
[port1
- 1]->power_is_on
)
836 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
838 usb_clear_port_feature(hub
->hdev
, port1
,
839 USB_PORT_FEAT_POWER
);
841 /* Wait at least 100 msec for power to become stable */
842 delay
= max(pgood_delay
, (unsigned) 100);
848 static int hub_hub_status(struct usb_hub
*hub
,
849 u16
*status
, u16
*change
)
853 mutex_lock(&hub
->status_mutex
);
854 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
857 dev_err(hub
->intfdev
,
858 "%s failed (err = %d)\n", __func__
, ret
);
860 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
861 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
864 mutex_unlock(&hub
->status_mutex
);
868 static int hub_set_port_link_state(struct usb_hub
*hub
, int port1
,
869 unsigned int link_status
)
871 return set_port_feature(hub
->hdev
,
872 port1
| (link_status
<< 3),
873 USB_PORT_FEAT_LINK_STATE
);
877 * If USB 3.0 ports are placed into the Disabled state, they will no longer
878 * detect any device connects or disconnects. This is generally not what the
879 * USB core wants, since it expects a disabled port to produce a port status
880 * change event when a new device connects.
882 * Instead, set the link state to Disabled, wait for the link to settle into
883 * that state, clear any change bits, and then put the port into the RxDetect
886 static int hub_usb3_port_disable(struct usb_hub
*hub
, int port1
)
890 u16 portchange
, portstatus
;
892 if (!hub_is_superspeed(hub
->hdev
))
895 ret
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_SS_DISABLED
);
899 /* Wait for the link to enter the disabled state. */
900 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
901 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
905 if ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
906 USB_SS_PORT_LS_SS_DISABLED
)
908 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
910 msleep(HUB_DEBOUNCE_STEP
);
912 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
913 dev_warn(hub
->intfdev
, "Could not disable port %d after %d ms\n",
916 return hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_RX_DETECT
);
919 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
921 struct usb_device
*hdev
= hub
->hdev
;
924 if (hub
->ports
[port1
- 1]->child
&& set_state
)
925 usb_set_device_state(hub
->ports
[port1
- 1]->child
,
926 USB_STATE_NOTATTACHED
);
928 if (hub_is_superspeed(hub
->hdev
))
929 ret
= hub_usb3_port_disable(hub
, port1
);
931 ret
= usb_clear_port_feature(hdev
, port1
,
932 USB_PORT_FEAT_ENABLE
);
934 if (ret
&& ret
!= -ENODEV
)
935 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
941 * Disable a port and mark a logical connect-change event, so that some
942 * time later khubd will disconnect() any existing usb_device on the port
943 * and will re-enumerate if there actually is a device attached.
945 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
947 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
948 hub_port_disable(hub
, port1
, 1);
950 /* FIXME let caller ask to power down the port:
951 * - some devices won't enumerate without a VBUS power cycle
952 * - SRP saves power that way
953 * - ... new call, TBD ...
954 * That's easy if this hub can switch power per-port, and
955 * khubd reactivates the port later (timer, SRP, etc).
956 * Powerdown must be optional, because of reset/DFU.
959 set_bit(port1
, hub
->change_bits
);
964 * usb_remove_device - disable a device's port on its parent hub
965 * @udev: device to be disabled and removed
966 * Context: @udev locked, must be able to sleep.
968 * After @udev's port has been disabled, khubd is notified and it will
969 * see that the device has been disconnected. When the device is
970 * physically unplugged and something is plugged in, the events will
971 * be received and processed normally.
973 int usb_remove_device(struct usb_device
*udev
)
976 struct usb_interface
*intf
;
978 if (!udev
->parent
) /* Can't remove a root hub */
980 hub
= usb_hub_to_struct_hub(udev
->parent
);
981 intf
= to_usb_interface(hub
->intfdev
);
983 usb_autopm_get_interface(intf
);
984 set_bit(udev
->portnum
, hub
->removed_bits
);
985 hub_port_logical_disconnect(hub
, udev
->portnum
);
986 usb_autopm_put_interface(intf
);
990 enum hub_activation_type
{
991 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
992 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
995 static void hub_init_func2(struct work_struct
*ws
);
996 static void hub_init_func3(struct work_struct
*ws
);
998 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
1000 struct usb_device
*hdev
= hub
->hdev
;
1001 struct usb_hcd
*hcd
;
1005 bool need_debounce_delay
= false;
1008 /* Continue a partial initialization */
1009 if (type
== HUB_INIT2
)
1011 if (type
== HUB_INIT3
)
1014 /* The superspeed hub except for root hub has to use Hub Depth
1015 * value as an offset into the route string to locate the bits
1016 * it uses to determine the downstream port number. So hub driver
1017 * should send a set hub depth request to superspeed hub after
1018 * the superspeed hub is set configuration in initialization or
1021 * After a resume, port power should still be on.
1022 * For any other type of activation, turn it on.
1024 if (type
!= HUB_RESUME
) {
1025 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
1026 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
1027 HUB_SET_DEPTH
, USB_RT_HUB
,
1028 hdev
->level
- 1, 0, NULL
, 0,
1029 USB_CTRL_SET_TIMEOUT
);
1031 dev_err(hub
->intfdev
,
1032 "set hub depth failed\n");
1035 /* Speed up system boot by using a delayed_work for the
1036 * hub's initial power-up delays. This is pretty awkward
1037 * and the implementation looks like a home-brewed sort of
1038 * setjmp/longjmp, but it saves at least 100 ms for each
1039 * root hub (assuming usbcore is compiled into the kernel
1040 * rather than as a module). It adds up.
1042 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1043 * because for those activation types the ports have to be
1044 * operational when we return. In theory this could be done
1045 * for HUB_POST_RESET, but it's easier not to.
1047 if (type
== HUB_INIT
) {
1048 delay
= hub_power_on(hub
, false);
1049 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
1050 schedule_delayed_work(&hub
->init_work
,
1051 msecs_to_jiffies(delay
));
1053 /* Suppress autosuspend until init is done */
1054 usb_autopm_get_interface_no_resume(
1055 to_usb_interface(hub
->intfdev
));
1056 return; /* Continues at init2: below */
1057 } else if (type
== HUB_RESET_RESUME
) {
1058 /* The internal host controller state for the hub device
1059 * may be gone after a host power loss on system resume.
1060 * Update the device's info so the HW knows it's a hub.
1062 hcd
= bus_to_hcd(hdev
->bus
);
1063 if (hcd
->driver
->update_hub_device
) {
1064 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1065 &hub
->tt
, GFP_NOIO
);
1067 dev_err(hub
->intfdev
, "Host not "
1068 "accepting hub info "
1070 dev_err(hub
->intfdev
, "LS/FS devices "
1071 "and hubs may not work "
1072 "under this hub\n.");
1075 hub_power_on(hub
, true);
1077 hub_power_on(hub
, true);
1082 /* Check each port and set hub->change_bits to let khubd know
1083 * which ports need attention.
1085 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1086 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
1087 u16 portstatus
, portchange
;
1089 portstatus
= portchange
= 0;
1090 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1091 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1092 dev_dbg(hub
->intfdev
,
1093 "port %d: status %04x change %04x\n",
1094 port1
, portstatus
, portchange
);
1096 /* After anything other than HUB_RESUME (i.e., initialization
1097 * or any sort of reset), every port should be disabled.
1098 * Unconnected ports should likewise be disabled (paranoia),
1099 * and so should ports for which we have no usb_device.
1101 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1102 type
!= HUB_RESUME
||
1103 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1105 udev
->state
== USB_STATE_NOTATTACHED
)) {
1107 * USB3 protocol ports will automatically transition
1108 * to Enabled state when detect an USB3.0 device attach.
1109 * Do not disable USB3 protocol ports.
1111 if (!hub_is_superspeed(hdev
)) {
1112 usb_clear_port_feature(hdev
, port1
,
1113 USB_PORT_FEAT_ENABLE
);
1114 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1116 /* Pretend that power was lost for USB3 devs */
1117 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1121 /* Clear status-change flags; we'll debounce later */
1122 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1123 need_debounce_delay
= true;
1124 usb_clear_port_feature(hub
->hdev
, port1
,
1125 USB_PORT_FEAT_C_CONNECTION
);
1127 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1128 need_debounce_delay
= true;
1129 usb_clear_port_feature(hub
->hdev
, port1
,
1130 USB_PORT_FEAT_C_ENABLE
);
1132 if (portchange
& USB_PORT_STAT_C_RESET
) {
1133 need_debounce_delay
= true;
1134 usb_clear_port_feature(hub
->hdev
, port1
,
1135 USB_PORT_FEAT_C_RESET
);
1137 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1138 hub_is_superspeed(hub
->hdev
)) {
1139 need_debounce_delay
= true;
1140 usb_clear_port_feature(hub
->hdev
, port1
,
1141 USB_PORT_FEAT_C_BH_PORT_RESET
);
1143 /* We can forget about a "removed" device when there's a
1144 * physical disconnect or the connect status changes.
1146 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1147 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1148 clear_bit(port1
, hub
->removed_bits
);
1150 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1151 /* Tell khubd to disconnect the device or
1152 * check for a new connection
1154 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1155 set_bit(port1
, hub
->change_bits
);
1157 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1158 bool port_resumed
= (portstatus
&
1159 USB_PORT_STAT_LINK_STATE
) ==
1161 /* The power session apparently survived the resume.
1162 * If there was an overcurrent or suspend change
1163 * (i.e., remote wakeup request), have khubd
1164 * take care of it. Look at the port link state
1165 * for USB 3.0 hubs, since they don't have a suspend
1166 * change bit, and they don't set the port link change
1167 * bit on device-initiated resume.
1169 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1171 set_bit(port1
, hub
->change_bits
);
1173 } else if (udev
->persist_enabled
) {
1174 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
1177 udev
->reset_resume
= 1;
1179 /* Don't set the change_bits when the device
1182 if (port_dev
->power_is_on
)
1183 set_bit(port1
, hub
->change_bits
);
1186 /* The power session is gone; tell khubd */
1187 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1188 set_bit(port1
, hub
->change_bits
);
1192 /* If no port-status-change flags were set, we don't need any
1193 * debouncing. If flags were set we can try to debounce the
1194 * ports all at once right now, instead of letting khubd do them
1195 * one at a time later on.
1197 * If any port-status changes do occur during this delay, khubd
1198 * will see them later and handle them normally.
1200 if (need_debounce_delay
) {
1201 delay
= HUB_DEBOUNCE_STABLE
;
1203 /* Don't do a long sleep inside a workqueue routine */
1204 if (type
== HUB_INIT2
) {
1205 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1206 schedule_delayed_work(&hub
->init_work
,
1207 msecs_to_jiffies(delay
));
1208 return; /* Continues at init3: below */
1216 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1218 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1219 if (hub
->has_indicators
&& blinkenlights
)
1220 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1222 /* Scan all ports that need attention */
1225 /* Allow autosuspend if it was suppressed */
1226 if (type
<= HUB_INIT3
)
1227 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1230 /* Implement the continuations for the delays above */
1231 static void hub_init_func2(struct work_struct
*ws
)
1233 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1235 hub_activate(hub
, HUB_INIT2
);
1238 static void hub_init_func3(struct work_struct
*ws
)
1240 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1242 hub_activate(hub
, HUB_INIT3
);
1245 enum hub_quiescing_type
{
1246 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1249 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1251 struct usb_device
*hdev
= hub
->hdev
;
1254 cancel_delayed_work_sync(&hub
->init_work
);
1256 /* khubd and related activity won't re-trigger */
1259 if (type
!= HUB_SUSPEND
) {
1260 /* Disconnect all the children */
1261 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1262 if (hub
->ports
[i
]->child
)
1263 usb_disconnect(&hub
->ports
[i
]->child
);
1267 /* Stop khubd and related activity */
1268 usb_kill_urb(hub
->urb
);
1269 if (hub
->has_indicators
)
1270 cancel_delayed_work_sync(&hub
->leds
);
1272 flush_work(&hub
->tt
.clear_work
);
1275 /* caller has locked the hub device */
1276 static int hub_pre_reset(struct usb_interface
*intf
)
1278 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1280 hub_quiesce(hub
, HUB_PRE_RESET
);
1284 /* caller has locked the hub device */
1285 static int hub_post_reset(struct usb_interface
*intf
)
1287 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1289 hub_activate(hub
, HUB_POST_RESET
);
1293 static int hub_configure(struct usb_hub
*hub
,
1294 struct usb_endpoint_descriptor
*endpoint
)
1296 struct usb_hcd
*hcd
;
1297 struct usb_device
*hdev
= hub
->hdev
;
1298 struct device
*hub_dev
= hub
->intfdev
;
1299 u16 hubstatus
, hubchange
;
1300 u16 wHubCharacteristics
;
1303 char *message
= "out of memory";
1307 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1313 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1318 mutex_init(&hub
->status_mutex
);
1320 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1321 if (!hub
->descriptor
) {
1326 /* Request the entire hub descriptor.
1327 * hub->descriptor can handle USB_MAXCHILDREN ports,
1328 * but the hub can/will return fewer bytes here.
1330 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1332 message
= "can't read hub descriptor";
1334 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1335 message
= "hub has too many ports!";
1338 } else if (hub
->descriptor
->bNbrPorts
== 0) {
1339 message
= "hub doesn't have any ports!";
1344 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1345 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1346 (hdev
->maxchild
== 1) ? "" : "s");
1348 hub
->ports
= kzalloc(hdev
->maxchild
* sizeof(struct usb_port
*),
1355 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1356 if (hub_is_superspeed(hdev
)) {
1364 /* FIXME for USB 3.0, skip for now */
1365 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1366 !(hub_is_superspeed(hdev
))) {
1368 char portstr
[USB_MAXCHILDREN
+ 1];
1370 for (i
= 0; i
< hdev
->maxchild
; i
++)
1371 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1372 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1374 portstr
[hdev
->maxchild
] = 0;
1375 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1377 dev_dbg(hub_dev
, "standalone hub\n");
1379 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1380 case HUB_CHAR_COMMON_LPSM
:
1381 dev_dbg(hub_dev
, "ganged power switching\n");
1383 case HUB_CHAR_INDV_PORT_LPSM
:
1384 dev_dbg(hub_dev
, "individual port power switching\n");
1386 case HUB_CHAR_NO_LPSM
:
1388 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1392 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1393 case HUB_CHAR_COMMON_OCPM
:
1394 dev_dbg(hub_dev
, "global over-current protection\n");
1396 case HUB_CHAR_INDV_PORT_OCPM
:
1397 dev_dbg(hub_dev
, "individual port over-current protection\n");
1399 case HUB_CHAR_NO_OCPM
:
1401 dev_dbg(hub_dev
, "no over-current protection\n");
1405 spin_lock_init (&hub
->tt
.lock
);
1406 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1407 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1408 switch (hdev
->descriptor
.bDeviceProtocol
) {
1411 case USB_HUB_PR_HS_SINGLE_TT
:
1412 dev_dbg(hub_dev
, "Single TT\n");
1415 case USB_HUB_PR_HS_MULTI_TT
:
1416 ret
= usb_set_interface(hdev
, 0, 1);
1418 dev_dbg(hub_dev
, "TT per port\n");
1421 dev_err(hub_dev
, "Using single TT (err %d)\n",
1426 /* USB 3.0 hubs don't have a TT */
1429 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1430 hdev
->descriptor
.bDeviceProtocol
);
1434 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1435 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1436 case HUB_TTTT_8_BITS
:
1437 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1438 hub
->tt
.think_time
= 666;
1439 dev_dbg(hub_dev
, "TT requires at most %d "
1440 "FS bit times (%d ns)\n",
1441 8, hub
->tt
.think_time
);
1444 case HUB_TTTT_16_BITS
:
1445 hub
->tt
.think_time
= 666 * 2;
1446 dev_dbg(hub_dev
, "TT requires at most %d "
1447 "FS bit times (%d ns)\n",
1448 16, hub
->tt
.think_time
);
1450 case HUB_TTTT_24_BITS
:
1451 hub
->tt
.think_time
= 666 * 3;
1452 dev_dbg(hub_dev
, "TT requires at most %d "
1453 "FS bit times (%d ns)\n",
1454 24, hub
->tt
.think_time
);
1456 case HUB_TTTT_32_BITS
:
1457 hub
->tt
.think_time
= 666 * 4;
1458 dev_dbg(hub_dev
, "TT requires at most %d "
1459 "FS bit times (%d ns)\n",
1460 32, hub
->tt
.think_time
);
1464 /* probe() zeroes hub->indicator[] */
1465 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1466 hub
->has_indicators
= 1;
1467 dev_dbg(hub_dev
, "Port indicators are supported\n");
1470 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1471 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1473 /* power budgeting mostly matters with bus-powered hubs,
1474 * and battery-powered root hubs (may provide just 8 mA).
1476 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1478 message
= "can't get hub status";
1481 le16_to_cpus(&hubstatus
);
1482 hcd
= bus_to_hcd(hdev
->bus
);
1483 if (hdev
== hdev
->bus
->root_hub
) {
1484 if (hcd
->power_budget
> 0)
1485 hdev
->bus_mA
= hcd
->power_budget
;
1487 hdev
->bus_mA
= full_load
* hdev
->maxchild
;
1488 if (hdev
->bus_mA
>= full_load
)
1489 hub
->mA_per_port
= full_load
;
1491 hub
->mA_per_port
= hdev
->bus_mA
;
1492 hub
->limited_power
= 1;
1494 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1495 int remaining
= hdev
->bus_mA
-
1496 hub
->descriptor
->bHubContrCurrent
;
1498 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1499 hub
->descriptor
->bHubContrCurrent
);
1500 hub
->limited_power
= 1;
1502 if (remaining
< hdev
->maxchild
* unit_load
)
1504 "insufficient power available "
1505 "to use all downstream ports\n");
1506 hub
->mA_per_port
= unit_load
; /* 7.2.1 */
1508 } else { /* Self-powered external hub */
1509 /* FIXME: What about battery-powered external hubs that
1510 * provide less current per port? */
1511 hub
->mA_per_port
= full_load
;
1513 if (hub
->mA_per_port
< full_load
)
1514 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1517 /* Update the HCD's internal representation of this hub before khubd
1518 * starts getting port status changes for devices under the hub.
1520 if (hcd
->driver
->update_hub_device
) {
1521 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1522 &hub
->tt
, GFP_KERNEL
);
1524 message
= "can't update HCD hub info";
1529 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1531 message
= "can't get hub status";
1535 /* local power status reports aren't always correct */
1536 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1537 dev_dbg(hub_dev
, "local power source is %s\n",
1538 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1539 ? "lost (inactive)" : "good");
1541 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1542 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1543 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1545 /* set up the interrupt endpoint
1546 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1547 * bytes as USB2.0[11.12.3] says because some hubs are known
1548 * to send more data (and thus cause overflow). For root hubs,
1549 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1550 * to be big enough for at least USB_MAXCHILDREN ports. */
1551 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1552 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1554 if (maxp
> sizeof(*hub
->buffer
))
1555 maxp
= sizeof(*hub
->buffer
);
1557 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1563 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1564 hub
, endpoint
->bInterval
);
1566 /* maybe cycle the hub leds */
1567 if (hub
->has_indicators
&& blinkenlights
)
1568 hub
->indicator
[0] = INDICATOR_CYCLE
;
1570 for (i
= 0; i
< hdev
->maxchild
; i
++) {
1571 ret
= usb_hub_create_port_device(hub
, i
+ 1);
1573 dev_err(hub
->intfdev
,
1574 "couldn't create port%d device.\n", i
+ 1);
1576 goto fail_keep_maxchild
;
1580 usb_hub_adjust_deviceremovable(hdev
, hub
->descriptor
);
1582 hub_activate(hub
, HUB_INIT
);
1588 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1590 /* hub_disconnect() frees urb and descriptor */
1594 static void hub_release(struct kref
*kref
)
1596 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1598 usb_put_intf(to_usb_interface(hub
->intfdev
));
1602 static unsigned highspeed_hubs
;
1604 static void hub_disconnect(struct usb_interface
*intf
)
1606 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1607 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1610 /* Take the hub off the event list and don't let it be added again */
1611 spin_lock_irq(&hub_event_lock
);
1612 if (!list_empty(&hub
->event_list
)) {
1613 list_del_init(&hub
->event_list
);
1614 usb_autopm_put_interface_no_suspend(intf
);
1616 hub
->disconnected
= 1;
1617 spin_unlock_irq(&hub_event_lock
);
1619 /* Disconnect all children and quiesce the hub */
1621 hub_quiesce(hub
, HUB_DISCONNECT
);
1623 usb_set_intfdata (intf
, NULL
);
1625 for (i
= 0; i
< hdev
->maxchild
; i
++)
1626 usb_hub_remove_port_device(hub
, i
+ 1);
1627 hub
->hdev
->maxchild
= 0;
1629 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1632 usb_free_urb(hub
->urb
);
1634 kfree(hub
->descriptor
);
1638 pm_suspend_ignore_children(&intf
->dev
, false);
1639 kref_put(&hub
->kref
, hub_release
);
1642 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1644 struct usb_host_interface
*desc
;
1645 struct usb_endpoint_descriptor
*endpoint
;
1646 struct usb_device
*hdev
;
1647 struct usb_hub
*hub
;
1649 desc
= intf
->cur_altsetting
;
1650 hdev
= interface_to_usbdev(intf
);
1653 * Set default autosuspend delay as 0 to speedup bus suspend,
1654 * based on the below considerations:
1656 * - Unlike other drivers, the hub driver does not rely on the
1657 * autosuspend delay to provide enough time to handle a wakeup
1658 * event, and the submitted status URB is just to check future
1659 * change on hub downstream ports, so it is safe to do it.
1661 * - The patch might cause one or more auto supend/resume for
1662 * below very rare devices when they are plugged into hub
1665 * devices having trouble initializing, and disconnect
1666 * themselves from the bus and then reconnect a second
1669 * devices just for downloading firmware, and disconnects
1670 * themselves after completing it
1672 * For these quite rare devices, their drivers may change the
1673 * autosuspend delay of their parent hub in the probe() to one
1674 * appropriate value to avoid the subtle problem if someone
1677 * - The patch may cause one or more auto suspend/resume on
1678 * hub during running 'lsusb', but it is probably too
1679 * infrequent to worry about.
1681 * - Change autosuspend delay of hub can avoid unnecessary auto
1682 * suspend timer for hub, also may decrease power consumption
1685 pm_runtime_set_autosuspend_delay(&hdev
->dev
, 0);
1687 /* Hubs have proper suspend/resume support. */
1688 usb_enable_autosuspend(hdev
);
1690 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1692 "Unsupported bus topology: hub nested too deep\n");
1696 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1698 dev_warn(&intf
->dev
, "ignoring external hub\n");
1703 /* Some hubs have a subclass of 1, which AFAICT according to the */
1704 /* specs is not defined, but it works */
1705 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1706 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1708 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1712 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1713 if (desc
->desc
.bNumEndpoints
!= 1)
1714 goto descriptor_error
;
1716 endpoint
= &desc
->endpoint
[0].desc
;
1718 /* If it's not an interrupt in endpoint, we'd better punt! */
1719 if (!usb_endpoint_is_int_in(endpoint
))
1720 goto descriptor_error
;
1722 /* We found a hub */
1723 dev_info (&intf
->dev
, "USB hub found\n");
1725 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1727 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1731 kref_init(&hub
->kref
);
1732 INIT_LIST_HEAD(&hub
->event_list
);
1733 hub
->intfdev
= &intf
->dev
;
1735 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1736 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1739 usb_set_intfdata (intf
, hub
);
1740 intf
->needs_remote_wakeup
= 1;
1741 pm_suspend_ignore_children(&intf
->dev
, true);
1743 if (hdev
->speed
== USB_SPEED_HIGH
)
1746 if (id
->driver_info
& HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
)
1747 hub
->quirk_check_port_auto_suspend
= 1;
1749 if (hub_configure(hub
, endpoint
) >= 0)
1752 hub_disconnect (intf
);
1757 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1759 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1760 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1762 /* assert ifno == 0 (part of hub spec) */
1764 case USBDEVFS_HUB_PORTINFO
: {
1765 struct usbdevfs_hub_portinfo
*info
= user_data
;
1768 spin_lock_irq(&device_state_lock
);
1769 if (hdev
->devnum
<= 0)
1772 info
->nports
= hdev
->maxchild
;
1773 for (i
= 0; i
< info
->nports
; i
++) {
1774 if (hub
->ports
[i
]->child
== NULL
)
1778 hub
->ports
[i
]->child
->devnum
;
1781 spin_unlock_irq(&device_state_lock
);
1783 return info
->nports
+ 1;
1792 * Allow user programs to claim ports on a hub. When a device is attached
1793 * to one of these "claimed" ports, the program will "own" the device.
1795 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1796 struct dev_state
***ppowner
)
1798 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1800 if (port1
== 0 || port1
> hdev
->maxchild
)
1803 /* This assumes that devices not managed by the hub driver
1804 * will always have maxchild equal to 0.
1806 *ppowner
= &(usb_hub_to_struct_hub(hdev
)->ports
[port1
- 1]->port_owner
);
1810 /* In the following three functions, the caller must hold hdev's lock */
1811 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1812 struct dev_state
*owner
)
1815 struct dev_state
**powner
;
1817 rc
= find_port_owner(hdev
, port1
, &powner
);
1826 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1827 struct dev_state
*owner
)
1830 struct dev_state
**powner
;
1832 rc
= find_port_owner(hdev
, port1
, &powner
);
1835 if (*powner
!= owner
)
1841 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1843 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
1846 for (n
= 0; n
< hdev
->maxchild
; n
++) {
1847 if (hub
->ports
[n
]->port_owner
== owner
)
1848 hub
->ports
[n
]->port_owner
= NULL
;
1853 /* The caller must hold udev's lock */
1854 bool usb_device_is_owned(struct usb_device
*udev
)
1856 struct usb_hub
*hub
;
1858 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1860 hub
= usb_hub_to_struct_hub(udev
->parent
);
1861 return !!hub
->ports
[udev
->portnum
- 1]->port_owner
;
1864 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1866 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
1869 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1870 if (hub
->ports
[i
]->child
)
1871 recursively_mark_NOTATTACHED(hub
->ports
[i
]->child
);
1873 if (udev
->state
== USB_STATE_SUSPENDED
)
1874 udev
->active_duration
-= jiffies
;
1875 udev
->state
= USB_STATE_NOTATTACHED
;
1879 * usb_set_device_state - change a device's current state (usbcore, hcds)
1880 * @udev: pointer to device whose state should be changed
1881 * @new_state: new state value to be stored
1883 * udev->state is _not_ fully protected by the device lock. Although
1884 * most transitions are made only while holding the lock, the state can
1885 * can change to USB_STATE_NOTATTACHED at almost any time. This
1886 * is so that devices can be marked as disconnected as soon as possible,
1887 * without having to wait for any semaphores to be released. As a result,
1888 * all changes to any device's state must be protected by the
1889 * device_state_lock spinlock.
1891 * Once a device has been added to the device tree, all changes to its state
1892 * should be made using this routine. The state should _not_ be set directly.
1894 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1895 * Otherwise udev->state is set to new_state, and if new_state is
1896 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1897 * to USB_STATE_NOTATTACHED.
1899 void usb_set_device_state(struct usb_device
*udev
,
1900 enum usb_device_state new_state
)
1902 unsigned long flags
;
1905 spin_lock_irqsave(&device_state_lock
, flags
);
1906 if (udev
->state
== USB_STATE_NOTATTACHED
)
1908 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1910 /* root hub wakeup capabilities are managed out-of-band
1911 * and may involve silicon errata ... ignore them here.
1914 if (udev
->state
== USB_STATE_SUSPENDED
1915 || new_state
== USB_STATE_SUSPENDED
)
1916 ; /* No change to wakeup settings */
1917 else if (new_state
== USB_STATE_CONFIGURED
)
1918 wakeup
= udev
->actconfig
->desc
.bmAttributes
1919 & USB_CONFIG_ATT_WAKEUP
;
1923 if (udev
->state
== USB_STATE_SUSPENDED
&&
1924 new_state
!= USB_STATE_SUSPENDED
)
1925 udev
->active_duration
-= jiffies
;
1926 else if (new_state
== USB_STATE_SUSPENDED
&&
1927 udev
->state
!= USB_STATE_SUSPENDED
)
1928 udev
->active_duration
+= jiffies
;
1929 udev
->state
= new_state
;
1931 recursively_mark_NOTATTACHED(udev
);
1932 spin_unlock_irqrestore(&device_state_lock
, flags
);
1934 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1936 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1939 * Choose a device number.
1941 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1942 * USB-2.0 buses they are also used as device addresses, however on
1943 * USB-3.0 buses the address is assigned by the controller hardware
1944 * and it usually is not the same as the device number.
1946 * WUSB devices are simple: they have no hubs behind, so the mapping
1947 * device <-> virtual port number becomes 1:1. Why? to simplify the
1948 * life of the device connection logic in
1949 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1950 * handshake we need to assign a temporary address in the unauthorized
1951 * space. For simplicity we use the first virtual port number found to
1952 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1953 * and that becomes it's address [X < 128] or its unauthorized address
1956 * We add 1 as an offset to the one-based USB-stack port number
1957 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1958 * 0 is reserved by USB for default address; (b) Linux's USB stack
1959 * uses always #1 for the root hub of the controller. So USB stack's
1960 * port #1, which is wusb virtual-port #0 has address #2.
1962 * Devices connected under xHCI are not as simple. The host controller
1963 * supports virtualization, so the hardware assigns device addresses and
1964 * the HCD must setup data structures before issuing a set address
1965 * command to the hardware.
1967 static void choose_devnum(struct usb_device
*udev
)
1970 struct usb_bus
*bus
= udev
->bus
;
1972 /* If khubd ever becomes multithreaded, this will need a lock */
1974 devnum
= udev
->portnum
+ 1;
1975 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1977 /* Try to allocate the next devnum beginning at
1978 * bus->devnum_next. */
1979 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1982 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1984 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1987 set_bit(devnum
, bus
->devmap
.devicemap
);
1988 udev
->devnum
= devnum
;
1992 static void release_devnum(struct usb_device
*udev
)
1994 if (udev
->devnum
> 0) {
1995 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
2000 static void update_devnum(struct usb_device
*udev
, int devnum
)
2002 /* The address for a WUSB device is managed by wusbcore. */
2004 udev
->devnum
= devnum
;
2007 static void hub_free_dev(struct usb_device
*udev
)
2009 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2011 /* Root hubs aren't real devices, so don't free HCD resources */
2012 if (hcd
->driver
->free_dev
&& udev
->parent
)
2013 hcd
->driver
->free_dev(hcd
, udev
);
2017 * usb_disconnect - disconnect a device (usbcore-internal)
2018 * @pdev: pointer to device being disconnected
2019 * Context: !in_interrupt ()
2021 * Something got disconnected. Get rid of it and all of its children.
2023 * If *pdev is a normal device then the parent hub must already be locked.
2024 * If *pdev is a root hub then this routine will acquire the
2025 * usb_bus_list_lock on behalf of the caller.
2027 * Only hub drivers (including virtual root hub drivers for host
2028 * controllers) should ever call this.
2030 * This call is synchronous, and may not be used in an interrupt context.
2032 void usb_disconnect(struct usb_device
**pdev
)
2034 struct usb_device
*udev
= *pdev
;
2035 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2038 /* mark the device as inactive, so any further urb submissions for
2039 * this device (and any of its children) will fail immediately.
2040 * this quiesces everything except pending urbs.
2042 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2043 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
2046 usb_lock_device(udev
);
2048 /* Free up all the children before we remove this device */
2049 for (i
= 0; i
< udev
->maxchild
; i
++) {
2050 if (hub
->ports
[i
]->child
)
2051 usb_disconnect(&hub
->ports
[i
]->child
);
2054 /* deallocate hcd/hardware state ... nuking all pending urbs and
2055 * cleaning up all state associated with the current configuration
2056 * so that the hardware is now fully quiesced.
2058 dev_dbg (&udev
->dev
, "unregistering device\n");
2059 usb_disable_device(udev
, 0);
2060 usb_hcd_synchronize_unlinks(udev
);
2063 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2064 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2066 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2067 sysfs_remove_link(&port_dev
->dev
.kobj
, "device");
2069 if (!port_dev
->did_runtime_put
)
2070 pm_runtime_put(&port_dev
->dev
);
2072 port_dev
->did_runtime_put
= false;
2075 usb_remove_ep_devs(&udev
->ep0
);
2076 usb_unlock_device(udev
);
2078 /* Unregister the device. The device driver is responsible
2079 * for de-configuring the device and invoking the remove-device
2080 * notifier chain (used by usbfs and possibly others).
2082 device_del(&udev
->dev
);
2084 /* Free the device number and delete the parent's children[]
2085 * (or root_hub) pointer.
2087 release_devnum(udev
);
2089 /* Avoid races with recursively_mark_NOTATTACHED() */
2090 spin_lock_irq(&device_state_lock
);
2092 spin_unlock_irq(&device_state_lock
);
2096 put_device(&udev
->dev
);
2099 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2100 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
2104 dev_info(&udev
->dev
, "%s: %s\n", id
, string
);
2107 static void announce_device(struct usb_device
*udev
)
2109 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2110 le16_to_cpu(udev
->descriptor
.idVendor
),
2111 le16_to_cpu(udev
->descriptor
.idProduct
));
2112 dev_info(&udev
->dev
,
2113 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2114 udev
->descriptor
.iManufacturer
,
2115 udev
->descriptor
.iProduct
,
2116 udev
->descriptor
.iSerialNumber
);
2117 show_string(udev
, "Product", udev
->product
);
2118 show_string(udev
, "Manufacturer", udev
->manufacturer
);
2119 show_string(udev
, "SerialNumber", udev
->serial
);
2122 static inline void announce_device(struct usb_device
*udev
) { }
2125 #ifdef CONFIG_USB_OTG
2126 #include "otg_whitelist.h"
2130 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2131 * @udev: newly addressed device (in ADDRESS state)
2133 * Finish enumeration for On-The-Go devices
2135 static int usb_enumerate_device_otg(struct usb_device
*udev
)
2139 #ifdef CONFIG_USB_OTG
2141 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2142 * to wake us after we've powered off VBUS; and HNP, switching roles
2143 * "host" to "peripheral". The OTG descriptor helps figure this out.
2145 if (!udev
->bus
->is_b_host
2147 && udev
->parent
== udev
->bus
->root_hub
) {
2148 struct usb_otg_descriptor
*desc
= NULL
;
2149 struct usb_bus
*bus
= udev
->bus
;
2151 /* descriptor may appear anywhere in config */
2152 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
2153 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2154 USB_DT_OTG
, (void **) &desc
) == 0) {
2155 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2156 unsigned port1
= udev
->portnum
;
2158 dev_info(&udev
->dev
,
2159 "Dual-Role OTG device on %sHNP port\n",
2160 (port1
== bus
->otg_port
)
2163 /* enable HNP before suspend, it's simpler */
2164 if (port1
== bus
->otg_port
)
2165 bus
->b_hnp_enable
= 1;
2166 err
= usb_control_msg(udev
,
2167 usb_sndctrlpipe(udev
, 0),
2168 USB_REQ_SET_FEATURE
, 0,
2170 ? USB_DEVICE_B_HNP_ENABLE
2171 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2172 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2174 /* OTG MESSAGE: report errors here,
2175 * customize to match your product.
2177 dev_info(&udev
->dev
,
2178 "can't set HNP mode: %d\n",
2180 bus
->b_hnp_enable
= 0;
2186 if (!is_targeted(udev
)) {
2188 /* Maybe it can talk to us, though we can't talk to it.
2189 * (Includes HNP test device.)
2191 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2192 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2194 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2206 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2207 * @udev: newly addressed device (in ADDRESS state)
2209 * This is only called by usb_new_device() and usb_authorize_device()
2210 * and FIXME -- all comments that apply to them apply here wrt to
2213 * If the device is WUSB and not authorized, we don't attempt to read
2214 * the string descriptors, as they will be errored out by the device
2215 * until it has been authorized.
2217 static int usb_enumerate_device(struct usb_device
*udev
)
2221 if (udev
->config
== NULL
) {
2222 err
= usb_get_configuration(udev
);
2225 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2230 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
2231 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2232 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2233 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2236 /* read the standard strings and cache them if present */
2237 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2238 udev
->manufacturer
= usb_cache_string(udev
,
2239 udev
->descriptor
.iManufacturer
);
2240 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2242 err
= usb_enumerate_device_otg(udev
);
2246 usb_detect_interface_quirks(udev
);
2251 static void set_usb_port_removable(struct usb_device
*udev
)
2253 struct usb_device
*hdev
= udev
->parent
;
2254 struct usb_hub
*hub
;
2255 u8 port
= udev
->portnum
;
2256 u16 wHubCharacteristics
;
2257 bool removable
= true;
2262 hub
= usb_hub_to_struct_hub(udev
->parent
);
2264 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2266 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2269 if (hub_is_superspeed(hdev
)) {
2270 if (le16_to_cpu(hub
->descriptor
->u
.ss
.DeviceRemovable
)
2274 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2279 udev
->removable
= USB_DEVICE_REMOVABLE
;
2281 udev
->removable
= USB_DEVICE_FIXED
;
2285 * usb_new_device - perform initial device setup (usbcore-internal)
2286 * @udev: newly addressed device (in ADDRESS state)
2288 * This is called with devices which have been detected but not fully
2289 * enumerated. The device descriptor is available, but not descriptors
2290 * for any device configuration. The caller must have locked either
2291 * the parent hub (if udev is a normal device) or else the
2292 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2293 * udev has already been installed, but udev is not yet visible through
2294 * sysfs or other filesystem code.
2296 * It will return if the device is configured properly or not. Zero if
2297 * the interface was registered with the driver core; else a negative
2300 * This call is synchronous, and may not be used in an interrupt context.
2302 * Only the hub driver or root-hub registrar should ever call this.
2304 int usb_new_device(struct usb_device
*udev
)
2309 /* Initialize non-root-hub device wakeup to disabled;
2310 * device (un)configuration controls wakeup capable
2311 * sysfs power/wakeup controls wakeup enabled/disabled
2313 device_init_wakeup(&udev
->dev
, 0);
2316 /* Tell the runtime-PM framework the device is active */
2317 pm_runtime_set_active(&udev
->dev
);
2318 pm_runtime_get_noresume(&udev
->dev
);
2319 pm_runtime_use_autosuspend(&udev
->dev
);
2320 pm_runtime_enable(&udev
->dev
);
2322 /* By default, forbid autosuspend for all devices. It will be
2323 * allowed for hubs during binding.
2325 usb_disable_autosuspend(udev
);
2327 err
= usb_enumerate_device(udev
); /* Read descriptors */
2330 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2331 udev
->devnum
, udev
->bus
->busnum
,
2332 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2333 /* export the usbdev device-node for libusb */
2334 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2335 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2337 /* Tell the world! */
2338 announce_device(udev
);
2341 add_device_randomness(udev
->serial
, strlen(udev
->serial
));
2343 add_device_randomness(udev
->product
, strlen(udev
->product
));
2344 if (udev
->manufacturer
)
2345 add_device_randomness(udev
->manufacturer
,
2346 strlen(udev
->manufacturer
));
2348 device_enable_async_suspend(&udev
->dev
);
2351 * check whether the hub marks this port as non-removable. Do it
2352 * now so that platform-specific data can override it in
2356 set_usb_port_removable(udev
);
2358 /* Register the device. The device driver is responsible
2359 * for configuring the device and invoking the add-device
2360 * notifier chain (used by usbfs and possibly others).
2362 err
= device_add(&udev
->dev
);
2364 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2368 /* Create link files between child device and usb port device. */
2370 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2371 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2373 err
= sysfs_create_link(&udev
->dev
.kobj
,
2374 &port_dev
->dev
.kobj
, "port");
2378 err
= sysfs_create_link(&port_dev
->dev
.kobj
,
2379 &udev
->dev
.kobj
, "device");
2381 sysfs_remove_link(&udev
->dev
.kobj
, "port");
2385 pm_runtime_get_sync(&port_dev
->dev
);
2388 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2389 usb_mark_last_busy(udev
);
2390 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2394 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2395 pm_runtime_disable(&udev
->dev
);
2396 pm_runtime_set_suspended(&udev
->dev
);
2402 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2403 * @usb_dev: USB device
2405 * Move the USB device to a very basic state where interfaces are disabled
2406 * and the device is in fact unconfigured and unusable.
2408 * We share a lock (that we have) with device_del(), so we need to
2411 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2413 usb_lock_device(usb_dev
);
2414 if (usb_dev
->authorized
== 0)
2415 goto out_unauthorized
;
2417 usb_dev
->authorized
= 0;
2418 usb_set_configuration(usb_dev
, -1);
2420 kfree(usb_dev
->product
);
2421 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2422 kfree(usb_dev
->manufacturer
);
2423 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2424 kfree(usb_dev
->serial
);
2425 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2427 usb_destroy_configuration(usb_dev
);
2428 usb_dev
->descriptor
.bNumConfigurations
= 0;
2431 usb_unlock_device(usb_dev
);
2436 int usb_authorize_device(struct usb_device
*usb_dev
)
2440 usb_lock_device(usb_dev
);
2441 if (usb_dev
->authorized
== 1)
2442 goto out_authorized
;
2444 result
= usb_autoresume_device(usb_dev
);
2446 dev_err(&usb_dev
->dev
,
2447 "can't autoresume for authorization: %d\n", result
);
2448 goto error_autoresume
;
2450 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2452 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2453 "authorization: %d\n", result
);
2454 goto error_device_descriptor
;
2457 kfree(usb_dev
->product
);
2458 usb_dev
->product
= NULL
;
2459 kfree(usb_dev
->manufacturer
);
2460 usb_dev
->manufacturer
= NULL
;
2461 kfree(usb_dev
->serial
);
2462 usb_dev
->serial
= NULL
;
2464 usb_dev
->authorized
= 1;
2465 result
= usb_enumerate_device(usb_dev
);
2467 goto error_enumerate
;
2468 /* Choose and set the configuration. This registers the interfaces
2469 * with the driver core and lets interface drivers bind to them.
2471 c
= usb_choose_configuration(usb_dev
);
2473 result
= usb_set_configuration(usb_dev
, c
);
2475 dev_err(&usb_dev
->dev
,
2476 "can't set config #%d, error %d\n", c
, result
);
2477 /* This need not be fatal. The user can try to
2478 * set other configurations. */
2481 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2484 error_device_descriptor
:
2485 usb_autosuspend_device(usb_dev
);
2488 usb_unlock_device(usb_dev
); // complements locktree
2493 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2494 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2496 struct usb_hcd
*hcd
;
2497 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2499 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2500 return hcd
->wireless
;
2504 #define PORT_RESET_TRIES 5
2505 #define SET_ADDRESS_TRIES 2
2506 #define GET_DESCRIPTOR_TRIES 2
2507 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2508 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2510 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2511 #define HUB_SHORT_RESET_TIME 10
2512 #define HUB_BH_RESET_TIME 50
2513 #define HUB_LONG_RESET_TIME 200
2514 #define HUB_RESET_TIMEOUT 800
2516 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2517 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2519 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2520 * Port worm reset is required to recover
2522 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2524 return hub_is_superspeed(hub
->hdev
) &&
2525 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2526 USB_SS_PORT_LS_SS_INACTIVE
) ||
2527 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2528 USB_SS_PORT_LS_COMP_MOD
)) ;
2531 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2532 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2534 int delay_time
, ret
;
2538 for (delay_time
= 0;
2539 delay_time
< HUB_RESET_TIMEOUT
;
2540 delay_time
+= delay
) {
2541 /* wait to give the device a chance to reset */
2544 /* read and decode port status */
2545 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2549 /* The port state is unknown until the reset completes. */
2550 if (!(portstatus
& USB_PORT_STAT_RESET
))
2553 /* switch to the long delay after two short delay failures */
2554 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2555 delay
= HUB_LONG_RESET_TIME
;
2557 dev_dbg (hub
->intfdev
,
2558 "port %d not %sreset yet, waiting %dms\n",
2559 port1
, warm
? "warm " : "", delay
);
2562 if ((portstatus
& USB_PORT_STAT_RESET
))
2565 if (hub_port_warm_reset_required(hub
, portstatus
))
2568 /* Device went away? */
2569 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2572 /* bomb out completely if the connection bounced. A USB 3.0
2573 * connection may bounce if multiple warm resets were issued,
2574 * but the device may have successfully re-connected. Ignore it.
2576 if (!hub_is_superspeed(hub
->hdev
) &&
2577 (portchange
& USB_PORT_STAT_C_CONNECTION
))
2580 if (!(portstatus
& USB_PORT_STAT_ENABLE
))
2586 if (hub_is_wusb(hub
))
2587 udev
->speed
= USB_SPEED_WIRELESS
;
2588 else if (hub_is_superspeed(hub
->hdev
))
2589 udev
->speed
= USB_SPEED_SUPER
;
2590 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2591 udev
->speed
= USB_SPEED_HIGH
;
2592 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2593 udev
->speed
= USB_SPEED_LOW
;
2595 udev
->speed
= USB_SPEED_FULL
;
2599 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2600 struct usb_device
*udev
, int *status
)
2604 /* TRSTRCY = 10 ms; plus some extra */
2607 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2609 update_devnum(udev
, 0);
2610 /* The xHC may think the device is already reset,
2611 * so ignore the status.
2613 if (hcd
->driver
->reset_device
)
2614 hcd
->driver
->reset_device(hcd
, udev
);
2619 usb_clear_port_feature(hub
->hdev
,
2620 port1
, USB_PORT_FEAT_C_RESET
);
2621 if (hub_is_superspeed(hub
->hdev
)) {
2622 usb_clear_port_feature(hub
->hdev
, port1
,
2623 USB_PORT_FEAT_C_BH_PORT_RESET
);
2624 usb_clear_port_feature(hub
->hdev
, port1
,
2625 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2626 usb_clear_port_feature(hub
->hdev
, port1
,
2627 USB_PORT_FEAT_C_CONNECTION
);
2630 usb_set_device_state(udev
, *status
2631 ? USB_STATE_NOTATTACHED
2632 : USB_STATE_DEFAULT
);
2637 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2638 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2639 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2642 u16 portchange
, portstatus
;
2644 if (!hub_is_superspeed(hub
->hdev
)) {
2646 dev_err(hub
->intfdev
, "only USB3 hub support "
2650 /* Block EHCI CF initialization during the port reset.
2651 * Some companion controllers don't like it when they mix.
2653 down_read(&ehci_cf_port_reset_rwsem
);
2656 * If the caller hasn't explicitly requested a warm reset,
2657 * double check and see if one is needed.
2659 status
= hub_port_status(hub
, port1
,
2660 &portstatus
, &portchange
);
2664 if (hub_port_warm_reset_required(hub
, portstatus
))
2668 /* Reset the port */
2669 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2670 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2671 USB_PORT_FEAT_BH_PORT_RESET
:
2672 USB_PORT_FEAT_RESET
));
2673 if (status
== -ENODEV
) {
2674 ; /* The hub is gone */
2675 } else if (status
) {
2676 dev_err(hub
->intfdev
,
2677 "cannot %sreset port %d (err = %d)\n",
2678 warm
? "warm " : "", port1
, status
);
2680 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2682 if (status
&& status
!= -ENOTCONN
&& status
!= -ENODEV
)
2683 dev_dbg(hub
->intfdev
,
2684 "port_wait_reset: err = %d\n",
2688 /* Check for disconnect or reset */
2689 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2690 hub_port_finish_reset(hub
, port1
, udev
, &status
);
2692 if (!hub_is_superspeed(hub
->hdev
))
2696 * If a USB 3.0 device migrates from reset to an error
2697 * state, re-issue the warm reset.
2699 if (hub_port_status(hub
, port1
,
2700 &portstatus
, &portchange
) < 0)
2703 if (!hub_port_warm_reset_required(hub
, portstatus
))
2707 * If the port is in SS.Inactive or Compliance Mode, the
2708 * hot or warm reset failed. Try another warm reset.
2711 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2717 dev_dbg (hub
->intfdev
,
2718 "port %d not enabled, trying %sreset again...\n",
2719 port1
, warm
? "warm " : "");
2720 delay
= HUB_LONG_RESET_TIME
;
2723 dev_err (hub
->intfdev
,
2724 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2728 if (!hub_is_superspeed(hub
->hdev
))
2729 up_read(&ehci_cf_port_reset_rwsem
);
2734 /* Check if a port is power on */
2735 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2739 if (hub_is_superspeed(hub
->hdev
)) {
2740 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2743 if (portstatus
& USB_PORT_STAT_POWER
)
2752 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2753 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2757 if (hub_is_superspeed(hub
->hdev
)) {
2758 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2759 == USB_SS_PORT_LS_U3
)
2762 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2769 /* Determine whether the device on a port is ready for a normal resume,
2770 * is ready for a reset-resume, or should be disconnected.
2772 static int check_port_resume_type(struct usb_device
*udev
,
2773 struct usb_hub
*hub
, int port1
,
2774 int status
, unsigned portchange
, unsigned portstatus
)
2776 /* Is the device still present? */
2777 if (status
|| port_is_suspended(hub
, portstatus
) ||
2778 !port_is_power_on(hub
, portstatus
) ||
2779 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2784 /* Can't do a normal resume if the port isn't enabled,
2785 * so try a reset-resume instead.
2787 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2788 if (udev
->persist_enabled
)
2789 udev
->reset_resume
= 1;
2795 dev_dbg(hub
->intfdev
,
2796 "port %d status %04x.%04x after resume, %d\n",
2797 port1
, portchange
, portstatus
, status
);
2798 } else if (udev
->reset_resume
) {
2800 /* Late port handoff can set status-change bits */
2801 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2802 usb_clear_port_feature(hub
->hdev
, port1
,
2803 USB_PORT_FEAT_C_CONNECTION
);
2804 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2805 usb_clear_port_feature(hub
->hdev
, port1
,
2806 USB_PORT_FEAT_C_ENABLE
);
2812 int usb_disable_ltm(struct usb_device
*udev
)
2814 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2816 /* Check if the roothub and device supports LTM. */
2817 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2818 !usb_device_supports_ltm(udev
))
2821 /* Clear Feature LTM Enable can only be sent if the device is
2824 if (!udev
->actconfig
)
2827 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2828 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2829 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2830 USB_CTRL_SET_TIMEOUT
);
2832 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2834 void usb_enable_ltm(struct usb_device
*udev
)
2836 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2838 /* Check if the roothub and device supports LTM. */
2839 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2840 !usb_device_supports_ltm(udev
))
2843 /* Set Feature LTM Enable can only be sent if the device is
2846 if (!udev
->actconfig
)
2849 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2850 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2851 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2852 USB_CTRL_SET_TIMEOUT
);
2854 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2858 * usb_disable_function_remotewakeup - disable usb3.0
2859 * device's function remote wakeup
2860 * @udev: target device
2862 * Assume there's only one function on the USB 3.0
2863 * device and disable remote wake for the first
2864 * interface. FIXME if the interface association
2865 * descriptor shows there's more than one function.
2867 static int usb_disable_function_remotewakeup(struct usb_device
*udev
)
2869 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2870 USB_REQ_CLEAR_FEATURE
, USB_RECIP_INTERFACE
,
2871 USB_INTRF_FUNC_SUSPEND
, 0, NULL
, 0,
2872 USB_CTRL_SET_TIMEOUT
);
2875 /* Count of wakeup-enabled devices at or below udev */
2876 static unsigned wakeup_enabled_descendants(struct usb_device
*udev
)
2878 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
);
2880 return udev
->do_remote_wakeup
+
2881 (hub
? hub
->wakeup_enabled_descendants
: 0);
2885 * usb_port_suspend - suspend a usb device's upstream port
2886 * @udev: device that's no longer in active use, not a root hub
2887 * Context: must be able to sleep; device not locked; pm locks held
2889 * Suspends a USB device that isn't in active use, conserving power.
2890 * Devices may wake out of a suspend, if anything important happens,
2891 * using the remote wakeup mechanism. They may also be taken out of
2892 * suspend by the host, using usb_port_resume(). It's also routine
2893 * to disconnect devices while they are suspended.
2895 * This only affects the USB hardware for a device; its interfaces
2896 * (and, for hubs, child devices) must already have been suspended.
2898 * Selective port suspend reduces power; most suspended devices draw
2899 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2900 * All devices below the suspended port are also suspended.
2902 * Devices leave suspend state when the host wakes them up. Some devices
2903 * also support "remote wakeup", where the device can activate the USB
2904 * tree above them to deliver data, such as a keypress or packet. In
2905 * some cases, this wakes the USB host.
2907 * Suspending OTG devices may trigger HNP, if that's been enabled
2908 * between a pair of dual-role devices. That will change roles, such
2909 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2911 * Devices on USB hub ports have only one "suspend" state, corresponding
2912 * to ACPI D2, "may cause the device to lose some context".
2913 * State transitions include:
2915 * - suspend, resume ... when the VBUS power link stays live
2916 * - suspend, disconnect ... VBUS lost
2918 * Once VBUS drop breaks the circuit, the port it's using has to go through
2919 * normal re-enumeration procedures, starting with enabling VBUS power.
2920 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2921 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2922 * timer, no SRP, no requests through sysfs.
2924 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2925 * suspended until their bus goes into global suspend (i.e., the root
2926 * hub is suspended). Nevertheless, we change @udev->state to
2927 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2928 * upstream port setting is stored in @udev->port_is_suspended.
2930 * Returns 0 on success, else negative errno.
2932 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2934 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
2935 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
2936 int port1
= udev
->portnum
;
2938 bool really_suspend
= true;
2940 /* enable remote wakeup when appropriate; this lets the device
2941 * wake up the upstream hub (including maybe the root hub).
2943 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2944 * we don't explicitly enable it here.
2946 if (udev
->do_remote_wakeup
) {
2947 if (!hub_is_superspeed(hub
->hdev
)) {
2948 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2949 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2950 USB_DEVICE_REMOTE_WAKEUP
, 0,
2952 USB_CTRL_SET_TIMEOUT
);
2954 /* Assume there's only one function on the USB 3.0
2955 * device and enable remote wake for the first
2956 * interface. FIXME if the interface association
2957 * descriptor shows there's more than one function.
2959 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2960 USB_REQ_SET_FEATURE
,
2961 USB_RECIP_INTERFACE
,
2962 USB_INTRF_FUNC_SUSPEND
,
2963 USB_INTRF_FUNC_SUSPEND_RW
|
2964 USB_INTRF_FUNC_SUSPEND_LP
,
2966 USB_CTRL_SET_TIMEOUT
);
2969 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2971 /* bail if autosuspend is requested */
2972 if (PMSG_IS_AUTO(msg
))
2977 /* disable USB2 hardware LPM */
2978 if (udev
->usb2_hw_lpm_enabled
== 1)
2979 usb_set_usb2_hardware_lpm(udev
, 0);
2981 if (usb_disable_ltm(udev
)) {
2982 dev_err(&udev
->dev
, "Failed to disable LTM before suspend\n.");
2984 if (PMSG_IS_AUTO(msg
))
2987 if (usb_unlocked_disable_lpm(udev
)) {
2988 dev_err(&udev
->dev
, "Failed to disable LPM before suspend\n.");
2990 if (PMSG_IS_AUTO(msg
))
2995 if (hub_is_superspeed(hub
->hdev
))
2996 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U3
);
2999 * For system suspend, we do not need to enable the suspend feature
3000 * on individual USB-2 ports. The devices will automatically go
3001 * into suspend a few ms after the root hub stops sending packets.
3002 * The USB 2.0 spec calls this "global suspend".
3004 * However, many USB hubs have a bug: They don't relay wakeup requests
3005 * from a downstream port if the port's suspend feature isn't on.
3006 * Therefore we will turn on the suspend feature if udev or any of its
3007 * descendants is enabled for remote wakeup.
3009 else if (PMSG_IS_AUTO(msg
) || wakeup_enabled_descendants(udev
) > 0)
3010 status
= set_port_feature(hub
->hdev
, port1
,
3011 USB_PORT_FEAT_SUSPEND
);
3013 really_suspend
= false;
3017 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
3020 /* Try to enable USB3 LPM and LTM again */
3021 usb_unlocked_enable_lpm(udev
);
3023 usb_enable_ltm(udev
);
3025 /* Try to enable USB2 hardware LPM again */
3026 if (udev
->usb2_hw_lpm_capable
== 1)
3027 usb_set_usb2_hardware_lpm(udev
, 1);
3029 if (udev
->do_remote_wakeup
) {
3030 if (udev
->speed
< USB_SPEED_SUPER
)
3031 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3032 USB_REQ_CLEAR_FEATURE
,
3034 USB_DEVICE_REMOTE_WAKEUP
, 0,
3035 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3037 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3038 USB_REQ_CLEAR_FEATURE
,
3039 USB_RECIP_INTERFACE
,
3040 USB_INTRF_FUNC_SUSPEND
, 0,
3041 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3045 /* System sleep transitions should never fail */
3046 if (!PMSG_IS_AUTO(msg
))
3049 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
3050 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
3051 udev
->do_remote_wakeup
);
3052 if (really_suspend
) {
3053 udev
->port_is_suspended
= 1;
3055 /* device has up to 10 msec to fully suspend */
3058 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
3061 if (status
== 0 && !udev
->do_remote_wakeup
&& udev
->persist_enabled
) {
3062 pm_runtime_put_sync(&port_dev
->dev
);
3063 port_dev
->did_runtime_put
= true;
3066 usb_mark_last_busy(hub
->hdev
);
3071 * If the USB "suspend" state is in use (rather than "global suspend"),
3072 * many devices will be individually taken out of suspend state using
3073 * special "resume" signaling. This routine kicks in shortly after
3074 * hardware resume signaling is finished, either because of selective
3075 * resume (by host) or remote wakeup (by device) ... now see what changed
3076 * in the tree that's rooted at this device.
3078 * If @udev->reset_resume is set then the device is reset before the
3079 * status check is done.
3081 static int finish_port_resume(struct usb_device
*udev
)
3086 /* caller owns the udev device lock */
3087 dev_dbg(&udev
->dev
, "%s\n",
3088 udev
->reset_resume
? "finish reset-resume" : "finish resume");
3090 /* usb ch9 identifies four variants of SUSPENDED, based on what
3091 * state the device resumes to. Linux currently won't see the
3092 * first two on the host side; they'd be inside hub_port_init()
3093 * during many timeouts, but khubd can't suspend until later.
3095 usb_set_device_state(udev
, udev
->actconfig
3096 ? USB_STATE_CONFIGURED
3097 : USB_STATE_ADDRESS
);
3099 /* 10.5.4.5 says not to reset a suspended port if the attached
3100 * device is enabled for remote wakeup. Hence the reset
3101 * operation is carried out here, after the port has been
3104 if (udev
->reset_resume
)
3106 status
= usb_reset_and_verify_device(udev
);
3108 /* 10.5.4.5 says be sure devices in the tree are still there.
3109 * For now let's assume the device didn't go crazy on resume,
3110 * and device drivers will know about any resume quirks.
3114 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
3116 status
= (status
> 0 ? 0 : -ENODEV
);
3118 /* If a normal resume failed, try doing a reset-resume */
3119 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
3120 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
3121 udev
->reset_resume
= 1;
3122 goto retry_reset_resume
;
3127 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
3130 * There are a few quirky devices which violate the standard
3131 * by claiming to have remote wakeup enabled after a reset,
3132 * which crash if the feature is cleared, hence check for
3133 * udev->reset_resume
3135 } else if (udev
->actconfig
&& !udev
->reset_resume
) {
3136 if (!hub_is_superspeed(udev
->parent
)) {
3137 le16_to_cpus(&devstatus
);
3138 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
))
3139 status
= usb_control_msg(udev
,
3140 usb_sndctrlpipe(udev
, 0),
3141 USB_REQ_CLEAR_FEATURE
,
3143 USB_DEVICE_REMOTE_WAKEUP
, 0,
3145 USB_CTRL_SET_TIMEOUT
);
3147 status
= usb_get_status(udev
, USB_RECIP_INTERFACE
, 0,
3149 le16_to_cpus(&devstatus
);
3150 if (!status
&& devstatus
& (USB_INTRF_STAT_FUNC_RW_CAP
3151 | USB_INTRF_STAT_FUNC_RW
))
3153 usb_disable_function_remotewakeup(udev
);
3158 "disable remote wakeup, status %d\n",
3166 * usb_port_resume - re-activate a suspended usb device's upstream port
3167 * @udev: device to re-activate, not a root hub
3168 * Context: must be able to sleep; device not locked; pm locks held
3170 * This will re-activate the suspended device, increasing power usage
3171 * while letting drivers communicate again with its endpoints.
3172 * USB resume explicitly guarantees that the power session between
3173 * the host and the device is the same as it was when the device
3176 * If @udev->reset_resume is set then this routine won't check that the
3177 * port is still enabled. Furthermore, finish_port_resume() above will
3178 * reset @udev. The end result is that a broken power session can be
3179 * recovered and @udev will appear to persist across a loss of VBUS power.
3181 * For example, if a host controller doesn't maintain VBUS suspend current
3182 * during a system sleep or is reset when the system wakes up, all the USB
3183 * power sessions below it will be broken. This is especially troublesome
3184 * for mass-storage devices containing mounted filesystems, since the
3185 * device will appear to have disconnected and all the memory mappings
3186 * to it will be lost. Using the USB_PERSIST facility, the device can be
3187 * made to appear as if it had not disconnected.
3189 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3190 * every effort to insure that the same device is present after the
3191 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3192 * quite possible for a device to remain unaltered but its media to be
3193 * changed. If the user replaces a flash memory card while the system is
3194 * asleep, he will have only himself to blame when the filesystem on the
3195 * new card is corrupted and the system crashes.
3197 * Returns 0 on success, else negative errno.
3199 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3201 struct usb_hub
*hub
= usb_hub_to_struct_hub(udev
->parent
);
3202 struct usb_port
*port_dev
= hub
->ports
[udev
->portnum
- 1];
3203 int port1
= udev
->portnum
;
3205 u16 portchange
, portstatus
;
3207 if (port_dev
->did_runtime_put
) {
3208 status
= pm_runtime_get_sync(&port_dev
->dev
);
3209 port_dev
->did_runtime_put
= false;
3211 dev_dbg(&udev
->dev
, "can't resume usb port, status %d\n",
3217 /* Skip the initial Clear-Suspend step for a remote wakeup */
3218 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3219 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
3220 goto SuspendCleared
;
3222 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3224 set_bit(port1
, hub
->busy_bits
);
3226 /* see 7.1.7.7; affects power usage, but not budgeting */
3227 if (hub_is_superspeed(hub
->hdev
))
3228 status
= hub_set_port_link_state(hub
, port1
, USB_SS_PORT_LS_U0
);
3230 status
= usb_clear_port_feature(hub
->hdev
,
3231 port1
, USB_PORT_FEAT_SUSPEND
);
3233 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
3236 /* drive resume for at least 20 msec */
3237 dev_dbg(&udev
->dev
, "usb %sresume\n",
3238 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
3241 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3242 * stop resume signaling. Then finish the resume
3245 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3247 /* TRSMRCY = 10 msec */
3253 udev
->port_is_suspended
= 0;
3254 if (hub_is_superspeed(hub
->hdev
)) {
3255 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
3256 usb_clear_port_feature(hub
->hdev
, port1
,
3257 USB_PORT_FEAT_C_PORT_LINK_STATE
);
3259 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
3260 usb_clear_port_feature(hub
->hdev
, port1
,
3261 USB_PORT_FEAT_C_SUSPEND
);
3265 clear_bit(port1
, hub
->busy_bits
);
3267 status
= check_port_resume_type(udev
,
3268 hub
, port1
, status
, portchange
, portstatus
);
3270 status
= finish_port_resume(udev
);
3272 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3273 hub_port_logical_disconnect(hub
, port1
);
3275 /* Try to enable USB2 hardware LPM */
3276 if (udev
->usb2_hw_lpm_capable
== 1)
3277 usb_set_usb2_hardware_lpm(udev
, 1);
3279 /* Try to enable USB3 LTM and LPM */
3280 usb_enable_ltm(udev
);
3281 usb_unlocked_enable_lpm(udev
);
3287 #endif /* CONFIG_PM */
3289 #ifdef CONFIG_PM_RUNTIME
3291 /* caller has locked udev */
3292 int usb_remote_wakeup(struct usb_device
*udev
)
3296 if (udev
->state
== USB_STATE_SUSPENDED
) {
3297 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3298 status
= usb_autoresume_device(udev
);
3300 /* Let the drivers do their thing, then... */
3301 usb_autosuspend_device(udev
);
3309 static int check_ports_changed(struct usb_hub
*hub
)
3313 for (port1
= 1; port1
<= hub
->hdev
->maxchild
; ++port1
) {
3314 u16 portstatus
, portchange
;
3317 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3318 if (!status
&& portchange
)
3324 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3326 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3327 struct usb_device
*hdev
= hub
->hdev
;
3332 * Warn if children aren't already suspended.
3333 * Also, add up the number of wakeup-enabled descendants.
3335 hub
->wakeup_enabled_descendants
= 0;
3336 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3337 struct usb_device
*udev
;
3339 udev
= hub
->ports
[port1
- 1]->child
;
3340 if (udev
&& udev
->can_submit
) {
3341 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3342 if (PMSG_IS_AUTO(msg
))
3346 hub
->wakeup_enabled_descendants
+=
3347 wakeup_enabled_descendants(udev
);
3350 if (hdev
->do_remote_wakeup
&& hub
->quirk_check_port_auto_suspend
) {
3351 /* check if there are changes pending on hub ports */
3352 if (check_ports_changed(hub
)) {
3353 if (PMSG_IS_AUTO(msg
))
3355 pm_wakeup_event(&hdev
->dev
, 2000);
3359 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3360 /* Enable hub to send remote wakeup for all ports. */
3361 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3362 status
= set_port_feature(hdev
,
3364 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3365 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3366 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3367 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3371 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3373 /* stop khubd and related activity */
3374 hub_quiesce(hub
, HUB_SUSPEND
);
3378 static int hub_resume(struct usb_interface
*intf
)
3380 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3382 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3383 hub_activate(hub
, HUB_RESUME
);
3387 static int hub_reset_resume(struct usb_interface
*intf
)
3389 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3391 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3392 hub_activate(hub
, HUB_RESET_RESUME
);
3397 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3398 * @rhdev: struct usb_device for the root hub
3400 * The USB host controller driver calls this function when its root hub
3401 * is resumed and Vbus power has been interrupted or the controller
3402 * has been reset. The routine marks @rhdev as having lost power.
3403 * When the hub driver is resumed it will take notice and carry out
3404 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3405 * the others will be disconnected.
3407 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3409 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3410 rhdev
->reset_resume
= 1;
3412 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3414 static const char * const usb3_lpm_names
[] = {
3422 * Send a Set SEL control transfer to the device, prior to enabling
3423 * device-initiated U1 or U2. This lets the device know the exit latencies from
3424 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3425 * packet from the host.
3427 * This function will fail if the SEL or PEL values for udev are greater than
3428 * the maximum allowed values for the link state to be enabled.
3430 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3432 struct usb_set_sel_req
*sel_values
;
3433 unsigned long long u1_sel
;
3434 unsigned long long u1_pel
;
3435 unsigned long long u2_sel
;
3436 unsigned long long u2_pel
;
3439 /* Convert SEL and PEL stored in ns to us */
3440 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3441 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3442 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3443 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3446 * Make sure that the calculated SEL and PEL values for the link
3447 * state we're enabling aren't bigger than the max SEL/PEL
3448 * value that will fit in the SET SEL control transfer.
3449 * Otherwise the device would get an incorrect idea of the exit
3450 * latency for the link state, and could start a device-initiated
3451 * U1/U2 when the exit latencies are too high.
3453 if ((state
== USB3_LPM_U1
&&
3454 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3455 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3456 (state
== USB3_LPM_U2
&&
3457 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3458 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3459 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3460 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3465 * If we're enabling device-initiated LPM for one link state,
3466 * but the other link state has a too high SEL or PEL value,
3467 * just set those values to the max in the Set SEL request.
3469 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3470 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3472 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3473 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3475 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3476 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3478 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3479 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3482 * usb_enable_lpm() can be called as part of a failed device reset,
3483 * which may be initiated by an error path of a mass storage driver.
3484 * Therefore, use GFP_NOIO.
3486 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3490 sel_values
->u1_sel
= u1_sel
;
3491 sel_values
->u1_pel
= u1_pel
;
3492 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3493 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3495 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3499 sel_values
, sizeof *(sel_values
),
3500 USB_CTRL_SET_TIMEOUT
);
3506 * Enable or disable device-initiated U1 or U2 transitions.
3508 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3509 enum usb3_link_state state
, bool enable
)
3516 feature
= USB_DEVICE_U1_ENABLE
;
3519 feature
= USB_DEVICE_U2_ENABLE
;
3522 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3523 __func__
, enable
? "enable" : "disable");
3527 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3528 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3529 "for unconfigured device.\n",
3530 __func__
, enable
? "enable" : "disable",
3531 usb3_lpm_names
[state
]);
3537 * Now send the control transfer to enable device-initiated LPM
3538 * for either U1 or U2.
3540 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3541 USB_REQ_SET_FEATURE
,
3545 USB_CTRL_SET_TIMEOUT
);
3547 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3548 USB_REQ_CLEAR_FEATURE
,
3552 USB_CTRL_SET_TIMEOUT
);
3555 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3556 enable
? "Enable" : "Disable",
3557 usb3_lpm_names
[state
]);
3563 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3564 enum usb3_link_state state
, int timeout
)
3571 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3574 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3577 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3582 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3583 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3584 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3585 "which is a reserved value.\n",
3586 usb3_lpm_names
[state
], timeout
);
3590 ret
= set_port_feature(udev
->parent
,
3591 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3594 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3595 "error code %i\n", usb3_lpm_names
[state
],
3599 if (state
== USB3_LPM_U1
)
3600 udev
->u1_params
.timeout
= timeout
;
3602 udev
->u2_params
.timeout
= timeout
;
3607 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3610 * We will attempt to enable U1 or U2, but there are no guarantees that the
3611 * control transfers to set the hub timeout or enable device-initiated U1/U2
3612 * will be successful.
3614 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3615 * driver know about it. If that call fails, it should be harmless, and just
3616 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3618 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3619 enum usb3_link_state state
)
3622 __u8 u1_mel
= udev
->bos
->ss_cap
->bU1devExitLat
;
3623 __le16 u2_mel
= udev
->bos
->ss_cap
->bU2DevExitLat
;
3625 /* If the device says it doesn't have *any* exit latency to come out of
3626 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3629 if ((state
== USB3_LPM_U1
&& u1_mel
== 0) ||
3630 (state
== USB3_LPM_U2
&& u2_mel
== 0))
3634 * First, let the device know about the exit latencies
3635 * associated with the link state we're about to enable.
3637 ret
= usb_req_set_sel(udev
, state
);
3639 dev_warn(&udev
->dev
, "Set SEL for device-initiated %s failed.\n",
3640 usb3_lpm_names
[state
]);
3644 /* We allow the host controller to set the U1/U2 timeout internally
3645 * first, so that it can change its schedule to account for the
3646 * additional latency to send data to a device in a lower power
3649 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3651 /* xHCI host controller doesn't want to enable this LPM state. */
3656 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3657 "xHCI error %i.\n", usb3_lpm_names
[state
],
3662 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3663 /* If we can't set the parent hub U1/U2 timeout,
3664 * device-initiated LPM won't be allowed either, so let the xHCI
3665 * host know that this link state won't be enabled.
3667 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3669 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3670 else if (udev
->actconfig
)
3671 usb_set_device_initiated_lpm(udev
, state
, true);
3676 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3679 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3680 * If zero is returned, the parent will not allow the link to go into U1/U2.
3682 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3683 * it won't have an effect on the bus link state because the parent hub will
3684 * still disallow device-initiated U1/U2 entry.
3686 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3687 * possible. The result will be slightly more bus bandwidth will be taken up
3688 * (to account for U1/U2 exit latency), but it should be harmless.
3690 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3691 enum usb3_link_state state
)
3697 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3700 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3703 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3708 if (usb_set_lpm_timeout(udev
, state
, 0))
3711 usb_set_device_initiated_lpm(udev
, state
, false);
3713 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3714 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3715 "bus schedule bandwidth may be impacted.\n",
3716 usb3_lpm_names
[state
]);
3721 * Disable hub-initiated and device-initiated U1 and U2 entry.
3722 * Caller must own the bandwidth_mutex.
3724 * This will call usb_enable_lpm() on failure, which will decrement
3725 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3727 int usb_disable_lpm(struct usb_device
*udev
)
3729 struct usb_hcd
*hcd
;
3731 if (!udev
|| !udev
->parent
||
3732 udev
->speed
!= USB_SPEED_SUPER
||
3736 hcd
= bus_to_hcd(udev
->bus
);
3737 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3740 udev
->lpm_disable_count
++;
3741 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3744 /* If LPM is enabled, attempt to disable it. */
3745 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3747 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3753 usb_enable_lpm(udev
);
3756 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3758 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3759 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3761 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3767 mutex_lock(hcd
->bandwidth_mutex
);
3768 ret
= usb_disable_lpm(udev
);
3769 mutex_unlock(hcd
->bandwidth_mutex
);
3773 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3776 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3777 * xHCI host policy may prevent U1 or U2 from being enabled.
3779 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3780 * until the lpm_disable_count drops to zero. Caller must own the
3783 void usb_enable_lpm(struct usb_device
*udev
)
3785 struct usb_hcd
*hcd
;
3787 if (!udev
|| !udev
->parent
||
3788 udev
->speed
!= USB_SPEED_SUPER
||
3792 udev
->lpm_disable_count
--;
3793 hcd
= bus_to_hcd(udev
->bus
);
3794 /* Double check that we can both enable and disable LPM.
3795 * Device must be configured to accept set feature U1/U2 timeout.
3797 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3798 !hcd
->driver
->disable_usb3_lpm_timeout
)
3801 if (udev
->lpm_disable_count
> 0)
3804 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3805 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3807 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3809 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3810 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3812 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3817 mutex_lock(hcd
->bandwidth_mutex
);
3818 usb_enable_lpm(udev
);
3819 mutex_unlock(hcd
->bandwidth_mutex
);
3821 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3824 #else /* CONFIG_PM */
3826 #define hub_suspend NULL
3827 #define hub_resume NULL
3828 #define hub_reset_resume NULL
3830 int usb_disable_lpm(struct usb_device
*udev
)
3834 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3836 void usb_enable_lpm(struct usb_device
*udev
) { }
3837 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3839 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3843 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3845 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3846 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3848 int usb_disable_ltm(struct usb_device
*udev
)
3852 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3854 void usb_enable_ltm(struct usb_device
*udev
) { }
3855 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3859 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3861 * Between connect detection and reset signaling there must be a delay
3862 * of 100ms at least for debounce and power-settling. The corresponding
3863 * timer shall restart whenever the downstream port detects a disconnect.
3865 * Apparently there are some bluetooth and irda-dongles and a number of
3866 * low-speed devices for which this debounce period may last over a second.
3867 * Not covered by the spec - but easy to deal with.
3869 * This implementation uses a 1500ms total debounce timeout; if the
3870 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3871 * every 25ms for transient disconnects. When the port status has been
3872 * unchanged for 100ms it returns the port status.
3874 int hub_port_debounce(struct usb_hub
*hub
, int port1
, bool must_be_connected
)
3877 int total_time
, stable_time
= 0;
3878 u16 portchange
, portstatus
;
3879 unsigned connection
= 0xffff;
3881 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3882 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3886 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3887 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3888 if (!must_be_connected
||
3889 (connection
== USB_PORT_STAT_CONNECTION
))
3890 stable_time
+= HUB_DEBOUNCE_STEP
;
3891 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3895 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3898 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3899 usb_clear_port_feature(hub
->hdev
, port1
,
3900 USB_PORT_FEAT_C_CONNECTION
);
3903 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3905 msleep(HUB_DEBOUNCE_STEP
);
3908 dev_dbg (hub
->intfdev
,
3909 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3910 port1
, total_time
, stable_time
, portstatus
);
3912 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3917 void usb_ep0_reinit(struct usb_device
*udev
)
3919 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3920 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3921 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3923 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3925 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3926 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3928 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3931 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3934 * The host controller will choose the device address,
3935 * instead of the core having chosen it earlier
3937 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3939 if (udev
->state
== USB_STATE_ADDRESS
)
3941 if (udev
->state
!= USB_STATE_DEFAULT
)
3943 if (hcd
->driver
->address_device
)
3944 retval
= hcd
->driver
->address_device(hcd
, udev
);
3946 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3947 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3948 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3950 update_devnum(udev
, devnum
);
3951 /* Device now using proper address. */
3952 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3953 usb_ep0_reinit(udev
);
3958 /* Reset device, (re)assign address, get device descriptor.
3959 * Device connection must be stable, no more debouncing needed.
3960 * Returns device in USB_STATE_ADDRESS, except on error.
3962 * If this is called for an already-existing device (as part of
3963 * usb_reset_and_verify_device), the caller must own the device lock. For a
3964 * newly detected device that is not accessible through any global
3965 * pointers, it's not necessary to lock the device.
3968 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
3971 static DEFINE_MUTEX(usb_address0_mutex
);
3973 struct usb_device
*hdev
= hub
->hdev
;
3974 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3976 unsigned delay
= HUB_SHORT_RESET_TIME
;
3977 enum usb_device_speed oldspeed
= udev
->speed
;
3979 int devnum
= udev
->devnum
;
3981 /* root hub ports have a slightly longer reset period
3982 * (from USB 2.0 spec, section 7.1.7.5)
3984 if (!hdev
->parent
) {
3985 delay
= HUB_ROOT_RESET_TIME
;
3986 if (port1
== hdev
->bus
->otg_port
)
3987 hdev
->bus
->b_hnp_enable
= 0;
3990 /* Some low speed devices have problems with the quick delay, so */
3991 /* be a bit pessimistic with those devices. RHbug #23670 */
3992 if (oldspeed
== USB_SPEED_LOW
)
3993 delay
= HUB_LONG_RESET_TIME
;
3995 mutex_lock(&usb_address0_mutex
);
3997 /* Reset the device; full speed may morph to high speed */
3998 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3999 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4000 if (retval
< 0) /* error or disconnect */
4002 /* success, speed is known */
4006 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
4007 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
4010 oldspeed
= udev
->speed
;
4012 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4013 * it's fixed size except for full speed devices.
4014 * For Wireless USB devices, ep0 max packet is always 512 (tho
4015 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4017 switch (udev
->speed
) {
4018 case USB_SPEED_SUPER
:
4019 case USB_SPEED_WIRELESS
: /* fixed at 512 */
4020 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
4022 case USB_SPEED_HIGH
: /* fixed at 64 */
4023 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4025 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
4026 /* to determine the ep0 maxpacket size, try to read
4027 * the device descriptor to get bMaxPacketSize0 and
4028 * then correct our initial guess.
4030 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
4032 case USB_SPEED_LOW
: /* fixed at 8 */
4033 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
4039 if (udev
->speed
== USB_SPEED_WIRELESS
)
4040 speed
= "variable speed Wireless";
4042 speed
= usb_speed_string(udev
->speed
);
4044 if (udev
->speed
!= USB_SPEED_SUPER
)
4045 dev_info(&udev
->dev
,
4046 "%s %s USB device number %d using %s\n",
4047 (udev
->config
) ? "reset" : "new", speed
,
4048 devnum
, udev
->bus
->controller
->driver
->name
);
4050 /* Set up TT records, if needed */
4052 udev
->tt
= hdev
->tt
;
4053 udev
->ttport
= hdev
->ttport
;
4054 } else if (udev
->speed
!= USB_SPEED_HIGH
4055 && hdev
->speed
== USB_SPEED_HIGH
) {
4057 dev_err(&udev
->dev
, "parent hub has no TT\n");
4061 udev
->tt
= &hub
->tt
;
4062 udev
->ttport
= port1
;
4065 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4066 * Because device hardware and firmware is sometimes buggy in
4067 * this area, and this is how Linux has done it for ages.
4068 * Change it cautiously.
4070 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4071 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4072 * so it may help with some non-standards-compliant devices.
4073 * Otherwise we start with SET_ADDRESS and then try to read the
4074 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4077 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
4078 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
4079 struct usb_device_descriptor
*buf
;
4082 #define GET_DESCRIPTOR_BUFSIZE 64
4083 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
4089 /* Retry on all errors; some devices are flakey.
4090 * 255 is for WUSB devices, we actually need to use
4091 * 512 (WUSB1.0[4.8.1]).
4093 for (j
= 0; j
< 3; ++j
) {
4094 buf
->bMaxPacketSize0
= 0;
4095 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
4096 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
4097 USB_DT_DEVICE
<< 8, 0,
4098 buf
, GET_DESCRIPTOR_BUFSIZE
,
4099 initial_descriptor_timeout
);
4100 switch (buf
->bMaxPacketSize0
) {
4101 case 8: case 16: case 32: case 64: case 255:
4102 if (buf
->bDescriptorType
==
4116 udev
->descriptor
.bMaxPacketSize0
=
4117 buf
->bMaxPacketSize0
;
4120 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
4121 if (retval
< 0) /* error or disconnect */
4123 if (oldspeed
!= udev
->speed
) {
4125 "device reset changed speed!\n");
4131 dev_err(&udev
->dev
, "device descriptor read/64, error %d\n",
4136 #undef GET_DESCRIPTOR_BUFSIZE
4140 * If device is WUSB, we already assigned an
4141 * unauthorized address in the Connect Ack sequence;
4142 * authorization will assign the final address.
4144 if (udev
->wusb
== 0) {
4145 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
4146 retval
= hub_set_address(udev
, devnum
);
4152 if (retval
!= -ENODEV
)
4153 dev_err(&udev
->dev
, "device not accepting address %d, error %d\n",
4157 if (udev
->speed
== USB_SPEED_SUPER
) {
4158 devnum
= udev
->devnum
;
4159 dev_info(&udev
->dev
,
4160 "%s SuperSpeed USB device number %d using %s\n",
4161 (udev
->config
) ? "reset" : "new",
4162 devnum
, udev
->bus
->controller
->driver
->name
);
4165 /* cope with hardware quirkiness:
4166 * - let SET_ADDRESS settle, some device hardware wants it
4167 * - read ep0 maxpacket even for high and low speed,
4170 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
4174 retval
= usb_get_device_descriptor(udev
, 8);
4176 if (retval
!= -ENODEV
)
4178 "device descriptor read/8, error %d\n",
4190 if (hcd
->phy
&& !hdev
->parent
)
4191 usb_phy_notify_connect(hcd
->phy
, udev
->speed
);
4194 * Some superspeed devices have finished the link training process
4195 * and attached to a superspeed hub port, but the device descriptor
4196 * got from those devices show they aren't superspeed devices. Warm
4197 * reset the port attached by the devices can fix them.
4199 if ((udev
->speed
== USB_SPEED_SUPER
) &&
4200 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
4201 dev_err(&udev
->dev
, "got a wrong device descriptor, "
4202 "warm reset device\n");
4203 hub_port_reset(hub
, port1
, udev
,
4204 HUB_BH_RESET_TIME
, true);
4209 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
4210 udev
->speed
== USB_SPEED_SUPER
)
4213 i
= udev
->descriptor
.bMaxPacketSize0
;
4214 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
4215 if (udev
->speed
== USB_SPEED_LOW
||
4216 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
4217 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
4221 if (udev
->speed
== USB_SPEED_FULL
)
4222 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
4224 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
4225 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
4226 usb_ep0_reinit(udev
);
4229 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
4230 if (retval
< (signed)sizeof(udev
->descriptor
)) {
4231 if (retval
!= -ENODEV
)
4232 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
4239 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
4240 retval
= usb_get_bos_descriptor(udev
);
4242 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
4243 usb_set_lpm_parameters(udev
);
4248 /* notify HCD that we have a device connected and addressed */
4249 if (hcd
->driver
->update_device
)
4250 hcd
->driver
->update_device(hcd
, udev
);
4253 hub_port_disable(hub
, port1
, 0);
4254 update_devnum(udev
, devnum
); /* for disconnect processing */
4256 mutex_unlock(&usb_address0_mutex
);
4261 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
4263 struct usb_qualifier_descriptor
*qual
;
4266 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
4270 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
4271 qual
, sizeof *qual
);
4272 if (status
== sizeof *qual
) {
4273 dev_info(&udev
->dev
, "not running at top speed; "
4274 "connect to a high speed hub\n");
4275 /* hub LEDs are probably harder to miss than syslog */
4276 if (hub
->has_indicators
) {
4277 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
4278 schedule_delayed_work (&hub
->leds
, 0);
4285 hub_power_remaining (struct usb_hub
*hub
)
4287 struct usb_device
*hdev
= hub
->hdev
;
4291 if (!hub
->limited_power
)
4294 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
4295 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
4296 struct usb_device
*udev
= hub
->ports
[port1
- 1]->child
;
4302 if (hub_is_superspeed(udev
))
4308 * Unconfigured devices may not use more than one unit load,
4309 * or 8mA for OTG ports
4311 if (udev
->actconfig
)
4312 delta
= usb_get_max_power(udev
, udev
->actconfig
);
4313 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4317 if (delta
> hub
->mA_per_port
)
4318 dev_warn(&udev
->dev
,
4319 "%dmA is over %umA budget for port %d!\n",
4320 delta
, hub
->mA_per_port
, port1
);
4323 if (remaining
< 0) {
4324 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4331 /* Handle physical or logical connection change events.
4332 * This routine is called when:
4333 * a port connection-change occurs;
4334 * a port enable-change occurs (often caused by EMI);
4335 * usb_reset_and_verify_device() encounters changed descriptors (as from
4336 * a firmware download)
4337 * caller already locked the hub
4339 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4340 u16 portstatus
, u16 portchange
)
4342 struct usb_device
*hdev
= hub
->hdev
;
4343 struct device
*hub_dev
= hub
->intfdev
;
4344 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4345 unsigned wHubCharacteristics
=
4346 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4347 struct usb_device
*udev
;
4352 "port %d, status %04x, change %04x, %s\n",
4353 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4355 if (hub
->has_indicators
) {
4356 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4357 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4360 #ifdef CONFIG_USB_OTG
4361 /* during HNP, don't repeat the debounce */
4362 if (hdev
->bus
->is_b_host
)
4363 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4364 USB_PORT_STAT_C_ENABLE
);
4367 /* Try to resuscitate an existing device */
4368 udev
= hub
->ports
[port1
- 1]->child
;
4369 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4370 udev
->state
!= USB_STATE_NOTATTACHED
) {
4371 usb_lock_device(udev
);
4372 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4373 status
= 0; /* Nothing to do */
4375 #ifdef CONFIG_PM_RUNTIME
4376 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4377 udev
->persist_enabled
) {
4378 /* For a suspended device, treat this as a
4379 * remote wakeup event.
4381 status
= usb_remote_wakeup(udev
);
4385 status
= -ENODEV
; /* Don't resuscitate */
4387 usb_unlock_device(udev
);
4390 clear_bit(port1
, hub
->change_bits
);
4395 /* Disconnect any existing devices under this port */
4397 if (hcd
->phy
&& !hdev
->parent
&&
4398 !(portstatus
& USB_PORT_STAT_CONNECTION
))
4399 usb_phy_notify_disconnect(hcd
->phy
, udev
->speed
);
4400 usb_disconnect(&hub
->ports
[port1
- 1]->child
);
4402 clear_bit(port1
, hub
->change_bits
);
4404 /* We can forget about a "removed" device when there's a physical
4405 * disconnect or the connect status changes.
4407 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4408 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4409 clear_bit(port1
, hub
->removed_bits
);
4411 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4412 USB_PORT_STAT_C_ENABLE
)) {
4413 status
= hub_port_debounce_be_stable(hub
, port1
);
4415 if (status
!= -ENODEV
&& printk_ratelimit())
4416 dev_err(hub_dev
, "connect-debounce failed, "
4417 "port %d disabled\n", port1
);
4418 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4420 portstatus
= status
;
4424 /* Return now if debouncing failed or nothing is connected or
4425 * the device was "removed".
4427 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4428 test_bit(port1
, hub
->removed_bits
)) {
4430 /* maybe switch power back on (e.g. root hub was reset) */
4431 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4432 && !port_is_power_on(hub
, portstatus
))
4433 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4435 if (portstatus
& USB_PORT_STAT_ENABLE
)
4439 if (hub_is_superspeed(hub
->hdev
))
4445 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4447 /* reallocate for each attempt, since references
4448 * to the previous one can escape in various ways
4450 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4453 "couldn't allocate port %d usb_device\n",
4458 usb_set_device_state(udev
, USB_STATE_POWERED
);
4459 udev
->bus_mA
= hub
->mA_per_port
;
4460 udev
->level
= hdev
->level
+ 1;
4461 udev
->wusb
= hub_is_wusb(hub
);
4463 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4464 if (hub_is_superspeed(hub
->hdev
))
4465 udev
->speed
= USB_SPEED_SUPER
;
4467 udev
->speed
= USB_SPEED_UNKNOWN
;
4469 choose_devnum(udev
);
4470 if (udev
->devnum
<= 0) {
4471 status
= -ENOTCONN
; /* Don't retry */
4475 /* reset (non-USB 3.0 devices) and get descriptor */
4476 status
= hub_port_init(hub
, udev
, port1
, i
);
4480 usb_detect_quirks(udev
);
4481 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4484 /* consecutive bus-powered hubs aren't reliable; they can
4485 * violate the voltage drop budget. if the new child has
4486 * a "powered" LED, users should notice we didn't enable it
4487 * (without reading syslog), even without per-port LEDs
4490 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4491 && udev
->bus_mA
<= unit_load
) {
4494 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4497 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4500 le16_to_cpus(&devstat
);
4501 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4503 "can't connect bus-powered hub "
4505 if (hub
->has_indicators
) {
4506 hub
->indicator
[port1
-1] =
4507 INDICATOR_AMBER_BLINK
;
4508 schedule_delayed_work (&hub
->leds
, 0);
4510 status
= -ENOTCONN
; /* Don't retry */
4515 /* check for devices running slower than they could */
4516 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4517 && udev
->speed
== USB_SPEED_FULL
4518 && highspeed_hubs
!= 0)
4519 check_highspeed (hub
, udev
, port1
);
4521 /* Store the parent's children[] pointer. At this point
4522 * udev becomes globally accessible, although presumably
4523 * no one will look at it until hdev is unlocked.
4527 /* We mustn't add new devices if the parent hub has
4528 * been disconnected; we would race with the
4529 * recursively_mark_NOTATTACHED() routine.
4531 spin_lock_irq(&device_state_lock
);
4532 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4535 hub
->ports
[port1
- 1]->child
= udev
;
4536 spin_unlock_irq(&device_state_lock
);
4538 /* Run it through the hoops (find a driver, etc) */
4540 status
= usb_new_device(udev
);
4542 spin_lock_irq(&device_state_lock
);
4543 hub
->ports
[port1
- 1]->child
= NULL
;
4544 spin_unlock_irq(&device_state_lock
);
4551 status
= hub_power_remaining(hub
);
4553 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4558 hub_port_disable(hub
, port1
, 1);
4560 usb_ep0_reinit(udev
);
4561 release_devnum(udev
);
4564 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4567 if (hub
->hdev
->parent
||
4568 !hcd
->driver
->port_handed_over
||
4569 !(hcd
->driver
->port_handed_over
)(hcd
, port1
)) {
4570 if (status
!= -ENOTCONN
&& status
!= -ENODEV
)
4571 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4576 hub_port_disable(hub
, port1
, 1);
4577 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4578 hcd
->driver
->relinquish_port(hcd
, port1
);
4581 /* Returns 1 if there was a remote wakeup and a connect status change. */
4582 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4583 u16 portstatus
, u16 portchange
)
4585 struct usb_device
*hdev
;
4586 struct usb_device
*udev
;
4587 int connect_change
= 0;
4591 udev
= hub
->ports
[port
- 1]->child
;
4592 if (!hub_is_superspeed(hdev
)) {
4593 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4595 usb_clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4597 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4598 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4604 /* TRSMRCY = 10 msec */
4607 usb_lock_device(udev
);
4608 ret
= usb_remote_wakeup(udev
);
4609 usb_unlock_device(udev
);
4614 hub_port_disable(hub
, port
, 1);
4616 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4618 return connect_change
;
4621 static void hub_events(void)
4623 struct list_head
*tmp
;
4624 struct usb_device
*hdev
;
4625 struct usb_interface
*intf
;
4626 struct usb_hub
*hub
;
4627 struct device
*hub_dev
;
4633 int connect_change
, wakeup_change
;
4636 * We restart the list every time to avoid a deadlock with
4637 * deleting hubs downstream from this one. This should be
4638 * safe since we delete the hub from the event list.
4639 * Not the most efficient, but avoids deadlocks.
4643 /* Grab the first entry at the beginning of the list */
4644 spin_lock_irq(&hub_event_lock
);
4645 if (list_empty(&hub_event_list
)) {
4646 spin_unlock_irq(&hub_event_lock
);
4650 tmp
= hub_event_list
.next
;
4653 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4654 kref_get(&hub
->kref
);
4655 spin_unlock_irq(&hub_event_lock
);
4658 hub_dev
= hub
->intfdev
;
4659 intf
= to_usb_interface(hub_dev
);
4660 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4661 hdev
->state
, hub
->descriptor
4662 ? hub
->descriptor
->bNbrPorts
4664 /* NOTE: expects max 15 ports... */
4665 (u16
) hub
->change_bits
[0],
4666 (u16
) hub
->event_bits
[0]);
4668 /* Lock the device, then check to see if we were
4669 * disconnected while waiting for the lock to succeed. */
4670 usb_lock_device(hdev
);
4671 if (unlikely(hub
->disconnected
))
4672 goto loop_disconnected
;
4674 /* If the hub has died, clean up after it */
4675 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4676 hub
->error
= -ENODEV
;
4677 hub_quiesce(hub
, HUB_DISCONNECT
);
4682 ret
= usb_autopm_get_interface(intf
);
4684 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4688 /* If this is an inactive hub, do nothing */
4693 dev_dbg (hub_dev
, "resetting for error %d\n",
4696 ret
= usb_reset_device(hdev
);
4699 "error resetting hub: %d\n", ret
);
4707 /* deal with port status changes */
4708 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4709 if (test_bit(i
, hub
->busy_bits
))
4711 connect_change
= test_bit(i
, hub
->change_bits
);
4712 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4713 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4714 !connect_change
&& !wakeup_change
)
4717 ret
= hub_port_status(hub
, i
,
4718 &portstatus
, &portchange
);
4722 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4723 usb_clear_port_feature(hdev
, i
,
4724 USB_PORT_FEAT_C_CONNECTION
);
4728 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4729 if (!connect_change
)
4731 "port %d enable change, "
4734 usb_clear_port_feature(hdev
, i
,
4735 USB_PORT_FEAT_C_ENABLE
);
4738 * EM interference sometimes causes badly
4739 * shielded USB devices to be shutdown by
4740 * the hub, this hack enables them again.
4741 * Works at least with mouse driver.
4743 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4745 && hub
->ports
[i
- 1]->child
) {
4748 "disabled by hub (EMI?), "
4755 if (hub_handle_remote_wakeup(hub
, i
,
4756 portstatus
, portchange
))
4759 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4763 dev_dbg(hub_dev
, "over-current change on port "
4765 usb_clear_port_feature(hdev
, i
,
4766 USB_PORT_FEAT_C_OVER_CURRENT
);
4767 msleep(100); /* Cool down */
4768 hub_power_on(hub
, true);
4769 hub_port_status(hub
, i
, &status
, &unused
);
4770 if (status
& USB_PORT_STAT_OVERCURRENT
)
4771 dev_err(hub_dev
, "over-current "
4772 "condition on port %d\n", i
);
4775 if (portchange
& USB_PORT_STAT_C_RESET
) {
4777 "reset change on port %d\n",
4779 usb_clear_port_feature(hdev
, i
,
4780 USB_PORT_FEAT_C_RESET
);
4782 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4783 hub_is_superspeed(hub
->hdev
)) {
4785 "warm reset change on port %d\n",
4787 usb_clear_port_feature(hdev
, i
,
4788 USB_PORT_FEAT_C_BH_PORT_RESET
);
4790 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4791 usb_clear_port_feature(hub
->hdev
, i
,
4792 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4794 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4796 "config error on port %d\n",
4798 usb_clear_port_feature(hub
->hdev
, i
,
4799 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4802 /* Warm reset a USB3 protocol port if it's in
4803 * SS.Inactive state.
4805 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4807 struct usb_device
*udev
=
4808 hub
->ports
[i
- 1]->child
;
4810 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4812 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4813 udev
->state
== USB_STATE_NOTATTACHED
) {
4814 status
= hub_port_reset(hub
, i
,
4815 NULL
, HUB_BH_RESET_TIME
,
4818 hub_port_disable(hub
, i
, 1);
4820 usb_lock_device(udev
);
4821 status
= usb_reset_device(udev
);
4822 usb_unlock_device(udev
);
4828 hub_port_connect_change(hub
, i
,
4829 portstatus
, portchange
);
4832 /* deal with hub status changes */
4833 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4835 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4836 dev_err (hub_dev
, "get_hub_status failed\n");
4838 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4839 dev_dbg (hub_dev
, "power change\n");
4840 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4841 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4842 /* FIXME: Is this always true? */
4843 hub
->limited_power
= 1;
4845 hub
->limited_power
= 0;
4847 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4851 dev_dbg(hub_dev
, "over-current change\n");
4852 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4853 msleep(500); /* Cool down */
4854 hub_power_on(hub
, true);
4855 hub_hub_status(hub
, &status
, &unused
);
4856 if (status
& HUB_STATUS_OVERCURRENT
)
4857 dev_err(hub_dev
, "over-current "
4863 /* Balance the usb_autopm_get_interface() above */
4864 usb_autopm_put_interface_no_suspend(intf
);
4866 /* Balance the usb_autopm_get_interface_no_resume() in
4867 * kick_khubd() and allow autosuspend.
4869 usb_autopm_put_interface(intf
);
4871 usb_unlock_device(hdev
);
4872 kref_put(&hub
->kref
, hub_release
);
4874 } /* end while (1) */
4877 static int hub_thread(void *__unused
)
4879 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4880 * port handover. Otherwise it might see that a full-speed device
4881 * was gone before the EHCI controller had handed its port over to
4882 * the companion full-speed controller.
4888 wait_event_freezable(khubd_wait
,
4889 !list_empty(&hub_event_list
) ||
4890 kthread_should_stop());
4891 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4893 pr_debug("%s: khubd exiting\n", usbcore_name
);
4897 static const struct usb_device_id hub_id_table
[] = {
4898 { .match_flags
= USB_DEVICE_ID_MATCH_VENDOR
4899 | USB_DEVICE_ID_MATCH_INT_CLASS
,
4900 .idVendor
= USB_VENDOR_GENESYS_LOGIC
,
4901 .bInterfaceClass
= USB_CLASS_HUB
,
4902 .driver_info
= HUB_QUIRK_CHECK_PORT_AUTOSUSPEND
},
4903 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4904 .bDeviceClass
= USB_CLASS_HUB
},
4905 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4906 .bInterfaceClass
= USB_CLASS_HUB
},
4907 { } /* Terminating entry */
4910 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4912 static struct usb_driver hub_driver
= {
4915 .disconnect
= hub_disconnect
,
4916 .suspend
= hub_suspend
,
4917 .resume
= hub_resume
,
4918 .reset_resume
= hub_reset_resume
,
4919 .pre_reset
= hub_pre_reset
,
4920 .post_reset
= hub_post_reset
,
4921 .unlocked_ioctl
= hub_ioctl
,
4922 .id_table
= hub_id_table
,
4923 .supports_autosuspend
= 1,
4926 int usb_hub_init(void)
4928 if (usb_register(&hub_driver
) < 0) {
4929 printk(KERN_ERR
"%s: can't register hub driver\n",
4934 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4935 if (!IS_ERR(khubd_task
))
4938 /* Fall through if kernel_thread failed */
4939 usb_deregister(&hub_driver
);
4940 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4945 void usb_hub_cleanup(void)
4947 kthread_stop(khubd_task
);
4950 * Hub resources are freed for us by usb_deregister. It calls
4951 * usb_driver_purge on every device which in turn calls that
4952 * devices disconnect function if it is using this driver.
4953 * The hub_disconnect function takes care of releasing the
4954 * individual hub resources. -greg
4956 usb_deregister(&hub_driver
);
4957 } /* usb_hub_cleanup() */
4959 static int descriptors_changed(struct usb_device
*udev
,
4960 struct usb_device_descriptor
*old_device_descriptor
)
4964 unsigned serial_len
= 0;
4966 unsigned old_length
;
4970 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4971 sizeof(*old_device_descriptor
)) != 0)
4974 /* Since the idVendor, idProduct, and bcdDevice values in the
4975 * device descriptor haven't changed, we will assume the
4976 * Manufacturer and Product strings haven't changed either.
4977 * But the SerialNumber string could be different (e.g., a
4978 * different flash card of the same brand).
4981 serial_len
= strlen(udev
->serial
) + 1;
4984 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4985 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4986 len
= max(len
, old_length
);
4989 buf
= kmalloc(len
, GFP_NOIO
);
4991 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
4992 /* assume the worst */
4995 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4996 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4997 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
4999 if (length
!= old_length
) {
5000 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
5005 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
5007 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
5009 ((struct usb_config_descriptor
*) buf
)->
5010 bConfigurationValue
);
5016 if (!changed
&& serial_len
) {
5017 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
5019 if (length
+ 1 != serial_len
) {
5020 dev_dbg(&udev
->dev
, "serial string error %d\n",
5023 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
5024 dev_dbg(&udev
->dev
, "serial string changed\n");
5034 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5035 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5037 * WARNING - don't use this routine to reset a composite device
5038 * (one with multiple interfaces owned by separate drivers)!
5039 * Use usb_reset_device() instead.
5041 * Do a port reset, reassign the device's address, and establish its
5042 * former operating configuration. If the reset fails, or the device's
5043 * descriptors change from their values before the reset, or the original
5044 * configuration and altsettings cannot be restored, a flag will be set
5045 * telling khubd to pretend the device has been disconnected and then
5046 * re-connected. All drivers will be unbound, and the device will be
5047 * re-enumerated and probed all over again.
5049 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5050 * flagged for logical disconnection, or some other negative error code
5051 * if the reset wasn't even attempted.
5053 * The caller must own the device lock. For example, it's safe to use
5054 * this from a driver probe() routine after downloading new firmware.
5055 * For calls that might not occur during probe(), drivers should lock
5056 * the device using usb_lock_device_for_reset().
5058 * Locking exception: This routine may also be called from within an
5059 * autoresume handler. Such usage won't conflict with other tasks
5060 * holding the device lock because these tasks should always call
5061 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5063 static int usb_reset_and_verify_device(struct usb_device
*udev
)
5065 struct usb_device
*parent_hdev
= udev
->parent
;
5066 struct usb_hub
*parent_hub
;
5067 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
5068 struct usb_device_descriptor descriptor
= udev
->descriptor
;
5070 int port1
= udev
->portnum
;
5072 if (udev
->state
== USB_STATE_NOTATTACHED
||
5073 udev
->state
== USB_STATE_SUSPENDED
) {
5074 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5080 /* this requires hcd-specific logic; see ohci_restart() */
5081 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
5084 parent_hub
= usb_hub_to_struct_hub(parent_hdev
);
5086 /* Disable LPM and LTM while we reset the device and reinstall the alt
5087 * settings. Device-initiated LPM settings, and system exit latency
5088 * settings are cleared when the device is reset, so we have to set
5091 ret
= usb_unlocked_disable_lpm(udev
);
5093 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
5096 ret
= usb_disable_ltm(udev
);
5098 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
5103 set_bit(port1
, parent_hub
->busy_bits
);
5104 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
5106 /* ep0 maxpacket size may change; let the HCD know about it.
5107 * Other endpoints will be handled by re-enumeration. */
5108 usb_ep0_reinit(udev
);
5109 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
5110 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
5113 clear_bit(port1
, parent_hub
->busy_bits
);
5118 /* Device might have changed firmware (DFU or similar) */
5119 if (descriptors_changed(udev
, &descriptor
)) {
5120 dev_info(&udev
->dev
, "device firmware changed\n");
5121 udev
->descriptor
= descriptor
; /* for disconnect() calls */
5125 /* Restore the device's previous configuration */
5126 if (!udev
->actconfig
)
5129 mutex_lock(hcd
->bandwidth_mutex
);
5130 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
5132 dev_warn(&udev
->dev
,
5133 "Busted HC? Not enough HCD resources for "
5134 "old configuration.\n");
5135 mutex_unlock(hcd
->bandwidth_mutex
);
5138 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
5139 USB_REQ_SET_CONFIGURATION
, 0,
5140 udev
->actconfig
->desc
.bConfigurationValue
, 0,
5141 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
5144 "can't restore configuration #%d (error=%d)\n",
5145 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
5146 mutex_unlock(hcd
->bandwidth_mutex
);
5149 mutex_unlock(hcd
->bandwidth_mutex
);
5150 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
5152 /* Put interfaces back into the same altsettings as before.
5153 * Don't bother to send the Set-Interface request for interfaces
5154 * that were already in altsetting 0; besides being unnecessary,
5155 * many devices can't handle it. Instead just reset the host-side
5158 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
5159 struct usb_host_config
*config
= udev
->actconfig
;
5160 struct usb_interface
*intf
= config
->interface
[i
];
5161 struct usb_interface_descriptor
*desc
;
5163 desc
= &intf
->cur_altsetting
->desc
;
5164 if (desc
->bAlternateSetting
== 0) {
5165 usb_disable_interface(udev
, intf
, true);
5166 usb_enable_interface(udev
, intf
, true);
5169 /* Let the bandwidth allocation function know that this
5170 * device has been reset, and it will have to use
5171 * alternate setting 0 as the current alternate setting.
5173 intf
->resetting_device
= 1;
5174 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
5175 desc
->bAlternateSetting
);
5176 intf
->resetting_device
= 0;
5179 dev_err(&udev
->dev
, "failed to restore interface %d "
5180 "altsetting %d (error=%d)\n",
5181 desc
->bInterfaceNumber
,
5182 desc
->bAlternateSetting
,
5189 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5190 usb_unlocked_enable_lpm(udev
);
5191 usb_enable_ltm(udev
);
5195 /* LPM state doesn't matter when we're about to destroy the device. */
5196 hub_port_logical_disconnect(parent_hub
, port1
);
5201 * usb_reset_device - warn interface drivers and perform a USB port reset
5202 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5204 * Warns all drivers bound to registered interfaces (using their pre_reset
5205 * method), performs the port reset, and then lets the drivers know that
5206 * the reset is over (using their post_reset method).
5208 * Return value is the same as for usb_reset_and_verify_device().
5210 * The caller must own the device lock. For example, it's safe to use
5211 * this from a driver probe() routine after downloading new firmware.
5212 * For calls that might not occur during probe(), drivers should lock
5213 * the device using usb_lock_device_for_reset().
5215 * If an interface is currently being probed or disconnected, we assume
5216 * its driver knows how to handle resets. For all other interfaces,
5217 * if the driver doesn't have pre_reset and post_reset methods then
5218 * we attempt to unbind it and rebind afterward.
5220 int usb_reset_device(struct usb_device
*udev
)
5224 unsigned int noio_flag
;
5225 struct usb_host_config
*config
= udev
->actconfig
;
5227 if (udev
->state
== USB_STATE_NOTATTACHED
||
5228 udev
->state
== USB_STATE_SUSPENDED
) {
5229 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
5235 * Don't allocate memory with GFP_KERNEL in current
5236 * context to avoid possible deadlock if usb mass
5237 * storage interface or usbnet interface(iSCSI case)
5238 * is included in current configuration. The easist
5239 * approach is to do it for every device reset,
5240 * because the device 'memalloc_noio' flag may have
5241 * not been set before reseting the usb device.
5243 noio_flag
= memalloc_noio_save();
5245 /* Prevent autosuspend during the reset */
5246 usb_autoresume_device(udev
);
5249 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
5250 struct usb_interface
*cintf
= config
->interface
[i
];
5251 struct usb_driver
*drv
;
5254 if (cintf
->dev
.driver
) {
5255 drv
= to_usb_driver(cintf
->dev
.driver
);
5256 if (drv
->pre_reset
&& drv
->post_reset
)
5257 unbind
= (drv
->pre_reset
)(cintf
);
5258 else if (cintf
->condition
==
5259 USB_INTERFACE_BOUND
)
5262 usb_forced_unbind_intf(cintf
);
5267 ret
= usb_reset_and_verify_device(udev
);
5270 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
5271 struct usb_interface
*cintf
= config
->interface
[i
];
5272 struct usb_driver
*drv
;
5273 int rebind
= cintf
->needs_binding
;
5275 if (!rebind
&& cintf
->dev
.driver
) {
5276 drv
= to_usb_driver(cintf
->dev
.driver
);
5277 if (drv
->post_reset
)
5278 rebind
= (drv
->post_reset
)(cintf
);
5279 else if (cintf
->condition
==
5280 USB_INTERFACE_BOUND
)
5283 if (ret
== 0 && rebind
)
5284 usb_rebind_intf(cintf
);
5288 usb_autosuspend_device(udev
);
5289 memalloc_noio_restore(noio_flag
);
5292 EXPORT_SYMBOL_GPL(usb_reset_device
);
5296 * usb_queue_reset_device - Reset a USB device from an atomic context
5297 * @iface: USB interface belonging to the device to reset
5299 * This function can be used to reset a USB device from an atomic
5300 * context, where usb_reset_device() won't work (as it blocks).
5302 * Doing a reset via this method is functionally equivalent to calling
5303 * usb_reset_device(), except for the fact that it is delayed to a
5304 * workqueue. This means that any drivers bound to other interfaces
5305 * might be unbound, as well as users from usbfs in user space.
5309 * - Scheduling two resets at the same time from two different drivers
5310 * attached to two different interfaces of the same device is
5311 * possible; depending on how the driver attached to each interface
5312 * handles ->pre_reset(), the second reset might happen or not.
5314 * - If a driver is unbound and it had a pending reset, the reset will
5317 * - This function can be called during .probe() or .disconnect()
5318 * times. On return from .disconnect(), any pending resets will be
5321 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5324 * NOTE: We don't do any reference count tracking because it is not
5325 * needed. The lifecycle of the work_struct is tied to the
5326 * usb_interface. Before destroying the interface we cancel the
5327 * work_struct, so the fact that work_struct is queued and or
5328 * running means the interface (and thus, the device) exist and
5331 void usb_queue_reset_device(struct usb_interface
*iface
)
5333 schedule_work(&iface
->reset_ws
);
5335 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);
5338 * usb_hub_find_child - Get the pointer of child device
5339 * attached to the port which is specified by @port1.
5340 * @hdev: USB device belonging to the usb hub
5341 * @port1: port num to indicate which port the child device
5344 * USB drivers call this function to get hub's child device
5347 * Return NULL if input param is invalid and
5348 * child's usb_device pointer if non-NULL.
5350 struct usb_device
*usb_hub_find_child(struct usb_device
*hdev
,
5353 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5355 if (port1
< 1 || port1
> hdev
->maxchild
)
5357 return hub
->ports
[port1
- 1]->child
;
5359 EXPORT_SYMBOL_GPL(usb_hub_find_child
);
5362 * usb_set_hub_port_connect_type - set hub port connect type.
5363 * @hdev: USB device belonging to the usb hub
5364 * @port1: port num of the port
5365 * @type: connect type of the port
5367 void usb_set_hub_port_connect_type(struct usb_device
*hdev
, int port1
,
5368 enum usb_port_connect_type type
)
5370 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5372 hub
->ports
[port1
- 1]->connect_type
= type
;
5376 * usb_get_hub_port_connect_type - Get the port's connect type
5377 * @hdev: USB device belonging to the usb hub
5378 * @port1: port num of the port
5380 * Return connect type of the port and if input params are
5381 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5383 enum usb_port_connect_type
5384 usb_get_hub_port_connect_type(struct usb_device
*hdev
, int port1
)
5386 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5388 return hub
->ports
[port1
- 1]->connect_type
;
5391 void usb_hub_adjust_deviceremovable(struct usb_device
*hdev
,
5392 struct usb_hub_descriptor
*desc
)
5394 enum usb_port_connect_type connect_type
;
5397 if (!hub_is_superspeed(hdev
)) {
5398 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5399 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5401 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5402 u8 mask
= 1 << (i
%8);
5404 if (!(desc
->u
.hs
.DeviceRemovable
[i
/8] & mask
)) {
5405 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5407 desc
->u
.hs
.DeviceRemovable
[i
/8] |= mask
;
5412 u16 port_removable
= le16_to_cpu(desc
->u
.ss
.DeviceRemovable
);
5414 for (i
= 1; i
<= hdev
->maxchild
; i
++) {
5415 connect_type
= usb_get_hub_port_connect_type(hdev
, i
);
5417 if (connect_type
== USB_PORT_CONNECT_TYPE_HARD_WIRED
) {
5420 if (!(port_removable
& mask
)) {
5421 dev_dbg(&hdev
->dev
, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5423 port_removable
|= mask
;
5428 desc
->u
.ss
.DeviceRemovable
= cpu_to_le16(port_removable
);
5434 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5435 * @hdev: USB device belonging to the usb hub
5436 * @port1: port num of the port
5438 * Return port's acpi handle if successful, NULL if params are
5441 acpi_handle
usb_get_hub_port_acpi_handle(struct usb_device
*hdev
,
5444 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
5446 return DEVICE_ACPI_HANDLE(&hub
->ports
[port1
- 1]->dev
);