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/workqueue.h>
26 #include <linux/mutex.h>
27 #include <linux/random.h>
28 #include <linux/pm_qos.h>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
34 #include "otg_whitelist.h"
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->dev.sem, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock);
44 /* workqueue to process hub events */
45 static struct workqueue_struct *hub_wq;
46 static void hub_event(struct work_struct *work);
48 /* synchronize hub-port add/remove and peering operations */
49 DEFINE_MUTEX(usb_port_peer_mutex);
51 /* cycle leds on hubs that aren't blinking for attention */
52 static bool blinkenlights = 0;
53 module_param(blinkenlights, bool, S_IRUGO);
54 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
57 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
58 * 10 seconds to send reply for the initial 64-byte descriptor request.
60 /* define initial 64-byte descriptor request timeout in milliseconds */
61 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
62 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
63 MODULE_PARM_DESC(initial_descriptor_timeout,
64 "initial 64-byte descriptor request timeout in milliseconds "
65 "(default 5000 - 5.0 seconds)");
68 * As of 2.6.10 we introduce a new USB device initialization scheme which
69 * closely resembles the way Windows works. Hopefully it will be compatible
70 * with a wider range of devices than the old scheme. However some previously
71 * working devices may start giving rise to "device not accepting address"
72 * errors; if that happens the user can try the old scheme by adjusting the
73 * following module parameters.
75 * For maximum flexibility there are two boolean parameters to control the
76 * hub driver's behavior. On the first initialization attempt, if the
77 * "old_scheme_first" parameter is set then the old scheme will be used,
78 * otherwise the new scheme is used. If that fails and "use_both_schemes"
79 * is set, then the driver will make another attempt, using the other scheme.
81 static bool old_scheme_first = 0;
82 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
83 MODULE_PARM_DESC(old_scheme_first,
84 "start with the old device initialization scheme");
86 static bool use_both_schemes = 1;
87 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
88 MODULE_PARM_DESC(use_both_schemes,
89 "try the other device initialization scheme if the "
92 /* Mutual exclusion for EHCI CF initialization. This interferes with
93 * port reset on some companion controllers.
95 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
96 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
98 #define HUB_DEBOUNCE_TIMEOUT 2000
99 #define HUB_DEBOUNCE_STEP 25
100 #define HUB_DEBOUNCE_STABLE 100
102 static void hub_release(struct kref *kref);
103 static int usb_reset_and_verify_device(struct usb_device *udev);
105 static inline char *portspeed(struct usb_hub *hub, int portstatus)
107 if (hub_is_superspeed(hub->hdev))
109 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
111 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
117 /* Note that hdev or one of its children must be locked! */
118 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
120 if (!hdev || !hdev->actconfig || !hdev->maxchild)
122 return usb_get_intfdata(hdev->actconfig->interface[0]);
125 int usb_device_supports_lpm(struct usb_device *udev)
127 /* Some devices have trouble with LPM */
128 if (udev->quirks & USB_QUIRK_NO_LPM)
131 /* USB 2.1 (and greater) devices indicate LPM support through
132 * their USB 2.0 Extended Capabilities BOS descriptor.
134 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
135 if (udev->bos->ext_cap &&
137 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
143 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
144 * However, there are some that don't, and they set the U1/U2 exit
147 if (!udev->bos->ss_cap) {
148 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
152 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
153 udev->bos->ss_cap->bU2DevExitLat == 0) {
155 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
157 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
161 if (!udev->parent || udev->parent->lpm_capable)
167 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
170 static void usb_set_lpm_mel(struct usb_device *udev,
171 struct usb3_lpm_parameters *udev_lpm_params,
172 unsigned int udev_exit_latency,
174 struct usb3_lpm_parameters *hub_lpm_params,
175 unsigned int hub_exit_latency)
177 unsigned int total_mel;
178 unsigned int device_mel;
179 unsigned int hub_mel;
182 * Calculate the time it takes to transition all links from the roothub
183 * to the parent hub into U0. The parent hub must then decode the
184 * packet (hub header decode latency) to figure out which port it was
187 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
188 * means 0.1us). Multiply that by 100 to get nanoseconds.
190 total_mel = hub_lpm_params->mel +
191 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
194 * How long will it take to transition the downstream hub's port into
195 * U0? The greater of either the hub exit latency or the device exit
198 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
199 * Multiply that by 1000 to get nanoseconds.
201 device_mel = udev_exit_latency * 1000;
202 hub_mel = hub_exit_latency * 1000;
203 if (device_mel > hub_mel)
204 total_mel += device_mel;
206 total_mel += hub_mel;
208 udev_lpm_params->mel = total_mel;
212 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
213 * a transition from either U1 or U2.
215 static void usb_set_lpm_pel(struct usb_device *udev,
216 struct usb3_lpm_parameters *udev_lpm_params,
217 unsigned int udev_exit_latency,
219 struct usb3_lpm_parameters *hub_lpm_params,
220 unsigned int hub_exit_latency,
221 unsigned int port_to_port_exit_latency)
223 unsigned int first_link_pel;
224 unsigned int hub_pel;
227 * First, the device sends an LFPS to transition the link between the
228 * device and the parent hub into U0. The exit latency is the bigger of
229 * the device exit latency or the hub exit latency.
231 if (udev_exit_latency > hub_exit_latency)
232 first_link_pel = udev_exit_latency * 1000;
234 first_link_pel = hub_exit_latency * 1000;
237 * When the hub starts to receive the LFPS, there is a slight delay for
238 * it to figure out that one of the ports is sending an LFPS. Then it
239 * will forward the LFPS to its upstream link. The exit latency is the
240 * delay, plus the PEL that we calculated for this hub.
242 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
245 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
246 * is the greater of the two exit latencies.
248 if (first_link_pel > hub_pel)
249 udev_lpm_params->pel = first_link_pel;
251 udev_lpm_params->pel = hub_pel;
255 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
256 * when a device initiates a transition to U0, until when it will receive the
257 * first packet from the host controller.
259 * Section C.1.5.1 describes the four components to this:
261 * - t2: time for the ERDY to make it from the device to the host.
262 * - t3: a host-specific delay to process the ERDY.
263 * - t4: time for the packet to make it from the host to the device.
265 * t3 is specific to both the xHCI host and the platform the host is integrated
266 * into. The Intel HW folks have said it's negligible, FIXME if a different
267 * vendor says otherwise.
269 static void usb_set_lpm_sel(struct usb_device *udev,
270 struct usb3_lpm_parameters *udev_lpm_params)
272 struct usb_device *parent;
273 unsigned int num_hubs;
274 unsigned int total_sel;
276 /* t1 = device PEL */
277 total_sel = udev_lpm_params->pel;
278 /* How many external hubs are in between the device & the root port. */
279 for (parent = udev->parent, num_hubs = 0; parent->parent;
280 parent = parent->parent)
282 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
284 total_sel += 2100 + 250 * (num_hubs - 1);
286 /* t4 = 250ns * num_hubs */
287 total_sel += 250 * num_hubs;
289 udev_lpm_params->sel = total_sel;
292 static void usb_set_lpm_parameters(struct usb_device *udev)
295 unsigned int port_to_port_delay;
296 unsigned int udev_u1_del;
297 unsigned int udev_u2_del;
298 unsigned int hub_u1_del;
299 unsigned int hub_u2_del;
301 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
304 hub = usb_hub_to_struct_hub(udev->parent);
305 /* It doesn't take time to transition the roothub into U0, since it
306 * doesn't have an upstream link.
311 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
312 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
313 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
314 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
316 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
317 hub, &udev->parent->u1_params, hub_u1_del);
319 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
320 hub, &udev->parent->u2_params, hub_u2_del);
323 * Appendix C, section C.2.2.2, says that there is a slight delay from
324 * when the parent hub notices the downstream port is trying to
325 * transition to U0 to when the hub initiates a U0 transition on its
326 * upstream port. The section says the delays are tPort2PortU1EL and
327 * tPort2PortU2EL, but it doesn't define what they are.
329 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
330 * about the same delays. Use the maximum delay calculations from those
331 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
332 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
333 * assume the device exit latencies they are talking about are the hub
336 * What do we do if the U2 exit latency is less than the U1 exit
337 * latency? It's possible, although not likely...
339 port_to_port_delay = 1;
341 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
342 hub, &udev->parent->u1_params, hub_u1_del,
345 if (hub_u2_del > hub_u1_del)
346 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
348 port_to_port_delay = 1 + hub_u1_del;
350 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
351 hub, &udev->parent->u2_params, hub_u2_del,
354 /* Now that we've got PEL, calculate SEL. */
355 usb_set_lpm_sel(udev, &udev->u1_params);
356 usb_set_lpm_sel(udev, &udev->u2_params);
359 /* USB 2.0 spec Section 11.24.4.5 */
360 static int get_hub_descriptor(struct usb_device *hdev, void *data)
365 if (hub_is_superspeed(hdev)) {
366 dtype = USB_DT_SS_HUB;
367 size = USB_DT_SS_HUB_SIZE;
370 size = sizeof(struct usb_hub_descriptor);
373 for (i = 0; i < 3; i++) {
374 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
375 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
376 dtype << 8, 0, data, size,
377 USB_CTRL_GET_TIMEOUT);
378 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
385 * USB 2.0 spec Section 11.24.2.1
387 static int clear_hub_feature(struct usb_device *hdev, int feature)
389 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
390 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
394 * USB 2.0 spec Section 11.24.2.2
396 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
398 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
399 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
404 * USB 2.0 spec Section 11.24.2.13
406 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
408 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
409 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
413 static char *to_led_name(int selector)
430 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
431 * for info about using port indicators
433 static void set_port_led(struct usb_hub *hub, int port1, int selector)
435 struct usb_port *port_dev = hub->ports[port1 - 1];
438 status = set_port_feature(hub->hdev, (selector << 8) | port1,
439 USB_PORT_FEAT_INDICATOR);
440 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
441 to_led_name(selector), status);
444 #define LED_CYCLE_PERIOD ((2*HZ)/3)
446 static void led_work(struct work_struct *work)
448 struct usb_hub *hub =
449 container_of(work, struct usb_hub, leds.work);
450 struct usb_device *hdev = hub->hdev;
452 unsigned changed = 0;
455 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
458 for (i = 0; i < hdev->maxchild; i++) {
459 unsigned selector, mode;
461 /* 30%-50% duty cycle */
463 switch (hub->indicator[i]) {
465 case INDICATOR_CYCLE:
467 selector = HUB_LED_AUTO;
468 mode = INDICATOR_AUTO;
470 /* blinking green = sw attention */
471 case INDICATOR_GREEN_BLINK:
472 selector = HUB_LED_GREEN;
473 mode = INDICATOR_GREEN_BLINK_OFF;
475 case INDICATOR_GREEN_BLINK_OFF:
476 selector = HUB_LED_OFF;
477 mode = INDICATOR_GREEN_BLINK;
479 /* blinking amber = hw attention */
480 case INDICATOR_AMBER_BLINK:
481 selector = HUB_LED_AMBER;
482 mode = INDICATOR_AMBER_BLINK_OFF;
484 case INDICATOR_AMBER_BLINK_OFF:
485 selector = HUB_LED_OFF;
486 mode = INDICATOR_AMBER_BLINK;
488 /* blink green/amber = reserved */
489 case INDICATOR_ALT_BLINK:
490 selector = HUB_LED_GREEN;
491 mode = INDICATOR_ALT_BLINK_OFF;
493 case INDICATOR_ALT_BLINK_OFF:
494 selector = HUB_LED_AMBER;
495 mode = INDICATOR_ALT_BLINK;
500 if (selector != HUB_LED_AUTO)
502 set_port_led(hub, i + 1, selector);
503 hub->indicator[i] = mode;
505 if (!changed && blinkenlights) {
507 cursor %= hdev->maxchild;
508 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
509 hub->indicator[cursor] = INDICATOR_CYCLE;
513 queue_delayed_work(system_power_efficient_wq,
514 &hub->leds, LED_CYCLE_PERIOD);
517 /* use a short timeout for hub/port status fetches */
518 #define USB_STS_TIMEOUT 1000
519 #define USB_STS_RETRIES 5
522 * USB 2.0 spec Section 11.24.2.6
524 static int get_hub_status(struct usb_device *hdev,
525 struct usb_hub_status *data)
527 int i, status = -ETIMEDOUT;
529 for (i = 0; i < USB_STS_RETRIES &&
530 (status == -ETIMEDOUT || status == -EPIPE); i++) {
531 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
532 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
533 data, sizeof(*data), USB_STS_TIMEOUT);
539 * USB 2.0 spec Section 11.24.2.7
541 static int get_port_status(struct usb_device *hdev, int port1,
542 struct usb_port_status *data)
544 int i, status = -ETIMEDOUT;
546 for (i = 0; i < USB_STS_RETRIES &&
547 (status == -ETIMEDOUT || status == -EPIPE); i++) {
548 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
549 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
550 data, sizeof(*data), USB_STS_TIMEOUT);
555 static int hub_port_status(struct usb_hub *hub, int port1,
556 u16 *status, u16 *change)
560 mutex_lock(&hub->status_mutex);
561 ret = get_port_status(hub->hdev, port1, &hub->status->port);
564 dev_err(hub->intfdev,
565 "%s failed (err = %d)\n", __func__, ret);
569 *status = le16_to_cpu(hub->status->port.wPortStatus);
570 *change = le16_to_cpu(hub->status->port.wPortChange);
574 mutex_unlock(&hub->status_mutex);
578 static void kick_hub_wq(struct usb_hub *hub)
580 struct usb_interface *intf;
582 if (hub->disconnected || work_pending(&hub->events))
586 * Suppress autosuspend until the event is proceed.
588 * Be careful and make sure that the symmetric operation is
589 * always called. We are here only when there is no pending
590 * work for this hub. Therefore put the interface either when
591 * the new work is called or when it is canceled.
593 intf = to_usb_interface(hub->intfdev);
594 usb_autopm_get_interface_no_resume(intf);
595 kref_get(&hub->kref);
597 if (queue_work(hub_wq, &hub->events))
600 /* the work has already been scheduled */
601 usb_autopm_put_interface_async(intf);
602 kref_put(&hub->kref, hub_release);
605 void usb_kick_hub_wq(struct usb_device *hdev)
607 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
614 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
615 * Notification, which indicates it had initiated remote wakeup.
617 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
618 * device initiates resume, so the USB core will not receive notice of the
619 * resume through the normal hub interrupt URB.
621 void usb_wakeup_notification(struct usb_device *hdev,
622 unsigned int portnum)
629 hub = usb_hub_to_struct_hub(hdev);
631 set_bit(portnum, hub->wakeup_bits);
635 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
637 /* completion function, fires on port status changes and various faults */
638 static void hub_irq(struct urb *urb)
640 struct usb_hub *hub = urb->context;
641 int status = urb->status;
646 case -ENOENT: /* synchronous unlink */
647 case -ECONNRESET: /* async unlink */
648 case -ESHUTDOWN: /* hardware going away */
651 default: /* presumably an error */
652 /* Cause a hub reset after 10 consecutive errors */
653 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
654 if ((++hub->nerrors < 10) || hub->error)
659 /* let hub_wq handle things */
660 case 0: /* we got data: port status changed */
662 for (i = 0; i < urb->actual_length; ++i)
663 bits |= ((unsigned long) ((*hub->buffer)[i]))
665 hub->event_bits[0] = bits;
671 /* Something happened, let hub_wq figure it out */
678 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
679 if (status != 0 && status != -ENODEV && status != -EPERM)
680 dev_err(hub->intfdev, "resubmit --> %d\n", status);
683 /* USB 2.0 spec Section 11.24.2.3 */
685 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
687 /* Need to clear both directions for control ep */
688 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
689 USB_ENDPOINT_XFER_CONTROL) {
690 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
691 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
692 devinfo ^ 0x8000, tt, NULL, 0, 1000);
696 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
697 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
702 * enumeration blocks hub_wq for a long time. we use keventd instead, since
703 * long blocking there is the exception, not the rule. accordingly, HCDs
704 * talking to TTs must queue control transfers (not just bulk and iso), so
705 * both can talk to the same hub concurrently.
707 static void hub_tt_work(struct work_struct *work)
709 struct usb_hub *hub =
710 container_of(work, struct usb_hub, tt.clear_work);
713 spin_lock_irqsave(&hub->tt.lock, flags);
714 while (!list_empty(&hub->tt.clear_list)) {
715 struct list_head *next;
716 struct usb_tt_clear *clear;
717 struct usb_device *hdev = hub->hdev;
718 const struct hc_driver *drv;
721 next = hub->tt.clear_list.next;
722 clear = list_entry(next, struct usb_tt_clear, clear_list);
723 list_del(&clear->clear_list);
725 /* drop lock so HCD can concurrently report other TT errors */
726 spin_unlock_irqrestore(&hub->tt.lock, flags);
727 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
728 if (status && status != -ENODEV)
730 "clear tt %d (%04x) error %d\n",
731 clear->tt, clear->devinfo, status);
733 /* Tell the HCD, even if the operation failed */
734 drv = clear->hcd->driver;
735 if (drv->clear_tt_buffer_complete)
736 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
739 spin_lock_irqsave(&hub->tt.lock, flags);
741 spin_unlock_irqrestore(&hub->tt.lock, flags);
745 * usb_hub_set_port_power - control hub port's power state
746 * @hdev: USB device belonging to the usb hub
749 * @set: expected status
751 * call this function to control port's power via setting or
752 * clearing the port's PORT_POWER feature.
754 * Return: 0 if successful. A negative error code otherwise.
756 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
762 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
764 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
770 set_bit(port1, hub->power_bits);
772 clear_bit(port1, hub->power_bits);
777 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
778 * @urb: an URB associated with the failed or incomplete split transaction
780 * High speed HCDs use this to tell the hub driver that some split control or
781 * bulk transaction failed in a way that requires clearing internal state of
782 * a transaction translator. This is normally detected (and reported) from
785 * It may not be possible for that hub to handle additional full (or low)
786 * speed transactions until that state is fully cleared out.
788 * Return: 0 if successful. A negative error code otherwise.
790 int usb_hub_clear_tt_buffer(struct urb *urb)
792 struct usb_device *udev = urb->dev;
793 int pipe = urb->pipe;
794 struct usb_tt *tt = udev->tt;
796 struct usb_tt_clear *clear;
798 /* we've got to cope with an arbitrary number of pending TT clears,
799 * since each TT has "at least two" buffers that can need it (and
800 * there can be many TTs per hub). even if they're uncommon.
802 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
804 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
805 /* FIXME recover somehow ... RESET_TT? */
809 /* info that CLEAR_TT_BUFFER needs */
810 clear->tt = tt->multi ? udev->ttport : 1;
811 clear->devinfo = usb_pipeendpoint (pipe);
812 clear->devinfo |= udev->devnum << 4;
813 clear->devinfo |= usb_pipecontrol(pipe)
814 ? (USB_ENDPOINT_XFER_CONTROL << 11)
815 : (USB_ENDPOINT_XFER_BULK << 11);
816 if (usb_pipein(pipe))
817 clear->devinfo |= 1 << 15;
819 /* info for completion callback */
820 clear->hcd = bus_to_hcd(udev->bus);
823 /* tell keventd to clear state for this TT */
824 spin_lock_irqsave(&tt->lock, flags);
825 list_add_tail(&clear->clear_list, &tt->clear_list);
826 schedule_work(&tt->clear_work);
827 spin_unlock_irqrestore(&tt->lock, flags);
830 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
832 static void hub_power_on(struct usb_hub *hub, bool do_delay)
836 /* Enable power on each port. Some hubs have reserved values
837 * of LPSM (> 2) in their descriptors, even though they are
838 * USB 2.0 hubs. Some hubs do not implement port-power switching
839 * but only emulate it. In all cases, the ports won't work
840 * unless we send these messages to the hub.
842 if (hub_is_port_power_switchable(hub))
843 dev_dbg(hub->intfdev, "enabling power on all ports\n");
845 dev_dbg(hub->intfdev, "trying to enable port power on "
846 "non-switchable hub\n");
847 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
848 if (test_bit(port1, hub->power_bits))
849 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
851 usb_clear_port_feature(hub->hdev, port1,
852 USB_PORT_FEAT_POWER);
854 msleep(hub_power_on_good_delay(hub));
857 static int hub_hub_status(struct usb_hub *hub,
858 u16 *status, u16 *change)
862 mutex_lock(&hub->status_mutex);
863 ret = get_hub_status(hub->hdev, &hub->status->hub);
866 dev_err(hub->intfdev,
867 "%s failed (err = %d)\n", __func__, ret);
869 *status = le16_to_cpu(hub->status->hub.wHubStatus);
870 *change = le16_to_cpu(hub->status->hub.wHubChange);
873 mutex_unlock(&hub->status_mutex);
877 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
878 unsigned int link_status)
880 return set_port_feature(hub->hdev,
881 port1 | (link_status << 3),
882 USB_PORT_FEAT_LINK_STATE);
886 * If USB 3.0 ports are placed into the Disabled state, they will no longer
887 * detect any device connects or disconnects. This is generally not what the
888 * USB core wants, since it expects a disabled port to produce a port status
889 * change event when a new device connects.
891 * Instead, set the link state to Disabled, wait for the link to settle into
892 * that state, clear any change bits, and then put the port into the RxDetect
895 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
899 u16 portchange, portstatus;
901 if (!hub_is_superspeed(hub->hdev))
904 ret = hub_port_status(hub, port1, &portstatus, &portchange);
909 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
910 * Controller [1022:7814] will have spurious result making the following
911 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
912 * as high-speed device if we set the usb 3.0 port link state to
913 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
914 * check the state here to avoid the bug.
916 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
917 USB_SS_PORT_LS_RX_DETECT) {
918 dev_dbg(&hub->ports[port1 - 1]->dev,
919 "Not disabling port; link state is RxDetect\n");
923 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
927 /* Wait for the link to enter the disabled state. */
928 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
929 ret = hub_port_status(hub, port1, &portstatus, &portchange);
933 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
934 USB_SS_PORT_LS_SS_DISABLED)
936 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
938 msleep(HUB_DEBOUNCE_STEP);
940 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
941 dev_warn(&hub->ports[port1 - 1]->dev,
942 "Could not disable after %d ms\n", total_time);
944 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
947 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
949 struct usb_port *port_dev = hub->ports[port1 - 1];
950 struct usb_device *hdev = hub->hdev;
953 if (port_dev->child && set_state)
954 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
956 if (hub_is_superspeed(hub->hdev))
957 ret = hub_usb3_port_disable(hub, port1);
959 ret = usb_clear_port_feature(hdev, port1,
960 USB_PORT_FEAT_ENABLE);
962 if (ret && ret != -ENODEV)
963 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
968 * Disable a port and mark a logical connect-change event, so that some
969 * time later hub_wq will disconnect() any existing usb_device on the port
970 * and will re-enumerate if there actually is a device attached.
972 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
974 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
975 hub_port_disable(hub, port1, 1);
977 /* FIXME let caller ask to power down the port:
978 * - some devices won't enumerate without a VBUS power cycle
979 * - SRP saves power that way
980 * - ... new call, TBD ...
981 * That's easy if this hub can switch power per-port, and
982 * hub_wq reactivates the port later (timer, SRP, etc).
983 * Powerdown must be optional, because of reset/DFU.
986 set_bit(port1, hub->change_bits);
991 * usb_remove_device - disable a device's port on its parent hub
992 * @udev: device to be disabled and removed
993 * Context: @udev locked, must be able to sleep.
995 * After @udev's port has been disabled, hub_wq is notified and it will
996 * see that the device has been disconnected. When the device is
997 * physically unplugged and something is plugged in, the events will
998 * be received and processed normally.
1000 * Return: 0 if successful. A negative error code otherwise.
1002 int usb_remove_device(struct usb_device *udev)
1004 struct usb_hub *hub;
1005 struct usb_interface *intf;
1007 if (!udev->parent) /* Can't remove a root hub */
1009 hub = usb_hub_to_struct_hub(udev->parent);
1010 intf = to_usb_interface(hub->intfdev);
1012 usb_autopm_get_interface(intf);
1013 set_bit(udev->portnum, hub->removed_bits);
1014 hub_port_logical_disconnect(hub, udev->portnum);
1015 usb_autopm_put_interface(intf);
1019 enum hub_activation_type {
1020 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1021 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1024 static void hub_init_func2(struct work_struct *ws);
1025 static void hub_init_func3(struct work_struct *ws);
1027 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1029 struct usb_device *hdev = hub->hdev;
1030 struct usb_hcd *hcd;
1034 bool need_debounce_delay = false;
1037 /* Continue a partial initialization */
1038 if (type == HUB_INIT2)
1040 if (type == HUB_INIT3)
1043 /* The superspeed hub except for root hub has to use Hub Depth
1044 * value as an offset into the route string to locate the bits
1045 * it uses to determine the downstream port number. So hub driver
1046 * should send a set hub depth request to superspeed hub after
1047 * the superspeed hub is set configuration in initialization or
1050 * After a resume, port power should still be on.
1051 * For any other type of activation, turn it on.
1053 if (type != HUB_RESUME) {
1054 if (hdev->parent && hub_is_superspeed(hdev)) {
1055 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1056 HUB_SET_DEPTH, USB_RT_HUB,
1057 hdev->level - 1, 0, NULL, 0,
1058 USB_CTRL_SET_TIMEOUT);
1060 dev_err(hub->intfdev,
1061 "set hub depth failed\n");
1064 /* Speed up system boot by using a delayed_work for the
1065 * hub's initial power-up delays. This is pretty awkward
1066 * and the implementation looks like a home-brewed sort of
1067 * setjmp/longjmp, but it saves at least 100 ms for each
1068 * root hub (assuming usbcore is compiled into the kernel
1069 * rather than as a module). It adds up.
1071 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1072 * because for those activation types the ports have to be
1073 * operational when we return. In theory this could be done
1074 * for HUB_POST_RESET, but it's easier not to.
1076 if (type == HUB_INIT) {
1077 delay = hub_power_on_good_delay(hub);
1079 hub_power_on(hub, false);
1080 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1081 queue_delayed_work(system_power_efficient_wq,
1083 msecs_to_jiffies(delay));
1085 /* Suppress autosuspend until init is done */
1086 usb_autopm_get_interface_no_resume(
1087 to_usb_interface(hub->intfdev));
1088 return; /* Continues at init2: below */
1089 } else if (type == HUB_RESET_RESUME) {
1090 /* The internal host controller state for the hub device
1091 * may be gone after a host power loss on system resume.
1092 * Update the device's info so the HW knows it's a hub.
1094 hcd = bus_to_hcd(hdev->bus);
1095 if (hcd->driver->update_hub_device) {
1096 ret = hcd->driver->update_hub_device(hcd, hdev,
1097 &hub->tt, GFP_NOIO);
1099 dev_err(hub->intfdev, "Host not "
1100 "accepting hub info "
1102 dev_err(hub->intfdev, "LS/FS devices "
1103 "and hubs may not work "
1104 "under this hub\n.");
1107 hub_power_on(hub, true);
1109 hub_power_on(hub, true);
1115 * Check each port and set hub->change_bits to let hub_wq know
1116 * which ports need attention.
1118 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1119 struct usb_port *port_dev = hub->ports[port1 - 1];
1120 struct usb_device *udev = port_dev->child;
1121 u16 portstatus, portchange;
1123 portstatus = portchange = 0;
1124 status = hub_port_status(hub, port1, &portstatus, &portchange);
1125 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1126 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1127 portstatus, portchange);
1130 * After anything other than HUB_RESUME (i.e., initialization
1131 * or any sort of reset), every port should be disabled.
1132 * Unconnected ports should likewise be disabled (paranoia),
1133 * and so should ports for which we have no usb_device.
1135 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1136 type != HUB_RESUME ||
1137 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1139 udev->state == USB_STATE_NOTATTACHED)) {
1141 * USB3 protocol ports will automatically transition
1142 * to Enabled state when detect an USB3.0 device attach.
1143 * Do not disable USB3 protocol ports, just pretend
1146 portstatus &= ~USB_PORT_STAT_ENABLE;
1147 if (!hub_is_superspeed(hdev))
1148 usb_clear_port_feature(hdev, port1,
1149 USB_PORT_FEAT_ENABLE);
1152 /* Clear status-change flags; we'll debounce later */
1153 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1154 need_debounce_delay = true;
1155 usb_clear_port_feature(hub->hdev, port1,
1156 USB_PORT_FEAT_C_CONNECTION);
1158 if (portchange & USB_PORT_STAT_C_ENABLE) {
1159 need_debounce_delay = true;
1160 usb_clear_port_feature(hub->hdev, port1,
1161 USB_PORT_FEAT_C_ENABLE);
1163 if (portchange & USB_PORT_STAT_C_RESET) {
1164 need_debounce_delay = true;
1165 usb_clear_port_feature(hub->hdev, port1,
1166 USB_PORT_FEAT_C_RESET);
1168 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1169 hub_is_superspeed(hub->hdev)) {
1170 need_debounce_delay = true;
1171 usb_clear_port_feature(hub->hdev, port1,
1172 USB_PORT_FEAT_C_BH_PORT_RESET);
1174 /* We can forget about a "removed" device when there's a
1175 * physical disconnect or the connect status changes.
1177 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1178 (portchange & USB_PORT_STAT_C_CONNECTION))
1179 clear_bit(port1, hub->removed_bits);
1181 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1182 /* Tell hub_wq to disconnect the device or
1183 * check for a new connection
1185 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1186 (portstatus & USB_PORT_STAT_OVERCURRENT))
1187 set_bit(port1, hub->change_bits);
1189 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1190 bool port_resumed = (portstatus &
1191 USB_PORT_STAT_LINK_STATE) ==
1193 /* The power session apparently survived the resume.
1194 * If there was an overcurrent or suspend change
1195 * (i.e., remote wakeup request), have hub_wq
1196 * take care of it. Look at the port link state
1197 * for USB 3.0 hubs, since they don't have a suspend
1198 * change bit, and they don't set the port link change
1199 * bit on device-initiated resume.
1201 if (portchange || (hub_is_superspeed(hub->hdev) &&
1203 set_bit(port1, hub->change_bits);
1205 } else if (udev->persist_enabled) {
1207 udev->reset_resume = 1;
1209 /* Don't set the change_bits when the device
1212 if (test_bit(port1, hub->power_bits))
1213 set_bit(port1, hub->change_bits);
1216 /* The power session is gone; tell hub_wq */
1217 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1218 set_bit(port1, hub->change_bits);
1222 /* If no port-status-change flags were set, we don't need any
1223 * debouncing. If flags were set we can try to debounce the
1224 * ports all at once right now, instead of letting hub_wq do them
1225 * one at a time later on.
1227 * If any port-status changes do occur during this delay, hub_wq
1228 * will see them later and handle them normally.
1230 if (need_debounce_delay) {
1231 delay = HUB_DEBOUNCE_STABLE;
1233 /* Don't do a long sleep inside a workqueue routine */
1234 if (type == HUB_INIT2) {
1235 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1236 queue_delayed_work(system_power_efficient_wq,
1238 msecs_to_jiffies(delay));
1239 return; /* Continues at init3: below */
1247 status = usb_submit_urb(hub->urb, GFP_NOIO);
1249 dev_err(hub->intfdev, "activate --> %d\n", status);
1250 if (hub->has_indicators && blinkenlights)
1251 queue_delayed_work(system_power_efficient_wq,
1252 &hub->leds, LED_CYCLE_PERIOD);
1254 /* Scan all ports that need attention */
1257 /* Allow autosuspend if it was suppressed */
1258 if (type <= HUB_INIT3)
1259 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1262 /* Implement the continuations for the delays above */
1263 static void hub_init_func2(struct work_struct *ws)
1265 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1267 hub_activate(hub, HUB_INIT2);
1270 static void hub_init_func3(struct work_struct *ws)
1272 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1274 hub_activate(hub, HUB_INIT3);
1277 enum hub_quiescing_type {
1278 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1281 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1283 struct usb_device *hdev = hub->hdev;
1286 cancel_delayed_work_sync(&hub->init_work);
1288 /* hub_wq and related activity won't re-trigger */
1291 if (type != HUB_SUSPEND) {
1292 /* Disconnect all the children */
1293 for (i = 0; i < hdev->maxchild; ++i) {
1294 if (hub->ports[i]->child)
1295 usb_disconnect(&hub->ports[i]->child);
1299 /* Stop hub_wq and related activity */
1300 usb_kill_urb(hub->urb);
1301 if (hub->has_indicators)
1302 cancel_delayed_work_sync(&hub->leds);
1304 flush_work(&hub->tt.clear_work);
1307 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1311 for (i = 0; i < hub->hdev->maxchild; ++i)
1312 pm_runtime_barrier(&hub->ports[i]->dev);
1315 /* caller has locked the hub device */
1316 static int hub_pre_reset(struct usb_interface *intf)
1318 struct usb_hub *hub = usb_get_intfdata(intf);
1320 hub_quiesce(hub, HUB_PRE_RESET);
1322 hub_pm_barrier_for_all_ports(hub);
1326 /* caller has locked the hub device */
1327 static int hub_post_reset(struct usb_interface *intf)
1329 struct usb_hub *hub = usb_get_intfdata(intf);
1332 hub_pm_barrier_for_all_ports(hub);
1333 hub_activate(hub, HUB_POST_RESET);
1337 static int hub_configure(struct usb_hub *hub,
1338 struct usb_endpoint_descriptor *endpoint)
1340 struct usb_hcd *hcd;
1341 struct usb_device *hdev = hub->hdev;
1342 struct device *hub_dev = hub->intfdev;
1343 u16 hubstatus, hubchange;
1344 u16 wHubCharacteristics;
1347 char *message = "out of memory";
1352 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1358 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1363 mutex_init(&hub->status_mutex);
1365 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1366 if (!hub->descriptor) {
1371 /* Request the entire hub descriptor.
1372 * hub->descriptor can handle USB_MAXCHILDREN ports,
1373 * but the hub can/will return fewer bytes here.
1375 ret = get_hub_descriptor(hdev, hub->descriptor);
1377 message = "can't read hub descriptor";
1379 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1380 message = "hub has too many ports!";
1383 } else if (hub->descriptor->bNbrPorts == 0) {
1384 message = "hub doesn't have any ports!";
1389 maxchild = hub->descriptor->bNbrPorts;
1390 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1391 (maxchild == 1) ? "" : "s");
1393 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1399 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1400 if (hub_is_superspeed(hdev)) {
1408 /* FIXME for USB 3.0, skip for now */
1409 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1410 !(hub_is_superspeed(hdev))) {
1411 char portstr[USB_MAXCHILDREN + 1];
1413 for (i = 0; i < maxchild; i++)
1414 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1415 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1417 portstr[maxchild] = 0;
1418 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1420 dev_dbg(hub_dev, "standalone hub\n");
1422 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1423 case HUB_CHAR_COMMON_LPSM:
1424 dev_dbg(hub_dev, "ganged power switching\n");
1426 case HUB_CHAR_INDV_PORT_LPSM:
1427 dev_dbg(hub_dev, "individual port power switching\n");
1429 case HUB_CHAR_NO_LPSM:
1431 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1435 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1436 case HUB_CHAR_COMMON_OCPM:
1437 dev_dbg(hub_dev, "global over-current protection\n");
1439 case HUB_CHAR_INDV_PORT_OCPM:
1440 dev_dbg(hub_dev, "individual port over-current protection\n");
1442 case HUB_CHAR_NO_OCPM:
1444 dev_dbg(hub_dev, "no over-current protection\n");
1448 spin_lock_init(&hub->tt.lock);
1449 INIT_LIST_HEAD(&hub->tt.clear_list);
1450 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1451 switch (hdev->descriptor.bDeviceProtocol) {
1454 case USB_HUB_PR_HS_SINGLE_TT:
1455 dev_dbg(hub_dev, "Single TT\n");
1458 case USB_HUB_PR_HS_MULTI_TT:
1459 ret = usb_set_interface(hdev, 0, 1);
1461 dev_dbg(hub_dev, "TT per port\n");
1464 dev_err(hub_dev, "Using single TT (err %d)\n",
1469 /* USB 3.0 hubs don't have a TT */
1472 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1473 hdev->descriptor.bDeviceProtocol);
1477 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1478 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1479 case HUB_TTTT_8_BITS:
1480 if (hdev->descriptor.bDeviceProtocol != 0) {
1481 hub->tt.think_time = 666;
1482 dev_dbg(hub_dev, "TT requires at most %d "
1483 "FS bit times (%d ns)\n",
1484 8, hub->tt.think_time);
1487 case HUB_TTTT_16_BITS:
1488 hub->tt.think_time = 666 * 2;
1489 dev_dbg(hub_dev, "TT requires at most %d "
1490 "FS bit times (%d ns)\n",
1491 16, hub->tt.think_time);
1493 case HUB_TTTT_24_BITS:
1494 hub->tt.think_time = 666 * 3;
1495 dev_dbg(hub_dev, "TT requires at most %d "
1496 "FS bit times (%d ns)\n",
1497 24, hub->tt.think_time);
1499 case HUB_TTTT_32_BITS:
1500 hub->tt.think_time = 666 * 4;
1501 dev_dbg(hub_dev, "TT requires at most %d "
1502 "FS bit times (%d ns)\n",
1503 32, hub->tt.think_time);
1507 /* probe() zeroes hub->indicator[] */
1508 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1509 hub->has_indicators = 1;
1510 dev_dbg(hub_dev, "Port indicators are supported\n");
1513 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1514 hub->descriptor->bPwrOn2PwrGood * 2);
1516 /* power budgeting mostly matters with bus-powered hubs,
1517 * and battery-powered root hubs (may provide just 8 mA).
1519 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1521 message = "can't get hub status";
1524 hcd = bus_to_hcd(hdev->bus);
1525 if (hdev == hdev->bus->root_hub) {
1526 if (hcd->power_budget > 0)
1527 hdev->bus_mA = hcd->power_budget;
1529 hdev->bus_mA = full_load * maxchild;
1530 if (hdev->bus_mA >= full_load)
1531 hub->mA_per_port = full_load;
1533 hub->mA_per_port = hdev->bus_mA;
1534 hub->limited_power = 1;
1536 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1537 int remaining = hdev->bus_mA -
1538 hub->descriptor->bHubContrCurrent;
1540 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1541 hub->descriptor->bHubContrCurrent);
1542 hub->limited_power = 1;
1544 if (remaining < maxchild * unit_load)
1546 "insufficient power available "
1547 "to use all downstream ports\n");
1548 hub->mA_per_port = unit_load; /* 7.2.1 */
1550 } else { /* Self-powered external hub */
1551 /* FIXME: What about battery-powered external hubs that
1552 * provide less current per port? */
1553 hub->mA_per_port = full_load;
1555 if (hub->mA_per_port < full_load)
1556 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1559 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1561 message = "can't get hub status";
1565 /* local power status reports aren't always correct */
1566 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1567 dev_dbg(hub_dev, "local power source is %s\n",
1568 (hubstatus & HUB_STATUS_LOCAL_POWER)
1569 ? "lost (inactive)" : "good");
1571 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1572 dev_dbg(hub_dev, "%sover-current condition exists\n",
1573 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1575 /* set up the interrupt endpoint
1576 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1577 * bytes as USB2.0[11.12.3] says because some hubs are known
1578 * to send more data (and thus cause overflow). For root hubs,
1579 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1580 * to be big enough for at least USB_MAXCHILDREN ports. */
1581 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1582 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1584 if (maxp > sizeof(*hub->buffer))
1585 maxp = sizeof(*hub->buffer);
1587 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1593 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1594 hub, endpoint->bInterval);
1596 /* maybe cycle the hub leds */
1597 if (hub->has_indicators && blinkenlights)
1598 hub->indicator[0] = INDICATOR_CYCLE;
1600 mutex_lock(&usb_port_peer_mutex);
1601 for (i = 0; i < maxchild; i++) {
1602 ret = usb_hub_create_port_device(hub, i + 1);
1604 dev_err(hub->intfdev,
1605 "couldn't create port%d device.\n", i + 1);
1610 for (i = 0; i < hdev->maxchild; i++) {
1611 struct usb_port *port_dev = hub->ports[i];
1613 pm_runtime_put(&port_dev->dev);
1616 mutex_unlock(&usb_port_peer_mutex);
1620 /* Update the HCD's internal representation of this hub before hub_wq
1621 * starts getting port status changes for devices under the hub.
1623 if (hcd->driver->update_hub_device) {
1624 ret = hcd->driver->update_hub_device(hcd, hdev,
1625 &hub->tt, GFP_KERNEL);
1627 message = "can't update HCD hub info";
1632 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1634 hub_activate(hub, HUB_INIT);
1638 dev_err(hub_dev, "config failed, %s (err %d)\n",
1640 /* hub_disconnect() frees urb and descriptor */
1644 static void hub_release(struct kref *kref)
1646 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1648 usb_put_dev(hub->hdev);
1649 usb_put_intf(to_usb_interface(hub->intfdev));
1653 static unsigned highspeed_hubs;
1655 static void hub_disconnect(struct usb_interface *intf)
1657 struct usb_hub *hub = usb_get_intfdata(intf);
1658 struct usb_device *hdev = interface_to_usbdev(intf);
1662 * Stop adding new hub events. We do not want to block here and thus
1663 * will not try to remove any pending work item.
1665 hub->disconnected = 1;
1667 /* Disconnect all children and quiesce the hub */
1669 hub_quiesce(hub, HUB_DISCONNECT);
1671 mutex_lock(&usb_port_peer_mutex);
1673 /* Avoid races with recursively_mark_NOTATTACHED() */
1674 spin_lock_irq(&device_state_lock);
1675 port1 = hdev->maxchild;
1677 usb_set_intfdata(intf, NULL);
1678 spin_unlock_irq(&device_state_lock);
1680 for (; port1 > 0; --port1)
1681 usb_hub_remove_port_device(hub, port1);
1683 mutex_unlock(&usb_port_peer_mutex);
1685 if (hub->hdev->speed == USB_SPEED_HIGH)
1688 usb_free_urb(hub->urb);
1690 kfree(hub->descriptor);
1694 pm_suspend_ignore_children(&intf->dev, false);
1695 kref_put(&hub->kref, hub_release);
1698 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1700 struct usb_host_interface *desc;
1701 struct usb_endpoint_descriptor *endpoint;
1702 struct usb_device *hdev;
1703 struct usb_hub *hub;
1705 desc = intf->cur_altsetting;
1706 hdev = interface_to_usbdev(intf);
1709 * Set default autosuspend delay as 0 to speedup bus suspend,
1710 * based on the below considerations:
1712 * - Unlike other drivers, the hub driver does not rely on the
1713 * autosuspend delay to provide enough time to handle a wakeup
1714 * event, and the submitted status URB is just to check future
1715 * change on hub downstream ports, so it is safe to do it.
1717 * - The patch might cause one or more auto supend/resume for
1718 * below very rare devices when they are plugged into hub
1721 * devices having trouble initializing, and disconnect
1722 * themselves from the bus and then reconnect a second
1725 * devices just for downloading firmware, and disconnects
1726 * themselves after completing it
1728 * For these quite rare devices, their drivers may change the
1729 * autosuspend delay of their parent hub in the probe() to one
1730 * appropriate value to avoid the subtle problem if someone
1733 * - The patch may cause one or more auto suspend/resume on
1734 * hub during running 'lsusb', but it is probably too
1735 * infrequent to worry about.
1737 * - Change autosuspend delay of hub can avoid unnecessary auto
1738 * suspend timer for hub, also may decrease power consumption
1741 * - If user has indicated to prevent autosuspend by passing
1742 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1745 if (hdev->dev.power.autosuspend_delay >= 0)
1746 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1750 * Hubs have proper suspend/resume support, except for root hubs
1751 * where the controller driver doesn't have bus_suspend and
1752 * bus_resume methods.
1754 if (hdev->parent) { /* normal device */
1755 usb_enable_autosuspend(hdev);
1756 } else { /* root hub */
1757 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1759 if (drv->bus_suspend && drv->bus_resume)
1760 usb_enable_autosuspend(hdev);
1763 if (hdev->level == MAX_TOPO_LEVEL) {
1765 "Unsupported bus topology: hub nested too deep\n");
1769 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1771 dev_warn(&intf->dev, "ignoring external hub\n");
1776 /* Some hubs have a subclass of 1, which AFAICT according to the */
1777 /* specs is not defined, but it works */
1778 if ((desc->desc.bInterfaceSubClass != 0) &&
1779 (desc->desc.bInterfaceSubClass != 1)) {
1781 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1785 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1786 if (desc->desc.bNumEndpoints != 1)
1787 goto descriptor_error;
1789 endpoint = &desc->endpoint[0].desc;
1791 /* If it's not an interrupt in endpoint, we'd better punt! */
1792 if (!usb_endpoint_is_int_in(endpoint))
1793 goto descriptor_error;
1795 /* We found a hub */
1796 dev_info(&intf->dev, "USB hub found\n");
1798 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1800 dev_dbg(&intf->dev, "couldn't kmalloc hub struct\n");
1804 kref_init(&hub->kref);
1805 hub->intfdev = &intf->dev;
1807 INIT_DELAYED_WORK(&hub->leds, led_work);
1808 INIT_DELAYED_WORK(&hub->init_work, NULL);
1809 INIT_WORK(&hub->events, hub_event);
1813 usb_set_intfdata(intf, hub);
1814 intf->needs_remote_wakeup = 1;
1815 pm_suspend_ignore_children(&intf->dev, true);
1817 if (hdev->speed == USB_SPEED_HIGH)
1820 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1821 hub->quirk_check_port_auto_suspend = 1;
1823 if (hub_configure(hub, endpoint) >= 0)
1826 hub_disconnect(intf);
1831 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1833 struct usb_device *hdev = interface_to_usbdev(intf);
1834 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1836 /* assert ifno == 0 (part of hub spec) */
1838 case USBDEVFS_HUB_PORTINFO: {
1839 struct usbdevfs_hub_portinfo *info = user_data;
1842 spin_lock_irq(&device_state_lock);
1843 if (hdev->devnum <= 0)
1846 info->nports = hdev->maxchild;
1847 for (i = 0; i < info->nports; i++) {
1848 if (hub->ports[i]->child == NULL)
1852 hub->ports[i]->child->devnum;
1855 spin_unlock_irq(&device_state_lock);
1857 return info->nports + 1;
1866 * Allow user programs to claim ports on a hub. When a device is attached
1867 * to one of these "claimed" ports, the program will "own" the device.
1869 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1870 struct usb_dev_state ***ppowner)
1872 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1874 if (hdev->state == USB_STATE_NOTATTACHED)
1876 if (port1 == 0 || port1 > hdev->maxchild)
1879 /* Devices not managed by the hub driver
1880 * will always have maxchild equal to 0.
1882 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1886 /* In the following three functions, the caller must hold hdev's lock */
1887 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1888 struct usb_dev_state *owner)
1891 struct usb_dev_state **powner;
1893 rc = find_port_owner(hdev, port1, &powner);
1901 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1903 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1904 struct usb_dev_state *owner)
1907 struct usb_dev_state **powner;
1909 rc = find_port_owner(hdev, port1, &powner);
1912 if (*powner != owner)
1917 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1919 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1921 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1924 for (n = 0; n < hdev->maxchild; n++) {
1925 if (hub->ports[n]->port_owner == owner)
1926 hub->ports[n]->port_owner = NULL;
1931 /* The caller must hold udev's lock */
1932 bool usb_device_is_owned(struct usb_device *udev)
1934 struct usb_hub *hub;
1936 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1938 hub = usb_hub_to_struct_hub(udev->parent);
1939 return !!hub->ports[udev->portnum - 1]->port_owner;
1942 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1944 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1947 for (i = 0; i < udev->maxchild; ++i) {
1948 if (hub->ports[i]->child)
1949 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1951 if (udev->state == USB_STATE_SUSPENDED)
1952 udev->active_duration -= jiffies;
1953 udev->state = USB_STATE_NOTATTACHED;
1957 * usb_set_device_state - change a device's current state (usbcore, hcds)
1958 * @udev: pointer to device whose state should be changed
1959 * @new_state: new state value to be stored
1961 * udev->state is _not_ fully protected by the device lock. Although
1962 * most transitions are made only while holding the lock, the state can
1963 * can change to USB_STATE_NOTATTACHED at almost any time. This
1964 * is so that devices can be marked as disconnected as soon as possible,
1965 * without having to wait for any semaphores to be released. As a result,
1966 * all changes to any device's state must be protected by the
1967 * device_state_lock spinlock.
1969 * Once a device has been added to the device tree, all changes to its state
1970 * should be made using this routine. The state should _not_ be set directly.
1972 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1973 * Otherwise udev->state is set to new_state, and if new_state is
1974 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1975 * to USB_STATE_NOTATTACHED.
1977 void usb_set_device_state(struct usb_device *udev,
1978 enum usb_device_state new_state)
1980 unsigned long flags;
1983 spin_lock_irqsave(&device_state_lock, flags);
1984 if (udev->state == USB_STATE_NOTATTACHED)
1986 else if (new_state != USB_STATE_NOTATTACHED) {
1988 /* root hub wakeup capabilities are managed out-of-band
1989 * and may involve silicon errata ... ignore them here.
1992 if (udev->state == USB_STATE_SUSPENDED
1993 || new_state == USB_STATE_SUSPENDED)
1994 ; /* No change to wakeup settings */
1995 else if (new_state == USB_STATE_CONFIGURED)
1996 wakeup = (udev->quirks &
1997 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1998 udev->actconfig->desc.bmAttributes &
1999 USB_CONFIG_ATT_WAKEUP;
2003 if (udev->state == USB_STATE_SUSPENDED &&
2004 new_state != USB_STATE_SUSPENDED)
2005 udev->active_duration -= jiffies;
2006 else if (new_state == USB_STATE_SUSPENDED &&
2007 udev->state != USB_STATE_SUSPENDED)
2008 udev->active_duration += jiffies;
2009 udev->state = new_state;
2011 recursively_mark_NOTATTACHED(udev);
2012 spin_unlock_irqrestore(&device_state_lock, flags);
2014 device_set_wakeup_capable(&udev->dev, wakeup);
2016 EXPORT_SYMBOL_GPL(usb_set_device_state);
2019 * Choose a device number.
2021 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2022 * USB-2.0 buses they are also used as device addresses, however on
2023 * USB-3.0 buses the address is assigned by the controller hardware
2024 * and it usually is not the same as the device number.
2026 * WUSB devices are simple: they have no hubs behind, so the mapping
2027 * device <-> virtual port number becomes 1:1. Why? to simplify the
2028 * life of the device connection logic in
2029 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2030 * handshake we need to assign a temporary address in the unauthorized
2031 * space. For simplicity we use the first virtual port number found to
2032 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2033 * and that becomes it's address [X < 128] or its unauthorized address
2036 * We add 1 as an offset to the one-based USB-stack port number
2037 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2038 * 0 is reserved by USB for default address; (b) Linux's USB stack
2039 * uses always #1 for the root hub of the controller. So USB stack's
2040 * port #1, which is wusb virtual-port #0 has address #2.
2042 * Devices connected under xHCI are not as simple. The host controller
2043 * supports virtualization, so the hardware assigns device addresses and
2044 * the HCD must setup data structures before issuing a set address
2045 * command to the hardware.
2047 static void choose_devnum(struct usb_device *udev)
2050 struct usb_bus *bus = udev->bus;
2052 /* be safe when more hub events are proceed in parallel */
2053 mutex_lock(&bus->usb_address0_mutex);
2055 devnum = udev->portnum + 1;
2056 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2058 /* Try to allocate the next devnum beginning at
2059 * bus->devnum_next. */
2060 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2063 devnum = find_next_zero_bit(bus->devmap.devicemap,
2065 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2068 set_bit(devnum, bus->devmap.devicemap);
2069 udev->devnum = devnum;
2071 mutex_unlock(&bus->usb_address0_mutex);
2074 static void release_devnum(struct usb_device *udev)
2076 if (udev->devnum > 0) {
2077 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2082 static void update_devnum(struct usb_device *udev, int devnum)
2084 /* The address for a WUSB device is managed by wusbcore. */
2086 udev->devnum = devnum;
2089 static void hub_free_dev(struct usb_device *udev)
2091 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2093 /* Root hubs aren't real devices, so don't free HCD resources */
2094 if (hcd->driver->free_dev && udev->parent)
2095 hcd->driver->free_dev(hcd, udev);
2098 static void hub_disconnect_children(struct usb_device *udev)
2100 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2103 /* Free up all the children before we remove this device */
2104 for (i = 0; i < udev->maxchild; i++) {
2105 if (hub->ports[i]->child)
2106 usb_disconnect(&hub->ports[i]->child);
2111 * usb_disconnect - disconnect a device (usbcore-internal)
2112 * @pdev: pointer to device being disconnected
2113 * Context: !in_interrupt ()
2115 * Something got disconnected. Get rid of it and all of its children.
2117 * If *pdev is a normal device then the parent hub must already be locked.
2118 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2119 * which protects the set of root hubs as well as the list of buses.
2121 * Only hub drivers (including virtual root hub drivers for host
2122 * controllers) should ever call this.
2124 * This call is synchronous, and may not be used in an interrupt context.
2126 void usb_disconnect(struct usb_device **pdev)
2128 struct usb_port *port_dev = NULL;
2129 struct usb_device *udev = *pdev;
2130 struct usb_hub *hub = NULL;
2133 /* mark the device as inactive, so any further urb submissions for
2134 * this device (and any of its children) will fail immediately.
2135 * this quiesces everything except pending urbs.
2137 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2138 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2141 usb_lock_device(udev);
2143 hub_disconnect_children(udev);
2145 /* deallocate hcd/hardware state ... nuking all pending urbs and
2146 * cleaning up all state associated with the current configuration
2147 * so that the hardware is now fully quiesced.
2149 dev_dbg(&udev->dev, "unregistering device\n");
2150 usb_disable_device(udev, 0);
2151 usb_hcd_synchronize_unlinks(udev);
2154 port1 = udev->portnum;
2155 hub = usb_hub_to_struct_hub(udev->parent);
2156 port_dev = hub->ports[port1 - 1];
2158 sysfs_remove_link(&udev->dev.kobj, "port");
2159 sysfs_remove_link(&port_dev->dev.kobj, "device");
2162 * As usb_port_runtime_resume() de-references udev, make
2163 * sure no resumes occur during removal
2165 if (!test_and_set_bit(port1, hub->child_usage_bits))
2166 pm_runtime_get_sync(&port_dev->dev);
2169 usb_remove_ep_devs(&udev->ep0);
2170 usb_unlock_device(udev);
2172 /* Unregister the device. The device driver is responsible
2173 * for de-configuring the device and invoking the remove-device
2174 * notifier chain (used by usbfs and possibly others).
2176 device_del(&udev->dev);
2178 /* Free the device number and delete the parent's children[]
2179 * (or root_hub) pointer.
2181 release_devnum(udev);
2183 /* Avoid races with recursively_mark_NOTATTACHED() */
2184 spin_lock_irq(&device_state_lock);
2186 spin_unlock_irq(&device_state_lock);
2188 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2189 pm_runtime_put(&port_dev->dev);
2193 put_device(&udev->dev);
2196 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2197 static void show_string(struct usb_device *udev, char *id, char *string)
2201 dev_info(&udev->dev, "%s: %s\n", id, string);
2204 static void announce_device(struct usb_device *udev)
2206 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2207 le16_to_cpu(udev->descriptor.idVendor),
2208 le16_to_cpu(udev->descriptor.idProduct));
2209 dev_info(&udev->dev,
2210 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2211 udev->descriptor.iManufacturer,
2212 udev->descriptor.iProduct,
2213 udev->descriptor.iSerialNumber);
2214 show_string(udev, "Product", udev->product);
2215 show_string(udev, "Manufacturer", udev->manufacturer);
2216 show_string(udev, "SerialNumber", udev->serial);
2219 static inline void announce_device(struct usb_device *udev) { }
2224 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2225 * @udev: newly addressed device (in ADDRESS state)
2227 * Finish enumeration for On-The-Go devices
2229 * Return: 0 if successful. A negative error code otherwise.
2231 static int usb_enumerate_device_otg(struct usb_device *udev)
2235 #ifdef CONFIG_USB_OTG
2237 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2238 * to wake us after we've powered off VBUS; and HNP, switching roles
2239 * "host" to "peripheral". The OTG descriptor helps figure this out.
2241 if (!udev->bus->is_b_host
2243 && udev->parent == udev->bus->root_hub) {
2244 struct usb_otg_descriptor *desc = NULL;
2245 struct usb_bus *bus = udev->bus;
2246 unsigned port1 = udev->portnum;
2248 /* descriptor may appear anywhere in config */
2249 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2250 le16_to_cpu(udev->config[0].desc.wTotalLength),
2251 USB_DT_OTG, (void **) &desc);
2252 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2255 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2256 (port1 == bus->otg_port) ? "" : "non-");
2258 /* enable HNP before suspend, it's simpler */
2259 if (port1 == bus->otg_port) {
2260 bus->b_hnp_enable = 1;
2261 err = usb_control_msg(udev,
2262 usb_sndctrlpipe(udev, 0),
2263 USB_REQ_SET_FEATURE, 0,
2264 USB_DEVICE_B_HNP_ENABLE,
2266 USB_CTRL_SET_TIMEOUT);
2269 * OTG MESSAGE: report errors here,
2270 * customize to match your product.
2272 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2274 bus->b_hnp_enable = 0;
2276 } else if (desc->bLength == sizeof
2277 (struct usb_otg_descriptor)) {
2278 /* Set a_alt_hnp_support for legacy otg device */
2279 err = usb_control_msg(udev,
2280 usb_sndctrlpipe(udev, 0),
2281 USB_REQ_SET_FEATURE, 0,
2282 USB_DEVICE_A_ALT_HNP_SUPPORT,
2284 USB_CTRL_SET_TIMEOUT);
2287 "set a_alt_hnp_support failed: %d\n",
2297 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2298 * @udev: newly addressed device (in ADDRESS state)
2300 * This is only called by usb_new_device() and usb_authorize_device()
2301 * and FIXME -- all comments that apply to them apply here wrt to
2304 * If the device is WUSB and not authorized, we don't attempt to read
2305 * the string descriptors, as they will be errored out by the device
2306 * until it has been authorized.
2308 * Return: 0 if successful. A negative error code otherwise.
2310 static int usb_enumerate_device(struct usb_device *udev)
2313 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2315 if (udev->config == NULL) {
2316 err = usb_get_configuration(udev);
2319 dev_err(&udev->dev, "can't read configurations, error %d\n",
2325 /* read the standard strings and cache them if present */
2326 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2327 udev->manufacturer = usb_cache_string(udev,
2328 udev->descriptor.iManufacturer);
2329 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2331 err = usb_enumerate_device_otg(udev);
2335 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2336 !is_targeted(udev)) {
2337 /* Maybe it can talk to us, though we can't talk to it.
2338 * (Includes HNP test device.)
2340 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2341 || udev->bus->is_b_host)) {
2342 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2344 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2349 usb_detect_interface_quirks(udev);
2354 static void set_usb_port_removable(struct usb_device *udev)
2356 struct usb_device *hdev = udev->parent;
2357 struct usb_hub *hub;
2358 u8 port = udev->portnum;
2359 u16 wHubCharacteristics;
2360 bool removable = true;
2365 hub = usb_hub_to_struct_hub(udev->parent);
2368 * If the platform firmware has provided information about a port,
2369 * use that to determine whether it's removable.
2371 switch (hub->ports[udev->portnum - 1]->connect_type) {
2372 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2373 udev->removable = USB_DEVICE_REMOVABLE;
2375 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2376 case USB_PORT_NOT_USED:
2377 udev->removable = USB_DEVICE_FIXED;
2384 * Otherwise, check whether the hub knows whether a port is removable
2387 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2389 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2392 if (hub_is_superspeed(hdev)) {
2393 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2397 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2402 udev->removable = USB_DEVICE_REMOVABLE;
2404 udev->removable = USB_DEVICE_FIXED;
2409 * usb_new_device - perform initial device setup (usbcore-internal)
2410 * @udev: newly addressed device (in ADDRESS state)
2412 * This is called with devices which have been detected but not fully
2413 * enumerated. The device descriptor is available, but not descriptors
2414 * for any device configuration. The caller must have locked either
2415 * the parent hub (if udev is a normal device) or else the
2416 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2417 * udev has already been installed, but udev is not yet visible through
2418 * sysfs or other filesystem code.
2420 * This call is synchronous, and may not be used in an interrupt context.
2422 * Only the hub driver or root-hub registrar should ever call this.
2424 * Return: Whether the device is configured properly or not. Zero if the
2425 * interface was registered with the driver core; else a negative errno
2429 int usb_new_device(struct usb_device *udev)
2434 /* Initialize non-root-hub device wakeup to disabled;
2435 * device (un)configuration controls wakeup capable
2436 * sysfs power/wakeup controls wakeup enabled/disabled
2438 device_init_wakeup(&udev->dev, 0);
2441 /* Tell the runtime-PM framework the device is active */
2442 pm_runtime_set_active(&udev->dev);
2443 pm_runtime_get_noresume(&udev->dev);
2444 pm_runtime_use_autosuspend(&udev->dev);
2445 pm_runtime_enable(&udev->dev);
2447 /* By default, forbid autosuspend for all devices. It will be
2448 * allowed for hubs during binding.
2450 usb_disable_autosuspend(udev);
2452 err = usb_enumerate_device(udev); /* Read descriptors */
2455 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2456 udev->devnum, udev->bus->busnum,
2457 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2458 /* export the usbdev device-node for libusb */
2459 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2460 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2462 /* Tell the world! */
2463 announce_device(udev);
2466 add_device_randomness(udev->serial, strlen(udev->serial));
2468 add_device_randomness(udev->product, strlen(udev->product));
2469 if (udev->manufacturer)
2470 add_device_randomness(udev->manufacturer,
2471 strlen(udev->manufacturer));
2473 device_enable_async_suspend(&udev->dev);
2475 /* check whether the hub or firmware marks this port as non-removable */
2477 set_usb_port_removable(udev);
2479 /* Register the device. The device driver is responsible
2480 * for configuring the device and invoking the add-device
2481 * notifier chain (used by usbfs and possibly others).
2483 err = device_add(&udev->dev);
2485 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2489 /* Create link files between child device and usb port device. */
2491 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2492 int port1 = udev->portnum;
2493 struct usb_port *port_dev = hub->ports[port1 - 1];
2495 err = sysfs_create_link(&udev->dev.kobj,
2496 &port_dev->dev.kobj, "port");
2500 err = sysfs_create_link(&port_dev->dev.kobj,
2501 &udev->dev.kobj, "device");
2503 sysfs_remove_link(&udev->dev.kobj, "port");
2507 if (!test_and_set_bit(port1, hub->child_usage_bits))
2508 pm_runtime_get_sync(&port_dev->dev);
2511 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2512 usb_mark_last_busy(udev);
2513 pm_runtime_put_sync_autosuspend(&udev->dev);
2517 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2518 pm_runtime_disable(&udev->dev);
2519 pm_runtime_set_suspended(&udev->dev);
2525 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2526 * @usb_dev: USB device
2528 * Move the USB device to a very basic state where interfaces are disabled
2529 * and the device is in fact unconfigured and unusable.
2531 * We share a lock (that we have) with device_del(), so we need to
2536 int usb_deauthorize_device(struct usb_device *usb_dev)
2538 usb_lock_device(usb_dev);
2539 if (usb_dev->authorized == 0)
2540 goto out_unauthorized;
2542 usb_dev->authorized = 0;
2543 usb_set_configuration(usb_dev, -1);
2546 usb_unlock_device(usb_dev);
2551 int usb_authorize_device(struct usb_device *usb_dev)
2555 usb_lock_device(usb_dev);
2556 if (usb_dev->authorized == 1)
2557 goto out_authorized;
2559 result = usb_autoresume_device(usb_dev);
2561 dev_err(&usb_dev->dev,
2562 "can't autoresume for authorization: %d\n", result);
2563 goto error_autoresume;
2566 if (usb_dev->wusb) {
2567 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2569 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2570 "authorization: %d\n", result);
2571 goto error_device_descriptor;
2575 usb_dev->authorized = 1;
2576 /* Choose and set the configuration. This registers the interfaces
2577 * with the driver core and lets interface drivers bind to them.
2579 c = usb_choose_configuration(usb_dev);
2581 result = usb_set_configuration(usb_dev, c);
2583 dev_err(&usb_dev->dev,
2584 "can't set config #%d, error %d\n", c, result);
2585 /* This need not be fatal. The user can try to
2586 * set other configurations. */
2589 dev_info(&usb_dev->dev, "authorized to connect\n");
2591 error_device_descriptor:
2592 usb_autosuspend_device(usb_dev);
2595 usb_unlock_device(usb_dev); /* complements locktree */
2600 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2601 static unsigned hub_is_wusb(struct usb_hub *hub)
2603 struct usb_hcd *hcd;
2604 if (hub->hdev->parent != NULL) /* not a root hub? */
2606 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2607 return hcd->wireless;
2611 #define PORT_RESET_TRIES 5
2612 #define SET_ADDRESS_TRIES 2
2613 #define GET_DESCRIPTOR_TRIES 2
2614 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2615 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2617 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2618 #define HUB_SHORT_RESET_TIME 10
2619 #define HUB_BH_RESET_TIME 50
2620 #define HUB_LONG_RESET_TIME 200
2621 #define HUB_RESET_TIMEOUT 800
2624 * "New scheme" enumeration causes an extra state transition to be
2625 * exposed to an xhci host and causes USB3 devices to receive control
2626 * commands in the default state. This has been seen to cause
2627 * enumeration failures, so disable this enumeration scheme for USB3
2630 static bool use_new_scheme(struct usb_device *udev, int retry)
2632 if (udev->speed == USB_SPEED_SUPER)
2635 return USE_NEW_SCHEME(retry);
2638 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2639 * Port worm reset is required to recover
2641 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2646 if (!hub_is_superspeed(hub->hdev))
2649 if (test_bit(port1, hub->warm_reset_bits))
2652 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2653 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2654 || link_state == USB_SS_PORT_LS_COMP_MOD;
2657 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2658 struct usb_device *udev, unsigned int delay, bool warm)
2660 int delay_time, ret;
2664 for (delay_time = 0;
2665 delay_time < HUB_RESET_TIMEOUT;
2666 delay_time += delay) {
2667 /* wait to give the device a chance to reset */
2670 /* read and decode port status */
2671 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2675 /* The port state is unknown until the reset completes. */
2676 if (!(portstatus & USB_PORT_STAT_RESET))
2679 /* switch to the long delay after two short delay failures */
2680 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2681 delay = HUB_LONG_RESET_TIME;
2683 dev_dbg(&hub->ports[port1 - 1]->dev,
2684 "not %sreset yet, waiting %dms\n",
2685 warm ? "warm " : "", delay);
2688 if ((portstatus & USB_PORT_STAT_RESET))
2691 if (hub_port_warm_reset_required(hub, port1, portstatus))
2694 /* Device went away? */
2695 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2698 /* bomb out completely if the connection bounced. A USB 3.0
2699 * connection may bounce if multiple warm resets were issued,
2700 * but the device may have successfully re-connected. Ignore it.
2702 if (!hub_is_superspeed(hub->hdev) &&
2703 (portchange & USB_PORT_STAT_C_CONNECTION))
2706 if (!(portstatus & USB_PORT_STAT_ENABLE))
2712 if (hub_is_wusb(hub))
2713 udev->speed = USB_SPEED_WIRELESS;
2714 else if (hub_is_superspeed(hub->hdev))
2715 udev->speed = USB_SPEED_SUPER;
2716 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2717 udev->speed = USB_SPEED_HIGH;
2718 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2719 udev->speed = USB_SPEED_LOW;
2721 udev->speed = USB_SPEED_FULL;
2725 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2726 static int hub_port_reset(struct usb_hub *hub, int port1,
2727 struct usb_device *udev, unsigned int delay, bool warm)
2730 u16 portchange, portstatus;
2731 struct usb_port *port_dev = hub->ports[port1 - 1];
2733 if (!hub_is_superspeed(hub->hdev)) {
2735 dev_err(hub->intfdev, "only USB3 hub support "
2739 /* Block EHCI CF initialization during the port reset.
2740 * Some companion controllers don't like it when they mix.
2742 down_read(&ehci_cf_port_reset_rwsem);
2745 * If the caller hasn't explicitly requested a warm reset,
2746 * double check and see if one is needed.
2748 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2749 if (hub_port_warm_reset_required(hub, port1,
2753 clear_bit(port1, hub->warm_reset_bits);
2755 /* Reset the port */
2756 for (i = 0; i < PORT_RESET_TRIES; i++) {
2757 status = set_port_feature(hub->hdev, port1, (warm ?
2758 USB_PORT_FEAT_BH_PORT_RESET :
2759 USB_PORT_FEAT_RESET));
2760 if (status == -ENODEV) {
2761 ; /* The hub is gone */
2762 } else if (status) {
2763 dev_err(&port_dev->dev,
2764 "cannot %sreset (err = %d)\n",
2765 warm ? "warm " : "", status);
2767 status = hub_port_wait_reset(hub, port1, udev, delay,
2769 if (status && status != -ENOTCONN && status != -ENODEV)
2770 dev_dbg(hub->intfdev,
2771 "port_wait_reset: err = %d\n",
2775 /* Check for disconnect or reset */
2776 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2777 usb_clear_port_feature(hub->hdev, port1,
2778 USB_PORT_FEAT_C_RESET);
2780 if (!hub_is_superspeed(hub->hdev))
2783 usb_clear_port_feature(hub->hdev, port1,
2784 USB_PORT_FEAT_C_BH_PORT_RESET);
2785 usb_clear_port_feature(hub->hdev, port1,
2786 USB_PORT_FEAT_C_PORT_LINK_STATE);
2787 usb_clear_port_feature(hub->hdev, port1,
2788 USB_PORT_FEAT_C_CONNECTION);
2791 * If a USB 3.0 device migrates from reset to an error
2792 * state, re-issue the warm reset.
2794 if (hub_port_status(hub, port1,
2795 &portstatus, &portchange) < 0)
2798 if (!hub_port_warm_reset_required(hub, port1,
2803 * If the port is in SS.Inactive or Compliance Mode, the
2804 * hot or warm reset failed. Try another warm reset.
2807 dev_dbg(&port_dev->dev,
2808 "hot reset failed, warm reset\n");
2813 dev_dbg(&port_dev->dev,
2814 "not enabled, trying %sreset again...\n",
2815 warm ? "warm " : "");
2816 delay = HUB_LONG_RESET_TIME;
2819 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2823 /* TRSTRCY = 10 ms; plus some extra */
2826 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2828 update_devnum(udev, 0);
2829 /* The xHC may think the device is already reset,
2830 * so ignore the status.
2832 if (hcd->driver->reset_device)
2833 hcd->driver->reset_device(hcd, udev);
2835 usb_set_device_state(udev, USB_STATE_DEFAULT);
2839 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2842 if (!hub_is_superspeed(hub->hdev))
2843 up_read(&ehci_cf_port_reset_rwsem);
2848 /* Check if a port is power on */
2849 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2853 if (hub_is_superspeed(hub->hdev)) {
2854 if (portstatus & USB_SS_PORT_STAT_POWER)
2857 if (portstatus & USB_PORT_STAT_POWER)
2864 static void usb_lock_port(struct usb_port *port_dev)
2865 __acquires(&port_dev->status_lock)
2867 mutex_lock(&port_dev->status_lock);
2868 __acquire(&port_dev->status_lock);
2871 static void usb_unlock_port(struct usb_port *port_dev)
2872 __releases(&port_dev->status_lock)
2874 mutex_unlock(&port_dev->status_lock);
2875 __release(&port_dev->status_lock);
2880 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2881 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2885 if (hub_is_superspeed(hub->hdev)) {
2886 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2887 == USB_SS_PORT_LS_U3)
2890 if (portstatus & USB_PORT_STAT_SUSPEND)
2897 /* Determine whether the device on a port is ready for a normal resume,
2898 * is ready for a reset-resume, or should be disconnected.
2900 static int check_port_resume_type(struct usb_device *udev,
2901 struct usb_hub *hub, int port1,
2902 int status, u16 portchange, u16 portstatus)
2904 struct usb_port *port_dev = hub->ports[port1 - 1];
2908 /* Is a warm reset needed to recover the connection? */
2909 if (status == 0 && udev->reset_resume
2910 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2913 /* Is the device still present? */
2914 else if (status || port_is_suspended(hub, portstatus) ||
2915 !port_is_power_on(hub, portstatus)) {
2918 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2920 usleep_range(200, 300);
2921 status = hub_port_status(hub, port1, &portstatus,
2928 /* Can't do a normal resume if the port isn't enabled,
2929 * so try a reset-resume instead.
2931 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2932 if (udev->persist_enabled)
2933 udev->reset_resume = 1;
2939 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2940 portchange, portstatus, status);
2941 } else if (udev->reset_resume) {
2943 /* Late port handoff can set status-change bits */
2944 if (portchange & USB_PORT_STAT_C_CONNECTION)
2945 usb_clear_port_feature(hub->hdev, port1,
2946 USB_PORT_FEAT_C_CONNECTION);
2947 if (portchange & USB_PORT_STAT_C_ENABLE)
2948 usb_clear_port_feature(hub->hdev, port1,
2949 USB_PORT_FEAT_C_ENABLE);
2955 int usb_disable_ltm(struct usb_device *udev)
2957 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2959 /* Check if the roothub and device supports LTM. */
2960 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2961 !usb_device_supports_ltm(udev))
2964 /* Clear Feature LTM Enable can only be sent if the device is
2967 if (!udev->actconfig)
2970 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2971 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2972 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2973 USB_CTRL_SET_TIMEOUT);
2975 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2977 void usb_enable_ltm(struct usb_device *udev)
2979 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2981 /* Check if the roothub and device supports LTM. */
2982 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2983 !usb_device_supports_ltm(udev))
2986 /* Set Feature LTM Enable can only be sent if the device is
2989 if (!udev->actconfig)
2992 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2993 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2994 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2995 USB_CTRL_SET_TIMEOUT);
2997 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3000 * usb_enable_remote_wakeup - enable remote wakeup for a device
3001 * @udev: target device
3003 * For USB-2 devices: Set the device's remote wakeup feature.
3005 * For USB-3 devices: Assume there's only one function on the device and
3006 * enable remote wake for the first interface. FIXME if the interface
3007 * association descriptor shows there's more than one function.
3009 static int usb_enable_remote_wakeup(struct usb_device *udev)
3011 if (udev->speed < USB_SPEED_SUPER)
3012 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3013 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3014 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3015 USB_CTRL_SET_TIMEOUT);
3017 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3018 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3019 USB_INTRF_FUNC_SUSPEND,
3020 USB_INTRF_FUNC_SUSPEND_RW |
3021 USB_INTRF_FUNC_SUSPEND_LP,
3022 NULL, 0, USB_CTRL_SET_TIMEOUT);
3026 * usb_disable_remote_wakeup - disable remote wakeup for a device
3027 * @udev: target device
3029 * For USB-2 devices: Clear the device's remote wakeup feature.
3031 * For USB-3 devices: Assume there's only one function on the device and
3032 * disable remote wake for the first interface. FIXME if the interface
3033 * association descriptor shows there's more than one function.
3035 static int usb_disable_remote_wakeup(struct usb_device *udev)
3037 if (udev->speed < USB_SPEED_SUPER)
3038 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3039 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3040 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3041 USB_CTRL_SET_TIMEOUT);
3043 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3044 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
3045 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3046 USB_CTRL_SET_TIMEOUT);
3049 /* Count of wakeup-enabled devices at or below udev */
3050 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3052 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3054 return udev->do_remote_wakeup +
3055 (hub ? hub->wakeup_enabled_descendants : 0);
3059 * usb_port_suspend - suspend a usb device's upstream port
3060 * @udev: device that's no longer in active use, not a root hub
3061 * Context: must be able to sleep; device not locked; pm locks held
3063 * Suspends a USB device that isn't in active use, conserving power.
3064 * Devices may wake out of a suspend, if anything important happens,
3065 * using the remote wakeup mechanism. They may also be taken out of
3066 * suspend by the host, using usb_port_resume(). It's also routine
3067 * to disconnect devices while they are suspended.
3069 * This only affects the USB hardware for a device; its interfaces
3070 * (and, for hubs, child devices) must already have been suspended.
3072 * Selective port suspend reduces power; most suspended devices draw
3073 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3074 * All devices below the suspended port are also suspended.
3076 * Devices leave suspend state when the host wakes them up. Some devices
3077 * also support "remote wakeup", where the device can activate the USB
3078 * tree above them to deliver data, such as a keypress or packet. In
3079 * some cases, this wakes the USB host.
3081 * Suspending OTG devices may trigger HNP, if that's been enabled
3082 * between a pair of dual-role devices. That will change roles, such
3083 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3085 * Devices on USB hub ports have only one "suspend" state, corresponding
3086 * to ACPI D2, "may cause the device to lose some context".
3087 * State transitions include:
3089 * - suspend, resume ... when the VBUS power link stays live
3090 * - suspend, disconnect ... VBUS lost
3092 * Once VBUS drop breaks the circuit, the port it's using has to go through
3093 * normal re-enumeration procedures, starting with enabling VBUS power.
3094 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3095 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3096 * timer, no SRP, no requests through sysfs.
3098 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3099 * suspended until their bus goes into global suspend (i.e., the root
3100 * hub is suspended). Nevertheless, we change @udev->state to
3101 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3102 * upstream port setting is stored in @udev->port_is_suspended.
3104 * Returns 0 on success, else negative errno.
3106 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3108 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3109 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3110 int port1 = udev->portnum;
3112 bool really_suspend = true;
3114 usb_lock_port(port_dev);
3116 /* enable remote wakeup when appropriate; this lets the device
3117 * wake up the upstream hub (including maybe the root hub).
3119 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3120 * we don't explicitly enable it here.
3122 if (udev->do_remote_wakeup) {
3123 status = usb_enable_remote_wakeup(udev);
3125 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3127 /* bail if autosuspend is requested */
3128 if (PMSG_IS_AUTO(msg))
3133 /* disable USB2 hardware LPM */
3134 if (udev->usb2_hw_lpm_enabled == 1)
3135 usb_set_usb2_hardware_lpm(udev, 0);
3137 if (usb_disable_ltm(udev)) {
3138 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3140 if (PMSG_IS_AUTO(msg))
3143 if (usb_unlocked_disable_lpm(udev)) {
3144 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3146 if (PMSG_IS_AUTO(msg))
3151 if (hub_is_superspeed(hub->hdev))
3152 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3155 * For system suspend, we do not need to enable the suspend feature
3156 * on individual USB-2 ports. The devices will automatically go
3157 * into suspend a few ms after the root hub stops sending packets.
3158 * The USB 2.0 spec calls this "global suspend".
3160 * However, many USB hubs have a bug: They don't relay wakeup requests
3161 * from a downstream port if the port's suspend feature isn't on.
3162 * Therefore we will turn on the suspend feature if udev or any of its
3163 * descendants is enabled for remote wakeup.
3165 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3166 status = set_port_feature(hub->hdev, port1,
3167 USB_PORT_FEAT_SUSPEND);
3169 really_suspend = false;
3173 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3175 /* Try to enable USB3 LPM and LTM again */
3176 usb_unlocked_enable_lpm(udev);
3178 usb_enable_ltm(udev);
3180 /* Try to enable USB2 hardware LPM again */
3181 if (udev->usb2_hw_lpm_capable == 1)
3182 usb_set_usb2_hardware_lpm(udev, 1);
3184 if (udev->do_remote_wakeup)
3185 (void) usb_disable_remote_wakeup(udev);
3188 /* System sleep transitions should never fail */
3189 if (!PMSG_IS_AUTO(msg))
3192 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3193 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3194 udev->do_remote_wakeup);
3195 if (really_suspend) {
3196 udev->port_is_suspended = 1;
3198 /* device has up to 10 msec to fully suspend */
3201 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3204 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3205 && test_and_clear_bit(port1, hub->child_usage_bits))
3206 pm_runtime_put_sync(&port_dev->dev);
3208 usb_mark_last_busy(hub->hdev);
3210 usb_unlock_port(port_dev);
3215 * If the USB "suspend" state is in use (rather than "global suspend"),
3216 * many devices will be individually taken out of suspend state using
3217 * special "resume" signaling. This routine kicks in shortly after
3218 * hardware resume signaling is finished, either because of selective
3219 * resume (by host) or remote wakeup (by device) ... now see what changed
3220 * in the tree that's rooted at this device.
3222 * If @udev->reset_resume is set then the device is reset before the
3223 * status check is done.
3225 static int finish_port_resume(struct usb_device *udev)
3230 /* caller owns the udev device lock */
3231 dev_dbg(&udev->dev, "%s\n",
3232 udev->reset_resume ? "finish reset-resume" : "finish resume");
3234 /* usb ch9 identifies four variants of SUSPENDED, based on what
3235 * state the device resumes to. Linux currently won't see the
3236 * first two on the host side; they'd be inside hub_port_init()
3237 * during many timeouts, but hub_wq can't suspend until later.
3239 usb_set_device_state(udev, udev->actconfig
3240 ? USB_STATE_CONFIGURED
3241 : USB_STATE_ADDRESS);
3243 /* 10.5.4.5 says not to reset a suspended port if the attached
3244 * device is enabled for remote wakeup. Hence the reset
3245 * operation is carried out here, after the port has been
3248 if (udev->reset_resume) {
3250 * If the device morphs or switches modes when it is reset,
3251 * we don't want to perform a reset-resume. We'll fail the
3252 * resume, which will cause a logical disconnect, and then
3253 * the device will be rediscovered.
3256 if (udev->quirks & USB_QUIRK_RESET)
3259 status = usb_reset_and_verify_device(udev);
3262 /* 10.5.4.5 says be sure devices in the tree are still there.
3263 * For now let's assume the device didn't go crazy on resume,
3264 * and device drivers will know about any resume quirks.
3268 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3270 /* If a normal resume failed, try doing a reset-resume */
3271 if (status && !udev->reset_resume && udev->persist_enabled) {
3272 dev_dbg(&udev->dev, "retry with reset-resume\n");
3273 udev->reset_resume = 1;
3274 goto retry_reset_resume;
3279 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3282 * There are a few quirky devices which violate the standard
3283 * by claiming to have remote wakeup enabled after a reset,
3284 * which crash if the feature is cleared, hence check for
3285 * udev->reset_resume
3287 } else if (udev->actconfig && !udev->reset_resume) {
3288 if (udev->speed < USB_SPEED_SUPER) {
3289 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3290 status = usb_disable_remote_wakeup(udev);
3292 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3294 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3295 | USB_INTRF_STAT_FUNC_RW))
3296 status = usb_disable_remote_wakeup(udev);
3301 "disable remote wakeup, status %d\n",
3309 * There are some SS USB devices which take longer time for link training.
3310 * XHCI specs 4.19.4 says that when Link training is successful, port
3311 * sets CSC bit to 1. So if SW reads port status before successful link
3312 * training, then it will not find device to be present.
3313 * USB Analyzer log with such buggy devices show that in some cases
3314 * device switch on the RX termination after long delay of host enabling
3315 * the VBUS. In few other cases it has been seen that device fails to
3316 * negotiate link training in first attempt. It has been
3317 * reported till now that few devices take as long as 2000 ms to train
3318 * the link after host enabling its VBUS and termination. Following
3319 * routine implements a 2000 ms timeout for link training. If in a case
3320 * link trains before timeout, loop will exit earlier.
3322 * FIXME: If a device was connected before suspend, but was removed
3323 * while system was asleep, then the loop in the following routine will
3324 * only exit at timeout.
3326 * This routine should only be called when persist is enabled for a SS
3329 static int wait_for_ss_port_enable(struct usb_device *udev,
3330 struct usb_hub *hub, int *port1,
3331 u16 *portchange, u16 *portstatus)
3333 int status = 0, delay_ms = 0;
3335 while (delay_ms < 2000) {
3336 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3340 status = hub_port_status(hub, *port1, portstatus, portchange);
3346 * usb_port_resume - re-activate a suspended usb device's upstream port
3347 * @udev: device to re-activate, not a root hub
3348 * Context: must be able to sleep; device not locked; pm locks held
3350 * This will re-activate the suspended device, increasing power usage
3351 * while letting drivers communicate again with its endpoints.
3352 * USB resume explicitly guarantees that the power session between
3353 * the host and the device is the same as it was when the device
3356 * If @udev->reset_resume is set then this routine won't check that the
3357 * port is still enabled. Furthermore, finish_port_resume() above will
3358 * reset @udev. The end result is that a broken power session can be
3359 * recovered and @udev will appear to persist across a loss of VBUS power.
3361 * For example, if a host controller doesn't maintain VBUS suspend current
3362 * during a system sleep or is reset when the system wakes up, all the USB
3363 * power sessions below it will be broken. This is especially troublesome
3364 * for mass-storage devices containing mounted filesystems, since the
3365 * device will appear to have disconnected and all the memory mappings
3366 * to it will be lost. Using the USB_PERSIST facility, the device can be
3367 * made to appear as if it had not disconnected.
3369 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3370 * every effort to insure that the same device is present after the
3371 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3372 * quite possible for a device to remain unaltered but its media to be
3373 * changed. If the user replaces a flash memory card while the system is
3374 * asleep, he will have only himself to blame when the filesystem on the
3375 * new card is corrupted and the system crashes.
3377 * Returns 0 on success, else negative errno.
3379 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3381 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3382 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3383 int port1 = udev->portnum;
3385 u16 portchange, portstatus;
3387 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3388 status = pm_runtime_get_sync(&port_dev->dev);
3390 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3396 usb_lock_port(port_dev);
3398 /* Skip the initial Clear-Suspend step for a remote wakeup */
3399 status = hub_port_status(hub, port1, &portstatus, &portchange);
3400 if (status == 0 && !port_is_suspended(hub, portstatus))
3401 goto SuspendCleared;
3403 /* see 7.1.7.7; affects power usage, but not budgeting */
3404 if (hub_is_superspeed(hub->hdev))
3405 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3407 status = usb_clear_port_feature(hub->hdev,
3408 port1, USB_PORT_FEAT_SUSPEND);
3410 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3412 /* drive resume for USB_RESUME_TIMEOUT msec */
3413 dev_dbg(&udev->dev, "usb %sresume\n",
3414 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3415 msleep(USB_RESUME_TIMEOUT);
3417 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3418 * stop resume signaling. Then finish the resume
3421 status = hub_port_status(hub, port1, &portstatus, &portchange);
3423 /* TRSMRCY = 10 msec */
3429 udev->port_is_suspended = 0;
3430 if (hub_is_superspeed(hub->hdev)) {
3431 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3432 usb_clear_port_feature(hub->hdev, port1,
3433 USB_PORT_FEAT_C_PORT_LINK_STATE);
3435 if (portchange & USB_PORT_STAT_C_SUSPEND)
3436 usb_clear_port_feature(hub->hdev, port1,
3437 USB_PORT_FEAT_C_SUSPEND);
3441 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3442 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3445 status = check_port_resume_type(udev,
3446 hub, port1, status, portchange, portstatus);
3448 status = finish_port_resume(udev);
3450 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3451 hub_port_logical_disconnect(hub, port1);
3453 /* Try to enable USB2 hardware LPM */
3454 if (udev->usb2_hw_lpm_capable == 1)
3455 usb_set_usb2_hardware_lpm(udev, 1);
3457 /* Try to enable USB3 LTM and LPM */
3458 usb_enable_ltm(udev);
3459 usb_unlocked_enable_lpm(udev);
3462 usb_unlock_port(port_dev);
3467 int usb_remote_wakeup(struct usb_device *udev)
3471 usb_lock_device(udev);
3472 if (udev->state == USB_STATE_SUSPENDED) {
3473 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3474 status = usb_autoresume_device(udev);
3476 /* Let the drivers do their thing, then... */
3477 usb_autosuspend_device(udev);
3480 usb_unlock_device(udev);
3484 /* Returns 1 if there was a remote wakeup and a connect status change. */
3485 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3486 u16 portstatus, u16 portchange)
3487 __must_hold(&port_dev->status_lock)
3489 struct usb_port *port_dev = hub->ports[port - 1];
3490 struct usb_device *hdev;
3491 struct usb_device *udev;
3492 int connect_change = 0;
3496 udev = port_dev->child;
3497 if (!hub_is_superspeed(hdev)) {
3498 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3500 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3502 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3503 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3509 /* TRSMRCY = 10 msec */
3512 usb_unlock_port(port_dev);
3513 ret = usb_remote_wakeup(udev);
3514 usb_lock_port(port_dev);
3519 hub_port_disable(hub, port, 1);
3521 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3522 return connect_change;
3525 static int check_ports_changed(struct usb_hub *hub)
3529 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3530 u16 portstatus, portchange;
3533 status = hub_port_status(hub, port1, &portstatus, &portchange);
3534 if (!status && portchange)
3540 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3542 struct usb_hub *hub = usb_get_intfdata(intf);
3543 struct usb_device *hdev = hub->hdev;
3548 * Warn if children aren't already suspended.
3549 * Also, add up the number of wakeup-enabled descendants.
3551 hub->wakeup_enabled_descendants = 0;
3552 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3553 struct usb_port *port_dev = hub->ports[port1 - 1];
3554 struct usb_device *udev = port_dev->child;
3556 if (udev && udev->can_submit) {
3557 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3558 dev_name(&udev->dev));
3559 if (PMSG_IS_AUTO(msg))
3563 hub->wakeup_enabled_descendants +=
3564 wakeup_enabled_descendants(udev);
3567 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3568 /* check if there are changes pending on hub ports */
3569 if (check_ports_changed(hub)) {
3570 if (PMSG_IS_AUTO(msg))
3572 pm_wakeup_event(&hdev->dev, 2000);
3576 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3577 /* Enable hub to send remote wakeup for all ports. */
3578 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3579 status = set_port_feature(hdev,
3581 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3582 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3583 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3584 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3588 dev_dbg(&intf->dev, "%s\n", __func__);
3590 /* stop hub_wq and related activity */
3591 hub_quiesce(hub, HUB_SUSPEND);
3595 static int hub_resume(struct usb_interface *intf)
3597 struct usb_hub *hub = usb_get_intfdata(intf);
3599 dev_dbg(&intf->dev, "%s\n", __func__);
3600 hub_activate(hub, HUB_RESUME);
3604 static int hub_reset_resume(struct usb_interface *intf)
3606 struct usb_hub *hub = usb_get_intfdata(intf);
3608 dev_dbg(&intf->dev, "%s\n", __func__);
3609 hub_activate(hub, HUB_RESET_RESUME);
3614 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3615 * @rhdev: struct usb_device for the root hub
3617 * The USB host controller driver calls this function when its root hub
3618 * is resumed and Vbus power has been interrupted or the controller
3619 * has been reset. The routine marks @rhdev as having lost power.
3620 * When the hub driver is resumed it will take notice and carry out
3621 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3622 * the others will be disconnected.
3624 void usb_root_hub_lost_power(struct usb_device *rhdev)
3626 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3627 rhdev->reset_resume = 1;
3629 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3631 static const char * const usb3_lpm_names[] = {
3639 * Send a Set SEL control transfer to the device, prior to enabling
3640 * device-initiated U1 or U2. This lets the device know the exit latencies from
3641 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3642 * packet from the host.
3644 * This function will fail if the SEL or PEL values for udev are greater than
3645 * the maximum allowed values for the link state to be enabled.
3647 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3649 struct usb_set_sel_req *sel_values;
3650 unsigned long long u1_sel;
3651 unsigned long long u1_pel;
3652 unsigned long long u2_sel;
3653 unsigned long long u2_pel;
3656 if (udev->state != USB_STATE_CONFIGURED)
3659 /* Convert SEL and PEL stored in ns to us */
3660 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3661 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3662 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3663 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3666 * Make sure that the calculated SEL and PEL values for the link
3667 * state we're enabling aren't bigger than the max SEL/PEL
3668 * value that will fit in the SET SEL control transfer.
3669 * Otherwise the device would get an incorrect idea of the exit
3670 * latency for the link state, and could start a device-initiated
3671 * U1/U2 when the exit latencies are too high.
3673 if ((state == USB3_LPM_U1 &&
3674 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3675 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3676 (state == USB3_LPM_U2 &&
3677 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3678 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3679 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3680 usb3_lpm_names[state], u1_sel, u1_pel);
3685 * If we're enabling device-initiated LPM for one link state,
3686 * but the other link state has a too high SEL or PEL value,
3687 * just set those values to the max in the Set SEL request.
3689 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3690 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3692 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3693 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3695 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3696 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3698 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3699 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3702 * usb_enable_lpm() can be called as part of a failed device reset,
3703 * which may be initiated by an error path of a mass storage driver.
3704 * Therefore, use GFP_NOIO.
3706 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3710 sel_values->u1_sel = u1_sel;
3711 sel_values->u1_pel = u1_pel;
3712 sel_values->u2_sel = cpu_to_le16(u2_sel);
3713 sel_values->u2_pel = cpu_to_le16(u2_pel);
3715 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3719 sel_values, sizeof *(sel_values),
3720 USB_CTRL_SET_TIMEOUT);
3726 * Enable or disable device-initiated U1 or U2 transitions.
3728 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3729 enum usb3_link_state state, bool enable)
3736 feature = USB_DEVICE_U1_ENABLE;
3739 feature = USB_DEVICE_U2_ENABLE;
3742 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3743 __func__, enable ? "enable" : "disable");
3747 if (udev->state != USB_STATE_CONFIGURED) {
3748 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3749 "for unconfigured device.\n",
3750 __func__, enable ? "enable" : "disable",
3751 usb3_lpm_names[state]);
3757 * Now send the control transfer to enable device-initiated LPM
3758 * for either U1 or U2.
3760 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3761 USB_REQ_SET_FEATURE,
3765 USB_CTRL_SET_TIMEOUT);
3767 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3768 USB_REQ_CLEAR_FEATURE,
3772 USB_CTRL_SET_TIMEOUT);
3775 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3776 enable ? "Enable" : "Disable",
3777 usb3_lpm_names[state]);
3783 static int usb_set_lpm_timeout(struct usb_device *udev,
3784 enum usb3_link_state state, int timeout)
3791 feature = USB_PORT_FEAT_U1_TIMEOUT;
3794 feature = USB_PORT_FEAT_U2_TIMEOUT;
3797 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3802 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3803 timeout != USB3_LPM_DEVICE_INITIATED) {
3804 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3805 "which is a reserved value.\n",
3806 usb3_lpm_names[state], timeout);
3810 ret = set_port_feature(udev->parent,
3811 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3814 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3815 "error code %i\n", usb3_lpm_names[state],
3819 if (state == USB3_LPM_U1)
3820 udev->u1_params.timeout = timeout;
3822 udev->u2_params.timeout = timeout;
3827 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3830 * We will attempt to enable U1 or U2, but there are no guarantees that the
3831 * control transfers to set the hub timeout or enable device-initiated U1/U2
3832 * will be successful.
3834 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3835 * driver know about it. If that call fails, it should be harmless, and just
3836 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3838 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3839 enum usb3_link_state state)
3842 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3843 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3845 /* If the device says it doesn't have *any* exit latency to come out of
3846 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3849 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3850 (state == USB3_LPM_U2 && u2_mel == 0))
3854 * First, let the device know about the exit latencies
3855 * associated with the link state we're about to enable.
3857 ret = usb_req_set_sel(udev, state);
3859 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3860 usb3_lpm_names[state]);
3864 /* We allow the host controller to set the U1/U2 timeout internally
3865 * first, so that it can change its schedule to account for the
3866 * additional latency to send data to a device in a lower power
3869 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3871 /* xHCI host controller doesn't want to enable this LPM state. */
3876 dev_warn(&udev->dev, "Could not enable %s link state, "
3877 "xHCI error %i.\n", usb3_lpm_names[state],
3882 if (usb_set_lpm_timeout(udev, state, timeout))
3883 /* If we can't set the parent hub U1/U2 timeout,
3884 * device-initiated LPM won't be allowed either, so let the xHCI
3885 * host know that this link state won't be enabled.
3887 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3889 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3890 else if (udev->actconfig)
3891 usb_set_device_initiated_lpm(udev, state, true);
3896 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3899 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3900 * If zero is returned, the parent will not allow the link to go into U1/U2.
3902 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3903 * it won't have an effect on the bus link state because the parent hub will
3904 * still disallow device-initiated U1/U2 entry.
3906 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3907 * possible. The result will be slightly more bus bandwidth will be taken up
3908 * (to account for U1/U2 exit latency), but it should be harmless.
3910 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3911 enum usb3_link_state state)
3918 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3923 if (usb_set_lpm_timeout(udev, state, 0))
3926 usb_set_device_initiated_lpm(udev, state, false);
3928 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3929 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3930 "bus schedule bandwidth may be impacted.\n",
3931 usb3_lpm_names[state]);
3936 * Disable hub-initiated and device-initiated U1 and U2 entry.
3937 * Caller must own the bandwidth_mutex.
3939 * This will call usb_enable_lpm() on failure, which will decrement
3940 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3942 int usb_disable_lpm(struct usb_device *udev)
3944 struct usb_hcd *hcd;
3946 if (!udev || !udev->parent ||
3947 udev->speed != USB_SPEED_SUPER ||
3948 !udev->lpm_capable ||
3949 udev->state < USB_STATE_DEFAULT)
3952 hcd = bus_to_hcd(udev->bus);
3953 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3956 udev->lpm_disable_count++;
3957 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3960 /* If LPM is enabled, attempt to disable it. */
3961 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3963 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3966 udev->usb3_lpm_enabled = 0;
3971 usb_enable_lpm(udev);
3974 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3976 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3977 int usb_unlocked_disable_lpm(struct usb_device *udev)
3979 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3985 mutex_lock(hcd->bandwidth_mutex);
3986 ret = usb_disable_lpm(udev);
3987 mutex_unlock(hcd->bandwidth_mutex);
3991 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3994 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3995 * xHCI host policy may prevent U1 or U2 from being enabled.
3997 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3998 * until the lpm_disable_count drops to zero. Caller must own the
4001 void usb_enable_lpm(struct usb_device *udev)
4003 struct usb_hcd *hcd;
4005 if (!udev || !udev->parent ||
4006 udev->speed != USB_SPEED_SUPER ||
4007 !udev->lpm_capable ||
4008 udev->state < USB_STATE_DEFAULT)
4011 udev->lpm_disable_count--;
4012 hcd = bus_to_hcd(udev->bus);
4013 /* Double check that we can both enable and disable LPM.
4014 * Device must be configured to accept set feature U1/U2 timeout.
4016 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4017 !hcd->driver->disable_usb3_lpm_timeout)
4020 if (udev->lpm_disable_count > 0)
4023 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4024 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4026 udev->usb3_lpm_enabled = 1;
4028 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4030 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4031 void usb_unlocked_enable_lpm(struct usb_device *udev)
4033 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4038 mutex_lock(hcd->bandwidth_mutex);
4039 usb_enable_lpm(udev);
4040 mutex_unlock(hcd->bandwidth_mutex);
4042 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4045 #else /* CONFIG_PM */
4047 #define hub_suspend NULL
4048 #define hub_resume NULL
4049 #define hub_reset_resume NULL
4051 int usb_disable_lpm(struct usb_device *udev)
4055 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4057 void usb_enable_lpm(struct usb_device *udev) { }
4058 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4060 int usb_unlocked_disable_lpm(struct usb_device *udev)
4064 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4066 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4067 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4069 int usb_disable_ltm(struct usb_device *udev)
4073 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4075 void usb_enable_ltm(struct usb_device *udev) { }
4076 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4078 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4079 u16 portstatus, u16 portchange)
4084 #endif /* CONFIG_PM */
4087 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4089 * Between connect detection and reset signaling there must be a delay
4090 * of 100ms at least for debounce and power-settling. The corresponding
4091 * timer shall restart whenever the downstream port detects a disconnect.
4093 * Apparently there are some bluetooth and irda-dongles and a number of
4094 * low-speed devices for which this debounce period may last over a second.
4095 * Not covered by the spec - but easy to deal with.
4097 * This implementation uses a 1500ms total debounce timeout; if the
4098 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4099 * every 25ms for transient disconnects. When the port status has been
4100 * unchanged for 100ms it returns the port status.
4102 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4105 u16 portchange, portstatus;
4106 unsigned connection = 0xffff;
4107 int total_time, stable_time = 0;
4108 struct usb_port *port_dev = hub->ports[port1 - 1];
4110 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4111 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4115 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4116 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4117 if (!must_be_connected ||
4118 (connection == USB_PORT_STAT_CONNECTION))
4119 stable_time += HUB_DEBOUNCE_STEP;
4120 if (stable_time >= HUB_DEBOUNCE_STABLE)
4124 connection = portstatus & USB_PORT_STAT_CONNECTION;
4127 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4128 usb_clear_port_feature(hub->hdev, port1,
4129 USB_PORT_FEAT_C_CONNECTION);
4132 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4134 msleep(HUB_DEBOUNCE_STEP);
4137 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4138 total_time, stable_time, portstatus);
4140 if (stable_time < HUB_DEBOUNCE_STABLE)
4145 void usb_ep0_reinit(struct usb_device *udev)
4147 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4148 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4149 usb_enable_endpoint(udev, &udev->ep0, true);
4151 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4153 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4154 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4156 static int hub_set_address(struct usb_device *udev, int devnum)
4159 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4162 * The host controller will choose the device address,
4163 * instead of the core having chosen it earlier
4165 if (!hcd->driver->address_device && devnum <= 1)
4167 if (udev->state == USB_STATE_ADDRESS)
4169 if (udev->state != USB_STATE_DEFAULT)
4171 if (hcd->driver->address_device)
4172 retval = hcd->driver->address_device(hcd, udev);
4174 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4175 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4176 NULL, 0, USB_CTRL_SET_TIMEOUT);
4178 update_devnum(udev, devnum);
4179 /* Device now using proper address. */
4180 usb_set_device_state(udev, USB_STATE_ADDRESS);
4181 usb_ep0_reinit(udev);
4187 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4188 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4191 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4192 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4193 * support bit in the BOS descriptor.
4195 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4197 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4198 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4200 if (!udev->usb2_hw_lpm_capable)
4204 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4206 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4207 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4208 udev->usb2_hw_lpm_allowed = 1;
4209 usb_set_usb2_hardware_lpm(udev, 1);
4213 static int hub_enable_device(struct usb_device *udev)
4215 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4217 if (!hcd->driver->enable_device)
4219 if (udev->state == USB_STATE_ADDRESS)
4221 if (udev->state != USB_STATE_DEFAULT)
4224 return hcd->driver->enable_device(hcd, udev);
4227 /* Reset device, (re)assign address, get device descriptor.
4228 * Device connection must be stable, no more debouncing needed.
4229 * Returns device in USB_STATE_ADDRESS, except on error.
4231 * If this is called for an already-existing device (as part of
4232 * usb_reset_and_verify_device), the caller must own the device lock and
4233 * the port lock. For a newly detected device that is not accessible
4234 * through any global pointers, it's not necessary to lock the device,
4235 * but it is still necessary to lock the port.
4238 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4241 struct usb_device *hdev = hub->hdev;
4242 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4244 unsigned delay = HUB_SHORT_RESET_TIME;
4245 enum usb_device_speed oldspeed = udev->speed;
4247 int devnum = udev->devnum;
4249 /* root hub ports have a slightly longer reset period
4250 * (from USB 2.0 spec, section 7.1.7.5)
4252 if (!hdev->parent) {
4253 delay = HUB_ROOT_RESET_TIME;
4254 if (port1 == hdev->bus->otg_port)
4255 hdev->bus->b_hnp_enable = 0;
4258 /* Some low speed devices have problems with the quick delay, so */
4259 /* be a bit pessimistic with those devices. RHbug #23670 */
4260 if (oldspeed == USB_SPEED_LOW)
4261 delay = HUB_LONG_RESET_TIME;
4263 mutex_lock(&hdev->bus->usb_address0_mutex);
4265 /* Reset the device; full speed may morph to high speed */
4266 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4267 retval = hub_port_reset(hub, port1, udev, delay, false);
4268 if (retval < 0) /* error or disconnect */
4270 /* success, speed is known */
4274 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4275 dev_dbg(&udev->dev, "device reset changed speed!\n");
4278 oldspeed = udev->speed;
4280 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4281 * it's fixed size except for full speed devices.
4282 * For Wireless USB devices, ep0 max packet is always 512 (tho
4283 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4285 switch (udev->speed) {
4286 case USB_SPEED_SUPER:
4287 case USB_SPEED_WIRELESS: /* fixed at 512 */
4288 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4290 case USB_SPEED_HIGH: /* fixed at 64 */
4291 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4293 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4294 /* to determine the ep0 maxpacket size, try to read
4295 * the device descriptor to get bMaxPacketSize0 and
4296 * then correct our initial guess.
4298 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4300 case USB_SPEED_LOW: /* fixed at 8 */
4301 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4307 if (udev->speed == USB_SPEED_WIRELESS)
4308 speed = "variable speed Wireless";
4310 speed = usb_speed_string(udev->speed);
4312 if (udev->speed != USB_SPEED_SUPER)
4313 dev_info(&udev->dev,
4314 "%s %s USB device number %d using %s\n",
4315 (udev->config) ? "reset" : "new", speed,
4316 devnum, udev->bus->controller->driver->name);
4318 /* Set up TT records, if needed */
4320 udev->tt = hdev->tt;
4321 udev->ttport = hdev->ttport;
4322 } else if (udev->speed != USB_SPEED_HIGH
4323 && hdev->speed == USB_SPEED_HIGH) {
4325 dev_err(&udev->dev, "parent hub has no TT\n");
4329 udev->tt = &hub->tt;
4330 udev->ttport = port1;
4333 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4334 * Because device hardware and firmware is sometimes buggy in
4335 * this area, and this is how Linux has done it for ages.
4336 * Change it cautiously.
4338 * NOTE: If use_new_scheme() is true we will start by issuing
4339 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4340 * so it may help with some non-standards-compliant devices.
4341 * Otherwise we start with SET_ADDRESS and then try to read the
4342 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4345 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4346 bool did_new_scheme = false;
4348 if (use_new_scheme(udev, retry_counter)) {
4349 struct usb_device_descriptor *buf;
4352 did_new_scheme = true;
4353 retval = hub_enable_device(udev);
4356 "hub failed to enable device, error %d\n",
4361 #define GET_DESCRIPTOR_BUFSIZE 64
4362 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4368 /* Retry on all errors; some devices are flakey.
4369 * 255 is for WUSB devices, we actually need to use
4370 * 512 (WUSB1.0[4.8.1]).
4372 for (j = 0; j < 3; ++j) {
4373 buf->bMaxPacketSize0 = 0;
4374 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4375 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4376 USB_DT_DEVICE << 8, 0,
4377 buf, GET_DESCRIPTOR_BUFSIZE,
4378 initial_descriptor_timeout);
4379 switch (buf->bMaxPacketSize0) {
4380 case 8: case 16: case 32: case 64: case 255:
4381 if (buf->bDescriptorType ==
4395 udev->descriptor.bMaxPacketSize0 =
4396 buf->bMaxPacketSize0;
4399 retval = hub_port_reset(hub, port1, udev, delay, false);
4400 if (retval < 0) /* error or disconnect */
4402 if (oldspeed != udev->speed) {
4404 "device reset changed speed!\n");
4410 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4415 #undef GET_DESCRIPTOR_BUFSIZE
4419 * If device is WUSB, we already assigned an
4420 * unauthorized address in the Connect Ack sequence;
4421 * authorization will assign the final address.
4423 if (udev->wusb == 0) {
4424 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4425 retval = hub_set_address(udev, devnum);
4431 if (retval != -ENODEV)
4432 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4436 if (udev->speed == USB_SPEED_SUPER) {
4437 devnum = udev->devnum;
4438 dev_info(&udev->dev,
4439 "%s SuperSpeed USB device number %d using %s\n",
4440 (udev->config) ? "reset" : "new",
4441 devnum, udev->bus->controller->driver->name);
4444 /* cope with hardware quirkiness:
4445 * - let SET_ADDRESS settle, some device hardware wants it
4446 * - read ep0 maxpacket even for high and low speed,
4449 /* use_new_scheme() checks the speed which may have
4450 * changed since the initial look so we cache the result
4457 retval = usb_get_device_descriptor(udev, 8);
4459 if (retval != -ENODEV)
4461 "device descriptor read/8, error %d\n",
4474 * Some superspeed devices have finished the link training process
4475 * and attached to a superspeed hub port, but the device descriptor
4476 * got from those devices show they aren't superspeed devices. Warm
4477 * reset the port attached by the devices can fix them.
4479 if ((udev->speed == USB_SPEED_SUPER) &&
4480 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4481 dev_err(&udev->dev, "got a wrong device descriptor, "
4482 "warm reset device\n");
4483 hub_port_reset(hub, port1, udev,
4484 HUB_BH_RESET_TIME, true);
4489 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4490 udev->speed == USB_SPEED_SUPER)
4493 i = udev->descriptor.bMaxPacketSize0;
4494 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4495 if (udev->speed == USB_SPEED_LOW ||
4496 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4497 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4501 if (udev->speed == USB_SPEED_FULL)
4502 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4504 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4505 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4506 usb_ep0_reinit(udev);
4509 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4510 if (retval < (signed)sizeof(udev->descriptor)) {
4511 if (retval != -ENODEV)
4512 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4519 usb_detect_quirks(udev);
4521 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4522 retval = usb_get_bos_descriptor(udev);
4524 udev->lpm_capable = usb_device_supports_lpm(udev);
4525 usb_set_lpm_parameters(udev);
4530 /* notify HCD that we have a device connected and addressed */
4531 if (hcd->driver->update_device)
4532 hcd->driver->update_device(hcd, udev);
4533 hub_set_initial_usb2_lpm_policy(udev);
4536 hub_port_disable(hub, port1, 0);
4537 update_devnum(udev, devnum); /* for disconnect processing */
4539 mutex_unlock(&hdev->bus->usb_address0_mutex);
4544 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4546 struct usb_qualifier_descriptor *qual;
4549 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4552 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4556 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4557 qual, sizeof *qual);
4558 if (status == sizeof *qual) {
4559 dev_info(&udev->dev, "not running at top speed; "
4560 "connect to a high speed hub\n");
4561 /* hub LEDs are probably harder to miss than syslog */
4562 if (hub->has_indicators) {
4563 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4564 queue_delayed_work(system_power_efficient_wq,
4572 hub_power_remaining(struct usb_hub *hub)
4574 struct usb_device *hdev = hub->hdev;
4578 if (!hub->limited_power)
4581 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4582 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4583 struct usb_port *port_dev = hub->ports[port1 - 1];
4584 struct usb_device *udev = port_dev->child;
4590 if (hub_is_superspeed(udev))
4596 * Unconfigured devices may not use more than one unit load,
4597 * or 8mA for OTG ports
4599 if (udev->actconfig)
4600 delta = usb_get_max_power(udev, udev->actconfig);
4601 else if (port1 != udev->bus->otg_port || hdev->parent)
4605 if (delta > hub->mA_per_port)
4606 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4607 delta, hub->mA_per_port);
4610 if (remaining < 0) {
4611 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4618 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4623 struct usb_device *hdev = hub->hdev;
4624 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4625 struct usb_port *port_dev = hub->ports[port1 - 1];
4626 struct usb_device *udev = port_dev->child;
4627 static int unreliable_port = -1;
4629 /* Disconnect any existing devices under this port */
4631 if (hcd->usb_phy && !hdev->parent)
4632 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4633 usb_disconnect(&port_dev->child);
4636 /* We can forget about a "removed" device when there's a physical
4637 * disconnect or the connect status changes.
4639 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4640 (portchange & USB_PORT_STAT_C_CONNECTION))
4641 clear_bit(port1, hub->removed_bits);
4643 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4644 USB_PORT_STAT_C_ENABLE)) {
4645 status = hub_port_debounce_be_stable(hub, port1);
4647 if (status != -ENODEV &&
4648 port1 != unreliable_port &&
4650 dev_err(&port_dev->dev, "connect-debounce failed\n");
4651 portstatus &= ~USB_PORT_STAT_CONNECTION;
4652 unreliable_port = port1;
4654 portstatus = status;
4658 /* Return now if debouncing failed or nothing is connected or
4659 * the device was "removed".
4661 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4662 test_bit(port1, hub->removed_bits)) {
4665 * maybe switch power back on (e.g. root hub was reset)
4666 * but only if the port isn't owned by someone else.
4668 if (hub_is_port_power_switchable(hub)
4669 && !port_is_power_on(hub, portstatus)
4670 && !port_dev->port_owner)
4671 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4673 if (portstatus & USB_PORT_STAT_ENABLE)
4677 if (hub_is_superspeed(hub->hdev))
4683 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4685 /* reallocate for each attempt, since references
4686 * to the previous one can escape in various ways
4688 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4690 dev_err(&port_dev->dev,
4691 "couldn't allocate usb_device\n");
4695 usb_set_device_state(udev, USB_STATE_POWERED);
4696 udev->bus_mA = hub->mA_per_port;
4697 udev->level = hdev->level + 1;
4698 udev->wusb = hub_is_wusb(hub);
4700 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4701 if (hub_is_superspeed(hub->hdev))
4702 udev->speed = USB_SPEED_SUPER;
4704 udev->speed = USB_SPEED_UNKNOWN;
4706 choose_devnum(udev);
4707 if (udev->devnum <= 0) {
4708 status = -ENOTCONN; /* Don't retry */
4712 /* reset (non-USB 3.0 devices) and get descriptor */
4713 usb_lock_port(port_dev);
4714 status = hub_port_init(hub, udev, port1, i);
4715 usb_unlock_port(port_dev);
4719 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4722 /* consecutive bus-powered hubs aren't reliable; they can
4723 * violate the voltage drop budget. if the new child has
4724 * a "powered" LED, users should notice we didn't enable it
4725 * (without reading syslog), even without per-port LEDs
4728 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4729 && udev->bus_mA <= unit_load) {
4732 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4735 dev_dbg(&udev->dev, "get status %d ?\n", status);
4738 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4740 "can't connect bus-powered hub "
4742 if (hub->has_indicators) {
4743 hub->indicator[port1-1] =
4744 INDICATOR_AMBER_BLINK;
4746 system_power_efficient_wq,
4749 status = -ENOTCONN; /* Don't retry */
4754 /* check for devices running slower than they could */
4755 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4756 && udev->speed == USB_SPEED_FULL
4757 && highspeed_hubs != 0)
4758 check_highspeed(hub, udev, port1);
4760 /* Store the parent's children[] pointer. At this point
4761 * udev becomes globally accessible, although presumably
4762 * no one will look at it until hdev is unlocked.
4766 mutex_lock(&usb_port_peer_mutex);
4768 /* We mustn't add new devices if the parent hub has
4769 * been disconnected; we would race with the
4770 * recursively_mark_NOTATTACHED() routine.
4772 spin_lock_irq(&device_state_lock);
4773 if (hdev->state == USB_STATE_NOTATTACHED)
4776 port_dev->child = udev;
4777 spin_unlock_irq(&device_state_lock);
4778 mutex_unlock(&usb_port_peer_mutex);
4780 /* Run it through the hoops (find a driver, etc) */
4782 status = usb_new_device(udev);
4784 mutex_lock(&usb_port_peer_mutex);
4785 spin_lock_irq(&device_state_lock);
4786 port_dev->child = NULL;
4787 spin_unlock_irq(&device_state_lock);
4788 mutex_unlock(&usb_port_peer_mutex);
4790 if (hcd->usb_phy && !hdev->parent)
4791 usb_phy_notify_connect(hcd->usb_phy,
4799 status = hub_power_remaining(hub);
4801 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4806 hub_port_disable(hub, port1, 1);
4808 usb_ep0_reinit(udev);
4809 release_devnum(udev);
4812 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4815 if (hub->hdev->parent ||
4816 !hcd->driver->port_handed_over ||
4817 !(hcd->driver->port_handed_over)(hcd, port1)) {
4818 if (status != -ENOTCONN && status != -ENODEV)
4819 dev_err(&port_dev->dev,
4820 "unable to enumerate USB device\n");
4824 hub_port_disable(hub, port1, 1);
4825 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4826 hcd->driver->relinquish_port(hcd, port1);
4830 /* Handle physical or logical connection change events.
4831 * This routine is called when:
4832 * a port connection-change occurs;
4833 * a port enable-change occurs (often caused by EMI);
4834 * usb_reset_and_verify_device() encounters changed descriptors (as from
4835 * a firmware download)
4836 * caller already locked the hub
4838 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4839 u16 portstatus, u16 portchange)
4840 __must_hold(&port_dev->status_lock)
4842 struct usb_port *port_dev = hub->ports[port1 - 1];
4843 struct usb_device *udev = port_dev->child;
4844 int status = -ENODEV;
4846 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4847 portchange, portspeed(hub, portstatus));
4849 if (hub->has_indicators) {
4850 set_port_led(hub, port1, HUB_LED_AUTO);
4851 hub->indicator[port1-1] = INDICATOR_AUTO;
4854 #ifdef CONFIG_USB_OTG
4855 /* during HNP, don't repeat the debounce */
4856 if (hub->hdev->bus->is_b_host)
4857 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4858 USB_PORT_STAT_C_ENABLE);
4861 /* Try to resuscitate an existing device */
4862 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4863 udev->state != USB_STATE_NOTATTACHED) {
4864 if (portstatus & USB_PORT_STAT_ENABLE) {
4865 status = 0; /* Nothing to do */
4867 } else if (udev->state == USB_STATE_SUSPENDED &&
4868 udev->persist_enabled) {
4869 /* For a suspended device, treat this as a
4870 * remote wakeup event.
4872 usb_unlock_port(port_dev);
4873 status = usb_remote_wakeup(udev);
4874 usb_lock_port(port_dev);
4877 /* Don't resuscitate */;
4880 clear_bit(port1, hub->change_bits);
4882 /* successfully revalidated the connection */
4886 usb_unlock_port(port_dev);
4887 hub_port_connect(hub, port1, portstatus, portchange);
4888 usb_lock_port(port_dev);
4891 static void port_event(struct usb_hub *hub, int port1)
4892 __must_hold(&port_dev->status_lock)
4895 struct usb_port *port_dev = hub->ports[port1 - 1];
4896 struct usb_device *udev = port_dev->child;
4897 struct usb_device *hdev = hub->hdev;
4898 u16 portstatus, portchange;
4900 connect_change = test_bit(port1, hub->change_bits);
4901 clear_bit(port1, hub->event_bits);
4902 clear_bit(port1, hub->wakeup_bits);
4904 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
4907 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4908 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
4912 if (portchange & USB_PORT_STAT_C_ENABLE) {
4913 if (!connect_change)
4914 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
4916 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
4919 * EM interference sometimes causes badly shielded USB devices
4920 * to be shutdown by the hub, this hack enables them again.
4921 * Works at least with mouse driver.
4923 if (!(portstatus & USB_PORT_STAT_ENABLE)
4924 && !connect_change && udev) {
4925 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
4930 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4931 u16 status = 0, unused;
4933 dev_dbg(&port_dev->dev, "over-current change\n");
4934 usb_clear_port_feature(hdev, port1,
4935 USB_PORT_FEAT_C_OVER_CURRENT);
4936 msleep(100); /* Cool down */
4937 hub_power_on(hub, true);
4938 hub_port_status(hub, port1, &status, &unused);
4939 if (status & USB_PORT_STAT_OVERCURRENT)
4940 dev_err(&port_dev->dev, "over-current condition\n");
4943 if (portchange & USB_PORT_STAT_C_RESET) {
4944 dev_dbg(&port_dev->dev, "reset change\n");
4945 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
4947 if ((portchange & USB_PORT_STAT_C_BH_RESET)
4948 && hub_is_superspeed(hdev)) {
4949 dev_dbg(&port_dev->dev, "warm reset change\n");
4950 usb_clear_port_feature(hdev, port1,
4951 USB_PORT_FEAT_C_BH_PORT_RESET);
4953 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4954 dev_dbg(&port_dev->dev, "link state change\n");
4955 usb_clear_port_feature(hdev, port1,
4956 USB_PORT_FEAT_C_PORT_LINK_STATE);
4958 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4959 dev_warn(&port_dev->dev, "config error\n");
4960 usb_clear_port_feature(hdev, port1,
4961 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4964 /* skip port actions that require the port to be powered on */
4965 if (!pm_runtime_active(&port_dev->dev))
4968 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
4972 * Warm reset a USB3 protocol port if it's in
4973 * SS.Inactive state.
4975 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
4976 dev_dbg(&port_dev->dev, "do warm reset\n");
4977 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
4978 || udev->state == USB_STATE_NOTATTACHED) {
4979 if (hub_port_reset(hub, port1, NULL,
4980 HUB_BH_RESET_TIME, true) < 0)
4981 hub_port_disable(hub, port1, 1);
4983 usb_unlock_port(port_dev);
4984 usb_lock_device(udev);
4985 usb_reset_device(udev);
4986 usb_unlock_device(udev);
4987 usb_lock_port(port_dev);
4993 hub_port_connect_change(hub, port1, portstatus, portchange);
4996 static void hub_event(struct work_struct *work)
4998 struct usb_device *hdev;
4999 struct usb_interface *intf;
5000 struct usb_hub *hub;
5001 struct device *hub_dev;
5006 hub = container_of(work, struct usb_hub, events);
5008 hub_dev = hub->intfdev;
5009 intf = to_usb_interface(hub_dev);
5011 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5012 hdev->state, hdev->maxchild,
5013 /* NOTE: expects max 15 ports... */
5014 (u16) hub->change_bits[0],
5015 (u16) hub->event_bits[0]);
5017 /* Lock the device, then check to see if we were
5018 * disconnected while waiting for the lock to succeed. */
5019 usb_lock_device(hdev);
5020 if (unlikely(hub->disconnected))
5023 /* If the hub has died, clean up after it */
5024 if (hdev->state == USB_STATE_NOTATTACHED) {
5025 hub->error = -ENODEV;
5026 hub_quiesce(hub, HUB_DISCONNECT);
5031 ret = usb_autopm_get_interface(intf);
5033 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5037 /* If this is an inactive hub, do nothing */
5042 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5044 ret = usb_reset_device(hdev);
5046 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5054 /* deal with port status changes */
5055 for (i = 1; i <= hdev->maxchild; i++) {
5056 struct usb_port *port_dev = hub->ports[i - 1];
5058 if (test_bit(i, hub->event_bits)
5059 || test_bit(i, hub->change_bits)
5060 || test_bit(i, hub->wakeup_bits)) {
5062 * The get_noresume and barrier ensure that if
5063 * the port was in the process of resuming, we
5064 * flush that work and keep the port active for
5065 * the duration of the port_event(). However,
5066 * if the port is runtime pm suspended
5067 * (powered-off), we leave it in that state, run
5068 * an abbreviated port_event(), and move on.
5070 pm_runtime_get_noresume(&port_dev->dev);
5071 pm_runtime_barrier(&port_dev->dev);
5072 usb_lock_port(port_dev);
5074 usb_unlock_port(port_dev);
5075 pm_runtime_put_sync(&port_dev->dev);
5079 /* deal with hub status changes */
5080 if (test_and_clear_bit(0, hub->event_bits) == 0)
5082 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5083 dev_err(hub_dev, "get_hub_status failed\n");
5085 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5086 dev_dbg(hub_dev, "power change\n");
5087 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5088 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5089 /* FIXME: Is this always true? */
5090 hub->limited_power = 1;
5092 hub->limited_power = 0;
5094 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5098 dev_dbg(hub_dev, "over-current change\n");
5099 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5100 msleep(500); /* Cool down */
5101 hub_power_on(hub, true);
5102 hub_hub_status(hub, &status, &unused);
5103 if (status & HUB_STATUS_OVERCURRENT)
5104 dev_err(hub_dev, "over-current condition\n");
5109 /* Balance the usb_autopm_get_interface() above */
5110 usb_autopm_put_interface_no_suspend(intf);
5112 usb_unlock_device(hdev);
5114 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5115 usb_autopm_put_interface(intf);
5116 kref_put(&hub->kref, hub_release);
5119 static const struct usb_device_id hub_id_table[] = {
5120 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5121 | USB_DEVICE_ID_MATCH_INT_CLASS,
5122 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5123 .bInterfaceClass = USB_CLASS_HUB,
5124 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5125 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5126 .bDeviceClass = USB_CLASS_HUB},
5127 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5128 .bInterfaceClass = USB_CLASS_HUB},
5129 { } /* Terminating entry */
5132 MODULE_DEVICE_TABLE(usb, hub_id_table);
5134 static struct usb_driver hub_driver = {
5137 .disconnect = hub_disconnect,
5138 .suspend = hub_suspend,
5139 .resume = hub_resume,
5140 .reset_resume = hub_reset_resume,
5141 .pre_reset = hub_pre_reset,
5142 .post_reset = hub_post_reset,
5143 .unlocked_ioctl = hub_ioctl,
5144 .id_table = hub_id_table,
5145 .supports_autosuspend = 1,
5148 int usb_hub_init(void)
5150 if (usb_register(&hub_driver) < 0) {
5151 printk(KERN_ERR "%s: can't register hub driver\n",
5157 * The workqueue needs to be freezable to avoid interfering with
5158 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5159 * device was gone before the EHCI controller had handed its port
5160 * over to the companion full-speed controller.
5162 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5166 /* Fall through if kernel_thread failed */
5167 usb_deregister(&hub_driver);
5168 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5173 void usb_hub_cleanup(void)
5175 destroy_workqueue(hub_wq);
5178 * Hub resources are freed for us by usb_deregister. It calls
5179 * usb_driver_purge on every device which in turn calls that
5180 * devices disconnect function if it is using this driver.
5181 * The hub_disconnect function takes care of releasing the
5182 * individual hub resources. -greg
5184 usb_deregister(&hub_driver);
5185 } /* usb_hub_cleanup() */
5187 static int descriptors_changed(struct usb_device *udev,
5188 struct usb_device_descriptor *old_device_descriptor,
5189 struct usb_host_bos *old_bos)
5193 unsigned serial_len = 0;
5195 unsigned old_length;
5199 if (memcmp(&udev->descriptor, old_device_descriptor,
5200 sizeof(*old_device_descriptor)) != 0)
5203 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5206 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5207 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5209 if (memcmp(udev->bos->desc, old_bos->desc, len))
5213 /* Since the idVendor, idProduct, and bcdDevice values in the
5214 * device descriptor haven't changed, we will assume the
5215 * Manufacturer and Product strings haven't changed either.
5216 * But the SerialNumber string could be different (e.g., a
5217 * different flash card of the same brand).
5220 serial_len = strlen(udev->serial) + 1;
5223 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5224 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5225 len = max(len, old_length);
5228 buf = kmalloc(len, GFP_NOIO);
5230 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5231 /* assume the worst */
5234 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5235 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5236 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5238 if (length != old_length) {
5239 dev_dbg(&udev->dev, "config index %d, error %d\n",
5244 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5246 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5248 ((struct usb_config_descriptor *) buf)->
5249 bConfigurationValue);
5255 if (!changed && serial_len) {
5256 length = usb_string(udev, udev->descriptor.iSerialNumber,
5258 if (length + 1 != serial_len) {
5259 dev_dbg(&udev->dev, "serial string error %d\n",
5262 } else if (memcmp(buf, udev->serial, length) != 0) {
5263 dev_dbg(&udev->dev, "serial string changed\n");
5273 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5274 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5276 * WARNING - don't use this routine to reset a composite device
5277 * (one with multiple interfaces owned by separate drivers)!
5278 * Use usb_reset_device() instead.
5280 * Do a port reset, reassign the device's address, and establish its
5281 * former operating configuration. If the reset fails, or the device's
5282 * descriptors change from their values before the reset, or the original
5283 * configuration and altsettings cannot be restored, a flag will be set
5284 * telling hub_wq to pretend the device has been disconnected and then
5285 * re-connected. All drivers will be unbound, and the device will be
5286 * re-enumerated and probed all over again.
5288 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5289 * flagged for logical disconnection, or some other negative error code
5290 * if the reset wasn't even attempted.
5293 * The caller must own the device lock and the port lock, the latter is
5294 * taken by usb_reset_device(). For example, it's safe to use
5295 * usb_reset_device() from a driver probe() routine after downloading
5296 * new firmware. For calls that might not occur during probe(), drivers
5297 * should lock the device using usb_lock_device_for_reset().
5299 * Locking exception: This routine may also be called from within an
5300 * autoresume handler. Such usage won't conflict with other tasks
5301 * holding the device lock because these tasks should always call
5302 * usb_autopm_resume_device(), thereby preventing any unwanted
5303 * autoresume. The autoresume handler is expected to have already
5304 * acquired the port lock before calling this routine.
5306 static int usb_reset_and_verify_device(struct usb_device *udev)
5308 struct usb_device *parent_hdev = udev->parent;
5309 struct usb_hub *parent_hub;
5310 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5311 struct usb_device_descriptor descriptor = udev->descriptor;
5312 struct usb_host_bos *bos;
5314 int port1 = udev->portnum;
5316 if (udev->state == USB_STATE_NOTATTACHED ||
5317 udev->state == USB_STATE_SUSPENDED) {
5318 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5326 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5328 /* Disable USB2 hardware LPM.
5329 * It will be re-enabled by the enumeration process.
5331 if (udev->usb2_hw_lpm_enabled == 1)
5332 usb_set_usb2_hardware_lpm(udev, 0);
5334 /* Disable LPM and LTM while we reset the device and reinstall the alt
5335 * settings. Device-initiated LPM settings, and system exit latency
5336 * settings are cleared when the device is reset, so we have to set
5339 ret = usb_unlocked_disable_lpm(udev);
5341 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5342 goto re_enumerate_no_bos;
5344 ret = usb_disable_ltm(udev);
5346 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5348 goto re_enumerate_no_bos;
5354 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5356 /* ep0 maxpacket size may change; let the HCD know about it.
5357 * Other endpoints will be handled by re-enumeration. */
5358 usb_ep0_reinit(udev);
5359 ret = hub_port_init(parent_hub, udev, port1, i);
5360 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5367 /* Device might have changed firmware (DFU or similar) */
5368 if (descriptors_changed(udev, &descriptor, bos)) {
5369 dev_info(&udev->dev, "device firmware changed\n");
5370 udev->descriptor = descriptor; /* for disconnect() calls */
5374 /* Restore the device's previous configuration */
5375 if (!udev->actconfig)
5378 mutex_lock(hcd->bandwidth_mutex);
5379 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5381 dev_warn(&udev->dev,
5382 "Busted HC? Not enough HCD resources for "
5383 "old configuration.\n");
5384 mutex_unlock(hcd->bandwidth_mutex);
5387 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5388 USB_REQ_SET_CONFIGURATION, 0,
5389 udev->actconfig->desc.bConfigurationValue, 0,
5390 NULL, 0, USB_CTRL_SET_TIMEOUT);
5393 "can't restore configuration #%d (error=%d)\n",
5394 udev->actconfig->desc.bConfigurationValue, ret);
5395 mutex_unlock(hcd->bandwidth_mutex);
5398 mutex_unlock(hcd->bandwidth_mutex);
5399 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5401 /* Put interfaces back into the same altsettings as before.
5402 * Don't bother to send the Set-Interface request for interfaces
5403 * that were already in altsetting 0; besides being unnecessary,
5404 * many devices can't handle it. Instead just reset the host-side
5407 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5408 struct usb_host_config *config = udev->actconfig;
5409 struct usb_interface *intf = config->interface[i];
5410 struct usb_interface_descriptor *desc;
5412 desc = &intf->cur_altsetting->desc;
5413 if (desc->bAlternateSetting == 0) {
5414 usb_disable_interface(udev, intf, true);
5415 usb_enable_interface(udev, intf, true);
5418 /* Let the bandwidth allocation function know that this
5419 * device has been reset, and it will have to use
5420 * alternate setting 0 as the current alternate setting.
5422 intf->resetting_device = 1;
5423 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5424 desc->bAlternateSetting);
5425 intf->resetting_device = 0;
5428 dev_err(&udev->dev, "failed to restore interface %d "
5429 "altsetting %d (error=%d)\n",
5430 desc->bInterfaceNumber,
5431 desc->bAlternateSetting,
5435 /* Resetting also frees any allocated streams */
5436 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5437 intf->cur_altsetting->endpoint[j].streams = 0;
5441 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5442 usb_set_usb2_hardware_lpm(udev, 1);
5443 usb_unlocked_enable_lpm(udev);
5444 usb_enable_ltm(udev);
5445 usb_release_bos_descriptor(udev);
5450 usb_release_bos_descriptor(udev);
5452 re_enumerate_no_bos:
5453 /* LPM state doesn't matter when we're about to destroy the device. */
5454 hub_port_logical_disconnect(parent_hub, port1);
5459 * usb_reset_device - warn interface drivers and perform a USB port reset
5460 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5462 * Warns all drivers bound to registered interfaces (using their pre_reset
5463 * method), performs the port reset, and then lets the drivers know that
5464 * the reset is over (using their post_reset method).
5466 * Return: The same as for usb_reset_and_verify_device().
5469 * The caller must own the device lock. For example, it's safe to use
5470 * this from a driver probe() routine after downloading new firmware.
5471 * For calls that might not occur during probe(), drivers should lock
5472 * the device using usb_lock_device_for_reset().
5474 * If an interface is currently being probed or disconnected, we assume
5475 * its driver knows how to handle resets. For all other interfaces,
5476 * if the driver doesn't have pre_reset and post_reset methods then
5477 * we attempt to unbind it and rebind afterward.
5479 int usb_reset_device(struct usb_device *udev)
5483 unsigned int noio_flag;
5484 struct usb_port *port_dev;
5485 struct usb_host_config *config = udev->actconfig;
5486 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5488 if (udev->state == USB_STATE_NOTATTACHED ||
5489 udev->state == USB_STATE_SUSPENDED) {
5490 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5495 if (!udev->parent) {
5496 /* this requires hcd-specific logic; see ohci_restart() */
5497 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5501 port_dev = hub->ports[udev->portnum - 1];
5504 * Don't allocate memory with GFP_KERNEL in current
5505 * context to avoid possible deadlock if usb mass
5506 * storage interface or usbnet interface(iSCSI case)
5507 * is included in current configuration. The easist
5508 * approach is to do it for every device reset,
5509 * because the device 'memalloc_noio' flag may have
5510 * not been set before reseting the usb device.
5512 noio_flag = memalloc_noio_save();
5514 /* Prevent autosuspend during the reset */
5515 usb_autoresume_device(udev);
5518 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5519 struct usb_interface *cintf = config->interface[i];
5520 struct usb_driver *drv;
5523 if (cintf->dev.driver) {
5524 drv = to_usb_driver(cintf->dev.driver);
5525 if (drv->pre_reset && drv->post_reset)
5526 unbind = (drv->pre_reset)(cintf);
5527 else if (cintf->condition ==
5528 USB_INTERFACE_BOUND)
5531 usb_forced_unbind_intf(cintf);
5536 usb_lock_port(port_dev);
5537 ret = usb_reset_and_verify_device(udev);
5538 usb_unlock_port(port_dev);
5541 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5542 struct usb_interface *cintf = config->interface[i];
5543 struct usb_driver *drv;
5544 int rebind = cintf->needs_binding;
5546 if (!rebind && cintf->dev.driver) {
5547 drv = to_usb_driver(cintf->dev.driver);
5548 if (drv->post_reset)
5549 rebind = (drv->post_reset)(cintf);
5550 else if (cintf->condition ==
5551 USB_INTERFACE_BOUND)
5554 cintf->needs_binding = 1;
5557 usb_unbind_and_rebind_marked_interfaces(udev);
5560 usb_autosuspend_device(udev);
5561 memalloc_noio_restore(noio_flag);
5564 EXPORT_SYMBOL_GPL(usb_reset_device);
5568 * usb_queue_reset_device - Reset a USB device from an atomic context
5569 * @iface: USB interface belonging to the device to reset
5571 * This function can be used to reset a USB device from an atomic
5572 * context, where usb_reset_device() won't work (as it blocks).
5574 * Doing a reset via this method is functionally equivalent to calling
5575 * usb_reset_device(), except for the fact that it is delayed to a
5576 * workqueue. This means that any drivers bound to other interfaces
5577 * might be unbound, as well as users from usbfs in user space.
5581 * - Scheduling two resets at the same time from two different drivers
5582 * attached to two different interfaces of the same device is
5583 * possible; depending on how the driver attached to each interface
5584 * handles ->pre_reset(), the second reset might happen or not.
5586 * - If the reset is delayed so long that the interface is unbound from
5587 * its driver, the reset will be skipped.
5589 * - This function can be called during .probe(). It can also be called
5590 * during .disconnect(), but doing so is pointless because the reset
5591 * will not occur. If you really want to reset the device during
5592 * .disconnect(), call usb_reset_device() directly -- but watch out
5593 * for nested unbinding issues!
5595 void usb_queue_reset_device(struct usb_interface *iface)
5597 if (schedule_work(&iface->reset_ws))
5598 usb_get_intf(iface);
5600 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5603 * usb_hub_find_child - Get the pointer of child device
5604 * attached to the port which is specified by @port1.
5605 * @hdev: USB device belonging to the usb hub
5606 * @port1: port num to indicate which port the child device
5609 * USB drivers call this function to get hub's child device
5612 * Return: %NULL if input param is invalid and
5613 * child's usb_device pointer if non-NULL.
5615 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5618 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5620 if (port1 < 1 || port1 > hdev->maxchild)
5622 return hub->ports[port1 - 1]->child;
5624 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5626 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5627 struct usb_hub_descriptor *desc)
5629 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5630 enum usb_port_connect_type connect_type;
5636 if (!hub_is_superspeed(hdev)) {
5637 for (i = 1; i <= hdev->maxchild; i++) {
5638 struct usb_port *port_dev = hub->ports[i - 1];
5640 connect_type = port_dev->connect_type;
5641 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5642 u8 mask = 1 << (i%8);
5644 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5645 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5646 desc->u.hs.DeviceRemovable[i/8] |= mask;
5651 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5653 for (i = 1; i <= hdev->maxchild; i++) {
5654 struct usb_port *port_dev = hub->ports[i - 1];
5656 connect_type = port_dev->connect_type;
5657 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5660 if (!(port_removable & mask)) {
5661 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5662 port_removable |= mask;
5667 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5673 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5674 * @hdev: USB device belonging to the usb hub
5675 * @port1: port num of the port
5677 * Return: Port's acpi handle if successful, %NULL if params are
5680 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5683 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5688 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);