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 static inline int hub_is_superspeed(struct usb_device *hdev)
41 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock);
49 /* khubd's worklist and its lock */
50 static DEFINE_SPINLOCK(hub_event_lock);
51 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
54 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
56 static struct task_struct *khubd_task;
58 /* cycle leds on hubs that aren't blinking for attention */
59 static bool blinkenlights = 0;
60 module_param (blinkenlights, bool, S_IRUGO);
61 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
64 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
65 * 10 seconds to send reply for the initial 64-byte descriptor request.
67 /* define initial 64-byte descriptor request timeout in milliseconds */
68 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
69 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
70 MODULE_PARM_DESC(initial_descriptor_timeout,
71 "initial 64-byte descriptor request timeout in milliseconds "
72 "(default 5000 - 5.0 seconds)");
75 * As of 2.6.10 we introduce a new USB device initialization scheme which
76 * closely resembles the way Windows works. Hopefully it will be compatible
77 * with a wider range of devices than the old scheme. However some previously
78 * working devices may start giving rise to "device not accepting address"
79 * errors; if that happens the user can try the old scheme by adjusting the
80 * following module parameters.
82 * For maximum flexibility there are two boolean parameters to control the
83 * hub driver's behavior. On the first initialization attempt, if the
84 * "old_scheme_first" parameter is set then the old scheme will be used,
85 * otherwise the new scheme is used. If that fails and "use_both_schemes"
86 * is set, then the driver will make another attempt, using the other scheme.
88 static bool old_scheme_first = 0;
89 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
90 MODULE_PARM_DESC(old_scheme_first,
91 "start with the old device initialization scheme");
93 static bool use_both_schemes = 1;
94 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
95 MODULE_PARM_DESC(use_both_schemes,
96 "try the other device initialization scheme if the "
99 /* Mutual exclusion for EHCI CF initialization. This interferes with
100 * port reset on some companion controllers.
102 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
103 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
105 #define HUB_DEBOUNCE_TIMEOUT 2000
106 #define HUB_DEBOUNCE_STEP 25
107 #define HUB_DEBOUNCE_STABLE 100
109 static int usb_reset_and_verify_device(struct usb_device *udev);
111 static inline char *portspeed(struct usb_hub *hub, int portstatus)
113 if (hub_is_superspeed(hub->hdev))
115 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
117 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
123 /* Note that hdev or one of its children must be locked! */
124 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
126 if (!hdev || !hdev->actconfig || !hdev->maxchild)
128 return usb_get_intfdata(hdev->actconfig->interface[0]);
131 static int usb_device_supports_lpm(struct usb_device *udev)
133 /* USB 2.1 (and greater) devices indicate LPM support through
134 * their USB 2.0 Extended Capabilities BOS descriptor.
136 if (udev->speed == USB_SPEED_HIGH) {
137 if (udev->bos->ext_cap &&
139 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
145 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
146 * However, there are some that don't, and they set the U1/U2 exit
149 if (!udev->bos->ss_cap) {
150 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
154 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
155 udev->bos->ss_cap->bU2DevExitLat == 0) {
157 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
159 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
163 if (!udev->parent || udev->parent->lpm_capable)
169 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
172 static void usb_set_lpm_mel(struct usb_device *udev,
173 struct usb3_lpm_parameters *udev_lpm_params,
174 unsigned int udev_exit_latency,
176 struct usb3_lpm_parameters *hub_lpm_params,
177 unsigned int hub_exit_latency)
179 unsigned int total_mel;
180 unsigned int device_mel;
181 unsigned int hub_mel;
184 * Calculate the time it takes to transition all links from the roothub
185 * to the parent hub into U0. The parent hub must then decode the
186 * packet (hub header decode latency) to figure out which port it was
189 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
190 * means 0.1us). Multiply that by 100 to get nanoseconds.
192 total_mel = hub_lpm_params->mel +
193 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
196 * How long will it take to transition the downstream hub's port into
197 * U0? The greater of either the hub exit latency or the device exit
200 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
201 * Multiply that by 1000 to get nanoseconds.
203 device_mel = udev_exit_latency * 1000;
204 hub_mel = hub_exit_latency * 1000;
205 if (device_mel > hub_mel)
206 total_mel += device_mel;
208 total_mel += hub_mel;
210 udev_lpm_params->mel = total_mel;
214 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
215 * a transition from either U1 or U2.
217 static void usb_set_lpm_pel(struct usb_device *udev,
218 struct usb3_lpm_parameters *udev_lpm_params,
219 unsigned int udev_exit_latency,
221 struct usb3_lpm_parameters *hub_lpm_params,
222 unsigned int hub_exit_latency,
223 unsigned int port_to_port_exit_latency)
225 unsigned int first_link_pel;
226 unsigned int hub_pel;
229 * First, the device sends an LFPS to transition the link between the
230 * device and the parent hub into U0. The exit latency is the bigger of
231 * the device exit latency or the hub exit latency.
233 if (udev_exit_latency > hub_exit_latency)
234 first_link_pel = udev_exit_latency * 1000;
236 first_link_pel = hub_exit_latency * 1000;
239 * When the hub starts to receive the LFPS, there is a slight delay for
240 * it to figure out that one of the ports is sending an LFPS. Then it
241 * will forward the LFPS to its upstream link. The exit latency is the
242 * delay, plus the PEL that we calculated for this hub.
244 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
247 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
248 * is the greater of the two exit latencies.
250 if (first_link_pel > hub_pel)
251 udev_lpm_params->pel = first_link_pel;
253 udev_lpm_params->pel = hub_pel;
257 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
258 * when a device initiates a transition to U0, until when it will receive the
259 * first packet from the host controller.
261 * Section C.1.5.1 describes the four components to this:
263 * - t2: time for the ERDY to make it from the device to the host.
264 * - t3: a host-specific delay to process the ERDY.
265 * - t4: time for the packet to make it from the host to the device.
267 * t3 is specific to both the xHCI host and the platform the host is integrated
268 * into. The Intel HW folks have said it's negligible, FIXME if a different
269 * vendor says otherwise.
271 static void usb_set_lpm_sel(struct usb_device *udev,
272 struct usb3_lpm_parameters *udev_lpm_params)
274 struct usb_device *parent;
275 unsigned int num_hubs;
276 unsigned int total_sel;
278 /* t1 = device PEL */
279 total_sel = udev_lpm_params->pel;
280 /* How many external hubs are in between the device & the root port. */
281 for (parent = udev->parent, num_hubs = 0; parent->parent;
282 parent = parent->parent)
284 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
286 total_sel += 2100 + 250 * (num_hubs - 1);
288 /* t4 = 250ns * num_hubs */
289 total_sel += 250 * num_hubs;
291 udev_lpm_params->sel = total_sel;
294 static void usb_set_lpm_parameters(struct usb_device *udev)
297 unsigned int port_to_port_delay;
298 unsigned int udev_u1_del;
299 unsigned int udev_u2_del;
300 unsigned int hub_u1_del;
301 unsigned int hub_u2_del;
303 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
306 hub = usb_hub_to_struct_hub(udev->parent);
307 /* It doesn't take time to transition the roothub into U0, since it
308 * doesn't have an upstream link.
313 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
314 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
315 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
316 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
318 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
319 hub, &udev->parent->u1_params, hub_u1_del);
321 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
322 hub, &udev->parent->u2_params, hub_u2_del);
325 * Appendix C, section C.2.2.2, says that there is a slight delay from
326 * when the parent hub notices the downstream port is trying to
327 * transition to U0 to when the hub initiates a U0 transition on its
328 * upstream port. The section says the delays are tPort2PortU1EL and
329 * tPort2PortU2EL, but it doesn't define what they are.
331 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
332 * about the same delays. Use the maximum delay calculations from those
333 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
334 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
335 * assume the device exit latencies they are talking about are the hub
338 * What do we do if the U2 exit latency is less than the U1 exit
339 * latency? It's possible, although not likely...
341 port_to_port_delay = 1;
343 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
344 hub, &udev->parent->u1_params, hub_u1_del,
347 if (hub_u2_del > hub_u1_del)
348 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
350 port_to_port_delay = 1 + hub_u1_del;
352 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
353 hub, &udev->parent->u2_params, hub_u2_del,
356 /* Now that we've got PEL, calculate SEL. */
357 usb_set_lpm_sel(udev, &udev->u1_params);
358 usb_set_lpm_sel(udev, &udev->u2_params);
361 /* USB 2.0 spec Section 11.24.4.5 */
362 static int get_hub_descriptor(struct usb_device *hdev, void *data)
367 if (hub_is_superspeed(hdev)) {
368 dtype = USB_DT_SS_HUB;
369 size = USB_DT_SS_HUB_SIZE;
372 size = sizeof(struct usb_hub_descriptor);
375 for (i = 0; i < 3; i++) {
376 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
377 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
378 dtype << 8, 0, data, size,
379 USB_CTRL_GET_TIMEOUT);
380 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
387 * USB 2.0 spec Section 11.24.2.1
389 static int clear_hub_feature(struct usb_device *hdev, int feature)
391 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
392 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
396 * USB 2.0 spec Section 11.24.2.2
398 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
400 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
401 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
406 * USB 2.0 spec Section 11.24.2.13
408 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
410 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
411 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
415 static char *to_led_name(int selector)
432 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
433 * for info about using port indicators
435 static void set_port_led(struct usb_hub *hub, int port1, int selector)
437 struct usb_port *port_dev = hub->ports[port1 - 1];
440 status = set_port_feature(hub->hdev, (selector << 8) | port1,
441 USB_PORT_FEAT_INDICATOR);
442 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
443 to_led_name(selector), status);
446 #define LED_CYCLE_PERIOD ((2*HZ)/3)
448 static void led_work (struct work_struct *work)
450 struct usb_hub *hub =
451 container_of(work, struct usb_hub, leds.work);
452 struct usb_device *hdev = hub->hdev;
454 unsigned changed = 0;
457 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
460 for (i = 0; i < hdev->maxchild; i++) {
461 unsigned selector, mode;
463 /* 30%-50% duty cycle */
465 switch (hub->indicator[i]) {
467 case INDICATOR_CYCLE:
469 selector = HUB_LED_AUTO;
470 mode = INDICATOR_AUTO;
472 /* blinking green = sw attention */
473 case INDICATOR_GREEN_BLINK:
474 selector = HUB_LED_GREEN;
475 mode = INDICATOR_GREEN_BLINK_OFF;
477 case INDICATOR_GREEN_BLINK_OFF:
478 selector = HUB_LED_OFF;
479 mode = INDICATOR_GREEN_BLINK;
481 /* blinking amber = hw attention */
482 case INDICATOR_AMBER_BLINK:
483 selector = HUB_LED_AMBER;
484 mode = INDICATOR_AMBER_BLINK_OFF;
486 case INDICATOR_AMBER_BLINK_OFF:
487 selector = HUB_LED_OFF;
488 mode = INDICATOR_AMBER_BLINK;
490 /* blink green/amber = reserved */
491 case INDICATOR_ALT_BLINK:
492 selector = HUB_LED_GREEN;
493 mode = INDICATOR_ALT_BLINK_OFF;
495 case INDICATOR_ALT_BLINK_OFF:
496 selector = HUB_LED_AMBER;
497 mode = INDICATOR_ALT_BLINK;
502 if (selector != HUB_LED_AUTO)
504 set_port_led(hub, i + 1, selector);
505 hub->indicator[i] = mode;
507 if (!changed && blinkenlights) {
509 cursor %= hdev->maxchild;
510 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
511 hub->indicator[cursor] = INDICATOR_CYCLE;
515 queue_delayed_work(system_power_efficient_wq,
516 &hub->leds, LED_CYCLE_PERIOD);
519 /* use a short timeout for hub/port status fetches */
520 #define USB_STS_TIMEOUT 1000
521 #define USB_STS_RETRIES 5
524 * USB 2.0 spec Section 11.24.2.6
526 static int get_hub_status(struct usb_device *hdev,
527 struct usb_hub_status *data)
529 int i, status = -ETIMEDOUT;
531 for (i = 0; i < USB_STS_RETRIES &&
532 (status == -ETIMEDOUT || status == -EPIPE); i++) {
533 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
534 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
535 data, sizeof(*data), USB_STS_TIMEOUT);
541 * USB 2.0 spec Section 11.24.2.7
543 static int get_port_status(struct usb_device *hdev, int port1,
544 struct usb_port_status *data)
546 int i, status = -ETIMEDOUT;
548 for (i = 0; i < USB_STS_RETRIES &&
549 (status == -ETIMEDOUT || status == -EPIPE); i++) {
550 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
551 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
552 data, sizeof(*data), USB_STS_TIMEOUT);
557 static int hub_port_status(struct usb_hub *hub, int port1,
558 u16 *status, u16 *change)
562 mutex_lock(&hub->status_mutex);
563 ret = get_port_status(hub->hdev, port1, &hub->status->port);
566 dev_err(hub->intfdev,
567 "%s failed (err = %d)\n", __func__, ret);
571 *status = le16_to_cpu(hub->status->port.wPortStatus);
572 *change = le16_to_cpu(hub->status->port.wPortChange);
576 mutex_unlock(&hub->status_mutex);
580 static void kick_khubd(struct usb_hub *hub)
584 spin_lock_irqsave(&hub_event_lock, flags);
585 if (!hub->disconnected && list_empty(&hub->event_list)) {
586 list_add_tail(&hub->event_list, &hub_event_list);
588 /* Suppress autosuspend until khubd runs */
589 usb_autopm_get_interface_no_resume(
590 to_usb_interface(hub->intfdev));
591 wake_up(&khubd_wait);
593 spin_unlock_irqrestore(&hub_event_lock, flags);
596 void usb_kick_khubd(struct usb_device *hdev)
598 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
605 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
606 * Notification, which indicates it had initiated remote wakeup.
608 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
609 * device initiates resume, so the USB core will not receive notice of the
610 * resume through the normal hub interrupt URB.
612 void usb_wakeup_notification(struct usb_device *hdev,
613 unsigned int portnum)
620 hub = usb_hub_to_struct_hub(hdev);
622 set_bit(portnum, hub->wakeup_bits);
626 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
628 /* completion function, fires on port status changes and various faults */
629 static void hub_irq(struct urb *urb)
631 struct usb_hub *hub = urb->context;
632 int status = urb->status;
637 case -ENOENT: /* synchronous unlink */
638 case -ECONNRESET: /* async unlink */
639 case -ESHUTDOWN: /* hardware going away */
642 default: /* presumably an error */
643 /* Cause a hub reset after 10 consecutive errors */
644 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
645 if ((++hub->nerrors < 10) || hub->error)
650 /* let khubd handle things */
651 case 0: /* we got data: port status changed */
653 for (i = 0; i < urb->actual_length; ++i)
654 bits |= ((unsigned long) ((*hub->buffer)[i]))
656 hub->event_bits[0] = bits;
662 /* Something happened, let khubd figure it out */
669 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
670 && status != -ENODEV && status != -EPERM)
671 dev_err (hub->intfdev, "resubmit --> %d\n", status);
674 /* USB 2.0 spec Section 11.24.2.3 */
676 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
678 /* Need to clear both directions for control ep */
679 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
680 USB_ENDPOINT_XFER_CONTROL) {
681 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
682 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
683 devinfo ^ 0x8000, tt, NULL, 0, 1000);
687 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
688 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
693 * enumeration blocks khubd for a long time. we use keventd instead, since
694 * long blocking there is the exception, not the rule. accordingly, HCDs
695 * talking to TTs must queue control transfers (not just bulk and iso), so
696 * both can talk to the same hub concurrently.
698 static void hub_tt_work(struct work_struct *work)
700 struct usb_hub *hub =
701 container_of(work, struct usb_hub, tt.clear_work);
704 spin_lock_irqsave (&hub->tt.lock, flags);
705 while (!list_empty(&hub->tt.clear_list)) {
706 struct list_head *next;
707 struct usb_tt_clear *clear;
708 struct usb_device *hdev = hub->hdev;
709 const struct hc_driver *drv;
712 next = hub->tt.clear_list.next;
713 clear = list_entry (next, struct usb_tt_clear, clear_list);
714 list_del (&clear->clear_list);
716 /* drop lock so HCD can concurrently report other TT errors */
717 spin_unlock_irqrestore (&hub->tt.lock, flags);
718 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
719 if (status && status != -ENODEV)
721 "clear tt %d (%04x) error %d\n",
722 clear->tt, clear->devinfo, status);
724 /* Tell the HCD, even if the operation failed */
725 drv = clear->hcd->driver;
726 if (drv->clear_tt_buffer_complete)
727 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
730 spin_lock_irqsave(&hub->tt.lock, flags);
732 spin_unlock_irqrestore (&hub->tt.lock, flags);
736 * usb_hub_set_port_power - control hub port's power state
737 * @hdev: USB device belonging to the usb hub
740 * @set: expected status
742 * call this function to control port's power via setting or
743 * clearing the port's PORT_POWER feature.
745 * Return: 0 if successful. A negative error code otherwise.
747 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
751 struct usb_port *port_dev = hub->ports[port1 - 1];
754 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
756 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
759 port_dev->power_is_on = set;
764 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
765 * @urb: an URB associated with the failed or incomplete split transaction
767 * High speed HCDs use this to tell the hub driver that some split control or
768 * bulk transaction failed in a way that requires clearing internal state of
769 * a transaction translator. This is normally detected (and reported) from
772 * It may not be possible for that hub to handle additional full (or low)
773 * speed transactions until that state is fully cleared out.
775 * Return: 0 if successful. A negative error code otherwise.
777 int usb_hub_clear_tt_buffer(struct urb *urb)
779 struct usb_device *udev = urb->dev;
780 int pipe = urb->pipe;
781 struct usb_tt *tt = udev->tt;
783 struct usb_tt_clear *clear;
785 /* we've got to cope with an arbitrary number of pending TT clears,
786 * since each TT has "at least two" buffers that can need it (and
787 * there can be many TTs per hub). even if they're uncommon.
789 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
790 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
791 /* FIXME recover somehow ... RESET_TT? */
795 /* info that CLEAR_TT_BUFFER needs */
796 clear->tt = tt->multi ? udev->ttport : 1;
797 clear->devinfo = usb_pipeendpoint (pipe);
798 clear->devinfo |= udev->devnum << 4;
799 clear->devinfo |= usb_pipecontrol (pipe)
800 ? (USB_ENDPOINT_XFER_CONTROL << 11)
801 : (USB_ENDPOINT_XFER_BULK << 11);
802 if (usb_pipein (pipe))
803 clear->devinfo |= 1 << 15;
805 /* info for completion callback */
806 clear->hcd = bus_to_hcd(udev->bus);
809 /* tell keventd to clear state for this TT */
810 spin_lock_irqsave (&tt->lock, flags);
811 list_add_tail (&clear->clear_list, &tt->clear_list);
812 schedule_work(&tt->clear_work);
813 spin_unlock_irqrestore (&tt->lock, flags);
816 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
818 /* If do_delay is false, return the number of milliseconds the caller
821 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
824 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
827 /* Enable power on each port. Some hubs have reserved values
828 * of LPSM (> 2) in their descriptors, even though they are
829 * USB 2.0 hubs. Some hubs do not implement port-power switching
830 * but only emulate it. In all cases, the ports won't work
831 * unless we send these messages to the hub.
833 if (hub_is_port_power_switchable(hub))
834 dev_dbg(hub->intfdev, "enabling power on all ports\n");
836 dev_dbg(hub->intfdev, "trying to enable port power on "
837 "non-switchable hub\n");
838 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
839 if (hub->ports[port1 - 1]->power_is_on)
840 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
842 usb_clear_port_feature(hub->hdev, port1,
843 USB_PORT_FEAT_POWER);
845 /* Wait at least 100 msec for power to become stable */
846 delay = max(pgood_delay, (unsigned) 100);
852 static int hub_hub_status(struct usb_hub *hub,
853 u16 *status, u16 *change)
857 mutex_lock(&hub->status_mutex);
858 ret = get_hub_status(hub->hdev, &hub->status->hub);
861 dev_err(hub->intfdev,
862 "%s failed (err = %d)\n", __func__, ret);
864 *status = le16_to_cpu(hub->status->hub.wHubStatus);
865 *change = le16_to_cpu(hub->status->hub.wHubChange);
868 mutex_unlock(&hub->status_mutex);
872 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
873 unsigned int link_status)
875 return set_port_feature(hub->hdev,
876 port1 | (link_status << 3),
877 USB_PORT_FEAT_LINK_STATE);
881 * If USB 3.0 ports are placed into the Disabled state, they will no longer
882 * detect any device connects or disconnects. This is generally not what the
883 * USB core wants, since it expects a disabled port to produce a port status
884 * change event when a new device connects.
886 * Instead, set the link state to Disabled, wait for the link to settle into
887 * that state, clear any change bits, and then put the port into the RxDetect
890 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
894 u16 portchange, portstatus;
896 if (!hub_is_superspeed(hub->hdev))
899 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
903 /* Wait for the link to enter the disabled state. */
904 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
905 ret = hub_port_status(hub, port1, &portstatus, &portchange);
909 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
910 USB_SS_PORT_LS_SS_DISABLED)
912 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
914 msleep(HUB_DEBOUNCE_STEP);
916 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
917 dev_warn(&hub->ports[port1 - 1]->dev,
918 "Could not disable after %d ms\n", total_time);
920 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
923 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
925 struct usb_port *port_dev = hub->ports[port1 - 1];
926 struct usb_device *hdev = hub->hdev;
929 if (port_dev->child && set_state)
930 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
932 if (hub_is_superspeed(hub->hdev))
933 ret = hub_usb3_port_disable(hub, port1);
935 ret = usb_clear_port_feature(hdev, port1,
936 USB_PORT_FEAT_ENABLE);
938 if (ret && ret != -ENODEV)
939 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
944 * Disable a port and mark a logical connect-change event, so that some
945 * time later khubd will disconnect() any existing usb_device on the port
946 * and will re-enumerate if there actually is a device attached.
948 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
950 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
951 hub_port_disable(hub, port1, 1);
953 /* FIXME let caller ask to power down the port:
954 * - some devices won't enumerate without a VBUS power cycle
955 * - SRP saves power that way
956 * - ... new call, TBD ...
957 * That's easy if this hub can switch power per-port, and
958 * khubd reactivates the port later (timer, SRP, etc).
959 * Powerdown must be optional, because of reset/DFU.
962 set_bit(port1, hub->change_bits);
967 * usb_remove_device - disable a device's port on its parent hub
968 * @udev: device to be disabled and removed
969 * Context: @udev locked, must be able to sleep.
971 * After @udev's port has been disabled, khubd is notified and it will
972 * see that the device has been disconnected. When the device is
973 * physically unplugged and something is plugged in, the events will
974 * be received and processed normally.
976 * Return: 0 if successful. A negative error code otherwise.
978 int usb_remove_device(struct usb_device *udev)
981 struct usb_interface *intf;
983 if (!udev->parent) /* Can't remove a root hub */
985 hub = usb_hub_to_struct_hub(udev->parent);
986 intf = to_usb_interface(hub->intfdev);
988 usb_autopm_get_interface(intf);
989 set_bit(udev->portnum, hub->removed_bits);
990 hub_port_logical_disconnect(hub, udev->portnum);
991 usb_autopm_put_interface(intf);
995 enum hub_activation_type {
996 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
997 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1000 static void hub_init_func2(struct work_struct *ws);
1001 static void hub_init_func3(struct work_struct *ws);
1003 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1005 struct usb_device *hdev = hub->hdev;
1006 struct usb_hcd *hcd;
1010 bool need_debounce_delay = false;
1013 /* Continue a partial initialization */
1014 if (type == HUB_INIT2)
1016 if (type == HUB_INIT3)
1019 /* The superspeed hub except for root hub has to use Hub Depth
1020 * value as an offset into the route string to locate the bits
1021 * it uses to determine the downstream port number. So hub driver
1022 * should send a set hub depth request to superspeed hub after
1023 * the superspeed hub is set configuration in initialization or
1026 * After a resume, port power should still be on.
1027 * For any other type of activation, turn it on.
1029 if (type != HUB_RESUME) {
1030 if (hdev->parent && hub_is_superspeed(hdev)) {
1031 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1032 HUB_SET_DEPTH, USB_RT_HUB,
1033 hdev->level - 1, 0, NULL, 0,
1034 USB_CTRL_SET_TIMEOUT);
1036 dev_err(hub->intfdev,
1037 "set hub depth failed\n");
1040 /* Speed up system boot by using a delayed_work for the
1041 * hub's initial power-up delays. This is pretty awkward
1042 * and the implementation looks like a home-brewed sort of
1043 * setjmp/longjmp, but it saves at least 100 ms for each
1044 * root hub (assuming usbcore is compiled into the kernel
1045 * rather than as a module). It adds up.
1047 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1048 * because for those activation types the ports have to be
1049 * operational when we return. In theory this could be done
1050 * for HUB_POST_RESET, but it's easier not to.
1052 if (type == HUB_INIT) {
1053 delay = hub_power_on(hub, false);
1054 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1055 queue_delayed_work(system_power_efficient_wq,
1057 msecs_to_jiffies(delay));
1059 /* Suppress autosuspend until init is done */
1060 usb_autopm_get_interface_no_resume(
1061 to_usb_interface(hub->intfdev));
1062 return; /* Continues at init2: below */
1063 } else if (type == HUB_RESET_RESUME) {
1064 /* The internal host controller state for the hub device
1065 * may be gone after a host power loss on system resume.
1066 * Update the device's info so the HW knows it's a hub.
1068 hcd = bus_to_hcd(hdev->bus);
1069 if (hcd->driver->update_hub_device) {
1070 ret = hcd->driver->update_hub_device(hcd, hdev,
1071 &hub->tt, GFP_NOIO);
1073 dev_err(hub->intfdev, "Host not "
1074 "accepting hub info "
1076 dev_err(hub->intfdev, "LS/FS devices "
1077 "and hubs may not work "
1078 "under this hub\n.");
1081 hub_power_on(hub, true);
1083 hub_power_on(hub, true);
1089 * Check each port and set hub->change_bits to let khubd know
1090 * which ports need attention.
1092 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1093 struct usb_port *port_dev = hub->ports[port1 - 1];
1094 struct usb_device *udev = port_dev->child;
1095 u16 portstatus, portchange;
1097 portstatus = portchange = 0;
1098 status = hub_port_status(hub, port1, &portstatus, &portchange);
1099 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1100 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1101 portstatus, portchange);
1104 * After anything other than HUB_RESUME (i.e., initialization
1105 * or any sort of reset), every port should be disabled.
1106 * Unconnected ports should likewise be disabled (paranoia),
1107 * and so should ports for which we have no usb_device.
1109 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1110 type != HUB_RESUME ||
1111 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1113 udev->state == USB_STATE_NOTATTACHED)) {
1115 * USB3 protocol ports will automatically transition
1116 * to Enabled state when detect an USB3.0 device attach.
1117 * Do not disable USB3 protocol ports, just pretend
1120 portstatus &= ~USB_PORT_STAT_ENABLE;
1121 if (!hub_is_superspeed(hdev))
1122 usb_clear_port_feature(hdev, port1,
1123 USB_PORT_FEAT_ENABLE);
1126 /* Clear status-change flags; we'll debounce later */
1127 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1128 need_debounce_delay = true;
1129 usb_clear_port_feature(hub->hdev, port1,
1130 USB_PORT_FEAT_C_CONNECTION);
1132 if (portchange & USB_PORT_STAT_C_ENABLE) {
1133 need_debounce_delay = true;
1134 usb_clear_port_feature(hub->hdev, port1,
1135 USB_PORT_FEAT_C_ENABLE);
1137 if (portchange & USB_PORT_STAT_C_RESET) {
1138 need_debounce_delay = true;
1139 usb_clear_port_feature(hub->hdev, port1,
1140 USB_PORT_FEAT_C_RESET);
1142 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1143 hub_is_superspeed(hub->hdev)) {
1144 need_debounce_delay = true;
1145 usb_clear_port_feature(hub->hdev, port1,
1146 USB_PORT_FEAT_C_BH_PORT_RESET);
1148 /* We can forget about a "removed" device when there's a
1149 * physical disconnect or the connect status changes.
1151 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1152 (portchange & USB_PORT_STAT_C_CONNECTION))
1153 clear_bit(port1, hub->removed_bits);
1155 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1156 /* Tell khubd to disconnect the device or
1157 * check for a new connection
1159 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1160 (portstatus & USB_PORT_STAT_OVERCURRENT))
1161 set_bit(port1, hub->change_bits);
1163 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1164 bool port_resumed = (portstatus &
1165 USB_PORT_STAT_LINK_STATE) ==
1167 /* The power session apparently survived the resume.
1168 * If there was an overcurrent or suspend change
1169 * (i.e., remote wakeup request), have khubd
1170 * take care of it. Look at the port link state
1171 * for USB 3.0 hubs, since they don't have a suspend
1172 * change bit, and they don't set the port link change
1173 * bit on device-initiated resume.
1175 if (portchange || (hub_is_superspeed(hub->hdev) &&
1177 set_bit(port1, hub->change_bits);
1179 } else if (udev->persist_enabled) {
1180 struct usb_port *port_dev = hub->ports[port1 - 1];
1183 udev->reset_resume = 1;
1185 /* Don't set the change_bits when the device
1188 if (port_dev->power_is_on)
1189 set_bit(port1, hub->change_bits);
1192 /* The power session is gone; tell khubd */
1193 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1194 set_bit(port1, hub->change_bits);
1198 /* If no port-status-change flags were set, we don't need any
1199 * debouncing. If flags were set we can try to debounce the
1200 * ports all at once right now, instead of letting khubd do them
1201 * one at a time later on.
1203 * If any port-status changes do occur during this delay, khubd
1204 * will see them later and handle them normally.
1206 if (need_debounce_delay) {
1207 delay = HUB_DEBOUNCE_STABLE;
1209 /* Don't do a long sleep inside a workqueue routine */
1210 if (type == HUB_INIT2) {
1211 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1212 queue_delayed_work(system_power_efficient_wq,
1214 msecs_to_jiffies(delay));
1215 return; /* Continues at init3: below */
1223 status = usb_submit_urb(hub->urb, GFP_NOIO);
1225 dev_err(hub->intfdev, "activate --> %d\n", status);
1226 if (hub->has_indicators && blinkenlights)
1227 queue_delayed_work(system_power_efficient_wq,
1228 &hub->leds, LED_CYCLE_PERIOD);
1230 /* Scan all ports that need attention */
1233 /* Allow autosuspend if it was suppressed */
1234 if (type <= HUB_INIT3)
1235 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1238 /* Implement the continuations for the delays above */
1239 static void hub_init_func2(struct work_struct *ws)
1241 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1243 hub_activate(hub, HUB_INIT2);
1246 static void hub_init_func3(struct work_struct *ws)
1248 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1250 hub_activate(hub, HUB_INIT3);
1253 enum hub_quiescing_type {
1254 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1257 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1259 struct usb_device *hdev = hub->hdev;
1262 cancel_delayed_work_sync(&hub->init_work);
1264 /* khubd and related activity won't re-trigger */
1267 if (type != HUB_SUSPEND) {
1268 /* Disconnect all the children */
1269 for (i = 0; i < hdev->maxchild; ++i) {
1270 if (hub->ports[i]->child)
1271 usb_disconnect(&hub->ports[i]->child);
1275 /* Stop khubd and related activity */
1276 usb_kill_urb(hub->urb);
1277 if (hub->has_indicators)
1278 cancel_delayed_work_sync(&hub->leds);
1280 flush_work(&hub->tt.clear_work);
1283 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1287 for (i = 0; i < hub->hdev->maxchild; ++i)
1288 pm_runtime_barrier(&hub->ports[i]->dev);
1291 /* caller has locked the hub device */
1292 static int hub_pre_reset(struct usb_interface *intf)
1294 struct usb_hub *hub = usb_get_intfdata(intf);
1296 hub_quiesce(hub, HUB_PRE_RESET);
1298 hub_pm_barrier_for_all_ports(hub);
1302 /* caller has locked the hub device */
1303 static int hub_post_reset(struct usb_interface *intf)
1305 struct usb_hub *hub = usb_get_intfdata(intf);
1308 hub_pm_barrier_for_all_ports(hub);
1309 hub_activate(hub, HUB_POST_RESET);
1313 static int hub_configure(struct usb_hub *hub,
1314 struct usb_endpoint_descriptor *endpoint)
1316 struct usb_hcd *hcd;
1317 struct usb_device *hdev = hub->hdev;
1318 struct device *hub_dev = hub->intfdev;
1319 u16 hubstatus, hubchange;
1320 u16 wHubCharacteristics;
1323 char *message = "out of memory";
1327 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1333 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1338 mutex_init(&hub->status_mutex);
1340 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1341 if (!hub->descriptor) {
1346 /* Request the entire hub descriptor.
1347 * hub->descriptor can handle USB_MAXCHILDREN ports,
1348 * but the hub can/will return fewer bytes here.
1350 ret = get_hub_descriptor(hdev, hub->descriptor);
1352 message = "can't read hub descriptor";
1354 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1355 message = "hub has too many ports!";
1358 } else if (hub->descriptor->bNbrPorts == 0) {
1359 message = "hub doesn't have any ports!";
1364 hdev->maxchild = hub->descriptor->bNbrPorts;
1365 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1366 (hdev->maxchild == 1) ? "" : "s");
1368 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1375 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1376 if (hub_is_superspeed(hdev)) {
1384 /* FIXME for USB 3.0, skip for now */
1385 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1386 !(hub_is_superspeed(hdev))) {
1388 char portstr[USB_MAXCHILDREN + 1];
1390 for (i = 0; i < hdev->maxchild; i++)
1391 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1392 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1394 portstr[hdev->maxchild] = 0;
1395 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1397 dev_dbg(hub_dev, "standalone hub\n");
1399 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1400 case HUB_CHAR_COMMON_LPSM:
1401 dev_dbg(hub_dev, "ganged power switching\n");
1403 case HUB_CHAR_INDV_PORT_LPSM:
1404 dev_dbg(hub_dev, "individual port power switching\n");
1406 case HUB_CHAR_NO_LPSM:
1408 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1412 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1413 case HUB_CHAR_COMMON_OCPM:
1414 dev_dbg(hub_dev, "global over-current protection\n");
1416 case HUB_CHAR_INDV_PORT_OCPM:
1417 dev_dbg(hub_dev, "individual port over-current protection\n");
1419 case HUB_CHAR_NO_OCPM:
1421 dev_dbg(hub_dev, "no over-current protection\n");
1425 spin_lock_init (&hub->tt.lock);
1426 INIT_LIST_HEAD (&hub->tt.clear_list);
1427 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1428 switch (hdev->descriptor.bDeviceProtocol) {
1431 case USB_HUB_PR_HS_SINGLE_TT:
1432 dev_dbg(hub_dev, "Single TT\n");
1435 case USB_HUB_PR_HS_MULTI_TT:
1436 ret = usb_set_interface(hdev, 0, 1);
1438 dev_dbg(hub_dev, "TT per port\n");
1441 dev_err(hub_dev, "Using single TT (err %d)\n",
1446 /* USB 3.0 hubs don't have a TT */
1449 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1450 hdev->descriptor.bDeviceProtocol);
1454 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1455 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1456 case HUB_TTTT_8_BITS:
1457 if (hdev->descriptor.bDeviceProtocol != 0) {
1458 hub->tt.think_time = 666;
1459 dev_dbg(hub_dev, "TT requires at most %d "
1460 "FS bit times (%d ns)\n",
1461 8, hub->tt.think_time);
1464 case HUB_TTTT_16_BITS:
1465 hub->tt.think_time = 666 * 2;
1466 dev_dbg(hub_dev, "TT requires at most %d "
1467 "FS bit times (%d ns)\n",
1468 16, hub->tt.think_time);
1470 case HUB_TTTT_24_BITS:
1471 hub->tt.think_time = 666 * 3;
1472 dev_dbg(hub_dev, "TT requires at most %d "
1473 "FS bit times (%d ns)\n",
1474 24, hub->tt.think_time);
1476 case HUB_TTTT_32_BITS:
1477 hub->tt.think_time = 666 * 4;
1478 dev_dbg(hub_dev, "TT requires at most %d "
1479 "FS bit times (%d ns)\n",
1480 32, hub->tt.think_time);
1484 /* probe() zeroes hub->indicator[] */
1485 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1486 hub->has_indicators = 1;
1487 dev_dbg(hub_dev, "Port indicators are supported\n");
1490 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1491 hub->descriptor->bPwrOn2PwrGood * 2);
1493 /* power budgeting mostly matters with bus-powered hubs,
1494 * and battery-powered root hubs (may provide just 8 mA).
1496 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1498 message = "can't get hub status";
1501 hcd = bus_to_hcd(hdev->bus);
1502 if (hdev == hdev->bus->root_hub) {
1503 if (hcd->power_budget > 0)
1504 hdev->bus_mA = hcd->power_budget;
1506 hdev->bus_mA = full_load * hdev->maxchild;
1507 if (hdev->bus_mA >= full_load)
1508 hub->mA_per_port = full_load;
1510 hub->mA_per_port = hdev->bus_mA;
1511 hub->limited_power = 1;
1513 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1514 int remaining = hdev->bus_mA -
1515 hub->descriptor->bHubContrCurrent;
1517 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1518 hub->descriptor->bHubContrCurrent);
1519 hub->limited_power = 1;
1521 if (remaining < hdev->maxchild * unit_load)
1523 "insufficient power available "
1524 "to use all downstream ports\n");
1525 hub->mA_per_port = unit_load; /* 7.2.1 */
1527 } else { /* Self-powered external hub */
1528 /* FIXME: What about battery-powered external hubs that
1529 * provide less current per port? */
1530 hub->mA_per_port = full_load;
1532 if (hub->mA_per_port < full_load)
1533 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1536 /* Update the HCD's internal representation of this hub before khubd
1537 * starts getting port status changes for devices under the hub.
1539 if (hcd->driver->update_hub_device) {
1540 ret = hcd->driver->update_hub_device(hcd, hdev,
1541 &hub->tt, GFP_KERNEL);
1543 message = "can't update HCD hub info";
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 for (i = 0; i < hdev->maxchild; i++) {
1590 ret = usb_hub_create_port_device(hub, i + 1);
1592 dev_err(hub->intfdev,
1593 "couldn't create port%d device.\n", i + 1);
1595 goto fail_keep_maxchild;
1599 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1601 hub_activate(hub, HUB_INIT);
1607 dev_err (hub_dev, "config failed, %s (err %d)\n",
1609 /* hub_disconnect() frees urb and descriptor */
1613 static void hub_release(struct kref *kref)
1615 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1617 usb_put_intf(to_usb_interface(hub->intfdev));
1621 static unsigned highspeed_hubs;
1623 static void hub_disconnect(struct usb_interface *intf)
1625 struct usb_hub *hub = usb_get_intfdata(intf);
1626 struct usb_device *hdev = interface_to_usbdev(intf);
1629 /* Take the hub off the event list and don't let it be added again */
1630 spin_lock_irq(&hub_event_lock);
1631 if (!list_empty(&hub->event_list)) {
1632 list_del_init(&hub->event_list);
1633 usb_autopm_put_interface_no_suspend(intf);
1635 hub->disconnected = 1;
1636 spin_unlock_irq(&hub_event_lock);
1638 /* Disconnect all children and quiesce the hub */
1640 hub_quiesce(hub, HUB_DISCONNECT);
1642 /* Avoid races with recursively_mark_NOTATTACHED() */
1643 spin_lock_irq(&device_state_lock);
1644 port1 = hdev->maxchild;
1646 usb_set_intfdata(intf, NULL);
1647 spin_unlock_irq(&device_state_lock);
1649 for (; port1 > 0; --port1)
1650 usb_hub_remove_port_device(hub, port1);
1652 if (hub->hdev->speed == USB_SPEED_HIGH)
1655 usb_free_urb(hub->urb);
1657 kfree(hub->descriptor);
1661 pm_suspend_ignore_children(&intf->dev, false);
1662 kref_put(&hub->kref, hub_release);
1665 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1667 struct usb_host_interface *desc;
1668 struct usb_endpoint_descriptor *endpoint;
1669 struct usb_device *hdev;
1670 struct usb_hub *hub;
1672 desc = intf->cur_altsetting;
1673 hdev = interface_to_usbdev(intf);
1676 * Set default autosuspend delay as 0 to speedup bus suspend,
1677 * based on the below considerations:
1679 * - Unlike other drivers, the hub driver does not rely on the
1680 * autosuspend delay to provide enough time to handle a wakeup
1681 * event, and the submitted status URB is just to check future
1682 * change on hub downstream ports, so it is safe to do it.
1684 * - The patch might cause one or more auto supend/resume for
1685 * below very rare devices when they are plugged into hub
1688 * devices having trouble initializing, and disconnect
1689 * themselves from the bus and then reconnect a second
1692 * devices just for downloading firmware, and disconnects
1693 * themselves after completing it
1695 * For these quite rare devices, their drivers may change the
1696 * autosuspend delay of their parent hub in the probe() to one
1697 * appropriate value to avoid the subtle problem if someone
1700 * - The patch may cause one or more auto suspend/resume on
1701 * hub during running 'lsusb', but it is probably too
1702 * infrequent to worry about.
1704 * - Change autosuspend delay of hub can avoid unnecessary auto
1705 * suspend timer for hub, also may decrease power consumption
1708 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1710 /* Hubs have proper suspend/resume support. */
1711 usb_enable_autosuspend(hdev);
1713 if (hdev->level == MAX_TOPO_LEVEL) {
1715 "Unsupported bus topology: hub nested too deep\n");
1719 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1721 dev_warn(&intf->dev, "ignoring external hub\n");
1726 /* Some hubs have a subclass of 1, which AFAICT according to the */
1727 /* specs is not defined, but it works */
1728 if ((desc->desc.bInterfaceSubClass != 0) &&
1729 (desc->desc.bInterfaceSubClass != 1)) {
1731 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1735 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1736 if (desc->desc.bNumEndpoints != 1)
1737 goto descriptor_error;
1739 endpoint = &desc->endpoint[0].desc;
1741 /* If it's not an interrupt in endpoint, we'd better punt! */
1742 if (!usb_endpoint_is_int_in(endpoint))
1743 goto descriptor_error;
1745 /* We found a hub */
1746 dev_info (&intf->dev, "USB hub found\n");
1748 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1750 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1754 kref_init(&hub->kref);
1755 INIT_LIST_HEAD(&hub->event_list);
1756 hub->intfdev = &intf->dev;
1758 INIT_DELAYED_WORK(&hub->leds, led_work);
1759 INIT_DELAYED_WORK(&hub->init_work, NULL);
1762 usb_set_intfdata (intf, hub);
1763 intf->needs_remote_wakeup = 1;
1764 pm_suspend_ignore_children(&intf->dev, true);
1766 if (hdev->speed == USB_SPEED_HIGH)
1769 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1770 hub->quirk_check_port_auto_suspend = 1;
1772 if (hub_configure(hub, endpoint) >= 0)
1775 hub_disconnect (intf);
1780 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1782 struct usb_device *hdev = interface_to_usbdev (intf);
1783 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1785 /* assert ifno == 0 (part of hub spec) */
1787 case USBDEVFS_HUB_PORTINFO: {
1788 struct usbdevfs_hub_portinfo *info = user_data;
1791 spin_lock_irq(&device_state_lock);
1792 if (hdev->devnum <= 0)
1795 info->nports = hdev->maxchild;
1796 for (i = 0; i < info->nports; i++) {
1797 if (hub->ports[i]->child == NULL)
1801 hub->ports[i]->child->devnum;
1804 spin_unlock_irq(&device_state_lock);
1806 return info->nports + 1;
1815 * Allow user programs to claim ports on a hub. When a device is attached
1816 * to one of these "claimed" ports, the program will "own" the device.
1818 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1819 struct usb_dev_state ***ppowner)
1821 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1823 if (hdev->state == USB_STATE_NOTATTACHED)
1825 if (port1 == 0 || port1 > hdev->maxchild)
1828 /* Devices not managed by the hub driver
1829 * will always have maxchild equal to 0.
1831 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1835 /* In the following three functions, the caller must hold hdev's lock */
1836 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1837 struct usb_dev_state *owner)
1840 struct usb_dev_state **powner;
1842 rc = find_port_owner(hdev, port1, &powner);
1850 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1852 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1853 struct usb_dev_state *owner)
1856 struct usb_dev_state **powner;
1858 rc = find_port_owner(hdev, port1, &powner);
1861 if (*powner != owner)
1866 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1868 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1870 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1873 for (n = 0; n < hdev->maxchild; n++) {
1874 if (hub->ports[n]->port_owner == owner)
1875 hub->ports[n]->port_owner = NULL;
1880 /* The caller must hold udev's lock */
1881 bool usb_device_is_owned(struct usb_device *udev)
1883 struct usb_hub *hub;
1885 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1887 hub = usb_hub_to_struct_hub(udev->parent);
1888 return !!hub->ports[udev->portnum - 1]->port_owner;
1891 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1893 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1896 for (i = 0; i < udev->maxchild; ++i) {
1897 if (hub->ports[i]->child)
1898 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1900 if (udev->state == USB_STATE_SUSPENDED)
1901 udev->active_duration -= jiffies;
1902 udev->state = USB_STATE_NOTATTACHED;
1906 * usb_set_device_state - change a device's current state (usbcore, hcds)
1907 * @udev: pointer to device whose state should be changed
1908 * @new_state: new state value to be stored
1910 * udev->state is _not_ fully protected by the device lock. Although
1911 * most transitions are made only while holding the lock, the state can
1912 * can change to USB_STATE_NOTATTACHED at almost any time. This
1913 * is so that devices can be marked as disconnected as soon as possible,
1914 * without having to wait for any semaphores to be released. As a result,
1915 * all changes to any device's state must be protected by the
1916 * device_state_lock spinlock.
1918 * Once a device has been added to the device tree, all changes to its state
1919 * should be made using this routine. The state should _not_ be set directly.
1921 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1922 * Otherwise udev->state is set to new_state, and if new_state is
1923 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1924 * to USB_STATE_NOTATTACHED.
1926 void usb_set_device_state(struct usb_device *udev,
1927 enum usb_device_state new_state)
1929 unsigned long flags;
1932 spin_lock_irqsave(&device_state_lock, flags);
1933 if (udev->state == USB_STATE_NOTATTACHED)
1935 else if (new_state != USB_STATE_NOTATTACHED) {
1937 /* root hub wakeup capabilities are managed out-of-band
1938 * and may involve silicon errata ... ignore them here.
1941 if (udev->state == USB_STATE_SUSPENDED
1942 || new_state == USB_STATE_SUSPENDED)
1943 ; /* No change to wakeup settings */
1944 else if (new_state == USB_STATE_CONFIGURED)
1945 wakeup = udev->actconfig->desc.bmAttributes
1946 & USB_CONFIG_ATT_WAKEUP;
1950 if (udev->state == USB_STATE_SUSPENDED &&
1951 new_state != USB_STATE_SUSPENDED)
1952 udev->active_duration -= jiffies;
1953 else if (new_state == USB_STATE_SUSPENDED &&
1954 udev->state != USB_STATE_SUSPENDED)
1955 udev->active_duration += jiffies;
1956 udev->state = new_state;
1958 recursively_mark_NOTATTACHED(udev);
1959 spin_unlock_irqrestore(&device_state_lock, flags);
1961 device_set_wakeup_capable(&udev->dev, wakeup);
1963 EXPORT_SYMBOL_GPL(usb_set_device_state);
1966 * Choose a device number.
1968 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1969 * USB-2.0 buses they are also used as device addresses, however on
1970 * USB-3.0 buses the address is assigned by the controller hardware
1971 * and it usually is not the same as the device number.
1973 * WUSB devices are simple: they have no hubs behind, so the mapping
1974 * device <-> virtual port number becomes 1:1. Why? to simplify the
1975 * life of the device connection logic in
1976 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1977 * handshake we need to assign a temporary address in the unauthorized
1978 * space. For simplicity we use the first virtual port number found to
1979 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1980 * and that becomes it's address [X < 128] or its unauthorized address
1983 * We add 1 as an offset to the one-based USB-stack port number
1984 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1985 * 0 is reserved by USB for default address; (b) Linux's USB stack
1986 * uses always #1 for the root hub of the controller. So USB stack's
1987 * port #1, which is wusb virtual-port #0 has address #2.
1989 * Devices connected under xHCI are not as simple. The host controller
1990 * supports virtualization, so the hardware assigns device addresses and
1991 * the HCD must setup data structures before issuing a set address
1992 * command to the hardware.
1994 static void choose_devnum(struct usb_device *udev)
1997 struct usb_bus *bus = udev->bus;
1999 /* If khubd ever becomes multithreaded, this will need a lock */
2001 devnum = udev->portnum + 1;
2002 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2004 /* Try to allocate the next devnum beginning at
2005 * bus->devnum_next. */
2006 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2009 devnum = find_next_zero_bit(bus->devmap.devicemap,
2011 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2014 set_bit(devnum, bus->devmap.devicemap);
2015 udev->devnum = devnum;
2019 static void release_devnum(struct usb_device *udev)
2021 if (udev->devnum > 0) {
2022 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2027 static void update_devnum(struct usb_device *udev, int devnum)
2029 /* The address for a WUSB device is managed by wusbcore. */
2031 udev->devnum = devnum;
2034 static void hub_free_dev(struct usb_device *udev)
2036 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2038 /* Root hubs aren't real devices, so don't free HCD resources */
2039 if (hcd->driver->free_dev && udev->parent)
2040 hcd->driver->free_dev(hcd, udev);
2044 * usb_disconnect - disconnect a device (usbcore-internal)
2045 * @pdev: pointer to device being disconnected
2046 * Context: !in_interrupt ()
2048 * Something got disconnected. Get rid of it and all of its children.
2050 * If *pdev is a normal device then the parent hub must already be locked.
2051 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2052 * which protects the set of root hubs as well as the list of buses.
2054 * Only hub drivers (including virtual root hub drivers for host
2055 * controllers) should ever call this.
2057 * This call is synchronous, and may not be used in an interrupt context.
2059 void usb_disconnect(struct usb_device **pdev)
2061 struct usb_device *udev = *pdev;
2062 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2065 /* mark the device as inactive, so any further urb submissions for
2066 * this device (and any of its children) will fail immediately.
2067 * this quiesces everything except pending urbs.
2069 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2070 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2073 usb_lock_device(udev);
2075 /* Free up all the children before we remove this device */
2076 for (i = 0; i < udev->maxchild; i++) {
2077 if (hub->ports[i]->child)
2078 usb_disconnect(&hub->ports[i]->child);
2081 /* deallocate hcd/hardware state ... nuking all pending urbs and
2082 * cleaning up all state associated with the current configuration
2083 * so that the hardware is now fully quiesced.
2085 dev_dbg (&udev->dev, "unregistering device\n");
2086 usb_disable_device(udev, 0);
2087 usb_hcd_synchronize_unlinks(udev);
2090 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2091 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2093 sysfs_remove_link(&udev->dev.kobj, "port");
2094 sysfs_remove_link(&port_dev->dev.kobj, "device");
2096 if (!port_dev->did_runtime_put)
2097 pm_runtime_put(&port_dev->dev);
2099 port_dev->did_runtime_put = false;
2102 usb_remove_ep_devs(&udev->ep0);
2103 usb_unlock_device(udev);
2105 /* Unregister the device. The device driver is responsible
2106 * for de-configuring the device and invoking the remove-device
2107 * notifier chain (used by usbfs and possibly others).
2109 device_del(&udev->dev);
2111 /* Free the device number and delete the parent's children[]
2112 * (or root_hub) pointer.
2114 release_devnum(udev);
2116 /* Avoid races with recursively_mark_NOTATTACHED() */
2117 spin_lock_irq(&device_state_lock);
2119 spin_unlock_irq(&device_state_lock);
2123 put_device(&udev->dev);
2126 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2127 static void show_string(struct usb_device *udev, char *id, char *string)
2131 dev_info(&udev->dev, "%s: %s\n", id, string);
2134 static void announce_device(struct usb_device *udev)
2136 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2137 le16_to_cpu(udev->descriptor.idVendor),
2138 le16_to_cpu(udev->descriptor.idProduct));
2139 dev_info(&udev->dev,
2140 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2141 udev->descriptor.iManufacturer,
2142 udev->descriptor.iProduct,
2143 udev->descriptor.iSerialNumber);
2144 show_string(udev, "Product", udev->product);
2145 show_string(udev, "Manufacturer", udev->manufacturer);
2146 show_string(udev, "SerialNumber", udev->serial);
2149 static inline void announce_device(struct usb_device *udev) { }
2152 #ifdef CONFIG_USB_OTG
2153 #include "otg_whitelist.h"
2157 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2158 * @udev: newly addressed device (in ADDRESS state)
2160 * Finish enumeration for On-The-Go devices
2162 * Return: 0 if successful. A negative error code otherwise.
2164 static int usb_enumerate_device_otg(struct usb_device *udev)
2168 #ifdef CONFIG_USB_OTG
2170 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2171 * to wake us after we've powered off VBUS; and HNP, switching roles
2172 * "host" to "peripheral". The OTG descriptor helps figure this out.
2174 if (!udev->bus->is_b_host
2176 && udev->parent == udev->bus->root_hub) {
2177 struct usb_otg_descriptor *desc = NULL;
2178 struct usb_bus *bus = udev->bus;
2180 /* descriptor may appear anywhere in config */
2181 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2182 le16_to_cpu(udev->config[0].desc.wTotalLength),
2183 USB_DT_OTG, (void **) &desc) == 0) {
2184 if (desc->bmAttributes & USB_OTG_HNP) {
2185 unsigned port1 = udev->portnum;
2187 dev_info(&udev->dev,
2188 "Dual-Role OTG device on %sHNP port\n",
2189 (port1 == bus->otg_port)
2192 /* enable HNP before suspend, it's simpler */
2193 if (port1 == bus->otg_port)
2194 bus->b_hnp_enable = 1;
2195 err = usb_control_msg(udev,
2196 usb_sndctrlpipe(udev, 0),
2197 USB_REQ_SET_FEATURE, 0,
2199 ? USB_DEVICE_B_HNP_ENABLE
2200 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2201 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2203 /* OTG MESSAGE: report errors here,
2204 * customize to match your product.
2206 dev_info(&udev->dev,
2207 "can't set HNP mode: %d\n",
2209 bus->b_hnp_enable = 0;
2215 if (!is_targeted(udev)) {
2217 /* Maybe it can talk to us, though we can't talk to it.
2218 * (Includes HNP test device.)
2220 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2221 err = usb_port_suspend(udev, PMSG_SUSPEND);
2223 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2235 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2236 * @udev: newly addressed device (in ADDRESS state)
2238 * This is only called by usb_new_device() and usb_authorize_device()
2239 * and FIXME -- all comments that apply to them apply here wrt to
2242 * If the device is WUSB and not authorized, we don't attempt to read
2243 * the string descriptors, as they will be errored out by the device
2244 * until it has been authorized.
2246 * Return: 0 if successful. A negative error code otherwise.
2248 static int usb_enumerate_device(struct usb_device *udev)
2252 if (udev->config == NULL) {
2253 err = usb_get_configuration(udev);
2256 dev_err(&udev->dev, "can't read configurations, error %d\n",
2262 /* read the standard strings and cache them if present */
2263 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2264 udev->manufacturer = usb_cache_string(udev,
2265 udev->descriptor.iManufacturer);
2266 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2268 err = usb_enumerate_device_otg(udev);
2272 usb_detect_interface_quirks(udev);
2277 static void set_usb_port_removable(struct usb_device *udev)
2279 struct usb_device *hdev = udev->parent;
2280 struct usb_hub *hub;
2281 u8 port = udev->portnum;
2282 u16 wHubCharacteristics;
2283 bool removable = true;
2288 hub = usb_hub_to_struct_hub(udev->parent);
2290 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2292 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2295 if (hub_is_superspeed(hdev)) {
2296 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2300 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2305 udev->removable = USB_DEVICE_REMOVABLE;
2307 udev->removable = USB_DEVICE_FIXED;
2310 * Platform firmware may have populated an alternative value for
2311 * removable. If the parent port has a known connect_type use
2314 switch (hub->ports[udev->portnum - 1]->connect_type) {
2315 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2316 udev->removable = USB_DEVICE_REMOVABLE;
2318 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2319 udev->removable = USB_DEVICE_FIXED;
2321 default: /* use what was set above */
2327 * usb_new_device - perform initial device setup (usbcore-internal)
2328 * @udev: newly addressed device (in ADDRESS state)
2330 * This is called with devices which have been detected but not fully
2331 * enumerated. The device descriptor is available, but not descriptors
2332 * for any device configuration. The caller must have locked either
2333 * the parent hub (if udev is a normal device) or else the
2334 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2335 * udev has already been installed, but udev is not yet visible through
2336 * sysfs or other filesystem code.
2338 * This call is synchronous, and may not be used in an interrupt context.
2340 * Only the hub driver or root-hub registrar should ever call this.
2342 * Return: Whether the device is configured properly or not. Zero if the
2343 * interface was registered with the driver core; else a negative errno
2347 int usb_new_device(struct usb_device *udev)
2352 /* Initialize non-root-hub device wakeup to disabled;
2353 * device (un)configuration controls wakeup capable
2354 * sysfs power/wakeup controls wakeup enabled/disabled
2356 device_init_wakeup(&udev->dev, 0);
2359 /* Tell the runtime-PM framework the device is active */
2360 pm_runtime_set_active(&udev->dev);
2361 pm_runtime_get_noresume(&udev->dev);
2362 pm_runtime_use_autosuspend(&udev->dev);
2363 pm_runtime_enable(&udev->dev);
2365 /* By default, forbid autosuspend for all devices. It will be
2366 * allowed for hubs during binding.
2368 usb_disable_autosuspend(udev);
2370 err = usb_enumerate_device(udev); /* Read descriptors */
2373 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2374 udev->devnum, udev->bus->busnum,
2375 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2376 /* export the usbdev device-node for libusb */
2377 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2378 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2380 /* Tell the world! */
2381 announce_device(udev);
2384 add_device_randomness(udev->serial, strlen(udev->serial));
2386 add_device_randomness(udev->product, strlen(udev->product));
2387 if (udev->manufacturer)
2388 add_device_randomness(udev->manufacturer,
2389 strlen(udev->manufacturer));
2391 device_enable_async_suspend(&udev->dev);
2393 /* check whether the hub or firmware marks this port as non-removable */
2395 set_usb_port_removable(udev);
2397 /* Register the device. The device driver is responsible
2398 * for configuring the device and invoking the add-device
2399 * notifier chain (used by usbfs and possibly others).
2401 err = device_add(&udev->dev);
2403 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2407 /* Create link files between child device and usb port device. */
2409 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2410 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2412 err = sysfs_create_link(&udev->dev.kobj,
2413 &port_dev->dev.kobj, "port");
2417 err = sysfs_create_link(&port_dev->dev.kobj,
2418 &udev->dev.kobj, "device");
2420 sysfs_remove_link(&udev->dev.kobj, "port");
2424 pm_runtime_get_sync(&port_dev->dev);
2427 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2428 usb_mark_last_busy(udev);
2429 pm_runtime_put_sync_autosuspend(&udev->dev);
2433 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2434 pm_runtime_disable(&udev->dev);
2435 pm_runtime_set_suspended(&udev->dev);
2441 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2442 * @usb_dev: USB device
2444 * Move the USB device to a very basic state where interfaces are disabled
2445 * and the device is in fact unconfigured and unusable.
2447 * We share a lock (that we have) with device_del(), so we need to
2452 int usb_deauthorize_device(struct usb_device *usb_dev)
2454 usb_lock_device(usb_dev);
2455 if (usb_dev->authorized == 0)
2456 goto out_unauthorized;
2458 usb_dev->authorized = 0;
2459 usb_set_configuration(usb_dev, -1);
2462 usb_unlock_device(usb_dev);
2467 int usb_authorize_device(struct usb_device *usb_dev)
2471 usb_lock_device(usb_dev);
2472 if (usb_dev->authorized == 1)
2473 goto out_authorized;
2475 result = usb_autoresume_device(usb_dev);
2477 dev_err(&usb_dev->dev,
2478 "can't autoresume for authorization: %d\n", result);
2479 goto error_autoresume;
2481 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2483 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2484 "authorization: %d\n", result);
2485 goto error_device_descriptor;
2488 usb_dev->authorized = 1;
2489 /* Choose and set the configuration. This registers the interfaces
2490 * with the driver core and lets interface drivers bind to them.
2492 c = usb_choose_configuration(usb_dev);
2494 result = usb_set_configuration(usb_dev, c);
2496 dev_err(&usb_dev->dev,
2497 "can't set config #%d, error %d\n", c, result);
2498 /* This need not be fatal. The user can try to
2499 * set other configurations. */
2502 dev_info(&usb_dev->dev, "authorized to connect\n");
2504 error_device_descriptor:
2505 usb_autosuspend_device(usb_dev);
2508 usb_unlock_device(usb_dev); /* complements locktree */
2513 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2514 static unsigned hub_is_wusb(struct usb_hub *hub)
2516 struct usb_hcd *hcd;
2517 if (hub->hdev->parent != NULL) /* not a root hub? */
2519 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2520 return hcd->wireless;
2524 #define PORT_RESET_TRIES 5
2525 #define SET_ADDRESS_TRIES 2
2526 #define GET_DESCRIPTOR_TRIES 2
2527 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2528 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2530 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2531 #define HUB_SHORT_RESET_TIME 10
2532 #define HUB_BH_RESET_TIME 50
2533 #define HUB_LONG_RESET_TIME 200
2534 #define HUB_RESET_TIMEOUT 800
2537 * "New scheme" enumeration causes an extra state transition to be
2538 * exposed to an xhci host and causes USB3 devices to receive control
2539 * commands in the default state. This has been seen to cause
2540 * enumeration failures, so disable this enumeration scheme for USB3
2543 static bool use_new_scheme(struct usb_device *udev, int retry)
2545 if (udev->speed == USB_SPEED_SUPER)
2548 return USE_NEW_SCHEME(retry);
2551 static int hub_port_reset(struct usb_hub *hub, int port1,
2552 struct usb_device *udev, unsigned int delay, bool warm);
2554 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2555 * Port worm reset is required to recover
2557 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2559 return hub_is_superspeed(hub->hdev) &&
2560 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2561 USB_SS_PORT_LS_SS_INACTIVE) ||
2562 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2563 USB_SS_PORT_LS_COMP_MOD)) ;
2566 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2567 struct usb_device *udev, unsigned int delay, bool warm)
2569 int delay_time, ret;
2573 for (delay_time = 0;
2574 delay_time < HUB_RESET_TIMEOUT;
2575 delay_time += delay) {
2576 /* wait to give the device a chance to reset */
2579 /* read and decode port status */
2580 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2584 /* The port state is unknown until the reset completes. */
2585 if (!(portstatus & USB_PORT_STAT_RESET))
2588 /* switch to the long delay after two short delay failures */
2589 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2590 delay = HUB_LONG_RESET_TIME;
2592 dev_dbg(&hub->ports[port1 - 1]->dev,
2593 "not %sreset yet, waiting %dms\n",
2594 warm ? "warm " : "", delay);
2597 if ((portstatus & USB_PORT_STAT_RESET))
2600 if (hub_port_warm_reset_required(hub, portstatus))
2603 /* Device went away? */
2604 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2607 /* bomb out completely if the connection bounced. A USB 3.0
2608 * connection may bounce if multiple warm resets were issued,
2609 * but the device may have successfully re-connected. Ignore it.
2611 if (!hub_is_superspeed(hub->hdev) &&
2612 (portchange & USB_PORT_STAT_C_CONNECTION))
2615 if (!(portstatus & USB_PORT_STAT_ENABLE))
2621 if (hub_is_wusb(hub))
2622 udev->speed = USB_SPEED_WIRELESS;
2623 else if (hub_is_superspeed(hub->hdev))
2624 udev->speed = USB_SPEED_SUPER;
2625 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2626 udev->speed = USB_SPEED_HIGH;
2627 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2628 udev->speed = USB_SPEED_LOW;
2630 udev->speed = USB_SPEED_FULL;
2634 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2635 struct usb_device *udev, int *status)
2639 /* TRSTRCY = 10 ms; plus some extra */
2642 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2644 update_devnum(udev, 0);
2645 /* The xHC may think the device is already reset,
2646 * so ignore the status.
2648 if (hcd->driver->reset_device)
2649 hcd->driver->reset_device(hcd, udev);
2654 usb_clear_port_feature(hub->hdev,
2655 port1, USB_PORT_FEAT_C_RESET);
2656 if (hub_is_superspeed(hub->hdev)) {
2657 usb_clear_port_feature(hub->hdev, port1,
2658 USB_PORT_FEAT_C_BH_PORT_RESET);
2659 usb_clear_port_feature(hub->hdev, port1,
2660 USB_PORT_FEAT_C_PORT_LINK_STATE);
2661 usb_clear_port_feature(hub->hdev, port1,
2662 USB_PORT_FEAT_C_CONNECTION);
2665 usb_set_device_state(udev, *status
2666 ? USB_STATE_NOTATTACHED
2667 : USB_STATE_DEFAULT);
2672 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2673 static int hub_port_reset(struct usb_hub *hub, int port1,
2674 struct usb_device *udev, unsigned int delay, bool warm)
2677 u16 portchange, portstatus;
2678 struct usb_port *port_dev = hub->ports[port1 - 1];
2680 if (!hub_is_superspeed(hub->hdev)) {
2682 dev_err(hub->intfdev, "only USB3 hub support "
2686 /* Block EHCI CF initialization during the port reset.
2687 * Some companion controllers don't like it when they mix.
2689 down_read(&ehci_cf_port_reset_rwsem);
2692 * If the caller hasn't explicitly requested a warm reset,
2693 * double check and see if one is needed.
2695 status = hub_port_status(hub, port1,
2696 &portstatus, &portchange);
2700 if (hub_port_warm_reset_required(hub, portstatus))
2704 /* Reset the port */
2705 for (i = 0; i < PORT_RESET_TRIES; i++) {
2706 status = set_port_feature(hub->hdev, port1, (warm ?
2707 USB_PORT_FEAT_BH_PORT_RESET :
2708 USB_PORT_FEAT_RESET));
2709 if (status == -ENODEV) {
2710 ; /* The hub is gone */
2711 } else if (status) {
2712 dev_err(&port_dev->dev,
2713 "cannot %sreset (err = %d)\n",
2714 warm ? "warm " : "", status);
2716 status = hub_port_wait_reset(hub, port1, udev, delay,
2718 if (status && status != -ENOTCONN && status != -ENODEV)
2719 dev_dbg(hub->intfdev,
2720 "port_wait_reset: err = %d\n",
2724 /* Check for disconnect or reset */
2725 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2726 hub_port_finish_reset(hub, port1, udev, &status);
2728 if (!hub_is_superspeed(hub->hdev))
2732 * If a USB 3.0 device migrates from reset to an error
2733 * state, re-issue the warm reset.
2735 if (hub_port_status(hub, port1,
2736 &portstatus, &portchange) < 0)
2739 if (!hub_port_warm_reset_required(hub, portstatus))
2743 * If the port is in SS.Inactive or Compliance Mode, the
2744 * hot or warm reset failed. Try another warm reset.
2747 dev_dbg(&port_dev->dev,
2748 "hot reset failed, warm reset\n");
2753 dev_dbg(&port_dev->dev,
2754 "not enabled, trying %sreset again...\n",
2755 warm ? "warm " : "");
2756 delay = HUB_LONG_RESET_TIME;
2759 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2762 if (!hub_is_superspeed(hub->hdev))
2763 up_read(&ehci_cf_port_reset_rwsem);
2768 /* Check if a port is power on */
2769 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2773 if (hub_is_superspeed(hub->hdev)) {
2774 if (portstatus & USB_SS_PORT_STAT_POWER)
2777 if (portstatus & USB_PORT_STAT_POWER)
2786 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2787 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2791 if (hub_is_superspeed(hub->hdev)) {
2792 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2793 == USB_SS_PORT_LS_U3)
2796 if (portstatus & USB_PORT_STAT_SUSPEND)
2803 /* Determine whether the device on a port is ready for a normal resume,
2804 * is ready for a reset-resume, or should be disconnected.
2806 static int check_port_resume_type(struct usb_device *udev,
2807 struct usb_hub *hub, int port1,
2808 int status, unsigned portchange, unsigned portstatus)
2810 struct usb_port *port_dev = hub->ports[port1 - 1];
2812 /* Is the device still present? */
2813 if (status || port_is_suspended(hub, portstatus) ||
2814 !port_is_power_on(hub, portstatus) ||
2815 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2820 /* Can't do a normal resume if the port isn't enabled,
2821 * so try a reset-resume instead.
2823 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2824 if (udev->persist_enabled)
2825 udev->reset_resume = 1;
2831 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2832 portchange, portstatus, status);
2833 } else if (udev->reset_resume) {
2835 /* Late port handoff can set status-change bits */
2836 if (portchange & USB_PORT_STAT_C_CONNECTION)
2837 usb_clear_port_feature(hub->hdev, port1,
2838 USB_PORT_FEAT_C_CONNECTION);
2839 if (portchange & USB_PORT_STAT_C_ENABLE)
2840 usb_clear_port_feature(hub->hdev, port1,
2841 USB_PORT_FEAT_C_ENABLE);
2847 int usb_disable_ltm(struct usb_device *udev)
2849 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2851 /* Check if the roothub and device supports LTM. */
2852 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2853 !usb_device_supports_ltm(udev))
2856 /* Clear Feature LTM Enable can only be sent if the device is
2859 if (!udev->actconfig)
2862 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2863 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2864 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2865 USB_CTRL_SET_TIMEOUT);
2867 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2869 void usb_enable_ltm(struct usb_device *udev)
2871 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2873 /* Check if the roothub and device supports LTM. */
2874 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2875 !usb_device_supports_ltm(udev))
2878 /* Set Feature LTM Enable can only be sent if the device is
2881 if (!udev->actconfig)
2884 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2885 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2886 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2887 USB_CTRL_SET_TIMEOUT);
2889 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2892 * usb_enable_remote_wakeup - enable remote wakeup for a device
2893 * @udev: target device
2895 * For USB-2 devices: Set the device's remote wakeup feature.
2897 * For USB-3 devices: Assume there's only one function on the device and
2898 * enable remote wake for the first interface. FIXME if the interface
2899 * association descriptor shows there's more than one function.
2901 static int usb_enable_remote_wakeup(struct usb_device *udev)
2903 if (udev->speed < USB_SPEED_SUPER)
2904 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2905 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2906 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2907 USB_CTRL_SET_TIMEOUT);
2909 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2910 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2911 USB_INTRF_FUNC_SUSPEND,
2912 USB_INTRF_FUNC_SUSPEND_RW |
2913 USB_INTRF_FUNC_SUSPEND_LP,
2914 NULL, 0, USB_CTRL_SET_TIMEOUT);
2918 * usb_disable_remote_wakeup - disable remote wakeup for a device
2919 * @udev: target device
2921 * For USB-2 devices: Clear the device's remote wakeup feature.
2923 * For USB-3 devices: Assume there's only one function on the device and
2924 * disable remote wake for the first interface. FIXME if the interface
2925 * association descriptor shows there's more than one function.
2927 static int usb_disable_remote_wakeup(struct usb_device *udev)
2929 if (udev->speed < USB_SPEED_SUPER)
2930 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2931 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2932 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2933 USB_CTRL_SET_TIMEOUT);
2935 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2936 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2937 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2938 USB_CTRL_SET_TIMEOUT);
2941 /* Count of wakeup-enabled devices at or below udev */
2942 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2944 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2946 return udev->do_remote_wakeup +
2947 (hub ? hub->wakeup_enabled_descendants : 0);
2951 * usb_port_suspend - suspend a usb device's upstream port
2952 * @udev: device that's no longer in active use, not a root hub
2953 * Context: must be able to sleep; device not locked; pm locks held
2955 * Suspends a USB device that isn't in active use, conserving power.
2956 * Devices may wake out of a suspend, if anything important happens,
2957 * using the remote wakeup mechanism. They may also be taken out of
2958 * suspend by the host, using usb_port_resume(). It's also routine
2959 * to disconnect devices while they are suspended.
2961 * This only affects the USB hardware for a device; its interfaces
2962 * (and, for hubs, child devices) must already have been suspended.
2964 * Selective port suspend reduces power; most suspended devices draw
2965 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2966 * All devices below the suspended port are also suspended.
2968 * Devices leave suspend state when the host wakes them up. Some devices
2969 * also support "remote wakeup", where the device can activate the USB
2970 * tree above them to deliver data, such as a keypress or packet. In
2971 * some cases, this wakes the USB host.
2973 * Suspending OTG devices may trigger HNP, if that's been enabled
2974 * between a pair of dual-role devices. That will change roles, such
2975 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2977 * Devices on USB hub ports have only one "suspend" state, corresponding
2978 * to ACPI D2, "may cause the device to lose some context".
2979 * State transitions include:
2981 * - suspend, resume ... when the VBUS power link stays live
2982 * - suspend, disconnect ... VBUS lost
2984 * Once VBUS drop breaks the circuit, the port it's using has to go through
2985 * normal re-enumeration procedures, starting with enabling VBUS power.
2986 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2987 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2988 * timer, no SRP, no requests through sysfs.
2990 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2991 * suspended until their bus goes into global suspend (i.e., the root
2992 * hub is suspended). Nevertheless, we change @udev->state to
2993 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2994 * upstream port setting is stored in @udev->port_is_suspended.
2996 * Returns 0 on success, else negative errno.
2998 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3000 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3001 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3002 int port1 = udev->portnum;
3004 bool really_suspend = true;
3006 /* enable remote wakeup when appropriate; this lets the device
3007 * wake up the upstream hub (including maybe the root hub).
3009 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3010 * we don't explicitly enable it here.
3012 if (udev->do_remote_wakeup) {
3013 status = usb_enable_remote_wakeup(udev);
3015 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3017 /* bail if autosuspend is requested */
3018 if (PMSG_IS_AUTO(msg))
3023 /* disable USB2 hardware LPM */
3024 if (udev->usb2_hw_lpm_enabled == 1)
3025 usb_set_usb2_hardware_lpm(udev, 0);
3027 if (usb_disable_ltm(udev)) {
3028 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3030 if (PMSG_IS_AUTO(msg))
3033 if (usb_unlocked_disable_lpm(udev)) {
3034 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3036 if (PMSG_IS_AUTO(msg))
3041 if (hub_is_superspeed(hub->hdev))
3042 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3045 * For system suspend, we do not need to enable the suspend feature
3046 * on individual USB-2 ports. The devices will automatically go
3047 * into suspend a few ms after the root hub stops sending packets.
3048 * The USB 2.0 spec calls this "global suspend".
3050 * However, many USB hubs have a bug: They don't relay wakeup requests
3051 * from a downstream port if the port's suspend feature isn't on.
3052 * Therefore we will turn on the suspend feature if udev or any of its
3053 * descendants is enabled for remote wakeup.
3055 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3056 status = set_port_feature(hub->hdev, port1,
3057 USB_PORT_FEAT_SUSPEND);
3059 really_suspend = false;
3063 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3065 /* Try to enable USB3 LPM and LTM again */
3066 usb_unlocked_enable_lpm(udev);
3068 usb_enable_ltm(udev);
3070 /* Try to enable USB2 hardware LPM again */
3071 if (udev->usb2_hw_lpm_capable == 1)
3072 usb_set_usb2_hardware_lpm(udev, 1);
3074 if (udev->do_remote_wakeup)
3075 (void) usb_disable_remote_wakeup(udev);
3078 /* System sleep transitions should never fail */
3079 if (!PMSG_IS_AUTO(msg))
3082 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3083 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3084 udev->do_remote_wakeup);
3085 if (really_suspend) {
3086 udev->port_is_suspended = 1;
3088 /* device has up to 10 msec to fully suspend */
3091 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3094 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3095 pm_runtime_put_sync(&port_dev->dev);
3096 port_dev->did_runtime_put = true;
3099 usb_mark_last_busy(hub->hdev);
3104 * If the USB "suspend" state is in use (rather than "global suspend"),
3105 * many devices will be individually taken out of suspend state using
3106 * special "resume" signaling. This routine kicks in shortly after
3107 * hardware resume signaling is finished, either because of selective
3108 * resume (by host) or remote wakeup (by device) ... now see what changed
3109 * in the tree that's rooted at this device.
3111 * If @udev->reset_resume is set then the device is reset before the
3112 * status check is done.
3114 static int finish_port_resume(struct usb_device *udev)
3119 /* caller owns the udev device lock */
3120 dev_dbg(&udev->dev, "%s\n",
3121 udev->reset_resume ? "finish reset-resume" : "finish resume");
3123 /* usb ch9 identifies four variants of SUSPENDED, based on what
3124 * state the device resumes to. Linux currently won't see the
3125 * first two on the host side; they'd be inside hub_port_init()
3126 * during many timeouts, but khubd can't suspend until later.
3128 usb_set_device_state(udev, udev->actconfig
3129 ? USB_STATE_CONFIGURED
3130 : USB_STATE_ADDRESS);
3132 /* 10.5.4.5 says not to reset a suspended port if the attached
3133 * device is enabled for remote wakeup. Hence the reset
3134 * operation is carried out here, after the port has been
3137 if (udev->reset_resume) {
3139 * If the device morphs or switches modes when it is reset,
3140 * we don't want to perform a reset-resume. We'll fail the
3141 * resume, which will cause a logical disconnect, and then
3142 * the device will be rediscovered.
3145 if (udev->quirks & USB_QUIRK_RESET)
3148 status = usb_reset_and_verify_device(udev);
3151 /* 10.5.4.5 says be sure devices in the tree are still there.
3152 * For now let's assume the device didn't go crazy on resume,
3153 * and device drivers will know about any resume quirks.
3157 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3159 /* If a normal resume failed, try doing a reset-resume */
3160 if (status && !udev->reset_resume && udev->persist_enabled) {
3161 dev_dbg(&udev->dev, "retry with reset-resume\n");
3162 udev->reset_resume = 1;
3163 goto retry_reset_resume;
3168 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3171 * There are a few quirky devices which violate the standard
3172 * by claiming to have remote wakeup enabled after a reset,
3173 * which crash if the feature is cleared, hence check for
3174 * udev->reset_resume
3176 } else if (udev->actconfig && !udev->reset_resume) {
3177 if (udev->speed < USB_SPEED_SUPER) {
3178 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3179 status = usb_disable_remote_wakeup(udev);
3181 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3183 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3184 | USB_INTRF_STAT_FUNC_RW))
3185 status = usb_disable_remote_wakeup(udev);
3190 "disable remote wakeup, status %d\n",
3198 * usb_port_resume - re-activate a suspended usb device's upstream port
3199 * @udev: device to re-activate, not a root hub
3200 * Context: must be able to sleep; device not locked; pm locks held
3202 * This will re-activate the suspended device, increasing power usage
3203 * while letting drivers communicate again with its endpoints.
3204 * USB resume explicitly guarantees that the power session between
3205 * the host and the device is the same as it was when the device
3208 * If @udev->reset_resume is set then this routine won't check that the
3209 * port is still enabled. Furthermore, finish_port_resume() above will
3210 * reset @udev. The end result is that a broken power session can be
3211 * recovered and @udev will appear to persist across a loss of VBUS power.
3213 * For example, if a host controller doesn't maintain VBUS suspend current
3214 * during a system sleep or is reset when the system wakes up, all the USB
3215 * power sessions below it will be broken. This is especially troublesome
3216 * for mass-storage devices containing mounted filesystems, since the
3217 * device will appear to have disconnected and all the memory mappings
3218 * to it will be lost. Using the USB_PERSIST facility, the device can be
3219 * made to appear as if it had not disconnected.
3221 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3222 * every effort to insure that the same device is present after the
3223 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3224 * quite possible for a device to remain unaltered but its media to be
3225 * changed. If the user replaces a flash memory card while the system is
3226 * asleep, he will have only himself to blame when the filesystem on the
3227 * new card is corrupted and the system crashes.
3229 * Returns 0 on success, else negative errno.
3231 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3233 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3234 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3235 int port1 = udev->portnum;
3237 u16 portchange, portstatus;
3239 if (port_dev->did_runtime_put) {
3240 status = pm_runtime_get_sync(&port_dev->dev);
3241 port_dev->did_runtime_put = false;
3243 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3249 /* Skip the initial Clear-Suspend step for a remote wakeup */
3250 status = hub_port_status(hub, port1, &portstatus, &portchange);
3251 if (status == 0 && !port_is_suspended(hub, portstatus))
3252 goto SuspendCleared;
3254 set_bit(port1, hub->busy_bits);
3256 /* see 7.1.7.7; affects power usage, but not budgeting */
3257 if (hub_is_superspeed(hub->hdev))
3258 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3260 status = usb_clear_port_feature(hub->hdev,
3261 port1, USB_PORT_FEAT_SUSPEND);
3263 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3265 /* drive resume for at least 20 msec */
3266 dev_dbg(&udev->dev, "usb %sresume\n",
3267 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3270 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3271 * stop resume signaling. Then finish the resume
3274 status = hub_port_status(hub, port1, &portstatus, &portchange);
3276 /* TRSMRCY = 10 msec */
3282 udev->port_is_suspended = 0;
3283 if (hub_is_superspeed(hub->hdev)) {
3284 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3285 usb_clear_port_feature(hub->hdev, port1,
3286 USB_PORT_FEAT_C_PORT_LINK_STATE);
3288 if (portchange & USB_PORT_STAT_C_SUSPEND)
3289 usb_clear_port_feature(hub->hdev, port1,
3290 USB_PORT_FEAT_C_SUSPEND);
3294 clear_bit(port1, hub->busy_bits);
3296 status = check_port_resume_type(udev,
3297 hub, port1, status, portchange, portstatus);
3299 status = finish_port_resume(udev);
3301 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3302 hub_port_logical_disconnect(hub, port1);
3304 /* Try to enable USB2 hardware LPM */
3305 if (udev->usb2_hw_lpm_capable == 1)
3306 usb_set_usb2_hardware_lpm(udev, 1);
3308 /* Try to enable USB3 LTM and LPM */
3309 usb_enable_ltm(udev);
3310 usb_unlocked_enable_lpm(udev);
3316 #ifdef CONFIG_PM_RUNTIME
3318 /* caller has locked udev */
3319 int usb_remote_wakeup(struct usb_device *udev)
3323 if (udev->state == USB_STATE_SUSPENDED) {
3324 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3325 status = usb_autoresume_device(udev);
3327 /* Let the drivers do their thing, then... */
3328 usb_autosuspend_device(udev);
3336 static int check_ports_changed(struct usb_hub *hub)
3340 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3341 u16 portstatus, portchange;
3344 status = hub_port_status(hub, port1, &portstatus, &portchange);
3345 if (!status && portchange)
3351 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3353 struct usb_hub *hub = usb_get_intfdata (intf);
3354 struct usb_device *hdev = hub->hdev;
3359 * Warn if children aren't already suspended.
3360 * Also, add up the number of wakeup-enabled descendants.
3362 hub->wakeup_enabled_descendants = 0;
3363 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3364 struct usb_port *port_dev = hub->ports[port1 - 1];
3365 struct usb_device *udev = port_dev->child;
3367 if (udev && udev->can_submit) {
3368 dev_warn(&port_dev->dev, "not suspended yet\n");
3369 if (PMSG_IS_AUTO(msg))
3373 hub->wakeup_enabled_descendants +=
3374 wakeup_enabled_descendants(udev);
3377 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3378 /* check if there are changes pending on hub ports */
3379 if (check_ports_changed(hub)) {
3380 if (PMSG_IS_AUTO(msg))
3382 pm_wakeup_event(&hdev->dev, 2000);
3386 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3387 /* Enable hub to send remote wakeup for all ports. */
3388 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3389 status = set_port_feature(hdev,
3391 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3392 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3393 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3394 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3398 dev_dbg(&intf->dev, "%s\n", __func__);
3400 /* stop khubd and related activity */
3401 hub_quiesce(hub, HUB_SUSPEND);
3405 static int hub_resume(struct usb_interface *intf)
3407 struct usb_hub *hub = usb_get_intfdata(intf);
3409 dev_dbg(&intf->dev, "%s\n", __func__);
3410 hub_activate(hub, HUB_RESUME);
3414 static int hub_reset_resume(struct usb_interface *intf)
3416 struct usb_hub *hub = usb_get_intfdata(intf);
3418 dev_dbg(&intf->dev, "%s\n", __func__);
3419 hub_activate(hub, HUB_RESET_RESUME);
3424 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3425 * @rhdev: struct usb_device for the root hub
3427 * The USB host controller driver calls this function when its root hub
3428 * is resumed and Vbus power has been interrupted or the controller
3429 * has been reset. The routine marks @rhdev as having lost power.
3430 * When the hub driver is resumed it will take notice and carry out
3431 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3432 * the others will be disconnected.
3434 void usb_root_hub_lost_power(struct usb_device *rhdev)
3436 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3437 rhdev->reset_resume = 1;
3439 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3441 static const char * const usb3_lpm_names[] = {
3449 * Send a Set SEL control transfer to the device, prior to enabling
3450 * device-initiated U1 or U2. This lets the device know the exit latencies from
3451 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3452 * packet from the host.
3454 * This function will fail if the SEL or PEL values for udev are greater than
3455 * the maximum allowed values for the link state to be enabled.
3457 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3459 struct usb_set_sel_req *sel_values;
3460 unsigned long long u1_sel;
3461 unsigned long long u1_pel;
3462 unsigned long long u2_sel;
3463 unsigned long long u2_pel;
3466 if (udev->state != USB_STATE_CONFIGURED)
3469 /* Convert SEL and PEL stored in ns to us */
3470 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3471 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3472 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3473 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3476 * Make sure that the calculated SEL and PEL values for the link
3477 * state we're enabling aren't bigger than the max SEL/PEL
3478 * value that will fit in the SET SEL control transfer.
3479 * Otherwise the device would get an incorrect idea of the exit
3480 * latency for the link state, and could start a device-initiated
3481 * U1/U2 when the exit latencies are too high.
3483 if ((state == USB3_LPM_U1 &&
3484 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3485 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3486 (state == USB3_LPM_U2 &&
3487 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3488 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3489 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3490 usb3_lpm_names[state], u1_sel, u1_pel);
3495 * If we're enabling device-initiated LPM for one link state,
3496 * but the other link state has a too high SEL or PEL value,
3497 * just set those values to the max in the Set SEL request.
3499 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3500 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3502 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3503 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3505 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3506 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3508 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3509 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3512 * usb_enable_lpm() can be called as part of a failed device reset,
3513 * which may be initiated by an error path of a mass storage driver.
3514 * Therefore, use GFP_NOIO.
3516 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3520 sel_values->u1_sel = u1_sel;
3521 sel_values->u1_pel = u1_pel;
3522 sel_values->u2_sel = cpu_to_le16(u2_sel);
3523 sel_values->u2_pel = cpu_to_le16(u2_pel);
3525 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3529 sel_values, sizeof *(sel_values),
3530 USB_CTRL_SET_TIMEOUT);
3536 * Enable or disable device-initiated U1 or U2 transitions.
3538 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3539 enum usb3_link_state state, bool enable)
3546 feature = USB_DEVICE_U1_ENABLE;
3549 feature = USB_DEVICE_U2_ENABLE;
3552 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3553 __func__, enable ? "enable" : "disable");
3557 if (udev->state != USB_STATE_CONFIGURED) {
3558 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3559 "for unconfigured device.\n",
3560 __func__, enable ? "enable" : "disable",
3561 usb3_lpm_names[state]);
3567 * Now send the control transfer to enable device-initiated LPM
3568 * for either U1 or U2.
3570 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3571 USB_REQ_SET_FEATURE,
3575 USB_CTRL_SET_TIMEOUT);
3577 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3578 USB_REQ_CLEAR_FEATURE,
3582 USB_CTRL_SET_TIMEOUT);
3585 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3586 enable ? "Enable" : "Disable",
3587 usb3_lpm_names[state]);
3593 static int usb_set_lpm_timeout(struct usb_device *udev,
3594 enum usb3_link_state state, int timeout)
3601 feature = USB_PORT_FEAT_U1_TIMEOUT;
3604 feature = USB_PORT_FEAT_U2_TIMEOUT;
3607 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3612 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3613 timeout != USB3_LPM_DEVICE_INITIATED) {
3614 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3615 "which is a reserved value.\n",
3616 usb3_lpm_names[state], timeout);
3620 ret = set_port_feature(udev->parent,
3621 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3624 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3625 "error code %i\n", usb3_lpm_names[state],
3629 if (state == USB3_LPM_U1)
3630 udev->u1_params.timeout = timeout;
3632 udev->u2_params.timeout = timeout;
3637 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3640 * We will attempt to enable U1 or U2, but there are no guarantees that the
3641 * control transfers to set the hub timeout or enable device-initiated U1/U2
3642 * will be successful.
3644 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3645 * driver know about it. If that call fails, it should be harmless, and just
3646 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3648 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3649 enum usb3_link_state state)
3652 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3653 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3655 /* If the device says it doesn't have *any* exit latency to come out of
3656 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3659 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3660 (state == USB3_LPM_U2 && u2_mel == 0))
3664 * First, let the device know about the exit latencies
3665 * associated with the link state we're about to enable.
3667 ret = usb_req_set_sel(udev, state);
3669 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3670 usb3_lpm_names[state]);
3674 /* We allow the host controller to set the U1/U2 timeout internally
3675 * first, so that it can change its schedule to account for the
3676 * additional latency to send data to a device in a lower power
3679 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3681 /* xHCI host controller doesn't want to enable this LPM state. */
3686 dev_warn(&udev->dev, "Could not enable %s link state, "
3687 "xHCI error %i.\n", usb3_lpm_names[state],
3692 if (usb_set_lpm_timeout(udev, state, timeout))
3693 /* If we can't set the parent hub U1/U2 timeout,
3694 * device-initiated LPM won't be allowed either, so let the xHCI
3695 * host know that this link state won't be enabled.
3697 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3699 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3700 else if (udev->actconfig)
3701 usb_set_device_initiated_lpm(udev, state, true);
3706 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3709 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3710 * If zero is returned, the parent will not allow the link to go into U1/U2.
3712 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3713 * it won't have an effect on the bus link state because the parent hub will
3714 * still disallow device-initiated U1/U2 entry.
3716 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3717 * possible. The result will be slightly more bus bandwidth will be taken up
3718 * (to account for U1/U2 exit latency), but it should be harmless.
3720 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3721 enum usb3_link_state state)
3727 feature = USB_PORT_FEAT_U1_TIMEOUT;
3730 feature = USB_PORT_FEAT_U2_TIMEOUT;
3733 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3738 if (usb_set_lpm_timeout(udev, state, 0))
3741 usb_set_device_initiated_lpm(udev, state, false);
3743 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3744 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3745 "bus schedule bandwidth may be impacted.\n",
3746 usb3_lpm_names[state]);
3751 * Disable hub-initiated and device-initiated U1 and U2 entry.
3752 * Caller must own the bandwidth_mutex.
3754 * This will call usb_enable_lpm() on failure, which will decrement
3755 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3757 int usb_disable_lpm(struct usb_device *udev)
3759 struct usb_hcd *hcd;
3761 if (!udev || !udev->parent ||
3762 udev->speed != USB_SPEED_SUPER ||
3766 hcd = bus_to_hcd(udev->bus);
3767 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3770 udev->lpm_disable_count++;
3771 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3774 /* If LPM is enabled, attempt to disable it. */
3775 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3777 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3783 usb_enable_lpm(udev);
3786 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3788 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3789 int usb_unlocked_disable_lpm(struct usb_device *udev)
3791 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3797 mutex_lock(hcd->bandwidth_mutex);
3798 ret = usb_disable_lpm(udev);
3799 mutex_unlock(hcd->bandwidth_mutex);
3803 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3806 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3807 * xHCI host policy may prevent U1 or U2 from being enabled.
3809 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3810 * until the lpm_disable_count drops to zero. Caller must own the
3813 void usb_enable_lpm(struct usb_device *udev)
3815 struct usb_hcd *hcd;
3817 if (!udev || !udev->parent ||
3818 udev->speed != USB_SPEED_SUPER ||
3822 udev->lpm_disable_count--;
3823 hcd = bus_to_hcd(udev->bus);
3824 /* Double check that we can both enable and disable LPM.
3825 * Device must be configured to accept set feature U1/U2 timeout.
3827 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3828 !hcd->driver->disable_usb3_lpm_timeout)
3831 if (udev->lpm_disable_count > 0)
3834 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3835 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3837 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3839 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3840 void usb_unlocked_enable_lpm(struct usb_device *udev)
3842 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3847 mutex_lock(hcd->bandwidth_mutex);
3848 usb_enable_lpm(udev);
3849 mutex_unlock(hcd->bandwidth_mutex);
3851 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3854 #else /* CONFIG_PM */
3856 #define hub_suspend NULL
3857 #define hub_resume NULL
3858 #define hub_reset_resume NULL
3860 int usb_disable_lpm(struct usb_device *udev)
3864 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3866 void usb_enable_lpm(struct usb_device *udev) { }
3867 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3869 int usb_unlocked_disable_lpm(struct usb_device *udev)
3873 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3875 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3876 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3878 int usb_disable_ltm(struct usb_device *udev)
3882 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3884 void usb_enable_ltm(struct usb_device *udev) { }
3885 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3887 #endif /* CONFIG_PM */
3890 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3892 * Between connect detection and reset signaling there must be a delay
3893 * of 100ms at least for debounce and power-settling. The corresponding
3894 * timer shall restart whenever the downstream port detects a disconnect.
3896 * Apparently there are some bluetooth and irda-dongles and a number of
3897 * low-speed devices for which this debounce period may last over a second.
3898 * Not covered by the spec - but easy to deal with.
3900 * This implementation uses a 1500ms total debounce timeout; if the
3901 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3902 * every 25ms for transient disconnects. When the port status has been
3903 * unchanged for 100ms it returns the port status.
3905 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3908 u16 portchange, portstatus;
3909 unsigned connection = 0xffff;
3910 int total_time, stable_time = 0;
3911 struct usb_port *port_dev = hub->ports[port1 - 1];
3913 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3914 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3918 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3919 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3920 if (!must_be_connected ||
3921 (connection == USB_PORT_STAT_CONNECTION))
3922 stable_time += HUB_DEBOUNCE_STEP;
3923 if (stable_time >= HUB_DEBOUNCE_STABLE)
3927 connection = portstatus & USB_PORT_STAT_CONNECTION;
3930 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3931 usb_clear_port_feature(hub->hdev, port1,
3932 USB_PORT_FEAT_C_CONNECTION);
3935 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3937 msleep(HUB_DEBOUNCE_STEP);
3940 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
3941 total_time, stable_time, portstatus);
3943 if (stable_time < HUB_DEBOUNCE_STABLE)
3948 void usb_ep0_reinit(struct usb_device *udev)
3950 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3951 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3952 usb_enable_endpoint(udev, &udev->ep0, true);
3954 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3956 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3957 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3959 static int hub_set_address(struct usb_device *udev, int devnum)
3962 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3965 * The host controller will choose the device address,
3966 * instead of the core having chosen it earlier
3968 if (!hcd->driver->address_device && devnum <= 1)
3970 if (udev->state == USB_STATE_ADDRESS)
3972 if (udev->state != USB_STATE_DEFAULT)
3974 if (hcd->driver->address_device)
3975 retval = hcd->driver->address_device(hcd, udev);
3977 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3978 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3979 NULL, 0, USB_CTRL_SET_TIMEOUT);
3981 update_devnum(udev, devnum);
3982 /* Device now using proper address. */
3983 usb_set_device_state(udev, USB_STATE_ADDRESS);
3984 usb_ep0_reinit(udev);
3990 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
3991 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
3994 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
3995 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
3996 * support bit in the BOS descriptor.
3998 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4000 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4001 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4003 if (!udev->usb2_hw_lpm_capable)
4007 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4009 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4010 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4011 udev->usb2_hw_lpm_allowed = 1;
4012 usb_set_usb2_hardware_lpm(udev, 1);
4016 static int hub_enable_device(struct usb_device *udev)
4018 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4020 if (!hcd->driver->enable_device)
4022 if (udev->state == USB_STATE_ADDRESS)
4024 if (udev->state != USB_STATE_DEFAULT)
4027 return hcd->driver->enable_device(hcd, udev);
4030 /* Reset device, (re)assign address, get device descriptor.
4031 * Device connection must be stable, no more debouncing needed.
4032 * Returns device in USB_STATE_ADDRESS, except on error.
4034 * If this is called for an already-existing device (as part of
4035 * usb_reset_and_verify_device), the caller must own the device lock. For a
4036 * newly detected device that is not accessible through any global
4037 * pointers, it's not necessary to lock the device.
4040 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4043 struct usb_device *hdev = hub->hdev;
4044 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4046 unsigned delay = HUB_SHORT_RESET_TIME;
4047 enum usb_device_speed oldspeed = udev->speed;
4049 int devnum = udev->devnum;
4051 /* root hub ports have a slightly longer reset period
4052 * (from USB 2.0 spec, section 7.1.7.5)
4054 if (!hdev->parent) {
4055 delay = HUB_ROOT_RESET_TIME;
4056 if (port1 == hdev->bus->otg_port)
4057 hdev->bus->b_hnp_enable = 0;
4060 /* Some low speed devices have problems with the quick delay, so */
4061 /* be a bit pessimistic with those devices. RHbug #23670 */
4062 if (oldspeed == USB_SPEED_LOW)
4063 delay = HUB_LONG_RESET_TIME;
4065 mutex_lock(&hdev->bus->usb_address0_mutex);
4067 /* Reset the device; full speed may morph to high speed */
4068 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4069 retval = hub_port_reset(hub, port1, udev, delay, false);
4070 if (retval < 0) /* error or disconnect */
4072 /* success, speed is known */
4076 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4077 dev_dbg(&udev->dev, "device reset changed speed!\n");
4080 oldspeed = udev->speed;
4082 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4083 * it's fixed size except for full speed devices.
4084 * For Wireless USB devices, ep0 max packet is always 512 (tho
4085 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4087 switch (udev->speed) {
4088 case USB_SPEED_SUPER:
4089 case USB_SPEED_WIRELESS: /* fixed at 512 */
4090 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4092 case USB_SPEED_HIGH: /* fixed at 64 */
4093 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4095 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4096 /* to determine the ep0 maxpacket size, try to read
4097 * the device descriptor to get bMaxPacketSize0 and
4098 * then correct our initial guess.
4100 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4102 case USB_SPEED_LOW: /* fixed at 8 */
4103 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4109 if (udev->speed == USB_SPEED_WIRELESS)
4110 speed = "variable speed Wireless";
4112 speed = usb_speed_string(udev->speed);
4114 if (udev->speed != USB_SPEED_SUPER)
4115 dev_info(&udev->dev,
4116 "%s %s USB device number %d using %s\n",
4117 (udev->config) ? "reset" : "new", speed,
4118 devnum, udev->bus->controller->driver->name);
4120 /* Set up TT records, if needed */
4122 udev->tt = hdev->tt;
4123 udev->ttport = hdev->ttport;
4124 } else if (udev->speed != USB_SPEED_HIGH
4125 && hdev->speed == USB_SPEED_HIGH) {
4127 dev_err(&udev->dev, "parent hub has no TT\n");
4131 udev->tt = &hub->tt;
4132 udev->ttport = port1;
4135 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4136 * Because device hardware and firmware is sometimes buggy in
4137 * this area, and this is how Linux has done it for ages.
4138 * Change it cautiously.
4140 * NOTE: If use_new_scheme() is true we will start by issuing
4141 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4142 * so it may help with some non-standards-compliant devices.
4143 * Otherwise we start with SET_ADDRESS and then try to read the
4144 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4147 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4148 bool did_new_scheme = false;
4150 if (use_new_scheme(udev, retry_counter)) {
4151 struct usb_device_descriptor *buf;
4154 did_new_scheme = true;
4155 retval = hub_enable_device(udev);
4158 "hub failed to enable device, error %d\n",
4163 #define GET_DESCRIPTOR_BUFSIZE 64
4164 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4170 /* Retry on all errors; some devices are flakey.
4171 * 255 is for WUSB devices, we actually need to use
4172 * 512 (WUSB1.0[4.8.1]).
4174 for (j = 0; j < 3; ++j) {
4175 buf->bMaxPacketSize0 = 0;
4176 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4177 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4178 USB_DT_DEVICE << 8, 0,
4179 buf, GET_DESCRIPTOR_BUFSIZE,
4180 initial_descriptor_timeout);
4181 switch (buf->bMaxPacketSize0) {
4182 case 8: case 16: case 32: case 64: case 255:
4183 if (buf->bDescriptorType ==
4197 udev->descriptor.bMaxPacketSize0 =
4198 buf->bMaxPacketSize0;
4201 retval = hub_port_reset(hub, port1, udev, delay, false);
4202 if (retval < 0) /* error or disconnect */
4204 if (oldspeed != udev->speed) {
4206 "device reset changed speed!\n");
4212 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4217 #undef GET_DESCRIPTOR_BUFSIZE
4221 * If device is WUSB, we already assigned an
4222 * unauthorized address in the Connect Ack sequence;
4223 * authorization will assign the final address.
4225 if (udev->wusb == 0) {
4226 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4227 retval = hub_set_address(udev, devnum);
4233 if (retval != -ENODEV)
4234 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4238 if (udev->speed == USB_SPEED_SUPER) {
4239 devnum = udev->devnum;
4240 dev_info(&udev->dev,
4241 "%s SuperSpeed USB device number %d using %s\n",
4242 (udev->config) ? "reset" : "new",
4243 devnum, udev->bus->controller->driver->name);
4246 /* cope with hardware quirkiness:
4247 * - let SET_ADDRESS settle, some device hardware wants it
4248 * - read ep0 maxpacket even for high and low speed,
4251 /* use_new_scheme() checks the speed which may have
4252 * changed since the initial look so we cache the result
4259 retval = usb_get_device_descriptor(udev, 8);
4261 if (retval != -ENODEV)
4263 "device descriptor read/8, error %d\n",
4275 if (hcd->phy && !hdev->parent)
4276 usb_phy_notify_connect(hcd->phy, udev->speed);
4279 * Some superspeed devices have finished the link training process
4280 * and attached to a superspeed hub port, but the device descriptor
4281 * got from those devices show they aren't superspeed devices. Warm
4282 * reset the port attached by the devices can fix them.
4284 if ((udev->speed == USB_SPEED_SUPER) &&
4285 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4286 dev_err(&udev->dev, "got a wrong device descriptor, "
4287 "warm reset device\n");
4288 hub_port_reset(hub, port1, udev,
4289 HUB_BH_RESET_TIME, true);
4294 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4295 udev->speed == USB_SPEED_SUPER)
4298 i = udev->descriptor.bMaxPacketSize0;
4299 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4300 if (udev->speed == USB_SPEED_LOW ||
4301 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4302 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4306 if (udev->speed == USB_SPEED_FULL)
4307 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4309 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4310 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4311 usb_ep0_reinit(udev);
4314 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4315 if (retval < (signed)sizeof(udev->descriptor)) {
4316 if (retval != -ENODEV)
4317 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4324 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4325 retval = usb_get_bos_descriptor(udev);
4327 udev->lpm_capable = usb_device_supports_lpm(udev);
4328 usb_set_lpm_parameters(udev);
4333 /* notify HCD that we have a device connected and addressed */
4334 if (hcd->driver->update_device)
4335 hcd->driver->update_device(hcd, udev);
4336 hub_set_initial_usb2_lpm_policy(udev);
4339 hub_port_disable(hub, port1, 0);
4340 update_devnum(udev, devnum); /* for disconnect processing */
4342 mutex_unlock(&hdev->bus->usb_address0_mutex);
4347 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4349 struct usb_qualifier_descriptor *qual;
4352 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4356 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4357 qual, sizeof *qual);
4358 if (status == sizeof *qual) {
4359 dev_info(&udev->dev, "not running at top speed; "
4360 "connect to a high speed hub\n");
4361 /* hub LEDs are probably harder to miss than syslog */
4362 if (hub->has_indicators) {
4363 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4364 queue_delayed_work(system_power_efficient_wq,
4372 hub_power_remaining (struct usb_hub *hub)
4374 struct usb_device *hdev = hub->hdev;
4378 if (!hub->limited_power)
4381 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4382 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4383 struct usb_port *port_dev = hub->ports[port1 - 1];
4384 struct usb_device *udev = port_dev->child;
4390 if (hub_is_superspeed(udev))
4396 * Unconfigured devices may not use more than one unit load,
4397 * or 8mA for OTG ports
4399 if (udev->actconfig)
4400 delta = usb_get_max_power(udev, udev->actconfig);
4401 else if (port1 != udev->bus->otg_port || hdev->parent)
4405 if (delta > hub->mA_per_port)
4406 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4407 delta, hub->mA_per_port);
4410 if (remaining < 0) {
4411 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4418 /* Handle physical or logical connection change events.
4419 * This routine is called when:
4420 * a port connection-change occurs;
4421 * a port enable-change occurs (often caused by EMI);
4422 * usb_reset_and_verify_device() encounters changed descriptors (as from
4423 * a firmware download)
4424 * caller already locked the hub
4426 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4427 u16 portstatus, u16 portchange)
4429 struct usb_device *hdev = hub->hdev;
4430 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4431 struct usb_port *port_dev = hub->ports[port1 - 1];
4432 struct usb_device *udev;
4436 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n",
4437 portstatus, portchange, portspeed(hub, portstatus));
4439 if (hub->has_indicators) {
4440 set_port_led(hub, port1, HUB_LED_AUTO);
4441 hub->indicator[port1-1] = INDICATOR_AUTO;
4444 #ifdef CONFIG_USB_OTG
4445 /* during HNP, don't repeat the debounce */
4446 if (hdev->bus->is_b_host)
4447 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4448 USB_PORT_STAT_C_ENABLE);
4451 /* Try to resuscitate an existing device */
4452 udev = port_dev->child;
4453 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4454 udev->state != USB_STATE_NOTATTACHED) {
4455 usb_lock_device(udev);
4456 if (portstatus & USB_PORT_STAT_ENABLE) {
4457 status = 0; /* Nothing to do */
4459 #ifdef CONFIG_PM_RUNTIME
4460 } else if (udev->state == USB_STATE_SUSPENDED &&
4461 udev->persist_enabled) {
4462 /* For a suspended device, treat this as a
4463 * remote wakeup event.
4465 status = usb_remote_wakeup(udev);
4469 status = -ENODEV; /* Don't resuscitate */
4471 usb_unlock_device(udev);
4474 clear_bit(port1, hub->change_bits);
4479 /* Disconnect any existing devices under this port */
4481 if (hcd->phy && !hdev->parent &&
4482 !(portstatus & USB_PORT_STAT_CONNECTION))
4483 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4484 usb_disconnect(&port_dev->child);
4486 clear_bit(port1, hub->change_bits);
4488 /* We can forget about a "removed" device when there's a physical
4489 * disconnect or the connect status changes.
4491 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4492 (portchange & USB_PORT_STAT_C_CONNECTION))
4493 clear_bit(port1, hub->removed_bits);
4495 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4496 USB_PORT_STAT_C_ENABLE)) {
4497 status = hub_port_debounce_be_stable(hub, port1);
4499 if (status != -ENODEV && printk_ratelimit())
4500 dev_err(&port_dev->dev,
4501 "connect-debounce failed\n");
4502 portstatus &= ~USB_PORT_STAT_CONNECTION;
4504 portstatus = status;
4508 /* Return now if debouncing failed or nothing is connected or
4509 * the device was "removed".
4511 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4512 test_bit(port1, hub->removed_bits)) {
4514 /* maybe switch power back on (e.g. root hub was reset) */
4515 if (hub_is_port_power_switchable(hub)
4516 && !port_is_power_on(hub, portstatus))
4517 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4519 if (portstatus & USB_PORT_STAT_ENABLE)
4523 if (hub_is_superspeed(hub->hdev))
4529 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4531 /* reallocate for each attempt, since references
4532 * to the previous one can escape in various ways
4534 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4536 dev_err(&port_dev->dev,
4537 "couldn't allocate usb_device\n");
4541 usb_set_device_state(udev, USB_STATE_POWERED);
4542 udev->bus_mA = hub->mA_per_port;
4543 udev->level = hdev->level + 1;
4544 udev->wusb = hub_is_wusb(hub);
4546 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4547 if (hub_is_superspeed(hub->hdev))
4548 udev->speed = USB_SPEED_SUPER;
4550 udev->speed = USB_SPEED_UNKNOWN;
4552 choose_devnum(udev);
4553 if (udev->devnum <= 0) {
4554 status = -ENOTCONN; /* Don't retry */
4558 /* reset (non-USB 3.0 devices) and get descriptor */
4559 status = hub_port_init(hub, udev, port1, i);
4563 usb_detect_quirks(udev);
4564 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4567 /* consecutive bus-powered hubs aren't reliable; they can
4568 * violate the voltage drop budget. if the new child has
4569 * a "powered" LED, users should notice we didn't enable it
4570 * (without reading syslog), even without per-port LEDs
4573 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4574 && udev->bus_mA <= unit_load) {
4577 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4580 dev_dbg(&udev->dev, "get status %d ?\n", status);
4583 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4585 "can't connect bus-powered hub "
4587 if (hub->has_indicators) {
4588 hub->indicator[port1-1] =
4589 INDICATOR_AMBER_BLINK;
4591 system_power_efficient_wq,
4594 status = -ENOTCONN; /* Don't retry */
4599 /* check for devices running slower than they could */
4600 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4601 && udev->speed == USB_SPEED_FULL
4602 && highspeed_hubs != 0)
4603 check_highspeed (hub, udev, port1);
4605 /* Store the parent's children[] pointer. At this point
4606 * udev becomes globally accessible, although presumably
4607 * no one will look at it until hdev is unlocked.
4611 /* We mustn't add new devices if the parent hub has
4612 * been disconnected; we would race with the
4613 * recursively_mark_NOTATTACHED() routine.
4615 spin_lock_irq(&device_state_lock);
4616 if (hdev->state == USB_STATE_NOTATTACHED)
4619 port_dev->child = udev;
4620 spin_unlock_irq(&device_state_lock);
4622 /* Run it through the hoops (find a driver, etc) */
4624 status = usb_new_device(udev);
4626 spin_lock_irq(&device_state_lock);
4627 port_dev->child = NULL;
4628 spin_unlock_irq(&device_state_lock);
4635 status = hub_power_remaining(hub);
4637 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4642 hub_port_disable(hub, port1, 1);
4644 usb_ep0_reinit(udev);
4645 release_devnum(udev);
4648 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4651 if (hub->hdev->parent ||
4652 !hcd->driver->port_handed_over ||
4653 !(hcd->driver->port_handed_over)(hcd, port1)) {
4654 if (status != -ENOTCONN && status != -ENODEV)
4655 dev_err(&port_dev->dev,
4656 "unable to enumerate USB device\n");
4660 hub_port_disable(hub, port1, 1);
4661 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4662 hcd->driver->relinquish_port(hcd, port1);
4665 /* Returns 1 if there was a remote wakeup and a connect status change. */
4666 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4667 u16 portstatus, u16 portchange)
4669 struct usb_port *port_dev = hub->ports[port - 1];
4670 struct usb_device *hdev;
4671 struct usb_device *udev;
4672 int connect_change = 0;
4676 udev = port_dev->child;
4677 if (!hub_is_superspeed(hdev)) {
4678 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4680 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4682 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4683 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4689 /* TRSMRCY = 10 msec */
4692 usb_lock_device(udev);
4693 ret = usb_remote_wakeup(udev);
4694 usb_unlock_device(udev);
4699 hub_port_disable(hub, port, 1);
4701 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
4702 return connect_change;
4705 static void hub_events(void)
4707 struct list_head *tmp;
4708 struct usb_device *hdev;
4709 struct usb_interface *intf;
4710 struct usb_hub *hub;
4711 struct device *hub_dev;
4717 int connect_change, wakeup_change;
4720 * We restart the list every time to avoid a deadlock with
4721 * deleting hubs downstream from this one. This should be
4722 * safe since we delete the hub from the event list.
4723 * Not the most efficient, but avoids deadlocks.
4727 /* Grab the first entry at the beginning of the list */
4728 spin_lock_irq(&hub_event_lock);
4729 if (list_empty(&hub_event_list)) {
4730 spin_unlock_irq(&hub_event_lock);
4734 tmp = hub_event_list.next;
4737 hub = list_entry(tmp, struct usb_hub, event_list);
4738 kref_get(&hub->kref);
4739 spin_unlock_irq(&hub_event_lock);
4742 hub_dev = hub->intfdev;
4743 intf = to_usb_interface(hub_dev);
4744 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4745 hdev->state, hdev->maxchild,
4746 /* NOTE: expects max 15 ports... */
4747 (u16) hub->change_bits[0],
4748 (u16) hub->event_bits[0]);
4750 /* Lock the device, then check to see if we were
4751 * disconnected while waiting for the lock to succeed. */
4752 usb_lock_device(hdev);
4753 if (unlikely(hub->disconnected))
4754 goto loop_disconnected;
4756 /* If the hub has died, clean up after it */
4757 if (hdev->state == USB_STATE_NOTATTACHED) {
4758 hub->error = -ENODEV;
4759 hub_quiesce(hub, HUB_DISCONNECT);
4764 ret = usb_autopm_get_interface(intf);
4766 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4770 /* If this is an inactive hub, do nothing */
4775 dev_dbg (hub_dev, "resetting for error %d\n",
4778 ret = usb_reset_device(hdev);
4781 "error resetting hub: %d\n", ret);
4789 /* deal with port status changes */
4790 for (i = 1; i <= hdev->maxchild; i++) {
4791 struct usb_port *port_dev = hub->ports[i - 1];
4792 struct usb_device *udev = port_dev->child;
4794 if (test_bit(i, hub->busy_bits))
4796 connect_change = test_bit(i, hub->change_bits);
4797 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4798 if (!test_and_clear_bit(i, hub->event_bits) &&
4799 !connect_change && !wakeup_change)
4802 ret = hub_port_status(hub, i,
4803 &portstatus, &portchange);
4807 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4808 usb_clear_port_feature(hdev, i,
4809 USB_PORT_FEAT_C_CONNECTION);
4813 if (portchange & USB_PORT_STAT_C_ENABLE) {
4814 if (!connect_change)
4815 dev_dbg(&port_dev->dev,
4816 "enable change, status %08x\n",
4818 usb_clear_port_feature(hdev, i,
4819 USB_PORT_FEAT_C_ENABLE);
4822 * EM interference sometimes causes badly
4823 * shielded USB devices to be shutdown by
4824 * the hub, this hack enables them again.
4825 * Works at least with mouse driver.
4827 if (!(portstatus & USB_PORT_STAT_ENABLE)
4828 && !connect_change && udev) {
4829 dev_err(&port_dev->dev,
4830 "disabled by hub (EMI?), re-enabling...\n");
4835 if (hub_handle_remote_wakeup(hub, i,
4836 portstatus, portchange))
4839 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4843 dev_dbg(&port_dev->dev, "over-current change\n");
4844 usb_clear_port_feature(hdev, i,
4845 USB_PORT_FEAT_C_OVER_CURRENT);
4846 msleep(100); /* Cool down */
4847 hub_power_on(hub, true);
4848 hub_port_status(hub, i, &status, &unused);
4849 if (status & USB_PORT_STAT_OVERCURRENT)
4850 dev_err(&port_dev->dev,
4851 "over-current condition\n");
4854 if (portchange & USB_PORT_STAT_C_RESET) {
4855 dev_dbg(&port_dev->dev, "reset change\n");
4856 usb_clear_port_feature(hdev, i,
4857 USB_PORT_FEAT_C_RESET);
4859 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4860 hub_is_superspeed(hub->hdev)) {
4861 dev_dbg(&port_dev->dev, "warm reset change\n");
4862 usb_clear_port_feature(hdev, i,
4863 USB_PORT_FEAT_C_BH_PORT_RESET);
4865 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4866 usb_clear_port_feature(hub->hdev, i,
4867 USB_PORT_FEAT_C_PORT_LINK_STATE);
4869 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4870 dev_warn(&port_dev->dev, "config error\n");
4871 usb_clear_port_feature(hub->hdev, i,
4872 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4875 /* Warm reset a USB3 protocol port if it's in
4876 * SS.Inactive state.
4878 if (hub_port_warm_reset_required(hub, portstatus)) {
4881 dev_dbg(&port_dev->dev, "warm reset\n");
4883 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4884 udev->state == USB_STATE_NOTATTACHED) {
4885 status = hub_port_reset(hub, i,
4886 NULL, HUB_BH_RESET_TIME,
4889 hub_port_disable(hub, i, 1);
4891 usb_lock_device(udev);
4892 status = usb_reset_device(udev);
4893 usb_unlock_device(udev);
4897 * On disconnect USB3 protocol ports transit from U0 to
4898 * SS.Inactive to Rx.Detect. If this happens a warm-
4899 * reset is not needed, but a (re)connect may happen
4900 * before khubd runs and sees the disconnect, and the
4901 * device may be an unknown state.
4903 * If the port went through SS.Inactive without khubd
4904 * seeing it the C_LINK_STATE change flag will be set,
4905 * and we reset the dev to put it in a known state.
4907 } else if (udev && hub_is_superspeed(hub->hdev) &&
4908 (portchange & USB_PORT_STAT_C_LINK_STATE) &&
4909 (portstatus & USB_PORT_STAT_CONNECTION)) {
4910 usb_lock_device(udev);
4911 usb_reset_device(udev);
4912 usb_unlock_device(udev);
4917 hub_port_connect_change(hub, i,
4918 portstatus, portchange);
4921 /* deal with hub status changes */
4922 if (test_and_clear_bit(0, hub->event_bits) == 0)
4924 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4925 dev_err (hub_dev, "get_hub_status failed\n");
4927 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4928 dev_dbg (hub_dev, "power change\n");
4929 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4930 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4931 /* FIXME: Is this always true? */
4932 hub->limited_power = 1;
4934 hub->limited_power = 0;
4936 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4940 dev_dbg(hub_dev, "over-current change\n");
4941 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4942 msleep(500); /* Cool down */
4943 hub_power_on(hub, true);
4944 hub_hub_status(hub, &status, &unused);
4945 if (status & HUB_STATUS_OVERCURRENT)
4946 dev_err(hub_dev, "over-current "
4952 /* Balance the usb_autopm_get_interface() above */
4953 usb_autopm_put_interface_no_suspend(intf);
4955 /* Balance the usb_autopm_get_interface_no_resume() in
4956 * kick_khubd() and allow autosuspend.
4958 usb_autopm_put_interface(intf);
4960 usb_unlock_device(hdev);
4961 kref_put(&hub->kref, hub_release);
4963 } /* end while (1) */
4966 static int hub_thread(void *__unused)
4968 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4969 * port handover. Otherwise it might see that a full-speed device
4970 * was gone before the EHCI controller had handed its port over to
4971 * the companion full-speed controller.
4977 wait_event_freezable(khubd_wait,
4978 !list_empty(&hub_event_list) ||
4979 kthread_should_stop());
4980 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4982 pr_debug("%s: khubd exiting\n", usbcore_name);
4986 static const struct usb_device_id hub_id_table[] = {
4987 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4988 | USB_DEVICE_ID_MATCH_INT_CLASS,
4989 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4990 .bInterfaceClass = USB_CLASS_HUB,
4991 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4992 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4993 .bDeviceClass = USB_CLASS_HUB},
4994 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4995 .bInterfaceClass = USB_CLASS_HUB},
4996 { } /* Terminating entry */
4999 MODULE_DEVICE_TABLE (usb, hub_id_table);
5001 static struct usb_driver hub_driver = {
5004 .disconnect = hub_disconnect,
5005 .suspend = hub_suspend,
5006 .resume = hub_resume,
5007 .reset_resume = hub_reset_resume,
5008 .pre_reset = hub_pre_reset,
5009 .post_reset = hub_post_reset,
5010 .unlocked_ioctl = hub_ioctl,
5011 .id_table = hub_id_table,
5012 .supports_autosuspend = 1,
5015 int usb_hub_init(void)
5017 if (usb_register(&hub_driver) < 0) {
5018 printk(KERN_ERR "%s: can't register hub driver\n",
5023 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5024 if (!IS_ERR(khubd_task))
5027 /* Fall through if kernel_thread failed */
5028 usb_deregister(&hub_driver);
5029 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5034 void usb_hub_cleanup(void)
5036 kthread_stop(khubd_task);
5039 * Hub resources are freed for us by usb_deregister. It calls
5040 * usb_driver_purge on every device which in turn calls that
5041 * devices disconnect function if it is using this driver.
5042 * The hub_disconnect function takes care of releasing the
5043 * individual hub resources. -greg
5045 usb_deregister(&hub_driver);
5046 } /* usb_hub_cleanup() */
5048 static int descriptors_changed(struct usb_device *udev,
5049 struct usb_device_descriptor *old_device_descriptor,
5050 struct usb_host_bos *old_bos)
5054 unsigned serial_len = 0;
5056 unsigned old_length;
5060 if (memcmp(&udev->descriptor, old_device_descriptor,
5061 sizeof(*old_device_descriptor)) != 0)
5064 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5067 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5068 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5070 if (memcmp(udev->bos->desc, old_bos->desc, len))
5074 /* Since the idVendor, idProduct, and bcdDevice values in the
5075 * device descriptor haven't changed, we will assume the
5076 * Manufacturer and Product strings haven't changed either.
5077 * But the SerialNumber string could be different (e.g., a
5078 * different flash card of the same brand).
5081 serial_len = strlen(udev->serial) + 1;
5084 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5085 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5086 len = max(len, old_length);
5089 buf = kmalloc(len, GFP_NOIO);
5091 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5092 /* assume the worst */
5095 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5096 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5097 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5099 if (length != old_length) {
5100 dev_dbg(&udev->dev, "config index %d, error %d\n",
5105 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5107 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5109 ((struct usb_config_descriptor *) buf)->
5110 bConfigurationValue);
5116 if (!changed && serial_len) {
5117 length = usb_string(udev, udev->descriptor.iSerialNumber,
5119 if (length + 1 != serial_len) {
5120 dev_dbg(&udev->dev, "serial string error %d\n",
5123 } else if (memcmp(buf, udev->serial, length) != 0) {
5124 dev_dbg(&udev->dev, "serial string changed\n");
5134 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5135 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5137 * WARNING - don't use this routine to reset a composite device
5138 * (one with multiple interfaces owned by separate drivers)!
5139 * Use usb_reset_device() instead.
5141 * Do a port reset, reassign the device's address, and establish its
5142 * former operating configuration. If the reset fails, or the device's
5143 * descriptors change from their values before the reset, or the original
5144 * configuration and altsettings cannot be restored, a flag will be set
5145 * telling khubd to pretend the device has been disconnected and then
5146 * re-connected. All drivers will be unbound, and the device will be
5147 * re-enumerated and probed all over again.
5149 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5150 * flagged for logical disconnection, or some other negative error code
5151 * if the reset wasn't even attempted.
5154 * The caller must own the device lock. For example, it's safe to use
5155 * this from a driver probe() routine after downloading new firmware.
5156 * For calls that might not occur during probe(), drivers should lock
5157 * the device using usb_lock_device_for_reset().
5159 * Locking exception: This routine may also be called from within an
5160 * autoresume handler. Such usage won't conflict with other tasks
5161 * holding the device lock because these tasks should always call
5162 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5164 static int usb_reset_and_verify_device(struct usb_device *udev)
5166 struct usb_device *parent_hdev = udev->parent;
5167 struct usb_hub *parent_hub;
5168 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5169 struct usb_device_descriptor descriptor = udev->descriptor;
5170 struct usb_host_bos *bos;
5172 int port1 = udev->portnum;
5174 if (udev->state == USB_STATE_NOTATTACHED ||
5175 udev->state == USB_STATE_SUSPENDED) {
5176 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5182 /* this requires hcd-specific logic; see ohci_restart() */
5183 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5186 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5188 /* Disable USB2 hardware LPM.
5189 * It will be re-enabled by the enumeration process.
5191 if (udev->usb2_hw_lpm_enabled == 1)
5192 usb_set_usb2_hardware_lpm(udev, 0);
5197 /* Disable LPM and LTM while we reset the device and reinstall the alt
5198 * settings. Device-initiated LPM settings, and system exit latency
5199 * settings are cleared when the device is reset, so we have to set
5202 ret = usb_unlocked_disable_lpm(udev);
5204 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5207 ret = usb_disable_ltm(udev);
5209 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5214 set_bit(port1, parent_hub->busy_bits);
5215 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5217 /* ep0 maxpacket size may change; let the HCD know about it.
5218 * Other endpoints will be handled by re-enumeration. */
5219 usb_ep0_reinit(udev);
5220 ret = hub_port_init(parent_hub, udev, port1, i);
5221 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5224 clear_bit(port1, parent_hub->busy_bits);
5229 /* Device might have changed firmware (DFU or similar) */
5230 if (descriptors_changed(udev, &descriptor, bos)) {
5231 dev_info(&udev->dev, "device firmware changed\n");
5232 udev->descriptor = descriptor; /* for disconnect() calls */
5236 /* Restore the device's previous configuration */
5237 if (!udev->actconfig)
5240 mutex_lock(hcd->bandwidth_mutex);
5241 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5243 dev_warn(&udev->dev,
5244 "Busted HC? Not enough HCD resources for "
5245 "old configuration.\n");
5246 mutex_unlock(hcd->bandwidth_mutex);
5249 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5250 USB_REQ_SET_CONFIGURATION, 0,
5251 udev->actconfig->desc.bConfigurationValue, 0,
5252 NULL, 0, USB_CTRL_SET_TIMEOUT);
5255 "can't restore configuration #%d (error=%d)\n",
5256 udev->actconfig->desc.bConfigurationValue, ret);
5257 mutex_unlock(hcd->bandwidth_mutex);
5260 mutex_unlock(hcd->bandwidth_mutex);
5261 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5263 /* Put interfaces back into the same altsettings as before.
5264 * Don't bother to send the Set-Interface request for interfaces
5265 * that were already in altsetting 0; besides being unnecessary,
5266 * many devices can't handle it. Instead just reset the host-side
5269 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5270 struct usb_host_config *config = udev->actconfig;
5271 struct usb_interface *intf = config->interface[i];
5272 struct usb_interface_descriptor *desc;
5274 desc = &intf->cur_altsetting->desc;
5275 if (desc->bAlternateSetting == 0) {
5276 usb_disable_interface(udev, intf, true);
5277 usb_enable_interface(udev, intf, true);
5280 /* Let the bandwidth allocation function know that this
5281 * device has been reset, and it will have to use
5282 * alternate setting 0 as the current alternate setting.
5284 intf->resetting_device = 1;
5285 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5286 desc->bAlternateSetting);
5287 intf->resetting_device = 0;
5290 dev_err(&udev->dev, "failed to restore interface %d "
5291 "altsetting %d (error=%d)\n",
5292 desc->bInterfaceNumber,
5293 desc->bAlternateSetting,
5297 /* Resetting also frees any allocated streams */
5298 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5299 intf->cur_altsetting->endpoint[j].streams = 0;
5303 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5304 usb_set_usb2_hardware_lpm(udev, 1);
5305 usb_unlocked_enable_lpm(udev);
5306 usb_enable_ltm(udev);
5307 usb_release_bos_descriptor(udev);
5312 /* LPM state doesn't matter when we're about to destroy the device. */
5313 hub_port_logical_disconnect(parent_hub, port1);
5314 usb_release_bos_descriptor(udev);
5320 * usb_reset_device - warn interface drivers and perform a USB port reset
5321 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5323 * Warns all drivers bound to registered interfaces (using their pre_reset
5324 * method), performs the port reset, and then lets the drivers know that
5325 * the reset is over (using their post_reset method).
5327 * Return: The same as for usb_reset_and_verify_device().
5330 * The caller must own the device lock. For example, it's safe to use
5331 * this from a driver probe() routine after downloading new firmware.
5332 * For calls that might not occur during probe(), drivers should lock
5333 * the device using usb_lock_device_for_reset().
5335 * If an interface is currently being probed or disconnected, we assume
5336 * its driver knows how to handle resets. For all other interfaces,
5337 * if the driver doesn't have pre_reset and post_reset methods then
5338 * we attempt to unbind it and rebind afterward.
5340 int usb_reset_device(struct usb_device *udev)
5344 unsigned int noio_flag;
5345 struct usb_host_config *config = udev->actconfig;
5347 if (udev->state == USB_STATE_NOTATTACHED ||
5348 udev->state == USB_STATE_SUSPENDED) {
5349 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5355 * Don't allocate memory with GFP_KERNEL in current
5356 * context to avoid possible deadlock if usb mass
5357 * storage interface or usbnet interface(iSCSI case)
5358 * is included in current configuration. The easist
5359 * approach is to do it for every device reset,
5360 * because the device 'memalloc_noio' flag may have
5361 * not been set before reseting the usb device.
5363 noio_flag = memalloc_noio_save();
5365 /* Prevent autosuspend during the reset */
5366 usb_autoresume_device(udev);
5369 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5370 struct usb_interface *cintf = config->interface[i];
5371 struct usb_driver *drv;
5374 if (cintf->dev.driver) {
5375 drv = to_usb_driver(cintf->dev.driver);
5376 if (drv->pre_reset && drv->post_reset)
5377 unbind = (drv->pre_reset)(cintf);
5378 else if (cintf->condition ==
5379 USB_INTERFACE_BOUND)
5382 usb_forced_unbind_intf(cintf);
5387 ret = usb_reset_and_verify_device(udev);
5390 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5391 struct usb_interface *cintf = config->interface[i];
5392 struct usb_driver *drv;
5393 int rebind = cintf->needs_binding;
5395 if (!rebind && cintf->dev.driver) {
5396 drv = to_usb_driver(cintf->dev.driver);
5397 if (drv->post_reset)
5398 rebind = (drv->post_reset)(cintf);
5399 else if (cintf->condition ==
5400 USB_INTERFACE_BOUND)
5403 cintf->needs_binding = 1;
5406 usb_unbind_and_rebind_marked_interfaces(udev);
5409 usb_autosuspend_device(udev);
5410 memalloc_noio_restore(noio_flag);
5413 EXPORT_SYMBOL_GPL(usb_reset_device);
5417 * usb_queue_reset_device - Reset a USB device from an atomic context
5418 * @iface: USB interface belonging to the device to reset
5420 * This function can be used to reset a USB device from an atomic
5421 * context, where usb_reset_device() won't work (as it blocks).
5423 * Doing a reset via this method is functionally equivalent to calling
5424 * usb_reset_device(), except for the fact that it is delayed to a
5425 * workqueue. This means that any drivers bound to other interfaces
5426 * might be unbound, as well as users from usbfs in user space.
5430 * - Scheduling two resets at the same time from two different drivers
5431 * attached to two different interfaces of the same device is
5432 * possible; depending on how the driver attached to each interface
5433 * handles ->pre_reset(), the second reset might happen or not.
5435 * - If a driver is unbound and it had a pending reset, the reset will
5438 * - This function can be called during .probe() or .disconnect()
5439 * times. On return from .disconnect(), any pending resets will be
5442 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5445 * NOTE: We don't do any reference count tracking because it is not
5446 * needed. The lifecycle of the work_struct is tied to the
5447 * usb_interface. Before destroying the interface we cancel the
5448 * work_struct, so the fact that work_struct is queued and or
5449 * running means the interface (and thus, the device) exist and
5452 void usb_queue_reset_device(struct usb_interface *iface)
5454 schedule_work(&iface->reset_ws);
5456 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5459 * usb_hub_find_child - Get the pointer of child device
5460 * attached to the port which is specified by @port1.
5461 * @hdev: USB device belonging to the usb hub
5462 * @port1: port num to indicate which port the child device
5465 * USB drivers call this function to get hub's child device
5468 * Return: %NULL if input param is invalid and
5469 * child's usb_device pointer if non-NULL.
5471 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5474 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5476 if (port1 < 1 || port1 > hdev->maxchild)
5478 return hub->ports[port1 - 1]->child;
5480 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5482 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5483 struct usb_hub_descriptor *desc)
5485 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5486 enum usb_port_connect_type connect_type;
5492 if (!hub_is_superspeed(hdev)) {
5493 for (i = 1; i <= hdev->maxchild; i++) {
5494 struct usb_port *port_dev = hub->ports[i - 1];
5496 connect_type = port_dev->connect_type;
5497 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5498 u8 mask = 1 << (i%8);
5500 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5501 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5502 desc->u.hs.DeviceRemovable[i/8] |= mask;
5507 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5509 for (i = 1; i <= hdev->maxchild; i++) {
5510 struct usb_port *port_dev = hub->ports[i - 1];
5512 connect_type = port_dev->connect_type;
5513 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5516 if (!(port_removable & mask)) {
5517 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5518 port_removable |= mask;
5523 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5529 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5530 * @hdev: USB device belonging to the usb hub
5531 * @port1: port num of the port
5533 * Return: Port's acpi handle if successful, %NULL if params are
5536 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5539 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5544 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);