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,
416 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
417 * for info about using port indicators
419 static void set_port_led(
425 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
426 USB_PORT_FEAT_INDICATOR);
428 dev_dbg (hub->intfdev,
429 "port %d indicator %s status %d\n",
431 ({ char *s; switch (selector) {
432 case HUB_LED_AMBER: s = "amber"; break;
433 case HUB_LED_GREEN: s = "green"; break;
434 case HUB_LED_OFF: s = "off"; break;
435 case HUB_LED_AUTO: s = "auto"; break;
436 default: s = "??"; break;
441 #define LED_CYCLE_PERIOD ((2*HZ)/3)
443 static void led_work (struct work_struct *work)
445 struct usb_hub *hub =
446 container_of(work, struct usb_hub, leds.work);
447 struct usb_device *hdev = hub->hdev;
449 unsigned changed = 0;
452 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
455 for (i = 0; i < hdev->maxchild; i++) {
456 unsigned selector, mode;
458 /* 30%-50% duty cycle */
460 switch (hub->indicator[i]) {
462 case INDICATOR_CYCLE:
464 selector = HUB_LED_AUTO;
465 mode = INDICATOR_AUTO;
467 /* blinking green = sw attention */
468 case INDICATOR_GREEN_BLINK:
469 selector = HUB_LED_GREEN;
470 mode = INDICATOR_GREEN_BLINK_OFF;
472 case INDICATOR_GREEN_BLINK_OFF:
473 selector = HUB_LED_OFF;
474 mode = INDICATOR_GREEN_BLINK;
476 /* blinking amber = hw attention */
477 case INDICATOR_AMBER_BLINK:
478 selector = HUB_LED_AMBER;
479 mode = INDICATOR_AMBER_BLINK_OFF;
481 case INDICATOR_AMBER_BLINK_OFF:
482 selector = HUB_LED_OFF;
483 mode = INDICATOR_AMBER_BLINK;
485 /* blink green/amber = reserved */
486 case INDICATOR_ALT_BLINK:
487 selector = HUB_LED_GREEN;
488 mode = INDICATOR_ALT_BLINK_OFF;
490 case INDICATOR_ALT_BLINK_OFF:
491 selector = HUB_LED_AMBER;
492 mode = INDICATOR_ALT_BLINK;
497 if (selector != HUB_LED_AUTO)
499 set_port_led(hub, i + 1, selector);
500 hub->indicator[i] = mode;
502 if (!changed && blinkenlights) {
504 cursor %= hdev->maxchild;
505 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
506 hub->indicator[cursor] = INDICATOR_CYCLE;
510 queue_delayed_work(system_power_efficient_wq,
511 &hub->leds, LED_CYCLE_PERIOD);
514 /* use a short timeout for hub/port status fetches */
515 #define USB_STS_TIMEOUT 1000
516 #define USB_STS_RETRIES 5
519 * USB 2.0 spec Section 11.24.2.6
521 static int get_hub_status(struct usb_device *hdev,
522 struct usb_hub_status *data)
524 int i, status = -ETIMEDOUT;
526 for (i = 0; i < USB_STS_RETRIES &&
527 (status == -ETIMEDOUT || status == -EPIPE); i++) {
528 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
529 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
530 data, sizeof(*data), USB_STS_TIMEOUT);
536 * USB 2.0 spec Section 11.24.2.7
538 static int get_port_status(struct usb_device *hdev, int port1,
539 struct usb_port_status *data)
541 int i, status = -ETIMEDOUT;
543 for (i = 0; i < USB_STS_RETRIES &&
544 (status == -ETIMEDOUT || status == -EPIPE); i++) {
545 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
546 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
547 data, sizeof(*data), USB_STS_TIMEOUT);
552 static int hub_port_status(struct usb_hub *hub, int port1,
553 u16 *status, u16 *change)
557 mutex_lock(&hub->status_mutex);
558 ret = get_port_status(hub->hdev, port1, &hub->status->port);
561 dev_err(hub->intfdev,
562 "%s failed (err = %d)\n", __func__, ret);
566 *status = le16_to_cpu(hub->status->port.wPortStatus);
567 *change = le16_to_cpu(hub->status->port.wPortChange);
571 mutex_unlock(&hub->status_mutex);
575 static void kick_khubd(struct usb_hub *hub)
579 spin_lock_irqsave(&hub_event_lock, flags);
580 if (!hub->disconnected && list_empty(&hub->event_list)) {
581 list_add_tail(&hub->event_list, &hub_event_list);
583 /* Suppress autosuspend until khubd runs */
584 usb_autopm_get_interface_no_resume(
585 to_usb_interface(hub->intfdev));
586 wake_up(&khubd_wait);
588 spin_unlock_irqrestore(&hub_event_lock, flags);
591 void usb_kick_khubd(struct usb_device *hdev)
593 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
600 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
601 * Notification, which indicates it had initiated remote wakeup.
603 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
604 * device initiates resume, so the USB core will not receive notice of the
605 * resume through the normal hub interrupt URB.
607 void usb_wakeup_notification(struct usb_device *hdev,
608 unsigned int portnum)
615 hub = usb_hub_to_struct_hub(hdev);
617 set_bit(portnum, hub->wakeup_bits);
621 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
623 /* completion function, fires on port status changes and various faults */
624 static void hub_irq(struct urb *urb)
626 struct usb_hub *hub = urb->context;
627 int status = urb->status;
632 case -ENOENT: /* synchronous unlink */
633 case -ECONNRESET: /* async unlink */
634 case -ESHUTDOWN: /* hardware going away */
637 default: /* presumably an error */
638 /* Cause a hub reset after 10 consecutive errors */
639 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
640 if ((++hub->nerrors < 10) || hub->error)
645 /* let khubd handle things */
646 case 0: /* we got data: port status changed */
648 for (i = 0; i < urb->actual_length; ++i)
649 bits |= ((unsigned long) ((*hub->buffer)[i]))
651 hub->event_bits[0] = bits;
657 /* Something happened, let khubd figure it out */
664 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
665 && status != -ENODEV && status != -EPERM)
666 dev_err (hub->intfdev, "resubmit --> %d\n", status);
669 /* USB 2.0 spec Section 11.24.2.3 */
671 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
673 /* Need to clear both directions for control ep */
674 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
675 USB_ENDPOINT_XFER_CONTROL) {
676 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
677 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
678 devinfo ^ 0x8000, tt, NULL, 0, 1000);
682 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
683 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
688 * enumeration blocks khubd for a long time. we use keventd instead, since
689 * long blocking there is the exception, not the rule. accordingly, HCDs
690 * talking to TTs must queue control transfers (not just bulk and iso), so
691 * both can talk to the same hub concurrently.
693 static void hub_tt_work(struct work_struct *work)
695 struct usb_hub *hub =
696 container_of(work, struct usb_hub, tt.clear_work);
699 spin_lock_irqsave (&hub->tt.lock, flags);
700 while (!list_empty(&hub->tt.clear_list)) {
701 struct list_head *next;
702 struct usb_tt_clear *clear;
703 struct usb_device *hdev = hub->hdev;
704 const struct hc_driver *drv;
707 next = hub->tt.clear_list.next;
708 clear = list_entry (next, struct usb_tt_clear, clear_list);
709 list_del (&clear->clear_list);
711 /* drop lock so HCD can concurrently report other TT errors */
712 spin_unlock_irqrestore (&hub->tt.lock, flags);
713 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
714 if (status && status != -ENODEV)
716 "clear tt %d (%04x) error %d\n",
717 clear->tt, clear->devinfo, status);
719 /* Tell the HCD, even if the operation failed */
720 drv = clear->hcd->driver;
721 if (drv->clear_tt_buffer_complete)
722 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
725 spin_lock_irqsave(&hub->tt.lock, flags);
727 spin_unlock_irqrestore (&hub->tt.lock, flags);
731 * usb_hub_set_port_power - control hub port's power state
732 * @hdev: USB device belonging to the usb hub
735 * @set: expected status
737 * call this function to control port's power via setting or
738 * clearing the port's PORT_POWER feature.
740 * Return: 0 if successful. A negative error code otherwise.
742 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
746 struct usb_port *port_dev = hub->ports[port1 - 1];
749 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
751 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
754 port_dev->power_is_on = set;
759 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
760 * @urb: an URB associated with the failed or incomplete split transaction
762 * High speed HCDs use this to tell the hub driver that some split control or
763 * bulk transaction failed in a way that requires clearing internal state of
764 * a transaction translator. This is normally detected (and reported) from
767 * It may not be possible for that hub to handle additional full (or low)
768 * speed transactions until that state is fully cleared out.
770 * Return: 0 if successful. A negative error code otherwise.
772 int usb_hub_clear_tt_buffer(struct urb *urb)
774 struct usb_device *udev = urb->dev;
775 int pipe = urb->pipe;
776 struct usb_tt *tt = udev->tt;
778 struct usb_tt_clear *clear;
780 /* we've got to cope with an arbitrary number of pending TT clears,
781 * since each TT has "at least two" buffers that can need it (and
782 * there can be many TTs per hub). even if they're uncommon.
784 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
785 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
786 /* FIXME recover somehow ... RESET_TT? */
790 /* info that CLEAR_TT_BUFFER needs */
791 clear->tt = tt->multi ? udev->ttport : 1;
792 clear->devinfo = usb_pipeendpoint (pipe);
793 clear->devinfo |= udev->devnum << 4;
794 clear->devinfo |= usb_pipecontrol (pipe)
795 ? (USB_ENDPOINT_XFER_CONTROL << 11)
796 : (USB_ENDPOINT_XFER_BULK << 11);
797 if (usb_pipein (pipe))
798 clear->devinfo |= 1 << 15;
800 /* info for completion callback */
801 clear->hcd = bus_to_hcd(udev->bus);
804 /* tell keventd to clear state for this TT */
805 spin_lock_irqsave (&tt->lock, flags);
806 list_add_tail (&clear->clear_list, &tt->clear_list);
807 schedule_work(&tt->clear_work);
808 spin_unlock_irqrestore (&tt->lock, flags);
811 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
813 /* If do_delay is false, return the number of milliseconds the caller
816 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
819 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
821 u16 wHubCharacteristics =
822 le16_to_cpu(hub->descriptor->wHubCharacteristics);
824 /* Enable power on each port. Some hubs have reserved values
825 * of LPSM (> 2) in their descriptors, even though they are
826 * USB 2.0 hubs. Some hubs do not implement port-power switching
827 * but only emulate it. In all cases, the ports won't work
828 * unless we send these messages to the hub.
830 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
831 dev_dbg(hub->intfdev, "enabling power on all ports\n");
833 dev_dbg(hub->intfdev, "trying to enable port power on "
834 "non-switchable hub\n");
835 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
836 if (hub->ports[port1 - 1]->power_is_on)
837 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
839 usb_clear_port_feature(hub->hdev, port1,
840 USB_PORT_FEAT_POWER);
842 /* Wait at least 100 msec for power to become stable */
843 delay = max(pgood_delay, (unsigned) 100);
849 static int hub_hub_status(struct usb_hub *hub,
850 u16 *status, u16 *change)
854 mutex_lock(&hub->status_mutex);
855 ret = get_hub_status(hub->hdev, &hub->status->hub);
858 dev_err(hub->intfdev,
859 "%s failed (err = %d)\n", __func__, ret);
861 *status = le16_to_cpu(hub->status->hub.wHubStatus);
862 *change = le16_to_cpu(hub->status->hub.wHubChange);
865 mutex_unlock(&hub->status_mutex);
869 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
870 unsigned int link_status)
872 return set_port_feature(hub->hdev,
873 port1 | (link_status << 3),
874 USB_PORT_FEAT_LINK_STATE);
878 * If USB 3.0 ports are placed into the Disabled state, they will no longer
879 * detect any device connects or disconnects. This is generally not what the
880 * USB core wants, since it expects a disabled port to produce a port status
881 * change event when a new device connects.
883 * Instead, set the link state to Disabled, wait for the link to settle into
884 * that state, clear any change bits, and then put the port into the RxDetect
887 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
891 u16 portchange, portstatus;
893 if (!hub_is_superspeed(hub->hdev))
896 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
900 /* Wait for the link to enter the disabled state. */
901 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
902 ret = hub_port_status(hub, port1, &portstatus, &portchange);
906 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
907 USB_SS_PORT_LS_SS_DISABLED)
909 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
911 msleep(HUB_DEBOUNCE_STEP);
913 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
914 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
917 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
920 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
922 struct usb_device *hdev = hub->hdev;
925 if (hub->ports[port1 - 1]->child && set_state)
926 usb_set_device_state(hub->ports[port1 - 1]->child,
927 USB_STATE_NOTATTACHED);
929 if (hub_is_superspeed(hub->hdev))
930 ret = hub_usb3_port_disable(hub, port1);
932 ret = usb_clear_port_feature(hdev, port1,
933 USB_PORT_FEAT_ENABLE);
935 if (ret && ret != -ENODEV)
936 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
942 * Disable a port and mark a logical connect-change event, so that some
943 * time later khubd will disconnect() any existing usb_device on the port
944 * and will re-enumerate if there actually is a device attached.
946 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
948 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
949 hub_port_disable(hub, port1, 1);
951 /* FIXME let caller ask to power down the port:
952 * - some devices won't enumerate without a VBUS power cycle
953 * - SRP saves power that way
954 * - ... new call, TBD ...
955 * That's easy if this hub can switch power per-port, and
956 * khubd reactivates the port later (timer, SRP, etc).
957 * Powerdown must be optional, because of reset/DFU.
960 set_bit(port1, hub->change_bits);
965 * usb_remove_device - disable a device's port on its parent hub
966 * @udev: device to be disabled and removed
967 * Context: @udev locked, must be able to sleep.
969 * After @udev's port has been disabled, khubd is notified and it will
970 * see that the device has been disconnected. When the device is
971 * physically unplugged and something is plugged in, the events will
972 * be received and processed normally.
974 * Return: 0 if successful. A negative error code otherwise.
976 int usb_remove_device(struct usb_device *udev)
979 struct usb_interface *intf;
981 if (!udev->parent) /* Can't remove a root hub */
983 hub = usb_hub_to_struct_hub(udev->parent);
984 intf = to_usb_interface(hub->intfdev);
986 usb_autopm_get_interface(intf);
987 set_bit(udev->portnum, hub->removed_bits);
988 hub_port_logical_disconnect(hub, udev->portnum);
989 usb_autopm_put_interface(intf);
993 enum hub_activation_type {
994 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
995 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
998 static void hub_init_func2(struct work_struct *ws);
999 static void hub_init_func3(struct work_struct *ws);
1001 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1003 struct usb_device *hdev = hub->hdev;
1004 struct usb_hcd *hcd;
1008 bool need_debounce_delay = false;
1011 /* Continue a partial initialization */
1012 if (type == HUB_INIT2)
1014 if (type == HUB_INIT3)
1017 /* The superspeed hub except for root hub has to use Hub Depth
1018 * value as an offset into the route string to locate the bits
1019 * it uses to determine the downstream port number. So hub driver
1020 * should send a set hub depth request to superspeed hub after
1021 * the superspeed hub is set configuration in initialization or
1024 * After a resume, port power should still be on.
1025 * For any other type of activation, turn it on.
1027 if (type != HUB_RESUME) {
1028 if (hdev->parent && hub_is_superspeed(hdev)) {
1029 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1030 HUB_SET_DEPTH, USB_RT_HUB,
1031 hdev->level - 1, 0, NULL, 0,
1032 USB_CTRL_SET_TIMEOUT);
1034 dev_err(hub->intfdev,
1035 "set hub depth failed\n");
1038 /* Speed up system boot by using a delayed_work for the
1039 * hub's initial power-up delays. This is pretty awkward
1040 * and the implementation looks like a home-brewed sort of
1041 * setjmp/longjmp, but it saves at least 100 ms for each
1042 * root hub (assuming usbcore is compiled into the kernel
1043 * rather than as a module). It adds up.
1045 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1046 * because for those activation types the ports have to be
1047 * operational when we return. In theory this could be done
1048 * for HUB_POST_RESET, but it's easier not to.
1050 if (type == HUB_INIT) {
1051 delay = hub_power_on(hub, false);
1052 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1053 queue_delayed_work(system_power_efficient_wq,
1055 msecs_to_jiffies(delay));
1057 /* Suppress autosuspend until init is done */
1058 usb_autopm_get_interface_no_resume(
1059 to_usb_interface(hub->intfdev));
1060 return; /* Continues at init2: below */
1061 } else if (type == HUB_RESET_RESUME) {
1062 /* The internal host controller state for the hub device
1063 * may be gone after a host power loss on system resume.
1064 * Update the device's info so the HW knows it's a hub.
1066 hcd = bus_to_hcd(hdev->bus);
1067 if (hcd->driver->update_hub_device) {
1068 ret = hcd->driver->update_hub_device(hcd, hdev,
1069 &hub->tt, GFP_NOIO);
1071 dev_err(hub->intfdev, "Host not "
1072 "accepting hub info "
1074 dev_err(hub->intfdev, "LS/FS devices "
1075 "and hubs may not work "
1076 "under this hub\n.");
1079 hub_power_on(hub, true);
1081 hub_power_on(hub, true);
1086 /* Check each port and set hub->change_bits to let khubd know
1087 * which ports need attention.
1089 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1090 struct usb_device *udev = hub->ports[port1 - 1]->child;
1091 u16 portstatus, portchange;
1093 portstatus = portchange = 0;
1094 status = hub_port_status(hub, port1, &portstatus, &portchange);
1095 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1096 dev_dbg(hub->intfdev,
1097 "port %d: status %04x change %04x\n",
1098 port1, portstatus, portchange);
1100 /* After anything other than HUB_RESUME (i.e., initialization
1101 * or any sort of reset), every port should be disabled.
1102 * Unconnected ports should likewise be disabled (paranoia),
1103 * and so should ports for which we have no usb_device.
1105 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1106 type != HUB_RESUME ||
1107 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1109 udev->state == USB_STATE_NOTATTACHED)) {
1111 * USB3 protocol ports will automatically transition
1112 * to Enabled state when detect an USB3.0 device attach.
1113 * Do not disable USB3 protocol ports, just pretend
1116 portstatus &= ~USB_PORT_STAT_ENABLE;
1117 if (!hub_is_superspeed(hdev))
1118 usb_clear_port_feature(hdev, port1,
1119 USB_PORT_FEAT_ENABLE);
1122 /* Clear status-change flags; we'll debounce later */
1123 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1124 need_debounce_delay = true;
1125 usb_clear_port_feature(hub->hdev, port1,
1126 USB_PORT_FEAT_C_CONNECTION);
1128 if (portchange & USB_PORT_STAT_C_ENABLE) {
1129 need_debounce_delay = true;
1130 usb_clear_port_feature(hub->hdev, port1,
1131 USB_PORT_FEAT_C_ENABLE);
1133 if (portchange & USB_PORT_STAT_C_RESET) {
1134 need_debounce_delay = true;
1135 usb_clear_port_feature(hub->hdev, port1,
1136 USB_PORT_FEAT_C_RESET);
1138 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1139 hub_is_superspeed(hub->hdev)) {
1140 need_debounce_delay = true;
1141 usb_clear_port_feature(hub->hdev, port1,
1142 USB_PORT_FEAT_C_BH_PORT_RESET);
1144 /* We can forget about a "removed" device when there's a
1145 * physical disconnect or the connect status changes.
1147 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1148 (portchange & USB_PORT_STAT_C_CONNECTION))
1149 clear_bit(port1, hub->removed_bits);
1151 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1152 /* Tell khubd to disconnect the device or
1153 * check for a new connection
1155 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1156 (portstatus & USB_PORT_STAT_OVERCURRENT))
1157 set_bit(port1, hub->change_bits);
1159 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1160 bool port_resumed = (portstatus &
1161 USB_PORT_STAT_LINK_STATE) ==
1163 /* The power session apparently survived the resume.
1164 * If there was an overcurrent or suspend change
1165 * (i.e., remote wakeup request), have khubd
1166 * take care of it. Look at the port link state
1167 * for USB 3.0 hubs, since they don't have a suspend
1168 * change bit, and they don't set the port link change
1169 * bit on device-initiated resume.
1171 if (portchange || (hub_is_superspeed(hub->hdev) &&
1173 set_bit(port1, hub->change_bits);
1175 } else if (udev->persist_enabled) {
1176 struct usb_port *port_dev = hub->ports[port1 - 1];
1179 udev->reset_resume = 1;
1181 /* Don't set the change_bits when the device
1184 if (port_dev->power_is_on)
1185 set_bit(port1, hub->change_bits);
1188 /* The power session is gone; tell khubd */
1189 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1190 set_bit(port1, hub->change_bits);
1194 /* If no port-status-change flags were set, we don't need any
1195 * debouncing. If flags were set we can try to debounce the
1196 * ports all at once right now, instead of letting khubd do them
1197 * one at a time later on.
1199 * If any port-status changes do occur during this delay, khubd
1200 * will see them later and handle them normally.
1202 if (need_debounce_delay) {
1203 delay = HUB_DEBOUNCE_STABLE;
1205 /* Don't do a long sleep inside a workqueue routine */
1206 if (type == HUB_INIT2) {
1207 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1208 queue_delayed_work(system_power_efficient_wq,
1210 msecs_to_jiffies(delay));
1211 return; /* Continues at init3: below */
1219 status = usb_submit_urb(hub->urb, GFP_NOIO);
1221 dev_err(hub->intfdev, "activate --> %d\n", status);
1222 if (hub->has_indicators && blinkenlights)
1223 queue_delayed_work(system_power_efficient_wq,
1224 &hub->leds, LED_CYCLE_PERIOD);
1226 /* Scan all ports that need attention */
1229 /* Allow autosuspend if it was suppressed */
1230 if (type <= HUB_INIT3)
1231 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1234 /* Implement the continuations for the delays above */
1235 static void hub_init_func2(struct work_struct *ws)
1237 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1239 hub_activate(hub, HUB_INIT2);
1242 static void hub_init_func3(struct work_struct *ws)
1244 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1246 hub_activate(hub, HUB_INIT3);
1249 enum hub_quiescing_type {
1250 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1253 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1255 struct usb_device *hdev = hub->hdev;
1258 cancel_delayed_work_sync(&hub->init_work);
1260 /* khubd and related activity won't re-trigger */
1263 if (type != HUB_SUSPEND) {
1264 /* Disconnect all the children */
1265 for (i = 0; i < hdev->maxchild; ++i) {
1266 if (hub->ports[i]->child)
1267 usb_disconnect(&hub->ports[i]->child);
1271 /* Stop khubd and related activity */
1272 usb_kill_urb(hub->urb);
1273 if (hub->has_indicators)
1274 cancel_delayed_work_sync(&hub->leds);
1276 flush_work(&hub->tt.clear_work);
1279 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1283 for (i = 0; i < hub->hdev->maxchild; ++i)
1284 pm_runtime_barrier(&hub->ports[i]->dev);
1287 /* caller has locked the hub device */
1288 static int hub_pre_reset(struct usb_interface *intf)
1290 struct usb_hub *hub = usb_get_intfdata(intf);
1292 hub_quiesce(hub, HUB_PRE_RESET);
1294 hub_pm_barrier_for_all_ports(hub);
1298 /* caller has locked the hub device */
1299 static int hub_post_reset(struct usb_interface *intf)
1301 struct usb_hub *hub = usb_get_intfdata(intf);
1304 hub_pm_barrier_for_all_ports(hub);
1305 hub_activate(hub, HUB_POST_RESET);
1309 static int hub_configure(struct usb_hub *hub,
1310 struct usb_endpoint_descriptor *endpoint)
1312 struct usb_hcd *hcd;
1313 struct usb_device *hdev = hub->hdev;
1314 struct device *hub_dev = hub->intfdev;
1315 u16 hubstatus, hubchange;
1316 u16 wHubCharacteristics;
1319 char *message = "out of memory";
1323 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1329 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1334 mutex_init(&hub->status_mutex);
1336 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1337 if (!hub->descriptor) {
1342 /* Request the entire hub descriptor.
1343 * hub->descriptor can handle USB_MAXCHILDREN ports,
1344 * but the hub can/will return fewer bytes here.
1346 ret = get_hub_descriptor(hdev, hub->descriptor);
1348 message = "can't read hub descriptor";
1350 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1351 message = "hub has too many ports!";
1354 } else if (hub->descriptor->bNbrPorts == 0) {
1355 message = "hub doesn't have any ports!";
1360 hdev->maxchild = hub->descriptor->bNbrPorts;
1361 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1362 (hdev->maxchild == 1) ? "" : "s");
1364 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1371 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1372 if (hub_is_superspeed(hdev)) {
1380 /* FIXME for USB 3.0, skip for now */
1381 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1382 !(hub_is_superspeed(hdev))) {
1384 char portstr[USB_MAXCHILDREN + 1];
1386 for (i = 0; i < hdev->maxchild; i++)
1387 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1388 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1390 portstr[hdev->maxchild] = 0;
1391 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1393 dev_dbg(hub_dev, "standalone hub\n");
1395 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1396 case HUB_CHAR_COMMON_LPSM:
1397 dev_dbg(hub_dev, "ganged power switching\n");
1399 case HUB_CHAR_INDV_PORT_LPSM:
1400 dev_dbg(hub_dev, "individual port power switching\n");
1402 case HUB_CHAR_NO_LPSM:
1404 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1408 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1409 case HUB_CHAR_COMMON_OCPM:
1410 dev_dbg(hub_dev, "global over-current protection\n");
1412 case HUB_CHAR_INDV_PORT_OCPM:
1413 dev_dbg(hub_dev, "individual port over-current protection\n");
1415 case HUB_CHAR_NO_OCPM:
1417 dev_dbg(hub_dev, "no over-current protection\n");
1421 spin_lock_init (&hub->tt.lock);
1422 INIT_LIST_HEAD (&hub->tt.clear_list);
1423 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1424 switch (hdev->descriptor.bDeviceProtocol) {
1427 case USB_HUB_PR_HS_SINGLE_TT:
1428 dev_dbg(hub_dev, "Single TT\n");
1431 case USB_HUB_PR_HS_MULTI_TT:
1432 ret = usb_set_interface(hdev, 0, 1);
1434 dev_dbg(hub_dev, "TT per port\n");
1437 dev_err(hub_dev, "Using single TT (err %d)\n",
1442 /* USB 3.0 hubs don't have a TT */
1445 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1446 hdev->descriptor.bDeviceProtocol);
1450 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1451 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1452 case HUB_TTTT_8_BITS:
1453 if (hdev->descriptor.bDeviceProtocol != 0) {
1454 hub->tt.think_time = 666;
1455 dev_dbg(hub_dev, "TT requires at most %d "
1456 "FS bit times (%d ns)\n",
1457 8, hub->tt.think_time);
1460 case HUB_TTTT_16_BITS:
1461 hub->tt.think_time = 666 * 2;
1462 dev_dbg(hub_dev, "TT requires at most %d "
1463 "FS bit times (%d ns)\n",
1464 16, hub->tt.think_time);
1466 case HUB_TTTT_24_BITS:
1467 hub->tt.think_time = 666 * 3;
1468 dev_dbg(hub_dev, "TT requires at most %d "
1469 "FS bit times (%d ns)\n",
1470 24, hub->tt.think_time);
1472 case HUB_TTTT_32_BITS:
1473 hub->tt.think_time = 666 * 4;
1474 dev_dbg(hub_dev, "TT requires at most %d "
1475 "FS bit times (%d ns)\n",
1476 32, hub->tt.think_time);
1480 /* probe() zeroes hub->indicator[] */
1481 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1482 hub->has_indicators = 1;
1483 dev_dbg(hub_dev, "Port indicators are supported\n");
1486 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1487 hub->descriptor->bPwrOn2PwrGood * 2);
1489 /* power budgeting mostly matters with bus-powered hubs,
1490 * and battery-powered root hubs (may provide just 8 mA).
1492 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1494 message = "can't get hub status";
1497 hcd = bus_to_hcd(hdev->bus);
1498 if (hdev == hdev->bus->root_hub) {
1499 if (hcd->power_budget > 0)
1500 hdev->bus_mA = hcd->power_budget;
1502 hdev->bus_mA = full_load * hdev->maxchild;
1503 if (hdev->bus_mA >= full_load)
1504 hub->mA_per_port = full_load;
1506 hub->mA_per_port = hdev->bus_mA;
1507 hub->limited_power = 1;
1509 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1510 int remaining = hdev->bus_mA -
1511 hub->descriptor->bHubContrCurrent;
1513 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1514 hub->descriptor->bHubContrCurrent);
1515 hub->limited_power = 1;
1517 if (remaining < hdev->maxchild * unit_load)
1519 "insufficient power available "
1520 "to use all downstream ports\n");
1521 hub->mA_per_port = unit_load; /* 7.2.1 */
1523 } else { /* Self-powered external hub */
1524 /* FIXME: What about battery-powered external hubs that
1525 * provide less current per port? */
1526 hub->mA_per_port = full_load;
1528 if (hub->mA_per_port < full_load)
1529 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1532 /* Update the HCD's internal representation of this hub before khubd
1533 * starts getting port status changes for devices under the hub.
1535 if (hcd->driver->update_hub_device) {
1536 ret = hcd->driver->update_hub_device(hcd, hdev,
1537 &hub->tt, GFP_KERNEL);
1539 message = "can't update HCD hub info";
1544 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1546 message = "can't get hub status";
1550 /* local power status reports aren't always correct */
1551 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1552 dev_dbg(hub_dev, "local power source is %s\n",
1553 (hubstatus & HUB_STATUS_LOCAL_POWER)
1554 ? "lost (inactive)" : "good");
1556 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1557 dev_dbg(hub_dev, "%sover-current condition exists\n",
1558 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1560 /* set up the interrupt endpoint
1561 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1562 * bytes as USB2.0[11.12.3] says because some hubs are known
1563 * to send more data (and thus cause overflow). For root hubs,
1564 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1565 * to be big enough for at least USB_MAXCHILDREN ports. */
1566 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1567 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1569 if (maxp > sizeof(*hub->buffer))
1570 maxp = sizeof(*hub->buffer);
1572 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1578 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1579 hub, endpoint->bInterval);
1581 /* maybe cycle the hub leds */
1582 if (hub->has_indicators && blinkenlights)
1583 hub->indicator[0] = INDICATOR_CYCLE;
1585 for (i = 0; i < hdev->maxchild; i++) {
1586 ret = usb_hub_create_port_device(hub, i + 1);
1588 dev_err(hub->intfdev,
1589 "couldn't create port%d device.\n", i + 1);
1591 goto fail_keep_maxchild;
1595 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1597 hub_activate(hub, HUB_INIT);
1603 dev_err (hub_dev, "config failed, %s (err %d)\n",
1605 /* hub_disconnect() frees urb and descriptor */
1609 static void hub_release(struct kref *kref)
1611 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1613 usb_put_intf(to_usb_interface(hub->intfdev));
1617 static unsigned highspeed_hubs;
1619 static void hub_disconnect(struct usb_interface *intf)
1621 struct usb_hub *hub = usb_get_intfdata(intf);
1622 struct usb_device *hdev = interface_to_usbdev(intf);
1625 /* Take the hub off the event list and don't let it be added again */
1626 spin_lock_irq(&hub_event_lock);
1627 if (!list_empty(&hub->event_list)) {
1628 list_del_init(&hub->event_list);
1629 usb_autopm_put_interface_no_suspend(intf);
1631 hub->disconnected = 1;
1632 spin_unlock_irq(&hub_event_lock);
1634 /* Disconnect all children and quiesce the hub */
1636 hub_quiesce(hub, HUB_DISCONNECT);
1638 /* Avoid races with recursively_mark_NOTATTACHED() */
1639 spin_lock_irq(&device_state_lock);
1640 port1 = hdev->maxchild;
1642 usb_set_intfdata(intf, NULL);
1643 spin_unlock_irq(&device_state_lock);
1645 for (; port1 > 0; --port1)
1646 usb_hub_remove_port_device(hub, port1);
1648 if (hub->hdev->speed == USB_SPEED_HIGH)
1651 usb_free_urb(hub->urb);
1653 kfree(hub->descriptor);
1657 pm_suspend_ignore_children(&intf->dev, false);
1658 kref_put(&hub->kref, hub_release);
1661 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1663 struct usb_host_interface *desc;
1664 struct usb_endpoint_descriptor *endpoint;
1665 struct usb_device *hdev;
1666 struct usb_hub *hub;
1668 desc = intf->cur_altsetting;
1669 hdev = interface_to_usbdev(intf);
1672 * Set default autosuspend delay as 0 to speedup bus suspend,
1673 * based on the below considerations:
1675 * - Unlike other drivers, the hub driver does not rely on the
1676 * autosuspend delay to provide enough time to handle a wakeup
1677 * event, and the submitted status URB is just to check future
1678 * change on hub downstream ports, so it is safe to do it.
1680 * - The patch might cause one or more auto supend/resume for
1681 * below very rare devices when they are plugged into hub
1684 * devices having trouble initializing, and disconnect
1685 * themselves from the bus and then reconnect a second
1688 * devices just for downloading firmware, and disconnects
1689 * themselves after completing it
1691 * For these quite rare devices, their drivers may change the
1692 * autosuspend delay of their parent hub in the probe() to one
1693 * appropriate value to avoid the subtle problem if someone
1696 * - The patch may cause one or more auto suspend/resume on
1697 * hub during running 'lsusb', but it is probably too
1698 * infrequent to worry about.
1700 * - Change autosuspend delay of hub can avoid unnecessary auto
1701 * suspend timer for hub, also may decrease power consumption
1704 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1706 /* Hubs have proper suspend/resume support. */
1707 usb_enable_autosuspend(hdev);
1709 if (hdev->level == MAX_TOPO_LEVEL) {
1711 "Unsupported bus topology: hub nested too deep\n");
1715 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1717 dev_warn(&intf->dev, "ignoring external hub\n");
1722 /* Some hubs have a subclass of 1, which AFAICT according to the */
1723 /* specs is not defined, but it works */
1724 if ((desc->desc.bInterfaceSubClass != 0) &&
1725 (desc->desc.bInterfaceSubClass != 1)) {
1727 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1731 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1732 if (desc->desc.bNumEndpoints != 1)
1733 goto descriptor_error;
1735 endpoint = &desc->endpoint[0].desc;
1737 /* If it's not an interrupt in endpoint, we'd better punt! */
1738 if (!usb_endpoint_is_int_in(endpoint))
1739 goto descriptor_error;
1741 /* We found a hub */
1742 dev_info (&intf->dev, "USB hub found\n");
1744 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1746 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1750 kref_init(&hub->kref);
1751 INIT_LIST_HEAD(&hub->event_list);
1752 hub->intfdev = &intf->dev;
1754 INIT_DELAYED_WORK(&hub->leds, led_work);
1755 INIT_DELAYED_WORK(&hub->init_work, NULL);
1758 usb_set_intfdata (intf, hub);
1759 intf->needs_remote_wakeup = 1;
1760 pm_suspend_ignore_children(&intf->dev, true);
1762 if (hdev->speed == USB_SPEED_HIGH)
1765 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1766 hub->quirk_check_port_auto_suspend = 1;
1768 if (hub_configure(hub, endpoint) >= 0)
1771 hub_disconnect (intf);
1776 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1778 struct usb_device *hdev = interface_to_usbdev (intf);
1779 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1781 /* assert ifno == 0 (part of hub spec) */
1783 case USBDEVFS_HUB_PORTINFO: {
1784 struct usbdevfs_hub_portinfo *info = user_data;
1787 spin_lock_irq(&device_state_lock);
1788 if (hdev->devnum <= 0)
1791 info->nports = hdev->maxchild;
1792 for (i = 0; i < info->nports; i++) {
1793 if (hub->ports[i]->child == NULL)
1797 hub->ports[i]->child->devnum;
1800 spin_unlock_irq(&device_state_lock);
1802 return info->nports + 1;
1811 * Allow user programs to claim ports on a hub. When a device is attached
1812 * to one of these "claimed" ports, the program will "own" the device.
1814 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1815 struct usb_dev_state ***ppowner)
1817 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1819 if (hdev->state == USB_STATE_NOTATTACHED)
1821 if (port1 == 0 || port1 > hdev->maxchild)
1824 /* Devices not managed by the hub driver
1825 * will always have maxchild equal to 0.
1827 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1831 /* In the following three functions, the caller must hold hdev's lock */
1832 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1833 struct usb_dev_state *owner)
1836 struct usb_dev_state **powner;
1838 rc = find_port_owner(hdev, port1, &powner);
1846 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1848 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1849 struct usb_dev_state *owner)
1852 struct usb_dev_state **powner;
1854 rc = find_port_owner(hdev, port1, &powner);
1857 if (*powner != owner)
1862 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1864 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1866 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1869 for (n = 0; n < hdev->maxchild; n++) {
1870 if (hub->ports[n]->port_owner == owner)
1871 hub->ports[n]->port_owner = NULL;
1876 /* The caller must hold udev's lock */
1877 bool usb_device_is_owned(struct usb_device *udev)
1879 struct usb_hub *hub;
1881 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1883 hub = usb_hub_to_struct_hub(udev->parent);
1884 return !!hub->ports[udev->portnum - 1]->port_owner;
1887 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1889 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1892 for (i = 0; i < udev->maxchild; ++i) {
1893 if (hub->ports[i]->child)
1894 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1896 if (udev->state == USB_STATE_SUSPENDED)
1897 udev->active_duration -= jiffies;
1898 udev->state = USB_STATE_NOTATTACHED;
1902 * usb_set_device_state - change a device's current state (usbcore, hcds)
1903 * @udev: pointer to device whose state should be changed
1904 * @new_state: new state value to be stored
1906 * udev->state is _not_ fully protected by the device lock. Although
1907 * most transitions are made only while holding the lock, the state can
1908 * can change to USB_STATE_NOTATTACHED at almost any time. This
1909 * is so that devices can be marked as disconnected as soon as possible,
1910 * without having to wait for any semaphores to be released. As a result,
1911 * all changes to any device's state must be protected by the
1912 * device_state_lock spinlock.
1914 * Once a device has been added to the device tree, all changes to its state
1915 * should be made using this routine. The state should _not_ be set directly.
1917 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1918 * Otherwise udev->state is set to new_state, and if new_state is
1919 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1920 * to USB_STATE_NOTATTACHED.
1922 void usb_set_device_state(struct usb_device *udev,
1923 enum usb_device_state new_state)
1925 unsigned long flags;
1928 spin_lock_irqsave(&device_state_lock, flags);
1929 if (udev->state == USB_STATE_NOTATTACHED)
1931 else if (new_state != USB_STATE_NOTATTACHED) {
1933 /* root hub wakeup capabilities are managed out-of-band
1934 * and may involve silicon errata ... ignore them here.
1937 if (udev->state == USB_STATE_SUSPENDED
1938 || new_state == USB_STATE_SUSPENDED)
1939 ; /* No change to wakeup settings */
1940 else if (new_state == USB_STATE_CONFIGURED)
1941 wakeup = udev->actconfig->desc.bmAttributes
1942 & USB_CONFIG_ATT_WAKEUP;
1946 if (udev->state == USB_STATE_SUSPENDED &&
1947 new_state != USB_STATE_SUSPENDED)
1948 udev->active_duration -= jiffies;
1949 else if (new_state == USB_STATE_SUSPENDED &&
1950 udev->state != USB_STATE_SUSPENDED)
1951 udev->active_duration += jiffies;
1952 udev->state = new_state;
1954 recursively_mark_NOTATTACHED(udev);
1955 spin_unlock_irqrestore(&device_state_lock, flags);
1957 device_set_wakeup_capable(&udev->dev, wakeup);
1959 EXPORT_SYMBOL_GPL(usb_set_device_state);
1962 * Choose a device number.
1964 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1965 * USB-2.0 buses they are also used as device addresses, however on
1966 * USB-3.0 buses the address is assigned by the controller hardware
1967 * and it usually is not the same as the device number.
1969 * WUSB devices are simple: they have no hubs behind, so the mapping
1970 * device <-> virtual port number becomes 1:1. Why? to simplify the
1971 * life of the device connection logic in
1972 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1973 * handshake we need to assign a temporary address in the unauthorized
1974 * space. For simplicity we use the first virtual port number found to
1975 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1976 * and that becomes it's address [X < 128] or its unauthorized address
1979 * We add 1 as an offset to the one-based USB-stack port number
1980 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1981 * 0 is reserved by USB for default address; (b) Linux's USB stack
1982 * uses always #1 for the root hub of the controller. So USB stack's
1983 * port #1, which is wusb virtual-port #0 has address #2.
1985 * Devices connected under xHCI are not as simple. The host controller
1986 * supports virtualization, so the hardware assigns device addresses and
1987 * the HCD must setup data structures before issuing a set address
1988 * command to the hardware.
1990 static void choose_devnum(struct usb_device *udev)
1993 struct usb_bus *bus = udev->bus;
1995 /* If khubd ever becomes multithreaded, this will need a lock */
1997 devnum = udev->portnum + 1;
1998 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2000 /* Try to allocate the next devnum beginning at
2001 * bus->devnum_next. */
2002 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2005 devnum = find_next_zero_bit(bus->devmap.devicemap,
2007 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2010 set_bit(devnum, bus->devmap.devicemap);
2011 udev->devnum = devnum;
2015 static void release_devnum(struct usb_device *udev)
2017 if (udev->devnum > 0) {
2018 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2023 static void update_devnum(struct usb_device *udev, int devnum)
2025 /* The address for a WUSB device is managed by wusbcore. */
2027 udev->devnum = devnum;
2030 static void hub_free_dev(struct usb_device *udev)
2032 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2034 /* Root hubs aren't real devices, so don't free HCD resources */
2035 if (hcd->driver->free_dev && udev->parent)
2036 hcd->driver->free_dev(hcd, udev);
2040 * usb_disconnect - disconnect a device (usbcore-internal)
2041 * @pdev: pointer to device being disconnected
2042 * Context: !in_interrupt ()
2044 * Something got disconnected. Get rid of it and all of its children.
2046 * If *pdev is a normal device then the parent hub must already be locked.
2047 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2048 * which protects the set of root hubs as well as the list of buses.
2050 * Only hub drivers (including virtual root hub drivers for host
2051 * controllers) should ever call this.
2053 * This call is synchronous, and may not be used in an interrupt context.
2055 void usb_disconnect(struct usb_device **pdev)
2057 struct usb_device *udev = *pdev;
2058 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2061 /* mark the device as inactive, so any further urb submissions for
2062 * this device (and any of its children) will fail immediately.
2063 * this quiesces everything except pending urbs.
2065 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2066 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2069 usb_lock_device(udev);
2071 /* Free up all the children before we remove this device */
2072 for (i = 0; i < udev->maxchild; i++) {
2073 if (hub->ports[i]->child)
2074 usb_disconnect(&hub->ports[i]->child);
2077 /* deallocate hcd/hardware state ... nuking all pending urbs and
2078 * cleaning up all state associated with the current configuration
2079 * so that the hardware is now fully quiesced.
2081 dev_dbg (&udev->dev, "unregistering device\n");
2082 usb_disable_device(udev, 0);
2083 usb_hcd_synchronize_unlinks(udev);
2086 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2087 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2089 sysfs_remove_link(&udev->dev.kobj, "port");
2090 sysfs_remove_link(&port_dev->dev.kobj, "device");
2092 if (!port_dev->did_runtime_put)
2093 pm_runtime_put(&port_dev->dev);
2095 port_dev->did_runtime_put = false;
2098 usb_remove_ep_devs(&udev->ep0);
2099 usb_unlock_device(udev);
2101 /* Unregister the device. The device driver is responsible
2102 * for de-configuring the device and invoking the remove-device
2103 * notifier chain (used by usbfs and possibly others).
2105 device_del(&udev->dev);
2107 /* Free the device number and delete the parent's children[]
2108 * (or root_hub) pointer.
2110 release_devnum(udev);
2112 /* Avoid races with recursively_mark_NOTATTACHED() */
2113 spin_lock_irq(&device_state_lock);
2115 spin_unlock_irq(&device_state_lock);
2119 put_device(&udev->dev);
2122 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2123 static void show_string(struct usb_device *udev, char *id, char *string)
2127 dev_info(&udev->dev, "%s: %s\n", id, string);
2130 static void announce_device(struct usb_device *udev)
2132 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2133 le16_to_cpu(udev->descriptor.idVendor),
2134 le16_to_cpu(udev->descriptor.idProduct));
2135 dev_info(&udev->dev,
2136 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2137 udev->descriptor.iManufacturer,
2138 udev->descriptor.iProduct,
2139 udev->descriptor.iSerialNumber);
2140 show_string(udev, "Product", udev->product);
2141 show_string(udev, "Manufacturer", udev->manufacturer);
2142 show_string(udev, "SerialNumber", udev->serial);
2145 static inline void announce_device(struct usb_device *udev) { }
2148 #ifdef CONFIG_USB_OTG
2149 #include "otg_whitelist.h"
2153 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2154 * @udev: newly addressed device (in ADDRESS state)
2156 * Finish enumeration for On-The-Go devices
2158 * Return: 0 if successful. A negative error code otherwise.
2160 static int usb_enumerate_device_otg(struct usb_device *udev)
2164 #ifdef CONFIG_USB_OTG
2166 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2167 * to wake us after we've powered off VBUS; and HNP, switching roles
2168 * "host" to "peripheral". The OTG descriptor helps figure this out.
2170 if (!udev->bus->is_b_host
2172 && udev->parent == udev->bus->root_hub) {
2173 struct usb_otg_descriptor *desc = NULL;
2174 struct usb_bus *bus = udev->bus;
2176 /* descriptor may appear anywhere in config */
2177 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2178 le16_to_cpu(udev->config[0].desc.wTotalLength),
2179 USB_DT_OTG, (void **) &desc) == 0) {
2180 if (desc->bmAttributes & USB_OTG_HNP) {
2181 unsigned port1 = udev->portnum;
2183 dev_info(&udev->dev,
2184 "Dual-Role OTG device on %sHNP port\n",
2185 (port1 == bus->otg_port)
2188 /* enable HNP before suspend, it's simpler */
2189 if (port1 == bus->otg_port)
2190 bus->b_hnp_enable = 1;
2191 err = usb_control_msg(udev,
2192 usb_sndctrlpipe(udev, 0),
2193 USB_REQ_SET_FEATURE, 0,
2195 ? USB_DEVICE_B_HNP_ENABLE
2196 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2197 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2199 /* OTG MESSAGE: report errors here,
2200 * customize to match your product.
2202 dev_info(&udev->dev,
2203 "can't set HNP mode: %d\n",
2205 bus->b_hnp_enable = 0;
2211 if (!is_targeted(udev)) {
2213 /* Maybe it can talk to us, though we can't talk to it.
2214 * (Includes HNP test device.)
2216 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2217 err = usb_port_suspend(udev, PMSG_SUSPEND);
2219 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2231 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2232 * @udev: newly addressed device (in ADDRESS state)
2234 * This is only called by usb_new_device() and usb_authorize_device()
2235 * and FIXME -- all comments that apply to them apply here wrt to
2238 * If the device is WUSB and not authorized, we don't attempt to read
2239 * the string descriptors, as they will be errored out by the device
2240 * until it has been authorized.
2242 * Return: 0 if successful. A negative error code otherwise.
2244 static int usb_enumerate_device(struct usb_device *udev)
2248 if (udev->config == NULL) {
2249 err = usb_get_configuration(udev);
2252 dev_err(&udev->dev, "can't read configurations, error %d\n",
2258 /* read the standard strings and cache them if present */
2259 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2260 udev->manufacturer = usb_cache_string(udev,
2261 udev->descriptor.iManufacturer);
2262 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2264 err = usb_enumerate_device_otg(udev);
2268 usb_detect_interface_quirks(udev);
2273 static void set_usb_port_removable(struct usb_device *udev)
2275 struct usb_device *hdev = udev->parent;
2276 struct usb_hub *hub;
2277 u8 port = udev->portnum;
2278 u16 wHubCharacteristics;
2279 bool removable = true;
2284 hub = usb_hub_to_struct_hub(udev->parent);
2286 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2288 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2291 if (hub_is_superspeed(hdev)) {
2292 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2296 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2301 udev->removable = USB_DEVICE_REMOVABLE;
2303 udev->removable = USB_DEVICE_FIXED;
2307 * usb_new_device - perform initial device setup (usbcore-internal)
2308 * @udev: newly addressed device (in ADDRESS state)
2310 * This is called with devices which have been detected but not fully
2311 * enumerated. The device descriptor is available, but not descriptors
2312 * for any device configuration. The caller must have locked either
2313 * the parent hub (if udev is a normal device) or else the
2314 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2315 * udev has already been installed, but udev is not yet visible through
2316 * sysfs or other filesystem code.
2318 * This call is synchronous, and may not be used in an interrupt context.
2320 * Only the hub driver or root-hub registrar should ever call this.
2322 * Return: Whether the device is configured properly or not. Zero if the
2323 * interface was registered with the driver core; else a negative errno
2327 int usb_new_device(struct usb_device *udev)
2332 /* Initialize non-root-hub device wakeup to disabled;
2333 * device (un)configuration controls wakeup capable
2334 * sysfs power/wakeup controls wakeup enabled/disabled
2336 device_init_wakeup(&udev->dev, 0);
2339 /* Tell the runtime-PM framework the device is active */
2340 pm_runtime_set_active(&udev->dev);
2341 pm_runtime_get_noresume(&udev->dev);
2342 pm_runtime_use_autosuspend(&udev->dev);
2343 pm_runtime_enable(&udev->dev);
2345 /* By default, forbid autosuspend for all devices. It will be
2346 * allowed for hubs during binding.
2348 usb_disable_autosuspend(udev);
2350 err = usb_enumerate_device(udev); /* Read descriptors */
2353 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2354 udev->devnum, udev->bus->busnum,
2355 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2356 /* export the usbdev device-node for libusb */
2357 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2358 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2360 /* Tell the world! */
2361 announce_device(udev);
2364 add_device_randomness(udev->serial, strlen(udev->serial));
2366 add_device_randomness(udev->product, strlen(udev->product));
2367 if (udev->manufacturer)
2368 add_device_randomness(udev->manufacturer,
2369 strlen(udev->manufacturer));
2371 device_enable_async_suspend(&udev->dev);
2374 * check whether the hub marks this port as non-removable. Do it
2375 * now so that platform-specific data can override it in
2379 set_usb_port_removable(udev);
2381 /* Register the device. The device driver is responsible
2382 * for configuring the device and invoking the add-device
2383 * notifier chain (used by usbfs and possibly others).
2385 err = device_add(&udev->dev);
2387 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2391 /* Create link files between child device and usb port device. */
2393 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2394 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2396 err = sysfs_create_link(&udev->dev.kobj,
2397 &port_dev->dev.kobj, "port");
2401 err = sysfs_create_link(&port_dev->dev.kobj,
2402 &udev->dev.kobj, "device");
2404 sysfs_remove_link(&udev->dev.kobj, "port");
2408 pm_runtime_get_sync(&port_dev->dev);
2411 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2412 usb_mark_last_busy(udev);
2413 pm_runtime_put_sync_autosuspend(&udev->dev);
2417 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2418 pm_runtime_disable(&udev->dev);
2419 pm_runtime_set_suspended(&udev->dev);
2425 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2426 * @usb_dev: USB device
2428 * Move the USB device to a very basic state where interfaces are disabled
2429 * and the device is in fact unconfigured and unusable.
2431 * We share a lock (that we have) with device_del(), so we need to
2436 int usb_deauthorize_device(struct usb_device *usb_dev)
2438 usb_lock_device(usb_dev);
2439 if (usb_dev->authorized == 0)
2440 goto out_unauthorized;
2442 usb_dev->authorized = 0;
2443 usb_set_configuration(usb_dev, -1);
2446 usb_unlock_device(usb_dev);
2451 int usb_authorize_device(struct usb_device *usb_dev)
2455 usb_lock_device(usb_dev);
2456 if (usb_dev->authorized == 1)
2457 goto out_authorized;
2459 result = usb_autoresume_device(usb_dev);
2461 dev_err(&usb_dev->dev,
2462 "can't autoresume for authorization: %d\n", result);
2463 goto error_autoresume;
2465 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2467 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2468 "authorization: %d\n", result);
2469 goto error_device_descriptor;
2472 usb_dev->authorized = 1;
2473 /* Choose and set the configuration. This registers the interfaces
2474 * with the driver core and lets interface drivers bind to them.
2476 c = usb_choose_configuration(usb_dev);
2478 result = usb_set_configuration(usb_dev, c);
2480 dev_err(&usb_dev->dev,
2481 "can't set config #%d, error %d\n", c, result);
2482 /* This need not be fatal. The user can try to
2483 * set other configurations. */
2486 dev_info(&usb_dev->dev, "authorized to connect\n");
2488 error_device_descriptor:
2489 usb_autosuspend_device(usb_dev);
2492 usb_unlock_device(usb_dev); /* complements locktree */
2497 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2498 static unsigned hub_is_wusb(struct usb_hub *hub)
2500 struct usb_hcd *hcd;
2501 if (hub->hdev->parent != NULL) /* not a root hub? */
2503 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2504 return hcd->wireless;
2508 #define PORT_RESET_TRIES 5
2509 #define SET_ADDRESS_TRIES 2
2510 #define GET_DESCRIPTOR_TRIES 2
2511 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2512 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2514 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2515 #define HUB_SHORT_RESET_TIME 10
2516 #define HUB_BH_RESET_TIME 50
2517 #define HUB_LONG_RESET_TIME 200
2518 #define HUB_RESET_TIMEOUT 800
2521 * "New scheme" enumeration causes an extra state transition to be
2522 * exposed to an xhci host and causes USB3 devices to receive control
2523 * commands in the default state. This has been seen to cause
2524 * enumeration failures, so disable this enumeration scheme for USB3
2527 static bool use_new_scheme(struct usb_device *udev, int retry)
2529 if (udev->speed == USB_SPEED_SUPER)
2532 return USE_NEW_SCHEME(retry);
2535 static int hub_port_reset(struct usb_hub *hub, int port1,
2536 struct usb_device *udev, unsigned int delay, bool warm);
2538 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2539 * Port worm reset is required to recover
2541 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2543 return hub_is_superspeed(hub->hdev) &&
2544 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2545 USB_SS_PORT_LS_SS_INACTIVE) ||
2546 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2547 USB_SS_PORT_LS_COMP_MOD)) ;
2550 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2551 struct usb_device *udev, unsigned int delay, bool warm)
2553 int delay_time, ret;
2557 for (delay_time = 0;
2558 delay_time < HUB_RESET_TIMEOUT;
2559 delay_time += delay) {
2560 /* wait to give the device a chance to reset */
2563 /* read and decode port status */
2564 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2568 /* The port state is unknown until the reset completes. */
2569 if (!(portstatus & USB_PORT_STAT_RESET))
2572 /* switch to the long delay after two short delay failures */
2573 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2574 delay = HUB_LONG_RESET_TIME;
2576 dev_dbg (hub->intfdev,
2577 "port %d not %sreset yet, waiting %dms\n",
2578 port1, warm ? "warm " : "", delay);
2581 if ((portstatus & USB_PORT_STAT_RESET))
2584 if (hub_port_warm_reset_required(hub, portstatus))
2587 /* Device went away? */
2588 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2591 /* bomb out completely if the connection bounced. A USB 3.0
2592 * connection may bounce if multiple warm resets were issued,
2593 * but the device may have successfully re-connected. Ignore it.
2595 if (!hub_is_superspeed(hub->hdev) &&
2596 (portchange & USB_PORT_STAT_C_CONNECTION))
2599 if (!(portstatus & USB_PORT_STAT_ENABLE))
2605 if (hub_is_wusb(hub))
2606 udev->speed = USB_SPEED_WIRELESS;
2607 else if (hub_is_superspeed(hub->hdev))
2608 udev->speed = USB_SPEED_SUPER;
2609 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2610 udev->speed = USB_SPEED_HIGH;
2611 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2612 udev->speed = USB_SPEED_LOW;
2614 udev->speed = USB_SPEED_FULL;
2618 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2619 struct usb_device *udev, int *status)
2623 /* TRSTRCY = 10 ms; plus some extra */
2626 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2628 update_devnum(udev, 0);
2629 /* The xHC may think the device is already reset,
2630 * so ignore the status.
2632 if (hcd->driver->reset_device)
2633 hcd->driver->reset_device(hcd, udev);
2638 usb_clear_port_feature(hub->hdev,
2639 port1, USB_PORT_FEAT_C_RESET);
2640 if (hub_is_superspeed(hub->hdev)) {
2641 usb_clear_port_feature(hub->hdev, port1,
2642 USB_PORT_FEAT_C_BH_PORT_RESET);
2643 usb_clear_port_feature(hub->hdev, port1,
2644 USB_PORT_FEAT_C_PORT_LINK_STATE);
2645 usb_clear_port_feature(hub->hdev, port1,
2646 USB_PORT_FEAT_C_CONNECTION);
2649 usb_set_device_state(udev, *status
2650 ? USB_STATE_NOTATTACHED
2651 : USB_STATE_DEFAULT);
2656 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2657 static int hub_port_reset(struct usb_hub *hub, int port1,
2658 struct usb_device *udev, unsigned int delay, bool warm)
2661 u16 portchange, portstatus;
2663 if (!hub_is_superspeed(hub->hdev)) {
2665 dev_err(hub->intfdev, "only USB3 hub support "
2669 /* Block EHCI CF initialization during the port reset.
2670 * Some companion controllers don't like it when they mix.
2672 down_read(&ehci_cf_port_reset_rwsem);
2675 * If the caller hasn't explicitly requested a warm reset,
2676 * double check and see if one is needed.
2678 status = hub_port_status(hub, port1,
2679 &portstatus, &portchange);
2683 if (hub_port_warm_reset_required(hub, portstatus))
2687 /* Reset the port */
2688 for (i = 0; i < PORT_RESET_TRIES; i++) {
2689 status = set_port_feature(hub->hdev, port1, (warm ?
2690 USB_PORT_FEAT_BH_PORT_RESET :
2691 USB_PORT_FEAT_RESET));
2692 if (status == -ENODEV) {
2693 ; /* The hub is gone */
2694 } else if (status) {
2695 dev_err(hub->intfdev,
2696 "cannot %sreset port %d (err = %d)\n",
2697 warm ? "warm " : "", port1, status);
2699 status = hub_port_wait_reset(hub, port1, udev, delay,
2701 if (status && status != -ENOTCONN && status != -ENODEV)
2702 dev_dbg(hub->intfdev,
2703 "port_wait_reset: err = %d\n",
2707 /* Check for disconnect or reset */
2708 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2709 hub_port_finish_reset(hub, port1, udev, &status);
2711 if (!hub_is_superspeed(hub->hdev))
2715 * If a USB 3.0 device migrates from reset to an error
2716 * state, re-issue the warm reset.
2718 if (hub_port_status(hub, port1,
2719 &portstatus, &portchange) < 0)
2722 if (!hub_port_warm_reset_required(hub, portstatus))
2726 * If the port is in SS.Inactive or Compliance Mode, the
2727 * hot or warm reset failed. Try another warm reset.
2730 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2736 dev_dbg (hub->intfdev,
2737 "port %d not enabled, trying %sreset again...\n",
2738 port1, warm ? "warm " : "");
2739 delay = HUB_LONG_RESET_TIME;
2742 dev_err (hub->intfdev,
2743 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2747 if (!hub_is_superspeed(hub->hdev))
2748 up_read(&ehci_cf_port_reset_rwsem);
2753 /* Check if a port is power on */
2754 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2758 if (hub_is_superspeed(hub->hdev)) {
2759 if (portstatus & USB_SS_PORT_STAT_POWER)
2762 if (portstatus & USB_PORT_STAT_POWER)
2771 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2772 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2776 if (hub_is_superspeed(hub->hdev)) {
2777 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2778 == USB_SS_PORT_LS_U3)
2781 if (portstatus & USB_PORT_STAT_SUSPEND)
2788 /* Determine whether the device on a port is ready for a normal resume,
2789 * is ready for a reset-resume, or should be disconnected.
2791 static int check_port_resume_type(struct usb_device *udev,
2792 struct usb_hub *hub, int port1,
2793 int status, unsigned portchange, unsigned portstatus)
2795 /* Is the device still present? */
2796 if (status || port_is_suspended(hub, portstatus) ||
2797 !port_is_power_on(hub, portstatus) ||
2798 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2803 /* Can't do a normal resume if the port isn't enabled,
2804 * so try a reset-resume instead.
2806 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2807 if (udev->persist_enabled)
2808 udev->reset_resume = 1;
2814 dev_dbg(hub->intfdev,
2815 "port %d status %04x.%04x after resume, %d\n",
2816 port1, portchange, portstatus, status);
2817 } else if (udev->reset_resume) {
2819 /* Late port handoff can set status-change bits */
2820 if (portchange & USB_PORT_STAT_C_CONNECTION)
2821 usb_clear_port_feature(hub->hdev, port1,
2822 USB_PORT_FEAT_C_CONNECTION);
2823 if (portchange & USB_PORT_STAT_C_ENABLE)
2824 usb_clear_port_feature(hub->hdev, port1,
2825 USB_PORT_FEAT_C_ENABLE);
2831 int usb_disable_ltm(struct usb_device *udev)
2833 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2835 /* Check if the roothub and device supports LTM. */
2836 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2837 !usb_device_supports_ltm(udev))
2840 /* Clear Feature LTM Enable can only be sent if the device is
2843 if (!udev->actconfig)
2846 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2847 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2848 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2849 USB_CTRL_SET_TIMEOUT);
2851 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2853 void usb_enable_ltm(struct usb_device *udev)
2855 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2857 /* Check if the roothub and device supports LTM. */
2858 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2859 !usb_device_supports_ltm(udev))
2862 /* Set Feature LTM Enable can only be sent if the device is
2865 if (!udev->actconfig)
2868 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2869 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2870 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2871 USB_CTRL_SET_TIMEOUT);
2873 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2876 * usb_enable_remote_wakeup - enable remote wakeup for a device
2877 * @udev: target device
2879 * For USB-2 devices: Set the device's remote wakeup feature.
2881 * For USB-3 devices: Assume there's only one function on the device and
2882 * enable remote wake for the first interface. FIXME if the interface
2883 * association descriptor shows there's more than one function.
2885 static int usb_enable_remote_wakeup(struct usb_device *udev)
2887 if (udev->speed < USB_SPEED_SUPER)
2888 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2889 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2890 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2891 USB_CTRL_SET_TIMEOUT);
2893 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2894 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2895 USB_INTRF_FUNC_SUSPEND,
2896 USB_INTRF_FUNC_SUSPEND_RW |
2897 USB_INTRF_FUNC_SUSPEND_LP,
2898 NULL, 0, USB_CTRL_SET_TIMEOUT);
2902 * usb_disable_remote_wakeup - disable remote wakeup for a device
2903 * @udev: target device
2905 * For USB-2 devices: Clear the device's remote wakeup feature.
2907 * For USB-3 devices: Assume there's only one function on the device and
2908 * disable remote wake for the first interface. FIXME if the interface
2909 * association descriptor shows there's more than one function.
2911 static int usb_disable_remote_wakeup(struct usb_device *udev)
2913 if (udev->speed < USB_SPEED_SUPER)
2914 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2915 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2916 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2917 USB_CTRL_SET_TIMEOUT);
2919 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2920 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2921 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2922 USB_CTRL_SET_TIMEOUT);
2925 /* Count of wakeup-enabled devices at or below udev */
2926 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2928 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2930 return udev->do_remote_wakeup +
2931 (hub ? hub->wakeup_enabled_descendants : 0);
2935 * usb_port_suspend - suspend a usb device's upstream port
2936 * @udev: device that's no longer in active use, not a root hub
2937 * Context: must be able to sleep; device not locked; pm locks held
2939 * Suspends a USB device that isn't in active use, conserving power.
2940 * Devices may wake out of a suspend, if anything important happens,
2941 * using the remote wakeup mechanism. They may also be taken out of
2942 * suspend by the host, using usb_port_resume(). It's also routine
2943 * to disconnect devices while they are suspended.
2945 * This only affects the USB hardware for a device; its interfaces
2946 * (and, for hubs, child devices) must already have been suspended.
2948 * Selective port suspend reduces power; most suspended devices draw
2949 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2950 * All devices below the suspended port are also suspended.
2952 * Devices leave suspend state when the host wakes them up. Some devices
2953 * also support "remote wakeup", where the device can activate the USB
2954 * tree above them to deliver data, such as a keypress or packet. In
2955 * some cases, this wakes the USB host.
2957 * Suspending OTG devices may trigger HNP, if that's been enabled
2958 * between a pair of dual-role devices. That will change roles, such
2959 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2961 * Devices on USB hub ports have only one "suspend" state, corresponding
2962 * to ACPI D2, "may cause the device to lose some context".
2963 * State transitions include:
2965 * - suspend, resume ... when the VBUS power link stays live
2966 * - suspend, disconnect ... VBUS lost
2968 * Once VBUS drop breaks the circuit, the port it's using has to go through
2969 * normal re-enumeration procedures, starting with enabling VBUS power.
2970 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2971 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2972 * timer, no SRP, no requests through sysfs.
2974 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2975 * suspended until their bus goes into global suspend (i.e., the root
2976 * hub is suspended). Nevertheless, we change @udev->state to
2977 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2978 * upstream port setting is stored in @udev->port_is_suspended.
2980 * Returns 0 on success, else negative errno.
2982 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2984 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2985 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2986 int port1 = udev->portnum;
2988 bool really_suspend = true;
2990 /* enable remote wakeup when appropriate; this lets the device
2991 * wake up the upstream hub (including maybe the root hub).
2993 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2994 * we don't explicitly enable it here.
2996 if (udev->do_remote_wakeup) {
2997 status = usb_enable_remote_wakeup(udev);
2999 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3001 /* bail if autosuspend is requested */
3002 if (PMSG_IS_AUTO(msg))
3007 /* disable USB2 hardware LPM */
3008 if (udev->usb2_hw_lpm_enabled == 1)
3009 usb_set_usb2_hardware_lpm(udev, 0);
3011 if (usb_disable_ltm(udev)) {
3012 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3014 if (PMSG_IS_AUTO(msg))
3017 if (usb_unlocked_disable_lpm(udev)) {
3018 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3020 if (PMSG_IS_AUTO(msg))
3025 if (hub_is_superspeed(hub->hdev))
3026 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3029 * For system suspend, we do not need to enable the suspend feature
3030 * on individual USB-2 ports. The devices will automatically go
3031 * into suspend a few ms after the root hub stops sending packets.
3032 * The USB 2.0 spec calls this "global suspend".
3034 * However, many USB hubs have a bug: They don't relay wakeup requests
3035 * from a downstream port if the port's suspend feature isn't on.
3036 * Therefore we will turn on the suspend feature if udev or any of its
3037 * descendants is enabled for remote wakeup.
3039 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3040 status = set_port_feature(hub->hdev, port1,
3041 USB_PORT_FEAT_SUSPEND);
3043 really_suspend = false;
3047 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3050 /* Try to enable USB3 LPM and LTM again */
3051 usb_unlocked_enable_lpm(udev);
3053 usb_enable_ltm(udev);
3055 /* Try to enable USB2 hardware LPM again */
3056 if (udev->usb2_hw_lpm_capable == 1)
3057 usb_set_usb2_hardware_lpm(udev, 1);
3059 if (udev->do_remote_wakeup)
3060 (void) usb_disable_remote_wakeup(udev);
3063 /* System sleep transitions should never fail */
3064 if (!PMSG_IS_AUTO(msg))
3067 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3068 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3069 udev->do_remote_wakeup);
3070 if (really_suspend) {
3071 udev->port_is_suspended = 1;
3073 /* device has up to 10 msec to fully suspend */
3076 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3079 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3080 pm_runtime_put_sync(&port_dev->dev);
3081 port_dev->did_runtime_put = true;
3084 usb_mark_last_busy(hub->hdev);
3089 * If the USB "suspend" state is in use (rather than "global suspend"),
3090 * many devices will be individually taken out of suspend state using
3091 * special "resume" signaling. This routine kicks in shortly after
3092 * hardware resume signaling is finished, either because of selective
3093 * resume (by host) or remote wakeup (by device) ... now see what changed
3094 * in the tree that's rooted at this device.
3096 * If @udev->reset_resume is set then the device is reset before the
3097 * status check is done.
3099 static int finish_port_resume(struct usb_device *udev)
3104 /* caller owns the udev device lock */
3105 dev_dbg(&udev->dev, "%s\n",
3106 udev->reset_resume ? "finish reset-resume" : "finish resume");
3108 /* usb ch9 identifies four variants of SUSPENDED, based on what
3109 * state the device resumes to. Linux currently won't see the
3110 * first two on the host side; they'd be inside hub_port_init()
3111 * during many timeouts, but khubd can't suspend until later.
3113 usb_set_device_state(udev, udev->actconfig
3114 ? USB_STATE_CONFIGURED
3115 : USB_STATE_ADDRESS);
3117 /* 10.5.4.5 says not to reset a suspended port if the attached
3118 * device is enabled for remote wakeup. Hence the reset
3119 * operation is carried out here, after the port has been
3122 if (udev->reset_resume) {
3124 * If the device morphs or switches modes when it is reset,
3125 * we don't want to perform a reset-resume. We'll fail the
3126 * resume, which will cause a logical disconnect, and then
3127 * the device will be rediscovered.
3130 if (udev->quirks & USB_QUIRK_RESET)
3133 status = usb_reset_and_verify_device(udev);
3136 /* 10.5.4.5 says be sure devices in the tree are still there.
3137 * For now let's assume the device didn't go crazy on resume,
3138 * and device drivers will know about any resume quirks.
3142 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3144 /* If a normal resume failed, try doing a reset-resume */
3145 if (status && !udev->reset_resume && udev->persist_enabled) {
3146 dev_dbg(&udev->dev, "retry with reset-resume\n");
3147 udev->reset_resume = 1;
3148 goto retry_reset_resume;
3153 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3156 * There are a few quirky devices which violate the standard
3157 * by claiming to have remote wakeup enabled after a reset,
3158 * which crash if the feature is cleared, hence check for
3159 * udev->reset_resume
3161 } else if (udev->actconfig && !udev->reset_resume) {
3162 if (udev->speed < USB_SPEED_SUPER) {
3163 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3164 status = usb_disable_remote_wakeup(udev);
3166 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3168 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3169 | USB_INTRF_STAT_FUNC_RW))
3170 status = usb_disable_remote_wakeup(udev);
3175 "disable remote wakeup, status %d\n",
3183 * usb_port_resume - re-activate a suspended usb device's upstream port
3184 * @udev: device to re-activate, not a root hub
3185 * Context: must be able to sleep; device not locked; pm locks held
3187 * This will re-activate the suspended device, increasing power usage
3188 * while letting drivers communicate again with its endpoints.
3189 * USB resume explicitly guarantees that the power session between
3190 * the host and the device is the same as it was when the device
3193 * If @udev->reset_resume is set then this routine won't check that the
3194 * port is still enabled. Furthermore, finish_port_resume() above will
3195 * reset @udev. The end result is that a broken power session can be
3196 * recovered and @udev will appear to persist across a loss of VBUS power.
3198 * For example, if a host controller doesn't maintain VBUS suspend current
3199 * during a system sleep or is reset when the system wakes up, all the USB
3200 * power sessions below it will be broken. This is especially troublesome
3201 * for mass-storage devices containing mounted filesystems, since the
3202 * device will appear to have disconnected and all the memory mappings
3203 * to it will be lost. Using the USB_PERSIST facility, the device can be
3204 * made to appear as if it had not disconnected.
3206 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3207 * every effort to insure that the same device is present after the
3208 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3209 * quite possible for a device to remain unaltered but its media to be
3210 * changed. If the user replaces a flash memory card while the system is
3211 * asleep, he will have only himself to blame when the filesystem on the
3212 * new card is corrupted and the system crashes.
3214 * Returns 0 on success, else negative errno.
3216 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3218 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3219 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3220 int port1 = udev->portnum;
3222 u16 portchange, portstatus;
3224 if (port_dev->did_runtime_put) {
3225 status = pm_runtime_get_sync(&port_dev->dev);
3226 port_dev->did_runtime_put = false;
3228 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3234 /* Skip the initial Clear-Suspend step for a remote wakeup */
3235 status = hub_port_status(hub, port1, &portstatus, &portchange);
3236 if (status == 0 && !port_is_suspended(hub, portstatus))
3237 goto SuspendCleared;
3239 /* dev_dbg(hub->intfdev, "resume port %d\n", port1); */
3241 set_bit(port1, hub->busy_bits);
3243 /* see 7.1.7.7; affects power usage, but not budgeting */
3244 if (hub_is_superspeed(hub->hdev))
3245 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3247 status = usb_clear_port_feature(hub->hdev,
3248 port1, USB_PORT_FEAT_SUSPEND);
3250 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3253 /* drive resume for at least 20 msec */
3254 dev_dbg(&udev->dev, "usb %sresume\n",
3255 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3258 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3259 * stop resume signaling. Then finish the resume
3262 status = hub_port_status(hub, port1, &portstatus, &portchange);
3264 /* TRSMRCY = 10 msec */
3270 udev->port_is_suspended = 0;
3271 if (hub_is_superspeed(hub->hdev)) {
3272 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3273 usb_clear_port_feature(hub->hdev, port1,
3274 USB_PORT_FEAT_C_PORT_LINK_STATE);
3276 if (portchange & USB_PORT_STAT_C_SUSPEND)
3277 usb_clear_port_feature(hub->hdev, port1,
3278 USB_PORT_FEAT_C_SUSPEND);
3282 clear_bit(port1, hub->busy_bits);
3284 status = check_port_resume_type(udev,
3285 hub, port1, status, portchange, portstatus);
3287 status = finish_port_resume(udev);
3289 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3290 hub_port_logical_disconnect(hub, port1);
3292 /* Try to enable USB2 hardware LPM */
3293 if (udev->usb2_hw_lpm_capable == 1)
3294 usb_set_usb2_hardware_lpm(udev, 1);
3296 /* Try to enable USB3 LTM and LPM */
3297 usb_enable_ltm(udev);
3298 usb_unlocked_enable_lpm(udev);
3304 #ifdef CONFIG_PM_RUNTIME
3306 /* caller has locked udev */
3307 int usb_remote_wakeup(struct usb_device *udev)
3311 if (udev->state == USB_STATE_SUSPENDED) {
3312 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3313 status = usb_autoresume_device(udev);
3315 /* Let the drivers do their thing, then... */
3316 usb_autosuspend_device(udev);
3324 static int check_ports_changed(struct usb_hub *hub)
3328 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3329 u16 portstatus, portchange;
3332 status = hub_port_status(hub, port1, &portstatus, &portchange);
3333 if (!status && portchange)
3339 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3341 struct usb_hub *hub = usb_get_intfdata (intf);
3342 struct usb_device *hdev = hub->hdev;
3347 * Warn if children aren't already suspended.
3348 * Also, add up the number of wakeup-enabled descendants.
3350 hub->wakeup_enabled_descendants = 0;
3351 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3352 struct usb_device *udev;
3354 udev = hub->ports[port1 - 1]->child;
3355 if (udev && udev->can_submit) {
3356 dev_warn(&intf->dev, "port %d not suspended yet\n",
3358 if (PMSG_IS_AUTO(msg))
3362 hub->wakeup_enabled_descendants +=
3363 wakeup_enabled_descendants(udev);
3366 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3367 /* check if there are changes pending on hub ports */
3368 if (check_ports_changed(hub)) {
3369 if (PMSG_IS_AUTO(msg))
3371 pm_wakeup_event(&hdev->dev, 2000);
3375 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3376 /* Enable hub to send remote wakeup for all ports. */
3377 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3378 status = set_port_feature(hdev,
3380 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3381 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3382 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3383 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3387 dev_dbg(&intf->dev, "%s\n", __func__);
3389 /* stop khubd and related activity */
3390 hub_quiesce(hub, HUB_SUSPEND);
3394 static int hub_resume(struct usb_interface *intf)
3396 struct usb_hub *hub = usb_get_intfdata(intf);
3398 dev_dbg(&intf->dev, "%s\n", __func__);
3399 hub_activate(hub, HUB_RESUME);
3403 static int hub_reset_resume(struct usb_interface *intf)
3405 struct usb_hub *hub = usb_get_intfdata(intf);
3407 dev_dbg(&intf->dev, "%s\n", __func__);
3408 hub_activate(hub, HUB_RESET_RESUME);
3413 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3414 * @rhdev: struct usb_device for the root hub
3416 * The USB host controller driver calls this function when its root hub
3417 * is resumed and Vbus power has been interrupted or the controller
3418 * has been reset. The routine marks @rhdev as having lost power.
3419 * When the hub driver is resumed it will take notice and carry out
3420 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3421 * the others will be disconnected.
3423 void usb_root_hub_lost_power(struct usb_device *rhdev)
3425 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3426 rhdev->reset_resume = 1;
3428 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3430 static const char * const usb3_lpm_names[] = {
3438 * Send a Set SEL control transfer to the device, prior to enabling
3439 * device-initiated U1 or U2. This lets the device know the exit latencies from
3440 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3441 * packet from the host.
3443 * This function will fail if the SEL or PEL values for udev are greater than
3444 * the maximum allowed values for the link state to be enabled.
3446 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3448 struct usb_set_sel_req *sel_values;
3449 unsigned long long u1_sel;
3450 unsigned long long u1_pel;
3451 unsigned long long u2_sel;
3452 unsigned long long u2_pel;
3455 if (udev->state != USB_STATE_CONFIGURED)
3458 /* Convert SEL and PEL stored in ns to us */
3459 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3460 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3461 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3462 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3465 * Make sure that the calculated SEL and PEL values for the link
3466 * state we're enabling aren't bigger than the max SEL/PEL
3467 * value that will fit in the SET SEL control transfer.
3468 * Otherwise the device would get an incorrect idea of the exit
3469 * latency for the link state, and could start a device-initiated
3470 * U1/U2 when the exit latencies are too high.
3472 if ((state == USB3_LPM_U1 &&
3473 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3474 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3475 (state == USB3_LPM_U2 &&
3476 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3477 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3478 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3479 usb3_lpm_names[state], u1_sel, u1_pel);
3484 * If we're enabling device-initiated LPM for one link state,
3485 * but the other link state has a too high SEL or PEL value,
3486 * just set those values to the max in the Set SEL request.
3488 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3489 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3491 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3492 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3494 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3495 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3497 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3498 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3501 * usb_enable_lpm() can be called as part of a failed device reset,
3502 * which may be initiated by an error path of a mass storage driver.
3503 * Therefore, use GFP_NOIO.
3505 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3509 sel_values->u1_sel = u1_sel;
3510 sel_values->u1_pel = u1_pel;
3511 sel_values->u2_sel = cpu_to_le16(u2_sel);
3512 sel_values->u2_pel = cpu_to_le16(u2_pel);
3514 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3518 sel_values, sizeof *(sel_values),
3519 USB_CTRL_SET_TIMEOUT);
3525 * Enable or disable device-initiated U1 or U2 transitions.
3527 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3528 enum usb3_link_state state, bool enable)
3535 feature = USB_DEVICE_U1_ENABLE;
3538 feature = USB_DEVICE_U2_ENABLE;
3541 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3542 __func__, enable ? "enable" : "disable");
3546 if (udev->state != USB_STATE_CONFIGURED) {
3547 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3548 "for unconfigured device.\n",
3549 __func__, enable ? "enable" : "disable",
3550 usb3_lpm_names[state]);
3556 * Now send the control transfer to enable device-initiated LPM
3557 * for either U1 or U2.
3559 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3560 USB_REQ_SET_FEATURE,
3564 USB_CTRL_SET_TIMEOUT);
3566 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3567 USB_REQ_CLEAR_FEATURE,
3571 USB_CTRL_SET_TIMEOUT);
3574 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3575 enable ? "Enable" : "Disable",
3576 usb3_lpm_names[state]);
3582 static int usb_set_lpm_timeout(struct usb_device *udev,
3583 enum usb3_link_state state, int timeout)
3590 feature = USB_PORT_FEAT_U1_TIMEOUT;
3593 feature = USB_PORT_FEAT_U2_TIMEOUT;
3596 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3601 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3602 timeout != USB3_LPM_DEVICE_INITIATED) {
3603 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3604 "which is a reserved value.\n",
3605 usb3_lpm_names[state], timeout);
3609 ret = set_port_feature(udev->parent,
3610 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3613 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3614 "error code %i\n", usb3_lpm_names[state],
3618 if (state == USB3_LPM_U1)
3619 udev->u1_params.timeout = timeout;
3621 udev->u2_params.timeout = timeout;
3626 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3629 * We will attempt to enable U1 or U2, but there are no guarantees that the
3630 * control transfers to set the hub timeout or enable device-initiated U1/U2
3631 * will be successful.
3633 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3634 * driver know about it. If that call fails, it should be harmless, and just
3635 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3637 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3638 enum usb3_link_state state)
3641 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3642 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3644 /* If the device says it doesn't have *any* exit latency to come out of
3645 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3648 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3649 (state == USB3_LPM_U2 && u2_mel == 0))
3653 * First, let the device know about the exit latencies
3654 * associated with the link state we're about to enable.
3656 ret = usb_req_set_sel(udev, state);
3658 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3659 usb3_lpm_names[state]);
3663 /* We allow the host controller to set the U1/U2 timeout internally
3664 * first, so that it can change its schedule to account for the
3665 * additional latency to send data to a device in a lower power
3668 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3670 /* xHCI host controller doesn't want to enable this LPM state. */
3675 dev_warn(&udev->dev, "Could not enable %s link state, "
3676 "xHCI error %i.\n", usb3_lpm_names[state],
3681 if (usb_set_lpm_timeout(udev, state, timeout))
3682 /* If we can't set the parent hub U1/U2 timeout,
3683 * device-initiated LPM won't be allowed either, so let the xHCI
3684 * host know that this link state won't be enabled.
3686 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3688 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3689 else if (udev->actconfig)
3690 usb_set_device_initiated_lpm(udev, state, true);
3695 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3698 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3699 * If zero is returned, the parent will not allow the link to go into U1/U2.
3701 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3702 * it won't have an effect on the bus link state because the parent hub will
3703 * still disallow device-initiated U1/U2 entry.
3705 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3706 * possible. The result will be slightly more bus bandwidth will be taken up
3707 * (to account for U1/U2 exit latency), but it should be harmless.
3709 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3710 enum usb3_link_state state)
3716 feature = USB_PORT_FEAT_U1_TIMEOUT;
3719 feature = USB_PORT_FEAT_U2_TIMEOUT;
3722 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3727 if (usb_set_lpm_timeout(udev, state, 0))
3730 usb_set_device_initiated_lpm(udev, state, false);
3732 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3733 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3734 "bus schedule bandwidth may be impacted.\n",
3735 usb3_lpm_names[state]);
3740 * Disable hub-initiated and device-initiated U1 and U2 entry.
3741 * Caller must own the bandwidth_mutex.
3743 * This will call usb_enable_lpm() on failure, which will decrement
3744 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3746 int usb_disable_lpm(struct usb_device *udev)
3748 struct usb_hcd *hcd;
3750 if (!udev || !udev->parent ||
3751 udev->speed != USB_SPEED_SUPER ||
3755 hcd = bus_to_hcd(udev->bus);
3756 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3759 udev->lpm_disable_count++;
3760 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3763 /* If LPM is enabled, attempt to disable it. */
3764 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3766 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3772 usb_enable_lpm(udev);
3775 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3777 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3778 int usb_unlocked_disable_lpm(struct usb_device *udev)
3780 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3786 mutex_lock(hcd->bandwidth_mutex);
3787 ret = usb_disable_lpm(udev);
3788 mutex_unlock(hcd->bandwidth_mutex);
3792 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3795 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3796 * xHCI host policy may prevent U1 or U2 from being enabled.
3798 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3799 * until the lpm_disable_count drops to zero. Caller must own the
3802 void usb_enable_lpm(struct usb_device *udev)
3804 struct usb_hcd *hcd;
3806 if (!udev || !udev->parent ||
3807 udev->speed != USB_SPEED_SUPER ||
3811 udev->lpm_disable_count--;
3812 hcd = bus_to_hcd(udev->bus);
3813 /* Double check that we can both enable and disable LPM.
3814 * Device must be configured to accept set feature U1/U2 timeout.
3816 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3817 !hcd->driver->disable_usb3_lpm_timeout)
3820 if (udev->lpm_disable_count > 0)
3823 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3824 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3826 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3828 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3829 void usb_unlocked_enable_lpm(struct usb_device *udev)
3831 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3836 mutex_lock(hcd->bandwidth_mutex);
3837 usb_enable_lpm(udev);
3838 mutex_unlock(hcd->bandwidth_mutex);
3840 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3843 #else /* CONFIG_PM */
3845 #define hub_suspend NULL
3846 #define hub_resume NULL
3847 #define hub_reset_resume NULL
3849 int usb_disable_lpm(struct usb_device *udev)
3853 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3855 void usb_enable_lpm(struct usb_device *udev) { }
3856 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3858 int usb_unlocked_disable_lpm(struct usb_device *udev)
3862 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3864 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3865 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3867 int usb_disable_ltm(struct usb_device *udev)
3871 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3873 void usb_enable_ltm(struct usb_device *udev) { }
3874 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3876 #endif /* CONFIG_PM */
3879 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3881 * Between connect detection and reset signaling there must be a delay
3882 * of 100ms at least for debounce and power-settling. The corresponding
3883 * timer shall restart whenever the downstream port detects a disconnect.
3885 * Apparently there are some bluetooth and irda-dongles and a number of
3886 * low-speed devices for which this debounce period may last over a second.
3887 * Not covered by the spec - but easy to deal with.
3889 * This implementation uses a 1500ms total debounce timeout; if the
3890 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3891 * every 25ms for transient disconnects. When the port status has been
3892 * unchanged for 100ms it returns the port status.
3894 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3897 int total_time, stable_time = 0;
3898 u16 portchange, portstatus;
3899 unsigned connection = 0xffff;
3901 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3902 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3906 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3907 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3908 if (!must_be_connected ||
3909 (connection == USB_PORT_STAT_CONNECTION))
3910 stable_time += HUB_DEBOUNCE_STEP;
3911 if (stable_time >= HUB_DEBOUNCE_STABLE)
3915 connection = portstatus & USB_PORT_STAT_CONNECTION;
3918 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3919 usb_clear_port_feature(hub->hdev, port1,
3920 USB_PORT_FEAT_C_CONNECTION);
3923 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3925 msleep(HUB_DEBOUNCE_STEP);
3928 dev_dbg (hub->intfdev,
3929 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3930 port1, total_time, stable_time, portstatus);
3932 if (stable_time < HUB_DEBOUNCE_STABLE)
3937 void usb_ep0_reinit(struct usb_device *udev)
3939 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3940 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3941 usb_enable_endpoint(udev, &udev->ep0, true);
3943 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3945 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3946 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3948 static int hub_set_address(struct usb_device *udev, int devnum)
3951 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3954 * The host controller will choose the device address,
3955 * instead of the core having chosen it earlier
3957 if (!hcd->driver->address_device && devnum <= 1)
3959 if (udev->state == USB_STATE_ADDRESS)
3961 if (udev->state != USB_STATE_DEFAULT)
3963 if (hcd->driver->address_device)
3964 retval = hcd->driver->address_device(hcd, udev);
3966 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3967 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3968 NULL, 0, USB_CTRL_SET_TIMEOUT);
3970 update_devnum(udev, devnum);
3971 /* Device now using proper address. */
3972 usb_set_device_state(udev, USB_STATE_ADDRESS);
3973 usb_ep0_reinit(udev);
3979 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
3980 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
3983 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
3984 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
3985 * support bit in the BOS descriptor.
3987 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
3991 if (!udev->usb2_hw_lpm_capable)
3994 connect_type = usb_get_hub_port_connect_type(udev->parent,
3997 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
3998 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
3999 udev->usb2_hw_lpm_allowed = 1;
4000 usb_set_usb2_hardware_lpm(udev, 1);
4004 static int hub_enable_device(struct usb_device *udev)
4006 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4008 if (!hcd->driver->enable_device)
4010 if (udev->state == USB_STATE_ADDRESS)
4012 if (udev->state != USB_STATE_DEFAULT)
4015 return hcd->driver->enable_device(hcd, udev);
4018 /* Reset device, (re)assign address, get device descriptor.
4019 * Device connection must be stable, no more debouncing needed.
4020 * Returns device in USB_STATE_ADDRESS, except on error.
4022 * If this is called for an already-existing device (as part of
4023 * usb_reset_and_verify_device), the caller must own the device lock. For a
4024 * newly detected device that is not accessible through any global
4025 * pointers, it's not necessary to lock the device.
4028 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4031 struct usb_device *hdev = hub->hdev;
4032 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4034 unsigned delay = HUB_SHORT_RESET_TIME;
4035 enum usb_device_speed oldspeed = udev->speed;
4037 int devnum = udev->devnum;
4039 /* root hub ports have a slightly longer reset period
4040 * (from USB 2.0 spec, section 7.1.7.5)
4042 if (!hdev->parent) {
4043 delay = HUB_ROOT_RESET_TIME;
4044 if (port1 == hdev->bus->otg_port)
4045 hdev->bus->b_hnp_enable = 0;
4048 /* Some low speed devices have problems with the quick delay, so */
4049 /* be a bit pessimistic with those devices. RHbug #23670 */
4050 if (oldspeed == USB_SPEED_LOW)
4051 delay = HUB_LONG_RESET_TIME;
4053 mutex_lock(&hdev->bus->usb_address0_mutex);
4055 /* Reset the device; full speed may morph to high speed */
4056 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4057 retval = hub_port_reset(hub, port1, udev, delay, false);
4058 if (retval < 0) /* error or disconnect */
4060 /* success, speed is known */
4064 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4065 dev_dbg(&udev->dev, "device reset changed speed!\n");
4068 oldspeed = udev->speed;
4070 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4071 * it's fixed size except for full speed devices.
4072 * For Wireless USB devices, ep0 max packet is always 512 (tho
4073 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4075 switch (udev->speed) {
4076 case USB_SPEED_SUPER:
4077 case USB_SPEED_WIRELESS: /* fixed at 512 */
4078 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4080 case USB_SPEED_HIGH: /* fixed at 64 */
4081 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4083 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4084 /* to determine the ep0 maxpacket size, try to read
4085 * the device descriptor to get bMaxPacketSize0 and
4086 * then correct our initial guess.
4088 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4090 case USB_SPEED_LOW: /* fixed at 8 */
4091 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4097 if (udev->speed == USB_SPEED_WIRELESS)
4098 speed = "variable speed Wireless";
4100 speed = usb_speed_string(udev->speed);
4102 if (udev->speed != USB_SPEED_SUPER)
4103 dev_info(&udev->dev,
4104 "%s %s USB device number %d using %s\n",
4105 (udev->config) ? "reset" : "new", speed,
4106 devnum, udev->bus->controller->driver->name);
4108 /* Set up TT records, if needed */
4110 udev->tt = hdev->tt;
4111 udev->ttport = hdev->ttport;
4112 } else if (udev->speed != USB_SPEED_HIGH
4113 && hdev->speed == USB_SPEED_HIGH) {
4115 dev_err(&udev->dev, "parent hub has no TT\n");
4119 udev->tt = &hub->tt;
4120 udev->ttport = port1;
4123 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4124 * Because device hardware and firmware is sometimes buggy in
4125 * this area, and this is how Linux has done it for ages.
4126 * Change it cautiously.
4128 * NOTE: If use_new_scheme() is true we will start by issuing
4129 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4130 * so it may help with some non-standards-compliant devices.
4131 * Otherwise we start with SET_ADDRESS and then try to read the
4132 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4135 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4136 bool did_new_scheme = false;
4138 if (use_new_scheme(udev, retry_counter)) {
4139 struct usb_device_descriptor *buf;
4142 did_new_scheme = true;
4143 retval = hub_enable_device(udev);
4146 "hub failed to enable device, error %d\n",
4151 #define GET_DESCRIPTOR_BUFSIZE 64
4152 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4158 /* Retry on all errors; some devices are flakey.
4159 * 255 is for WUSB devices, we actually need to use
4160 * 512 (WUSB1.0[4.8.1]).
4162 for (j = 0; j < 3; ++j) {
4163 buf->bMaxPacketSize0 = 0;
4164 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4165 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4166 USB_DT_DEVICE << 8, 0,
4167 buf, GET_DESCRIPTOR_BUFSIZE,
4168 initial_descriptor_timeout);
4169 switch (buf->bMaxPacketSize0) {
4170 case 8: case 16: case 32: case 64: case 255:
4171 if (buf->bDescriptorType ==
4185 udev->descriptor.bMaxPacketSize0 =
4186 buf->bMaxPacketSize0;
4189 retval = hub_port_reset(hub, port1, udev, delay, false);
4190 if (retval < 0) /* error or disconnect */
4192 if (oldspeed != udev->speed) {
4194 "device reset changed speed!\n");
4200 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4205 #undef GET_DESCRIPTOR_BUFSIZE
4209 * If device is WUSB, we already assigned an
4210 * unauthorized address in the Connect Ack sequence;
4211 * authorization will assign the final address.
4213 if (udev->wusb == 0) {
4214 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4215 retval = hub_set_address(udev, devnum);
4221 if (retval != -ENODEV)
4222 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4226 if (udev->speed == USB_SPEED_SUPER) {
4227 devnum = udev->devnum;
4228 dev_info(&udev->dev,
4229 "%s SuperSpeed USB device number %d using %s\n",
4230 (udev->config) ? "reset" : "new",
4231 devnum, udev->bus->controller->driver->name);
4234 /* cope with hardware quirkiness:
4235 * - let SET_ADDRESS settle, some device hardware wants it
4236 * - read ep0 maxpacket even for high and low speed,
4239 /* use_new_scheme() checks the speed which may have
4240 * changed since the initial look so we cache the result
4247 retval = usb_get_device_descriptor(udev, 8);
4249 if (retval != -ENODEV)
4251 "device descriptor read/8, error %d\n",
4263 if (hcd->phy && !hdev->parent)
4264 usb_phy_notify_connect(hcd->phy, udev->speed);
4267 * Some superspeed devices have finished the link training process
4268 * and attached to a superspeed hub port, but the device descriptor
4269 * got from those devices show they aren't superspeed devices. Warm
4270 * reset the port attached by the devices can fix them.
4272 if ((udev->speed == USB_SPEED_SUPER) &&
4273 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4274 dev_err(&udev->dev, "got a wrong device descriptor, "
4275 "warm reset device\n");
4276 hub_port_reset(hub, port1, udev,
4277 HUB_BH_RESET_TIME, true);
4282 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4283 udev->speed == USB_SPEED_SUPER)
4286 i = udev->descriptor.bMaxPacketSize0;
4287 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4288 if (udev->speed == USB_SPEED_LOW ||
4289 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4290 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4294 if (udev->speed == USB_SPEED_FULL)
4295 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4297 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4298 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4299 usb_ep0_reinit(udev);
4302 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4303 if (retval < (signed)sizeof(udev->descriptor)) {
4304 if (retval != -ENODEV)
4305 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4312 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4313 retval = usb_get_bos_descriptor(udev);
4315 udev->lpm_capable = usb_device_supports_lpm(udev);
4316 usb_set_lpm_parameters(udev);
4321 /* notify HCD that we have a device connected and addressed */
4322 if (hcd->driver->update_device)
4323 hcd->driver->update_device(hcd, udev);
4324 hub_set_initial_usb2_lpm_policy(udev);
4327 hub_port_disable(hub, port1, 0);
4328 update_devnum(udev, devnum); /* for disconnect processing */
4330 mutex_unlock(&hdev->bus->usb_address0_mutex);
4335 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4337 struct usb_qualifier_descriptor *qual;
4340 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4344 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4345 qual, sizeof *qual);
4346 if (status == sizeof *qual) {
4347 dev_info(&udev->dev, "not running at top speed; "
4348 "connect to a high speed hub\n");
4349 /* hub LEDs are probably harder to miss than syslog */
4350 if (hub->has_indicators) {
4351 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4352 queue_delayed_work(system_power_efficient_wq,
4360 hub_power_remaining (struct usb_hub *hub)
4362 struct usb_device *hdev = hub->hdev;
4366 if (!hub->limited_power)
4369 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4370 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4371 struct usb_device *udev = hub->ports[port1 - 1]->child;
4377 if (hub_is_superspeed(udev))
4383 * Unconfigured devices may not use more than one unit load,
4384 * or 8mA for OTG ports
4386 if (udev->actconfig)
4387 delta = usb_get_max_power(udev, udev->actconfig);
4388 else if (port1 != udev->bus->otg_port || hdev->parent)
4392 if (delta > hub->mA_per_port)
4393 dev_warn(&udev->dev,
4394 "%dmA is over %umA budget for port %d!\n",
4395 delta, hub->mA_per_port, port1);
4398 if (remaining < 0) {
4399 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4406 /* Handle physical or logical connection change events.
4407 * This routine is called when:
4408 * a port connection-change occurs;
4409 * a port enable-change occurs (often caused by EMI);
4410 * usb_reset_and_verify_device() encounters changed descriptors (as from
4411 * a firmware download)
4412 * caller already locked the hub
4414 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4415 u16 portstatus, u16 portchange)
4417 struct usb_device *hdev = hub->hdev;
4418 struct device *hub_dev = hub->intfdev;
4419 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4420 unsigned wHubCharacteristics =
4421 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4422 struct usb_device *udev;
4427 "port %d, status %04x, change %04x, %s\n",
4428 port1, portstatus, portchange, portspeed(hub, portstatus));
4430 if (hub->has_indicators) {
4431 set_port_led(hub, port1, HUB_LED_AUTO);
4432 hub->indicator[port1-1] = INDICATOR_AUTO;
4435 #ifdef CONFIG_USB_OTG
4436 /* during HNP, don't repeat the debounce */
4437 if (hdev->bus->is_b_host)
4438 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4439 USB_PORT_STAT_C_ENABLE);
4442 /* Try to resuscitate an existing device */
4443 udev = hub->ports[port1 - 1]->child;
4444 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4445 udev->state != USB_STATE_NOTATTACHED) {
4446 usb_lock_device(udev);
4447 if (portstatus & USB_PORT_STAT_ENABLE) {
4448 status = 0; /* Nothing to do */
4450 #ifdef CONFIG_PM_RUNTIME
4451 } else if (udev->state == USB_STATE_SUSPENDED &&
4452 udev->persist_enabled) {
4453 /* For a suspended device, treat this as a
4454 * remote wakeup event.
4456 status = usb_remote_wakeup(udev);
4460 status = -ENODEV; /* Don't resuscitate */
4462 usb_unlock_device(udev);
4465 clear_bit(port1, hub->change_bits);
4470 /* Disconnect any existing devices under this port */
4472 if (hcd->phy && !hdev->parent &&
4473 !(portstatus & USB_PORT_STAT_CONNECTION))
4474 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4475 usb_disconnect(&hub->ports[port1 - 1]->child);
4477 clear_bit(port1, hub->change_bits);
4479 /* We can forget about a "removed" device when there's a physical
4480 * disconnect or the connect status changes.
4482 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4483 (portchange & USB_PORT_STAT_C_CONNECTION))
4484 clear_bit(port1, hub->removed_bits);
4486 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4487 USB_PORT_STAT_C_ENABLE)) {
4488 status = hub_port_debounce_be_stable(hub, port1);
4490 if (status != -ENODEV && printk_ratelimit())
4491 dev_err(hub_dev, "connect-debounce failed, "
4492 "port %d disabled\n", port1);
4493 portstatus &= ~USB_PORT_STAT_CONNECTION;
4495 portstatus = status;
4499 /* Return now if debouncing failed or nothing is connected or
4500 * the device was "removed".
4502 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4503 test_bit(port1, hub->removed_bits)) {
4505 /* maybe switch power back on (e.g. root hub was reset) */
4506 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4507 && !port_is_power_on(hub, portstatus))
4508 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4510 if (portstatus & USB_PORT_STAT_ENABLE)
4514 if (hub_is_superspeed(hub->hdev))
4520 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4522 /* reallocate for each attempt, since references
4523 * to the previous one can escape in various ways
4525 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4528 "couldn't allocate port %d usb_device\n",
4533 usb_set_device_state(udev, USB_STATE_POWERED);
4534 udev->bus_mA = hub->mA_per_port;
4535 udev->level = hdev->level + 1;
4536 udev->wusb = hub_is_wusb(hub);
4538 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4539 if (hub_is_superspeed(hub->hdev))
4540 udev->speed = USB_SPEED_SUPER;
4542 udev->speed = USB_SPEED_UNKNOWN;
4544 choose_devnum(udev);
4545 if (udev->devnum <= 0) {
4546 status = -ENOTCONN; /* Don't retry */
4550 /* reset (non-USB 3.0 devices) and get descriptor */
4551 status = hub_port_init(hub, udev, port1, i);
4555 usb_detect_quirks(udev);
4556 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4559 /* consecutive bus-powered hubs aren't reliable; they can
4560 * violate the voltage drop budget. if the new child has
4561 * a "powered" LED, users should notice we didn't enable it
4562 * (without reading syslog), even without per-port LEDs
4565 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4566 && udev->bus_mA <= unit_load) {
4569 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4572 dev_dbg(&udev->dev, "get status %d ?\n", status);
4575 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4577 "can't connect bus-powered hub "
4579 if (hub->has_indicators) {
4580 hub->indicator[port1-1] =
4581 INDICATOR_AMBER_BLINK;
4583 system_power_efficient_wq,
4586 status = -ENOTCONN; /* Don't retry */
4591 /* check for devices running slower than they could */
4592 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4593 && udev->speed == USB_SPEED_FULL
4594 && highspeed_hubs != 0)
4595 check_highspeed (hub, udev, port1);
4597 /* Store the parent's children[] pointer. At this point
4598 * udev becomes globally accessible, although presumably
4599 * no one will look at it until hdev is unlocked.
4603 /* We mustn't add new devices if the parent hub has
4604 * been disconnected; we would race with the
4605 * recursively_mark_NOTATTACHED() routine.
4607 spin_lock_irq(&device_state_lock);
4608 if (hdev->state == USB_STATE_NOTATTACHED)
4611 hub->ports[port1 - 1]->child = udev;
4612 spin_unlock_irq(&device_state_lock);
4614 /* Run it through the hoops (find a driver, etc) */
4616 status = usb_new_device(udev);
4618 spin_lock_irq(&device_state_lock);
4619 hub->ports[port1 - 1]->child = NULL;
4620 spin_unlock_irq(&device_state_lock);
4627 status = hub_power_remaining(hub);
4629 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4634 hub_port_disable(hub, port1, 1);
4636 usb_ep0_reinit(udev);
4637 release_devnum(udev);
4640 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4643 if (hub->hdev->parent ||
4644 !hcd->driver->port_handed_over ||
4645 !(hcd->driver->port_handed_over)(hcd, port1)) {
4646 if (status != -ENOTCONN && status != -ENODEV)
4647 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4652 hub_port_disable(hub, port1, 1);
4653 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4654 hcd->driver->relinquish_port(hcd, port1);
4657 /* Returns 1 if there was a remote wakeup and a connect status change. */
4658 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4659 u16 portstatus, u16 portchange)
4661 struct usb_device *hdev;
4662 struct usb_device *udev;
4663 int connect_change = 0;
4667 udev = hub->ports[port - 1]->child;
4668 if (!hub_is_superspeed(hdev)) {
4669 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4671 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4673 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4674 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4680 /* TRSMRCY = 10 msec */
4683 usb_lock_device(udev);
4684 ret = usb_remote_wakeup(udev);
4685 usb_unlock_device(udev);
4690 hub_port_disable(hub, port, 1);
4692 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4694 return connect_change;
4697 static void hub_events(void)
4699 struct list_head *tmp;
4700 struct usb_device *hdev;
4701 struct usb_interface *intf;
4702 struct usb_hub *hub;
4703 struct device *hub_dev;
4709 int connect_change, wakeup_change;
4712 * We restart the list every time to avoid a deadlock with
4713 * deleting hubs downstream from this one. This should be
4714 * safe since we delete the hub from the event list.
4715 * Not the most efficient, but avoids deadlocks.
4719 /* Grab the first entry at the beginning of the list */
4720 spin_lock_irq(&hub_event_lock);
4721 if (list_empty(&hub_event_list)) {
4722 spin_unlock_irq(&hub_event_lock);
4726 tmp = hub_event_list.next;
4729 hub = list_entry(tmp, struct usb_hub, event_list);
4730 kref_get(&hub->kref);
4731 spin_unlock_irq(&hub_event_lock);
4734 hub_dev = hub->intfdev;
4735 intf = to_usb_interface(hub_dev);
4736 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4737 hdev->state, hdev->maxchild,
4738 /* NOTE: expects max 15 ports... */
4739 (u16) hub->change_bits[0],
4740 (u16) hub->event_bits[0]);
4742 /* Lock the device, then check to see if we were
4743 * disconnected while waiting for the lock to succeed. */
4744 usb_lock_device(hdev);
4745 if (unlikely(hub->disconnected))
4746 goto loop_disconnected;
4748 /* If the hub has died, clean up after it */
4749 if (hdev->state == USB_STATE_NOTATTACHED) {
4750 hub->error = -ENODEV;
4751 hub_quiesce(hub, HUB_DISCONNECT);
4756 ret = usb_autopm_get_interface(intf);
4758 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4762 /* If this is an inactive hub, do nothing */
4767 dev_dbg (hub_dev, "resetting for error %d\n",
4770 ret = usb_reset_device(hdev);
4773 "error resetting hub: %d\n", ret);
4781 /* deal with port status changes */
4782 for (i = 1; i <= hdev->maxchild; i++) {
4783 struct usb_device *udev = hub->ports[i - 1]->child;
4785 if (test_bit(i, hub->busy_bits))
4787 connect_change = test_bit(i, hub->change_bits);
4788 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4789 if (!test_and_clear_bit(i, hub->event_bits) &&
4790 !connect_change && !wakeup_change)
4793 ret = hub_port_status(hub, i,
4794 &portstatus, &portchange);
4798 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4799 usb_clear_port_feature(hdev, i,
4800 USB_PORT_FEAT_C_CONNECTION);
4804 if (portchange & USB_PORT_STAT_C_ENABLE) {
4805 if (!connect_change)
4807 "port %d enable change, "
4810 usb_clear_port_feature(hdev, i,
4811 USB_PORT_FEAT_C_ENABLE);
4814 * EM interference sometimes causes badly
4815 * shielded USB devices to be shutdown by
4816 * the hub, this hack enables them again.
4817 * Works at least with mouse driver.
4819 if (!(portstatus & USB_PORT_STAT_ENABLE)
4821 && hub->ports[i - 1]->child) {
4824 "disabled by hub (EMI?), "
4831 if (hub_handle_remote_wakeup(hub, i,
4832 portstatus, portchange))
4835 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4839 dev_dbg(hub_dev, "over-current change on port "
4841 usb_clear_port_feature(hdev, i,
4842 USB_PORT_FEAT_C_OVER_CURRENT);
4843 msleep(100); /* Cool down */
4844 hub_power_on(hub, true);
4845 hub_port_status(hub, i, &status, &unused);
4846 if (status & USB_PORT_STAT_OVERCURRENT)
4847 dev_err(hub_dev, "over-current "
4848 "condition on port %d\n", i);
4851 if (portchange & USB_PORT_STAT_C_RESET) {
4853 "reset change on port %d\n",
4855 usb_clear_port_feature(hdev, i,
4856 USB_PORT_FEAT_C_RESET);
4858 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4859 hub_is_superspeed(hub->hdev)) {
4861 "warm reset change on port %d\n",
4863 usb_clear_port_feature(hdev, i,
4864 USB_PORT_FEAT_C_BH_PORT_RESET);
4866 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4867 usb_clear_port_feature(hub->hdev, i,
4868 USB_PORT_FEAT_C_PORT_LINK_STATE);
4870 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4872 "config error on port %d\n",
4874 usb_clear_port_feature(hub->hdev, i,
4875 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4878 /* Warm reset a USB3 protocol port if it's in
4879 * SS.Inactive state.
4881 if (hub_port_warm_reset_required(hub, portstatus)) {
4884 dev_dbg(hub_dev, "warm reset port %d\n", i);
4886 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4887 udev->state == USB_STATE_NOTATTACHED) {
4888 status = hub_port_reset(hub, i,
4889 NULL, HUB_BH_RESET_TIME,
4892 hub_port_disable(hub, i, 1);
4894 usb_lock_device(udev);
4895 status = usb_reset_device(udev);
4896 usb_unlock_device(udev);
4900 * On disconnect USB3 protocol ports transit from U0 to
4901 * SS.Inactive to Rx.Detect. If this happens a warm-
4902 * reset is not needed, but a (re)connect may happen
4903 * before khubd runs and sees the disconnect, and the
4904 * device may be an unknown state.
4906 * If the port went through SS.Inactive without khubd
4907 * seeing it the C_LINK_STATE change flag will be set,
4908 * and we reset the dev to put it in a known state.
4910 } else if (udev && hub_is_superspeed(hub->hdev) &&
4911 (portchange & USB_PORT_STAT_C_LINK_STATE) &&
4912 (portstatus & USB_PORT_STAT_CONNECTION)) {
4913 usb_lock_device(udev);
4914 usb_reset_device(udev);
4915 usb_unlock_device(udev);
4920 hub_port_connect_change(hub, i,
4921 portstatus, portchange);
4924 /* deal with hub status changes */
4925 if (test_and_clear_bit(0, hub->event_bits) == 0)
4927 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4928 dev_err (hub_dev, "get_hub_status failed\n");
4930 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4931 dev_dbg (hub_dev, "power change\n");
4932 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4933 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4934 /* FIXME: Is this always true? */
4935 hub->limited_power = 1;
4937 hub->limited_power = 0;
4939 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4943 dev_dbg(hub_dev, "over-current change\n");
4944 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4945 msleep(500); /* Cool down */
4946 hub_power_on(hub, true);
4947 hub_hub_status(hub, &status, &unused);
4948 if (status & HUB_STATUS_OVERCURRENT)
4949 dev_err(hub_dev, "over-current "
4955 /* Balance the usb_autopm_get_interface() above */
4956 usb_autopm_put_interface_no_suspend(intf);
4958 /* Balance the usb_autopm_get_interface_no_resume() in
4959 * kick_khubd() and allow autosuspend.
4961 usb_autopm_put_interface(intf);
4963 usb_unlock_device(hdev);
4964 kref_put(&hub->kref, hub_release);
4966 } /* end while (1) */
4969 static int hub_thread(void *__unused)
4971 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4972 * port handover. Otherwise it might see that a full-speed device
4973 * was gone before the EHCI controller had handed its port over to
4974 * the companion full-speed controller.
4980 wait_event_freezable(khubd_wait,
4981 !list_empty(&hub_event_list) ||
4982 kthread_should_stop());
4983 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4985 pr_debug("%s: khubd exiting\n", usbcore_name);
4989 static const struct usb_device_id hub_id_table[] = {
4990 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4991 | USB_DEVICE_ID_MATCH_INT_CLASS,
4992 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4993 .bInterfaceClass = USB_CLASS_HUB,
4994 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4995 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4996 .bDeviceClass = USB_CLASS_HUB},
4997 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4998 .bInterfaceClass = USB_CLASS_HUB},
4999 { } /* Terminating entry */
5002 MODULE_DEVICE_TABLE (usb, hub_id_table);
5004 static struct usb_driver hub_driver = {
5007 .disconnect = hub_disconnect,
5008 .suspend = hub_suspend,
5009 .resume = hub_resume,
5010 .reset_resume = hub_reset_resume,
5011 .pre_reset = hub_pre_reset,
5012 .post_reset = hub_post_reset,
5013 .unlocked_ioctl = hub_ioctl,
5014 .id_table = hub_id_table,
5015 .supports_autosuspend = 1,
5018 int usb_hub_init(void)
5020 if (usb_register(&hub_driver) < 0) {
5021 printk(KERN_ERR "%s: can't register hub driver\n",
5026 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5027 if (!IS_ERR(khubd_task))
5030 /* Fall through if kernel_thread failed */
5031 usb_deregister(&hub_driver);
5032 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5037 void usb_hub_cleanup(void)
5039 kthread_stop(khubd_task);
5042 * Hub resources are freed for us by usb_deregister. It calls
5043 * usb_driver_purge on every device which in turn calls that
5044 * devices disconnect function if it is using this driver.
5045 * The hub_disconnect function takes care of releasing the
5046 * individual hub resources. -greg
5048 usb_deregister(&hub_driver);
5049 } /* usb_hub_cleanup() */
5051 static int descriptors_changed(struct usb_device *udev,
5052 struct usb_device_descriptor *old_device_descriptor,
5053 struct usb_host_bos *old_bos)
5057 unsigned serial_len = 0;
5059 unsigned old_length;
5063 if (memcmp(&udev->descriptor, old_device_descriptor,
5064 sizeof(*old_device_descriptor)) != 0)
5067 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5070 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5071 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5073 if (memcmp(udev->bos->desc, old_bos->desc, len))
5077 /* Since the idVendor, idProduct, and bcdDevice values in the
5078 * device descriptor haven't changed, we will assume the
5079 * Manufacturer and Product strings haven't changed either.
5080 * But the SerialNumber string could be different (e.g., a
5081 * different flash card of the same brand).
5084 serial_len = strlen(udev->serial) + 1;
5087 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5088 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5089 len = max(len, old_length);
5092 buf = kmalloc(len, GFP_NOIO);
5094 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5095 /* assume the worst */
5098 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5099 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5100 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5102 if (length != old_length) {
5103 dev_dbg(&udev->dev, "config index %d, error %d\n",
5108 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5110 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5112 ((struct usb_config_descriptor *) buf)->
5113 bConfigurationValue);
5119 if (!changed && serial_len) {
5120 length = usb_string(udev, udev->descriptor.iSerialNumber,
5122 if (length + 1 != serial_len) {
5123 dev_dbg(&udev->dev, "serial string error %d\n",
5126 } else if (memcmp(buf, udev->serial, length) != 0) {
5127 dev_dbg(&udev->dev, "serial string changed\n");
5137 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5138 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5140 * WARNING - don't use this routine to reset a composite device
5141 * (one with multiple interfaces owned by separate drivers)!
5142 * Use usb_reset_device() instead.
5144 * Do a port reset, reassign the device's address, and establish its
5145 * former operating configuration. If the reset fails, or the device's
5146 * descriptors change from their values before the reset, or the original
5147 * configuration and altsettings cannot be restored, a flag will be set
5148 * telling khubd to pretend the device has been disconnected and then
5149 * re-connected. All drivers will be unbound, and the device will be
5150 * re-enumerated and probed all over again.
5152 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5153 * flagged for logical disconnection, or some other negative error code
5154 * if the reset wasn't even attempted.
5157 * The caller must own the device lock. For example, it's safe to use
5158 * this from a driver probe() routine after downloading new firmware.
5159 * For calls that might not occur during probe(), drivers should lock
5160 * the device using usb_lock_device_for_reset().
5162 * Locking exception: This routine may also be called from within an
5163 * autoresume handler. Such usage won't conflict with other tasks
5164 * holding the device lock because these tasks should always call
5165 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5167 static int usb_reset_and_verify_device(struct usb_device *udev)
5169 struct usb_device *parent_hdev = udev->parent;
5170 struct usb_hub *parent_hub;
5171 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5172 struct usb_device_descriptor descriptor = udev->descriptor;
5173 struct usb_host_bos *bos;
5175 int port1 = udev->portnum;
5177 if (udev->state == USB_STATE_NOTATTACHED ||
5178 udev->state == USB_STATE_SUSPENDED) {
5179 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5185 /* this requires hcd-specific logic; see ohci_restart() */
5186 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5189 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5191 /* Disable USB2 hardware LPM.
5192 * It will be re-enabled by the enumeration process.
5194 if (udev->usb2_hw_lpm_enabled == 1)
5195 usb_set_usb2_hardware_lpm(udev, 0);
5200 /* Disable LPM and LTM while we reset the device and reinstall the alt
5201 * settings. Device-initiated LPM settings, and system exit latency
5202 * settings are cleared when the device is reset, so we have to set
5205 ret = usb_unlocked_disable_lpm(udev);
5207 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5210 ret = usb_disable_ltm(udev);
5212 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5217 set_bit(port1, parent_hub->busy_bits);
5218 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5220 /* ep0 maxpacket size may change; let the HCD know about it.
5221 * Other endpoints will be handled by re-enumeration. */
5222 usb_ep0_reinit(udev);
5223 ret = hub_port_init(parent_hub, udev, port1, i);
5224 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5227 clear_bit(port1, parent_hub->busy_bits);
5232 /* Device might have changed firmware (DFU or similar) */
5233 if (descriptors_changed(udev, &descriptor, bos)) {
5234 dev_info(&udev->dev, "device firmware changed\n");
5235 udev->descriptor = descriptor; /* for disconnect() calls */
5239 /* Restore the device's previous configuration */
5240 if (!udev->actconfig)
5243 mutex_lock(hcd->bandwidth_mutex);
5244 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5246 dev_warn(&udev->dev,
5247 "Busted HC? Not enough HCD resources for "
5248 "old configuration.\n");
5249 mutex_unlock(hcd->bandwidth_mutex);
5252 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5253 USB_REQ_SET_CONFIGURATION, 0,
5254 udev->actconfig->desc.bConfigurationValue, 0,
5255 NULL, 0, USB_CTRL_SET_TIMEOUT);
5258 "can't restore configuration #%d (error=%d)\n",
5259 udev->actconfig->desc.bConfigurationValue, ret);
5260 mutex_unlock(hcd->bandwidth_mutex);
5263 mutex_unlock(hcd->bandwidth_mutex);
5264 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5266 /* Put interfaces back into the same altsettings as before.
5267 * Don't bother to send the Set-Interface request for interfaces
5268 * that were already in altsetting 0; besides being unnecessary,
5269 * many devices can't handle it. Instead just reset the host-side
5272 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5273 struct usb_host_config *config = udev->actconfig;
5274 struct usb_interface *intf = config->interface[i];
5275 struct usb_interface_descriptor *desc;
5277 desc = &intf->cur_altsetting->desc;
5278 if (desc->bAlternateSetting == 0) {
5279 usb_disable_interface(udev, intf, true);
5280 usb_enable_interface(udev, intf, true);
5283 /* Let the bandwidth allocation function know that this
5284 * device has been reset, and it will have to use
5285 * alternate setting 0 as the current alternate setting.
5287 intf->resetting_device = 1;
5288 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5289 desc->bAlternateSetting);
5290 intf->resetting_device = 0;
5293 dev_err(&udev->dev, "failed to restore interface %d "
5294 "altsetting %d (error=%d)\n",
5295 desc->bInterfaceNumber,
5296 desc->bAlternateSetting,
5300 /* Resetting also frees any allocated streams */
5301 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5302 intf->cur_altsetting->endpoint[j].streams = 0;
5306 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5307 usb_set_usb2_hardware_lpm(udev, 1);
5308 usb_unlocked_enable_lpm(udev);
5309 usb_enable_ltm(udev);
5310 usb_release_bos_descriptor(udev);
5315 /* LPM state doesn't matter when we're about to destroy the device. */
5316 hub_port_logical_disconnect(parent_hub, port1);
5317 usb_release_bos_descriptor(udev);
5323 * usb_reset_device - warn interface drivers and perform a USB port reset
5324 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5326 * Warns all drivers bound to registered interfaces (using their pre_reset
5327 * method), performs the port reset, and then lets the drivers know that
5328 * the reset is over (using their post_reset method).
5330 * Return: The same as for usb_reset_and_verify_device().
5333 * The caller must own the device lock. For example, it's safe to use
5334 * this from a driver probe() routine after downloading new firmware.
5335 * For calls that might not occur during probe(), drivers should lock
5336 * the device using usb_lock_device_for_reset().
5338 * If an interface is currently being probed or disconnected, we assume
5339 * its driver knows how to handle resets. For all other interfaces,
5340 * if the driver doesn't have pre_reset and post_reset methods then
5341 * we attempt to unbind it and rebind afterward.
5343 int usb_reset_device(struct usb_device *udev)
5347 unsigned int noio_flag;
5348 struct usb_host_config *config = udev->actconfig;
5350 if (udev->state == USB_STATE_NOTATTACHED ||
5351 udev->state == USB_STATE_SUSPENDED) {
5352 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5358 * Don't allocate memory with GFP_KERNEL in current
5359 * context to avoid possible deadlock if usb mass
5360 * storage interface or usbnet interface(iSCSI case)
5361 * is included in current configuration. The easist
5362 * approach is to do it for every device reset,
5363 * because the device 'memalloc_noio' flag may have
5364 * not been set before reseting the usb device.
5366 noio_flag = memalloc_noio_save();
5368 /* Prevent autosuspend during the reset */
5369 usb_autoresume_device(udev);
5372 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5373 struct usb_interface *cintf = config->interface[i];
5374 struct usb_driver *drv;
5377 if (cintf->dev.driver) {
5378 drv = to_usb_driver(cintf->dev.driver);
5379 if (drv->pre_reset && drv->post_reset)
5380 unbind = (drv->pre_reset)(cintf);
5381 else if (cintf->condition ==
5382 USB_INTERFACE_BOUND)
5385 usb_forced_unbind_intf(cintf);
5390 ret = usb_reset_and_verify_device(udev);
5393 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5394 struct usb_interface *cintf = config->interface[i];
5395 struct usb_driver *drv;
5396 int rebind = cintf->needs_binding;
5398 if (!rebind && cintf->dev.driver) {
5399 drv = to_usb_driver(cintf->dev.driver);
5400 if (drv->post_reset)
5401 rebind = (drv->post_reset)(cintf);
5402 else if (cintf->condition ==
5403 USB_INTERFACE_BOUND)
5406 cintf->needs_binding = 1;
5409 usb_unbind_and_rebind_marked_interfaces(udev);
5412 usb_autosuspend_device(udev);
5413 memalloc_noio_restore(noio_flag);
5416 EXPORT_SYMBOL_GPL(usb_reset_device);
5420 * usb_queue_reset_device - Reset a USB device from an atomic context
5421 * @iface: USB interface belonging to the device to reset
5423 * This function can be used to reset a USB device from an atomic
5424 * context, where usb_reset_device() won't work (as it blocks).
5426 * Doing a reset via this method is functionally equivalent to calling
5427 * usb_reset_device(), except for the fact that it is delayed to a
5428 * workqueue. This means that any drivers bound to other interfaces
5429 * might be unbound, as well as users from usbfs in user space.
5433 * - Scheduling two resets at the same time from two different drivers
5434 * attached to two different interfaces of the same device is
5435 * possible; depending on how the driver attached to each interface
5436 * handles ->pre_reset(), the second reset might happen or not.
5438 * - If a driver is unbound and it had a pending reset, the reset will
5441 * - This function can be called during .probe() or .disconnect()
5442 * times. On return from .disconnect(), any pending resets will be
5445 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5448 * NOTE: We don't do any reference count tracking because it is not
5449 * needed. The lifecycle of the work_struct is tied to the
5450 * usb_interface. Before destroying the interface we cancel the
5451 * work_struct, so the fact that work_struct is queued and or
5452 * running means the interface (and thus, the device) exist and
5455 void usb_queue_reset_device(struct usb_interface *iface)
5457 schedule_work(&iface->reset_ws);
5459 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5462 * usb_hub_find_child - Get the pointer of child device
5463 * attached to the port which is specified by @port1.
5464 * @hdev: USB device belonging to the usb hub
5465 * @port1: port num to indicate which port the child device
5468 * USB drivers call this function to get hub's child device
5471 * Return: %NULL if input param is invalid and
5472 * child's usb_device pointer if non-NULL.
5474 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5477 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5479 if (port1 < 1 || port1 > hdev->maxchild)
5481 return hub->ports[port1 - 1]->child;
5483 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5486 * usb_set_hub_port_connect_type - set hub port connect type.
5487 * @hdev: USB device belonging to the usb hub
5488 * @port1: port num of the port
5489 * @type: connect type of the port
5491 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5492 enum usb_port_connect_type type)
5494 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5497 hub->ports[port1 - 1]->connect_type = type;
5501 * usb_get_hub_port_connect_type - Get the port's connect type
5502 * @hdev: USB device belonging to the usb hub
5503 * @port1: port num of the port
5505 * Return: The connect type of the port if successful. Or
5506 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5508 enum usb_port_connect_type
5509 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5511 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5514 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5516 return hub->ports[port1 - 1]->connect_type;
5519 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5520 struct usb_hub_descriptor *desc)
5522 enum usb_port_connect_type connect_type;
5525 if (!hub_is_superspeed(hdev)) {
5526 for (i = 1; i <= hdev->maxchild; i++) {
5527 connect_type = usb_get_hub_port_connect_type(hdev, i);
5529 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5530 u8 mask = 1 << (i%8);
5532 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5533 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5535 desc->u.hs.DeviceRemovable[i/8] |= mask;
5540 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5542 for (i = 1; i <= hdev->maxchild; i++) {
5543 connect_type = usb_get_hub_port_connect_type(hdev, i);
5545 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5548 if (!(port_removable & mask)) {
5549 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5551 port_removable |= mask;
5556 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5562 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5563 * @hdev: USB device belonging to the usb hub
5564 * @port1: port num of the port
5566 * Return: Port's acpi handle if successful, %NULL if params are
5569 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5572 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5577 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);