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>
29 #include <asm/uaccess.h>
30 #include <asm/byteorder.h>
34 /* if we are in debug mode, always announce new devices */
36 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct device
*intfdev
; /* the "interface" device */
43 struct usb_device
*hdev
;
45 struct urb
*urb
; /* for interrupt polling pipe */
47 /* buffer for urb ... with extra space in case of babble */
50 struct usb_hub_status hub
;
51 struct usb_port_status port
;
52 } *status
; /* buffer for status reports */
53 struct mutex status_mutex
; /* for the status buffer */
55 int error
; /* last reported error */
56 int nerrors
; /* track consecutive errors */
58 struct list_head event_list
; /* hubs w/data or errs ready */
59 unsigned long event_bits
[1]; /* status change bitmask */
60 unsigned long change_bits
[1]; /* ports with logical connect
62 unsigned long busy_bits
[1]; /* ports being reset or
64 unsigned long removed_bits
[1]; /* ports with a "removed"
66 unsigned long wakeup_bits
[1]; /* ports that have signaled
68 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
69 #error event_bits[] is too short!
72 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
73 struct usb_tt tt
; /* Transaction Translator */
75 unsigned mA_per_port
; /* current for each child */
77 unsigned limited_power
:1;
79 unsigned disconnected
:1;
81 unsigned has_indicators
:1;
82 u8 indicator
[USB_MAXCHILDREN
];
83 struct delayed_work leds
;
84 struct delayed_work init_work
;
85 struct dev_state
**port_owners
;
88 static inline int hub_is_superspeed(struct usb_device
*hdev
)
90 return (hdev
->descriptor
.bDeviceProtocol
== USB_HUB_PR_SS
);
93 /* Protect struct usb_device->state and ->children members
94 * Note: Both are also protected by ->dev.sem, except that ->state can
95 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
96 static DEFINE_SPINLOCK(device_state_lock
);
98 /* khubd's worklist and its lock */
99 static DEFINE_SPINLOCK(hub_event_lock
);
100 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
103 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
105 static struct task_struct
*khubd_task
;
107 /* cycle leds on hubs that aren't blinking for attention */
108 static bool blinkenlights
= 0;
109 module_param (blinkenlights
, bool, S_IRUGO
);
110 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
113 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
114 * 10 seconds to send reply for the initial 64-byte descriptor request.
116 /* define initial 64-byte descriptor request timeout in milliseconds */
117 static int initial_descriptor_timeout
= USB_CTRL_GET_TIMEOUT
;
118 module_param(initial_descriptor_timeout
, int, S_IRUGO
|S_IWUSR
);
119 MODULE_PARM_DESC(initial_descriptor_timeout
,
120 "initial 64-byte descriptor request timeout in milliseconds "
121 "(default 5000 - 5.0 seconds)");
124 * As of 2.6.10 we introduce a new USB device initialization scheme which
125 * closely resembles the way Windows works. Hopefully it will be compatible
126 * with a wider range of devices than the old scheme. However some previously
127 * working devices may start giving rise to "device not accepting address"
128 * errors; if that happens the user can try the old scheme by adjusting the
129 * following module parameters.
131 * For maximum flexibility there are two boolean parameters to control the
132 * hub driver's behavior. On the first initialization attempt, if the
133 * "old_scheme_first" parameter is set then the old scheme will be used,
134 * otherwise the new scheme is used. If that fails and "use_both_schemes"
135 * is set, then the driver will make another attempt, using the other scheme.
137 static bool old_scheme_first
= 0;
138 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
139 MODULE_PARM_DESC(old_scheme_first
,
140 "start with the old device initialization scheme");
142 static bool use_both_schemes
= 1;
143 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
144 MODULE_PARM_DESC(use_both_schemes
,
145 "try the other device initialization scheme if the "
148 /* Mutual exclusion for EHCI CF initialization. This interferes with
149 * port reset on some companion controllers.
151 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
152 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
154 #define HUB_DEBOUNCE_TIMEOUT 1500
155 #define HUB_DEBOUNCE_STEP 25
156 #define HUB_DEBOUNCE_STABLE 100
159 static int usb_reset_and_verify_device(struct usb_device
*udev
);
161 static inline char *portspeed(struct usb_hub
*hub
, int portstatus
)
163 if (hub_is_superspeed(hub
->hdev
))
165 if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
167 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
173 /* Note that hdev or one of its children must be locked! */
174 static struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
176 if (!hdev
|| !hdev
->actconfig
)
178 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
181 static int usb_device_supports_lpm(struct usb_device
*udev
)
183 /* USB 2.1 (and greater) devices indicate LPM support through
184 * their USB 2.0 Extended Capabilities BOS descriptor.
186 if (udev
->speed
== USB_SPEED_HIGH
) {
187 if (udev
->bos
->ext_cap
&&
189 le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
)))
194 /* All USB 3.0 must support LPM, but we need their max exit latency
195 * information from the SuperSpeed Extended Capabilities BOS descriptor.
197 if (!udev
->bos
->ss_cap
) {
198 dev_warn(&udev
->dev
, "No LPM exit latency info found. "
199 "Power management will be impacted.\n");
202 if (udev
->parent
->lpm_capable
)
205 dev_warn(&udev
->dev
, "Parent hub missing LPM exit latency info. "
206 "Power management will be impacted.\n");
211 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
214 static void usb_set_lpm_mel(struct usb_device
*udev
,
215 struct usb3_lpm_parameters
*udev_lpm_params
,
216 unsigned int udev_exit_latency
,
218 struct usb3_lpm_parameters
*hub_lpm_params
,
219 unsigned int hub_exit_latency
)
221 unsigned int total_mel
;
222 unsigned int device_mel
;
223 unsigned int hub_mel
;
226 * Calculate the time it takes to transition all links from the roothub
227 * to the parent hub into U0. The parent hub must then decode the
228 * packet (hub header decode latency) to figure out which port it was
231 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
232 * means 0.1us). Multiply that by 100 to get nanoseconds.
234 total_mel
= hub_lpm_params
->mel
+
235 (hub
->descriptor
->u
.ss
.bHubHdrDecLat
* 100);
238 * How long will it take to transition the downstream hub's port into
239 * U0? The greater of either the hub exit latency or the device exit
242 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
243 * Multiply that by 1000 to get nanoseconds.
245 device_mel
= udev_exit_latency
* 1000;
246 hub_mel
= hub_exit_latency
* 1000;
247 if (device_mel
> hub_mel
)
248 total_mel
+= device_mel
;
250 total_mel
+= hub_mel
;
252 udev_lpm_params
->mel
= total_mel
;
256 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
257 * a transition from either U1 or U2.
259 static void usb_set_lpm_pel(struct usb_device
*udev
,
260 struct usb3_lpm_parameters
*udev_lpm_params
,
261 unsigned int udev_exit_latency
,
263 struct usb3_lpm_parameters
*hub_lpm_params
,
264 unsigned int hub_exit_latency
,
265 unsigned int port_to_port_exit_latency
)
267 unsigned int first_link_pel
;
268 unsigned int hub_pel
;
271 * First, the device sends an LFPS to transition the link between the
272 * device and the parent hub into U0. The exit latency is the bigger of
273 * the device exit latency or the hub exit latency.
275 if (udev_exit_latency
> hub_exit_latency
)
276 first_link_pel
= udev_exit_latency
* 1000;
278 first_link_pel
= hub_exit_latency
* 1000;
281 * When the hub starts to receive the LFPS, there is a slight delay for
282 * it to figure out that one of the ports is sending an LFPS. Then it
283 * will forward the LFPS to its upstream link. The exit latency is the
284 * delay, plus the PEL that we calculated for this hub.
286 hub_pel
= port_to_port_exit_latency
* 1000 + hub_lpm_params
->pel
;
289 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
290 * is the greater of the two exit latencies.
292 if (first_link_pel
> hub_pel
)
293 udev_lpm_params
->pel
= first_link_pel
;
295 udev_lpm_params
->pel
= hub_pel
;
299 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
300 * when a device initiates a transition to U0, until when it will receive the
301 * first packet from the host controller.
303 * Section C.1.5.1 describes the four components to this:
305 * - t2: time for the ERDY to make it from the device to the host.
306 * - t3: a host-specific delay to process the ERDY.
307 * - t4: time for the packet to make it from the host to the device.
309 * t3 is specific to both the xHCI host and the platform the host is integrated
310 * into. The Intel HW folks have said it's negligible, FIXME if a different
311 * vendor says otherwise.
313 static void usb_set_lpm_sel(struct usb_device
*udev
,
314 struct usb3_lpm_parameters
*udev_lpm_params
)
316 struct usb_device
*parent
;
317 unsigned int num_hubs
;
318 unsigned int total_sel
;
320 /* t1 = device PEL */
321 total_sel
= udev_lpm_params
->pel
;
322 /* How many external hubs are in between the device & the root port. */
323 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
324 parent
= parent
->parent
)
326 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
328 total_sel
+= 2100 + 250 * (num_hubs
- 1);
330 /* t4 = 250ns * num_hubs */
331 total_sel
+= 250 * num_hubs
;
333 udev_lpm_params
->sel
= total_sel
;
336 static void usb_set_lpm_parameters(struct usb_device
*udev
)
339 unsigned int port_to_port_delay
;
340 unsigned int udev_u1_del
;
341 unsigned int udev_u2_del
;
342 unsigned int hub_u1_del
;
343 unsigned int hub_u2_del
;
345 if (!udev
->lpm_capable
|| udev
->speed
!= USB_SPEED_SUPER
)
348 hub
= hdev_to_hub(udev
->parent
);
349 /* It doesn't take time to transition the roothub into U0, since it
350 * doesn't have an upstream link.
355 udev_u1_del
= udev
->bos
->ss_cap
->bU1devExitLat
;
356 udev_u2_del
= udev
->bos
->ss_cap
->bU2DevExitLat
;
357 hub_u1_del
= udev
->parent
->bos
->ss_cap
->bU1devExitLat
;
358 hub_u2_del
= udev
->parent
->bos
->ss_cap
->bU2DevExitLat
;
360 usb_set_lpm_mel(udev
, &udev
->u1_params
, udev_u1_del
,
361 hub
, &udev
->parent
->u1_params
, hub_u1_del
);
363 usb_set_lpm_mel(udev
, &udev
->u2_params
, udev_u2_del
,
364 hub
, &udev
->parent
->u2_params
, hub_u2_del
);
367 * Appendix C, section C.2.2.2, says that there is a slight delay from
368 * when the parent hub notices the downstream port is trying to
369 * transition to U0 to when the hub initiates a U0 transition on its
370 * upstream port. The section says the delays are tPort2PortU1EL and
371 * tPort2PortU2EL, but it doesn't define what they are.
373 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
374 * about the same delays. Use the maximum delay calculations from those
375 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
376 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
377 * assume the device exit latencies they are talking about are the hub
380 * What do we do if the U2 exit latency is less than the U1 exit
381 * latency? It's possible, although not likely...
383 port_to_port_delay
= 1;
385 usb_set_lpm_pel(udev
, &udev
->u1_params
, udev_u1_del
,
386 hub
, &udev
->parent
->u1_params
, hub_u1_del
,
389 if (hub_u2_del
> hub_u1_del
)
390 port_to_port_delay
= 1 + hub_u2_del
- hub_u1_del
;
392 port_to_port_delay
= 1 + hub_u1_del
;
394 usb_set_lpm_pel(udev
, &udev
->u2_params
, udev_u2_del
,
395 hub
, &udev
->parent
->u2_params
, hub_u2_del
,
398 /* Now that we've got PEL, calculate SEL. */
399 usb_set_lpm_sel(udev
, &udev
->u1_params
);
400 usb_set_lpm_sel(udev
, &udev
->u2_params
);
403 /* USB 2.0 spec Section 11.24.4.5 */
404 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
)
409 if (hub_is_superspeed(hdev
)) {
410 dtype
= USB_DT_SS_HUB
;
411 size
= USB_DT_SS_HUB_SIZE
;
414 size
= sizeof(struct usb_hub_descriptor
);
417 for (i
= 0; i
< 3; i
++) {
418 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
419 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
420 dtype
<< 8, 0, data
, size
,
421 USB_CTRL_GET_TIMEOUT
);
422 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
429 * USB 2.0 spec Section 11.24.2.1
431 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
433 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
434 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
438 * USB 2.0 spec Section 11.24.2.2
440 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
442 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
443 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
448 * USB 2.0 spec Section 11.24.2.13
450 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
452 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
453 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
458 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
459 * for info about using port indicators
461 static void set_port_led(
467 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
468 USB_PORT_FEAT_INDICATOR
);
470 dev_dbg (hub
->intfdev
,
471 "port %d indicator %s status %d\n",
473 ({ char *s
; switch (selector
) {
474 case HUB_LED_AMBER
: s
= "amber"; break;
475 case HUB_LED_GREEN
: s
= "green"; break;
476 case HUB_LED_OFF
: s
= "off"; break;
477 case HUB_LED_AUTO
: s
= "auto"; break;
478 default: s
= "??"; break;
483 #define LED_CYCLE_PERIOD ((2*HZ)/3)
485 static void led_work (struct work_struct
*work
)
487 struct usb_hub
*hub
=
488 container_of(work
, struct usb_hub
, leds
.work
);
489 struct usb_device
*hdev
= hub
->hdev
;
491 unsigned changed
= 0;
494 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
497 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
498 unsigned selector
, mode
;
500 /* 30%-50% duty cycle */
502 switch (hub
->indicator
[i
]) {
504 case INDICATOR_CYCLE
:
506 selector
= HUB_LED_AUTO
;
507 mode
= INDICATOR_AUTO
;
509 /* blinking green = sw attention */
510 case INDICATOR_GREEN_BLINK
:
511 selector
= HUB_LED_GREEN
;
512 mode
= INDICATOR_GREEN_BLINK_OFF
;
514 case INDICATOR_GREEN_BLINK_OFF
:
515 selector
= HUB_LED_OFF
;
516 mode
= INDICATOR_GREEN_BLINK
;
518 /* blinking amber = hw attention */
519 case INDICATOR_AMBER_BLINK
:
520 selector
= HUB_LED_AMBER
;
521 mode
= INDICATOR_AMBER_BLINK_OFF
;
523 case INDICATOR_AMBER_BLINK_OFF
:
524 selector
= HUB_LED_OFF
;
525 mode
= INDICATOR_AMBER_BLINK
;
527 /* blink green/amber = reserved */
528 case INDICATOR_ALT_BLINK
:
529 selector
= HUB_LED_GREEN
;
530 mode
= INDICATOR_ALT_BLINK_OFF
;
532 case INDICATOR_ALT_BLINK_OFF
:
533 selector
= HUB_LED_AMBER
;
534 mode
= INDICATOR_ALT_BLINK
;
539 if (selector
!= HUB_LED_AUTO
)
541 set_port_led(hub
, i
+ 1, selector
);
542 hub
->indicator
[i
] = mode
;
544 if (!changed
&& blinkenlights
) {
546 cursor
%= hub
->descriptor
->bNbrPorts
;
547 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
548 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
552 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
555 /* use a short timeout for hub/port status fetches */
556 #define USB_STS_TIMEOUT 1000
557 #define USB_STS_RETRIES 5
560 * USB 2.0 spec Section 11.24.2.6
562 static int get_hub_status(struct usb_device
*hdev
,
563 struct usb_hub_status
*data
)
565 int i
, status
= -ETIMEDOUT
;
567 for (i
= 0; i
< USB_STS_RETRIES
&&
568 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
569 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
570 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
571 data
, sizeof(*data
), USB_STS_TIMEOUT
);
577 * USB 2.0 spec Section 11.24.2.7
579 static int get_port_status(struct usb_device
*hdev
, int port1
,
580 struct usb_port_status
*data
)
582 int i
, status
= -ETIMEDOUT
;
584 for (i
= 0; i
< USB_STS_RETRIES
&&
585 (status
== -ETIMEDOUT
|| status
== -EPIPE
); i
++) {
586 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
587 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
588 data
, sizeof(*data
), USB_STS_TIMEOUT
);
593 static int hub_port_status(struct usb_hub
*hub
, int port1
,
594 u16
*status
, u16
*change
)
598 mutex_lock(&hub
->status_mutex
);
599 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
601 dev_err(hub
->intfdev
,
602 "%s failed (err = %d)\n", __func__
, ret
);
606 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
607 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
611 mutex_unlock(&hub
->status_mutex
);
615 static void kick_khubd(struct usb_hub
*hub
)
619 spin_lock_irqsave(&hub_event_lock
, flags
);
620 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
621 list_add_tail(&hub
->event_list
, &hub_event_list
);
623 /* Suppress autosuspend until khubd runs */
624 usb_autopm_get_interface_no_resume(
625 to_usb_interface(hub
->intfdev
));
626 wake_up(&khubd_wait
);
628 spin_unlock_irqrestore(&hub_event_lock
, flags
);
631 void usb_kick_khubd(struct usb_device
*hdev
)
633 struct usb_hub
*hub
= hdev_to_hub(hdev
);
640 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
641 * Notification, which indicates it had initiated remote wakeup.
643 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
644 * device initiates resume, so the USB core will not receive notice of the
645 * resume through the normal hub interrupt URB.
647 void usb_wakeup_notification(struct usb_device
*hdev
,
648 unsigned int portnum
)
655 hub
= hdev_to_hub(hdev
);
657 set_bit(portnum
, hub
->wakeup_bits
);
661 EXPORT_SYMBOL_GPL(usb_wakeup_notification
);
663 /* completion function, fires on port status changes and various faults */
664 static void hub_irq(struct urb
*urb
)
666 struct usb_hub
*hub
= urb
->context
;
667 int status
= urb
->status
;
672 case -ENOENT
: /* synchronous unlink */
673 case -ECONNRESET
: /* async unlink */
674 case -ESHUTDOWN
: /* hardware going away */
677 default: /* presumably an error */
678 /* Cause a hub reset after 10 consecutive errors */
679 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
680 if ((++hub
->nerrors
< 10) || hub
->error
)
685 /* let khubd handle things */
686 case 0: /* we got data: port status changed */
688 for (i
= 0; i
< urb
->actual_length
; ++i
)
689 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
691 hub
->event_bits
[0] = bits
;
697 /* Something happened, let khubd figure it out */
704 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
705 && status
!= -ENODEV
&& status
!= -EPERM
)
706 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
709 /* USB 2.0 spec Section 11.24.2.3 */
711 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
713 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
714 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
719 * enumeration blocks khubd for a long time. we use keventd instead, since
720 * long blocking there is the exception, not the rule. accordingly, HCDs
721 * talking to TTs must queue control transfers (not just bulk and iso), so
722 * both can talk to the same hub concurrently.
724 static void hub_tt_work(struct work_struct
*work
)
726 struct usb_hub
*hub
=
727 container_of(work
, struct usb_hub
, tt
.clear_work
);
731 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
732 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
733 struct list_head
*next
;
734 struct usb_tt_clear
*clear
;
735 struct usb_device
*hdev
= hub
->hdev
;
736 const struct hc_driver
*drv
;
739 next
= hub
->tt
.clear_list
.next
;
740 clear
= list_entry (next
, struct usb_tt_clear
, clear_list
);
741 list_del (&clear
->clear_list
);
743 /* drop lock so HCD can concurrently report other TT errors */
744 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
745 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
748 "clear tt %d (%04x) error %d\n",
749 clear
->tt
, clear
->devinfo
, status
);
751 /* Tell the HCD, even if the operation failed */
752 drv
= clear
->hcd
->driver
;
753 if (drv
->clear_tt_buffer_complete
)
754 (drv
->clear_tt_buffer_complete
)(clear
->hcd
, clear
->ep
);
757 spin_lock_irqsave(&hub
->tt
.lock
, flags
);
759 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
763 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
764 * @urb: an URB associated with the failed or incomplete split transaction
766 * High speed HCDs use this to tell the hub driver that some split control or
767 * bulk transaction failed in a way that requires clearing internal state of
768 * a transaction translator. This is normally detected (and reported) from
771 * It may not be possible for that hub to handle additional full (or low)
772 * speed transactions until that state is fully cleared out.
774 int usb_hub_clear_tt_buffer(struct urb
*urb
)
776 struct usb_device
*udev
= urb
->dev
;
777 int pipe
= urb
->pipe
;
778 struct usb_tt
*tt
= udev
->tt
;
780 struct usb_tt_clear
*clear
;
782 /* we've got to cope with an arbitrary number of pending TT clears,
783 * since each TT has "at least two" buffers that can need it (and
784 * there can be many TTs per hub). even if they're uncommon.
786 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
787 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
788 /* FIXME recover somehow ... RESET_TT? */
792 /* info that CLEAR_TT_BUFFER needs */
793 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
794 clear
->devinfo
= usb_pipeendpoint (pipe
);
795 clear
->devinfo
|= udev
->devnum
<< 4;
796 clear
->devinfo
|= usb_pipecontrol (pipe
)
797 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
798 : (USB_ENDPOINT_XFER_BULK
<< 11);
799 if (usb_pipein (pipe
))
800 clear
->devinfo
|= 1 << 15;
802 /* info for completion callback */
803 clear
->hcd
= bus_to_hcd(udev
->bus
);
806 /* tell keventd to clear state for this TT */
807 spin_lock_irqsave (&tt
->lock
, flags
);
808 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
809 schedule_work(&tt
->clear_work
);
810 spin_unlock_irqrestore (&tt
->lock
, flags
);
813 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer
);
815 /* If do_delay is false, return the number of milliseconds the caller
818 static unsigned hub_power_on(struct usb_hub
*hub
, bool do_delay
)
821 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
823 u16 wHubCharacteristics
=
824 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
826 /* Enable power on each port. Some hubs have reserved values
827 * of LPSM (> 2) in their descriptors, even though they are
828 * USB 2.0 hubs. Some hubs do not implement port-power switching
829 * but only emulate it. In all cases, the ports won't work
830 * unless we send these messages to the hub.
832 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
833 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
835 dev_dbg(hub
->intfdev
, "trying to enable port power on "
836 "non-switchable hub\n");
837 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
838 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
840 /* Wait at least 100 msec for power to become stable */
841 delay
= max(pgood_delay
, (unsigned) 100);
847 static int hub_hub_status(struct usb_hub
*hub
,
848 u16
*status
, u16
*change
)
852 mutex_lock(&hub
->status_mutex
);
853 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
855 dev_err (hub
->intfdev
,
856 "%s failed (err = %d)\n", __func__
, ret
);
858 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
859 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
862 mutex_unlock(&hub
->status_mutex
);
866 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
868 struct usb_device
*hdev
= hub
->hdev
;
871 if (hdev
->children
[port1
-1] && set_state
)
872 usb_set_device_state(hdev
->children
[port1
-1],
873 USB_STATE_NOTATTACHED
);
874 if (!hub
->error
&& !hub_is_superspeed(hub
->hdev
))
875 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
877 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
883 * Disable a port and mark a logical connect-change event, so that some
884 * time later khubd will disconnect() any existing usb_device on the port
885 * and will re-enumerate if there actually is a device attached.
887 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
889 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
890 hub_port_disable(hub
, port1
, 1);
892 /* FIXME let caller ask to power down the port:
893 * - some devices won't enumerate without a VBUS power cycle
894 * - SRP saves power that way
895 * - ... new call, TBD ...
896 * That's easy if this hub can switch power per-port, and
897 * khubd reactivates the port later (timer, SRP, etc).
898 * Powerdown must be optional, because of reset/DFU.
901 set_bit(port1
, hub
->change_bits
);
906 * usb_remove_device - disable a device's port on its parent hub
907 * @udev: device to be disabled and removed
908 * Context: @udev locked, must be able to sleep.
910 * After @udev's port has been disabled, khubd is notified and it will
911 * see that the device has been disconnected. When the device is
912 * physically unplugged and something is plugged in, the events will
913 * be received and processed normally.
915 int usb_remove_device(struct usb_device
*udev
)
918 struct usb_interface
*intf
;
920 if (!udev
->parent
) /* Can't remove a root hub */
922 hub
= hdev_to_hub(udev
->parent
);
923 intf
= to_usb_interface(hub
->intfdev
);
925 usb_autopm_get_interface(intf
);
926 set_bit(udev
->portnum
, hub
->removed_bits
);
927 hub_port_logical_disconnect(hub
, udev
->portnum
);
928 usb_autopm_put_interface(intf
);
932 enum hub_activation_type
{
933 HUB_INIT
, HUB_INIT2
, HUB_INIT3
, /* INITs must come first */
934 HUB_POST_RESET
, HUB_RESUME
, HUB_RESET_RESUME
,
937 static void hub_init_func2(struct work_struct
*ws
);
938 static void hub_init_func3(struct work_struct
*ws
);
940 static void hub_activate(struct usb_hub
*hub
, enum hub_activation_type type
)
942 struct usb_device
*hdev
= hub
->hdev
;
947 bool need_debounce_delay
= false;
950 /* Continue a partial initialization */
951 if (type
== HUB_INIT2
)
953 if (type
== HUB_INIT3
)
956 /* The superspeed hub except for root hub has to use Hub Depth
957 * value as an offset into the route string to locate the bits
958 * it uses to determine the downstream port number. So hub driver
959 * should send a set hub depth request to superspeed hub after
960 * the superspeed hub is set configuration in initialization or
963 * After a resume, port power should still be on.
964 * For any other type of activation, turn it on.
966 if (type
!= HUB_RESUME
) {
967 if (hdev
->parent
&& hub_is_superspeed(hdev
)) {
968 ret
= usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
969 HUB_SET_DEPTH
, USB_RT_HUB
,
970 hdev
->level
- 1, 0, NULL
, 0,
971 USB_CTRL_SET_TIMEOUT
);
973 dev_err(hub
->intfdev
,
974 "set hub depth failed\n");
977 /* Speed up system boot by using a delayed_work for the
978 * hub's initial power-up delays. This is pretty awkward
979 * and the implementation looks like a home-brewed sort of
980 * setjmp/longjmp, but it saves at least 100 ms for each
981 * root hub (assuming usbcore is compiled into the kernel
982 * rather than as a module). It adds up.
984 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
985 * because for those activation types the ports have to be
986 * operational when we return. In theory this could be done
987 * for HUB_POST_RESET, but it's easier not to.
989 if (type
== HUB_INIT
) {
990 delay
= hub_power_on(hub
, false);
991 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func2
);
992 schedule_delayed_work(&hub
->init_work
,
993 msecs_to_jiffies(delay
));
995 /* Suppress autosuspend until init is done */
996 usb_autopm_get_interface_no_resume(
997 to_usb_interface(hub
->intfdev
));
998 return; /* Continues at init2: below */
999 } else if (type
== HUB_RESET_RESUME
) {
1000 /* The internal host controller state for the hub device
1001 * may be gone after a host power loss on system resume.
1002 * Update the device's info so the HW knows it's a hub.
1004 hcd
= bus_to_hcd(hdev
->bus
);
1005 if (hcd
->driver
->update_hub_device
) {
1006 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1007 &hub
->tt
, GFP_NOIO
);
1009 dev_err(hub
->intfdev
, "Host not "
1010 "accepting hub info "
1012 dev_err(hub
->intfdev
, "LS/FS devices "
1013 "and hubs may not work "
1014 "under this hub\n.");
1017 hub_power_on(hub
, true);
1019 hub_power_on(hub
, true);
1024 /* Check each port and set hub->change_bits to let khubd know
1025 * which ports need attention.
1027 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
1028 struct usb_device
*udev
= hdev
->children
[port1
-1];
1029 u16 portstatus
, portchange
;
1031 portstatus
= portchange
= 0;
1032 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1033 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1034 dev_dbg(hub
->intfdev
,
1035 "port %d: status %04x change %04x\n",
1036 port1
, portstatus
, portchange
);
1038 /* After anything other than HUB_RESUME (i.e., initialization
1039 * or any sort of reset), every port should be disabled.
1040 * Unconnected ports should likewise be disabled (paranoia),
1041 * and so should ports for which we have no usb_device.
1043 if ((portstatus
& USB_PORT_STAT_ENABLE
) && (
1044 type
!= HUB_RESUME
||
1045 !(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1047 udev
->state
== USB_STATE_NOTATTACHED
)) {
1049 * USB3 protocol ports will automatically transition
1050 * to Enabled state when detect an USB3.0 device attach.
1051 * Do not disable USB3 protocol ports.
1053 if (!hub_is_superspeed(hdev
)) {
1054 clear_port_feature(hdev
, port1
,
1055 USB_PORT_FEAT_ENABLE
);
1056 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1058 /* Pretend that power was lost for USB3 devs */
1059 portstatus
&= ~USB_PORT_STAT_ENABLE
;
1063 /* Clear status-change flags; we'll debounce later */
1064 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
1065 need_debounce_delay
= true;
1066 clear_port_feature(hub
->hdev
, port1
,
1067 USB_PORT_FEAT_C_CONNECTION
);
1069 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
1070 need_debounce_delay
= true;
1071 clear_port_feature(hub
->hdev
, port1
,
1072 USB_PORT_FEAT_C_ENABLE
);
1074 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
1075 hub_is_superspeed(hub
->hdev
)) {
1076 need_debounce_delay
= true;
1077 clear_port_feature(hub
->hdev
, port1
,
1078 USB_PORT_FEAT_C_BH_PORT_RESET
);
1080 /* We can forget about a "removed" device when there's a
1081 * physical disconnect or the connect status changes.
1083 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
1084 (portchange
& USB_PORT_STAT_C_CONNECTION
))
1085 clear_bit(port1
, hub
->removed_bits
);
1087 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
1088 /* Tell khubd to disconnect the device or
1089 * check for a new connection
1091 if (udev
|| (portstatus
& USB_PORT_STAT_CONNECTION
))
1092 set_bit(port1
, hub
->change_bits
);
1094 } else if (portstatus
& USB_PORT_STAT_ENABLE
) {
1095 bool port_resumed
= (portstatus
&
1096 USB_PORT_STAT_LINK_STATE
) ==
1098 /* The power session apparently survived the resume.
1099 * If there was an overcurrent or suspend change
1100 * (i.e., remote wakeup request), have khubd
1101 * take care of it. Look at the port link state
1102 * for USB 3.0 hubs, since they don't have a suspend
1103 * change bit, and they don't set the port link change
1104 * bit on device-initiated resume.
1106 if (portchange
|| (hub_is_superspeed(hub
->hdev
) &&
1108 set_bit(port1
, hub
->change_bits
);
1110 } else if (udev
->persist_enabled
) {
1112 udev
->reset_resume
= 1;
1114 set_bit(port1
, hub
->change_bits
);
1117 /* The power session is gone; tell khubd */
1118 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1119 set_bit(port1
, hub
->change_bits
);
1123 /* If no port-status-change flags were set, we don't need any
1124 * debouncing. If flags were set we can try to debounce the
1125 * ports all at once right now, instead of letting khubd do them
1126 * one at a time later on.
1128 * If any port-status changes do occur during this delay, khubd
1129 * will see them later and handle them normally.
1131 if (need_debounce_delay
) {
1132 delay
= HUB_DEBOUNCE_STABLE
;
1134 /* Don't do a long sleep inside a workqueue routine */
1135 if (type
== HUB_INIT2
) {
1136 PREPARE_DELAYED_WORK(&hub
->init_work
, hub_init_func3
);
1137 schedule_delayed_work(&hub
->init_work
,
1138 msecs_to_jiffies(delay
));
1139 return; /* Continues at init3: below */
1147 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
1149 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
1150 if (hub
->has_indicators
&& blinkenlights
)
1151 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
1153 /* Scan all ports that need attention */
1156 /* Allow autosuspend if it was suppressed */
1157 if (type
<= HUB_INIT3
)
1158 usb_autopm_put_interface_async(to_usb_interface(hub
->intfdev
));
1161 /* Implement the continuations for the delays above */
1162 static void hub_init_func2(struct work_struct
*ws
)
1164 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1166 hub_activate(hub
, HUB_INIT2
);
1169 static void hub_init_func3(struct work_struct
*ws
)
1171 struct usb_hub
*hub
= container_of(ws
, struct usb_hub
, init_work
.work
);
1173 hub_activate(hub
, HUB_INIT3
);
1176 enum hub_quiescing_type
{
1177 HUB_DISCONNECT
, HUB_PRE_RESET
, HUB_SUSPEND
1180 static void hub_quiesce(struct usb_hub
*hub
, enum hub_quiescing_type type
)
1182 struct usb_device
*hdev
= hub
->hdev
;
1185 cancel_delayed_work_sync(&hub
->init_work
);
1187 /* khubd and related activity won't re-trigger */
1190 if (type
!= HUB_SUSPEND
) {
1191 /* Disconnect all the children */
1192 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
1193 if (hdev
->children
[i
])
1194 usb_disconnect(&hdev
->children
[i
]);
1198 /* Stop khubd and related activity */
1199 usb_kill_urb(hub
->urb
);
1200 if (hub
->has_indicators
)
1201 cancel_delayed_work_sync(&hub
->leds
);
1203 cancel_work_sync(&hub
->tt
.clear_work
);
1206 /* caller has locked the hub device */
1207 static int hub_pre_reset(struct usb_interface
*intf
)
1209 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1211 hub_quiesce(hub
, HUB_PRE_RESET
);
1215 /* caller has locked the hub device */
1216 static int hub_post_reset(struct usb_interface
*intf
)
1218 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1220 hub_activate(hub
, HUB_POST_RESET
);
1224 static int hub_configure(struct usb_hub
*hub
,
1225 struct usb_endpoint_descriptor
*endpoint
)
1227 struct usb_hcd
*hcd
;
1228 struct usb_device
*hdev
= hub
->hdev
;
1229 struct device
*hub_dev
= hub
->intfdev
;
1230 u16 hubstatus
, hubchange
;
1231 u16 wHubCharacteristics
;
1234 char *message
= "out of memory";
1236 hub
->buffer
= kmalloc(sizeof(*hub
->buffer
), GFP_KERNEL
);
1242 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
1247 mutex_init(&hub
->status_mutex
);
1249 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
1250 if (!hub
->descriptor
) {
1255 /* Request the entire hub descriptor.
1256 * hub->descriptor can handle USB_MAXCHILDREN ports,
1257 * but the hub can/will return fewer bytes here.
1259 ret
= get_hub_descriptor(hdev
, hub
->descriptor
);
1261 message
= "can't read hub descriptor";
1263 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
1264 message
= "hub has too many ports!";
1269 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
1270 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
1271 (hdev
->maxchild
== 1) ? "" : "s");
1273 hdev
->children
= kzalloc(hdev
->maxchild
*
1274 sizeof(struct usb_device
*), GFP_KERNEL
);
1275 hub
->port_owners
= kzalloc(hdev
->maxchild
* sizeof(struct dev_state
*),
1277 if (!hdev
->children
|| !hub
->port_owners
) {
1282 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
1284 /* FIXME for USB 3.0, skip for now */
1285 if ((wHubCharacteristics
& HUB_CHAR_COMPOUND
) &&
1286 !(hub_is_superspeed(hdev
))) {
1288 char portstr
[USB_MAXCHILDREN
+ 1];
1290 for (i
= 0; i
< hdev
->maxchild
; i
++)
1291 portstr
[i
] = hub
->descriptor
->u
.hs
.DeviceRemovable
1292 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
1294 portstr
[hdev
->maxchild
] = 0;
1295 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
1297 dev_dbg(hub_dev
, "standalone hub\n");
1299 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
1300 case HUB_CHAR_COMMON_LPSM
:
1301 dev_dbg(hub_dev
, "ganged power switching\n");
1303 case HUB_CHAR_INDV_PORT_LPSM
:
1304 dev_dbg(hub_dev
, "individual port power switching\n");
1306 case HUB_CHAR_NO_LPSM
:
1308 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
1312 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
1313 case HUB_CHAR_COMMON_OCPM
:
1314 dev_dbg(hub_dev
, "global over-current protection\n");
1316 case HUB_CHAR_INDV_PORT_OCPM
:
1317 dev_dbg(hub_dev
, "individual port over-current protection\n");
1319 case HUB_CHAR_NO_OCPM
:
1321 dev_dbg(hub_dev
, "no over-current protection\n");
1325 spin_lock_init (&hub
->tt
.lock
);
1326 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
1327 INIT_WORK(&hub
->tt
.clear_work
, hub_tt_work
);
1328 switch (hdev
->descriptor
.bDeviceProtocol
) {
1331 case USB_HUB_PR_HS_SINGLE_TT
:
1332 dev_dbg(hub_dev
, "Single TT\n");
1335 case USB_HUB_PR_HS_MULTI_TT
:
1336 ret
= usb_set_interface(hdev
, 0, 1);
1338 dev_dbg(hub_dev
, "TT per port\n");
1341 dev_err(hub_dev
, "Using single TT (err %d)\n",
1346 /* USB 3.0 hubs don't have a TT */
1349 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
1350 hdev
->descriptor
.bDeviceProtocol
);
1354 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1355 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
1356 case HUB_TTTT_8_BITS
:
1357 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
1358 hub
->tt
.think_time
= 666;
1359 dev_dbg(hub_dev
, "TT requires at most %d "
1360 "FS bit times (%d ns)\n",
1361 8, hub
->tt
.think_time
);
1364 case HUB_TTTT_16_BITS
:
1365 hub
->tt
.think_time
= 666 * 2;
1366 dev_dbg(hub_dev
, "TT requires at most %d "
1367 "FS bit times (%d ns)\n",
1368 16, hub
->tt
.think_time
);
1370 case HUB_TTTT_24_BITS
:
1371 hub
->tt
.think_time
= 666 * 3;
1372 dev_dbg(hub_dev
, "TT requires at most %d "
1373 "FS bit times (%d ns)\n",
1374 24, hub
->tt
.think_time
);
1376 case HUB_TTTT_32_BITS
:
1377 hub
->tt
.think_time
= 666 * 4;
1378 dev_dbg(hub_dev
, "TT requires at most %d "
1379 "FS bit times (%d ns)\n",
1380 32, hub
->tt
.think_time
);
1384 /* probe() zeroes hub->indicator[] */
1385 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
1386 hub
->has_indicators
= 1;
1387 dev_dbg(hub_dev
, "Port indicators are supported\n");
1390 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
1391 hub
->descriptor
->bPwrOn2PwrGood
* 2);
1393 /* power budgeting mostly matters with bus-powered hubs,
1394 * and battery-powered root hubs (may provide just 8 mA).
1396 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
1398 message
= "can't get hub status";
1401 le16_to_cpus(&hubstatus
);
1402 if (hdev
== hdev
->bus
->root_hub
) {
1403 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
1404 hub
->mA_per_port
= 500;
1406 hub
->mA_per_port
= hdev
->bus_mA
;
1407 hub
->limited_power
= 1;
1409 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
1410 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
1411 hub
->descriptor
->bHubContrCurrent
);
1412 hub
->limited_power
= 1;
1413 if (hdev
->maxchild
> 0) {
1414 int remaining
= hdev
->bus_mA
-
1415 hub
->descriptor
->bHubContrCurrent
;
1417 if (remaining
< hdev
->maxchild
* 100)
1419 "insufficient power available "
1420 "to use all downstream ports\n");
1421 hub
->mA_per_port
= 100; /* 7.2.1.1 */
1423 } else { /* Self-powered external hub */
1424 /* FIXME: What about battery-powered external hubs that
1425 * provide less current per port? */
1426 hub
->mA_per_port
= 500;
1428 if (hub
->mA_per_port
< 500)
1429 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
1432 /* Update the HCD's internal representation of this hub before khubd
1433 * starts getting port status changes for devices under the hub.
1435 hcd
= bus_to_hcd(hdev
->bus
);
1436 if (hcd
->driver
->update_hub_device
) {
1437 ret
= hcd
->driver
->update_hub_device(hcd
, hdev
,
1438 &hub
->tt
, GFP_KERNEL
);
1440 message
= "can't update HCD hub info";
1445 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
1447 message
= "can't get hub status";
1451 /* local power status reports aren't always correct */
1452 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
1453 dev_dbg(hub_dev
, "local power source is %s\n",
1454 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
1455 ? "lost (inactive)" : "good");
1457 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
1458 dev_dbg(hub_dev
, "%sover-current condition exists\n",
1459 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
1461 /* set up the interrupt endpoint
1462 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1463 * bytes as USB2.0[11.12.3] says because some hubs are known
1464 * to send more data (and thus cause overflow). For root hubs,
1465 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1466 * to be big enough for at least USB_MAXCHILDREN ports. */
1467 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
1468 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
1470 if (maxp
> sizeof(*hub
->buffer
))
1471 maxp
= sizeof(*hub
->buffer
);
1473 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1479 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
1480 hub
, endpoint
->bInterval
);
1482 /* maybe cycle the hub leds */
1483 if (hub
->has_indicators
&& blinkenlights
)
1484 hub
->indicator
[0] = INDICATOR_CYCLE
;
1486 hub_activate(hub
, HUB_INIT
);
1490 dev_err (hub_dev
, "config failed, %s (err %d)\n",
1492 /* hub_disconnect() frees urb and descriptor */
1496 static void hub_release(struct kref
*kref
)
1498 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
1500 usb_put_intf(to_usb_interface(hub
->intfdev
));
1504 static unsigned highspeed_hubs
;
1506 static void hub_disconnect(struct usb_interface
*intf
)
1508 struct usb_hub
*hub
= usb_get_intfdata(intf
);
1509 struct usb_device
*hdev
= interface_to_usbdev(intf
);
1511 /* Take the hub off the event list and don't let it be added again */
1512 spin_lock_irq(&hub_event_lock
);
1513 if (!list_empty(&hub
->event_list
)) {
1514 list_del_init(&hub
->event_list
);
1515 usb_autopm_put_interface_no_suspend(intf
);
1517 hub
->disconnected
= 1;
1518 spin_unlock_irq(&hub_event_lock
);
1520 /* Disconnect all children and quiesce the hub */
1522 hub_quiesce(hub
, HUB_DISCONNECT
);
1524 usb_set_intfdata (intf
, NULL
);
1525 hub
->hdev
->maxchild
= 0;
1527 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1530 usb_free_urb(hub
->urb
);
1531 kfree(hdev
->children
);
1532 kfree(hub
->port_owners
);
1533 kfree(hub
->descriptor
);
1537 kref_put(&hub
->kref
, hub_release
);
1540 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1542 struct usb_host_interface
*desc
;
1543 struct usb_endpoint_descriptor
*endpoint
;
1544 struct usb_device
*hdev
;
1545 struct usb_hub
*hub
;
1547 desc
= intf
->cur_altsetting
;
1548 hdev
= interface_to_usbdev(intf
);
1550 /* Hubs have proper suspend/resume support. */
1551 usb_enable_autosuspend(hdev
);
1553 if (hdev
->level
== MAX_TOPO_LEVEL
) {
1555 "Unsupported bus topology: hub nested too deep\n");
1559 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1561 dev_warn(&intf
->dev
, "ignoring external hub\n");
1566 /* Some hubs have a subclass of 1, which AFAICT according to the */
1567 /* specs is not defined, but it works */
1568 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1569 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1571 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1575 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1576 if (desc
->desc
.bNumEndpoints
!= 1)
1577 goto descriptor_error
;
1579 endpoint
= &desc
->endpoint
[0].desc
;
1581 /* If it's not an interrupt in endpoint, we'd better punt! */
1582 if (!usb_endpoint_is_int_in(endpoint
))
1583 goto descriptor_error
;
1585 /* We found a hub */
1586 dev_info (&intf
->dev
, "USB hub found\n");
1588 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1590 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1594 kref_init(&hub
->kref
);
1595 INIT_LIST_HEAD(&hub
->event_list
);
1596 hub
->intfdev
= &intf
->dev
;
1598 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1599 INIT_DELAYED_WORK(&hub
->init_work
, NULL
);
1602 usb_set_intfdata (intf
, hub
);
1603 intf
->needs_remote_wakeup
= 1;
1605 if (hdev
->speed
== USB_SPEED_HIGH
)
1608 if (hub_configure(hub
, endpoint
) >= 0)
1611 hub_disconnect (intf
);
1616 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1618 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1620 /* assert ifno == 0 (part of hub spec) */
1622 case USBDEVFS_HUB_PORTINFO
: {
1623 struct usbdevfs_hub_portinfo
*info
= user_data
;
1626 spin_lock_irq(&device_state_lock
);
1627 if (hdev
->devnum
<= 0)
1630 info
->nports
= hdev
->maxchild
;
1631 for (i
= 0; i
< info
->nports
; i
++) {
1632 if (hdev
->children
[i
] == NULL
)
1636 hdev
->children
[i
]->devnum
;
1639 spin_unlock_irq(&device_state_lock
);
1641 return info
->nports
+ 1;
1650 * Allow user programs to claim ports on a hub. When a device is attached
1651 * to one of these "claimed" ports, the program will "own" the device.
1653 static int find_port_owner(struct usb_device
*hdev
, unsigned port1
,
1654 struct dev_state
***ppowner
)
1656 if (hdev
->state
== USB_STATE_NOTATTACHED
)
1658 if (port1
== 0 || port1
> hdev
->maxchild
)
1661 /* This assumes that devices not managed by the hub driver
1662 * will always have maxchild equal to 0.
1664 *ppowner
= &(hdev_to_hub(hdev
)->port_owners
[port1
- 1]);
1668 /* In the following three functions, the caller must hold hdev's lock */
1669 int usb_hub_claim_port(struct usb_device
*hdev
, unsigned port1
,
1670 struct dev_state
*owner
)
1673 struct dev_state
**powner
;
1675 rc
= find_port_owner(hdev
, port1
, &powner
);
1684 int usb_hub_release_port(struct usb_device
*hdev
, unsigned port1
,
1685 struct dev_state
*owner
)
1688 struct dev_state
**powner
;
1690 rc
= find_port_owner(hdev
, port1
, &powner
);
1693 if (*powner
!= owner
)
1699 void usb_hub_release_all_ports(struct usb_device
*hdev
, struct dev_state
*owner
)
1702 struct dev_state
**powner
;
1704 n
= find_port_owner(hdev
, 1, &powner
);
1706 for (; n
< hdev
->maxchild
; (++n
, ++powner
)) {
1707 if (*powner
== owner
)
1713 /* The caller must hold udev's lock */
1714 bool usb_device_is_owned(struct usb_device
*udev
)
1716 struct usb_hub
*hub
;
1718 if (udev
->state
== USB_STATE_NOTATTACHED
|| !udev
->parent
)
1720 hub
= hdev_to_hub(udev
->parent
);
1721 return !!hub
->port_owners
[udev
->portnum
- 1];
1725 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1729 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1730 if (udev
->children
[i
])
1731 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1733 if (udev
->state
== USB_STATE_SUSPENDED
)
1734 udev
->active_duration
-= jiffies
;
1735 udev
->state
= USB_STATE_NOTATTACHED
;
1739 * usb_set_device_state - change a device's current state (usbcore, hcds)
1740 * @udev: pointer to device whose state should be changed
1741 * @new_state: new state value to be stored
1743 * udev->state is _not_ fully protected by the device lock. Although
1744 * most transitions are made only while holding the lock, the state can
1745 * can change to USB_STATE_NOTATTACHED at almost any time. This
1746 * is so that devices can be marked as disconnected as soon as possible,
1747 * without having to wait for any semaphores to be released. As a result,
1748 * all changes to any device's state must be protected by the
1749 * device_state_lock spinlock.
1751 * Once a device has been added to the device tree, all changes to its state
1752 * should be made using this routine. The state should _not_ be set directly.
1754 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1755 * Otherwise udev->state is set to new_state, and if new_state is
1756 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1757 * to USB_STATE_NOTATTACHED.
1759 void usb_set_device_state(struct usb_device
*udev
,
1760 enum usb_device_state new_state
)
1762 unsigned long flags
;
1765 spin_lock_irqsave(&device_state_lock
, flags
);
1766 if (udev
->state
== USB_STATE_NOTATTACHED
)
1768 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1770 /* root hub wakeup capabilities are managed out-of-band
1771 * and may involve silicon errata ... ignore them here.
1774 if (udev
->state
== USB_STATE_SUSPENDED
1775 || new_state
== USB_STATE_SUSPENDED
)
1776 ; /* No change to wakeup settings */
1777 else if (new_state
== USB_STATE_CONFIGURED
)
1778 wakeup
= udev
->actconfig
->desc
.bmAttributes
1779 & USB_CONFIG_ATT_WAKEUP
;
1783 if (udev
->state
== USB_STATE_SUSPENDED
&&
1784 new_state
!= USB_STATE_SUSPENDED
)
1785 udev
->active_duration
-= jiffies
;
1786 else if (new_state
== USB_STATE_SUSPENDED
&&
1787 udev
->state
!= USB_STATE_SUSPENDED
)
1788 udev
->active_duration
+= jiffies
;
1789 udev
->state
= new_state
;
1791 recursively_mark_NOTATTACHED(udev
);
1792 spin_unlock_irqrestore(&device_state_lock
, flags
);
1794 device_set_wakeup_capable(&udev
->dev
, wakeup
);
1796 EXPORT_SYMBOL_GPL(usb_set_device_state
);
1799 * Choose a device number.
1801 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1802 * USB-2.0 buses they are also used as device addresses, however on
1803 * USB-3.0 buses the address is assigned by the controller hardware
1804 * and it usually is not the same as the device number.
1806 * WUSB devices are simple: they have no hubs behind, so the mapping
1807 * device <-> virtual port number becomes 1:1. Why? to simplify the
1808 * life of the device connection logic in
1809 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1810 * handshake we need to assign a temporary address in the unauthorized
1811 * space. For simplicity we use the first virtual port number found to
1812 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1813 * and that becomes it's address [X < 128] or its unauthorized address
1816 * We add 1 as an offset to the one-based USB-stack port number
1817 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1818 * 0 is reserved by USB for default address; (b) Linux's USB stack
1819 * uses always #1 for the root hub of the controller. So USB stack's
1820 * port #1, which is wusb virtual-port #0 has address #2.
1822 * Devices connected under xHCI are not as simple. The host controller
1823 * supports virtualization, so the hardware assigns device addresses and
1824 * the HCD must setup data structures before issuing a set address
1825 * command to the hardware.
1827 static void choose_devnum(struct usb_device
*udev
)
1830 struct usb_bus
*bus
= udev
->bus
;
1832 /* If khubd ever becomes multithreaded, this will need a lock */
1834 devnum
= udev
->portnum
+ 1;
1835 BUG_ON(test_bit(devnum
, bus
->devmap
.devicemap
));
1837 /* Try to allocate the next devnum beginning at
1838 * bus->devnum_next. */
1839 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1842 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
,
1844 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1847 set_bit(devnum
, bus
->devmap
.devicemap
);
1848 udev
->devnum
= devnum
;
1852 static void release_devnum(struct usb_device
*udev
)
1854 if (udev
->devnum
> 0) {
1855 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1860 static void update_devnum(struct usb_device
*udev
, int devnum
)
1862 /* The address for a WUSB device is managed by wusbcore. */
1864 udev
->devnum
= devnum
;
1867 static void hub_free_dev(struct usb_device
*udev
)
1869 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1871 /* Root hubs aren't real devices, so don't free HCD resources */
1872 if (hcd
->driver
->free_dev
&& udev
->parent
)
1873 hcd
->driver
->free_dev(hcd
, udev
);
1877 * usb_disconnect - disconnect a device (usbcore-internal)
1878 * @pdev: pointer to device being disconnected
1879 * Context: !in_interrupt ()
1881 * Something got disconnected. Get rid of it and all of its children.
1883 * If *pdev is a normal device then the parent hub must already be locked.
1884 * If *pdev is a root hub then this routine will acquire the
1885 * usb_bus_list_lock on behalf of the caller.
1887 * Only hub drivers (including virtual root hub drivers for host
1888 * controllers) should ever call this.
1890 * This call is synchronous, and may not be used in an interrupt context.
1892 void usb_disconnect(struct usb_device
**pdev
)
1894 struct usb_device
*udev
= *pdev
;
1897 /* mark the device as inactive, so any further urb submissions for
1898 * this device (and any of its children) will fail immediately.
1899 * this quiesces everything except pending urbs.
1901 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1902 dev_info(&udev
->dev
, "USB disconnect, device number %d\n",
1905 usb_lock_device(udev
);
1907 /* Free up all the children before we remove this device */
1908 for (i
= 0; i
< udev
->maxchild
; i
++) {
1909 if (udev
->children
[i
])
1910 usb_disconnect(&udev
->children
[i
]);
1913 /* deallocate hcd/hardware state ... nuking all pending urbs and
1914 * cleaning up all state associated with the current configuration
1915 * so that the hardware is now fully quiesced.
1917 dev_dbg (&udev
->dev
, "unregistering device\n");
1918 usb_disable_device(udev
, 0);
1919 usb_hcd_synchronize_unlinks(udev
);
1921 usb_remove_ep_devs(&udev
->ep0
);
1922 usb_unlock_device(udev
);
1924 /* Unregister the device. The device driver is responsible
1925 * for de-configuring the device and invoking the remove-device
1926 * notifier chain (used by usbfs and possibly others).
1928 device_del(&udev
->dev
);
1930 /* Free the device number and delete the parent's children[]
1931 * (or root_hub) pointer.
1933 release_devnum(udev
);
1935 /* Avoid races with recursively_mark_NOTATTACHED() */
1936 spin_lock_irq(&device_state_lock
);
1938 spin_unlock_irq(&device_state_lock
);
1942 put_device(&udev
->dev
);
1945 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1946 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1950 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1953 static void announce_device(struct usb_device
*udev
)
1955 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1956 le16_to_cpu(udev
->descriptor
.idVendor
),
1957 le16_to_cpu(udev
->descriptor
.idProduct
));
1958 dev_info(&udev
->dev
,
1959 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1960 udev
->descriptor
.iManufacturer
,
1961 udev
->descriptor
.iProduct
,
1962 udev
->descriptor
.iSerialNumber
);
1963 show_string(udev
, "Product", udev
->product
);
1964 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1965 show_string(udev
, "SerialNumber", udev
->serial
);
1968 static inline void announce_device(struct usb_device
*udev
) { }
1971 #ifdef CONFIG_USB_OTG
1972 #include "otg_whitelist.h"
1976 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1977 * @udev: newly addressed device (in ADDRESS state)
1979 * Finish enumeration for On-The-Go devices
1981 static int usb_enumerate_device_otg(struct usb_device
*udev
)
1985 #ifdef CONFIG_USB_OTG
1987 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1988 * to wake us after we've powered off VBUS; and HNP, switching roles
1989 * "host" to "peripheral". The OTG descriptor helps figure this out.
1991 if (!udev
->bus
->is_b_host
1993 && udev
->parent
== udev
->bus
->root_hub
) {
1994 struct usb_otg_descriptor
*desc
= NULL
;
1995 struct usb_bus
*bus
= udev
->bus
;
1997 /* descriptor may appear anywhere in config */
1998 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1999 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
2000 USB_DT_OTG
, (void **) &desc
) == 0) {
2001 if (desc
->bmAttributes
& USB_OTG_HNP
) {
2002 unsigned port1
= udev
->portnum
;
2004 dev_info(&udev
->dev
,
2005 "Dual-Role OTG device on %sHNP port\n",
2006 (port1
== bus
->otg_port
)
2009 /* enable HNP before suspend, it's simpler */
2010 if (port1
== bus
->otg_port
)
2011 bus
->b_hnp_enable
= 1;
2012 err
= usb_control_msg(udev
,
2013 usb_sndctrlpipe(udev
, 0),
2014 USB_REQ_SET_FEATURE
, 0,
2016 ? USB_DEVICE_B_HNP_ENABLE
2017 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
2018 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2020 /* OTG MESSAGE: report errors here,
2021 * customize to match your product.
2023 dev_info(&udev
->dev
,
2024 "can't set HNP mode: %d\n",
2026 bus
->b_hnp_enable
= 0;
2032 if (!is_targeted(udev
)) {
2034 /* Maybe it can talk to us, though we can't talk to it.
2035 * (Includes HNP test device.)
2037 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
2038 err
= usb_port_suspend(udev
, PMSG_SUSPEND
);
2040 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
2052 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2053 * @udev: newly addressed device (in ADDRESS state)
2055 * This is only called by usb_new_device() and usb_authorize_device()
2056 * and FIXME -- all comments that apply to them apply here wrt to
2059 * If the device is WUSB and not authorized, we don't attempt to read
2060 * the string descriptors, as they will be errored out by the device
2061 * until it has been authorized.
2063 static int usb_enumerate_device(struct usb_device
*udev
)
2067 if (udev
->config
== NULL
) {
2068 err
= usb_get_configuration(udev
);
2070 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
2075 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
2076 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2077 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2078 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2081 /* read the standard strings and cache them if present */
2082 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
2083 udev
->manufacturer
= usb_cache_string(udev
,
2084 udev
->descriptor
.iManufacturer
);
2085 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
2087 err
= usb_enumerate_device_otg(udev
);
2091 usb_detect_interface_quirks(udev
);
2096 static void set_usb_port_removable(struct usb_device
*udev
)
2098 struct usb_device
*hdev
= udev
->parent
;
2099 struct usb_hub
*hub
;
2100 u8 port
= udev
->portnum
;
2101 u16 wHubCharacteristics
;
2102 bool removable
= true;
2107 hub
= hdev_to_hub(udev
->parent
);
2109 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2111 if (!(wHubCharacteristics
& HUB_CHAR_COMPOUND
))
2114 if (hub_is_superspeed(hdev
)) {
2115 if (hub
->descriptor
->u
.ss
.DeviceRemovable
& (1 << port
))
2118 if (hub
->descriptor
->u
.hs
.DeviceRemovable
[port
/ 8] & (1 << (port
% 8)))
2123 udev
->removable
= USB_DEVICE_REMOVABLE
;
2125 udev
->removable
= USB_DEVICE_FIXED
;
2129 * usb_new_device - perform initial device setup (usbcore-internal)
2130 * @udev: newly addressed device (in ADDRESS state)
2132 * This is called with devices which have been detected but not fully
2133 * enumerated. The device descriptor is available, but not descriptors
2134 * for any device configuration. The caller must have locked either
2135 * the parent hub (if udev is a normal device) or else the
2136 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2137 * udev has already been installed, but udev is not yet visible through
2138 * sysfs or other filesystem code.
2140 * It will return if the device is configured properly or not. Zero if
2141 * the interface was registered with the driver core; else a negative
2144 * This call is synchronous, and may not be used in an interrupt context.
2146 * Only the hub driver or root-hub registrar should ever call this.
2148 int usb_new_device(struct usb_device
*udev
)
2153 /* Initialize non-root-hub device wakeup to disabled;
2154 * device (un)configuration controls wakeup capable
2155 * sysfs power/wakeup controls wakeup enabled/disabled
2157 device_init_wakeup(&udev
->dev
, 0);
2160 /* Tell the runtime-PM framework the device is active */
2161 pm_runtime_set_active(&udev
->dev
);
2162 pm_runtime_get_noresume(&udev
->dev
);
2163 pm_runtime_use_autosuspend(&udev
->dev
);
2164 pm_runtime_enable(&udev
->dev
);
2166 /* By default, forbid autosuspend for all devices. It will be
2167 * allowed for hubs during binding.
2169 usb_disable_autosuspend(udev
);
2171 err
= usb_enumerate_device(udev
); /* Read descriptors */
2174 dev_dbg(&udev
->dev
, "udev %d, busnum %d, minor = %d\n",
2175 udev
->devnum
, udev
->bus
->busnum
,
2176 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2177 /* export the usbdev device-node for libusb */
2178 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
2179 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
2181 /* Tell the world! */
2182 announce_device(udev
);
2184 device_enable_async_suspend(&udev
->dev
);
2187 * check whether the hub marks this port as non-removable. Do it
2188 * now so that platform-specific data can override it in
2192 set_usb_port_removable(udev
);
2194 /* Register the device. The device driver is responsible
2195 * for configuring the device and invoking the add-device
2196 * notifier chain (used by usbfs and possibly others).
2198 err
= device_add(&udev
->dev
);
2200 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
2204 (void) usb_create_ep_devs(&udev
->dev
, &udev
->ep0
, udev
);
2205 usb_mark_last_busy(udev
);
2206 pm_runtime_put_sync_autosuspend(&udev
->dev
);
2210 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
2211 pm_runtime_disable(&udev
->dev
);
2212 pm_runtime_set_suspended(&udev
->dev
);
2218 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2219 * @usb_dev: USB device
2221 * Move the USB device to a very basic state where interfaces are disabled
2222 * and the device is in fact unconfigured and unusable.
2224 * We share a lock (that we have) with device_del(), so we need to
2227 int usb_deauthorize_device(struct usb_device
*usb_dev
)
2229 usb_lock_device(usb_dev
);
2230 if (usb_dev
->authorized
== 0)
2231 goto out_unauthorized
;
2233 usb_dev
->authorized
= 0;
2234 usb_set_configuration(usb_dev
, -1);
2236 kfree(usb_dev
->product
);
2237 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2238 kfree(usb_dev
->manufacturer
);
2239 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2240 kfree(usb_dev
->serial
);
2241 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
2243 usb_destroy_configuration(usb_dev
);
2244 usb_dev
->descriptor
.bNumConfigurations
= 0;
2247 usb_unlock_device(usb_dev
);
2252 int usb_authorize_device(struct usb_device
*usb_dev
)
2256 usb_lock_device(usb_dev
);
2257 if (usb_dev
->authorized
== 1)
2258 goto out_authorized
;
2260 result
= usb_autoresume_device(usb_dev
);
2262 dev_err(&usb_dev
->dev
,
2263 "can't autoresume for authorization: %d\n", result
);
2264 goto error_autoresume
;
2266 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
2268 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
2269 "authorization: %d\n", result
);
2270 goto error_device_descriptor
;
2273 kfree(usb_dev
->product
);
2274 usb_dev
->product
= NULL
;
2275 kfree(usb_dev
->manufacturer
);
2276 usb_dev
->manufacturer
= NULL
;
2277 kfree(usb_dev
->serial
);
2278 usb_dev
->serial
= NULL
;
2280 usb_dev
->authorized
= 1;
2281 result
= usb_enumerate_device(usb_dev
);
2283 goto error_enumerate
;
2284 /* Choose and set the configuration. This registers the interfaces
2285 * with the driver core and lets interface drivers bind to them.
2287 c
= usb_choose_configuration(usb_dev
);
2289 result
= usb_set_configuration(usb_dev
, c
);
2291 dev_err(&usb_dev
->dev
,
2292 "can't set config #%d, error %d\n", c
, result
);
2293 /* This need not be fatal. The user can try to
2294 * set other configurations. */
2297 dev_info(&usb_dev
->dev
, "authorized to connect\n");
2300 error_device_descriptor
:
2301 usb_autosuspend_device(usb_dev
);
2304 usb_unlock_device(usb_dev
); // complements locktree
2309 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2310 static unsigned hub_is_wusb(struct usb_hub
*hub
)
2312 struct usb_hcd
*hcd
;
2313 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
2315 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
2316 return hcd
->wireless
;
2320 #define PORT_RESET_TRIES 5
2321 #define SET_ADDRESS_TRIES 2
2322 #define GET_DESCRIPTOR_TRIES 2
2323 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2324 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2326 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2327 #define HUB_SHORT_RESET_TIME 10
2328 #define HUB_BH_RESET_TIME 50
2329 #define HUB_LONG_RESET_TIME 200
2330 #define HUB_RESET_TIMEOUT 500
2332 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2333 struct usb_device
*udev
, unsigned int delay
, bool warm
);
2335 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2336 * Port worm reset is required to recover
2338 static bool hub_port_warm_reset_required(struct usb_hub
*hub
, u16 portstatus
)
2340 return hub_is_superspeed(hub
->hdev
) &&
2341 (((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2342 USB_SS_PORT_LS_SS_INACTIVE
) ||
2343 ((portstatus
& USB_PORT_STAT_LINK_STATE
) ==
2344 USB_SS_PORT_LS_COMP_MOD
)) ;
2347 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
2348 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2350 int delay_time
, ret
;
2354 for (delay_time
= 0;
2355 delay_time
< HUB_RESET_TIMEOUT
;
2356 delay_time
+= delay
) {
2357 /* wait to give the device a chance to reset */
2360 /* read and decode port status */
2361 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2366 * Some buggy devices require a warm reset to be issued even
2367 * when the port appears not to be connected.
2371 * Some buggy devices can cause an NEC host controller
2372 * to transition to the "Error" state after a hot port
2373 * reset. This will show up as the port state in
2374 * "Inactive", and the port may also report a
2375 * disconnect. Forcing a warm port reset seems to make
2378 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2380 if (hub_port_warm_reset_required(hub
, portstatus
)) {
2383 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
2384 clear_port_feature(hub
->hdev
, port1
,
2385 USB_PORT_FEAT_C_CONNECTION
);
2386 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
2387 clear_port_feature(hub
->hdev
, port1
,
2388 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2389 if (portchange
& USB_PORT_STAT_C_RESET
)
2390 clear_port_feature(hub
->hdev
, port1
,
2391 USB_PORT_FEAT_C_RESET
);
2392 dev_dbg(hub
->intfdev
, "hot reset failed, warm reset port %d\n",
2394 ret
= hub_port_reset(hub
, port1
,
2395 udev
, HUB_BH_RESET_TIME
,
2397 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
2398 clear_port_feature(hub
->hdev
, port1
,
2399 USB_PORT_FEAT_C_CONNECTION
);
2402 /* Device went away? */
2403 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
2406 /* bomb out completely if the connection bounced */
2407 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
2410 /* if we`ve finished resetting, then break out of
2413 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
2414 (portstatus
& USB_PORT_STAT_ENABLE
)) {
2415 if (hub_is_wusb(hub
))
2416 udev
->speed
= USB_SPEED_WIRELESS
;
2417 else if (hub_is_superspeed(hub
->hdev
))
2418 udev
->speed
= USB_SPEED_SUPER
;
2419 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
2420 udev
->speed
= USB_SPEED_HIGH
;
2421 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
2422 udev
->speed
= USB_SPEED_LOW
;
2424 udev
->speed
= USB_SPEED_FULL
;
2428 if (portchange
& USB_PORT_STAT_C_BH_RESET
)
2432 /* switch to the long delay after two short delay failures */
2433 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
2434 delay
= HUB_LONG_RESET_TIME
;
2436 dev_dbg (hub
->intfdev
,
2437 "port %d not %sreset yet, waiting %dms\n",
2438 port1
, warm
? "warm " : "", delay
);
2444 static void hub_port_finish_reset(struct usb_hub
*hub
, int port1
,
2445 struct usb_device
*udev
, int *status
, bool warm
)
2450 struct usb_hcd
*hcd
;
2451 /* TRSTRCY = 10 ms; plus some extra */
2453 update_devnum(udev
, 0);
2454 hcd
= bus_to_hcd(udev
->bus
);
2455 if (hcd
->driver
->reset_device
) {
2456 *status
= hcd
->driver
->reset_device(hcd
, udev
);
2458 dev_err(&udev
->dev
, "Cannot reset "
2459 "HCD device state\n");
2467 clear_port_feature(hub
->hdev
,
2468 port1
, USB_PORT_FEAT_C_RESET
);
2469 /* FIXME need disconnect() for NOTATTACHED device */
2471 clear_port_feature(hub
->hdev
, port1
,
2472 USB_PORT_FEAT_C_BH_PORT_RESET
);
2473 clear_port_feature(hub
->hdev
, port1
,
2474 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2476 usb_set_device_state(udev
, *status
2477 ? USB_STATE_NOTATTACHED
2478 : USB_STATE_DEFAULT
);
2484 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2485 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
2486 struct usb_device
*udev
, unsigned int delay
, bool warm
)
2491 /* Block EHCI CF initialization during the port reset.
2492 * Some companion controllers don't like it when they mix.
2494 down_read(&ehci_cf_port_reset_rwsem
);
2496 if (!hub_is_superspeed(hub
->hdev
)) {
2497 dev_err(hub
->intfdev
, "only USB3 hub support "
2503 /* Reset the port */
2504 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
2505 status
= set_port_feature(hub
->hdev
, port1
, (warm
?
2506 USB_PORT_FEAT_BH_PORT_RESET
:
2507 USB_PORT_FEAT_RESET
));
2509 dev_err(hub
->intfdev
,
2510 "cannot %sreset port %d (err = %d)\n",
2511 warm
? "warm " : "", port1
, status
);
2513 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
,
2515 if (status
&& status
!= -ENOTCONN
)
2516 dev_dbg(hub
->intfdev
,
2517 "port_wait_reset: err = %d\n",
2521 /* return on disconnect or reset */
2522 if (status
== 0 || status
== -ENOTCONN
|| status
== -ENODEV
) {
2523 hub_port_finish_reset(hub
, port1
, udev
, &status
, warm
);
2527 dev_dbg (hub
->intfdev
,
2528 "port %d not enabled, trying %sreset again...\n",
2529 port1
, warm
? "warm " : "");
2530 delay
= HUB_LONG_RESET_TIME
;
2533 dev_err (hub
->intfdev
,
2534 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2539 up_read(&ehci_cf_port_reset_rwsem
);
2544 /* Check if a port is power on */
2545 static int port_is_power_on(struct usb_hub
*hub
, unsigned portstatus
)
2549 if (hub_is_superspeed(hub
->hdev
)) {
2550 if (portstatus
& USB_SS_PORT_STAT_POWER
)
2553 if (portstatus
& USB_PORT_STAT_POWER
)
2562 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2563 static int port_is_suspended(struct usb_hub
*hub
, unsigned portstatus
)
2567 if (hub_is_superspeed(hub
->hdev
)) {
2568 if ((portstatus
& USB_PORT_STAT_LINK_STATE
)
2569 == USB_SS_PORT_LS_U3
)
2572 if (portstatus
& USB_PORT_STAT_SUSPEND
)
2579 /* Determine whether the device on a port is ready for a normal resume,
2580 * is ready for a reset-resume, or should be disconnected.
2582 static int check_port_resume_type(struct usb_device
*udev
,
2583 struct usb_hub
*hub
, int port1
,
2584 int status
, unsigned portchange
, unsigned portstatus
)
2586 /* Is the device still present? */
2587 if (status
|| port_is_suspended(hub
, portstatus
) ||
2588 !port_is_power_on(hub
, portstatus
) ||
2589 !(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2594 /* Can't do a normal resume if the port isn't enabled,
2595 * so try a reset-resume instead.
2597 else if (!(portstatus
& USB_PORT_STAT_ENABLE
) && !udev
->reset_resume
) {
2598 if (udev
->persist_enabled
)
2599 udev
->reset_resume
= 1;
2605 dev_dbg(hub
->intfdev
,
2606 "port %d status %04x.%04x after resume, %d\n",
2607 port1
, portchange
, portstatus
, status
);
2608 } else if (udev
->reset_resume
) {
2610 /* Late port handoff can set status-change bits */
2611 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
2612 clear_port_feature(hub
->hdev
, port1
,
2613 USB_PORT_FEAT_C_CONNECTION
);
2614 if (portchange
& USB_PORT_STAT_C_ENABLE
)
2615 clear_port_feature(hub
->hdev
, port1
,
2616 USB_PORT_FEAT_C_ENABLE
);
2622 int usb_disable_ltm(struct usb_device
*udev
)
2624 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2626 /* Check if the roothub and device supports LTM. */
2627 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2628 !usb_device_supports_ltm(udev
))
2631 /* Clear Feature LTM Enable can only be sent if the device is
2634 if (!udev
->actconfig
)
2637 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2638 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2639 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2640 USB_CTRL_SET_TIMEOUT
);
2642 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
2644 void usb_enable_ltm(struct usb_device
*udev
)
2646 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
2648 /* Check if the roothub and device supports LTM. */
2649 if (!usb_device_supports_ltm(hcd
->self
.root_hub
) ||
2650 !usb_device_supports_ltm(udev
))
2653 /* Set Feature LTM Enable can only be sent if the device is
2656 if (!udev
->actconfig
)
2659 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2660 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2661 USB_DEVICE_LTM_ENABLE
, 0, NULL
, 0,
2662 USB_CTRL_SET_TIMEOUT
);
2664 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
2666 #ifdef CONFIG_USB_SUSPEND
2669 * usb_port_suspend - suspend a usb device's upstream port
2670 * @udev: device that's no longer in active use, not a root hub
2671 * Context: must be able to sleep; device not locked; pm locks held
2673 * Suspends a USB device that isn't in active use, conserving power.
2674 * Devices may wake out of a suspend, if anything important happens,
2675 * using the remote wakeup mechanism. They may also be taken out of
2676 * suspend by the host, using usb_port_resume(). It's also routine
2677 * to disconnect devices while they are suspended.
2679 * This only affects the USB hardware for a device; its interfaces
2680 * (and, for hubs, child devices) must already have been suspended.
2682 * Selective port suspend reduces power; most suspended devices draw
2683 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2684 * All devices below the suspended port are also suspended.
2686 * Devices leave suspend state when the host wakes them up. Some devices
2687 * also support "remote wakeup", where the device can activate the USB
2688 * tree above them to deliver data, such as a keypress or packet. In
2689 * some cases, this wakes the USB host.
2691 * Suspending OTG devices may trigger HNP, if that's been enabled
2692 * between a pair of dual-role devices. That will change roles, such
2693 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2695 * Devices on USB hub ports have only one "suspend" state, corresponding
2696 * to ACPI D2, "may cause the device to lose some context".
2697 * State transitions include:
2699 * - suspend, resume ... when the VBUS power link stays live
2700 * - suspend, disconnect ... VBUS lost
2702 * Once VBUS drop breaks the circuit, the port it's using has to go through
2703 * normal re-enumeration procedures, starting with enabling VBUS power.
2704 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2705 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2706 * timer, no SRP, no requests through sysfs.
2708 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2709 * the root hub for their bus goes into global suspend ... so we don't
2710 * (falsely) update the device power state to say it suspended.
2712 * Returns 0 on success, else negative errno.
2714 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
2716 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2717 int port1
= udev
->portnum
;
2720 /* enable remote wakeup when appropriate; this lets the device
2721 * wake up the upstream hub (including maybe the root hub).
2723 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2724 * we don't explicitly enable it here.
2726 if (udev
->do_remote_wakeup
) {
2727 if (!hub_is_superspeed(hub
->hdev
)) {
2728 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2729 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
2730 USB_DEVICE_REMOTE_WAKEUP
, 0,
2732 USB_CTRL_SET_TIMEOUT
);
2734 /* Assume there's only one function on the USB 3.0
2735 * device and enable remote wake for the first
2736 * interface. FIXME if the interface association
2737 * descriptor shows there's more than one function.
2739 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2740 USB_REQ_SET_FEATURE
,
2741 USB_RECIP_INTERFACE
,
2742 USB_INTRF_FUNC_SUSPEND
,
2743 USB_INTRF_FUNC_SUSPEND_RW
|
2744 USB_INTRF_FUNC_SUSPEND_LP
,
2746 USB_CTRL_SET_TIMEOUT
);
2749 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
2751 /* bail if autosuspend is requested */
2752 if (PMSG_IS_AUTO(msg
))
2757 /* disable USB2 hardware LPM */
2758 if (udev
->usb2_hw_lpm_enabled
== 1)
2759 usb_set_usb2_hardware_lpm(udev
, 0);
2761 if (usb_disable_ltm(udev
)) {
2762 dev_err(&udev
->dev
, "%s Failed to disable LTM before suspend\n.",
2766 if (usb_unlocked_disable_lpm(udev
)) {
2767 dev_err(&udev
->dev
, "%s Failed to disable LPM before suspend\n.",
2773 if (hub_is_superspeed(hub
->hdev
))
2774 status
= set_port_feature(hub
->hdev
,
2775 port1
| (USB_SS_PORT_LS_U3
<< 3),
2776 USB_PORT_FEAT_LINK_STATE
);
2778 status
= set_port_feature(hub
->hdev
, port1
,
2779 USB_PORT_FEAT_SUSPEND
);
2781 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
2783 /* paranoia: "should not happen" */
2784 if (udev
->do_remote_wakeup
)
2785 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
2786 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
2787 USB_DEVICE_REMOTE_WAKEUP
, 0,
2789 USB_CTRL_SET_TIMEOUT
);
2791 /* Try to enable USB2 hardware LPM again */
2792 if (udev
->usb2_hw_lpm_capable
== 1)
2793 usb_set_usb2_hardware_lpm(udev
, 1);
2795 /* Try to enable USB3 LTM and LPM again */
2796 usb_enable_ltm(udev
);
2797 usb_unlocked_enable_lpm(udev
);
2799 /* System sleep transitions should never fail */
2800 if (!PMSG_IS_AUTO(msg
))
2803 /* device has up to 10 msec to fully suspend */
2804 dev_dbg(&udev
->dev
, "usb %ssuspend, wakeup %d\n",
2805 (PMSG_IS_AUTO(msg
) ? "auto-" : ""),
2806 udev
->do_remote_wakeup
);
2807 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
2810 usb_mark_last_busy(hub
->hdev
);
2815 * If the USB "suspend" state is in use (rather than "global suspend"),
2816 * many devices will be individually taken out of suspend state using
2817 * special "resume" signaling. This routine kicks in shortly after
2818 * hardware resume signaling is finished, either because of selective
2819 * resume (by host) or remote wakeup (by device) ... now see what changed
2820 * in the tree that's rooted at this device.
2822 * If @udev->reset_resume is set then the device is reset before the
2823 * status check is done.
2825 static int finish_port_resume(struct usb_device
*udev
)
2830 /* caller owns the udev device lock */
2831 dev_dbg(&udev
->dev
, "%s\n",
2832 udev
->reset_resume
? "finish reset-resume" : "finish resume");
2834 /* usb ch9 identifies four variants of SUSPENDED, based on what
2835 * state the device resumes to. Linux currently won't see the
2836 * first two on the host side; they'd be inside hub_port_init()
2837 * during many timeouts, but khubd can't suspend until later.
2839 usb_set_device_state(udev
, udev
->actconfig
2840 ? USB_STATE_CONFIGURED
2841 : USB_STATE_ADDRESS
);
2843 /* 10.5.4.5 says not to reset a suspended port if the attached
2844 * device is enabled for remote wakeup. Hence the reset
2845 * operation is carried out here, after the port has been
2848 if (udev
->reset_resume
)
2850 status
= usb_reset_and_verify_device(udev
);
2852 /* 10.5.4.5 says be sure devices in the tree are still there.
2853 * For now let's assume the device didn't go crazy on resume,
2854 * and device drivers will know about any resume quirks.
2858 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
2860 status
= (status
> 0 ? 0 : -ENODEV
);
2862 /* If a normal resume failed, try doing a reset-resume */
2863 if (status
&& !udev
->reset_resume
&& udev
->persist_enabled
) {
2864 dev_dbg(&udev
->dev
, "retry with reset-resume\n");
2865 udev
->reset_resume
= 1;
2866 goto retry_reset_resume
;
2871 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
2873 } else if (udev
->actconfig
) {
2874 le16_to_cpus(&devstatus
);
2875 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
2876 status
= usb_control_msg(udev
,
2877 usb_sndctrlpipe(udev
, 0),
2878 USB_REQ_CLEAR_FEATURE
,
2880 USB_DEVICE_REMOTE_WAKEUP
, 0,
2882 USB_CTRL_SET_TIMEOUT
);
2885 "disable remote wakeup, status %d\n",
2894 * usb_port_resume - re-activate a suspended usb device's upstream port
2895 * @udev: device to re-activate, not a root hub
2896 * Context: must be able to sleep; device not locked; pm locks held
2898 * This will re-activate the suspended device, increasing power usage
2899 * while letting drivers communicate again with its endpoints.
2900 * USB resume explicitly guarantees that the power session between
2901 * the host and the device is the same as it was when the device
2904 * If @udev->reset_resume is set then this routine won't check that the
2905 * port is still enabled. Furthermore, finish_port_resume() above will
2906 * reset @udev. The end result is that a broken power session can be
2907 * recovered and @udev will appear to persist across a loss of VBUS power.
2909 * For example, if a host controller doesn't maintain VBUS suspend current
2910 * during a system sleep or is reset when the system wakes up, all the USB
2911 * power sessions below it will be broken. This is especially troublesome
2912 * for mass-storage devices containing mounted filesystems, since the
2913 * device will appear to have disconnected and all the memory mappings
2914 * to it will be lost. Using the USB_PERSIST facility, the device can be
2915 * made to appear as if it had not disconnected.
2917 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2918 * every effort to insure that the same device is present after the
2919 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2920 * quite possible for a device to remain unaltered but its media to be
2921 * changed. If the user replaces a flash memory card while the system is
2922 * asleep, he will have only himself to blame when the filesystem on the
2923 * new card is corrupted and the system crashes.
2925 * Returns 0 on success, else negative errno.
2927 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
2929 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
2930 int port1
= udev
->portnum
;
2932 u16 portchange
, portstatus
;
2934 /* Skip the initial Clear-Suspend step for a remote wakeup */
2935 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2936 if (status
== 0 && !port_is_suspended(hub
, portstatus
))
2937 goto SuspendCleared
;
2939 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2941 set_bit(port1
, hub
->busy_bits
);
2943 /* see 7.1.7.7; affects power usage, but not budgeting */
2944 if (hub_is_superspeed(hub
->hdev
))
2945 status
= set_port_feature(hub
->hdev
,
2946 port1
| (USB_SS_PORT_LS_U0
<< 3),
2947 USB_PORT_FEAT_LINK_STATE
);
2949 status
= clear_port_feature(hub
->hdev
,
2950 port1
, USB_PORT_FEAT_SUSPEND
);
2952 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
2955 /* drive resume for at least 20 msec */
2956 dev_dbg(&udev
->dev
, "usb %sresume\n",
2957 (PMSG_IS_AUTO(msg
) ? "auto-" : ""));
2960 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2961 * stop resume signaling. Then finish the resume
2964 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2966 /* TRSMRCY = 10 msec */
2972 if (hub_is_superspeed(hub
->hdev
)) {
2973 if (portchange
& USB_PORT_STAT_C_LINK_STATE
)
2974 clear_port_feature(hub
->hdev
, port1
,
2975 USB_PORT_FEAT_C_PORT_LINK_STATE
);
2977 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2978 clear_port_feature(hub
->hdev
, port1
,
2979 USB_PORT_FEAT_C_SUSPEND
);
2983 clear_bit(port1
, hub
->busy_bits
);
2985 status
= check_port_resume_type(udev
,
2986 hub
, port1
, status
, portchange
, portstatus
);
2988 status
= finish_port_resume(udev
);
2990 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2991 hub_port_logical_disconnect(hub
, port1
);
2993 /* Try to enable USB2 hardware LPM */
2994 if (udev
->usb2_hw_lpm_capable
== 1)
2995 usb_set_usb2_hardware_lpm(udev
, 1);
2997 /* Try to enable USB3 LTM and LPM */
2998 usb_enable_ltm(udev
);
2999 usb_unlocked_enable_lpm(udev
);
3005 /* caller has locked udev */
3006 int usb_remote_wakeup(struct usb_device
*udev
)
3010 if (udev
->state
== USB_STATE_SUSPENDED
) {
3011 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
3012 status
= usb_autoresume_device(udev
);
3014 /* Let the drivers do their thing, then... */
3015 usb_autosuspend_device(udev
);
3021 #else /* CONFIG_USB_SUSPEND */
3023 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3025 int usb_port_suspend(struct usb_device
*udev
, pm_message_t msg
)
3030 /* However we may need to do a reset-resume */
3032 int usb_port_resume(struct usb_device
*udev
, pm_message_t msg
)
3034 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
3035 int port1
= udev
->portnum
;
3037 u16 portchange
, portstatus
;
3039 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3040 status
= check_port_resume_type(udev
,
3041 hub
, port1
, status
, portchange
, portstatus
);
3044 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
3045 hub_port_logical_disconnect(hub
, port1
);
3046 } else if (udev
->reset_resume
) {
3047 dev_dbg(&udev
->dev
, "reset-resume\n");
3048 status
= usb_reset_and_verify_device(udev
);
3055 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
3057 struct usb_hub
*hub
= usb_get_intfdata (intf
);
3058 struct usb_device
*hdev
= hub
->hdev
;
3062 /* Warn if children aren't already suspended */
3063 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3064 struct usb_device
*udev
;
3066 udev
= hdev
->children
[port1
-1];
3067 if (udev
&& udev
->can_submit
) {
3068 dev_warn(&intf
->dev
, "port %d nyet suspended\n", port1
);
3069 if (PMSG_IS_AUTO(msg
))
3073 if (hub_is_superspeed(hdev
) && hdev
->do_remote_wakeup
) {
3074 /* Enable hub to send remote wakeup for all ports. */
3075 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
3076 status
= set_port_feature(hdev
,
3078 USB_PORT_FEAT_REMOTE_WAKE_CONNECT
|
3079 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT
|
3080 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT
,
3081 USB_PORT_FEAT_REMOTE_WAKE_MASK
);
3085 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3087 /* stop khubd and related activity */
3088 hub_quiesce(hub
, HUB_SUSPEND
);
3092 static int hub_resume(struct usb_interface
*intf
)
3094 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3096 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3097 hub_activate(hub
, HUB_RESUME
);
3101 static int hub_reset_resume(struct usb_interface
*intf
)
3103 struct usb_hub
*hub
= usb_get_intfdata(intf
);
3105 dev_dbg(&intf
->dev
, "%s\n", __func__
);
3106 hub_activate(hub
, HUB_RESET_RESUME
);
3111 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3112 * @rhdev: struct usb_device for the root hub
3114 * The USB host controller driver calls this function when its root hub
3115 * is resumed and Vbus power has been interrupted or the controller
3116 * has been reset. The routine marks @rhdev as having lost power.
3117 * When the hub driver is resumed it will take notice and carry out
3118 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3119 * the others will be disconnected.
3121 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
3123 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
3124 rhdev
->reset_resume
= 1;
3126 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
3128 static const char * const usb3_lpm_names
[] = {
3136 * Send a Set SEL control transfer to the device, prior to enabling
3137 * device-initiated U1 or U2. This lets the device know the exit latencies from
3138 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3139 * packet from the host.
3141 * This function will fail if the SEL or PEL values for udev are greater than
3142 * the maximum allowed values for the link state to be enabled.
3144 static int usb_req_set_sel(struct usb_device
*udev
, enum usb3_link_state state
)
3146 struct usb_set_sel_req
*sel_values
;
3147 unsigned long long u1_sel
;
3148 unsigned long long u1_pel
;
3149 unsigned long long u2_sel
;
3150 unsigned long long u2_pel
;
3153 /* Convert SEL and PEL stored in ns to us */
3154 u1_sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
3155 u1_pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
3156 u2_sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
3157 u2_pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
3160 * Make sure that the calculated SEL and PEL values for the link
3161 * state we're enabling aren't bigger than the max SEL/PEL
3162 * value that will fit in the SET SEL control transfer.
3163 * Otherwise the device would get an incorrect idea of the exit
3164 * latency for the link state, and could start a device-initiated
3165 * U1/U2 when the exit latencies are too high.
3167 if ((state
== USB3_LPM_U1
&&
3168 (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
||
3169 u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)) ||
3170 (state
== USB3_LPM_U2
&&
3171 (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
||
3172 u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
))) {
3173 dev_dbg(&udev
->dev
, "Device-initiated %s disabled due "
3174 "to long SEL %llu ms or PEL %llu ms\n",
3175 usb3_lpm_names
[state
], u1_sel
, u1_pel
);
3180 * If we're enabling device-initiated LPM for one link state,
3181 * but the other link state has a too high SEL or PEL value,
3182 * just set those values to the max in the Set SEL request.
3184 if (u1_sel
> USB3_LPM_MAX_U1_SEL_PEL
)
3185 u1_sel
= USB3_LPM_MAX_U1_SEL_PEL
;
3187 if (u1_pel
> USB3_LPM_MAX_U1_SEL_PEL
)
3188 u1_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
3190 if (u2_sel
> USB3_LPM_MAX_U2_SEL_PEL
)
3191 u2_sel
= USB3_LPM_MAX_U2_SEL_PEL
;
3193 if (u2_pel
> USB3_LPM_MAX_U2_SEL_PEL
)
3194 u2_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
3197 * usb_enable_lpm() can be called as part of a failed device reset,
3198 * which may be initiated by an error path of a mass storage driver.
3199 * Therefore, use GFP_NOIO.
3201 sel_values
= kmalloc(sizeof *(sel_values
), GFP_NOIO
);
3205 sel_values
->u1_sel
= u1_sel
;
3206 sel_values
->u1_pel
= u1_pel
;
3207 sel_values
->u2_sel
= cpu_to_le16(u2_sel
);
3208 sel_values
->u2_pel
= cpu_to_le16(u2_pel
);
3210 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3214 sel_values
, sizeof *(sel_values
),
3215 USB_CTRL_SET_TIMEOUT
);
3221 * Enable or disable device-initiated U1 or U2 transitions.
3223 static int usb_set_device_initiated_lpm(struct usb_device
*udev
,
3224 enum usb3_link_state state
, bool enable
)
3231 feature
= USB_DEVICE_U1_ENABLE
;
3234 feature
= USB_DEVICE_U2_ENABLE
;
3237 dev_warn(&udev
->dev
, "%s: Can't %s non-U1 or U2 state.\n",
3238 __func__
, enable
? "enable" : "disable");
3242 if (udev
->state
!= USB_STATE_CONFIGURED
) {
3243 dev_dbg(&udev
->dev
, "%s: Can't %s %s state "
3244 "for unconfigured device.\n",
3245 __func__
, enable
? "enable" : "disable",
3246 usb3_lpm_names
[state
]);
3252 * First, let the device know about the exit latencies
3253 * associated with the link state we're about to enable.
3255 ret
= usb_req_set_sel(udev
, state
);
3257 dev_warn(&udev
->dev
, "Set SEL for device-initiated "
3258 "%s failed.\n", usb3_lpm_names
[state
]);
3262 * Now send the control transfer to enable device-initiated LPM
3263 * for either U1 or U2.
3265 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3266 USB_REQ_SET_FEATURE
,
3270 USB_CTRL_SET_TIMEOUT
);
3272 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3273 USB_REQ_CLEAR_FEATURE
,
3277 USB_CTRL_SET_TIMEOUT
);
3280 dev_warn(&udev
->dev
, "%s of device-initiated %s failed.\n",
3281 enable
? "Enable" : "Disable",
3282 usb3_lpm_names
[state
]);
3288 static int usb_set_lpm_timeout(struct usb_device
*udev
,
3289 enum usb3_link_state state
, int timeout
)
3296 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3299 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3302 dev_warn(&udev
->dev
, "%s: Can't set timeout for non-U1 or U2 state.\n",
3307 if (state
== USB3_LPM_U1
&& timeout
> USB3_LPM_U1_MAX_TIMEOUT
&&
3308 timeout
!= USB3_LPM_DEVICE_INITIATED
) {
3309 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x, "
3310 "which is a reserved value.\n",
3311 usb3_lpm_names
[state
], timeout
);
3315 ret
= set_port_feature(udev
->parent
,
3316 USB_PORT_LPM_TIMEOUT(timeout
) | udev
->portnum
,
3319 dev_warn(&udev
->dev
, "Failed to set %s timeout to 0x%x,"
3320 "error code %i\n", usb3_lpm_names
[state
],
3324 if (state
== USB3_LPM_U1
)
3325 udev
->u1_params
.timeout
= timeout
;
3327 udev
->u2_params
.timeout
= timeout
;
3332 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3335 * We will attempt to enable U1 or U2, but there are no guarantees that the
3336 * control transfers to set the hub timeout or enable device-initiated U1/U2
3337 * will be successful.
3339 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3340 * driver know about it. If that call fails, it should be harmless, and just
3341 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3343 static void usb_enable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3344 enum usb3_link_state state
)
3348 /* We allow the host controller to set the U1/U2 timeout internally
3349 * first, so that it can change its schedule to account for the
3350 * additional latency to send data to a device in a lower power
3353 timeout
= hcd
->driver
->enable_usb3_lpm_timeout(hcd
, udev
, state
);
3355 /* xHCI host controller doesn't want to enable this LPM state. */
3360 dev_warn(&udev
->dev
, "Could not enable %s link state, "
3361 "xHCI error %i.\n", usb3_lpm_names
[state
],
3366 if (usb_set_lpm_timeout(udev
, state
, timeout
))
3367 /* If we can't set the parent hub U1/U2 timeout,
3368 * device-initiated LPM won't be allowed either, so let the xHCI
3369 * host know that this link state won't be enabled.
3371 hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
);
3373 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3374 else if (udev
->actconfig
)
3375 usb_set_device_initiated_lpm(udev
, state
, true);
3380 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3383 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3384 * If zero is returned, the parent will not allow the link to go into U1/U2.
3386 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3387 * it won't have an effect on the bus link state because the parent hub will
3388 * still disallow device-initiated U1/U2 entry.
3390 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3391 * possible. The result will be slightly more bus bandwidth will be taken up
3392 * (to account for U1/U2 exit latency), but it should be harmless.
3394 static int usb_disable_link_state(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3395 enum usb3_link_state state
)
3401 feature
= USB_PORT_FEAT_U1_TIMEOUT
;
3404 feature
= USB_PORT_FEAT_U2_TIMEOUT
;
3407 dev_warn(&udev
->dev
, "%s: Can't disable non-U1 or U2 state.\n",
3412 if (usb_set_lpm_timeout(udev
, state
, 0))
3415 usb_set_device_initiated_lpm(udev
, state
, false);
3417 if (hcd
->driver
->disable_usb3_lpm_timeout(hcd
, udev
, state
))
3418 dev_warn(&udev
->dev
, "Could not disable xHCI %s timeout, "
3419 "bus schedule bandwidth may be impacted.\n",
3420 usb3_lpm_names
[state
]);
3425 * Disable hub-initiated and device-initiated U1 and U2 entry.
3426 * Caller must own the bandwidth_mutex.
3428 * This will call usb_enable_lpm() on failure, which will decrement
3429 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3431 int usb_disable_lpm(struct usb_device
*udev
)
3433 struct usb_hcd
*hcd
;
3435 if (!udev
|| !udev
->parent
||
3436 udev
->speed
!= USB_SPEED_SUPER
||
3440 hcd
= bus_to_hcd(udev
->bus
);
3441 if (!hcd
|| !hcd
->driver
->disable_usb3_lpm_timeout
)
3444 udev
->lpm_disable_count
++;
3445 if ((udev
->u1_params
.timeout
== 0 && udev
->u2_params
.timeout
== 0))
3448 /* If LPM is enabled, attempt to disable it. */
3449 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U1
))
3451 if (usb_disable_link_state(hcd
, udev
, USB3_LPM_U2
))
3457 usb_enable_lpm(udev
);
3460 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3462 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3463 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3465 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3471 mutex_lock(hcd
->bandwidth_mutex
);
3472 ret
= usb_disable_lpm(udev
);
3473 mutex_unlock(hcd
->bandwidth_mutex
);
3477 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3480 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3481 * xHCI host policy may prevent U1 or U2 from being enabled.
3483 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3484 * until the lpm_disable_count drops to zero. Caller must own the
3487 void usb_enable_lpm(struct usb_device
*udev
)
3489 struct usb_hcd
*hcd
;
3491 if (!udev
|| !udev
->parent
||
3492 udev
->speed
!= USB_SPEED_SUPER
||
3496 udev
->lpm_disable_count
--;
3497 hcd
= bus_to_hcd(udev
->bus
);
3498 /* Double check that we can both enable and disable LPM.
3499 * Device must be configured to accept set feature U1/U2 timeout.
3501 if (!hcd
|| !hcd
->driver
->enable_usb3_lpm_timeout
||
3502 !hcd
->driver
->disable_usb3_lpm_timeout
)
3505 if (udev
->lpm_disable_count
> 0)
3508 usb_enable_link_state(hcd
, udev
, USB3_LPM_U1
);
3509 usb_enable_link_state(hcd
, udev
, USB3_LPM_U2
);
3511 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3513 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3514 void usb_unlocked_enable_lpm(struct usb_device
*udev
)
3516 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3521 mutex_lock(hcd
->bandwidth_mutex
);
3522 usb_enable_lpm(udev
);
3523 mutex_unlock(hcd
->bandwidth_mutex
);
3525 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3528 #else /* CONFIG_PM */
3530 #define hub_suspend NULL
3531 #define hub_resume NULL
3532 #define hub_reset_resume NULL
3534 int usb_disable_lpm(struct usb_device
*udev
)
3538 EXPORT_SYMBOL_GPL(usb_disable_lpm
);
3540 void usb_enable_lpm(struct usb_device
*udev
) { }
3541 EXPORT_SYMBOL_GPL(usb_enable_lpm
);
3543 int usb_unlocked_disable_lpm(struct usb_device
*udev
)
3547 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm
);
3549 void usb_unlocked_enable_lpm(struct usb_device
*udev
) { }
3550 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm
);
3552 int usb_disable_ltm(struct usb_device
*udev
)
3556 EXPORT_SYMBOL_GPL(usb_disable_ltm
);
3558 void usb_enable_ltm(struct usb_device
*udev
) { }
3559 EXPORT_SYMBOL_GPL(usb_enable_ltm
);
3563 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3565 * Between connect detection and reset signaling there must be a delay
3566 * of 100ms at least for debounce and power-settling. The corresponding
3567 * timer shall restart whenever the downstream port detects a disconnect.
3569 * Apparently there are some bluetooth and irda-dongles and a number of
3570 * low-speed devices for which this debounce period may last over a second.
3571 * Not covered by the spec - but easy to deal with.
3573 * This implementation uses a 1500ms total debounce timeout; if the
3574 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3575 * every 25ms for transient disconnects. When the port status has been
3576 * unchanged for 100ms it returns the port status.
3578 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
3581 int total_time
, stable_time
= 0;
3582 u16 portchange
, portstatus
;
3583 unsigned connection
= 0xffff;
3585 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
3586 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
3590 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
3591 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
3592 stable_time
+= HUB_DEBOUNCE_STEP
;
3593 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
3597 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
3600 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
3601 clear_port_feature(hub
->hdev
, port1
,
3602 USB_PORT_FEAT_C_CONNECTION
);
3605 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
3607 msleep(HUB_DEBOUNCE_STEP
);
3610 dev_dbg (hub
->intfdev
,
3611 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3612 port1
, total_time
, stable_time
, portstatus
);
3614 if (stable_time
< HUB_DEBOUNCE_STABLE
)
3619 void usb_ep0_reinit(struct usb_device
*udev
)
3621 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
, true);
3622 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
, true);
3623 usb_enable_endpoint(udev
, &udev
->ep0
, true);
3625 EXPORT_SYMBOL_GPL(usb_ep0_reinit
);
3627 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3628 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3630 static int hub_set_address(struct usb_device
*udev
, int devnum
)
3633 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
3636 * The host controller will choose the device address,
3637 * instead of the core having chosen it earlier
3639 if (!hcd
->driver
->address_device
&& devnum
<= 1)
3641 if (udev
->state
== USB_STATE_ADDRESS
)
3643 if (udev
->state
!= USB_STATE_DEFAULT
)
3645 if (hcd
->driver
->address_device
)
3646 retval
= hcd
->driver
->address_device(hcd
, udev
);
3648 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
3649 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
3650 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3652 update_devnum(udev
, devnum
);
3653 /* Device now using proper address. */
3654 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
3655 usb_ep0_reinit(udev
);
3660 /* Reset device, (re)assign address, get device descriptor.
3661 * Device connection must be stable, no more debouncing needed.
3662 * Returns device in USB_STATE_ADDRESS, except on error.
3664 * If this is called for an already-existing device (as part of
3665 * usb_reset_and_verify_device), the caller must own the device lock. For a
3666 * newly detected device that is not accessible through any global
3667 * pointers, it's not necessary to lock the device.
3670 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
3673 static DEFINE_MUTEX(usb_address0_mutex
);
3675 struct usb_device
*hdev
= hub
->hdev
;
3676 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
3678 unsigned delay
= HUB_SHORT_RESET_TIME
;
3679 enum usb_device_speed oldspeed
= udev
->speed
;
3681 int devnum
= udev
->devnum
;
3683 /* root hub ports have a slightly longer reset period
3684 * (from USB 2.0 spec, section 7.1.7.5)
3686 if (!hdev
->parent
) {
3687 delay
= HUB_ROOT_RESET_TIME
;
3688 if (port1
== hdev
->bus
->otg_port
)
3689 hdev
->bus
->b_hnp_enable
= 0;
3692 /* Some low speed devices have problems with the quick delay, so */
3693 /* be a bit pessimistic with those devices. RHbug #23670 */
3694 if (oldspeed
== USB_SPEED_LOW
)
3695 delay
= HUB_LONG_RESET_TIME
;
3697 mutex_lock(&usb_address0_mutex
);
3699 /* Reset the device; full speed may morph to high speed */
3700 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3701 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
3702 if (retval
< 0) /* error or disconnect */
3704 /* success, speed is known */
3708 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
3709 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
3712 oldspeed
= udev
->speed
;
3714 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3715 * it's fixed size except for full speed devices.
3716 * For Wireless USB devices, ep0 max packet is always 512 (tho
3717 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3719 switch (udev
->speed
) {
3720 case USB_SPEED_SUPER
:
3721 case USB_SPEED_WIRELESS
: /* fixed at 512 */
3722 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(512);
3724 case USB_SPEED_HIGH
: /* fixed at 64 */
3725 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
3727 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
3728 /* to determine the ep0 maxpacket size, try to read
3729 * the device descriptor to get bMaxPacketSize0 and
3730 * then correct our initial guess.
3732 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(64);
3734 case USB_SPEED_LOW
: /* fixed at 8 */
3735 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(8);
3741 if (udev
->speed
== USB_SPEED_WIRELESS
)
3742 speed
= "variable speed Wireless";
3744 speed
= usb_speed_string(udev
->speed
);
3746 if (udev
->speed
!= USB_SPEED_SUPER
)
3747 dev_info(&udev
->dev
,
3748 "%s %s USB device number %d using %s\n",
3749 (udev
->config
) ? "reset" : "new", speed
,
3750 devnum
, udev
->bus
->controller
->driver
->name
);
3752 /* Set up TT records, if needed */
3754 udev
->tt
= hdev
->tt
;
3755 udev
->ttport
= hdev
->ttport
;
3756 } else if (udev
->speed
!= USB_SPEED_HIGH
3757 && hdev
->speed
== USB_SPEED_HIGH
) {
3759 dev_err(&udev
->dev
, "parent hub has no TT\n");
3763 udev
->tt
= &hub
->tt
;
3764 udev
->ttport
= port1
;
3767 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3768 * Because device hardware and firmware is sometimes buggy in
3769 * this area, and this is how Linux has done it for ages.
3770 * Change it cautiously.
3772 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3773 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3774 * so it may help with some non-standards-compliant devices.
3775 * Otherwise we start with SET_ADDRESS and then try to read the
3776 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3779 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
3780 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
)) {
3781 struct usb_device_descriptor
*buf
;
3784 #define GET_DESCRIPTOR_BUFSIZE 64
3785 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
3791 /* Retry on all errors; some devices are flakey.
3792 * 255 is for WUSB devices, we actually need to use
3793 * 512 (WUSB1.0[4.8.1]).
3795 for (j
= 0; j
< 3; ++j
) {
3796 buf
->bMaxPacketSize0
= 0;
3797 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
3798 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
3799 USB_DT_DEVICE
<< 8, 0,
3800 buf
, GET_DESCRIPTOR_BUFSIZE
,
3801 initial_descriptor_timeout
);
3802 switch (buf
->bMaxPacketSize0
) {
3803 case 8: case 16: case 32: case 64: case 255:
3804 if (buf
->bDescriptorType
==
3818 udev
->descriptor
.bMaxPacketSize0
=
3819 buf
->bMaxPacketSize0
;
3822 retval
= hub_port_reset(hub
, port1
, udev
, delay
, false);
3823 if (retval
< 0) /* error or disconnect */
3825 if (oldspeed
!= udev
->speed
) {
3827 "device reset changed speed!\n");
3833 "device descriptor read/64, error %d\n",
3838 #undef GET_DESCRIPTOR_BUFSIZE
3842 * If device is WUSB, we already assigned an
3843 * unauthorized address in the Connect Ack sequence;
3844 * authorization will assign the final address.
3846 if (udev
->wusb
== 0) {
3847 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
3848 retval
= hub_set_address(udev
, devnum
);
3855 "device not accepting address %d, error %d\n",
3859 if (udev
->speed
== USB_SPEED_SUPER
) {
3860 devnum
= udev
->devnum
;
3861 dev_info(&udev
->dev
,
3862 "%s SuperSpeed USB device number %d using %s\n",
3863 (udev
->config
) ? "reset" : "new",
3864 devnum
, udev
->bus
->controller
->driver
->name
);
3867 /* cope with hardware quirkiness:
3868 * - let SET_ADDRESS settle, some device hardware wants it
3869 * - read ep0 maxpacket even for high and low speed,
3872 if (USE_NEW_SCHEME(retry_counter
) && !(hcd
->driver
->flags
& HCD_USB3
))
3876 retval
= usb_get_device_descriptor(udev
, 8);
3879 "device descriptor read/8, error %d\n",
3892 * Some superspeed devices have finished the link training process
3893 * and attached to a superspeed hub port, but the device descriptor
3894 * got from those devices show they aren't superspeed devices. Warm
3895 * reset the port attached by the devices can fix them.
3897 if ((udev
->speed
== USB_SPEED_SUPER
) &&
3898 (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0300)) {
3899 dev_err(&udev
->dev
, "got a wrong device descriptor, "
3900 "warm reset device\n");
3901 hub_port_reset(hub
, port1
, udev
,
3902 HUB_BH_RESET_TIME
, true);
3907 if (udev
->descriptor
.bMaxPacketSize0
== 0xff ||
3908 udev
->speed
== USB_SPEED_SUPER
)
3911 i
= udev
->descriptor
.bMaxPacketSize0
;
3912 if (usb_endpoint_maxp(&udev
->ep0
.desc
) != i
) {
3913 if (udev
->speed
== USB_SPEED_LOW
||
3914 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
3915 dev_err(&udev
->dev
, "Invalid ep0 maxpacket: %d\n", i
);
3919 if (udev
->speed
== USB_SPEED_FULL
)
3920 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
3922 dev_warn(&udev
->dev
, "Using ep0 maxpacket: %d\n", i
);
3923 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
3924 usb_ep0_reinit(udev
);
3927 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
3928 if (retval
< (signed)sizeof(udev
->descriptor
)) {
3929 dev_err(&udev
->dev
, "device descriptor read/all, error %d\n",
3936 if (udev
->wusb
== 0 && le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0201) {
3937 retval
= usb_get_bos_descriptor(udev
);
3939 udev
->lpm_capable
= usb_device_supports_lpm(udev
);
3940 usb_set_lpm_parameters(udev
);
3945 /* notify HCD that we have a device connected and addressed */
3946 if (hcd
->driver
->update_device
)
3947 hcd
->driver
->update_device(hcd
, udev
);
3950 hub_port_disable(hub
, port1
, 0);
3951 update_devnum(udev
, devnum
); /* for disconnect processing */
3953 mutex_unlock(&usb_address0_mutex
);
3958 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
3960 struct usb_qualifier_descriptor
*qual
;
3963 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
3967 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
3968 qual
, sizeof *qual
);
3969 if (status
== sizeof *qual
) {
3970 dev_info(&udev
->dev
, "not running at top speed; "
3971 "connect to a high speed hub\n");
3972 /* hub LEDs are probably harder to miss than syslog */
3973 if (hub
->has_indicators
) {
3974 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
3975 schedule_delayed_work (&hub
->leds
, 0);
3982 hub_power_remaining (struct usb_hub
*hub
)
3984 struct usb_device
*hdev
= hub
->hdev
;
3988 if (!hub
->limited_power
)
3991 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
3992 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
3993 struct usb_device
*udev
= hdev
->children
[port1
- 1];
3999 /* Unconfigured devices may not use more than 100mA,
4000 * or 8mA for OTG ports */
4001 if (udev
->actconfig
)
4002 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
4003 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
4007 if (delta
> hub
->mA_per_port
)
4008 dev_warn(&udev
->dev
,
4009 "%dmA is over %umA budget for port %d!\n",
4010 delta
, hub
->mA_per_port
, port1
);
4013 if (remaining
< 0) {
4014 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
4021 /* Handle physical or logical connection change events.
4022 * This routine is called when:
4023 * a port connection-change occurs;
4024 * a port enable-change occurs (often caused by EMI);
4025 * usb_reset_and_verify_device() encounters changed descriptors (as from
4026 * a firmware download)
4027 * caller already locked the hub
4029 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
4030 u16 portstatus
, u16 portchange
)
4032 struct usb_device
*hdev
= hub
->hdev
;
4033 struct device
*hub_dev
= hub
->intfdev
;
4034 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
4035 unsigned wHubCharacteristics
=
4036 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
4037 struct usb_device
*udev
;
4041 "port %d, status %04x, change %04x, %s\n",
4042 port1
, portstatus
, portchange
, portspeed(hub
, portstatus
));
4044 if (hub
->has_indicators
) {
4045 set_port_led(hub
, port1
, HUB_LED_AUTO
);
4046 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
4049 #ifdef CONFIG_USB_OTG
4050 /* during HNP, don't repeat the debounce */
4051 if (hdev
->bus
->is_b_host
)
4052 portchange
&= ~(USB_PORT_STAT_C_CONNECTION
|
4053 USB_PORT_STAT_C_ENABLE
);
4056 /* Try to resuscitate an existing device */
4057 udev
= hdev
->children
[port1
-1];
4058 if ((portstatus
& USB_PORT_STAT_CONNECTION
) && udev
&&
4059 udev
->state
!= USB_STATE_NOTATTACHED
) {
4060 usb_lock_device(udev
);
4061 if (portstatus
& USB_PORT_STAT_ENABLE
) {
4062 status
= 0; /* Nothing to do */
4064 #ifdef CONFIG_USB_SUSPEND
4065 } else if (udev
->state
== USB_STATE_SUSPENDED
&&
4066 udev
->persist_enabled
) {
4067 /* For a suspended device, treat this as a
4068 * remote wakeup event.
4070 status
= usb_remote_wakeup(udev
);
4074 status
= -ENODEV
; /* Don't resuscitate */
4076 usb_unlock_device(udev
);
4079 clear_bit(port1
, hub
->change_bits
);
4084 /* Disconnect any existing devices under this port */
4086 usb_disconnect(&hdev
->children
[port1
-1]);
4087 clear_bit(port1
, hub
->change_bits
);
4089 /* We can forget about a "removed" device when there's a physical
4090 * disconnect or the connect status changes.
4092 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4093 (portchange
& USB_PORT_STAT_C_CONNECTION
))
4094 clear_bit(port1
, hub
->removed_bits
);
4096 if (portchange
& (USB_PORT_STAT_C_CONNECTION
|
4097 USB_PORT_STAT_C_ENABLE
)) {
4098 status
= hub_port_debounce(hub
, port1
);
4100 if (printk_ratelimit())
4101 dev_err(hub_dev
, "connect-debounce failed, "
4102 "port %d disabled\n", port1
);
4103 portstatus
&= ~USB_PORT_STAT_CONNECTION
;
4105 portstatus
= status
;
4109 if (hcd
->phy
&& !hdev
->parent
) {
4110 if (portstatus
& USB_PORT_STAT_CONNECTION
)
4111 usb_phy_notify_connect(hcd
->phy
, port1
);
4113 usb_phy_notify_disconnect(hcd
->phy
, port1
);
4116 /* Return now if debouncing failed or nothing is connected or
4117 * the device was "removed".
4119 if (!(portstatus
& USB_PORT_STAT_CONNECTION
) ||
4120 test_bit(port1
, hub
->removed_bits
)) {
4122 /* maybe switch power back on (e.g. root hub was reset) */
4123 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
4124 && !port_is_power_on(hub
, portstatus
))
4125 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
4127 if (portstatus
& USB_PORT_STAT_ENABLE
)
4132 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
4134 /* reallocate for each attempt, since references
4135 * to the previous one can escape in various ways
4137 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
4140 "couldn't allocate port %d usb_device\n",
4145 usb_set_device_state(udev
, USB_STATE_POWERED
);
4146 udev
->bus_mA
= hub
->mA_per_port
;
4147 udev
->level
= hdev
->level
+ 1;
4148 udev
->wusb
= hub_is_wusb(hub
);
4150 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4151 if (hub_is_superspeed(hub
->hdev
))
4152 udev
->speed
= USB_SPEED_SUPER
;
4154 udev
->speed
= USB_SPEED_UNKNOWN
;
4156 choose_devnum(udev
);
4157 if (udev
->devnum
<= 0) {
4158 status
= -ENOTCONN
; /* Don't retry */
4162 /* reset (non-USB 3.0 devices) and get descriptor */
4163 status
= hub_port_init(hub
, udev
, port1
, i
);
4167 usb_detect_quirks(udev
);
4168 if (udev
->quirks
& USB_QUIRK_DELAY_INIT
)
4171 /* consecutive bus-powered hubs aren't reliable; they can
4172 * violate the voltage drop budget. if the new child has
4173 * a "powered" LED, users should notice we didn't enable it
4174 * (without reading syslog), even without per-port LEDs
4177 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
4178 && udev
->bus_mA
<= 100) {
4181 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
4184 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
4187 le16_to_cpus(&devstat
);
4188 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
4190 "can't connect bus-powered hub "
4192 if (hub
->has_indicators
) {
4193 hub
->indicator
[port1
-1] =
4194 INDICATOR_AMBER_BLINK
;
4195 schedule_delayed_work (&hub
->leds
, 0);
4197 status
= -ENOTCONN
; /* Don't retry */
4202 /* check for devices running slower than they could */
4203 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
4204 && udev
->speed
== USB_SPEED_FULL
4205 && highspeed_hubs
!= 0)
4206 check_highspeed (hub
, udev
, port1
);
4208 /* Store the parent's children[] pointer. At this point
4209 * udev becomes globally accessible, although presumably
4210 * no one will look at it until hdev is unlocked.
4214 /* We mustn't add new devices if the parent hub has
4215 * been disconnected; we would race with the
4216 * recursively_mark_NOTATTACHED() routine.
4218 spin_lock_irq(&device_state_lock
);
4219 if (hdev
->state
== USB_STATE_NOTATTACHED
)
4222 hdev
->children
[port1
-1] = udev
;
4223 spin_unlock_irq(&device_state_lock
);
4225 /* Run it through the hoops (find a driver, etc) */
4227 status
= usb_new_device(udev
);
4229 spin_lock_irq(&device_state_lock
);
4230 hdev
->children
[port1
-1] = NULL
;
4231 spin_unlock_irq(&device_state_lock
);
4238 status
= hub_power_remaining(hub
);
4240 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
4245 hub_port_disable(hub
, port1
, 1);
4247 usb_ep0_reinit(udev
);
4248 release_devnum(udev
);
4251 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
4254 if (hub
->hdev
->parent
||
4255 !hcd
->driver
->port_handed_over
||
4256 !(hcd
->driver
->port_handed_over
)(hcd
, port1
))
4257 dev_err(hub_dev
, "unable to enumerate USB device on port %d\n",
4261 hub_port_disable(hub
, port1
, 1);
4262 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
4263 hcd
->driver
->relinquish_port(hcd
, port1
);
4266 /* Returns 1 if there was a remote wakeup and a connect status change. */
4267 static int hub_handle_remote_wakeup(struct usb_hub
*hub
, unsigned int port
,
4268 u16 portstatus
, u16 portchange
)
4270 struct usb_device
*hdev
;
4271 struct usb_device
*udev
;
4272 int connect_change
= 0;
4276 udev
= hdev
->children
[port
-1];
4277 if (!hub_is_superspeed(hdev
)) {
4278 if (!(portchange
& USB_PORT_STAT_C_SUSPEND
))
4280 clear_port_feature(hdev
, port
, USB_PORT_FEAT_C_SUSPEND
);
4282 if (!udev
|| udev
->state
!= USB_STATE_SUSPENDED
||
4283 (portstatus
& USB_PORT_STAT_LINK_STATE
) !=
4289 /* TRSMRCY = 10 msec */
4292 usb_lock_device(udev
);
4293 ret
= usb_remote_wakeup(udev
);
4294 usb_unlock_device(udev
);
4299 hub_port_disable(hub
, port
, 1);
4301 dev_dbg(hub
->intfdev
, "resume on port %d, status %d\n",
4303 return connect_change
;
4306 static void hub_events(void)
4308 struct list_head
*tmp
;
4309 struct usb_device
*hdev
;
4310 struct usb_interface
*intf
;
4311 struct usb_hub
*hub
;
4312 struct device
*hub_dev
;
4318 int connect_change
, wakeup_change
;
4321 * We restart the list every time to avoid a deadlock with
4322 * deleting hubs downstream from this one. This should be
4323 * safe since we delete the hub from the event list.
4324 * Not the most efficient, but avoids deadlocks.
4328 /* Grab the first entry at the beginning of the list */
4329 spin_lock_irq(&hub_event_lock
);
4330 if (list_empty(&hub_event_list
)) {
4331 spin_unlock_irq(&hub_event_lock
);
4335 tmp
= hub_event_list
.next
;
4338 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
4339 kref_get(&hub
->kref
);
4340 spin_unlock_irq(&hub_event_lock
);
4343 hub_dev
= hub
->intfdev
;
4344 intf
= to_usb_interface(hub_dev
);
4345 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
4346 hdev
->state
, hub
->descriptor
4347 ? hub
->descriptor
->bNbrPorts
4349 /* NOTE: expects max 15 ports... */
4350 (u16
) hub
->change_bits
[0],
4351 (u16
) hub
->event_bits
[0]);
4353 /* Lock the device, then check to see if we were
4354 * disconnected while waiting for the lock to succeed. */
4355 usb_lock_device(hdev
);
4356 if (unlikely(hub
->disconnected
))
4357 goto loop_disconnected
;
4359 /* If the hub has died, clean up after it */
4360 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
4361 hub
->error
= -ENODEV
;
4362 hub_quiesce(hub
, HUB_DISCONNECT
);
4367 ret
= usb_autopm_get_interface(intf
);
4369 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
4373 /* If this is an inactive hub, do nothing */
4378 dev_dbg (hub_dev
, "resetting for error %d\n",
4381 ret
= usb_reset_device(hdev
);
4384 "error resetting hub: %d\n", ret
);
4392 /* deal with port status changes */
4393 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
4394 if (test_bit(i
, hub
->busy_bits
))
4396 connect_change
= test_bit(i
, hub
->change_bits
);
4397 wakeup_change
= test_and_clear_bit(i
, hub
->wakeup_bits
);
4398 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
4399 !connect_change
&& !wakeup_change
)
4402 ret
= hub_port_status(hub
, i
,
4403 &portstatus
, &portchange
);
4407 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
4408 clear_port_feature(hdev
, i
,
4409 USB_PORT_FEAT_C_CONNECTION
);
4413 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
4414 if (!connect_change
)
4416 "port %d enable change, "
4419 clear_port_feature(hdev
, i
,
4420 USB_PORT_FEAT_C_ENABLE
);
4423 * EM interference sometimes causes badly
4424 * shielded USB devices to be shutdown by
4425 * the hub, this hack enables them again.
4426 * Works at least with mouse driver.
4428 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
4430 && hdev
->children
[i
-1]) {
4433 "disabled by hub (EMI?), "
4440 if (hub_handle_remote_wakeup(hub
, i
,
4441 portstatus
, portchange
))
4444 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
4448 dev_dbg(hub_dev
, "over-current change on port "
4450 clear_port_feature(hdev
, i
,
4451 USB_PORT_FEAT_C_OVER_CURRENT
);
4452 msleep(100); /* Cool down */
4453 hub_power_on(hub
, true);
4454 hub_port_status(hub
, i
, &status
, &unused
);
4455 if (status
& USB_PORT_STAT_OVERCURRENT
)
4456 dev_err(hub_dev
, "over-current "
4457 "condition on port %d\n", i
);
4460 if (portchange
& USB_PORT_STAT_C_RESET
) {
4462 "reset change on port %d\n",
4464 clear_port_feature(hdev
, i
,
4465 USB_PORT_FEAT_C_RESET
);
4467 if ((portchange
& USB_PORT_STAT_C_BH_RESET
) &&
4468 hub_is_superspeed(hub
->hdev
)) {
4470 "warm reset change on port %d\n",
4472 clear_port_feature(hdev
, i
,
4473 USB_PORT_FEAT_C_BH_PORT_RESET
);
4475 if (portchange
& USB_PORT_STAT_C_LINK_STATE
) {
4476 clear_port_feature(hub
->hdev
, i
,
4477 USB_PORT_FEAT_C_PORT_LINK_STATE
);
4479 if (portchange
& USB_PORT_STAT_C_CONFIG_ERROR
) {
4481 "config error on port %d\n",
4483 clear_port_feature(hub
->hdev
, i
,
4484 USB_PORT_FEAT_C_PORT_CONFIG_ERROR
);
4487 /* Warm reset a USB3 protocol port if it's in
4488 * SS.Inactive state.
4490 if (hub_port_warm_reset_required(hub
, portstatus
)) {
4491 dev_dbg(hub_dev
, "warm reset port %d\n", i
);
4492 hub_port_reset(hub
, i
, NULL
,
4493 HUB_BH_RESET_TIME
, true);
4497 hub_port_connect_change(hub
, i
,
4498 portstatus
, portchange
);
4501 /* deal with hub status changes */
4502 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
4504 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
4505 dev_err (hub_dev
, "get_hub_status failed\n");
4507 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
4508 dev_dbg (hub_dev
, "power change\n");
4509 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
4510 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
4511 /* FIXME: Is this always true? */
4512 hub
->limited_power
= 1;
4514 hub
->limited_power
= 0;
4516 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
4520 dev_dbg(hub_dev
, "over-current change\n");
4521 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
4522 msleep(500); /* Cool down */
4523 hub_power_on(hub
, true);
4524 hub_hub_status(hub
, &status
, &unused
);
4525 if (status
& HUB_STATUS_OVERCURRENT
)
4526 dev_err(hub_dev
, "over-current "
4532 /* Balance the usb_autopm_get_interface() above */
4533 usb_autopm_put_interface_no_suspend(intf
);
4535 /* Balance the usb_autopm_get_interface_no_resume() in
4536 * kick_khubd() and allow autosuspend.
4538 usb_autopm_put_interface(intf
);
4540 usb_unlock_device(hdev
);
4541 kref_put(&hub
->kref
, hub_release
);
4543 } /* end while (1) */
4546 static int hub_thread(void *__unused
)
4548 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4549 * port handover. Otherwise it might see that a full-speed device
4550 * was gone before the EHCI controller had handed its port over to
4551 * the companion full-speed controller.
4557 wait_event_freezable(khubd_wait
,
4558 !list_empty(&hub_event_list
) ||
4559 kthread_should_stop());
4560 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
4562 pr_debug("%s: khubd exiting\n", usbcore_name
);
4566 static const struct usb_device_id hub_id_table
[] = {
4567 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
4568 .bDeviceClass
= USB_CLASS_HUB
},
4569 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
4570 .bInterfaceClass
= USB_CLASS_HUB
},
4571 { } /* Terminating entry */
4574 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
4576 static struct usb_driver hub_driver
= {
4579 .disconnect
= hub_disconnect
,
4580 .suspend
= hub_suspend
,
4581 .resume
= hub_resume
,
4582 .reset_resume
= hub_reset_resume
,
4583 .pre_reset
= hub_pre_reset
,
4584 .post_reset
= hub_post_reset
,
4585 .unlocked_ioctl
= hub_ioctl
,
4586 .id_table
= hub_id_table
,
4587 .supports_autosuspend
= 1,
4590 int usb_hub_init(void)
4592 if (usb_register(&hub_driver
) < 0) {
4593 printk(KERN_ERR
"%s: can't register hub driver\n",
4598 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
4599 if (!IS_ERR(khubd_task
))
4602 /* Fall through if kernel_thread failed */
4603 usb_deregister(&hub_driver
);
4604 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
4609 void usb_hub_cleanup(void)
4611 kthread_stop(khubd_task
);
4614 * Hub resources are freed for us by usb_deregister. It calls
4615 * usb_driver_purge on every device which in turn calls that
4616 * devices disconnect function if it is using this driver.
4617 * The hub_disconnect function takes care of releasing the
4618 * individual hub resources. -greg
4620 usb_deregister(&hub_driver
);
4621 } /* usb_hub_cleanup() */
4623 static int descriptors_changed(struct usb_device
*udev
,
4624 struct usb_device_descriptor
*old_device_descriptor
)
4628 unsigned serial_len
= 0;
4630 unsigned old_length
;
4634 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
4635 sizeof(*old_device_descriptor
)) != 0)
4638 /* Since the idVendor, idProduct, and bcdDevice values in the
4639 * device descriptor haven't changed, we will assume the
4640 * Manufacturer and Product strings haven't changed either.
4641 * But the SerialNumber string could be different (e.g., a
4642 * different flash card of the same brand).
4645 serial_len
= strlen(udev
->serial
) + 1;
4648 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4649 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4650 len
= max(len
, old_length
);
4653 buf
= kmalloc(len
, GFP_NOIO
);
4655 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
4656 /* assume the worst */
4659 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
4660 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
4661 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
4663 if (length
!= old_length
) {
4664 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
4669 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
4671 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
4673 ((struct usb_config_descriptor
*) buf
)->
4674 bConfigurationValue
);
4680 if (!changed
&& serial_len
) {
4681 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
4683 if (length
+ 1 != serial_len
) {
4684 dev_dbg(&udev
->dev
, "serial string error %d\n",
4687 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
4688 dev_dbg(&udev
->dev
, "serial string changed\n");
4698 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4699 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4701 * WARNING - don't use this routine to reset a composite device
4702 * (one with multiple interfaces owned by separate drivers)!
4703 * Use usb_reset_device() instead.
4705 * Do a port reset, reassign the device's address, and establish its
4706 * former operating configuration. If the reset fails, or the device's
4707 * descriptors change from their values before the reset, or the original
4708 * configuration and altsettings cannot be restored, a flag will be set
4709 * telling khubd to pretend the device has been disconnected and then
4710 * re-connected. All drivers will be unbound, and the device will be
4711 * re-enumerated and probed all over again.
4713 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4714 * flagged for logical disconnection, or some other negative error code
4715 * if the reset wasn't even attempted.
4717 * The caller must own the device lock. For example, it's safe to use
4718 * this from a driver probe() routine after downloading new firmware.
4719 * For calls that might not occur during probe(), drivers should lock
4720 * the device using usb_lock_device_for_reset().
4722 * Locking exception: This routine may also be called from within an
4723 * autoresume handler. Such usage won't conflict with other tasks
4724 * holding the device lock because these tasks should always call
4725 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4727 static int usb_reset_and_verify_device(struct usb_device
*udev
)
4729 struct usb_device
*parent_hdev
= udev
->parent
;
4730 struct usb_hub
*parent_hub
;
4731 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
4732 struct usb_device_descriptor descriptor
= udev
->descriptor
;
4734 int port1
= udev
->portnum
;
4736 if (udev
->state
== USB_STATE_NOTATTACHED
||
4737 udev
->state
== USB_STATE_SUSPENDED
) {
4738 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
4744 /* this requires hcd-specific logic; see ohci_restart() */
4745 dev_dbg(&udev
->dev
, "%s for root hub!\n", __func__
);
4748 parent_hub
= hdev_to_hub(parent_hdev
);
4750 /* Disable LPM and LTM while we reset the device and reinstall the alt
4751 * settings. Device-initiated LPM settings, and system exit latency
4752 * settings are cleared when the device is reset, so we have to set
4755 ret
= usb_unlocked_disable_lpm(udev
);
4757 dev_err(&udev
->dev
, "%s Failed to disable LPM\n.", __func__
);
4760 ret
= usb_disable_ltm(udev
);
4762 dev_err(&udev
->dev
, "%s Failed to disable LTM\n.",
4767 set_bit(port1
, parent_hub
->busy_bits
);
4768 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
4770 /* ep0 maxpacket size may change; let the HCD know about it.
4771 * Other endpoints will be handled by re-enumeration. */
4772 usb_ep0_reinit(udev
);
4773 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
4774 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
4777 clear_bit(port1
, parent_hub
->busy_bits
);
4782 /* Device might have changed firmware (DFU or similar) */
4783 if (descriptors_changed(udev
, &descriptor
)) {
4784 dev_info(&udev
->dev
, "device firmware changed\n");
4785 udev
->descriptor
= descriptor
; /* for disconnect() calls */
4789 /* Restore the device's previous configuration */
4790 if (!udev
->actconfig
)
4793 mutex_lock(hcd
->bandwidth_mutex
);
4794 ret
= usb_hcd_alloc_bandwidth(udev
, udev
->actconfig
, NULL
, NULL
);
4796 dev_warn(&udev
->dev
,
4797 "Busted HC? Not enough HCD resources for "
4798 "old configuration.\n");
4799 mutex_unlock(hcd
->bandwidth_mutex
);
4802 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
4803 USB_REQ_SET_CONFIGURATION
, 0,
4804 udev
->actconfig
->desc
.bConfigurationValue
, 0,
4805 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
4808 "can't restore configuration #%d (error=%d)\n",
4809 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
4810 mutex_unlock(hcd
->bandwidth_mutex
);
4813 mutex_unlock(hcd
->bandwidth_mutex
);
4814 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
4816 /* Put interfaces back into the same altsettings as before.
4817 * Don't bother to send the Set-Interface request for interfaces
4818 * that were already in altsetting 0; besides being unnecessary,
4819 * many devices can't handle it. Instead just reset the host-side
4822 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
4823 struct usb_host_config
*config
= udev
->actconfig
;
4824 struct usb_interface
*intf
= config
->interface
[i
];
4825 struct usb_interface_descriptor
*desc
;
4827 desc
= &intf
->cur_altsetting
->desc
;
4828 if (desc
->bAlternateSetting
== 0) {
4829 usb_disable_interface(udev
, intf
, true);
4830 usb_enable_interface(udev
, intf
, true);
4833 /* Let the bandwidth allocation function know that this
4834 * device has been reset, and it will have to use
4835 * alternate setting 0 as the current alternate setting.
4837 intf
->resetting_device
= 1;
4838 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
4839 desc
->bAlternateSetting
);
4840 intf
->resetting_device
= 0;
4843 dev_err(&udev
->dev
, "failed to restore interface %d "
4844 "altsetting %d (error=%d)\n",
4845 desc
->bInterfaceNumber
,
4846 desc
->bAlternateSetting
,
4853 /* Now that the alt settings are re-installed, enable LTM and LPM. */
4854 usb_unlocked_enable_lpm(udev
);
4855 usb_enable_ltm(udev
);
4859 /* LPM state doesn't matter when we're about to destroy the device. */
4860 hub_port_logical_disconnect(parent_hub
, port1
);
4865 * usb_reset_device - warn interface drivers and perform a USB port reset
4866 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4868 * Warns all drivers bound to registered interfaces (using their pre_reset
4869 * method), performs the port reset, and then lets the drivers know that
4870 * the reset is over (using their post_reset method).
4872 * Return value is the same as for usb_reset_and_verify_device().
4874 * The caller must own the device lock. For example, it's safe to use
4875 * this from a driver probe() routine after downloading new firmware.
4876 * For calls that might not occur during probe(), drivers should lock
4877 * the device using usb_lock_device_for_reset().
4879 * If an interface is currently being probed or disconnected, we assume
4880 * its driver knows how to handle resets. For all other interfaces,
4881 * if the driver doesn't have pre_reset and post_reset methods then
4882 * we attempt to unbind it and rebind afterward.
4884 int usb_reset_device(struct usb_device
*udev
)
4888 struct usb_host_config
*config
= udev
->actconfig
;
4890 if (udev
->state
== USB_STATE_NOTATTACHED
||
4891 udev
->state
== USB_STATE_SUSPENDED
) {
4892 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
4897 /* Prevent autosuspend during the reset */
4898 usb_autoresume_device(udev
);
4901 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
4902 struct usb_interface
*cintf
= config
->interface
[i
];
4903 struct usb_driver
*drv
;
4906 if (cintf
->dev
.driver
) {
4907 drv
= to_usb_driver(cintf
->dev
.driver
);
4908 if (drv
->pre_reset
&& drv
->post_reset
)
4909 unbind
= (drv
->pre_reset
)(cintf
);
4910 else if (cintf
->condition
==
4911 USB_INTERFACE_BOUND
)
4914 usb_forced_unbind_intf(cintf
);
4919 ret
= usb_reset_and_verify_device(udev
);
4922 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
4923 struct usb_interface
*cintf
= config
->interface
[i
];
4924 struct usb_driver
*drv
;
4925 int rebind
= cintf
->needs_binding
;
4927 if (!rebind
&& cintf
->dev
.driver
) {
4928 drv
= to_usb_driver(cintf
->dev
.driver
);
4929 if (drv
->post_reset
)
4930 rebind
= (drv
->post_reset
)(cintf
);
4931 else if (cintf
->condition
==
4932 USB_INTERFACE_BOUND
)
4935 if (ret
== 0 && rebind
)
4936 usb_rebind_intf(cintf
);
4940 usb_autosuspend_device(udev
);
4943 EXPORT_SYMBOL_GPL(usb_reset_device
);
4947 * usb_queue_reset_device - Reset a USB device from an atomic context
4948 * @iface: USB interface belonging to the device to reset
4950 * This function can be used to reset a USB device from an atomic
4951 * context, where usb_reset_device() won't work (as it blocks).
4953 * Doing a reset via this method is functionally equivalent to calling
4954 * usb_reset_device(), except for the fact that it is delayed to a
4955 * workqueue. This means that any drivers bound to other interfaces
4956 * might be unbound, as well as users from usbfs in user space.
4960 * - Scheduling two resets at the same time from two different drivers
4961 * attached to two different interfaces of the same device is
4962 * possible; depending on how the driver attached to each interface
4963 * handles ->pre_reset(), the second reset might happen or not.
4965 * - If a driver is unbound and it had a pending reset, the reset will
4968 * - This function can be called during .probe() or .disconnect()
4969 * times. On return from .disconnect(), any pending resets will be
4972 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4975 * NOTE: We don't do any reference count tracking because it is not
4976 * needed. The lifecycle of the work_struct is tied to the
4977 * usb_interface. Before destroying the interface we cancel the
4978 * work_struct, so the fact that work_struct is queued and or
4979 * running means the interface (and thus, the device) exist and
4982 void usb_queue_reset_device(struct usb_interface
*iface
)
4984 schedule_work(&iface
->reset_ws
);
4986 EXPORT_SYMBOL_GPL(usb_queue_reset_device
);