4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 #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 /* khubd's worklist and its lock */
45 static DEFINE_SPINLOCK(hub_event_lock);
46 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
49 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
51 static struct task_struct *khubd_task;
53 /* synchronize hub-port add/remove and peering operations */
54 DEFINE_MUTEX(usb_port_peer_mutex);
56 /* cycle leds on hubs that aren't blinking for attention */
57 static bool blinkenlights = 0;
58 module_param (blinkenlights, bool, S_IRUGO);
59 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
62 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
63 * 10 seconds to send reply for the initial 64-byte descriptor request.
65 /* define initial 64-byte descriptor request timeout in milliseconds */
66 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
67 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
68 MODULE_PARM_DESC(initial_descriptor_timeout,
69 "initial 64-byte descriptor request timeout in milliseconds "
70 "(default 5000 - 5.0 seconds)");
73 * As of 2.6.10 we introduce a new USB device initialization scheme which
74 * closely resembles the way Windows works. Hopefully it will be compatible
75 * with a wider range of devices than the old scheme. However some previously
76 * working devices may start giving rise to "device not accepting address"
77 * errors; if that happens the user can try the old scheme by adjusting the
78 * following module parameters.
80 * For maximum flexibility there are two boolean parameters to control the
81 * hub driver's behavior. On the first initialization attempt, if the
82 * "old_scheme_first" parameter is set then the old scheme will be used,
83 * otherwise the new scheme is used. If that fails and "use_both_schemes"
84 * is set, then the driver will make another attempt, using the other scheme.
86 static bool old_scheme_first = 0;
87 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
88 MODULE_PARM_DESC(old_scheme_first,
89 "start with the old device initialization scheme");
91 static bool use_both_schemes = 1;
92 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(use_both_schemes,
94 "try the other device initialization scheme if the "
97 /* Mutual exclusion for EHCI CF initialization. This interferes with
98 * port reset on some companion controllers.
100 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
101 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
103 #define HUB_DEBOUNCE_TIMEOUT 2000
104 #define HUB_DEBOUNCE_STEP 25
105 #define HUB_DEBOUNCE_STABLE 100
107 static int usb_reset_and_verify_device(struct usb_device *udev);
109 static inline char *portspeed(struct usb_hub *hub, int portstatus)
111 if (hub_is_superspeed(hub->hdev))
113 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
115 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
121 /* Note that hdev or one of its children must be locked! */
122 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
124 if (!hdev || !hdev->actconfig || !hdev->maxchild)
126 return usb_get_intfdata(hdev->actconfig->interface[0]);
129 static int usb_device_supports_lpm(struct usb_device *udev)
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) {
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_khubd(struct usb_hub *hub)
582 spin_lock_irqsave(&hub_event_lock, flags);
583 if (!hub->disconnected && list_empty(&hub->event_list)) {
584 list_add_tail(&hub->event_list, &hub_event_list);
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub->intfdev));
589 wake_up(&khubd_wait);
591 spin_unlock_irqrestore(&hub_event_lock, flags);
594 void usb_kick_khubd(struct usb_device *hdev)
596 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
610 void usb_wakeup_notification(struct usb_device *hdev,
611 unsigned int portnum)
618 hub = usb_hub_to_struct_hub(hdev);
620 set_bit(portnum, hub->wakeup_bits);
624 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
626 /* completion function, fires on port status changes and various faults */
627 static void hub_irq(struct urb *urb)
629 struct usb_hub *hub = urb->context;
630 int status = urb->status;
635 case -ENOENT: /* synchronous unlink */
636 case -ECONNRESET: /* async unlink */
637 case -ESHUTDOWN: /* hardware going away */
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
642 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
643 if ((++hub->nerrors < 10) || hub->error)
648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
651 for (i = 0; i < urb->actual_length; ++i)
652 bits |= ((unsigned long) ((*hub->buffer)[i]))
654 hub->event_bits[0] = bits;
660 /* Something happened, let khubd figure it out */
667 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
668 && status != -ENODEV && status != -EPERM)
669 dev_err (hub->intfdev, "resubmit --> %d\n", status);
672 /* USB 2.0 spec Section 11.24.2.3 */
674 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
676 /* Need to clear both directions for control ep */
677 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
678 USB_ENDPOINT_XFER_CONTROL) {
679 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
680 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
681 devinfo ^ 0x8000, tt, NULL, 0, 1000);
685 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
686 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
696 static void hub_tt_work(struct work_struct *work)
698 struct usb_hub *hub =
699 container_of(work, struct usb_hub, tt.clear_work);
702 spin_lock_irqsave (&hub->tt.lock, flags);
703 while (!list_empty(&hub->tt.clear_list)) {
704 struct list_head *next;
705 struct usb_tt_clear *clear;
706 struct usb_device *hdev = hub->hdev;
707 const struct hc_driver *drv;
710 next = hub->tt.clear_list.next;
711 clear = list_entry (next, struct usb_tt_clear, clear_list);
712 list_del (&clear->clear_list);
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub->tt.lock, flags);
716 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
717 if (status && status != -ENODEV)
719 "clear tt %d (%04x) error %d\n",
720 clear->tt, clear->devinfo, status);
722 /* Tell the HCD, even if the operation failed */
723 drv = clear->hcd->driver;
724 if (drv->clear_tt_buffer_complete)
725 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
728 spin_lock_irqsave(&hub->tt.lock, flags);
730 spin_unlock_irqrestore (&hub->tt.lock, flags);
734 * usb_hub_set_port_power - control hub port's power state
735 * @hdev: USB device belonging to the usb hub
738 * @set: expected status
740 * call this function to control port's power via setting or
741 * clearing the port's PORT_POWER feature.
743 * Return: 0 if successful. A negative error code otherwise.
745 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
751 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
753 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
759 set_bit(port1, hub->power_bits);
761 clear_bit(port1, hub->power_bits);
766 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
767 * @urb: an URB associated with the failed or incomplete split transaction
769 * High speed HCDs use this to tell the hub driver that some split control or
770 * bulk transaction failed in a way that requires clearing internal state of
771 * a transaction translator. This is normally detected (and reported) from
774 * It may not be possible for that hub to handle additional full (or low)
775 * speed transactions until that state is fully cleared out.
777 * Return: 0 if successful. A negative error code otherwise.
779 int usb_hub_clear_tt_buffer(struct urb *urb)
781 struct usb_device *udev = urb->dev;
782 int pipe = urb->pipe;
783 struct usb_tt *tt = udev->tt;
785 struct usb_tt_clear *clear;
787 /* we've got to cope with an arbitrary number of pending TT clears,
788 * since each TT has "at least two" buffers that can need it (and
789 * there can be many TTs per hub). even if they're uncommon.
791 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
792 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
793 /* FIXME recover somehow ... RESET_TT? */
797 /* info that CLEAR_TT_BUFFER needs */
798 clear->tt = tt->multi ? udev->ttport : 1;
799 clear->devinfo = usb_pipeendpoint (pipe);
800 clear->devinfo |= udev->devnum << 4;
801 clear->devinfo |= usb_pipecontrol (pipe)
802 ? (USB_ENDPOINT_XFER_CONTROL << 11)
803 : (USB_ENDPOINT_XFER_BULK << 11);
804 if (usb_pipein (pipe))
805 clear->devinfo |= 1 << 15;
807 /* info for completion callback */
808 clear->hcd = bus_to_hcd(udev->bus);
811 /* tell keventd to clear state for this TT */
812 spin_lock_irqsave (&tt->lock, flags);
813 list_add_tail (&clear->clear_list, &tt->clear_list);
814 schedule_work(&tt->clear_work);
815 spin_unlock_irqrestore (&tt->lock, flags);
818 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
820 static void hub_power_on(struct usb_hub *hub, bool do_delay)
824 /* Enable power on each port. Some hubs have reserved values
825 * of LPSM (> 2) in their descriptors, even though they are
826 * USB 2.0 hubs. Some hubs do not implement port-power switching
827 * but only emulate it. In all cases, the ports won't work
828 * unless we send these messages to the hub.
830 if (hub_is_port_power_switchable(hub))
831 dev_dbg(hub->intfdev, "enabling power on all ports\n");
833 dev_dbg(hub->intfdev, "trying to enable port power on "
834 "non-switchable hub\n");
835 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
836 if (test_bit(port1, hub->power_bits))
837 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
839 usb_clear_port_feature(hub->hdev, port1,
840 USB_PORT_FEAT_POWER);
842 msleep(hub_power_on_good_delay(hub));
845 static int hub_hub_status(struct usb_hub *hub,
846 u16 *status, u16 *change)
850 mutex_lock(&hub->status_mutex);
851 ret = get_hub_status(hub->hdev, &hub->status->hub);
854 dev_err(hub->intfdev,
855 "%s failed (err = %d)\n", __func__, ret);
857 *status = le16_to_cpu(hub->status->hub.wHubStatus);
858 *change = le16_to_cpu(hub->status->hub.wHubChange);
861 mutex_unlock(&hub->status_mutex);
865 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
866 unsigned int link_status)
868 return set_port_feature(hub->hdev,
869 port1 | (link_status << 3),
870 USB_PORT_FEAT_LINK_STATE);
874 * If USB 3.0 ports are placed into the Disabled state, they will no longer
875 * detect any device connects or disconnects. This is generally not what the
876 * USB core wants, since it expects a disabled port to produce a port status
877 * change event when a new device connects.
879 * Instead, set the link state to Disabled, wait for the link to settle into
880 * that state, clear any change bits, and then put the port into the RxDetect
883 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
887 u16 portchange, portstatus;
889 if (!hub_is_superspeed(hub->hdev))
892 ret = hub_port_status(hub, port1, &portstatus, &portchange);
897 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
898 * Controller [1022:7814] will have spurious result making the following
899 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
900 * as high-speed device if we set the usb 3.0 port link state to
901 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
902 * check the state here to avoid the bug.
904 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
905 USB_SS_PORT_LS_RX_DETECT) {
906 dev_dbg(&hub->ports[port1 - 1]->dev,
907 "Not disabling port; link state is RxDetect\n");
911 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
915 /* Wait for the link to enter the disabled state. */
916 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
917 ret = hub_port_status(hub, port1, &portstatus, &portchange);
921 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
922 USB_SS_PORT_LS_SS_DISABLED)
924 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
926 msleep(HUB_DEBOUNCE_STEP);
928 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
929 dev_warn(&hub->ports[port1 - 1]->dev,
930 "Could not disable after %d ms\n", total_time);
932 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
935 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
937 struct usb_port *port_dev = hub->ports[port1 - 1];
938 struct usb_device *hdev = hub->hdev;
941 if (port_dev->child && set_state)
942 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
944 if (hub_is_superspeed(hub->hdev))
945 ret = hub_usb3_port_disable(hub, port1);
947 ret = usb_clear_port_feature(hdev, port1,
948 USB_PORT_FEAT_ENABLE);
950 if (ret && ret != -ENODEV)
951 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
956 * Disable a port and mark a logical connect-change event, so that some
957 * time later khubd will disconnect() any existing usb_device on the port
958 * and will re-enumerate if there actually is a device attached.
960 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
962 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
963 hub_port_disable(hub, port1, 1);
965 /* FIXME let caller ask to power down the port:
966 * - some devices won't enumerate without a VBUS power cycle
967 * - SRP saves power that way
968 * - ... new call, TBD ...
969 * That's easy if this hub can switch power per-port, and
970 * khubd reactivates the port later (timer, SRP, etc).
971 * Powerdown must be optional, because of reset/DFU.
974 set_bit(port1, hub->change_bits);
979 * usb_remove_device - disable a device's port on its parent hub
980 * @udev: device to be disabled and removed
981 * Context: @udev locked, must be able to sleep.
983 * After @udev's port has been disabled, khubd is notified and it will
984 * see that the device has been disconnected. When the device is
985 * physically unplugged and something is plugged in, the events will
986 * be received and processed normally.
988 * Return: 0 if successful. A negative error code otherwise.
990 int usb_remove_device(struct usb_device *udev)
993 struct usb_interface *intf;
995 if (!udev->parent) /* Can't remove a root hub */
997 hub = usb_hub_to_struct_hub(udev->parent);
998 intf = to_usb_interface(hub->intfdev);
1000 usb_autopm_get_interface(intf);
1001 set_bit(udev->portnum, hub->removed_bits);
1002 hub_port_logical_disconnect(hub, udev->portnum);
1003 usb_autopm_put_interface(intf);
1007 enum hub_activation_type {
1008 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1009 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1012 static void hub_init_func2(struct work_struct *ws);
1013 static void hub_init_func3(struct work_struct *ws);
1015 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1017 struct usb_device *hdev = hub->hdev;
1018 struct usb_hcd *hcd;
1022 bool need_debounce_delay = false;
1025 /* Continue a partial initialization */
1026 if (type == HUB_INIT2)
1028 if (type == HUB_INIT3)
1031 /* The superspeed hub except for root hub has to use Hub Depth
1032 * value as an offset into the route string to locate the bits
1033 * it uses to determine the downstream port number. So hub driver
1034 * should send a set hub depth request to superspeed hub after
1035 * the superspeed hub is set configuration in initialization or
1038 * After a resume, port power should still be on.
1039 * For any other type of activation, turn it on.
1041 if (type != HUB_RESUME) {
1042 if (hdev->parent && hub_is_superspeed(hdev)) {
1043 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1044 HUB_SET_DEPTH, USB_RT_HUB,
1045 hdev->level - 1, 0, NULL, 0,
1046 USB_CTRL_SET_TIMEOUT);
1048 dev_err(hub->intfdev,
1049 "set hub depth failed\n");
1052 /* Speed up system boot by using a delayed_work for the
1053 * hub's initial power-up delays. This is pretty awkward
1054 * and the implementation looks like a home-brewed sort of
1055 * setjmp/longjmp, but it saves at least 100 ms for each
1056 * root hub (assuming usbcore is compiled into the kernel
1057 * rather than as a module). It adds up.
1059 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1060 * because for those activation types the ports have to be
1061 * operational when we return. In theory this could be done
1062 * for HUB_POST_RESET, but it's easier not to.
1064 if (type == HUB_INIT) {
1065 unsigned delay = hub_power_on_good_delay(hub);
1067 hub_power_on(hub, false);
1068 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1069 queue_delayed_work(system_power_efficient_wq,
1071 msecs_to_jiffies(delay));
1073 /* Suppress autosuspend until init is done */
1074 usb_autopm_get_interface_no_resume(
1075 to_usb_interface(hub->intfdev));
1076 return; /* Continues at init2: below */
1077 } else if (type == HUB_RESET_RESUME) {
1078 /* The internal host controller state for the hub device
1079 * may be gone after a host power loss on system resume.
1080 * Update the device's info so the HW knows it's a hub.
1082 hcd = bus_to_hcd(hdev->bus);
1083 if (hcd->driver->update_hub_device) {
1084 ret = hcd->driver->update_hub_device(hcd, hdev,
1085 &hub->tt, GFP_NOIO);
1087 dev_err(hub->intfdev, "Host not "
1088 "accepting hub info "
1090 dev_err(hub->intfdev, "LS/FS devices "
1091 "and hubs may not work "
1092 "under this hub\n.");
1095 hub_power_on(hub, true);
1097 hub_power_on(hub, true);
1103 * Check each port and set hub->change_bits to let khubd know
1104 * which ports need attention.
1106 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1107 struct usb_port *port_dev = hub->ports[port1 - 1];
1108 struct usb_device *udev = port_dev->child;
1109 u16 portstatus, portchange;
1111 portstatus = portchange = 0;
1112 status = hub_port_status(hub, port1, &portstatus, &portchange);
1113 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1114 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1115 portstatus, portchange);
1118 * After anything other than HUB_RESUME (i.e., initialization
1119 * or any sort of reset), every port should be disabled.
1120 * Unconnected ports should likewise be disabled (paranoia),
1121 * and so should ports for which we have no usb_device.
1123 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1124 type != HUB_RESUME ||
1125 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1127 udev->state == USB_STATE_NOTATTACHED)) {
1129 * USB3 protocol ports will automatically transition
1130 * to Enabled state when detect an USB3.0 device attach.
1131 * Do not disable USB3 protocol ports, just pretend
1134 portstatus &= ~USB_PORT_STAT_ENABLE;
1135 if (!hub_is_superspeed(hdev))
1136 usb_clear_port_feature(hdev, port1,
1137 USB_PORT_FEAT_ENABLE);
1140 /* Clear status-change flags; we'll debounce later */
1141 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1142 need_debounce_delay = true;
1143 usb_clear_port_feature(hub->hdev, port1,
1144 USB_PORT_FEAT_C_CONNECTION);
1146 if (portchange & USB_PORT_STAT_C_ENABLE) {
1147 need_debounce_delay = true;
1148 usb_clear_port_feature(hub->hdev, port1,
1149 USB_PORT_FEAT_C_ENABLE);
1151 if (portchange & USB_PORT_STAT_C_RESET) {
1152 need_debounce_delay = true;
1153 usb_clear_port_feature(hub->hdev, port1,
1154 USB_PORT_FEAT_C_RESET);
1156 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1157 hub_is_superspeed(hub->hdev)) {
1158 need_debounce_delay = true;
1159 usb_clear_port_feature(hub->hdev, port1,
1160 USB_PORT_FEAT_C_BH_PORT_RESET);
1162 /* We can forget about a "removed" device when there's a
1163 * physical disconnect or the connect status changes.
1165 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1166 (portchange & USB_PORT_STAT_C_CONNECTION))
1167 clear_bit(port1, hub->removed_bits);
1169 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1170 /* Tell khubd to disconnect the device or
1171 * check for a new connection
1173 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1174 (portstatus & USB_PORT_STAT_OVERCURRENT))
1175 set_bit(port1, hub->change_bits);
1177 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1178 bool port_resumed = (portstatus &
1179 USB_PORT_STAT_LINK_STATE) ==
1181 /* The power session apparently survived the resume.
1182 * If there was an overcurrent or suspend change
1183 * (i.e., remote wakeup request), have khubd
1184 * take care of it. Look at the port link state
1185 * for USB 3.0 hubs, since they don't have a suspend
1186 * change bit, and they don't set the port link change
1187 * bit on device-initiated resume.
1189 if (portchange || (hub_is_superspeed(hub->hdev) &&
1191 set_bit(port1, hub->change_bits);
1193 } else if (udev->persist_enabled) {
1195 udev->reset_resume = 1;
1197 /* Don't set the change_bits when the device
1200 if (test_bit(port1, hub->power_bits))
1201 set_bit(port1, hub->change_bits);
1204 /* The power session is gone; tell khubd */
1205 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1206 set_bit(port1, hub->change_bits);
1210 /* If no port-status-change flags were set, we don't need any
1211 * debouncing. If flags were set we can try to debounce the
1212 * ports all at once right now, instead of letting khubd do them
1213 * one at a time later on.
1215 * If any port-status changes do occur during this delay, khubd
1216 * will see them later and handle them normally.
1218 if (need_debounce_delay) {
1219 delay = HUB_DEBOUNCE_STABLE;
1221 /* Don't do a long sleep inside a workqueue routine */
1222 if (type == HUB_INIT2) {
1223 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1224 queue_delayed_work(system_power_efficient_wq,
1226 msecs_to_jiffies(delay));
1227 return; /* Continues at init3: below */
1235 status = usb_submit_urb(hub->urb, GFP_NOIO);
1237 dev_err(hub->intfdev, "activate --> %d\n", status);
1238 if (hub->has_indicators && blinkenlights)
1239 queue_delayed_work(system_power_efficient_wq,
1240 &hub->leds, LED_CYCLE_PERIOD);
1242 /* Scan all ports that need attention */
1245 /* Allow autosuspend if it was suppressed */
1246 if (type <= HUB_INIT3)
1247 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1250 /* Implement the continuations for the delays above */
1251 static void hub_init_func2(struct work_struct *ws)
1253 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1255 hub_activate(hub, HUB_INIT2);
1258 static void hub_init_func3(struct work_struct *ws)
1260 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1262 hub_activate(hub, HUB_INIT3);
1265 enum hub_quiescing_type {
1266 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1269 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1271 struct usb_device *hdev = hub->hdev;
1274 cancel_delayed_work_sync(&hub->init_work);
1276 /* khubd and related activity won't re-trigger */
1279 if (type != HUB_SUSPEND) {
1280 /* Disconnect all the children */
1281 for (i = 0; i < hdev->maxchild; ++i) {
1282 if (hub->ports[i]->child)
1283 usb_disconnect(&hub->ports[i]->child);
1287 /* Stop khubd and related activity */
1288 usb_kill_urb(hub->urb);
1289 if (hub->has_indicators)
1290 cancel_delayed_work_sync(&hub->leds);
1292 flush_work(&hub->tt.clear_work);
1295 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1299 for (i = 0; i < hub->hdev->maxchild; ++i)
1300 pm_runtime_barrier(&hub->ports[i]->dev);
1303 /* caller has locked the hub device */
1304 static int hub_pre_reset(struct usb_interface *intf)
1306 struct usb_hub *hub = usb_get_intfdata(intf);
1308 hub_quiesce(hub, HUB_PRE_RESET);
1310 hub_pm_barrier_for_all_ports(hub);
1314 /* caller has locked the hub device */
1315 static int hub_post_reset(struct usb_interface *intf)
1317 struct usb_hub *hub = usb_get_intfdata(intf);
1320 hub_pm_barrier_for_all_ports(hub);
1321 hub_activate(hub, HUB_POST_RESET);
1325 static int hub_configure(struct usb_hub *hub,
1326 struct usb_endpoint_descriptor *endpoint)
1328 struct usb_hcd *hcd;
1329 struct usb_device *hdev = hub->hdev;
1330 struct device *hub_dev = hub->intfdev;
1331 u16 hubstatus, hubchange;
1332 u16 wHubCharacteristics;
1335 char *message = "out of memory";
1340 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1346 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1351 mutex_init(&hub->status_mutex);
1353 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1354 if (!hub->descriptor) {
1359 /* Request the entire hub descriptor.
1360 * hub->descriptor can handle USB_MAXCHILDREN ports,
1361 * but the hub can/will return fewer bytes here.
1363 ret = get_hub_descriptor(hdev, hub->descriptor);
1365 message = "can't read hub descriptor";
1367 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1368 message = "hub has too many ports!";
1371 } else if (hub->descriptor->bNbrPorts == 0) {
1372 message = "hub doesn't have any ports!";
1377 maxchild = hub->descriptor->bNbrPorts;
1378 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1379 (maxchild == 1) ? "" : "s");
1381 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1387 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1388 if (hub_is_superspeed(hdev)) {
1396 /* FIXME for USB 3.0, skip for now */
1397 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1398 !(hub_is_superspeed(hdev))) {
1400 char portstr[USB_MAXCHILDREN + 1];
1402 for (i = 0; i < maxchild; i++)
1403 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1404 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1406 portstr[maxchild] = 0;
1407 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1409 dev_dbg(hub_dev, "standalone hub\n");
1411 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1412 case HUB_CHAR_COMMON_LPSM:
1413 dev_dbg(hub_dev, "ganged power switching\n");
1415 case HUB_CHAR_INDV_PORT_LPSM:
1416 dev_dbg(hub_dev, "individual port power switching\n");
1418 case HUB_CHAR_NO_LPSM:
1420 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1424 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1425 case HUB_CHAR_COMMON_OCPM:
1426 dev_dbg(hub_dev, "global over-current protection\n");
1428 case HUB_CHAR_INDV_PORT_OCPM:
1429 dev_dbg(hub_dev, "individual port over-current protection\n");
1431 case HUB_CHAR_NO_OCPM:
1433 dev_dbg(hub_dev, "no over-current protection\n");
1437 spin_lock_init (&hub->tt.lock);
1438 INIT_LIST_HEAD (&hub->tt.clear_list);
1439 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1440 switch (hdev->descriptor.bDeviceProtocol) {
1443 case USB_HUB_PR_HS_SINGLE_TT:
1444 dev_dbg(hub_dev, "Single TT\n");
1447 case USB_HUB_PR_HS_MULTI_TT:
1448 ret = usb_set_interface(hdev, 0, 1);
1450 dev_dbg(hub_dev, "TT per port\n");
1453 dev_err(hub_dev, "Using single TT (err %d)\n",
1458 /* USB 3.0 hubs don't have a TT */
1461 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1462 hdev->descriptor.bDeviceProtocol);
1466 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1467 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1468 case HUB_TTTT_8_BITS:
1469 if (hdev->descriptor.bDeviceProtocol != 0) {
1470 hub->tt.think_time = 666;
1471 dev_dbg(hub_dev, "TT requires at most %d "
1472 "FS bit times (%d ns)\n",
1473 8, hub->tt.think_time);
1476 case HUB_TTTT_16_BITS:
1477 hub->tt.think_time = 666 * 2;
1478 dev_dbg(hub_dev, "TT requires at most %d "
1479 "FS bit times (%d ns)\n",
1480 16, hub->tt.think_time);
1482 case HUB_TTTT_24_BITS:
1483 hub->tt.think_time = 666 * 3;
1484 dev_dbg(hub_dev, "TT requires at most %d "
1485 "FS bit times (%d ns)\n",
1486 24, hub->tt.think_time);
1488 case HUB_TTTT_32_BITS:
1489 hub->tt.think_time = 666 * 4;
1490 dev_dbg(hub_dev, "TT requires at most %d "
1491 "FS bit times (%d ns)\n",
1492 32, hub->tt.think_time);
1496 /* probe() zeroes hub->indicator[] */
1497 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1498 hub->has_indicators = 1;
1499 dev_dbg(hub_dev, "Port indicators are supported\n");
1502 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1503 hub->descriptor->bPwrOn2PwrGood * 2);
1505 /* power budgeting mostly matters with bus-powered hubs,
1506 * and battery-powered root hubs (may provide just 8 mA).
1508 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1510 message = "can't get hub status";
1513 hcd = bus_to_hcd(hdev->bus);
1514 if (hdev == hdev->bus->root_hub) {
1515 if (hcd->power_budget > 0)
1516 hdev->bus_mA = hcd->power_budget;
1518 hdev->bus_mA = full_load * maxchild;
1519 if (hdev->bus_mA >= full_load)
1520 hub->mA_per_port = full_load;
1522 hub->mA_per_port = hdev->bus_mA;
1523 hub->limited_power = 1;
1525 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1526 int remaining = hdev->bus_mA -
1527 hub->descriptor->bHubContrCurrent;
1529 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1530 hub->descriptor->bHubContrCurrent);
1531 hub->limited_power = 1;
1533 if (remaining < maxchild * unit_load)
1535 "insufficient power available "
1536 "to use all downstream ports\n");
1537 hub->mA_per_port = unit_load; /* 7.2.1 */
1539 } else { /* Self-powered external hub */
1540 /* FIXME: What about battery-powered external hubs that
1541 * provide less current per port? */
1542 hub->mA_per_port = full_load;
1544 if (hub->mA_per_port < full_load)
1545 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1548 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1550 message = "can't get hub status";
1554 /* local power status reports aren't always correct */
1555 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1556 dev_dbg(hub_dev, "local power source is %s\n",
1557 (hubstatus & HUB_STATUS_LOCAL_POWER)
1558 ? "lost (inactive)" : "good");
1560 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1561 dev_dbg(hub_dev, "%sover-current condition exists\n",
1562 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1564 /* set up the interrupt endpoint
1565 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1566 * bytes as USB2.0[11.12.3] says because some hubs are known
1567 * to send more data (and thus cause overflow). For root hubs,
1568 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1569 * to be big enough for at least USB_MAXCHILDREN ports. */
1570 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1571 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1573 if (maxp > sizeof(*hub->buffer))
1574 maxp = sizeof(*hub->buffer);
1576 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1582 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1583 hub, endpoint->bInterval);
1585 /* maybe cycle the hub leds */
1586 if (hub->has_indicators && blinkenlights)
1587 hub->indicator[0] = INDICATOR_CYCLE;
1589 mutex_lock(&usb_port_peer_mutex);
1590 for (i = 0; i < maxchild; i++) {
1591 ret = usb_hub_create_port_device(hub, i + 1);
1593 dev_err(hub->intfdev,
1594 "couldn't create port%d device.\n", i + 1);
1599 for (i = 0; i < hdev->maxchild; i++) {
1600 struct usb_port *port_dev = hub->ports[i];
1602 pm_runtime_put(&port_dev->dev);
1605 mutex_unlock(&usb_port_peer_mutex);
1609 /* Update the HCD's internal representation of this hub before khubd
1610 * starts getting port status changes for devices under the hub.
1612 if (hcd->driver->update_hub_device) {
1613 ret = hcd->driver->update_hub_device(hcd, hdev,
1614 &hub->tt, GFP_KERNEL);
1616 message = "can't update HCD hub info";
1621 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1623 hub_activate(hub, HUB_INIT);
1627 dev_err (hub_dev, "config failed, %s (err %d)\n",
1629 /* hub_disconnect() frees urb and descriptor */
1633 static void hub_release(struct kref *kref)
1635 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1637 usb_put_intf(to_usb_interface(hub->intfdev));
1641 static unsigned highspeed_hubs;
1643 static void hub_disconnect(struct usb_interface *intf)
1645 struct usb_hub *hub = usb_get_intfdata(intf);
1646 struct usb_device *hdev = interface_to_usbdev(intf);
1649 /* Take the hub off the event list and don't let it be added again */
1650 spin_lock_irq(&hub_event_lock);
1651 if (!list_empty(&hub->event_list)) {
1652 list_del_init(&hub->event_list);
1653 usb_autopm_put_interface_no_suspend(intf);
1655 hub->disconnected = 1;
1656 spin_unlock_irq(&hub_event_lock);
1658 /* Disconnect all children and quiesce the hub */
1660 hub_quiesce(hub, HUB_DISCONNECT);
1662 mutex_lock(&usb_port_peer_mutex);
1664 /* Avoid races with recursively_mark_NOTATTACHED() */
1665 spin_lock_irq(&device_state_lock);
1666 port1 = hdev->maxchild;
1668 usb_set_intfdata(intf, NULL);
1669 spin_unlock_irq(&device_state_lock);
1671 for (; port1 > 0; --port1)
1672 usb_hub_remove_port_device(hub, port1);
1674 mutex_unlock(&usb_port_peer_mutex);
1676 if (hub->hdev->speed == USB_SPEED_HIGH)
1679 usb_free_urb(hub->urb);
1681 kfree(hub->descriptor);
1685 pm_suspend_ignore_children(&intf->dev, false);
1686 kref_put(&hub->kref, hub_release);
1689 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1691 struct usb_host_interface *desc;
1692 struct usb_endpoint_descriptor *endpoint;
1693 struct usb_device *hdev;
1694 struct usb_hub *hub;
1696 desc = intf->cur_altsetting;
1697 hdev = interface_to_usbdev(intf);
1700 * Set default autosuspend delay as 0 to speedup bus suspend,
1701 * based on the below considerations:
1703 * - Unlike other drivers, the hub driver does not rely on the
1704 * autosuspend delay to provide enough time to handle a wakeup
1705 * event, and the submitted status URB is just to check future
1706 * change on hub downstream ports, so it is safe to do it.
1708 * - The patch might cause one or more auto supend/resume for
1709 * below very rare devices when they are plugged into hub
1712 * devices having trouble initializing, and disconnect
1713 * themselves from the bus and then reconnect a second
1716 * devices just for downloading firmware, and disconnects
1717 * themselves after completing it
1719 * For these quite rare devices, their drivers may change the
1720 * autosuspend delay of their parent hub in the probe() to one
1721 * appropriate value to avoid the subtle problem if someone
1724 * - The patch may cause one or more auto suspend/resume on
1725 * hub during running 'lsusb', but it is probably too
1726 * infrequent to worry about.
1728 * - Change autosuspend delay of hub can avoid unnecessary auto
1729 * suspend timer for hub, also may decrease power consumption
1732 * - If user has indicated to prevent autosuspend by passing
1733 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1735 #ifdef CONFIG_PM_RUNTIME
1736 if (hdev->dev.power.autosuspend_delay >= 0)
1737 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1741 * Hubs have proper suspend/resume support, except for root hubs
1742 * where the controller driver doesn't have bus_suspend and
1743 * bus_resume methods.
1745 if (hdev->parent) { /* normal device */
1746 usb_enable_autosuspend(hdev);
1747 } else { /* root hub */
1748 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1750 if (drv->bus_suspend && drv->bus_resume)
1751 usb_enable_autosuspend(hdev);
1754 if (hdev->level == MAX_TOPO_LEVEL) {
1756 "Unsupported bus topology: hub nested too deep\n");
1760 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1762 dev_warn(&intf->dev, "ignoring external hub\n");
1767 /* Some hubs have a subclass of 1, which AFAICT according to the */
1768 /* specs is not defined, but it works */
1769 if ((desc->desc.bInterfaceSubClass != 0) &&
1770 (desc->desc.bInterfaceSubClass != 1)) {
1772 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1776 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1777 if (desc->desc.bNumEndpoints != 1)
1778 goto descriptor_error;
1780 endpoint = &desc->endpoint[0].desc;
1782 /* If it's not an interrupt in endpoint, we'd better punt! */
1783 if (!usb_endpoint_is_int_in(endpoint))
1784 goto descriptor_error;
1786 /* We found a hub */
1787 dev_info (&intf->dev, "USB hub found\n");
1789 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1791 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1795 kref_init(&hub->kref);
1796 INIT_LIST_HEAD(&hub->event_list);
1797 hub->intfdev = &intf->dev;
1799 INIT_DELAYED_WORK(&hub->leds, led_work);
1800 INIT_DELAYED_WORK(&hub->init_work, NULL);
1803 usb_set_intfdata (intf, hub);
1804 intf->needs_remote_wakeup = 1;
1805 pm_suspend_ignore_children(&intf->dev, true);
1807 if (hdev->speed == USB_SPEED_HIGH)
1810 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1811 hub->quirk_check_port_auto_suspend = 1;
1813 if (hub_configure(hub, endpoint) >= 0)
1816 hub_disconnect (intf);
1821 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1823 struct usb_device *hdev = interface_to_usbdev (intf);
1824 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1826 /* assert ifno == 0 (part of hub spec) */
1828 case USBDEVFS_HUB_PORTINFO: {
1829 struct usbdevfs_hub_portinfo *info = user_data;
1832 spin_lock_irq(&device_state_lock);
1833 if (hdev->devnum <= 0)
1836 info->nports = hdev->maxchild;
1837 for (i = 0; i < info->nports; i++) {
1838 if (hub->ports[i]->child == NULL)
1842 hub->ports[i]->child->devnum;
1845 spin_unlock_irq(&device_state_lock);
1847 return info->nports + 1;
1856 * Allow user programs to claim ports on a hub. When a device is attached
1857 * to one of these "claimed" ports, the program will "own" the device.
1859 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1860 struct usb_dev_state ***ppowner)
1862 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1864 if (hdev->state == USB_STATE_NOTATTACHED)
1866 if (port1 == 0 || port1 > hdev->maxchild)
1869 /* Devices not managed by the hub driver
1870 * will always have maxchild equal to 0.
1872 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1876 /* In the following three functions, the caller must hold hdev's lock */
1877 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1878 struct usb_dev_state *owner)
1881 struct usb_dev_state **powner;
1883 rc = find_port_owner(hdev, port1, &powner);
1891 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1893 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1894 struct usb_dev_state *owner)
1897 struct usb_dev_state **powner;
1899 rc = find_port_owner(hdev, port1, &powner);
1902 if (*powner != owner)
1907 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1909 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1911 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1914 for (n = 0; n < hdev->maxchild; n++) {
1915 if (hub->ports[n]->port_owner == owner)
1916 hub->ports[n]->port_owner = NULL;
1921 /* The caller must hold udev's lock */
1922 bool usb_device_is_owned(struct usb_device *udev)
1924 struct usb_hub *hub;
1926 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1928 hub = usb_hub_to_struct_hub(udev->parent);
1929 return !!hub->ports[udev->portnum - 1]->port_owner;
1932 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1934 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1937 for (i = 0; i < udev->maxchild; ++i) {
1938 if (hub->ports[i]->child)
1939 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1941 if (udev->state == USB_STATE_SUSPENDED)
1942 udev->active_duration -= jiffies;
1943 udev->state = USB_STATE_NOTATTACHED;
1947 * usb_set_device_state - change a device's current state (usbcore, hcds)
1948 * @udev: pointer to device whose state should be changed
1949 * @new_state: new state value to be stored
1951 * udev->state is _not_ fully protected by the device lock. Although
1952 * most transitions are made only while holding the lock, the state can
1953 * can change to USB_STATE_NOTATTACHED at almost any time. This
1954 * is so that devices can be marked as disconnected as soon as possible,
1955 * without having to wait for any semaphores to be released. As a result,
1956 * all changes to any device's state must be protected by the
1957 * device_state_lock spinlock.
1959 * Once a device has been added to the device tree, all changes to its state
1960 * should be made using this routine. The state should _not_ be set directly.
1962 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1963 * Otherwise udev->state is set to new_state, and if new_state is
1964 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1965 * to USB_STATE_NOTATTACHED.
1967 void usb_set_device_state(struct usb_device *udev,
1968 enum usb_device_state new_state)
1970 unsigned long flags;
1973 spin_lock_irqsave(&device_state_lock, flags);
1974 if (udev->state == USB_STATE_NOTATTACHED)
1976 else if (new_state != USB_STATE_NOTATTACHED) {
1978 /* root hub wakeup capabilities are managed out-of-band
1979 * and may involve silicon errata ... ignore them here.
1982 if (udev->state == USB_STATE_SUSPENDED
1983 || new_state == USB_STATE_SUSPENDED)
1984 ; /* No change to wakeup settings */
1985 else if (new_state == USB_STATE_CONFIGURED)
1986 wakeup = udev->actconfig->desc.bmAttributes
1987 & USB_CONFIG_ATT_WAKEUP;
1991 if (udev->state == USB_STATE_SUSPENDED &&
1992 new_state != USB_STATE_SUSPENDED)
1993 udev->active_duration -= jiffies;
1994 else if (new_state == USB_STATE_SUSPENDED &&
1995 udev->state != USB_STATE_SUSPENDED)
1996 udev->active_duration += jiffies;
1997 udev->state = new_state;
1999 recursively_mark_NOTATTACHED(udev);
2000 spin_unlock_irqrestore(&device_state_lock, flags);
2002 device_set_wakeup_capable(&udev->dev, wakeup);
2004 EXPORT_SYMBOL_GPL(usb_set_device_state);
2007 * Choose a device number.
2009 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2010 * USB-2.0 buses they are also used as device addresses, however on
2011 * USB-3.0 buses the address is assigned by the controller hardware
2012 * and it usually is not the same as the device number.
2014 * WUSB devices are simple: they have no hubs behind, so the mapping
2015 * device <-> virtual port number becomes 1:1. Why? to simplify the
2016 * life of the device connection logic in
2017 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2018 * handshake we need to assign a temporary address in the unauthorized
2019 * space. For simplicity we use the first virtual port number found to
2020 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2021 * and that becomes it's address [X < 128] or its unauthorized address
2024 * We add 1 as an offset to the one-based USB-stack port number
2025 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2026 * 0 is reserved by USB for default address; (b) Linux's USB stack
2027 * uses always #1 for the root hub of the controller. So USB stack's
2028 * port #1, which is wusb virtual-port #0 has address #2.
2030 * Devices connected under xHCI are not as simple. The host controller
2031 * supports virtualization, so the hardware assigns device addresses and
2032 * the HCD must setup data structures before issuing a set address
2033 * command to the hardware.
2035 static void choose_devnum(struct usb_device *udev)
2038 struct usb_bus *bus = udev->bus;
2040 /* If khubd ever becomes multithreaded, this will need a lock */
2042 devnum = udev->portnum + 1;
2043 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2045 /* Try to allocate the next devnum beginning at
2046 * bus->devnum_next. */
2047 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2050 devnum = find_next_zero_bit(bus->devmap.devicemap,
2052 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2055 set_bit(devnum, bus->devmap.devicemap);
2056 udev->devnum = devnum;
2060 static void release_devnum(struct usb_device *udev)
2062 if (udev->devnum > 0) {
2063 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2068 static void update_devnum(struct usb_device *udev, int devnum)
2070 /* The address for a WUSB device is managed by wusbcore. */
2072 udev->devnum = devnum;
2075 static void hub_free_dev(struct usb_device *udev)
2077 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2079 /* Root hubs aren't real devices, so don't free HCD resources */
2080 if (hcd->driver->free_dev && udev->parent)
2081 hcd->driver->free_dev(hcd, udev);
2084 static void hub_disconnect_children(struct usb_device *udev)
2086 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2089 /* Free up all the children before we remove this device */
2090 for (i = 0; i < udev->maxchild; i++) {
2091 if (hub->ports[i]->child)
2092 usb_disconnect(&hub->ports[i]->child);
2097 * usb_disconnect - disconnect a device (usbcore-internal)
2098 * @pdev: pointer to device being disconnected
2099 * Context: !in_interrupt ()
2101 * Something got disconnected. Get rid of it and all of its children.
2103 * If *pdev is a normal device then the parent hub must already be locked.
2104 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2105 * which protects the set of root hubs as well as the list of buses.
2107 * Only hub drivers (including virtual root hub drivers for host
2108 * controllers) should ever call this.
2110 * This call is synchronous, and may not be used in an interrupt context.
2112 void usb_disconnect(struct usb_device **pdev)
2114 struct usb_port *port_dev = NULL;
2115 struct usb_device *udev = *pdev;
2116 struct usb_hub *hub = NULL;
2119 /* mark the device as inactive, so any further urb submissions for
2120 * this device (and any of its children) will fail immediately.
2121 * this quiesces everything except pending urbs.
2123 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2124 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2127 usb_lock_device(udev);
2129 hub_disconnect_children(udev);
2131 /* deallocate hcd/hardware state ... nuking all pending urbs and
2132 * cleaning up all state associated with the current configuration
2133 * so that the hardware is now fully quiesced.
2135 dev_dbg (&udev->dev, "unregistering device\n");
2136 usb_disable_device(udev, 0);
2137 usb_hcd_synchronize_unlinks(udev);
2140 port1 = udev->portnum;
2141 hub = usb_hub_to_struct_hub(udev->parent);
2142 port_dev = hub->ports[port1 - 1];
2144 sysfs_remove_link(&udev->dev.kobj, "port");
2145 sysfs_remove_link(&port_dev->dev.kobj, "device");
2148 * As usb_port_runtime_resume() de-references udev, make
2149 * sure no resumes occur during removal
2151 if (!test_and_set_bit(port1, hub->child_usage_bits))
2152 pm_runtime_get_sync(&port_dev->dev);
2155 usb_remove_ep_devs(&udev->ep0);
2156 usb_unlock_device(udev);
2158 /* Unregister the device. The device driver is responsible
2159 * for de-configuring the device and invoking the remove-device
2160 * notifier chain (used by usbfs and possibly others).
2162 device_del(&udev->dev);
2164 /* Free the device number and delete the parent's children[]
2165 * (or root_hub) pointer.
2167 release_devnum(udev);
2169 /* Avoid races with recursively_mark_NOTATTACHED() */
2170 spin_lock_irq(&device_state_lock);
2172 spin_unlock_irq(&device_state_lock);
2174 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2175 pm_runtime_put(&port_dev->dev);
2179 put_device(&udev->dev);
2182 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2183 static void show_string(struct usb_device *udev, char *id, char *string)
2187 dev_info(&udev->dev, "%s: %s\n", id, string);
2190 static void announce_device(struct usb_device *udev)
2192 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2193 le16_to_cpu(udev->descriptor.idVendor),
2194 le16_to_cpu(udev->descriptor.idProduct));
2195 dev_info(&udev->dev,
2196 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2197 udev->descriptor.iManufacturer,
2198 udev->descriptor.iProduct,
2199 udev->descriptor.iSerialNumber);
2200 show_string(udev, "Product", udev->product);
2201 show_string(udev, "Manufacturer", udev->manufacturer);
2202 show_string(udev, "SerialNumber", udev->serial);
2205 static inline void announce_device(struct usb_device *udev) { }
2208 #ifdef CONFIG_USB_OTG
2209 #include "otg_whitelist.h"
2213 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2214 * @udev: newly addressed device (in ADDRESS state)
2216 * Finish enumeration for On-The-Go devices
2218 * Return: 0 if successful. A negative error code otherwise.
2220 static int usb_enumerate_device_otg(struct usb_device *udev)
2224 #ifdef CONFIG_USB_OTG
2226 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2227 * to wake us after we've powered off VBUS; and HNP, switching roles
2228 * "host" to "peripheral". The OTG descriptor helps figure this out.
2230 if (!udev->bus->is_b_host
2232 && udev->parent == udev->bus->root_hub) {
2233 struct usb_otg_descriptor *desc = NULL;
2234 struct usb_bus *bus = udev->bus;
2236 /* descriptor may appear anywhere in config */
2237 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2238 le16_to_cpu(udev->config[0].desc.wTotalLength),
2239 USB_DT_OTG, (void **) &desc) == 0) {
2240 if (desc->bmAttributes & USB_OTG_HNP) {
2241 unsigned port1 = udev->portnum;
2243 dev_info(&udev->dev,
2244 "Dual-Role OTG device on %sHNP port\n",
2245 (port1 == bus->otg_port)
2248 /* enable HNP before suspend, it's simpler */
2249 if (port1 == bus->otg_port)
2250 bus->b_hnp_enable = 1;
2251 err = usb_control_msg(udev,
2252 usb_sndctrlpipe(udev, 0),
2253 USB_REQ_SET_FEATURE, 0,
2255 ? USB_DEVICE_B_HNP_ENABLE
2256 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2257 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2259 /* OTG MESSAGE: report errors here,
2260 * customize to match your product.
2262 dev_info(&udev->dev,
2263 "can't set HNP mode: %d\n",
2265 bus->b_hnp_enable = 0;
2271 if (!is_targeted(udev)) {
2273 /* Maybe it can talk to us, though we can't talk to it.
2274 * (Includes HNP test device.)
2276 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2277 err = usb_port_suspend(udev, PMSG_SUSPEND);
2279 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2291 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2292 * @udev: newly addressed device (in ADDRESS state)
2294 * This is only called by usb_new_device() and usb_authorize_device()
2295 * and FIXME -- all comments that apply to them apply here wrt to
2298 * If the device is WUSB and not authorized, we don't attempt to read
2299 * the string descriptors, as they will be errored out by the device
2300 * until it has been authorized.
2302 * Return: 0 if successful. A negative error code otherwise.
2304 static int usb_enumerate_device(struct usb_device *udev)
2308 if (udev->config == NULL) {
2309 err = usb_get_configuration(udev);
2312 dev_err(&udev->dev, "can't read configurations, error %d\n",
2318 /* read the standard strings and cache them if present */
2319 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2320 udev->manufacturer = usb_cache_string(udev,
2321 udev->descriptor.iManufacturer);
2322 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2324 err = usb_enumerate_device_otg(udev);
2328 usb_detect_interface_quirks(udev);
2333 static void set_usb_port_removable(struct usb_device *udev)
2335 struct usb_device *hdev = udev->parent;
2336 struct usb_hub *hub;
2337 u8 port = udev->portnum;
2338 u16 wHubCharacteristics;
2339 bool removable = true;
2344 hub = usb_hub_to_struct_hub(udev->parent);
2346 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2348 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2351 if (hub_is_superspeed(hdev)) {
2352 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2356 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2361 udev->removable = USB_DEVICE_REMOVABLE;
2363 udev->removable = USB_DEVICE_FIXED;
2366 * Platform firmware may have populated an alternative value for
2367 * removable. If the parent port has a known connect_type use
2370 switch (hub->ports[udev->portnum - 1]->connect_type) {
2371 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2372 udev->removable = USB_DEVICE_REMOVABLE;
2374 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2375 udev->removable = USB_DEVICE_FIXED;
2377 default: /* use what was set above */
2383 * usb_new_device - perform initial device setup (usbcore-internal)
2384 * @udev: newly addressed device (in ADDRESS state)
2386 * This is called with devices which have been detected but not fully
2387 * enumerated. The device descriptor is available, but not descriptors
2388 * for any device configuration. The caller must have locked either
2389 * the parent hub (if udev is a normal device) or else the
2390 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2391 * udev has already been installed, but udev is not yet visible through
2392 * sysfs or other filesystem code.
2394 * This call is synchronous, and may not be used in an interrupt context.
2396 * Only the hub driver or root-hub registrar should ever call this.
2398 * Return: Whether the device is configured properly or not. Zero if the
2399 * interface was registered with the driver core; else a negative errno
2403 int usb_new_device(struct usb_device *udev)
2408 /* Initialize non-root-hub device wakeup to disabled;
2409 * device (un)configuration controls wakeup capable
2410 * sysfs power/wakeup controls wakeup enabled/disabled
2412 device_init_wakeup(&udev->dev, 0);
2415 /* Tell the runtime-PM framework the device is active */
2416 pm_runtime_set_active(&udev->dev);
2417 pm_runtime_get_noresume(&udev->dev);
2418 pm_runtime_use_autosuspend(&udev->dev);
2419 pm_runtime_enable(&udev->dev);
2421 /* By default, forbid autosuspend for all devices. It will be
2422 * allowed for hubs during binding.
2424 usb_disable_autosuspend(udev);
2426 err = usb_enumerate_device(udev); /* Read descriptors */
2429 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2430 udev->devnum, udev->bus->busnum,
2431 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2432 /* export the usbdev device-node for libusb */
2433 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2434 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2436 /* Tell the world! */
2437 announce_device(udev);
2440 add_device_randomness(udev->serial, strlen(udev->serial));
2442 add_device_randomness(udev->product, strlen(udev->product));
2443 if (udev->manufacturer)
2444 add_device_randomness(udev->manufacturer,
2445 strlen(udev->manufacturer));
2447 device_enable_async_suspend(&udev->dev);
2449 /* check whether the hub or firmware marks this port as non-removable */
2451 set_usb_port_removable(udev);
2453 /* Register the device. The device driver is responsible
2454 * for configuring the device and invoking the add-device
2455 * notifier chain (used by usbfs and possibly others).
2457 err = device_add(&udev->dev);
2459 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2463 /* Create link files between child device and usb port device. */
2465 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2466 int port1 = udev->portnum;
2467 struct usb_port *port_dev = hub->ports[port1 - 1];
2469 err = sysfs_create_link(&udev->dev.kobj,
2470 &port_dev->dev.kobj, "port");
2474 err = sysfs_create_link(&port_dev->dev.kobj,
2475 &udev->dev.kobj, "device");
2477 sysfs_remove_link(&udev->dev.kobj, "port");
2481 if (!test_and_set_bit(port1, hub->child_usage_bits))
2482 pm_runtime_get_sync(&port_dev->dev);
2485 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2486 usb_mark_last_busy(udev);
2487 pm_runtime_put_sync_autosuspend(&udev->dev);
2491 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2492 pm_runtime_disable(&udev->dev);
2493 pm_runtime_set_suspended(&udev->dev);
2499 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2500 * @usb_dev: USB device
2502 * Move the USB device to a very basic state where interfaces are disabled
2503 * and the device is in fact unconfigured and unusable.
2505 * We share a lock (that we have) with device_del(), so we need to
2510 int usb_deauthorize_device(struct usb_device *usb_dev)
2512 usb_lock_device(usb_dev);
2513 if (usb_dev->authorized == 0)
2514 goto out_unauthorized;
2516 usb_dev->authorized = 0;
2517 usb_set_configuration(usb_dev, -1);
2520 usb_unlock_device(usb_dev);
2525 int usb_authorize_device(struct usb_device *usb_dev)
2529 usb_lock_device(usb_dev);
2530 if (usb_dev->authorized == 1)
2531 goto out_authorized;
2533 result = usb_autoresume_device(usb_dev);
2535 dev_err(&usb_dev->dev,
2536 "can't autoresume for authorization: %d\n", result);
2537 goto error_autoresume;
2539 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2541 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2542 "authorization: %d\n", result);
2543 goto error_device_descriptor;
2546 usb_dev->authorized = 1;
2547 /* Choose and set the configuration. This registers the interfaces
2548 * with the driver core and lets interface drivers bind to them.
2550 c = usb_choose_configuration(usb_dev);
2552 result = usb_set_configuration(usb_dev, c);
2554 dev_err(&usb_dev->dev,
2555 "can't set config #%d, error %d\n", c, result);
2556 /* This need not be fatal. The user can try to
2557 * set other configurations. */
2560 dev_info(&usb_dev->dev, "authorized to connect\n");
2562 error_device_descriptor:
2563 usb_autosuspend_device(usb_dev);
2566 usb_unlock_device(usb_dev); /* complements locktree */
2571 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2572 static unsigned hub_is_wusb(struct usb_hub *hub)
2574 struct usb_hcd *hcd;
2575 if (hub->hdev->parent != NULL) /* not a root hub? */
2577 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2578 return hcd->wireless;
2582 #define PORT_RESET_TRIES 5
2583 #define SET_ADDRESS_TRIES 2
2584 #define GET_DESCRIPTOR_TRIES 2
2585 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2586 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2588 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2589 #define HUB_SHORT_RESET_TIME 10
2590 #define HUB_BH_RESET_TIME 50
2591 #define HUB_LONG_RESET_TIME 200
2592 #define HUB_RESET_TIMEOUT 800
2595 * "New scheme" enumeration causes an extra state transition to be
2596 * exposed to an xhci host and causes USB3 devices to receive control
2597 * commands in the default state. This has been seen to cause
2598 * enumeration failures, so disable this enumeration scheme for USB3
2601 static bool use_new_scheme(struct usb_device *udev, int retry)
2603 if (udev->speed == USB_SPEED_SUPER)
2606 return USE_NEW_SCHEME(retry);
2609 static int hub_port_reset(struct usb_hub *hub, int port1,
2610 struct usb_device *udev, unsigned int delay, bool warm);
2612 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2613 * Port worm reset is required to recover
2615 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2620 if (!hub_is_superspeed(hub->hdev))
2623 if (test_bit(port1, hub->warm_reset_bits))
2626 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2627 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2628 || link_state == USB_SS_PORT_LS_COMP_MOD;
2631 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2632 struct usb_device *udev, unsigned int delay, bool warm)
2634 int delay_time, ret;
2638 for (delay_time = 0;
2639 delay_time < HUB_RESET_TIMEOUT;
2640 delay_time += delay) {
2641 /* wait to give the device a chance to reset */
2644 /* read and decode port status */
2645 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2649 /* The port state is unknown until the reset completes. */
2650 if (!(portstatus & USB_PORT_STAT_RESET))
2653 /* switch to the long delay after two short delay failures */
2654 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2655 delay = HUB_LONG_RESET_TIME;
2657 dev_dbg(&hub->ports[port1 - 1]->dev,
2658 "not %sreset yet, waiting %dms\n",
2659 warm ? "warm " : "", delay);
2662 if ((portstatus & USB_PORT_STAT_RESET))
2665 if (hub_port_warm_reset_required(hub, port1, portstatus))
2668 /* Device went away? */
2669 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2672 /* bomb out completely if the connection bounced. A USB 3.0
2673 * connection may bounce if multiple warm resets were issued,
2674 * but the device may have successfully re-connected. Ignore it.
2676 if (!hub_is_superspeed(hub->hdev) &&
2677 (portchange & USB_PORT_STAT_C_CONNECTION))
2680 if (!(portstatus & USB_PORT_STAT_ENABLE))
2686 if (hub_is_wusb(hub))
2687 udev->speed = USB_SPEED_WIRELESS;
2688 else if (hub_is_superspeed(hub->hdev))
2689 udev->speed = USB_SPEED_SUPER;
2690 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2691 udev->speed = USB_SPEED_HIGH;
2692 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2693 udev->speed = USB_SPEED_LOW;
2695 udev->speed = USB_SPEED_FULL;
2699 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2700 struct usb_device *udev, int *status)
2704 /* TRSTRCY = 10 ms; plus some extra */
2707 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2709 update_devnum(udev, 0);
2710 /* The xHC may think the device is already reset,
2711 * so ignore the status.
2713 if (hcd->driver->reset_device)
2714 hcd->driver->reset_device(hcd, udev);
2719 usb_clear_port_feature(hub->hdev,
2720 port1, USB_PORT_FEAT_C_RESET);
2721 if (hub_is_superspeed(hub->hdev)) {
2722 usb_clear_port_feature(hub->hdev, port1,
2723 USB_PORT_FEAT_C_BH_PORT_RESET);
2724 usb_clear_port_feature(hub->hdev, port1,
2725 USB_PORT_FEAT_C_PORT_LINK_STATE);
2726 usb_clear_port_feature(hub->hdev, port1,
2727 USB_PORT_FEAT_C_CONNECTION);
2730 usb_set_device_state(udev, *status
2731 ? USB_STATE_NOTATTACHED
2732 : USB_STATE_DEFAULT);
2737 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2738 static int hub_port_reset(struct usb_hub *hub, int port1,
2739 struct usb_device *udev, unsigned int delay, bool warm)
2742 u16 portchange, portstatus;
2743 struct usb_port *port_dev = hub->ports[port1 - 1];
2745 if (!hub_is_superspeed(hub->hdev)) {
2747 dev_err(hub->intfdev, "only USB3 hub support "
2751 /* Block EHCI CF initialization during the port reset.
2752 * Some companion controllers don't like it when they mix.
2754 down_read(&ehci_cf_port_reset_rwsem);
2757 * If the caller hasn't explicitly requested a warm reset,
2758 * double check and see if one is needed.
2760 status = hub_port_status(hub, port1,
2761 &portstatus, &portchange);
2765 if (hub_port_warm_reset_required(hub, port1, portstatus))
2768 clear_bit(port1, hub->warm_reset_bits);
2770 /* Reset the port */
2771 for (i = 0; i < PORT_RESET_TRIES; i++) {
2772 status = set_port_feature(hub->hdev, port1, (warm ?
2773 USB_PORT_FEAT_BH_PORT_RESET :
2774 USB_PORT_FEAT_RESET));
2775 if (status == -ENODEV) {
2776 ; /* The hub is gone */
2777 } else if (status) {
2778 dev_err(&port_dev->dev,
2779 "cannot %sreset (err = %d)\n",
2780 warm ? "warm " : "", status);
2782 status = hub_port_wait_reset(hub, port1, udev, delay,
2784 if (status && status != -ENOTCONN && status != -ENODEV)
2785 dev_dbg(hub->intfdev,
2786 "port_wait_reset: err = %d\n",
2790 /* Check for disconnect or reset */
2791 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2792 hub_port_finish_reset(hub, port1, udev, &status);
2794 if (!hub_is_superspeed(hub->hdev))
2798 * If a USB 3.0 device migrates from reset to an error
2799 * state, re-issue the warm reset.
2801 if (hub_port_status(hub, port1,
2802 &portstatus, &portchange) < 0)
2805 if (!hub_port_warm_reset_required(hub, port1,
2810 * If the port is in SS.Inactive or Compliance Mode, the
2811 * hot or warm reset failed. Try another warm reset.
2814 dev_dbg(&port_dev->dev,
2815 "hot reset failed, warm reset\n");
2820 dev_dbg(&port_dev->dev,
2821 "not enabled, trying %sreset again...\n",
2822 warm ? "warm " : "");
2823 delay = HUB_LONG_RESET_TIME;
2826 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2829 if (!hub_is_superspeed(hub->hdev))
2830 up_read(&ehci_cf_port_reset_rwsem);
2835 /* Check if a port is power on */
2836 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2840 if (hub_is_superspeed(hub->hdev)) {
2841 if (portstatus & USB_SS_PORT_STAT_POWER)
2844 if (portstatus & USB_PORT_STAT_POWER)
2851 static void usb_lock_port(struct usb_port *port_dev)
2852 __acquires(&port_dev->status_lock)
2854 mutex_lock(&port_dev->status_lock);
2855 __acquire(&port_dev->status_lock);
2858 static void usb_unlock_port(struct usb_port *port_dev)
2859 __releases(&port_dev->status_lock)
2861 mutex_unlock(&port_dev->status_lock);
2862 __release(&port_dev->status_lock);
2867 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2868 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2872 if (hub_is_superspeed(hub->hdev)) {
2873 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2874 == USB_SS_PORT_LS_U3)
2877 if (portstatus & USB_PORT_STAT_SUSPEND)
2884 /* Determine whether the device on a port is ready for a normal resume,
2885 * is ready for a reset-resume, or should be disconnected.
2887 static int check_port_resume_type(struct usb_device *udev,
2888 struct usb_hub *hub, int port1,
2889 int status, unsigned portchange, unsigned portstatus)
2891 struct usb_port *port_dev = hub->ports[port1 - 1];
2893 /* Is a warm reset needed to recover the connection? */
2894 if (status == 0 && udev->reset_resume
2895 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2898 /* Is the device still present? */
2899 else if (status || port_is_suspended(hub, portstatus) ||
2900 !port_is_power_on(hub, portstatus) ||
2901 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2906 /* Can't do a normal resume if the port isn't enabled,
2907 * so try a reset-resume instead.
2909 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2910 if (udev->persist_enabled)
2911 udev->reset_resume = 1;
2917 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2918 portchange, portstatus, status);
2919 } else if (udev->reset_resume) {
2921 /* Late port handoff can set status-change bits */
2922 if (portchange & USB_PORT_STAT_C_CONNECTION)
2923 usb_clear_port_feature(hub->hdev, port1,
2924 USB_PORT_FEAT_C_CONNECTION);
2925 if (portchange & USB_PORT_STAT_C_ENABLE)
2926 usb_clear_port_feature(hub->hdev, port1,
2927 USB_PORT_FEAT_C_ENABLE);
2933 int usb_disable_ltm(struct usb_device *udev)
2935 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2937 /* Check if the roothub and device supports LTM. */
2938 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2939 !usb_device_supports_ltm(udev))
2942 /* Clear Feature LTM Enable can only be sent if the device is
2945 if (!udev->actconfig)
2948 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2949 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2950 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2951 USB_CTRL_SET_TIMEOUT);
2953 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2955 void usb_enable_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 /* Set Feature LTM Enable can only be sent if the device is
2967 if (!udev->actconfig)
2970 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2971 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2972 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2973 USB_CTRL_SET_TIMEOUT);
2975 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2978 * usb_enable_remote_wakeup - enable remote wakeup for a device
2979 * @udev: target device
2981 * For USB-2 devices: Set the device's remote wakeup feature.
2983 * For USB-3 devices: Assume there's only one function on the device and
2984 * enable remote wake for the first interface. FIXME if the interface
2985 * association descriptor shows there's more than one function.
2987 static int usb_enable_remote_wakeup(struct usb_device *udev)
2989 if (udev->speed < USB_SPEED_SUPER)
2990 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2991 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2992 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2993 USB_CTRL_SET_TIMEOUT);
2995 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2996 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2997 USB_INTRF_FUNC_SUSPEND,
2998 USB_INTRF_FUNC_SUSPEND_RW |
2999 USB_INTRF_FUNC_SUSPEND_LP,
3000 NULL, 0, USB_CTRL_SET_TIMEOUT);
3004 * usb_disable_remote_wakeup - disable remote wakeup for a device
3005 * @udev: target device
3007 * For USB-2 devices: Clear the device's remote wakeup feature.
3009 * For USB-3 devices: Assume there's only one function on the device and
3010 * disable remote wake for the first interface. FIXME if the interface
3011 * association descriptor shows there's more than one function.
3013 static int usb_disable_remote_wakeup(struct usb_device *udev)
3015 if (udev->speed < USB_SPEED_SUPER)
3016 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3017 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3018 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3019 USB_CTRL_SET_TIMEOUT);
3021 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3022 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
3023 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3024 USB_CTRL_SET_TIMEOUT);
3027 /* Count of wakeup-enabled devices at or below udev */
3028 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3030 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3032 return udev->do_remote_wakeup +
3033 (hub ? hub->wakeup_enabled_descendants : 0);
3037 * usb_port_suspend - suspend a usb device's upstream port
3038 * @udev: device that's no longer in active use, not a root hub
3039 * Context: must be able to sleep; device not locked; pm locks held
3041 * Suspends a USB device that isn't in active use, conserving power.
3042 * Devices may wake out of a suspend, if anything important happens,
3043 * using the remote wakeup mechanism. They may also be taken out of
3044 * suspend by the host, using usb_port_resume(). It's also routine
3045 * to disconnect devices while they are suspended.
3047 * This only affects the USB hardware for a device; its interfaces
3048 * (and, for hubs, child devices) must already have been suspended.
3050 * Selective port suspend reduces power; most suspended devices draw
3051 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3052 * All devices below the suspended port are also suspended.
3054 * Devices leave suspend state when the host wakes them up. Some devices
3055 * also support "remote wakeup", where the device can activate the USB
3056 * tree above them to deliver data, such as a keypress or packet. In
3057 * some cases, this wakes the USB host.
3059 * Suspending OTG devices may trigger HNP, if that's been enabled
3060 * between a pair of dual-role devices. That will change roles, such
3061 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3063 * Devices on USB hub ports have only one "suspend" state, corresponding
3064 * to ACPI D2, "may cause the device to lose some context".
3065 * State transitions include:
3067 * - suspend, resume ... when the VBUS power link stays live
3068 * - suspend, disconnect ... VBUS lost
3070 * Once VBUS drop breaks the circuit, the port it's using has to go through
3071 * normal re-enumeration procedures, starting with enabling VBUS power.
3072 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3073 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
3074 * timer, no SRP, no requests through sysfs.
3076 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3077 * suspended until their bus goes into global suspend (i.e., the root
3078 * hub is suspended). Nevertheless, we change @udev->state to
3079 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3080 * upstream port setting is stored in @udev->port_is_suspended.
3082 * Returns 0 on success, else negative errno.
3084 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3086 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3087 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3088 int port1 = udev->portnum;
3090 bool really_suspend = true;
3092 usb_lock_port(port_dev);
3094 /* enable remote wakeup when appropriate; this lets the device
3095 * wake up the upstream hub (including maybe the root hub).
3097 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3098 * we don't explicitly enable it here.
3100 if (udev->do_remote_wakeup) {
3101 status = usb_enable_remote_wakeup(udev);
3103 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3105 /* bail if autosuspend is requested */
3106 if (PMSG_IS_AUTO(msg))
3111 /* disable USB2 hardware LPM */
3112 if (udev->usb2_hw_lpm_enabled == 1)
3113 usb_set_usb2_hardware_lpm(udev, 0);
3115 if (usb_disable_ltm(udev)) {
3116 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3118 if (PMSG_IS_AUTO(msg))
3121 if (usb_unlocked_disable_lpm(udev)) {
3122 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3124 if (PMSG_IS_AUTO(msg))
3129 if (hub_is_superspeed(hub->hdev))
3130 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3133 * For system suspend, we do not need to enable the suspend feature
3134 * on individual USB-2 ports. The devices will automatically go
3135 * into suspend a few ms after the root hub stops sending packets.
3136 * The USB 2.0 spec calls this "global suspend".
3138 * However, many USB hubs have a bug: They don't relay wakeup requests
3139 * from a downstream port if the port's suspend feature isn't on.
3140 * Therefore we will turn on the suspend feature if udev or any of its
3141 * descendants is enabled for remote wakeup.
3143 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3144 status = set_port_feature(hub->hdev, port1,
3145 USB_PORT_FEAT_SUSPEND);
3147 really_suspend = false;
3151 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3153 /* Try to enable USB3 LPM and LTM again */
3154 usb_unlocked_enable_lpm(udev);
3156 usb_enable_ltm(udev);
3158 /* Try to enable USB2 hardware LPM again */
3159 if (udev->usb2_hw_lpm_capable == 1)
3160 usb_set_usb2_hardware_lpm(udev, 1);
3162 if (udev->do_remote_wakeup)
3163 (void) usb_disable_remote_wakeup(udev);
3166 /* System sleep transitions should never fail */
3167 if (!PMSG_IS_AUTO(msg))
3170 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3171 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3172 udev->do_remote_wakeup);
3173 if (really_suspend) {
3174 udev->port_is_suspended = 1;
3176 /* device has up to 10 msec to fully suspend */
3179 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3182 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3183 && test_and_clear_bit(port1, hub->child_usage_bits))
3184 pm_runtime_put_sync(&port_dev->dev);
3186 usb_mark_last_busy(hub->hdev);
3188 usb_unlock_port(port_dev);
3193 * If the USB "suspend" state is in use (rather than "global suspend"),
3194 * many devices will be individually taken out of suspend state using
3195 * special "resume" signaling. This routine kicks in shortly after
3196 * hardware resume signaling is finished, either because of selective
3197 * resume (by host) or remote wakeup (by device) ... now see what changed
3198 * in the tree that's rooted at this device.
3200 * If @udev->reset_resume is set then the device is reset before the
3201 * status check is done.
3203 static int finish_port_resume(struct usb_device *udev)
3208 /* caller owns the udev device lock */
3209 dev_dbg(&udev->dev, "%s\n",
3210 udev->reset_resume ? "finish reset-resume" : "finish resume");
3212 /* usb ch9 identifies four variants of SUSPENDED, based on what
3213 * state the device resumes to. Linux currently won't see the
3214 * first two on the host side; they'd be inside hub_port_init()
3215 * during many timeouts, but khubd can't suspend until later.
3217 usb_set_device_state(udev, udev->actconfig
3218 ? USB_STATE_CONFIGURED
3219 : USB_STATE_ADDRESS);
3221 /* 10.5.4.5 says not to reset a suspended port if the attached
3222 * device is enabled for remote wakeup. Hence the reset
3223 * operation is carried out here, after the port has been
3226 if (udev->reset_resume) {
3228 * If the device morphs or switches modes when it is reset,
3229 * we don't want to perform a reset-resume. We'll fail the
3230 * resume, which will cause a logical disconnect, and then
3231 * the device will be rediscovered.
3234 if (udev->quirks & USB_QUIRK_RESET)
3237 status = usb_reset_and_verify_device(udev);
3240 /* 10.5.4.5 says be sure devices in the tree are still there.
3241 * For now let's assume the device didn't go crazy on resume,
3242 * and device drivers will know about any resume quirks.
3246 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3248 /* If a normal resume failed, try doing a reset-resume */
3249 if (status && !udev->reset_resume && udev->persist_enabled) {
3250 dev_dbg(&udev->dev, "retry with reset-resume\n");
3251 udev->reset_resume = 1;
3252 goto retry_reset_resume;
3257 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3260 * There are a few quirky devices which violate the standard
3261 * by claiming to have remote wakeup enabled after a reset,
3262 * which crash if the feature is cleared, hence check for
3263 * udev->reset_resume
3265 } else if (udev->actconfig && !udev->reset_resume) {
3266 if (udev->speed < USB_SPEED_SUPER) {
3267 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3268 status = usb_disable_remote_wakeup(udev);
3270 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3272 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3273 | USB_INTRF_STAT_FUNC_RW))
3274 status = usb_disable_remote_wakeup(udev);
3279 "disable remote wakeup, status %d\n",
3287 * There are some SS USB devices which take longer time for link training.
3288 * XHCI specs 4.19.4 says that when Link training is successful, port
3289 * sets CSC bit to 1. So if SW reads port status before successful link
3290 * training, then it will not find device to be present.
3291 * USB Analyzer log with such buggy devices show that in some cases
3292 * device switch on the RX termination after long delay of host enabling
3293 * the VBUS. In few other cases it has been seen that device fails to
3294 * negotiate link training in first attempt. It has been
3295 * reported till now that few devices take as long as 2000 ms to train
3296 * the link after host enabling its VBUS and termination. Following
3297 * routine implements a 2000 ms timeout for link training. If in a case
3298 * link trains before timeout, loop will exit earlier.
3300 * FIXME: If a device was connected before suspend, but was removed
3301 * while system was asleep, then the loop in the following routine will
3302 * only exit at timeout.
3304 * This routine should only be called when persist is enabled for a SS
3307 static int wait_for_ss_port_enable(struct usb_device *udev,
3308 struct usb_hub *hub, int *port1,
3309 u16 *portchange, u16 *portstatus)
3311 int status = 0, delay_ms = 0;
3313 while (delay_ms < 2000) {
3314 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3318 status = hub_port_status(hub, *port1, portstatus, portchange);
3324 * usb_port_resume - re-activate a suspended usb device's upstream port
3325 * @udev: device to re-activate, not a root hub
3326 * Context: must be able to sleep; device not locked; pm locks held
3328 * This will re-activate the suspended device, increasing power usage
3329 * while letting drivers communicate again with its endpoints.
3330 * USB resume explicitly guarantees that the power session between
3331 * the host and the device is the same as it was when the device
3334 * If @udev->reset_resume is set then this routine won't check that the
3335 * port is still enabled. Furthermore, finish_port_resume() above will
3336 * reset @udev. The end result is that a broken power session can be
3337 * recovered and @udev will appear to persist across a loss of VBUS power.
3339 * For example, if a host controller doesn't maintain VBUS suspend current
3340 * during a system sleep or is reset when the system wakes up, all the USB
3341 * power sessions below it will be broken. This is especially troublesome
3342 * for mass-storage devices containing mounted filesystems, since the
3343 * device will appear to have disconnected and all the memory mappings
3344 * to it will be lost. Using the USB_PERSIST facility, the device can be
3345 * made to appear as if it had not disconnected.
3347 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3348 * every effort to insure that the same device is present after the
3349 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3350 * quite possible for a device to remain unaltered but its media to be
3351 * changed. If the user replaces a flash memory card while the system is
3352 * asleep, he will have only himself to blame when the filesystem on the
3353 * new card is corrupted and the system crashes.
3355 * Returns 0 on success, else negative errno.
3357 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3359 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3360 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3361 int port1 = udev->portnum;
3363 u16 portchange, portstatus;
3365 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3366 status = pm_runtime_get_sync(&port_dev->dev);
3368 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3374 usb_lock_port(port_dev);
3376 /* Skip the initial Clear-Suspend step for a remote wakeup */
3377 status = hub_port_status(hub, port1, &portstatus, &portchange);
3378 if (status == 0 && !port_is_suspended(hub, portstatus))
3379 goto SuspendCleared;
3381 /* see 7.1.7.7; affects power usage, but not budgeting */
3382 if (hub_is_superspeed(hub->hdev))
3383 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3385 status = usb_clear_port_feature(hub->hdev,
3386 port1, USB_PORT_FEAT_SUSPEND);
3388 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3390 /* drive resume for at least 20 msec */
3391 dev_dbg(&udev->dev, "usb %sresume\n",
3392 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3395 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3396 * stop resume signaling. Then finish the resume
3399 status = hub_port_status(hub, port1, &portstatus, &portchange);
3401 /* TRSMRCY = 10 msec */
3407 udev->port_is_suspended = 0;
3408 if (hub_is_superspeed(hub->hdev)) {
3409 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3410 usb_clear_port_feature(hub->hdev, port1,
3411 USB_PORT_FEAT_C_PORT_LINK_STATE);
3413 if (portchange & USB_PORT_STAT_C_SUSPEND)
3414 usb_clear_port_feature(hub->hdev, port1,
3415 USB_PORT_FEAT_C_SUSPEND);
3419 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3420 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3423 status = check_port_resume_type(udev,
3424 hub, port1, status, portchange, portstatus);
3426 status = finish_port_resume(udev);
3428 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3429 hub_port_logical_disconnect(hub, port1);
3431 /* Try to enable USB2 hardware LPM */
3432 if (udev->usb2_hw_lpm_capable == 1)
3433 usb_set_usb2_hardware_lpm(udev, 1);
3435 /* Try to enable USB3 LTM and LPM */
3436 usb_enable_ltm(udev);
3437 usb_unlocked_enable_lpm(udev);
3440 usb_unlock_port(port_dev);
3445 #ifdef CONFIG_PM_RUNTIME
3447 int usb_remote_wakeup(struct usb_device *udev)
3451 usb_lock_device(udev);
3452 if (udev->state == USB_STATE_SUSPENDED) {
3453 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3454 status = usb_autoresume_device(udev);
3456 /* Let the drivers do their thing, then... */
3457 usb_autosuspend_device(udev);
3460 usb_unlock_device(udev);
3464 /* Returns 1 if there was a remote wakeup and a connect status change. */
3465 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3466 u16 portstatus, u16 portchange)
3467 __must_hold(&port_dev->status_lock)
3469 struct usb_port *port_dev = hub->ports[port - 1];
3470 struct usb_device *hdev;
3471 struct usb_device *udev;
3472 int connect_change = 0;
3476 udev = port_dev->child;
3477 if (!hub_is_superspeed(hdev)) {
3478 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3480 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3482 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3483 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3489 /* TRSMRCY = 10 msec */
3492 usb_unlock_port(port_dev);
3493 ret = usb_remote_wakeup(udev);
3494 usb_lock_port(port_dev);
3499 hub_port_disable(hub, port, 1);
3501 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3502 return connect_change;
3507 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3508 u16 portstatus, u16 portchange)
3515 static int check_ports_changed(struct usb_hub *hub)
3519 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3520 u16 portstatus, portchange;
3523 status = hub_port_status(hub, port1, &portstatus, &portchange);
3524 if (!status && portchange)
3530 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3532 struct usb_hub *hub = usb_get_intfdata (intf);
3533 struct usb_device *hdev = hub->hdev;
3538 * Warn if children aren't already suspended.
3539 * Also, add up the number of wakeup-enabled descendants.
3541 hub->wakeup_enabled_descendants = 0;
3542 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3543 struct usb_port *port_dev = hub->ports[port1 - 1];
3544 struct usb_device *udev = port_dev->child;
3546 if (udev && udev->can_submit) {
3547 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3548 dev_name(&udev->dev));
3549 if (PMSG_IS_AUTO(msg))
3553 hub->wakeup_enabled_descendants +=
3554 wakeup_enabled_descendants(udev);
3557 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3558 /* check if there are changes pending on hub ports */
3559 if (check_ports_changed(hub)) {
3560 if (PMSG_IS_AUTO(msg))
3562 pm_wakeup_event(&hdev->dev, 2000);
3566 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3567 /* Enable hub to send remote wakeup for all ports. */
3568 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3569 status = set_port_feature(hdev,
3571 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3572 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3573 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3574 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3578 dev_dbg(&intf->dev, "%s\n", __func__);
3580 /* stop khubd and related activity */
3581 hub_quiesce(hub, HUB_SUSPEND);
3585 static int hub_resume(struct usb_interface *intf)
3587 struct usb_hub *hub = usb_get_intfdata(intf);
3589 dev_dbg(&intf->dev, "%s\n", __func__);
3590 hub_activate(hub, HUB_RESUME);
3594 static int hub_reset_resume(struct usb_interface *intf)
3596 struct usb_hub *hub = usb_get_intfdata(intf);
3598 dev_dbg(&intf->dev, "%s\n", __func__);
3599 hub_activate(hub, HUB_RESET_RESUME);
3604 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3605 * @rhdev: struct usb_device for the root hub
3607 * The USB host controller driver calls this function when its root hub
3608 * is resumed and Vbus power has been interrupted or the controller
3609 * has been reset. The routine marks @rhdev as having lost power.
3610 * When the hub driver is resumed it will take notice and carry out
3611 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3612 * the others will be disconnected.
3614 void usb_root_hub_lost_power(struct usb_device *rhdev)
3616 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3617 rhdev->reset_resume = 1;
3619 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3621 static const char * const usb3_lpm_names[] = {
3629 * Send a Set SEL control transfer to the device, prior to enabling
3630 * device-initiated U1 or U2. This lets the device know the exit latencies from
3631 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3632 * packet from the host.
3634 * This function will fail if the SEL or PEL values for udev are greater than
3635 * the maximum allowed values for the link state to be enabled.
3637 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3639 struct usb_set_sel_req *sel_values;
3640 unsigned long long u1_sel;
3641 unsigned long long u1_pel;
3642 unsigned long long u2_sel;
3643 unsigned long long u2_pel;
3646 if (udev->state != USB_STATE_CONFIGURED)
3649 /* Convert SEL and PEL stored in ns to us */
3650 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3651 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3652 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3653 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3656 * Make sure that the calculated SEL and PEL values for the link
3657 * state we're enabling aren't bigger than the max SEL/PEL
3658 * value that will fit in the SET SEL control transfer.
3659 * Otherwise the device would get an incorrect idea of the exit
3660 * latency for the link state, and could start a device-initiated
3661 * U1/U2 when the exit latencies are too high.
3663 if ((state == USB3_LPM_U1 &&
3664 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3665 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3666 (state == USB3_LPM_U2 &&
3667 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3668 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3669 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3670 usb3_lpm_names[state], u1_sel, u1_pel);
3675 * If we're enabling device-initiated LPM for one link state,
3676 * but the other link state has a too high SEL or PEL value,
3677 * just set those values to the max in the Set SEL request.
3679 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3680 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3682 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3683 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3685 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3686 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3688 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3689 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3692 * usb_enable_lpm() can be called as part of a failed device reset,
3693 * which may be initiated by an error path of a mass storage driver.
3694 * Therefore, use GFP_NOIO.
3696 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3700 sel_values->u1_sel = u1_sel;
3701 sel_values->u1_pel = u1_pel;
3702 sel_values->u2_sel = cpu_to_le16(u2_sel);
3703 sel_values->u2_pel = cpu_to_le16(u2_pel);
3705 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3709 sel_values, sizeof *(sel_values),
3710 USB_CTRL_SET_TIMEOUT);
3716 * Enable or disable device-initiated U1 or U2 transitions.
3718 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3719 enum usb3_link_state state, bool enable)
3726 feature = USB_DEVICE_U1_ENABLE;
3729 feature = USB_DEVICE_U2_ENABLE;
3732 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3733 __func__, enable ? "enable" : "disable");
3737 if (udev->state != USB_STATE_CONFIGURED) {
3738 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3739 "for unconfigured device.\n",
3740 __func__, enable ? "enable" : "disable",
3741 usb3_lpm_names[state]);
3747 * Now send the control transfer to enable device-initiated LPM
3748 * for either U1 or U2.
3750 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3751 USB_REQ_SET_FEATURE,
3755 USB_CTRL_SET_TIMEOUT);
3757 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3758 USB_REQ_CLEAR_FEATURE,
3762 USB_CTRL_SET_TIMEOUT);
3765 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3766 enable ? "Enable" : "Disable",
3767 usb3_lpm_names[state]);
3773 static int usb_set_lpm_timeout(struct usb_device *udev,
3774 enum usb3_link_state state, int timeout)
3781 feature = USB_PORT_FEAT_U1_TIMEOUT;
3784 feature = USB_PORT_FEAT_U2_TIMEOUT;
3787 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3792 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3793 timeout != USB3_LPM_DEVICE_INITIATED) {
3794 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3795 "which is a reserved value.\n",
3796 usb3_lpm_names[state], timeout);
3800 ret = set_port_feature(udev->parent,
3801 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3804 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3805 "error code %i\n", usb3_lpm_names[state],
3809 if (state == USB3_LPM_U1)
3810 udev->u1_params.timeout = timeout;
3812 udev->u2_params.timeout = timeout;
3817 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3820 * We will attempt to enable U1 or U2, but there are no guarantees that the
3821 * control transfers to set the hub timeout or enable device-initiated U1/U2
3822 * will be successful.
3824 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3825 * driver know about it. If that call fails, it should be harmless, and just
3826 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3828 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3829 enum usb3_link_state state)
3832 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3833 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3835 /* If the device says it doesn't have *any* exit latency to come out of
3836 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3839 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3840 (state == USB3_LPM_U2 && u2_mel == 0))
3844 * First, let the device know about the exit latencies
3845 * associated with the link state we're about to enable.
3847 ret = usb_req_set_sel(udev, state);
3849 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3850 usb3_lpm_names[state]);
3854 /* We allow the host controller to set the U1/U2 timeout internally
3855 * first, so that it can change its schedule to account for the
3856 * additional latency to send data to a device in a lower power
3859 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3861 /* xHCI host controller doesn't want to enable this LPM state. */
3866 dev_warn(&udev->dev, "Could not enable %s link state, "
3867 "xHCI error %i.\n", usb3_lpm_names[state],
3872 if (usb_set_lpm_timeout(udev, state, timeout))
3873 /* If we can't set the parent hub U1/U2 timeout,
3874 * device-initiated LPM won't be allowed either, so let the xHCI
3875 * host know that this link state won't be enabled.
3877 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3879 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3880 else if (udev->actconfig)
3881 usb_set_device_initiated_lpm(udev, state, true);
3886 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3889 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3890 * If zero is returned, the parent will not allow the link to go into U1/U2.
3892 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3893 * it won't have an effect on the bus link state because the parent hub will
3894 * still disallow device-initiated U1/U2 entry.
3896 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3897 * possible. The result will be slightly more bus bandwidth will be taken up
3898 * (to account for U1/U2 exit latency), but it should be harmless.
3900 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3901 enum usb3_link_state state)
3907 feature = USB_PORT_FEAT_U1_TIMEOUT;
3910 feature = USB_PORT_FEAT_U2_TIMEOUT;
3913 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3918 if (usb_set_lpm_timeout(udev, state, 0))
3921 usb_set_device_initiated_lpm(udev, state, false);
3923 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3924 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3925 "bus schedule bandwidth may be impacted.\n",
3926 usb3_lpm_names[state]);
3931 * Disable hub-initiated and device-initiated U1 and U2 entry.
3932 * Caller must own the bandwidth_mutex.
3934 * This will call usb_enable_lpm() on failure, which will decrement
3935 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3937 int usb_disable_lpm(struct usb_device *udev)
3939 struct usb_hcd *hcd;
3941 if (!udev || !udev->parent ||
3942 udev->speed != USB_SPEED_SUPER ||
3943 !udev->lpm_capable ||
3944 udev->state < USB_STATE_DEFAULT)
3947 hcd = bus_to_hcd(udev->bus);
3948 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3951 udev->lpm_disable_count++;
3952 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3955 /* If LPM is enabled, attempt to disable it. */
3956 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3958 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3964 usb_enable_lpm(udev);
3967 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3969 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3970 int usb_unlocked_disable_lpm(struct usb_device *udev)
3972 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3978 mutex_lock(hcd->bandwidth_mutex);
3979 ret = usb_disable_lpm(udev);
3980 mutex_unlock(hcd->bandwidth_mutex);
3984 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3987 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3988 * xHCI host policy may prevent U1 or U2 from being enabled.
3990 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3991 * until the lpm_disable_count drops to zero. Caller must own the
3994 void usb_enable_lpm(struct usb_device *udev)
3996 struct usb_hcd *hcd;
3998 if (!udev || !udev->parent ||
3999 udev->speed != USB_SPEED_SUPER ||
4000 !udev->lpm_capable ||
4001 udev->state < USB_STATE_DEFAULT)
4004 udev->lpm_disable_count--;
4005 hcd = bus_to_hcd(udev->bus);
4006 /* Double check that we can both enable and disable LPM.
4007 * Device must be configured to accept set feature U1/U2 timeout.
4009 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4010 !hcd->driver->disable_usb3_lpm_timeout)
4013 if (udev->lpm_disable_count > 0)
4016 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4017 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4019 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4021 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4022 void usb_unlocked_enable_lpm(struct usb_device *udev)
4024 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4029 mutex_lock(hcd->bandwidth_mutex);
4030 usb_enable_lpm(udev);
4031 mutex_unlock(hcd->bandwidth_mutex);
4033 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4036 #else /* CONFIG_PM */
4038 #define hub_suspend NULL
4039 #define hub_resume NULL
4040 #define hub_reset_resume NULL
4042 int usb_disable_lpm(struct usb_device *udev)
4046 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4048 void usb_enable_lpm(struct usb_device *udev) { }
4049 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4051 int usb_unlocked_disable_lpm(struct usb_device *udev)
4055 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4057 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4058 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4060 int usb_disable_ltm(struct usb_device *udev)
4064 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4066 void usb_enable_ltm(struct usb_device *udev) { }
4067 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4069 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4070 u16 portstatus, u16 portchange)
4075 #endif /* CONFIG_PM */
4078 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4080 * Between connect detection and reset signaling there must be a delay
4081 * of 100ms at least for debounce and power-settling. The corresponding
4082 * timer shall restart whenever the downstream port detects a disconnect.
4084 * Apparently there are some bluetooth and irda-dongles and a number of
4085 * low-speed devices for which this debounce period may last over a second.
4086 * Not covered by the spec - but easy to deal with.
4088 * This implementation uses a 1500ms total debounce timeout; if the
4089 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4090 * every 25ms for transient disconnects. When the port status has been
4091 * unchanged for 100ms it returns the port status.
4093 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4096 u16 portchange, portstatus;
4097 unsigned connection = 0xffff;
4098 int total_time, stable_time = 0;
4099 struct usb_port *port_dev = hub->ports[port1 - 1];
4101 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4102 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4106 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4107 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4108 if (!must_be_connected ||
4109 (connection == USB_PORT_STAT_CONNECTION))
4110 stable_time += HUB_DEBOUNCE_STEP;
4111 if (stable_time >= HUB_DEBOUNCE_STABLE)
4115 connection = portstatus & USB_PORT_STAT_CONNECTION;
4118 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4119 usb_clear_port_feature(hub->hdev, port1,
4120 USB_PORT_FEAT_C_CONNECTION);
4123 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4125 msleep(HUB_DEBOUNCE_STEP);
4128 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4129 total_time, stable_time, portstatus);
4131 if (stable_time < HUB_DEBOUNCE_STABLE)
4136 void usb_ep0_reinit(struct usb_device *udev)
4138 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4139 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4140 usb_enable_endpoint(udev, &udev->ep0, true);
4142 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4144 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4145 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4147 static int hub_set_address(struct usb_device *udev, int devnum)
4150 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4153 * The host controller will choose the device address,
4154 * instead of the core having chosen it earlier
4156 if (!hcd->driver->address_device && devnum <= 1)
4158 if (udev->state == USB_STATE_ADDRESS)
4160 if (udev->state != USB_STATE_DEFAULT)
4162 if (hcd->driver->address_device)
4163 retval = hcd->driver->address_device(hcd, udev);
4165 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4166 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4167 NULL, 0, USB_CTRL_SET_TIMEOUT);
4169 update_devnum(udev, devnum);
4170 /* Device now using proper address. */
4171 usb_set_device_state(udev, USB_STATE_ADDRESS);
4172 usb_ep0_reinit(udev);
4178 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4179 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4182 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4183 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4184 * support bit in the BOS descriptor.
4186 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4188 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4189 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4191 if (!udev->usb2_hw_lpm_capable)
4195 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4197 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4198 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4199 udev->usb2_hw_lpm_allowed = 1;
4200 usb_set_usb2_hardware_lpm(udev, 1);
4204 static int hub_enable_device(struct usb_device *udev)
4206 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4208 if (!hcd->driver->enable_device)
4210 if (udev->state == USB_STATE_ADDRESS)
4212 if (udev->state != USB_STATE_DEFAULT)
4215 return hcd->driver->enable_device(hcd, udev);
4218 /* Reset device, (re)assign address, get device descriptor.
4219 * Device connection must be stable, no more debouncing needed.
4220 * Returns device in USB_STATE_ADDRESS, except on error.
4222 * If this is called for an already-existing device (as part of
4223 * usb_reset_and_verify_device), the caller must own the device lock and
4224 * the port lock. For a newly detected device that is not accessible
4225 * through any global pointers, it's not necessary to lock the device,
4226 * but it is still necessary to lock the port.
4229 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4232 struct usb_device *hdev = hub->hdev;
4233 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4235 unsigned delay = HUB_SHORT_RESET_TIME;
4236 enum usb_device_speed oldspeed = udev->speed;
4238 int devnum = udev->devnum;
4240 /* root hub ports have a slightly longer reset period
4241 * (from USB 2.0 spec, section 7.1.7.5)
4243 if (!hdev->parent) {
4244 delay = HUB_ROOT_RESET_TIME;
4245 if (port1 == hdev->bus->otg_port)
4246 hdev->bus->b_hnp_enable = 0;
4249 /* Some low speed devices have problems with the quick delay, so */
4250 /* be a bit pessimistic with those devices. RHbug #23670 */
4251 if (oldspeed == USB_SPEED_LOW)
4252 delay = HUB_LONG_RESET_TIME;
4254 mutex_lock(&hdev->bus->usb_address0_mutex);
4256 /* Reset the device; full speed may morph to high speed */
4257 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4258 retval = hub_port_reset(hub, port1, udev, delay, false);
4259 if (retval < 0) /* error or disconnect */
4261 /* success, speed is known */
4265 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4266 dev_dbg(&udev->dev, "device reset changed speed!\n");
4269 oldspeed = udev->speed;
4271 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4272 * it's fixed size except for full speed devices.
4273 * For Wireless USB devices, ep0 max packet is always 512 (tho
4274 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4276 switch (udev->speed) {
4277 case USB_SPEED_SUPER:
4278 case USB_SPEED_WIRELESS: /* fixed at 512 */
4279 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4281 case USB_SPEED_HIGH: /* fixed at 64 */
4282 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4284 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4285 /* to determine the ep0 maxpacket size, try to read
4286 * the device descriptor to get bMaxPacketSize0 and
4287 * then correct our initial guess.
4289 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4291 case USB_SPEED_LOW: /* fixed at 8 */
4292 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4298 if (udev->speed == USB_SPEED_WIRELESS)
4299 speed = "variable speed Wireless";
4301 speed = usb_speed_string(udev->speed);
4303 if (udev->speed != USB_SPEED_SUPER)
4304 dev_info(&udev->dev,
4305 "%s %s USB device number %d using %s\n",
4306 (udev->config) ? "reset" : "new", speed,
4307 devnum, udev->bus->controller->driver->name);
4309 /* Set up TT records, if needed */
4311 udev->tt = hdev->tt;
4312 udev->ttport = hdev->ttport;
4313 } else if (udev->speed != USB_SPEED_HIGH
4314 && hdev->speed == USB_SPEED_HIGH) {
4316 dev_err(&udev->dev, "parent hub has no TT\n");
4320 udev->tt = &hub->tt;
4321 udev->ttport = port1;
4324 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4325 * Because device hardware and firmware is sometimes buggy in
4326 * this area, and this is how Linux has done it for ages.
4327 * Change it cautiously.
4329 * NOTE: If use_new_scheme() is true we will start by issuing
4330 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4331 * so it may help with some non-standards-compliant devices.
4332 * Otherwise we start with SET_ADDRESS and then try to read the
4333 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4336 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4337 bool did_new_scheme = false;
4339 if (use_new_scheme(udev, retry_counter)) {
4340 struct usb_device_descriptor *buf;
4343 did_new_scheme = true;
4344 retval = hub_enable_device(udev);
4347 "hub failed to enable device, error %d\n",
4352 #define GET_DESCRIPTOR_BUFSIZE 64
4353 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4359 /* Retry on all errors; some devices are flakey.
4360 * 255 is for WUSB devices, we actually need to use
4361 * 512 (WUSB1.0[4.8.1]).
4363 for (j = 0; j < 3; ++j) {
4364 buf->bMaxPacketSize0 = 0;
4365 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4366 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4367 USB_DT_DEVICE << 8, 0,
4368 buf, GET_DESCRIPTOR_BUFSIZE,
4369 initial_descriptor_timeout);
4370 switch (buf->bMaxPacketSize0) {
4371 case 8: case 16: case 32: case 64: case 255:
4372 if (buf->bDescriptorType ==
4386 udev->descriptor.bMaxPacketSize0 =
4387 buf->bMaxPacketSize0;
4390 retval = hub_port_reset(hub, port1, udev, delay, false);
4391 if (retval < 0) /* error or disconnect */
4393 if (oldspeed != udev->speed) {
4395 "device reset changed speed!\n");
4401 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4406 #undef GET_DESCRIPTOR_BUFSIZE
4410 * If device is WUSB, we already assigned an
4411 * unauthorized address in the Connect Ack sequence;
4412 * authorization will assign the final address.
4414 if (udev->wusb == 0) {
4415 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4416 retval = hub_set_address(udev, devnum);
4422 if (retval != -ENODEV)
4423 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4427 if (udev->speed == USB_SPEED_SUPER) {
4428 devnum = udev->devnum;
4429 dev_info(&udev->dev,
4430 "%s SuperSpeed USB device number %d using %s\n",
4431 (udev->config) ? "reset" : "new",
4432 devnum, udev->bus->controller->driver->name);
4435 /* cope with hardware quirkiness:
4436 * - let SET_ADDRESS settle, some device hardware wants it
4437 * - read ep0 maxpacket even for high and low speed,
4440 /* use_new_scheme() checks the speed which may have
4441 * changed since the initial look so we cache the result
4448 retval = usb_get_device_descriptor(udev, 8);
4450 if (retval != -ENODEV)
4452 "device descriptor read/8, error %d\n",
4464 if (hcd->phy && !hdev->parent)
4465 usb_phy_notify_connect(hcd->phy, udev->speed);
4468 * Some superspeed devices have finished the link training process
4469 * and attached to a superspeed hub port, but the device descriptor
4470 * got from those devices show they aren't superspeed devices. Warm
4471 * reset the port attached by the devices can fix them.
4473 if ((udev->speed == USB_SPEED_SUPER) &&
4474 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4475 dev_err(&udev->dev, "got a wrong device descriptor, "
4476 "warm reset device\n");
4477 hub_port_reset(hub, port1, udev,
4478 HUB_BH_RESET_TIME, true);
4483 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4484 udev->speed == USB_SPEED_SUPER)
4487 i = udev->descriptor.bMaxPacketSize0;
4488 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4489 if (udev->speed == USB_SPEED_LOW ||
4490 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4491 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4495 if (udev->speed == USB_SPEED_FULL)
4496 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4498 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4499 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4500 usb_ep0_reinit(udev);
4503 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4504 if (retval < (signed)sizeof(udev->descriptor)) {
4505 if (retval != -ENODEV)
4506 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4513 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4514 retval = usb_get_bos_descriptor(udev);
4516 udev->lpm_capable = usb_device_supports_lpm(udev);
4517 usb_set_lpm_parameters(udev);
4522 /* notify HCD that we have a device connected and addressed */
4523 if (hcd->driver->update_device)
4524 hcd->driver->update_device(hcd, udev);
4525 hub_set_initial_usb2_lpm_policy(udev);
4528 hub_port_disable(hub, port1, 0);
4529 update_devnum(udev, devnum); /* for disconnect processing */
4531 mutex_unlock(&hdev->bus->usb_address0_mutex);
4536 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4538 struct usb_qualifier_descriptor *qual;
4541 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4545 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4546 qual, sizeof *qual);
4547 if (status == sizeof *qual) {
4548 dev_info(&udev->dev, "not running at top speed; "
4549 "connect to a high speed hub\n");
4550 /* hub LEDs are probably harder to miss than syslog */
4551 if (hub->has_indicators) {
4552 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4553 queue_delayed_work(system_power_efficient_wq,
4561 hub_power_remaining (struct usb_hub *hub)
4563 struct usb_device *hdev = hub->hdev;
4567 if (!hub->limited_power)
4570 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4571 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4572 struct usb_port *port_dev = hub->ports[port1 - 1];
4573 struct usb_device *udev = port_dev->child;
4579 if (hub_is_superspeed(udev))
4585 * Unconfigured devices may not use more than one unit load,
4586 * or 8mA for OTG ports
4588 if (udev->actconfig)
4589 delta = usb_get_max_power(udev, udev->actconfig);
4590 else if (port1 != udev->bus->otg_port || hdev->parent)
4594 if (delta > hub->mA_per_port)
4595 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4596 delta, hub->mA_per_port);
4599 if (remaining < 0) {
4600 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4607 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4612 struct usb_device *hdev = hub->hdev;
4613 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4614 struct usb_port *port_dev = hub->ports[port1 - 1];
4615 struct usb_device *udev = port_dev->child;
4616 static int unreliable_port = -1;
4618 /* Disconnect any existing devices under this port */
4620 if (hcd->phy && !hdev->parent &&
4621 !(portstatus & USB_PORT_STAT_CONNECTION))
4622 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4623 usb_disconnect(&port_dev->child);
4626 /* We can forget about a "removed" device when there's a physical
4627 * disconnect or the connect status changes.
4629 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4630 (portchange & USB_PORT_STAT_C_CONNECTION))
4631 clear_bit(port1, hub->removed_bits);
4633 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4634 USB_PORT_STAT_C_ENABLE)) {
4635 status = hub_port_debounce_be_stable(hub, port1);
4637 if (status != -ENODEV &&
4638 port1 != unreliable_port &&
4640 dev_err(&port_dev->dev, "connect-debounce failed\n");
4641 portstatus &= ~USB_PORT_STAT_CONNECTION;
4642 unreliable_port = port1;
4644 portstatus = status;
4648 /* Return now if debouncing failed or nothing is connected or
4649 * the device was "removed".
4651 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4652 test_bit(port1, hub->removed_bits)) {
4654 /* maybe switch power back on (e.g. root hub was reset) */
4655 if (hub_is_port_power_switchable(hub)
4656 && !port_is_power_on(hub, portstatus))
4657 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4659 if (portstatus & USB_PORT_STAT_ENABLE)
4663 if (hub_is_superspeed(hub->hdev))
4669 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4671 /* reallocate for each attempt, since references
4672 * to the previous one can escape in various ways
4674 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4676 dev_err(&port_dev->dev,
4677 "couldn't allocate usb_device\n");
4681 usb_set_device_state(udev, USB_STATE_POWERED);
4682 udev->bus_mA = hub->mA_per_port;
4683 udev->level = hdev->level + 1;
4684 udev->wusb = hub_is_wusb(hub);
4686 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4687 if (hub_is_superspeed(hub->hdev))
4688 udev->speed = USB_SPEED_SUPER;
4690 udev->speed = USB_SPEED_UNKNOWN;
4692 choose_devnum(udev);
4693 if (udev->devnum <= 0) {
4694 status = -ENOTCONN; /* Don't retry */
4698 /* reset (non-USB 3.0 devices) and get descriptor */
4699 usb_lock_port(port_dev);
4700 status = hub_port_init(hub, udev, port1, i);
4701 usb_unlock_port(port_dev);
4705 usb_detect_quirks(udev);
4706 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4709 /* consecutive bus-powered hubs aren't reliable; they can
4710 * violate the voltage drop budget. if the new child has
4711 * a "powered" LED, users should notice we didn't enable it
4712 * (without reading syslog), even without per-port LEDs
4715 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4716 && udev->bus_mA <= unit_load) {
4719 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4722 dev_dbg(&udev->dev, "get status %d ?\n", status);
4725 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4727 "can't connect bus-powered hub "
4729 if (hub->has_indicators) {
4730 hub->indicator[port1-1] =
4731 INDICATOR_AMBER_BLINK;
4733 system_power_efficient_wq,
4736 status = -ENOTCONN; /* Don't retry */
4741 /* check for devices running slower than they could */
4742 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4743 && udev->speed == USB_SPEED_FULL
4744 && highspeed_hubs != 0)
4745 check_highspeed (hub, udev, port1);
4747 /* Store the parent's children[] pointer. At this point
4748 * udev becomes globally accessible, although presumably
4749 * no one will look at it until hdev is unlocked.
4753 mutex_lock(&usb_port_peer_mutex);
4755 /* We mustn't add new devices if the parent hub has
4756 * been disconnected; we would race with the
4757 * recursively_mark_NOTATTACHED() routine.
4759 spin_lock_irq(&device_state_lock);
4760 if (hdev->state == USB_STATE_NOTATTACHED)
4763 port_dev->child = udev;
4764 spin_unlock_irq(&device_state_lock);
4765 mutex_unlock(&usb_port_peer_mutex);
4767 /* Run it through the hoops (find a driver, etc) */
4769 status = usb_new_device(udev);
4771 mutex_lock(&usb_port_peer_mutex);
4772 spin_lock_irq(&device_state_lock);
4773 port_dev->child = NULL;
4774 spin_unlock_irq(&device_state_lock);
4775 mutex_unlock(&usb_port_peer_mutex);
4782 status = hub_power_remaining(hub);
4784 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4789 hub_port_disable(hub, port1, 1);
4791 usb_ep0_reinit(udev);
4792 release_devnum(udev);
4795 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4798 if (hub->hdev->parent ||
4799 !hcd->driver->port_handed_over ||
4800 !(hcd->driver->port_handed_over)(hcd, port1)) {
4801 if (status != -ENOTCONN && status != -ENODEV)
4802 dev_err(&port_dev->dev,
4803 "unable to enumerate USB device\n");
4807 hub_port_disable(hub, port1, 1);
4808 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4809 hcd->driver->relinquish_port(hcd, port1);
4813 /* Handle physical or logical connection change events.
4814 * This routine is called when:
4815 * a port connection-change occurs;
4816 * a port enable-change occurs (often caused by EMI);
4817 * usb_reset_and_verify_device() encounters changed descriptors (as from
4818 * a firmware download)
4819 * caller already locked the hub
4821 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4822 u16 portstatus, u16 portchange)
4823 __must_hold(&port_dev->status_lock)
4825 struct usb_port *port_dev = hub->ports[port1 - 1];
4826 struct usb_device *udev = port_dev->child;
4827 int status = -ENODEV;
4829 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4830 portchange, portspeed(hub, portstatus));
4832 if (hub->has_indicators) {
4833 set_port_led(hub, port1, HUB_LED_AUTO);
4834 hub->indicator[port1-1] = INDICATOR_AUTO;
4837 #ifdef CONFIG_USB_OTG
4838 /* during HNP, don't repeat the debounce */
4839 if (hub->hdev->bus->is_b_host)
4840 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4841 USB_PORT_STAT_C_ENABLE);
4844 /* Try to resuscitate an existing device */
4845 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4846 udev->state != USB_STATE_NOTATTACHED) {
4847 if (portstatus & USB_PORT_STAT_ENABLE) {
4848 status = 0; /* Nothing to do */
4849 #ifdef CONFIG_PM_RUNTIME
4850 } else if (udev->state == USB_STATE_SUSPENDED &&
4851 udev->persist_enabled) {
4852 /* For a suspended device, treat this as a
4853 * remote wakeup event.
4855 usb_unlock_port(port_dev);
4856 status = usb_remote_wakeup(udev);
4857 usb_lock_port(port_dev);
4860 /* Don't resuscitate */;
4863 clear_bit(port1, hub->change_bits);
4865 /* successfully revalidated the connection */
4869 usb_unlock_port(port_dev);
4870 hub_port_connect(hub, port1, portstatus, portchange);
4871 usb_lock_port(port_dev);
4874 static void port_event(struct usb_hub *hub, int port1)
4875 __must_hold(&port_dev->status_lock)
4877 int connect_change, reset_device = 0;
4878 struct usb_port *port_dev = hub->ports[port1 - 1];
4879 struct usb_device *udev = port_dev->child;
4880 struct usb_device *hdev = hub->hdev;
4881 u16 portstatus, portchange;
4883 connect_change = test_bit(port1, hub->change_bits);
4884 clear_bit(port1, hub->event_bits);
4885 clear_bit(port1, hub->wakeup_bits);
4887 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
4890 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4891 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
4895 if (portchange & USB_PORT_STAT_C_ENABLE) {
4896 if (!connect_change)
4897 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
4899 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
4902 * EM interference sometimes causes badly shielded USB devices
4903 * to be shutdown by the hub, this hack enables them again.
4904 * Works at least with mouse driver.
4906 if (!(portstatus & USB_PORT_STAT_ENABLE)
4907 && !connect_change && udev) {
4908 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
4913 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4914 u16 status = 0, unused;
4916 dev_dbg(&port_dev->dev, "over-current change\n");
4917 usb_clear_port_feature(hdev, port1,
4918 USB_PORT_FEAT_C_OVER_CURRENT);
4919 msleep(100); /* Cool down */
4920 hub_power_on(hub, true);
4921 hub_port_status(hub, port1, &status, &unused);
4922 if (status & USB_PORT_STAT_OVERCURRENT)
4923 dev_err(&port_dev->dev, "over-current condition\n");
4926 if (portchange & USB_PORT_STAT_C_RESET) {
4927 dev_dbg(&port_dev->dev, "reset change\n");
4928 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
4930 if ((portchange & USB_PORT_STAT_C_BH_RESET)
4931 && hub_is_superspeed(hdev)) {
4932 dev_dbg(&port_dev->dev, "warm reset change\n");
4933 usb_clear_port_feature(hdev, port1,
4934 USB_PORT_FEAT_C_BH_PORT_RESET);
4936 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4937 dev_dbg(&port_dev->dev, "link state change\n");
4938 usb_clear_port_feature(hdev, port1,
4939 USB_PORT_FEAT_C_PORT_LINK_STATE);
4941 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4942 dev_warn(&port_dev->dev, "config error\n");
4943 usb_clear_port_feature(hdev, port1,
4944 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4947 /* skip port actions that require the port to be powered on */
4948 if (!pm_runtime_active(&port_dev->dev))
4951 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
4955 * Warm reset a USB3 protocol port if it's in
4956 * SS.Inactive state.
4958 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
4959 dev_dbg(&port_dev->dev, "do warm reset\n");
4960 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
4961 || udev->state == USB_STATE_NOTATTACHED) {
4962 if (hub_port_reset(hub, port1, NULL,
4963 HUB_BH_RESET_TIME, true) < 0)
4964 hub_port_disable(hub, port1, 1);
4970 * On disconnect USB3 protocol ports transit from U0 to
4971 * SS.Inactive to Rx.Detect. If this happens a warm-
4972 * reset is not needed, but a (re)connect may happen
4973 * before khubd runs and sees the disconnect, and the
4974 * device may be an unknown state.
4976 * If the port went through SS.Inactive without khubd
4977 * seeing it the C_LINK_STATE change flag will be set,
4978 * and we reset the dev to put it in a known state.
4980 if (reset_device || (udev && hub_is_superspeed(hub->hdev)
4981 && (portchange & USB_PORT_STAT_C_LINK_STATE)
4982 && (portstatus & USB_PORT_STAT_CONNECTION))) {
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);
4992 hub_port_connect_change(hub, port1, portstatus, portchange);
4996 static void hub_events(void)
4998 struct list_head *tmp;
4999 struct usb_device *hdev;
5000 struct usb_interface *intf;
5001 struct usb_hub *hub;
5002 struct device *hub_dev;
5008 * We restart the list every time to avoid a deadlock with
5009 * deleting hubs downstream from this one. This should be
5010 * safe since we delete the hub from the event list.
5011 * Not the most efficient, but avoids deadlocks.
5015 /* Grab the first entry at the beginning of the list */
5016 spin_lock_irq(&hub_event_lock);
5017 if (list_empty(&hub_event_list)) {
5018 spin_unlock_irq(&hub_event_lock);
5022 tmp = hub_event_list.next;
5025 hub = list_entry(tmp, struct usb_hub, event_list);
5026 kref_get(&hub->kref);
5029 spin_unlock_irq(&hub_event_lock);
5031 hub_dev = hub->intfdev;
5032 intf = to_usb_interface(hub_dev);
5033 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5034 hdev->state, hdev->maxchild,
5035 /* NOTE: expects max 15 ports... */
5036 (u16) hub->change_bits[0],
5037 (u16) hub->event_bits[0]);
5039 /* Lock the device, then check to see if we were
5040 * disconnected while waiting for the lock to succeed. */
5041 usb_lock_device(hdev);
5042 if (unlikely(hub->disconnected))
5043 goto loop_disconnected;
5045 /* If the hub has died, clean up after it */
5046 if (hdev->state == USB_STATE_NOTATTACHED) {
5047 hub->error = -ENODEV;
5048 hub_quiesce(hub, HUB_DISCONNECT);
5053 ret = usb_autopm_get_interface(intf);
5055 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5059 /* If this is an inactive hub, do nothing */
5064 dev_dbg (hub_dev, "resetting for error %d\n",
5067 ret = usb_reset_device(hdev);
5070 "error resetting hub: %d\n", ret);
5078 /* deal with port status changes */
5079 for (i = 1; i <= hdev->maxchild; i++) {
5080 struct usb_port *port_dev = hub->ports[i - 1];
5082 if (test_bit(i, hub->event_bits)
5083 || test_bit(i, hub->change_bits)
5084 || test_bit(i, hub->wakeup_bits)) {
5086 * The get_noresume and barrier ensure that if
5087 * the port was in the process of resuming, we
5088 * flush that work and keep the port active for
5089 * the duration of the port_event(). However,
5090 * if the port is runtime pm suspended
5091 * (powered-off), we leave it in that state, run
5092 * an abbreviated port_event(), and move on.
5094 pm_runtime_get_noresume(&port_dev->dev);
5095 pm_runtime_barrier(&port_dev->dev);
5096 usb_lock_port(port_dev);
5098 usb_unlock_port(port_dev);
5099 pm_runtime_put_sync(&port_dev->dev);
5103 /* deal with hub status changes */
5104 if (test_and_clear_bit(0, hub->event_bits) == 0)
5106 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5107 dev_err (hub_dev, "get_hub_status failed\n");
5109 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5110 dev_dbg (hub_dev, "power change\n");
5111 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5112 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5113 /* FIXME: Is this always true? */
5114 hub->limited_power = 1;
5116 hub->limited_power = 0;
5118 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5122 dev_dbg(hub_dev, "over-current change\n");
5123 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5124 msleep(500); /* Cool down */
5125 hub_power_on(hub, true);
5126 hub_hub_status(hub, &status, &unused);
5127 if (status & HUB_STATUS_OVERCURRENT)
5128 dev_err(hub_dev, "over-current "
5134 /* Balance the usb_autopm_get_interface() above */
5135 usb_autopm_put_interface_no_suspend(intf);
5137 /* Balance the usb_autopm_get_interface_no_resume() in
5138 * kick_khubd() and allow autosuspend.
5140 usb_autopm_put_interface(intf);
5142 usb_unlock_device(hdev);
5144 kref_put(&hub->kref, hub_release);
5146 } /* end while (1) */
5149 static int hub_thread(void *__unused)
5151 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
5152 * port handover. Otherwise it might see that a full-speed device
5153 * was gone before the EHCI controller had handed its port over to
5154 * the companion full-speed controller.
5160 wait_event_freezable(khubd_wait,
5161 !list_empty(&hub_event_list) ||
5162 kthread_should_stop());
5163 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
5165 pr_debug("%s: khubd exiting\n", usbcore_name);
5169 static const struct usb_device_id hub_id_table[] = {
5170 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5171 | USB_DEVICE_ID_MATCH_INT_CLASS,
5172 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5173 .bInterfaceClass = USB_CLASS_HUB,
5174 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5175 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5176 .bDeviceClass = USB_CLASS_HUB},
5177 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5178 .bInterfaceClass = USB_CLASS_HUB},
5179 { } /* Terminating entry */
5182 MODULE_DEVICE_TABLE (usb, hub_id_table);
5184 static struct usb_driver hub_driver = {
5187 .disconnect = hub_disconnect,
5188 .suspend = hub_suspend,
5189 .resume = hub_resume,
5190 .reset_resume = hub_reset_resume,
5191 .pre_reset = hub_pre_reset,
5192 .post_reset = hub_post_reset,
5193 .unlocked_ioctl = hub_ioctl,
5194 .id_table = hub_id_table,
5195 .supports_autosuspend = 1,
5198 int usb_hub_init(void)
5200 if (usb_register(&hub_driver) < 0) {
5201 printk(KERN_ERR "%s: can't register hub driver\n",
5206 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5207 if (!IS_ERR(khubd_task))
5210 /* Fall through if kernel_thread failed */
5211 usb_deregister(&hub_driver);
5212 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5217 void usb_hub_cleanup(void)
5219 kthread_stop(khubd_task);
5222 * Hub resources are freed for us by usb_deregister. It calls
5223 * usb_driver_purge on every device which in turn calls that
5224 * devices disconnect function if it is using this driver.
5225 * The hub_disconnect function takes care of releasing the
5226 * individual hub resources. -greg
5228 usb_deregister(&hub_driver);
5229 } /* usb_hub_cleanup() */
5231 static int descriptors_changed(struct usb_device *udev,
5232 struct usb_device_descriptor *old_device_descriptor,
5233 struct usb_host_bos *old_bos)
5237 unsigned serial_len = 0;
5239 unsigned old_length;
5243 if (memcmp(&udev->descriptor, old_device_descriptor,
5244 sizeof(*old_device_descriptor)) != 0)
5247 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5250 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5251 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5253 if (memcmp(udev->bos->desc, old_bos->desc, len))
5257 /* Since the idVendor, idProduct, and bcdDevice values in the
5258 * device descriptor haven't changed, we will assume the
5259 * Manufacturer and Product strings haven't changed either.
5260 * But the SerialNumber string could be different (e.g., a
5261 * different flash card of the same brand).
5264 serial_len = strlen(udev->serial) + 1;
5267 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5268 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5269 len = max(len, old_length);
5272 buf = kmalloc(len, GFP_NOIO);
5274 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5275 /* assume the worst */
5278 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5279 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5280 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5282 if (length != old_length) {
5283 dev_dbg(&udev->dev, "config index %d, error %d\n",
5288 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5290 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5292 ((struct usb_config_descriptor *) buf)->
5293 bConfigurationValue);
5299 if (!changed && serial_len) {
5300 length = usb_string(udev, udev->descriptor.iSerialNumber,
5302 if (length + 1 != serial_len) {
5303 dev_dbg(&udev->dev, "serial string error %d\n",
5306 } else if (memcmp(buf, udev->serial, length) != 0) {
5307 dev_dbg(&udev->dev, "serial string changed\n");
5317 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5318 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5320 * WARNING - don't use this routine to reset a composite device
5321 * (one with multiple interfaces owned by separate drivers)!
5322 * Use usb_reset_device() instead.
5324 * Do a port reset, reassign the device's address, and establish its
5325 * former operating configuration. If the reset fails, or the device's
5326 * descriptors change from their values before the reset, or the original
5327 * configuration and altsettings cannot be restored, a flag will be set
5328 * telling khubd to pretend the device has been disconnected and then
5329 * re-connected. All drivers will be unbound, and the device will be
5330 * re-enumerated and probed all over again.
5332 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5333 * flagged for logical disconnection, or some other negative error code
5334 * if the reset wasn't even attempted.
5337 * The caller must own the device lock and the port lock, the latter is
5338 * taken by usb_reset_device(). For example, it's safe to use
5339 * usb_reset_device() from a driver probe() routine after downloading
5340 * new firmware. For calls that might not occur during probe(), drivers
5341 * should lock the device using usb_lock_device_for_reset().
5343 * Locking exception: This routine may also be called from within an
5344 * autoresume handler. Such usage won't conflict with other tasks
5345 * holding the device lock because these tasks should always call
5346 * usb_autopm_resume_device(), thereby preventing any unwanted
5347 * autoresume. The autoresume handler is expected to have already
5348 * acquired the port lock before calling this routine.
5350 static int usb_reset_and_verify_device(struct usb_device *udev)
5352 struct usb_device *parent_hdev = udev->parent;
5353 struct usb_hub *parent_hub;
5354 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5355 struct usb_device_descriptor descriptor = udev->descriptor;
5356 struct usb_host_bos *bos;
5358 int port1 = udev->portnum;
5360 if (udev->state == USB_STATE_NOTATTACHED ||
5361 udev->state == USB_STATE_SUSPENDED) {
5362 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5370 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5372 /* Disable USB2 hardware LPM.
5373 * It will be re-enabled by the enumeration process.
5375 if (udev->usb2_hw_lpm_enabled == 1)
5376 usb_set_usb2_hardware_lpm(udev, 0);
5381 /* Disable LPM and LTM while we reset the device and reinstall the alt
5382 * settings. Device-initiated LPM settings, and system exit latency
5383 * settings are cleared when the device is reset, so we have to set
5386 ret = usb_unlocked_disable_lpm(udev);
5388 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5391 ret = usb_disable_ltm(udev);
5393 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5398 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5400 /* ep0 maxpacket size may change; let the HCD know about it.
5401 * Other endpoints will be handled by re-enumeration. */
5402 usb_ep0_reinit(udev);
5403 ret = hub_port_init(parent_hub, udev, port1, i);
5404 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5411 /* Device might have changed firmware (DFU or similar) */
5412 if (descriptors_changed(udev, &descriptor, bos)) {
5413 dev_info(&udev->dev, "device firmware changed\n");
5414 udev->descriptor = descriptor; /* for disconnect() calls */
5418 /* Restore the device's previous configuration */
5419 if (!udev->actconfig)
5422 mutex_lock(hcd->bandwidth_mutex);
5423 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5425 dev_warn(&udev->dev,
5426 "Busted HC? Not enough HCD resources for "
5427 "old configuration.\n");
5428 mutex_unlock(hcd->bandwidth_mutex);
5431 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5432 USB_REQ_SET_CONFIGURATION, 0,
5433 udev->actconfig->desc.bConfigurationValue, 0,
5434 NULL, 0, USB_CTRL_SET_TIMEOUT);
5437 "can't restore configuration #%d (error=%d)\n",
5438 udev->actconfig->desc.bConfigurationValue, ret);
5439 mutex_unlock(hcd->bandwidth_mutex);
5442 mutex_unlock(hcd->bandwidth_mutex);
5443 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5445 /* Put interfaces back into the same altsettings as before.
5446 * Don't bother to send the Set-Interface request for interfaces
5447 * that were already in altsetting 0; besides being unnecessary,
5448 * many devices can't handle it. Instead just reset the host-side
5451 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5452 struct usb_host_config *config = udev->actconfig;
5453 struct usb_interface *intf = config->interface[i];
5454 struct usb_interface_descriptor *desc;
5456 desc = &intf->cur_altsetting->desc;
5457 if (desc->bAlternateSetting == 0) {
5458 usb_disable_interface(udev, intf, true);
5459 usb_enable_interface(udev, intf, true);
5462 /* Let the bandwidth allocation function know that this
5463 * device has been reset, and it will have to use
5464 * alternate setting 0 as the current alternate setting.
5466 intf->resetting_device = 1;
5467 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5468 desc->bAlternateSetting);
5469 intf->resetting_device = 0;
5472 dev_err(&udev->dev, "failed to restore interface %d "
5473 "altsetting %d (error=%d)\n",
5474 desc->bInterfaceNumber,
5475 desc->bAlternateSetting,
5479 /* Resetting also frees any allocated streams */
5480 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5481 intf->cur_altsetting->endpoint[j].streams = 0;
5485 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5486 usb_set_usb2_hardware_lpm(udev, 1);
5487 usb_unlocked_enable_lpm(udev);
5488 usb_enable_ltm(udev);
5489 usb_release_bos_descriptor(udev);
5494 /* LPM state doesn't matter when we're about to destroy the device. */
5495 hub_port_logical_disconnect(parent_hub, port1);
5496 usb_release_bos_descriptor(udev);
5502 * usb_reset_device - warn interface drivers and perform a USB port reset
5503 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5505 * Warns all drivers bound to registered interfaces (using their pre_reset
5506 * method), performs the port reset, and then lets the drivers know that
5507 * the reset is over (using their post_reset method).
5509 * Return: The same as for usb_reset_and_verify_device().
5512 * The caller must own the device lock. For example, it's safe to use
5513 * this from a driver probe() routine after downloading new firmware.
5514 * For calls that might not occur during probe(), drivers should lock
5515 * the device using usb_lock_device_for_reset().
5517 * If an interface is currently being probed or disconnected, we assume
5518 * its driver knows how to handle resets. For all other interfaces,
5519 * if the driver doesn't have pre_reset and post_reset methods then
5520 * we attempt to unbind it and rebind afterward.
5522 int usb_reset_device(struct usb_device *udev)
5526 unsigned int noio_flag;
5527 struct usb_port *port_dev;
5528 struct usb_host_config *config = udev->actconfig;
5529 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5531 if (udev->state == USB_STATE_NOTATTACHED ||
5532 udev->state == USB_STATE_SUSPENDED) {
5533 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5538 if (!udev->parent) {
5539 /* this requires hcd-specific logic; see ohci_restart() */
5540 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5544 port_dev = hub->ports[udev->portnum - 1];
5547 * Don't allocate memory with GFP_KERNEL in current
5548 * context to avoid possible deadlock if usb mass
5549 * storage interface or usbnet interface(iSCSI case)
5550 * is included in current configuration. The easist
5551 * approach is to do it for every device reset,
5552 * because the device 'memalloc_noio' flag may have
5553 * not been set before reseting the usb device.
5555 noio_flag = memalloc_noio_save();
5557 /* Prevent autosuspend during the reset */
5558 usb_autoresume_device(udev);
5561 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5562 struct usb_interface *cintf = config->interface[i];
5563 struct usb_driver *drv;
5566 if (cintf->dev.driver) {
5567 drv = to_usb_driver(cintf->dev.driver);
5568 if (drv->pre_reset && drv->post_reset)
5569 unbind = (drv->pre_reset)(cintf);
5570 else if (cintf->condition ==
5571 USB_INTERFACE_BOUND)
5574 usb_forced_unbind_intf(cintf);
5579 usb_lock_port(port_dev);
5580 ret = usb_reset_and_verify_device(udev);
5581 usb_unlock_port(port_dev);
5584 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5585 struct usb_interface *cintf = config->interface[i];
5586 struct usb_driver *drv;
5587 int rebind = cintf->needs_binding;
5589 if (!rebind && cintf->dev.driver) {
5590 drv = to_usb_driver(cintf->dev.driver);
5591 if (drv->post_reset)
5592 rebind = (drv->post_reset)(cintf);
5593 else if (cintf->condition ==
5594 USB_INTERFACE_BOUND)
5597 cintf->needs_binding = 1;
5600 usb_unbind_and_rebind_marked_interfaces(udev);
5603 usb_autosuspend_device(udev);
5604 memalloc_noio_restore(noio_flag);
5607 EXPORT_SYMBOL_GPL(usb_reset_device);
5611 * usb_queue_reset_device - Reset a USB device from an atomic context
5612 * @iface: USB interface belonging to the device to reset
5614 * This function can be used to reset a USB device from an atomic
5615 * context, where usb_reset_device() won't work (as it blocks).
5617 * Doing a reset via this method is functionally equivalent to calling
5618 * usb_reset_device(), except for the fact that it is delayed to a
5619 * workqueue. This means that any drivers bound to other interfaces
5620 * might be unbound, as well as users from usbfs in user space.
5624 * - Scheduling two resets at the same time from two different drivers
5625 * attached to two different interfaces of the same device is
5626 * possible; depending on how the driver attached to each interface
5627 * handles ->pre_reset(), the second reset might happen or not.
5629 * - If a driver is unbound and it had a pending reset, the reset will
5632 * - This function can be called during .probe() or .disconnect()
5633 * times. On return from .disconnect(), any pending resets will be
5636 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5639 * NOTE: We don't do any reference count tracking because it is not
5640 * needed. The lifecycle of the work_struct is tied to the
5641 * usb_interface. Before destroying the interface we cancel the
5642 * work_struct, so the fact that work_struct is queued and or
5643 * running means the interface (and thus, the device) exist and
5646 void usb_queue_reset_device(struct usb_interface *iface)
5648 schedule_work(&iface->reset_ws);
5650 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5653 * usb_hub_find_child - Get the pointer of child device
5654 * attached to the port which is specified by @port1.
5655 * @hdev: USB device belonging to the usb hub
5656 * @port1: port num to indicate which port the child device
5659 * USB drivers call this function to get hub's child device
5662 * Return: %NULL if input param is invalid and
5663 * child's usb_device pointer if non-NULL.
5665 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5668 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5670 if (port1 < 1 || port1 > hdev->maxchild)
5672 return hub->ports[port1 - 1]->child;
5674 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5676 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5677 struct usb_hub_descriptor *desc)
5679 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5680 enum usb_port_connect_type connect_type;
5686 if (!hub_is_superspeed(hdev)) {
5687 for (i = 1; i <= hdev->maxchild; i++) {
5688 struct usb_port *port_dev = hub->ports[i - 1];
5690 connect_type = port_dev->connect_type;
5691 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5692 u8 mask = 1 << (i%8);
5694 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5695 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5696 desc->u.hs.DeviceRemovable[i/8] |= mask;
5701 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5703 for (i = 1; i <= hdev->maxchild; i++) {
5704 struct usb_port *port_dev = hub->ports[i - 1];
5706 connect_type = port_dev->connect_type;
5707 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5710 if (!(port_removable & mask)) {
5711 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5712 port_removable |= mask;
5717 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5723 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5724 * @hdev: USB device belonging to the usb hub
5725 * @port1: port num of the port
5727 * Return: Port's acpi handle if successful, %NULL if params are
5730 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5733 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5738 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);