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 /* caller has locked the hub device */
1280 static int hub_pre_reset(struct usb_interface *intf)
1282 struct usb_hub *hub = usb_get_intfdata(intf);
1284 hub_quiesce(hub, HUB_PRE_RESET);
1288 /* caller has locked the hub device */
1289 static int hub_post_reset(struct usb_interface *intf)
1291 struct usb_hub *hub = usb_get_intfdata(intf);
1293 hub_activate(hub, HUB_POST_RESET);
1297 static int hub_configure(struct usb_hub *hub,
1298 struct usb_endpoint_descriptor *endpoint)
1300 struct usb_hcd *hcd;
1301 struct usb_device *hdev = hub->hdev;
1302 struct device *hub_dev = hub->intfdev;
1303 u16 hubstatus, hubchange;
1304 u16 wHubCharacteristics;
1307 char *message = "out of memory";
1311 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1317 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1322 mutex_init(&hub->status_mutex);
1324 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1325 if (!hub->descriptor) {
1330 /* Request the entire hub descriptor.
1331 * hub->descriptor can handle USB_MAXCHILDREN ports,
1332 * but the hub can/will return fewer bytes here.
1334 ret = get_hub_descriptor(hdev, hub->descriptor);
1336 message = "can't read hub descriptor";
1338 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1339 message = "hub has too many ports!";
1342 } else if (hub->descriptor->bNbrPorts == 0) {
1343 message = "hub doesn't have any ports!";
1348 hdev->maxchild = hub->descriptor->bNbrPorts;
1349 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1350 (hdev->maxchild == 1) ? "" : "s");
1352 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1359 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1360 if (hub_is_superspeed(hdev)) {
1368 /* FIXME for USB 3.0, skip for now */
1369 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1370 !(hub_is_superspeed(hdev))) {
1372 char portstr[USB_MAXCHILDREN + 1];
1374 for (i = 0; i < hdev->maxchild; i++)
1375 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1376 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1378 portstr[hdev->maxchild] = 0;
1379 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1381 dev_dbg(hub_dev, "standalone hub\n");
1383 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1384 case HUB_CHAR_COMMON_LPSM:
1385 dev_dbg(hub_dev, "ganged power switching\n");
1387 case HUB_CHAR_INDV_PORT_LPSM:
1388 dev_dbg(hub_dev, "individual port power switching\n");
1390 case HUB_CHAR_NO_LPSM:
1392 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1396 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1397 case HUB_CHAR_COMMON_OCPM:
1398 dev_dbg(hub_dev, "global over-current protection\n");
1400 case HUB_CHAR_INDV_PORT_OCPM:
1401 dev_dbg(hub_dev, "individual port over-current protection\n");
1403 case HUB_CHAR_NO_OCPM:
1405 dev_dbg(hub_dev, "no over-current protection\n");
1409 spin_lock_init (&hub->tt.lock);
1410 INIT_LIST_HEAD (&hub->tt.clear_list);
1411 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1412 switch (hdev->descriptor.bDeviceProtocol) {
1415 case USB_HUB_PR_HS_SINGLE_TT:
1416 dev_dbg(hub_dev, "Single TT\n");
1419 case USB_HUB_PR_HS_MULTI_TT:
1420 ret = usb_set_interface(hdev, 0, 1);
1422 dev_dbg(hub_dev, "TT per port\n");
1425 dev_err(hub_dev, "Using single TT (err %d)\n",
1430 /* USB 3.0 hubs don't have a TT */
1433 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1434 hdev->descriptor.bDeviceProtocol);
1438 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1439 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1440 case HUB_TTTT_8_BITS:
1441 if (hdev->descriptor.bDeviceProtocol != 0) {
1442 hub->tt.think_time = 666;
1443 dev_dbg(hub_dev, "TT requires at most %d "
1444 "FS bit times (%d ns)\n",
1445 8, hub->tt.think_time);
1448 case HUB_TTTT_16_BITS:
1449 hub->tt.think_time = 666 * 2;
1450 dev_dbg(hub_dev, "TT requires at most %d "
1451 "FS bit times (%d ns)\n",
1452 16, hub->tt.think_time);
1454 case HUB_TTTT_24_BITS:
1455 hub->tt.think_time = 666 * 3;
1456 dev_dbg(hub_dev, "TT requires at most %d "
1457 "FS bit times (%d ns)\n",
1458 24, hub->tt.think_time);
1460 case HUB_TTTT_32_BITS:
1461 hub->tt.think_time = 666 * 4;
1462 dev_dbg(hub_dev, "TT requires at most %d "
1463 "FS bit times (%d ns)\n",
1464 32, hub->tt.think_time);
1468 /* probe() zeroes hub->indicator[] */
1469 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1470 hub->has_indicators = 1;
1471 dev_dbg(hub_dev, "Port indicators are supported\n");
1474 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1475 hub->descriptor->bPwrOn2PwrGood * 2);
1477 /* power budgeting mostly matters with bus-powered hubs,
1478 * and battery-powered root hubs (may provide just 8 mA).
1480 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1482 message = "can't get hub status";
1485 hcd = bus_to_hcd(hdev->bus);
1486 if (hdev == hdev->bus->root_hub) {
1487 if (hcd->power_budget > 0)
1488 hdev->bus_mA = hcd->power_budget;
1490 hdev->bus_mA = full_load * hdev->maxchild;
1491 if (hdev->bus_mA >= full_load)
1492 hub->mA_per_port = full_load;
1494 hub->mA_per_port = hdev->bus_mA;
1495 hub->limited_power = 1;
1497 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1498 int remaining = hdev->bus_mA -
1499 hub->descriptor->bHubContrCurrent;
1501 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1502 hub->descriptor->bHubContrCurrent);
1503 hub->limited_power = 1;
1505 if (remaining < hdev->maxchild * unit_load)
1507 "insufficient power available "
1508 "to use all downstream ports\n");
1509 hub->mA_per_port = unit_load; /* 7.2.1 */
1511 } else { /* Self-powered external hub */
1512 /* FIXME: What about battery-powered external hubs that
1513 * provide less current per port? */
1514 hub->mA_per_port = full_load;
1516 if (hub->mA_per_port < full_load)
1517 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1520 /* Update the HCD's internal representation of this hub before khubd
1521 * starts getting port status changes for devices under the hub.
1523 if (hcd->driver->update_hub_device) {
1524 ret = hcd->driver->update_hub_device(hcd, hdev,
1525 &hub->tt, GFP_KERNEL);
1527 message = "can't update HCD hub info";
1532 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1534 message = "can't get hub status";
1538 /* local power status reports aren't always correct */
1539 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1540 dev_dbg(hub_dev, "local power source is %s\n",
1541 (hubstatus & HUB_STATUS_LOCAL_POWER)
1542 ? "lost (inactive)" : "good");
1544 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1545 dev_dbg(hub_dev, "%sover-current condition exists\n",
1546 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1548 /* set up the interrupt endpoint
1549 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1550 * bytes as USB2.0[11.12.3] says because some hubs are known
1551 * to send more data (and thus cause overflow). For root hubs,
1552 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1553 * to be big enough for at least USB_MAXCHILDREN ports. */
1554 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1555 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1557 if (maxp > sizeof(*hub->buffer))
1558 maxp = sizeof(*hub->buffer);
1560 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1566 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1567 hub, endpoint->bInterval);
1569 /* maybe cycle the hub leds */
1570 if (hub->has_indicators && blinkenlights)
1571 hub->indicator[0] = INDICATOR_CYCLE;
1573 for (i = 0; i < hdev->maxchild; i++) {
1574 ret = usb_hub_create_port_device(hub, i + 1);
1576 dev_err(hub->intfdev,
1577 "couldn't create port%d device.\n", i + 1);
1579 goto fail_keep_maxchild;
1583 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1585 hub_activate(hub, HUB_INIT);
1591 dev_err (hub_dev, "config failed, %s (err %d)\n",
1593 /* hub_disconnect() frees urb and descriptor */
1597 static void hub_release(struct kref *kref)
1599 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1601 usb_put_intf(to_usb_interface(hub->intfdev));
1605 static unsigned highspeed_hubs;
1607 static void hub_disconnect(struct usb_interface *intf)
1609 struct usb_hub *hub = usb_get_intfdata(intf);
1610 struct usb_device *hdev = interface_to_usbdev(intf);
1613 /* Take the hub off the event list and don't let it be added again */
1614 spin_lock_irq(&hub_event_lock);
1615 if (!list_empty(&hub->event_list)) {
1616 list_del_init(&hub->event_list);
1617 usb_autopm_put_interface_no_suspend(intf);
1619 hub->disconnected = 1;
1620 spin_unlock_irq(&hub_event_lock);
1622 /* Disconnect all children and quiesce the hub */
1624 hub_quiesce(hub, HUB_DISCONNECT);
1626 /* Avoid races with recursively_mark_NOTATTACHED() */
1627 spin_lock_irq(&device_state_lock);
1628 port1 = hdev->maxchild;
1630 usb_set_intfdata(intf, NULL);
1631 spin_unlock_irq(&device_state_lock);
1633 for (; port1 > 0; --port1)
1634 usb_hub_remove_port_device(hub, port1);
1636 if (hub->hdev->speed == USB_SPEED_HIGH)
1639 usb_free_urb(hub->urb);
1641 kfree(hub->descriptor);
1645 pm_suspend_ignore_children(&intf->dev, false);
1646 kref_put(&hub->kref, hub_release);
1649 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1651 struct usb_host_interface *desc;
1652 struct usb_endpoint_descriptor *endpoint;
1653 struct usb_device *hdev;
1654 struct usb_hub *hub;
1656 desc = intf->cur_altsetting;
1657 hdev = interface_to_usbdev(intf);
1660 * Set default autosuspend delay as 0 to speedup bus suspend,
1661 * based on the below considerations:
1663 * - Unlike other drivers, the hub driver does not rely on the
1664 * autosuspend delay to provide enough time to handle a wakeup
1665 * event, and the submitted status URB is just to check future
1666 * change on hub downstream ports, so it is safe to do it.
1668 * - The patch might cause one or more auto supend/resume for
1669 * below very rare devices when they are plugged into hub
1672 * devices having trouble initializing, and disconnect
1673 * themselves from the bus and then reconnect a second
1676 * devices just for downloading firmware, and disconnects
1677 * themselves after completing it
1679 * For these quite rare devices, their drivers may change the
1680 * autosuspend delay of their parent hub in the probe() to one
1681 * appropriate value to avoid the subtle problem if someone
1684 * - The patch may cause one or more auto suspend/resume on
1685 * hub during running 'lsusb', but it is probably too
1686 * infrequent to worry about.
1688 * - Change autosuspend delay of hub can avoid unnecessary auto
1689 * suspend timer for hub, also may decrease power consumption
1692 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1694 /* Hubs have proper suspend/resume support. */
1695 usb_enable_autosuspend(hdev);
1697 if (hdev->level == MAX_TOPO_LEVEL) {
1699 "Unsupported bus topology: hub nested too deep\n");
1703 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1705 dev_warn(&intf->dev, "ignoring external hub\n");
1710 /* Some hubs have a subclass of 1, which AFAICT according to the */
1711 /* specs is not defined, but it works */
1712 if ((desc->desc.bInterfaceSubClass != 0) &&
1713 (desc->desc.bInterfaceSubClass != 1)) {
1715 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1719 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1720 if (desc->desc.bNumEndpoints != 1)
1721 goto descriptor_error;
1723 endpoint = &desc->endpoint[0].desc;
1725 /* If it's not an interrupt in endpoint, we'd better punt! */
1726 if (!usb_endpoint_is_int_in(endpoint))
1727 goto descriptor_error;
1729 /* We found a hub */
1730 dev_info (&intf->dev, "USB hub found\n");
1732 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1734 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1738 kref_init(&hub->kref);
1739 INIT_LIST_HEAD(&hub->event_list);
1740 hub->intfdev = &intf->dev;
1742 INIT_DELAYED_WORK(&hub->leds, led_work);
1743 INIT_DELAYED_WORK(&hub->init_work, NULL);
1746 usb_set_intfdata (intf, hub);
1747 intf->needs_remote_wakeup = 1;
1748 pm_suspend_ignore_children(&intf->dev, true);
1750 if (hdev->speed == USB_SPEED_HIGH)
1753 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1754 hub->quirk_check_port_auto_suspend = 1;
1756 if (hub_configure(hub, endpoint) >= 0)
1759 hub_disconnect (intf);
1764 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1766 struct usb_device *hdev = interface_to_usbdev (intf);
1767 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1769 /* assert ifno == 0 (part of hub spec) */
1771 case USBDEVFS_HUB_PORTINFO: {
1772 struct usbdevfs_hub_portinfo *info = user_data;
1775 spin_lock_irq(&device_state_lock);
1776 if (hdev->devnum <= 0)
1779 info->nports = hdev->maxchild;
1780 for (i = 0; i < info->nports; i++) {
1781 if (hub->ports[i]->child == NULL)
1785 hub->ports[i]->child->devnum;
1788 spin_unlock_irq(&device_state_lock);
1790 return info->nports + 1;
1799 * Allow user programs to claim ports on a hub. When a device is attached
1800 * to one of these "claimed" ports, the program will "own" the device.
1802 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1803 struct usb_dev_state ***ppowner)
1805 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1807 if (hdev->state == USB_STATE_NOTATTACHED)
1809 if (port1 == 0 || port1 > hdev->maxchild)
1812 /* Devices not managed by the hub driver
1813 * will always have maxchild equal to 0.
1815 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1819 /* In the following three functions, the caller must hold hdev's lock */
1820 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1821 struct usb_dev_state *owner)
1824 struct usb_dev_state **powner;
1826 rc = find_port_owner(hdev, port1, &powner);
1834 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1836 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1837 struct usb_dev_state *owner)
1840 struct usb_dev_state **powner;
1842 rc = find_port_owner(hdev, port1, &powner);
1845 if (*powner != owner)
1850 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1852 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1854 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1857 for (n = 0; n < hdev->maxchild; n++) {
1858 if (hub->ports[n]->port_owner == owner)
1859 hub->ports[n]->port_owner = NULL;
1864 /* The caller must hold udev's lock */
1865 bool usb_device_is_owned(struct usb_device *udev)
1867 struct usb_hub *hub;
1869 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1871 hub = usb_hub_to_struct_hub(udev->parent);
1872 return !!hub->ports[udev->portnum - 1]->port_owner;
1875 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1877 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1880 for (i = 0; i < udev->maxchild; ++i) {
1881 if (hub->ports[i]->child)
1882 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1884 if (udev->state == USB_STATE_SUSPENDED)
1885 udev->active_duration -= jiffies;
1886 udev->state = USB_STATE_NOTATTACHED;
1890 * usb_set_device_state - change a device's current state (usbcore, hcds)
1891 * @udev: pointer to device whose state should be changed
1892 * @new_state: new state value to be stored
1894 * udev->state is _not_ fully protected by the device lock. Although
1895 * most transitions are made only while holding the lock, the state can
1896 * can change to USB_STATE_NOTATTACHED at almost any time. This
1897 * is so that devices can be marked as disconnected as soon as possible,
1898 * without having to wait for any semaphores to be released. As a result,
1899 * all changes to any device's state must be protected by the
1900 * device_state_lock spinlock.
1902 * Once a device has been added to the device tree, all changes to its state
1903 * should be made using this routine. The state should _not_ be set directly.
1905 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1906 * Otherwise udev->state is set to new_state, and if new_state is
1907 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1908 * to USB_STATE_NOTATTACHED.
1910 void usb_set_device_state(struct usb_device *udev,
1911 enum usb_device_state new_state)
1913 unsigned long flags;
1916 spin_lock_irqsave(&device_state_lock, flags);
1917 if (udev->state == USB_STATE_NOTATTACHED)
1919 else if (new_state != USB_STATE_NOTATTACHED) {
1921 /* root hub wakeup capabilities are managed out-of-band
1922 * and may involve silicon errata ... ignore them here.
1925 if (udev->state == USB_STATE_SUSPENDED
1926 || new_state == USB_STATE_SUSPENDED)
1927 ; /* No change to wakeup settings */
1928 else if (new_state == USB_STATE_CONFIGURED)
1929 wakeup = udev->actconfig->desc.bmAttributes
1930 & USB_CONFIG_ATT_WAKEUP;
1934 if (udev->state == USB_STATE_SUSPENDED &&
1935 new_state != USB_STATE_SUSPENDED)
1936 udev->active_duration -= jiffies;
1937 else if (new_state == USB_STATE_SUSPENDED &&
1938 udev->state != USB_STATE_SUSPENDED)
1939 udev->active_duration += jiffies;
1940 udev->state = new_state;
1942 recursively_mark_NOTATTACHED(udev);
1943 spin_unlock_irqrestore(&device_state_lock, flags);
1945 device_set_wakeup_capable(&udev->dev, wakeup);
1947 EXPORT_SYMBOL_GPL(usb_set_device_state);
1950 * Choose a device number.
1952 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1953 * USB-2.0 buses they are also used as device addresses, however on
1954 * USB-3.0 buses the address is assigned by the controller hardware
1955 * and it usually is not the same as the device number.
1957 * WUSB devices are simple: they have no hubs behind, so the mapping
1958 * device <-> virtual port number becomes 1:1. Why? to simplify the
1959 * life of the device connection logic in
1960 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1961 * handshake we need to assign a temporary address in the unauthorized
1962 * space. For simplicity we use the first virtual port number found to
1963 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1964 * and that becomes it's address [X < 128] or its unauthorized address
1967 * We add 1 as an offset to the one-based USB-stack port number
1968 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1969 * 0 is reserved by USB for default address; (b) Linux's USB stack
1970 * uses always #1 for the root hub of the controller. So USB stack's
1971 * port #1, which is wusb virtual-port #0 has address #2.
1973 * Devices connected under xHCI are not as simple. The host controller
1974 * supports virtualization, so the hardware assigns device addresses and
1975 * the HCD must setup data structures before issuing a set address
1976 * command to the hardware.
1978 static void choose_devnum(struct usb_device *udev)
1981 struct usb_bus *bus = udev->bus;
1983 /* If khubd ever becomes multithreaded, this will need a lock */
1985 devnum = udev->portnum + 1;
1986 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1988 /* Try to allocate the next devnum beginning at
1989 * bus->devnum_next. */
1990 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1993 devnum = find_next_zero_bit(bus->devmap.devicemap,
1995 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
1998 set_bit(devnum, bus->devmap.devicemap);
1999 udev->devnum = devnum;
2003 static void release_devnum(struct usb_device *udev)
2005 if (udev->devnum > 0) {
2006 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2011 static void update_devnum(struct usb_device *udev, int devnum)
2013 /* The address for a WUSB device is managed by wusbcore. */
2015 udev->devnum = devnum;
2018 static void hub_free_dev(struct usb_device *udev)
2020 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2022 /* Root hubs aren't real devices, so don't free HCD resources */
2023 if (hcd->driver->free_dev && udev->parent)
2024 hcd->driver->free_dev(hcd, udev);
2028 * usb_disconnect - disconnect a device (usbcore-internal)
2029 * @pdev: pointer to device being disconnected
2030 * Context: !in_interrupt ()
2032 * Something got disconnected. Get rid of it and all of its children.
2034 * If *pdev is a normal device then the parent hub must already be locked.
2035 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2036 * which protects the set of root hubs as well as the list of buses.
2038 * Only hub drivers (including virtual root hub drivers for host
2039 * controllers) should ever call this.
2041 * This call is synchronous, and may not be used in an interrupt context.
2043 void usb_disconnect(struct usb_device **pdev)
2045 struct usb_device *udev = *pdev;
2046 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2049 /* mark the device as inactive, so any further urb submissions for
2050 * this device (and any of its children) will fail immediately.
2051 * this quiesces everything except pending urbs.
2053 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2054 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2057 usb_lock_device(udev);
2059 /* Free up all the children before we remove this device */
2060 for (i = 0; i < udev->maxchild; i++) {
2061 if (hub->ports[i]->child)
2062 usb_disconnect(&hub->ports[i]->child);
2065 /* deallocate hcd/hardware state ... nuking all pending urbs and
2066 * cleaning up all state associated with the current configuration
2067 * so that the hardware is now fully quiesced.
2069 dev_dbg (&udev->dev, "unregistering device\n");
2070 usb_disable_device(udev, 0);
2071 usb_hcd_synchronize_unlinks(udev);
2074 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2075 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2077 sysfs_remove_link(&udev->dev.kobj, "port");
2078 sysfs_remove_link(&port_dev->dev.kobj, "device");
2080 if (!port_dev->did_runtime_put)
2081 pm_runtime_put(&port_dev->dev);
2083 port_dev->did_runtime_put = false;
2086 usb_remove_ep_devs(&udev->ep0);
2087 usb_unlock_device(udev);
2089 /* Unregister the device. The device driver is responsible
2090 * for de-configuring the device and invoking the remove-device
2091 * notifier chain (used by usbfs and possibly others).
2093 device_del(&udev->dev);
2095 /* Free the device number and delete the parent's children[]
2096 * (or root_hub) pointer.
2098 release_devnum(udev);
2100 /* Avoid races with recursively_mark_NOTATTACHED() */
2101 spin_lock_irq(&device_state_lock);
2103 spin_unlock_irq(&device_state_lock);
2107 put_device(&udev->dev);
2110 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2111 static void show_string(struct usb_device *udev, char *id, char *string)
2115 dev_info(&udev->dev, "%s: %s\n", id, string);
2118 static void announce_device(struct usb_device *udev)
2120 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2121 le16_to_cpu(udev->descriptor.idVendor),
2122 le16_to_cpu(udev->descriptor.idProduct));
2123 dev_info(&udev->dev,
2124 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2125 udev->descriptor.iManufacturer,
2126 udev->descriptor.iProduct,
2127 udev->descriptor.iSerialNumber);
2128 show_string(udev, "Product", udev->product);
2129 show_string(udev, "Manufacturer", udev->manufacturer);
2130 show_string(udev, "SerialNumber", udev->serial);
2133 static inline void announce_device(struct usb_device *udev) { }
2136 #ifdef CONFIG_USB_OTG
2137 #include "otg_whitelist.h"
2141 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2142 * @udev: newly addressed device (in ADDRESS state)
2144 * Finish enumeration for On-The-Go devices
2146 * Return: 0 if successful. A negative error code otherwise.
2148 static int usb_enumerate_device_otg(struct usb_device *udev)
2152 #ifdef CONFIG_USB_OTG
2154 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2155 * to wake us after we've powered off VBUS; and HNP, switching roles
2156 * "host" to "peripheral". The OTG descriptor helps figure this out.
2158 if (!udev->bus->is_b_host
2160 && udev->parent == udev->bus->root_hub) {
2161 struct usb_otg_descriptor *desc = NULL;
2162 struct usb_bus *bus = udev->bus;
2164 /* descriptor may appear anywhere in config */
2165 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2166 le16_to_cpu(udev->config[0].desc.wTotalLength),
2167 USB_DT_OTG, (void **) &desc) == 0) {
2168 if (desc->bmAttributes & USB_OTG_HNP) {
2169 unsigned port1 = udev->portnum;
2171 dev_info(&udev->dev,
2172 "Dual-Role OTG device on %sHNP port\n",
2173 (port1 == bus->otg_port)
2176 /* enable HNP before suspend, it's simpler */
2177 if (port1 == bus->otg_port)
2178 bus->b_hnp_enable = 1;
2179 err = usb_control_msg(udev,
2180 usb_sndctrlpipe(udev, 0),
2181 USB_REQ_SET_FEATURE, 0,
2183 ? USB_DEVICE_B_HNP_ENABLE
2184 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2185 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2187 /* OTG MESSAGE: report errors here,
2188 * customize to match your product.
2190 dev_info(&udev->dev,
2191 "can't set HNP mode: %d\n",
2193 bus->b_hnp_enable = 0;
2199 if (!is_targeted(udev)) {
2201 /* Maybe it can talk to us, though we can't talk to it.
2202 * (Includes HNP test device.)
2204 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2205 err = usb_port_suspend(udev, PMSG_SUSPEND);
2207 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2219 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2220 * @udev: newly addressed device (in ADDRESS state)
2222 * This is only called by usb_new_device() and usb_authorize_device()
2223 * and FIXME -- all comments that apply to them apply here wrt to
2226 * If the device is WUSB and not authorized, we don't attempt to read
2227 * the string descriptors, as they will be errored out by the device
2228 * until it has been authorized.
2230 * Return: 0 if successful. A negative error code otherwise.
2232 static int usb_enumerate_device(struct usb_device *udev)
2236 if (udev->config == NULL) {
2237 err = usb_get_configuration(udev);
2240 dev_err(&udev->dev, "can't read configurations, error %d\n",
2246 /* read the standard strings and cache them if present */
2247 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2248 udev->manufacturer = usb_cache_string(udev,
2249 udev->descriptor.iManufacturer);
2250 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2252 err = usb_enumerate_device_otg(udev);
2256 usb_detect_interface_quirks(udev);
2261 static void set_usb_port_removable(struct usb_device *udev)
2263 struct usb_device *hdev = udev->parent;
2264 struct usb_hub *hub;
2265 u8 port = udev->portnum;
2266 u16 wHubCharacteristics;
2267 bool removable = true;
2272 hub = usb_hub_to_struct_hub(udev->parent);
2274 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2276 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2279 if (hub_is_superspeed(hdev)) {
2280 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2284 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2289 udev->removable = USB_DEVICE_REMOVABLE;
2291 udev->removable = USB_DEVICE_FIXED;
2295 * usb_new_device - perform initial device setup (usbcore-internal)
2296 * @udev: newly addressed device (in ADDRESS state)
2298 * This is called with devices which have been detected but not fully
2299 * enumerated. The device descriptor is available, but not descriptors
2300 * for any device configuration. The caller must have locked either
2301 * the parent hub (if udev is a normal device) or else the
2302 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2303 * udev has already been installed, but udev is not yet visible through
2304 * sysfs or other filesystem code.
2306 * This call is synchronous, and may not be used in an interrupt context.
2308 * Only the hub driver or root-hub registrar should ever call this.
2310 * Return: Whether the device is configured properly or not. Zero if the
2311 * interface was registered with the driver core; else a negative errno
2315 int usb_new_device(struct usb_device *udev)
2320 /* Initialize non-root-hub device wakeup to disabled;
2321 * device (un)configuration controls wakeup capable
2322 * sysfs power/wakeup controls wakeup enabled/disabled
2324 device_init_wakeup(&udev->dev, 0);
2327 /* Tell the runtime-PM framework the device is active */
2328 pm_runtime_set_active(&udev->dev);
2329 pm_runtime_get_noresume(&udev->dev);
2330 pm_runtime_use_autosuspend(&udev->dev);
2331 pm_runtime_enable(&udev->dev);
2333 /* By default, forbid autosuspend for all devices. It will be
2334 * allowed for hubs during binding.
2336 usb_disable_autosuspend(udev);
2338 err = usb_enumerate_device(udev); /* Read descriptors */
2341 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2342 udev->devnum, udev->bus->busnum,
2343 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2344 /* export the usbdev device-node for libusb */
2345 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2346 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2348 /* Tell the world! */
2349 announce_device(udev);
2352 add_device_randomness(udev->serial, strlen(udev->serial));
2354 add_device_randomness(udev->product, strlen(udev->product));
2355 if (udev->manufacturer)
2356 add_device_randomness(udev->manufacturer,
2357 strlen(udev->manufacturer));
2359 device_enable_async_suspend(&udev->dev);
2362 * check whether the hub marks this port as non-removable. Do it
2363 * now so that platform-specific data can override it in
2367 set_usb_port_removable(udev);
2369 /* Register the device. The device driver is responsible
2370 * for configuring the device and invoking the add-device
2371 * notifier chain (used by usbfs and possibly others).
2373 err = device_add(&udev->dev);
2375 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2379 /* Create link files between child device and usb port device. */
2381 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2382 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2384 err = sysfs_create_link(&udev->dev.kobj,
2385 &port_dev->dev.kobj, "port");
2389 err = sysfs_create_link(&port_dev->dev.kobj,
2390 &udev->dev.kobj, "device");
2392 sysfs_remove_link(&udev->dev.kobj, "port");
2396 pm_runtime_get_sync(&port_dev->dev);
2399 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2400 usb_mark_last_busy(udev);
2401 pm_runtime_put_sync_autosuspend(&udev->dev);
2405 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2406 pm_runtime_disable(&udev->dev);
2407 pm_runtime_set_suspended(&udev->dev);
2413 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2414 * @usb_dev: USB device
2416 * Move the USB device to a very basic state where interfaces are disabled
2417 * and the device is in fact unconfigured and unusable.
2419 * We share a lock (that we have) with device_del(), so we need to
2424 int usb_deauthorize_device(struct usb_device *usb_dev)
2426 usb_lock_device(usb_dev);
2427 if (usb_dev->authorized == 0)
2428 goto out_unauthorized;
2430 usb_dev->authorized = 0;
2431 usb_set_configuration(usb_dev, -1);
2434 usb_unlock_device(usb_dev);
2439 int usb_authorize_device(struct usb_device *usb_dev)
2443 usb_lock_device(usb_dev);
2444 if (usb_dev->authorized == 1)
2445 goto out_authorized;
2447 result = usb_autoresume_device(usb_dev);
2449 dev_err(&usb_dev->dev,
2450 "can't autoresume for authorization: %d\n", result);
2451 goto error_autoresume;
2453 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2455 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2456 "authorization: %d\n", result);
2457 goto error_device_descriptor;
2460 usb_dev->authorized = 1;
2461 /* Choose and set the configuration. This registers the interfaces
2462 * with the driver core and lets interface drivers bind to them.
2464 c = usb_choose_configuration(usb_dev);
2466 result = usb_set_configuration(usb_dev, c);
2468 dev_err(&usb_dev->dev,
2469 "can't set config #%d, error %d\n", c, result);
2470 /* This need not be fatal. The user can try to
2471 * set other configurations. */
2474 dev_info(&usb_dev->dev, "authorized to connect\n");
2476 error_device_descriptor:
2477 usb_autosuspend_device(usb_dev);
2480 usb_unlock_device(usb_dev); /* complements locktree */
2485 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2486 static unsigned hub_is_wusb(struct usb_hub *hub)
2488 struct usb_hcd *hcd;
2489 if (hub->hdev->parent != NULL) /* not a root hub? */
2491 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2492 return hcd->wireless;
2496 #define PORT_RESET_TRIES 5
2497 #define SET_ADDRESS_TRIES 2
2498 #define GET_DESCRIPTOR_TRIES 2
2499 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2500 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2502 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2503 #define HUB_SHORT_RESET_TIME 10
2504 #define HUB_BH_RESET_TIME 50
2505 #define HUB_LONG_RESET_TIME 200
2506 #define HUB_RESET_TIMEOUT 800
2509 * "New scheme" enumeration causes an extra state transition to be
2510 * exposed to an xhci host and causes USB3 devices to receive control
2511 * commands in the default state. This has been seen to cause
2512 * enumeration failures, so disable this enumeration scheme for USB3
2515 static bool use_new_scheme(struct usb_device *udev, int retry)
2517 if (udev->speed == USB_SPEED_SUPER)
2520 return USE_NEW_SCHEME(retry);
2523 static int hub_port_reset(struct usb_hub *hub, int port1,
2524 struct usb_device *udev, unsigned int delay, bool warm);
2526 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2527 * Port worm reset is required to recover
2529 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2531 return hub_is_superspeed(hub->hdev) &&
2532 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2533 USB_SS_PORT_LS_SS_INACTIVE) ||
2534 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2535 USB_SS_PORT_LS_COMP_MOD)) ;
2538 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2539 struct usb_device *udev, unsigned int delay, bool warm)
2541 int delay_time, ret;
2545 for (delay_time = 0;
2546 delay_time < HUB_RESET_TIMEOUT;
2547 delay_time += delay) {
2548 /* wait to give the device a chance to reset */
2551 /* read and decode port status */
2552 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2556 /* The port state is unknown until the reset completes. */
2557 if (!(portstatus & USB_PORT_STAT_RESET))
2560 /* switch to the long delay after two short delay failures */
2561 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2562 delay = HUB_LONG_RESET_TIME;
2564 dev_dbg (hub->intfdev,
2565 "port %d not %sreset yet, waiting %dms\n",
2566 port1, warm ? "warm " : "", delay);
2569 if ((portstatus & USB_PORT_STAT_RESET))
2572 if (hub_port_warm_reset_required(hub, portstatus))
2575 /* Device went away? */
2576 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2579 /* bomb out completely if the connection bounced. A USB 3.0
2580 * connection may bounce if multiple warm resets were issued,
2581 * but the device may have successfully re-connected. Ignore it.
2583 if (!hub_is_superspeed(hub->hdev) &&
2584 (portchange & USB_PORT_STAT_C_CONNECTION))
2587 if (!(portstatus & USB_PORT_STAT_ENABLE))
2593 if (hub_is_wusb(hub))
2594 udev->speed = USB_SPEED_WIRELESS;
2595 else if (hub_is_superspeed(hub->hdev))
2596 udev->speed = USB_SPEED_SUPER;
2597 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2598 udev->speed = USB_SPEED_HIGH;
2599 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2600 udev->speed = USB_SPEED_LOW;
2602 udev->speed = USB_SPEED_FULL;
2606 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2607 struct usb_device *udev, int *status)
2611 /* TRSTRCY = 10 ms; plus some extra */
2614 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2616 update_devnum(udev, 0);
2617 /* The xHC may think the device is already reset,
2618 * so ignore the status.
2620 if (hcd->driver->reset_device)
2621 hcd->driver->reset_device(hcd, udev);
2626 usb_clear_port_feature(hub->hdev,
2627 port1, USB_PORT_FEAT_C_RESET);
2628 if (hub_is_superspeed(hub->hdev)) {
2629 usb_clear_port_feature(hub->hdev, port1,
2630 USB_PORT_FEAT_C_BH_PORT_RESET);
2631 usb_clear_port_feature(hub->hdev, port1,
2632 USB_PORT_FEAT_C_PORT_LINK_STATE);
2633 usb_clear_port_feature(hub->hdev, port1,
2634 USB_PORT_FEAT_C_CONNECTION);
2637 usb_set_device_state(udev, *status
2638 ? USB_STATE_NOTATTACHED
2639 : USB_STATE_DEFAULT);
2644 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2645 static int hub_port_reset(struct usb_hub *hub, int port1,
2646 struct usb_device *udev, unsigned int delay, bool warm)
2649 u16 portchange, portstatus;
2651 if (!hub_is_superspeed(hub->hdev)) {
2653 dev_err(hub->intfdev, "only USB3 hub support "
2657 /* Block EHCI CF initialization during the port reset.
2658 * Some companion controllers don't like it when they mix.
2660 down_read(&ehci_cf_port_reset_rwsem);
2663 * If the caller hasn't explicitly requested a warm reset,
2664 * double check and see if one is needed.
2666 status = hub_port_status(hub, port1,
2667 &portstatus, &portchange);
2671 if (hub_port_warm_reset_required(hub, portstatus))
2675 /* Reset the port */
2676 for (i = 0; i < PORT_RESET_TRIES; i++) {
2677 status = set_port_feature(hub->hdev, port1, (warm ?
2678 USB_PORT_FEAT_BH_PORT_RESET :
2679 USB_PORT_FEAT_RESET));
2680 if (status == -ENODEV) {
2681 ; /* The hub is gone */
2682 } else if (status) {
2683 dev_err(hub->intfdev,
2684 "cannot %sreset port %d (err = %d)\n",
2685 warm ? "warm " : "", port1, status);
2687 status = hub_port_wait_reset(hub, port1, udev, delay,
2689 if (status && status != -ENOTCONN && status != -ENODEV)
2690 dev_dbg(hub->intfdev,
2691 "port_wait_reset: err = %d\n",
2695 /* Check for disconnect or reset */
2696 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2697 hub_port_finish_reset(hub, port1, udev, &status);
2699 if (!hub_is_superspeed(hub->hdev))
2703 * If a USB 3.0 device migrates from reset to an error
2704 * state, re-issue the warm reset.
2706 if (hub_port_status(hub, port1,
2707 &portstatus, &portchange) < 0)
2710 if (!hub_port_warm_reset_required(hub, portstatus))
2714 * If the port is in SS.Inactive or Compliance Mode, the
2715 * hot or warm reset failed. Try another warm reset.
2718 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2724 dev_dbg (hub->intfdev,
2725 "port %d not enabled, trying %sreset again...\n",
2726 port1, warm ? "warm " : "");
2727 delay = HUB_LONG_RESET_TIME;
2730 dev_err (hub->intfdev,
2731 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2735 if (!hub_is_superspeed(hub->hdev))
2736 up_read(&ehci_cf_port_reset_rwsem);
2741 /* Check if a port is power on */
2742 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2746 if (hub_is_superspeed(hub->hdev)) {
2747 if (portstatus & USB_SS_PORT_STAT_POWER)
2750 if (portstatus & USB_PORT_STAT_POWER)
2759 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2760 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2764 if (hub_is_superspeed(hub->hdev)) {
2765 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2766 == USB_SS_PORT_LS_U3)
2769 if (portstatus & USB_PORT_STAT_SUSPEND)
2776 /* Determine whether the device on a port is ready for a normal resume,
2777 * is ready for a reset-resume, or should be disconnected.
2779 static int check_port_resume_type(struct usb_device *udev,
2780 struct usb_hub *hub, int port1,
2781 int status, unsigned portchange, unsigned portstatus)
2783 /* Is the device still present? */
2784 if (status || port_is_suspended(hub, portstatus) ||
2785 !port_is_power_on(hub, portstatus) ||
2786 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2791 /* Can't do a normal resume if the port isn't enabled,
2792 * so try a reset-resume instead.
2794 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2795 if (udev->persist_enabled)
2796 udev->reset_resume = 1;
2802 dev_dbg(hub->intfdev,
2803 "port %d status %04x.%04x after resume, %d\n",
2804 port1, portchange, portstatus, status);
2805 } else if (udev->reset_resume) {
2807 /* Late port handoff can set status-change bits */
2808 if (portchange & USB_PORT_STAT_C_CONNECTION)
2809 usb_clear_port_feature(hub->hdev, port1,
2810 USB_PORT_FEAT_C_CONNECTION);
2811 if (portchange & USB_PORT_STAT_C_ENABLE)
2812 usb_clear_port_feature(hub->hdev, port1,
2813 USB_PORT_FEAT_C_ENABLE);
2819 int usb_disable_ltm(struct usb_device *udev)
2821 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2823 /* Check if the roothub and device supports LTM. */
2824 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2825 !usb_device_supports_ltm(udev))
2828 /* Clear Feature LTM Enable can only be sent if the device is
2831 if (!udev->actconfig)
2834 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2835 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2836 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2837 USB_CTRL_SET_TIMEOUT);
2839 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2841 void usb_enable_ltm(struct usb_device *udev)
2843 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2845 /* Check if the roothub and device supports LTM. */
2846 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2847 !usb_device_supports_ltm(udev))
2850 /* Set Feature LTM Enable can only be sent if the device is
2853 if (!udev->actconfig)
2856 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2857 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2858 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2859 USB_CTRL_SET_TIMEOUT);
2861 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2864 * usb_enable_remote_wakeup - enable remote wakeup for a device
2865 * @udev: target device
2867 * For USB-2 devices: Set the device's remote wakeup feature.
2869 * For USB-3 devices: Assume there's only one function on the device and
2870 * enable remote wake for the first interface. FIXME if the interface
2871 * association descriptor shows there's more than one function.
2873 static int usb_enable_remote_wakeup(struct usb_device *udev)
2875 if (udev->speed < USB_SPEED_SUPER)
2876 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2877 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2878 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2879 USB_CTRL_SET_TIMEOUT);
2881 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2882 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2883 USB_INTRF_FUNC_SUSPEND,
2884 USB_INTRF_FUNC_SUSPEND_RW |
2885 USB_INTRF_FUNC_SUSPEND_LP,
2886 NULL, 0, USB_CTRL_SET_TIMEOUT);
2890 * usb_disable_remote_wakeup - disable remote wakeup for a device
2891 * @udev: target device
2893 * For USB-2 devices: Clear the device's remote wakeup feature.
2895 * For USB-3 devices: Assume there's only one function on the device and
2896 * disable remote wake for the first interface. FIXME if the interface
2897 * association descriptor shows there's more than one function.
2899 static int usb_disable_remote_wakeup(struct usb_device *udev)
2901 if (udev->speed < USB_SPEED_SUPER)
2902 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2903 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2904 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2905 USB_CTRL_SET_TIMEOUT);
2907 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2908 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2909 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2910 USB_CTRL_SET_TIMEOUT);
2913 /* Count of wakeup-enabled devices at or below udev */
2914 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2916 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2918 return udev->do_remote_wakeup +
2919 (hub ? hub->wakeup_enabled_descendants : 0);
2923 * usb_port_suspend - suspend a usb device's upstream port
2924 * @udev: device that's no longer in active use, not a root hub
2925 * Context: must be able to sleep; device not locked; pm locks held
2927 * Suspends a USB device that isn't in active use, conserving power.
2928 * Devices may wake out of a suspend, if anything important happens,
2929 * using the remote wakeup mechanism. They may also be taken out of
2930 * suspend by the host, using usb_port_resume(). It's also routine
2931 * to disconnect devices while they are suspended.
2933 * This only affects the USB hardware for a device; its interfaces
2934 * (and, for hubs, child devices) must already have been suspended.
2936 * Selective port suspend reduces power; most suspended devices draw
2937 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2938 * All devices below the suspended port are also suspended.
2940 * Devices leave suspend state when the host wakes them up. Some devices
2941 * also support "remote wakeup", where the device can activate the USB
2942 * tree above them to deliver data, such as a keypress or packet. In
2943 * some cases, this wakes the USB host.
2945 * Suspending OTG devices may trigger HNP, if that's been enabled
2946 * between a pair of dual-role devices. That will change roles, such
2947 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2949 * Devices on USB hub ports have only one "suspend" state, corresponding
2950 * to ACPI D2, "may cause the device to lose some context".
2951 * State transitions include:
2953 * - suspend, resume ... when the VBUS power link stays live
2954 * - suspend, disconnect ... VBUS lost
2956 * Once VBUS drop breaks the circuit, the port it's using has to go through
2957 * normal re-enumeration procedures, starting with enabling VBUS power.
2958 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2959 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2960 * timer, no SRP, no requests through sysfs.
2962 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2963 * suspended until their bus goes into global suspend (i.e., the root
2964 * hub is suspended). Nevertheless, we change @udev->state to
2965 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2966 * upstream port setting is stored in @udev->port_is_suspended.
2968 * Returns 0 on success, else negative errno.
2970 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2972 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2973 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2974 int port1 = udev->portnum;
2976 bool really_suspend = true;
2978 /* enable remote wakeup when appropriate; this lets the device
2979 * wake up the upstream hub (including maybe the root hub).
2981 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2982 * we don't explicitly enable it here.
2984 if (udev->do_remote_wakeup) {
2985 status = usb_enable_remote_wakeup(udev);
2987 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2989 /* bail if autosuspend is requested */
2990 if (PMSG_IS_AUTO(msg))
2995 /* disable USB2 hardware LPM */
2996 if (udev->usb2_hw_lpm_enabled == 1)
2997 usb_set_usb2_hardware_lpm(udev, 0);
2999 if (usb_disable_ltm(udev)) {
3000 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3002 if (PMSG_IS_AUTO(msg))
3005 if (usb_unlocked_disable_lpm(udev)) {
3006 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3008 if (PMSG_IS_AUTO(msg))
3013 if (hub_is_superspeed(hub->hdev))
3014 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3017 * For system suspend, we do not need to enable the suspend feature
3018 * on individual USB-2 ports. The devices will automatically go
3019 * into suspend a few ms after the root hub stops sending packets.
3020 * The USB 2.0 spec calls this "global suspend".
3022 * However, many USB hubs have a bug: They don't relay wakeup requests
3023 * from a downstream port if the port's suspend feature isn't on.
3024 * Therefore we will turn on the suspend feature if udev or any of its
3025 * descendants is enabled for remote wakeup.
3027 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3028 status = set_port_feature(hub->hdev, port1,
3029 USB_PORT_FEAT_SUSPEND);
3031 really_suspend = false;
3035 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3038 /* Try to enable USB3 LPM and LTM again */
3039 usb_unlocked_enable_lpm(udev);
3041 usb_enable_ltm(udev);
3043 /* Try to enable USB2 hardware LPM again */
3044 if (udev->usb2_hw_lpm_capable == 1)
3045 usb_set_usb2_hardware_lpm(udev, 1);
3047 if (udev->do_remote_wakeup)
3048 (void) usb_disable_remote_wakeup(udev);
3051 /* System sleep transitions should never fail */
3052 if (!PMSG_IS_AUTO(msg))
3055 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3056 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3057 udev->do_remote_wakeup);
3058 if (really_suspend) {
3059 udev->port_is_suspended = 1;
3061 /* device has up to 10 msec to fully suspend */
3064 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3067 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3068 pm_runtime_put_sync(&port_dev->dev);
3069 port_dev->did_runtime_put = true;
3072 usb_mark_last_busy(hub->hdev);
3077 * If the USB "suspend" state is in use (rather than "global suspend"),
3078 * many devices will be individually taken out of suspend state using
3079 * special "resume" signaling. This routine kicks in shortly after
3080 * hardware resume signaling is finished, either because of selective
3081 * resume (by host) or remote wakeup (by device) ... now see what changed
3082 * in the tree that's rooted at this device.
3084 * If @udev->reset_resume is set then the device is reset before the
3085 * status check is done.
3087 static int finish_port_resume(struct usb_device *udev)
3092 /* caller owns the udev device lock */
3093 dev_dbg(&udev->dev, "%s\n",
3094 udev->reset_resume ? "finish reset-resume" : "finish resume");
3096 /* usb ch9 identifies four variants of SUSPENDED, based on what
3097 * state the device resumes to. Linux currently won't see the
3098 * first two on the host side; they'd be inside hub_port_init()
3099 * during many timeouts, but khubd can't suspend until later.
3101 usb_set_device_state(udev, udev->actconfig
3102 ? USB_STATE_CONFIGURED
3103 : USB_STATE_ADDRESS);
3105 /* 10.5.4.5 says not to reset a suspended port if the attached
3106 * device is enabled for remote wakeup. Hence the reset
3107 * operation is carried out here, after the port has been
3110 if (udev->reset_resume) {
3112 * If the device morphs or switches modes when it is reset,
3113 * we don't want to perform a reset-resume. We'll fail the
3114 * resume, which will cause a logical disconnect, and then
3115 * the device will be rediscovered.
3118 if (udev->quirks & USB_QUIRK_RESET)
3121 status = usb_reset_and_verify_device(udev);
3124 /* 10.5.4.5 says be sure devices in the tree are still there.
3125 * For now let's assume the device didn't go crazy on resume,
3126 * and device drivers will know about any resume quirks.
3130 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3132 /* If a normal resume failed, try doing a reset-resume */
3133 if (status && !udev->reset_resume && udev->persist_enabled) {
3134 dev_dbg(&udev->dev, "retry with reset-resume\n");
3135 udev->reset_resume = 1;
3136 goto retry_reset_resume;
3141 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3144 * There are a few quirky devices which violate the standard
3145 * by claiming to have remote wakeup enabled after a reset,
3146 * which crash if the feature is cleared, hence check for
3147 * udev->reset_resume
3149 } else if (udev->actconfig && !udev->reset_resume) {
3150 if (udev->speed < USB_SPEED_SUPER) {
3151 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3152 status = usb_disable_remote_wakeup(udev);
3154 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3156 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3157 | USB_INTRF_STAT_FUNC_RW))
3158 status = usb_disable_remote_wakeup(udev);
3163 "disable remote wakeup, status %d\n",
3171 * usb_port_resume - re-activate a suspended usb device's upstream port
3172 * @udev: device to re-activate, not a root hub
3173 * Context: must be able to sleep; device not locked; pm locks held
3175 * This will re-activate the suspended device, increasing power usage
3176 * while letting drivers communicate again with its endpoints.
3177 * USB resume explicitly guarantees that the power session between
3178 * the host and the device is the same as it was when the device
3181 * If @udev->reset_resume is set then this routine won't check that the
3182 * port is still enabled. Furthermore, finish_port_resume() above will
3183 * reset @udev. The end result is that a broken power session can be
3184 * recovered and @udev will appear to persist across a loss of VBUS power.
3186 * For example, if a host controller doesn't maintain VBUS suspend current
3187 * during a system sleep or is reset when the system wakes up, all the USB
3188 * power sessions below it will be broken. This is especially troublesome
3189 * for mass-storage devices containing mounted filesystems, since the
3190 * device will appear to have disconnected and all the memory mappings
3191 * to it will be lost. Using the USB_PERSIST facility, the device can be
3192 * made to appear as if it had not disconnected.
3194 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3195 * every effort to insure that the same device is present after the
3196 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3197 * quite possible for a device to remain unaltered but its media to be
3198 * changed. If the user replaces a flash memory card while the system is
3199 * asleep, he will have only himself to blame when the filesystem on the
3200 * new card is corrupted and the system crashes.
3202 * Returns 0 on success, else negative errno.
3204 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3206 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3207 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3208 int port1 = udev->portnum;
3210 u16 portchange, portstatus;
3212 if (port_dev->did_runtime_put) {
3213 status = pm_runtime_get_sync(&port_dev->dev);
3214 port_dev->did_runtime_put = false;
3216 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3222 /* Skip the initial Clear-Suspend step for a remote wakeup */
3223 status = hub_port_status(hub, port1, &portstatus, &portchange);
3224 if (status == 0 && !port_is_suspended(hub, portstatus))
3225 goto SuspendCleared;
3227 /* dev_dbg(hub->intfdev, "resume port %d\n", port1); */
3229 set_bit(port1, hub->busy_bits);
3231 /* see 7.1.7.7; affects power usage, but not budgeting */
3232 if (hub_is_superspeed(hub->hdev))
3233 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3235 status = usb_clear_port_feature(hub->hdev,
3236 port1, USB_PORT_FEAT_SUSPEND);
3238 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3241 /* drive resume for at least 20 msec */
3242 dev_dbg(&udev->dev, "usb %sresume\n",
3243 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3246 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3247 * stop resume signaling. Then finish the resume
3250 status = hub_port_status(hub, port1, &portstatus, &portchange);
3252 /* TRSMRCY = 10 msec */
3258 udev->port_is_suspended = 0;
3259 if (hub_is_superspeed(hub->hdev)) {
3260 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3261 usb_clear_port_feature(hub->hdev, port1,
3262 USB_PORT_FEAT_C_PORT_LINK_STATE);
3264 if (portchange & USB_PORT_STAT_C_SUSPEND)
3265 usb_clear_port_feature(hub->hdev, port1,
3266 USB_PORT_FEAT_C_SUSPEND);
3270 clear_bit(port1, hub->busy_bits);
3272 status = check_port_resume_type(udev,
3273 hub, port1, status, portchange, portstatus);
3275 status = finish_port_resume(udev);
3277 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3278 hub_port_logical_disconnect(hub, port1);
3280 /* Try to enable USB2 hardware LPM */
3281 if (udev->usb2_hw_lpm_capable == 1)
3282 usb_set_usb2_hardware_lpm(udev, 1);
3284 /* Try to enable USB3 LTM and LPM */
3285 usb_enable_ltm(udev);
3286 usb_unlocked_enable_lpm(udev);
3292 #ifdef CONFIG_PM_RUNTIME
3294 /* caller has locked udev */
3295 int usb_remote_wakeup(struct usb_device *udev)
3299 if (udev->state == USB_STATE_SUSPENDED) {
3300 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3301 status = usb_autoresume_device(udev);
3303 /* Let the drivers do their thing, then... */
3304 usb_autosuspend_device(udev);
3312 static int check_ports_changed(struct usb_hub *hub)
3316 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3317 u16 portstatus, portchange;
3320 status = hub_port_status(hub, port1, &portstatus, &portchange);
3321 if (!status && portchange)
3327 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3329 struct usb_hub *hub = usb_get_intfdata (intf);
3330 struct usb_device *hdev = hub->hdev;
3335 * Warn if children aren't already suspended.
3336 * Also, add up the number of wakeup-enabled descendants.
3338 hub->wakeup_enabled_descendants = 0;
3339 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3340 struct usb_device *udev;
3342 udev = hub->ports[port1 - 1]->child;
3343 if (udev && udev->can_submit) {
3344 dev_warn(&intf->dev, "port %d not suspended yet\n",
3346 if (PMSG_IS_AUTO(msg))
3350 hub->wakeup_enabled_descendants +=
3351 wakeup_enabled_descendants(udev);
3354 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3355 /* check if there are changes pending on hub ports */
3356 if (check_ports_changed(hub)) {
3357 if (PMSG_IS_AUTO(msg))
3359 pm_wakeup_event(&hdev->dev, 2000);
3363 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3364 /* Enable hub to send remote wakeup for all ports. */
3365 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3366 status = set_port_feature(hdev,
3368 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3369 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3370 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3371 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3375 dev_dbg(&intf->dev, "%s\n", __func__);
3377 /* stop khubd and related activity */
3378 hub_quiesce(hub, HUB_SUSPEND);
3382 static int hub_resume(struct usb_interface *intf)
3384 struct usb_hub *hub = usb_get_intfdata(intf);
3386 dev_dbg(&intf->dev, "%s\n", __func__);
3387 hub_activate(hub, HUB_RESUME);
3391 static int hub_reset_resume(struct usb_interface *intf)
3393 struct usb_hub *hub = usb_get_intfdata(intf);
3395 dev_dbg(&intf->dev, "%s\n", __func__);
3396 hub_activate(hub, HUB_RESET_RESUME);
3401 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3402 * @rhdev: struct usb_device for the root hub
3404 * The USB host controller driver calls this function when its root hub
3405 * is resumed and Vbus power has been interrupted or the controller
3406 * has been reset. The routine marks @rhdev as having lost power.
3407 * When the hub driver is resumed it will take notice and carry out
3408 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3409 * the others will be disconnected.
3411 void usb_root_hub_lost_power(struct usb_device *rhdev)
3413 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3414 rhdev->reset_resume = 1;
3416 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3418 static const char * const usb3_lpm_names[] = {
3426 * Send a Set SEL control transfer to the device, prior to enabling
3427 * device-initiated U1 or U2. This lets the device know the exit latencies from
3428 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3429 * packet from the host.
3431 * This function will fail if the SEL or PEL values for udev are greater than
3432 * the maximum allowed values for the link state to be enabled.
3434 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3436 struct usb_set_sel_req *sel_values;
3437 unsigned long long u1_sel;
3438 unsigned long long u1_pel;
3439 unsigned long long u2_sel;
3440 unsigned long long u2_pel;
3443 if (udev->state != USB_STATE_CONFIGURED)
3446 /* Convert SEL and PEL stored in ns to us */
3447 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3448 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3449 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3450 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3453 * Make sure that the calculated SEL and PEL values for the link
3454 * state we're enabling aren't bigger than the max SEL/PEL
3455 * value that will fit in the SET SEL control transfer.
3456 * Otherwise the device would get an incorrect idea of the exit
3457 * latency for the link state, and could start a device-initiated
3458 * U1/U2 when the exit latencies are too high.
3460 if ((state == USB3_LPM_U1 &&
3461 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3462 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3463 (state == USB3_LPM_U2 &&
3464 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3465 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3466 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3467 usb3_lpm_names[state], u1_sel, u1_pel);
3472 * If we're enabling device-initiated LPM for one link state,
3473 * but the other link state has a too high SEL or PEL value,
3474 * just set those values to the max in the Set SEL request.
3476 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3477 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3479 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3480 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3482 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3483 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3485 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3486 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3489 * usb_enable_lpm() can be called as part of a failed device reset,
3490 * which may be initiated by an error path of a mass storage driver.
3491 * Therefore, use GFP_NOIO.
3493 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3497 sel_values->u1_sel = u1_sel;
3498 sel_values->u1_pel = u1_pel;
3499 sel_values->u2_sel = cpu_to_le16(u2_sel);
3500 sel_values->u2_pel = cpu_to_le16(u2_pel);
3502 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3506 sel_values, sizeof *(sel_values),
3507 USB_CTRL_SET_TIMEOUT);
3513 * Enable or disable device-initiated U1 or U2 transitions.
3515 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3516 enum usb3_link_state state, bool enable)
3523 feature = USB_DEVICE_U1_ENABLE;
3526 feature = USB_DEVICE_U2_ENABLE;
3529 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3530 __func__, enable ? "enable" : "disable");
3534 if (udev->state != USB_STATE_CONFIGURED) {
3535 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3536 "for unconfigured device.\n",
3537 __func__, enable ? "enable" : "disable",
3538 usb3_lpm_names[state]);
3544 * Now send the control transfer to enable device-initiated LPM
3545 * for either U1 or U2.
3547 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3548 USB_REQ_SET_FEATURE,
3552 USB_CTRL_SET_TIMEOUT);
3554 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3555 USB_REQ_CLEAR_FEATURE,
3559 USB_CTRL_SET_TIMEOUT);
3562 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3563 enable ? "Enable" : "Disable",
3564 usb3_lpm_names[state]);
3570 static int usb_set_lpm_timeout(struct usb_device *udev,
3571 enum usb3_link_state state, int timeout)
3578 feature = USB_PORT_FEAT_U1_TIMEOUT;
3581 feature = USB_PORT_FEAT_U2_TIMEOUT;
3584 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3589 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3590 timeout != USB3_LPM_DEVICE_INITIATED) {
3591 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3592 "which is a reserved value.\n",
3593 usb3_lpm_names[state], timeout);
3597 ret = set_port_feature(udev->parent,
3598 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3601 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3602 "error code %i\n", usb3_lpm_names[state],
3606 if (state == USB3_LPM_U1)
3607 udev->u1_params.timeout = timeout;
3609 udev->u2_params.timeout = timeout;
3614 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3617 * We will attempt to enable U1 or U2, but there are no guarantees that the
3618 * control transfers to set the hub timeout or enable device-initiated U1/U2
3619 * will be successful.
3621 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3622 * driver know about it. If that call fails, it should be harmless, and just
3623 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3625 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3626 enum usb3_link_state state)
3629 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3630 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3632 /* If the device says it doesn't have *any* exit latency to come out of
3633 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3636 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3637 (state == USB3_LPM_U2 && u2_mel == 0))
3641 * First, let the device know about the exit latencies
3642 * associated with the link state we're about to enable.
3644 ret = usb_req_set_sel(udev, state);
3646 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3647 usb3_lpm_names[state]);
3651 /* We allow the host controller to set the U1/U2 timeout internally
3652 * first, so that it can change its schedule to account for the
3653 * additional latency to send data to a device in a lower power
3656 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3658 /* xHCI host controller doesn't want to enable this LPM state. */
3663 dev_warn(&udev->dev, "Could not enable %s link state, "
3664 "xHCI error %i.\n", usb3_lpm_names[state],
3669 if (usb_set_lpm_timeout(udev, state, timeout))
3670 /* If we can't set the parent hub U1/U2 timeout,
3671 * device-initiated LPM won't be allowed either, so let the xHCI
3672 * host know that this link state won't be enabled.
3674 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3676 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3677 else if (udev->actconfig)
3678 usb_set_device_initiated_lpm(udev, state, true);
3683 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3686 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3687 * If zero is returned, the parent will not allow the link to go into U1/U2.
3689 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3690 * it won't have an effect on the bus link state because the parent hub will
3691 * still disallow device-initiated U1/U2 entry.
3693 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3694 * possible. The result will be slightly more bus bandwidth will be taken up
3695 * (to account for U1/U2 exit latency), but it should be harmless.
3697 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3698 enum usb3_link_state state)
3704 feature = USB_PORT_FEAT_U1_TIMEOUT;
3707 feature = USB_PORT_FEAT_U2_TIMEOUT;
3710 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3715 if (usb_set_lpm_timeout(udev, state, 0))
3718 usb_set_device_initiated_lpm(udev, state, false);
3720 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3721 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3722 "bus schedule bandwidth may be impacted.\n",
3723 usb3_lpm_names[state]);
3728 * Disable hub-initiated and device-initiated U1 and U2 entry.
3729 * Caller must own the bandwidth_mutex.
3731 * This will call usb_enable_lpm() on failure, which will decrement
3732 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3734 int usb_disable_lpm(struct usb_device *udev)
3736 struct usb_hcd *hcd;
3738 if (!udev || !udev->parent ||
3739 udev->speed != USB_SPEED_SUPER ||
3743 hcd = bus_to_hcd(udev->bus);
3744 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3747 udev->lpm_disable_count++;
3748 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3751 /* If LPM is enabled, attempt to disable it. */
3752 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3754 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3760 usb_enable_lpm(udev);
3763 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3765 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3766 int usb_unlocked_disable_lpm(struct usb_device *udev)
3768 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3774 mutex_lock(hcd->bandwidth_mutex);
3775 ret = usb_disable_lpm(udev);
3776 mutex_unlock(hcd->bandwidth_mutex);
3780 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3783 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3784 * xHCI host policy may prevent U1 or U2 from being enabled.
3786 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3787 * until the lpm_disable_count drops to zero. Caller must own the
3790 void usb_enable_lpm(struct usb_device *udev)
3792 struct usb_hcd *hcd;
3794 if (!udev || !udev->parent ||
3795 udev->speed != USB_SPEED_SUPER ||
3799 udev->lpm_disable_count--;
3800 hcd = bus_to_hcd(udev->bus);
3801 /* Double check that we can both enable and disable LPM.
3802 * Device must be configured to accept set feature U1/U2 timeout.
3804 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3805 !hcd->driver->disable_usb3_lpm_timeout)
3808 if (udev->lpm_disable_count > 0)
3811 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3812 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3814 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3816 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3817 void usb_unlocked_enable_lpm(struct usb_device *udev)
3819 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3824 mutex_lock(hcd->bandwidth_mutex);
3825 usb_enable_lpm(udev);
3826 mutex_unlock(hcd->bandwidth_mutex);
3828 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3831 #else /* CONFIG_PM */
3833 #define hub_suspend NULL
3834 #define hub_resume NULL
3835 #define hub_reset_resume NULL
3837 int usb_disable_lpm(struct usb_device *udev)
3841 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3843 void usb_enable_lpm(struct usb_device *udev) { }
3844 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3846 int usb_unlocked_disable_lpm(struct usb_device *udev)
3850 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3852 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3853 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3855 int usb_disable_ltm(struct usb_device *udev)
3859 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3861 void usb_enable_ltm(struct usb_device *udev) { }
3862 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3864 #endif /* CONFIG_PM */
3867 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3869 * Between connect detection and reset signaling there must be a delay
3870 * of 100ms at least for debounce and power-settling. The corresponding
3871 * timer shall restart whenever the downstream port detects a disconnect.
3873 * Apparently there are some bluetooth and irda-dongles and a number of
3874 * low-speed devices for which this debounce period may last over a second.
3875 * Not covered by the spec - but easy to deal with.
3877 * This implementation uses a 1500ms total debounce timeout; if the
3878 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3879 * every 25ms for transient disconnects. When the port status has been
3880 * unchanged for 100ms it returns the port status.
3882 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3885 int total_time, stable_time = 0;
3886 u16 portchange, portstatus;
3887 unsigned connection = 0xffff;
3889 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3890 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3894 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3895 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3896 if (!must_be_connected ||
3897 (connection == USB_PORT_STAT_CONNECTION))
3898 stable_time += HUB_DEBOUNCE_STEP;
3899 if (stable_time >= HUB_DEBOUNCE_STABLE)
3903 connection = portstatus & USB_PORT_STAT_CONNECTION;
3906 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3907 usb_clear_port_feature(hub->hdev, port1,
3908 USB_PORT_FEAT_C_CONNECTION);
3911 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3913 msleep(HUB_DEBOUNCE_STEP);
3916 dev_dbg (hub->intfdev,
3917 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3918 port1, total_time, stable_time, portstatus);
3920 if (stable_time < HUB_DEBOUNCE_STABLE)
3925 void usb_ep0_reinit(struct usb_device *udev)
3927 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3928 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3929 usb_enable_endpoint(udev, &udev->ep0, true);
3931 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3933 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3934 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3936 static int hub_set_address(struct usb_device *udev, int devnum)
3939 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3942 * The host controller will choose the device address,
3943 * instead of the core having chosen it earlier
3945 if (!hcd->driver->address_device && devnum <= 1)
3947 if (udev->state == USB_STATE_ADDRESS)
3949 if (udev->state != USB_STATE_DEFAULT)
3951 if (hcd->driver->address_device)
3952 retval = hcd->driver->address_device(hcd, udev);
3954 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3955 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3956 NULL, 0, USB_CTRL_SET_TIMEOUT);
3958 update_devnum(udev, devnum);
3959 /* Device now using proper address. */
3960 usb_set_device_state(udev, USB_STATE_ADDRESS);
3961 usb_ep0_reinit(udev);
3967 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
3968 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
3971 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
3972 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
3973 * support bit in the BOS descriptor.
3975 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
3979 if (!udev->usb2_hw_lpm_capable)
3982 connect_type = usb_get_hub_port_connect_type(udev->parent,
3985 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
3986 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
3987 udev->usb2_hw_lpm_allowed = 1;
3988 usb_set_usb2_hardware_lpm(udev, 1);
3992 static int hub_enable_device(struct usb_device *udev)
3994 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3996 if (!hcd->driver->enable_device)
3998 if (udev->state == USB_STATE_ADDRESS)
4000 if (udev->state != USB_STATE_DEFAULT)
4003 return hcd->driver->enable_device(hcd, udev);
4006 /* Reset device, (re)assign address, get device descriptor.
4007 * Device connection must be stable, no more debouncing needed.
4008 * Returns device in USB_STATE_ADDRESS, except on error.
4010 * If this is called for an already-existing device (as part of
4011 * usb_reset_and_verify_device), the caller must own the device lock. For a
4012 * newly detected device that is not accessible through any global
4013 * pointers, it's not necessary to lock the device.
4016 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4019 static DEFINE_MUTEX(usb_address0_mutex);
4021 struct usb_device *hdev = hub->hdev;
4022 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4024 unsigned delay = HUB_SHORT_RESET_TIME;
4025 enum usb_device_speed oldspeed = udev->speed;
4027 int devnum = udev->devnum;
4029 /* root hub ports have a slightly longer reset period
4030 * (from USB 2.0 spec, section 7.1.7.5)
4032 if (!hdev->parent) {
4033 delay = HUB_ROOT_RESET_TIME;
4034 if (port1 == hdev->bus->otg_port)
4035 hdev->bus->b_hnp_enable = 0;
4038 /* Some low speed devices have problems with the quick delay, so */
4039 /* be a bit pessimistic with those devices. RHbug #23670 */
4040 if (oldspeed == USB_SPEED_LOW)
4041 delay = HUB_LONG_RESET_TIME;
4043 mutex_lock(&usb_address0_mutex);
4045 /* Reset the device; full speed may morph to high speed */
4046 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4047 retval = hub_port_reset(hub, port1, udev, delay, false);
4048 if (retval < 0) /* error or disconnect */
4050 /* success, speed is known */
4054 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4055 dev_dbg(&udev->dev, "device reset changed speed!\n");
4058 oldspeed = udev->speed;
4060 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4061 * it's fixed size except for full speed devices.
4062 * For Wireless USB devices, ep0 max packet is always 512 (tho
4063 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4065 switch (udev->speed) {
4066 case USB_SPEED_SUPER:
4067 case USB_SPEED_WIRELESS: /* fixed at 512 */
4068 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4070 case USB_SPEED_HIGH: /* fixed at 64 */
4071 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4073 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4074 /* to determine the ep0 maxpacket size, try to read
4075 * the device descriptor to get bMaxPacketSize0 and
4076 * then correct our initial guess.
4078 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4080 case USB_SPEED_LOW: /* fixed at 8 */
4081 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4087 if (udev->speed == USB_SPEED_WIRELESS)
4088 speed = "variable speed Wireless";
4090 speed = usb_speed_string(udev->speed);
4092 if (udev->speed != USB_SPEED_SUPER)
4093 dev_info(&udev->dev,
4094 "%s %s USB device number %d using %s\n",
4095 (udev->config) ? "reset" : "new", speed,
4096 devnum, udev->bus->controller->driver->name);
4098 /* Set up TT records, if needed */
4100 udev->tt = hdev->tt;
4101 udev->ttport = hdev->ttport;
4102 } else if (udev->speed != USB_SPEED_HIGH
4103 && hdev->speed == USB_SPEED_HIGH) {
4105 dev_err(&udev->dev, "parent hub has no TT\n");
4109 udev->tt = &hub->tt;
4110 udev->ttport = port1;
4113 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4114 * Because device hardware and firmware is sometimes buggy in
4115 * this area, and this is how Linux has done it for ages.
4116 * Change it cautiously.
4118 * NOTE: If use_new_scheme() is true we will start by issuing
4119 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4120 * so it may help with some non-standards-compliant devices.
4121 * Otherwise we start with SET_ADDRESS and then try to read the
4122 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4125 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4126 bool did_new_scheme = false;
4128 if (use_new_scheme(udev, retry_counter)) {
4129 struct usb_device_descriptor *buf;
4132 did_new_scheme = true;
4133 retval = hub_enable_device(udev);
4136 "hub failed to enable device, error %d\n",
4141 #define GET_DESCRIPTOR_BUFSIZE 64
4142 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4148 /* Retry on all errors; some devices are flakey.
4149 * 255 is for WUSB devices, we actually need to use
4150 * 512 (WUSB1.0[4.8.1]).
4152 for (j = 0; j < 3; ++j) {
4153 buf->bMaxPacketSize0 = 0;
4154 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4155 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4156 USB_DT_DEVICE << 8, 0,
4157 buf, GET_DESCRIPTOR_BUFSIZE,
4158 initial_descriptor_timeout);
4159 switch (buf->bMaxPacketSize0) {
4160 case 8: case 16: case 32: case 64: case 255:
4161 if (buf->bDescriptorType ==
4175 udev->descriptor.bMaxPacketSize0 =
4176 buf->bMaxPacketSize0;
4179 retval = hub_port_reset(hub, port1, udev, delay, false);
4180 if (retval < 0) /* error or disconnect */
4182 if (oldspeed != udev->speed) {
4184 "device reset changed speed!\n");
4190 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4195 #undef GET_DESCRIPTOR_BUFSIZE
4199 * If device is WUSB, we already assigned an
4200 * unauthorized address in the Connect Ack sequence;
4201 * authorization will assign the final address.
4203 if (udev->wusb == 0) {
4204 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4205 retval = hub_set_address(udev, devnum);
4211 if (retval != -ENODEV)
4212 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4216 if (udev->speed == USB_SPEED_SUPER) {
4217 devnum = udev->devnum;
4218 dev_info(&udev->dev,
4219 "%s SuperSpeed USB device number %d using %s\n",
4220 (udev->config) ? "reset" : "new",
4221 devnum, udev->bus->controller->driver->name);
4224 /* cope with hardware quirkiness:
4225 * - let SET_ADDRESS settle, some device hardware wants it
4226 * - read ep0 maxpacket even for high and low speed,
4229 /* use_new_scheme() checks the speed which may have
4230 * changed since the initial look so we cache the result
4237 retval = usb_get_device_descriptor(udev, 8);
4239 if (retval != -ENODEV)
4241 "device descriptor read/8, error %d\n",
4253 if (hcd->phy && !hdev->parent)
4254 usb_phy_notify_connect(hcd->phy, udev->speed);
4257 * Some superspeed devices have finished the link training process
4258 * and attached to a superspeed hub port, but the device descriptor
4259 * got from those devices show they aren't superspeed devices. Warm
4260 * reset the port attached by the devices can fix them.
4262 if ((udev->speed == USB_SPEED_SUPER) &&
4263 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4264 dev_err(&udev->dev, "got a wrong device descriptor, "
4265 "warm reset device\n");
4266 hub_port_reset(hub, port1, udev,
4267 HUB_BH_RESET_TIME, true);
4272 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4273 udev->speed == USB_SPEED_SUPER)
4276 i = udev->descriptor.bMaxPacketSize0;
4277 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4278 if (udev->speed == USB_SPEED_LOW ||
4279 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4280 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4284 if (udev->speed == USB_SPEED_FULL)
4285 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4287 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4288 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4289 usb_ep0_reinit(udev);
4292 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4293 if (retval < (signed)sizeof(udev->descriptor)) {
4294 if (retval != -ENODEV)
4295 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4302 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4303 retval = usb_get_bos_descriptor(udev);
4305 udev->lpm_capable = usb_device_supports_lpm(udev);
4306 usb_set_lpm_parameters(udev);
4311 /* notify HCD that we have a device connected and addressed */
4312 if (hcd->driver->update_device)
4313 hcd->driver->update_device(hcd, udev);
4314 hub_set_initial_usb2_lpm_policy(udev);
4317 hub_port_disable(hub, port1, 0);
4318 update_devnum(udev, devnum); /* for disconnect processing */
4320 mutex_unlock(&usb_address0_mutex);
4325 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4327 struct usb_qualifier_descriptor *qual;
4330 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4334 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4335 qual, sizeof *qual);
4336 if (status == sizeof *qual) {
4337 dev_info(&udev->dev, "not running at top speed; "
4338 "connect to a high speed hub\n");
4339 /* hub LEDs are probably harder to miss than syslog */
4340 if (hub->has_indicators) {
4341 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4342 queue_delayed_work(system_power_efficient_wq,
4350 hub_power_remaining (struct usb_hub *hub)
4352 struct usb_device *hdev = hub->hdev;
4356 if (!hub->limited_power)
4359 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4360 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4361 struct usb_device *udev = hub->ports[port1 - 1]->child;
4367 if (hub_is_superspeed(udev))
4373 * Unconfigured devices may not use more than one unit load,
4374 * or 8mA for OTG ports
4376 if (udev->actconfig)
4377 delta = usb_get_max_power(udev, udev->actconfig);
4378 else if (port1 != udev->bus->otg_port || hdev->parent)
4382 if (delta > hub->mA_per_port)
4383 dev_warn(&udev->dev,
4384 "%dmA is over %umA budget for port %d!\n",
4385 delta, hub->mA_per_port, port1);
4388 if (remaining < 0) {
4389 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4396 /* Handle physical or logical connection change events.
4397 * This routine is called when:
4398 * a port connection-change occurs;
4399 * a port enable-change occurs (often caused by EMI);
4400 * usb_reset_and_verify_device() encounters changed descriptors (as from
4401 * a firmware download)
4402 * caller already locked the hub
4404 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4405 u16 portstatus, u16 portchange)
4407 struct usb_device *hdev = hub->hdev;
4408 struct device *hub_dev = hub->intfdev;
4409 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4410 unsigned wHubCharacteristics =
4411 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4412 struct usb_device *udev;
4417 "port %d, status %04x, change %04x, %s\n",
4418 port1, portstatus, portchange, portspeed(hub, portstatus));
4420 if (hub->has_indicators) {
4421 set_port_led(hub, port1, HUB_LED_AUTO);
4422 hub->indicator[port1-1] = INDICATOR_AUTO;
4425 #ifdef CONFIG_USB_OTG
4426 /* during HNP, don't repeat the debounce */
4427 if (hdev->bus->is_b_host)
4428 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4429 USB_PORT_STAT_C_ENABLE);
4432 /* Try to resuscitate an existing device */
4433 udev = hub->ports[port1 - 1]->child;
4434 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4435 udev->state != USB_STATE_NOTATTACHED) {
4436 usb_lock_device(udev);
4437 if (portstatus & USB_PORT_STAT_ENABLE) {
4438 status = 0; /* Nothing to do */
4440 #ifdef CONFIG_PM_RUNTIME
4441 } else if (udev->state == USB_STATE_SUSPENDED &&
4442 udev->persist_enabled) {
4443 /* For a suspended device, treat this as a
4444 * remote wakeup event.
4446 status = usb_remote_wakeup(udev);
4450 status = -ENODEV; /* Don't resuscitate */
4452 usb_unlock_device(udev);
4455 clear_bit(port1, hub->change_bits);
4460 /* Disconnect any existing devices under this port */
4462 if (hcd->phy && !hdev->parent &&
4463 !(portstatus & USB_PORT_STAT_CONNECTION))
4464 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4465 usb_disconnect(&hub->ports[port1 - 1]->child);
4467 clear_bit(port1, hub->change_bits);
4469 /* We can forget about a "removed" device when there's a physical
4470 * disconnect or the connect status changes.
4472 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4473 (portchange & USB_PORT_STAT_C_CONNECTION))
4474 clear_bit(port1, hub->removed_bits);
4476 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4477 USB_PORT_STAT_C_ENABLE)) {
4478 status = hub_port_debounce_be_stable(hub, port1);
4480 if (status != -ENODEV && printk_ratelimit())
4481 dev_err(hub_dev, "connect-debounce failed, "
4482 "port %d disabled\n", port1);
4483 portstatus &= ~USB_PORT_STAT_CONNECTION;
4485 portstatus = status;
4489 /* Return now if debouncing failed or nothing is connected or
4490 * the device was "removed".
4492 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4493 test_bit(port1, hub->removed_bits)) {
4495 /* maybe switch power back on (e.g. root hub was reset) */
4496 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4497 && !port_is_power_on(hub, portstatus))
4498 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4500 if (portstatus & USB_PORT_STAT_ENABLE)
4504 if (hub_is_superspeed(hub->hdev))
4510 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4512 /* reallocate for each attempt, since references
4513 * to the previous one can escape in various ways
4515 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4518 "couldn't allocate port %d usb_device\n",
4523 usb_set_device_state(udev, USB_STATE_POWERED);
4524 udev->bus_mA = hub->mA_per_port;
4525 udev->level = hdev->level + 1;
4526 udev->wusb = hub_is_wusb(hub);
4528 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4529 if (hub_is_superspeed(hub->hdev))
4530 udev->speed = USB_SPEED_SUPER;
4532 udev->speed = USB_SPEED_UNKNOWN;
4534 choose_devnum(udev);
4535 if (udev->devnum <= 0) {
4536 status = -ENOTCONN; /* Don't retry */
4540 /* reset (non-USB 3.0 devices) and get descriptor */
4541 status = hub_port_init(hub, udev, port1, i);
4545 usb_detect_quirks(udev);
4546 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4549 /* consecutive bus-powered hubs aren't reliable; they can
4550 * violate the voltage drop budget. if the new child has
4551 * a "powered" LED, users should notice we didn't enable it
4552 * (without reading syslog), even without per-port LEDs
4555 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4556 && udev->bus_mA <= unit_load) {
4559 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4562 dev_dbg(&udev->dev, "get status %d ?\n", status);
4565 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4567 "can't connect bus-powered hub "
4569 if (hub->has_indicators) {
4570 hub->indicator[port1-1] =
4571 INDICATOR_AMBER_BLINK;
4573 system_power_efficient_wq,
4576 status = -ENOTCONN; /* Don't retry */
4581 /* check for devices running slower than they could */
4582 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4583 && udev->speed == USB_SPEED_FULL
4584 && highspeed_hubs != 0)
4585 check_highspeed (hub, udev, port1);
4587 /* Store the parent's children[] pointer. At this point
4588 * udev becomes globally accessible, although presumably
4589 * no one will look at it until hdev is unlocked.
4593 /* We mustn't add new devices if the parent hub has
4594 * been disconnected; we would race with the
4595 * recursively_mark_NOTATTACHED() routine.
4597 spin_lock_irq(&device_state_lock);
4598 if (hdev->state == USB_STATE_NOTATTACHED)
4601 hub->ports[port1 - 1]->child = udev;
4602 spin_unlock_irq(&device_state_lock);
4604 /* Run it through the hoops (find a driver, etc) */
4606 status = usb_new_device(udev);
4608 spin_lock_irq(&device_state_lock);
4609 hub->ports[port1 - 1]->child = NULL;
4610 spin_unlock_irq(&device_state_lock);
4617 status = hub_power_remaining(hub);
4619 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4624 hub_port_disable(hub, port1, 1);
4626 usb_ep0_reinit(udev);
4627 release_devnum(udev);
4630 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4633 if (hub->hdev->parent ||
4634 !hcd->driver->port_handed_over ||
4635 !(hcd->driver->port_handed_over)(hcd, port1)) {
4636 if (status != -ENOTCONN && status != -ENODEV)
4637 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4642 hub_port_disable(hub, port1, 1);
4643 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4644 hcd->driver->relinquish_port(hcd, port1);
4647 /* Returns 1 if there was a remote wakeup and a connect status change. */
4648 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4649 u16 portstatus, u16 portchange)
4651 struct usb_device *hdev;
4652 struct usb_device *udev;
4653 int connect_change = 0;
4657 udev = hub->ports[port - 1]->child;
4658 if (!hub_is_superspeed(hdev)) {
4659 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4661 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4663 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4664 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4670 /* TRSMRCY = 10 msec */
4673 usb_lock_device(udev);
4674 ret = usb_remote_wakeup(udev);
4675 usb_unlock_device(udev);
4680 hub_port_disable(hub, port, 1);
4682 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4684 return connect_change;
4687 static void hub_events(void)
4689 struct list_head *tmp;
4690 struct usb_device *hdev;
4691 struct usb_interface *intf;
4692 struct usb_hub *hub;
4693 struct device *hub_dev;
4699 int connect_change, wakeup_change;
4702 * We restart the list every time to avoid a deadlock with
4703 * deleting hubs downstream from this one. This should be
4704 * safe since we delete the hub from the event list.
4705 * Not the most efficient, but avoids deadlocks.
4709 /* Grab the first entry at the beginning of the list */
4710 spin_lock_irq(&hub_event_lock);
4711 if (list_empty(&hub_event_list)) {
4712 spin_unlock_irq(&hub_event_lock);
4716 tmp = hub_event_list.next;
4719 hub = list_entry(tmp, struct usb_hub, event_list);
4720 kref_get(&hub->kref);
4721 spin_unlock_irq(&hub_event_lock);
4724 hub_dev = hub->intfdev;
4725 intf = to_usb_interface(hub_dev);
4726 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4727 hdev->state, hdev->maxchild,
4728 /* NOTE: expects max 15 ports... */
4729 (u16) hub->change_bits[0],
4730 (u16) hub->event_bits[0]);
4732 /* Lock the device, then check to see if we were
4733 * disconnected while waiting for the lock to succeed. */
4734 usb_lock_device(hdev);
4735 if (unlikely(hub->disconnected))
4736 goto loop_disconnected;
4738 /* If the hub has died, clean up after it */
4739 if (hdev->state == USB_STATE_NOTATTACHED) {
4740 hub->error = -ENODEV;
4741 hub_quiesce(hub, HUB_DISCONNECT);
4746 ret = usb_autopm_get_interface(intf);
4748 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4752 /* If this is an inactive hub, do nothing */
4757 dev_dbg (hub_dev, "resetting for error %d\n",
4760 ret = usb_reset_device(hdev);
4763 "error resetting hub: %d\n", ret);
4771 /* deal with port status changes */
4772 for (i = 1; i <= hdev->maxchild; i++) {
4773 struct usb_device *udev = hub->ports[i - 1]->child;
4775 if (test_bit(i, hub->busy_bits))
4777 connect_change = test_bit(i, hub->change_bits);
4778 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4779 if (!test_and_clear_bit(i, hub->event_bits) &&
4780 !connect_change && !wakeup_change)
4783 ret = hub_port_status(hub, i,
4784 &portstatus, &portchange);
4788 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4789 usb_clear_port_feature(hdev, i,
4790 USB_PORT_FEAT_C_CONNECTION);
4794 if (portchange & USB_PORT_STAT_C_ENABLE) {
4795 if (!connect_change)
4797 "port %d enable change, "
4800 usb_clear_port_feature(hdev, i,
4801 USB_PORT_FEAT_C_ENABLE);
4804 * EM interference sometimes causes badly
4805 * shielded USB devices to be shutdown by
4806 * the hub, this hack enables them again.
4807 * Works at least with mouse driver.
4809 if (!(portstatus & USB_PORT_STAT_ENABLE)
4811 && hub->ports[i - 1]->child) {
4814 "disabled by hub (EMI?), "
4821 if (hub_handle_remote_wakeup(hub, i,
4822 portstatus, portchange))
4825 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4829 dev_dbg(hub_dev, "over-current change on port "
4831 usb_clear_port_feature(hdev, i,
4832 USB_PORT_FEAT_C_OVER_CURRENT);
4833 msleep(100); /* Cool down */
4834 hub_power_on(hub, true);
4835 hub_port_status(hub, i, &status, &unused);
4836 if (status & USB_PORT_STAT_OVERCURRENT)
4837 dev_err(hub_dev, "over-current "
4838 "condition on port %d\n", i);
4841 if (portchange & USB_PORT_STAT_C_RESET) {
4843 "reset change on port %d\n",
4845 usb_clear_port_feature(hdev, i,
4846 USB_PORT_FEAT_C_RESET);
4848 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4849 hub_is_superspeed(hub->hdev)) {
4851 "warm reset change on port %d\n",
4853 usb_clear_port_feature(hdev, i,
4854 USB_PORT_FEAT_C_BH_PORT_RESET);
4856 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4857 usb_clear_port_feature(hub->hdev, i,
4858 USB_PORT_FEAT_C_PORT_LINK_STATE);
4860 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4862 "config error on port %d\n",
4864 usb_clear_port_feature(hub->hdev, i,
4865 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4868 /* Warm reset a USB3 protocol port if it's in
4869 * SS.Inactive state.
4871 if (hub_port_warm_reset_required(hub, portstatus)) {
4874 dev_dbg(hub_dev, "warm reset port %d\n", i);
4876 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4877 udev->state == USB_STATE_NOTATTACHED) {
4878 status = hub_port_reset(hub, i,
4879 NULL, HUB_BH_RESET_TIME,
4882 hub_port_disable(hub, i, 1);
4884 usb_lock_device(udev);
4885 status = usb_reset_device(udev);
4886 usb_unlock_device(udev);
4890 * On disconnect USB3 protocol ports transit from U0 to
4891 * SS.Inactive to Rx.Detect. If this happens a warm-
4892 * reset is not needed, but a (re)connect may happen
4893 * before khubd runs and sees the disconnect, and the
4894 * device may be an unknown state.
4896 * If the port went through SS.Inactive without khubd
4897 * seeing it the C_LINK_STATE change flag will be set,
4898 * and we reset the dev to put it in a known state.
4900 } else if (udev && hub_is_superspeed(hub->hdev) &&
4901 (portchange & USB_PORT_STAT_C_LINK_STATE) &&
4902 (portstatus & USB_PORT_STAT_CONNECTION)) {
4903 usb_lock_device(udev);
4904 usb_reset_device(udev);
4905 usb_unlock_device(udev);
4910 hub_port_connect_change(hub, i,
4911 portstatus, portchange);
4914 /* deal with hub status changes */
4915 if (test_and_clear_bit(0, hub->event_bits) == 0)
4917 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4918 dev_err (hub_dev, "get_hub_status failed\n");
4920 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4921 dev_dbg (hub_dev, "power change\n");
4922 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4923 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4924 /* FIXME: Is this always true? */
4925 hub->limited_power = 1;
4927 hub->limited_power = 0;
4929 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4933 dev_dbg(hub_dev, "over-current change\n");
4934 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4935 msleep(500); /* Cool down */
4936 hub_power_on(hub, true);
4937 hub_hub_status(hub, &status, &unused);
4938 if (status & HUB_STATUS_OVERCURRENT)
4939 dev_err(hub_dev, "over-current "
4945 /* Balance the usb_autopm_get_interface() above */
4946 usb_autopm_put_interface_no_suspend(intf);
4948 /* Balance the usb_autopm_get_interface_no_resume() in
4949 * kick_khubd() and allow autosuspend.
4951 usb_autopm_put_interface(intf);
4953 usb_unlock_device(hdev);
4954 kref_put(&hub->kref, hub_release);
4956 } /* end while (1) */
4959 static int hub_thread(void *__unused)
4961 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
4962 * port handover. Otherwise it might see that a full-speed device
4963 * was gone before the EHCI controller had handed its port over to
4964 * the companion full-speed controller.
4970 wait_event_freezable(khubd_wait,
4971 !list_empty(&hub_event_list) ||
4972 kthread_should_stop());
4973 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4975 pr_debug("%s: khubd exiting\n", usbcore_name);
4979 static const struct usb_device_id hub_id_table[] = {
4980 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4981 | USB_DEVICE_ID_MATCH_INT_CLASS,
4982 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4983 .bInterfaceClass = USB_CLASS_HUB,
4984 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4985 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4986 .bDeviceClass = USB_CLASS_HUB},
4987 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4988 .bInterfaceClass = USB_CLASS_HUB},
4989 { } /* Terminating entry */
4992 MODULE_DEVICE_TABLE (usb, hub_id_table);
4994 static struct usb_driver hub_driver = {
4997 .disconnect = hub_disconnect,
4998 .suspend = hub_suspend,
4999 .resume = hub_resume,
5000 .reset_resume = hub_reset_resume,
5001 .pre_reset = hub_pre_reset,
5002 .post_reset = hub_post_reset,
5003 .unlocked_ioctl = hub_ioctl,
5004 .id_table = hub_id_table,
5005 .supports_autosuspend = 1,
5008 int usb_hub_init(void)
5010 if (usb_register(&hub_driver) < 0) {
5011 printk(KERN_ERR "%s: can't register hub driver\n",
5016 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5017 if (!IS_ERR(khubd_task))
5020 /* Fall through if kernel_thread failed */
5021 usb_deregister(&hub_driver);
5022 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5027 void usb_hub_cleanup(void)
5029 kthread_stop(khubd_task);
5032 * Hub resources are freed for us by usb_deregister. It calls
5033 * usb_driver_purge on every device which in turn calls that
5034 * devices disconnect function if it is using this driver.
5035 * The hub_disconnect function takes care of releasing the
5036 * individual hub resources. -greg
5038 usb_deregister(&hub_driver);
5039 } /* usb_hub_cleanup() */
5041 static int descriptors_changed(struct usb_device *udev,
5042 struct usb_device_descriptor *old_device_descriptor,
5043 struct usb_host_bos *old_bos)
5047 unsigned serial_len = 0;
5049 unsigned old_length;
5053 if (memcmp(&udev->descriptor, old_device_descriptor,
5054 sizeof(*old_device_descriptor)) != 0)
5057 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5060 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5061 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5063 if (memcmp(udev->bos->desc, old_bos->desc, len))
5067 /* Since the idVendor, idProduct, and bcdDevice values in the
5068 * device descriptor haven't changed, we will assume the
5069 * Manufacturer and Product strings haven't changed either.
5070 * But the SerialNumber string could be different (e.g., a
5071 * different flash card of the same brand).
5074 serial_len = strlen(udev->serial) + 1;
5077 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5078 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5079 len = max(len, old_length);
5082 buf = kmalloc(len, GFP_NOIO);
5084 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5085 /* assume the worst */
5088 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5089 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5090 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5092 if (length != old_length) {
5093 dev_dbg(&udev->dev, "config index %d, error %d\n",
5098 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5100 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5102 ((struct usb_config_descriptor *) buf)->
5103 bConfigurationValue);
5109 if (!changed && serial_len) {
5110 length = usb_string(udev, udev->descriptor.iSerialNumber,
5112 if (length + 1 != serial_len) {
5113 dev_dbg(&udev->dev, "serial string error %d\n",
5116 } else if (memcmp(buf, udev->serial, length) != 0) {
5117 dev_dbg(&udev->dev, "serial string changed\n");
5127 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5128 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5130 * WARNING - don't use this routine to reset a composite device
5131 * (one with multiple interfaces owned by separate drivers)!
5132 * Use usb_reset_device() instead.
5134 * Do a port reset, reassign the device's address, and establish its
5135 * former operating configuration. If the reset fails, or the device's
5136 * descriptors change from their values before the reset, or the original
5137 * configuration and altsettings cannot be restored, a flag will be set
5138 * telling khubd to pretend the device has been disconnected and then
5139 * re-connected. All drivers will be unbound, and the device will be
5140 * re-enumerated and probed all over again.
5142 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5143 * flagged for logical disconnection, or some other negative error code
5144 * if the reset wasn't even attempted.
5147 * The caller must own the device lock. For example, it's safe to use
5148 * this from a driver probe() routine after downloading new firmware.
5149 * For calls that might not occur during probe(), drivers should lock
5150 * the device using usb_lock_device_for_reset().
5152 * Locking exception: This routine may also be called from within an
5153 * autoresume handler. Such usage won't conflict with other tasks
5154 * holding the device lock because these tasks should always call
5155 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5157 static int usb_reset_and_verify_device(struct usb_device *udev)
5159 struct usb_device *parent_hdev = udev->parent;
5160 struct usb_hub *parent_hub;
5161 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5162 struct usb_device_descriptor descriptor = udev->descriptor;
5163 struct usb_host_bos *bos;
5165 int port1 = udev->portnum;
5167 if (udev->state == USB_STATE_NOTATTACHED ||
5168 udev->state == USB_STATE_SUSPENDED) {
5169 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5175 /* this requires hcd-specific logic; see ohci_restart() */
5176 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5179 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5181 /* Disable USB2 hardware LPM.
5182 * It will be re-enabled by the enumeration process.
5184 if (udev->usb2_hw_lpm_enabled == 1)
5185 usb_set_usb2_hardware_lpm(udev, 0);
5190 /* Disable LPM and LTM while we reset the device and reinstall the alt
5191 * settings. Device-initiated LPM settings, and system exit latency
5192 * settings are cleared when the device is reset, so we have to set
5195 ret = usb_unlocked_disable_lpm(udev);
5197 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5200 ret = usb_disable_ltm(udev);
5202 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5207 set_bit(port1, parent_hub->busy_bits);
5208 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5210 /* ep0 maxpacket size may change; let the HCD know about it.
5211 * Other endpoints will be handled by re-enumeration. */
5212 usb_ep0_reinit(udev);
5213 ret = hub_port_init(parent_hub, udev, port1, i);
5214 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5217 clear_bit(port1, parent_hub->busy_bits);
5222 /* Device might have changed firmware (DFU or similar) */
5223 if (descriptors_changed(udev, &descriptor, bos)) {
5224 dev_info(&udev->dev, "device firmware changed\n");
5225 udev->descriptor = descriptor; /* for disconnect() calls */
5229 /* Restore the device's previous configuration */
5230 if (!udev->actconfig)
5233 mutex_lock(hcd->bandwidth_mutex);
5234 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5236 dev_warn(&udev->dev,
5237 "Busted HC? Not enough HCD resources for "
5238 "old configuration.\n");
5239 mutex_unlock(hcd->bandwidth_mutex);
5242 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5243 USB_REQ_SET_CONFIGURATION, 0,
5244 udev->actconfig->desc.bConfigurationValue, 0,
5245 NULL, 0, USB_CTRL_SET_TIMEOUT);
5248 "can't restore configuration #%d (error=%d)\n",
5249 udev->actconfig->desc.bConfigurationValue, ret);
5250 mutex_unlock(hcd->bandwidth_mutex);
5253 mutex_unlock(hcd->bandwidth_mutex);
5254 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5256 /* Put interfaces back into the same altsettings as before.
5257 * Don't bother to send the Set-Interface request for interfaces
5258 * that were already in altsetting 0; besides being unnecessary,
5259 * many devices can't handle it. Instead just reset the host-side
5262 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5263 struct usb_host_config *config = udev->actconfig;
5264 struct usb_interface *intf = config->interface[i];
5265 struct usb_interface_descriptor *desc;
5267 desc = &intf->cur_altsetting->desc;
5268 if (desc->bAlternateSetting == 0) {
5269 usb_disable_interface(udev, intf, true);
5270 usb_enable_interface(udev, intf, true);
5273 /* Let the bandwidth allocation function know that this
5274 * device has been reset, and it will have to use
5275 * alternate setting 0 as the current alternate setting.
5277 intf->resetting_device = 1;
5278 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5279 desc->bAlternateSetting);
5280 intf->resetting_device = 0;
5283 dev_err(&udev->dev, "failed to restore interface %d "
5284 "altsetting %d (error=%d)\n",
5285 desc->bInterfaceNumber,
5286 desc->bAlternateSetting,
5290 /* Resetting also frees any allocated streams */
5291 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5292 intf->cur_altsetting->endpoint[j].streams = 0;
5296 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5297 usb_set_usb2_hardware_lpm(udev, 1);
5298 usb_unlocked_enable_lpm(udev);
5299 usb_enable_ltm(udev);
5300 usb_release_bos_descriptor(udev);
5305 /* LPM state doesn't matter when we're about to destroy the device. */
5306 hub_port_logical_disconnect(parent_hub, port1);
5307 usb_release_bos_descriptor(udev);
5313 * usb_reset_device - warn interface drivers and perform a USB port reset
5314 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5316 * Warns all drivers bound to registered interfaces (using their pre_reset
5317 * method), performs the port reset, and then lets the drivers know that
5318 * the reset is over (using their post_reset method).
5320 * Return: The same as for usb_reset_and_verify_device().
5323 * The caller must own the device lock. For example, it's safe to use
5324 * this from a driver probe() routine after downloading new firmware.
5325 * For calls that might not occur during probe(), drivers should lock
5326 * the device using usb_lock_device_for_reset().
5328 * If an interface is currently being probed or disconnected, we assume
5329 * its driver knows how to handle resets. For all other interfaces,
5330 * if the driver doesn't have pre_reset and post_reset methods then
5331 * we attempt to unbind it and rebind afterward.
5333 int usb_reset_device(struct usb_device *udev)
5337 unsigned int noio_flag;
5338 struct usb_host_config *config = udev->actconfig;
5340 if (udev->state == USB_STATE_NOTATTACHED ||
5341 udev->state == USB_STATE_SUSPENDED) {
5342 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5348 * Don't allocate memory with GFP_KERNEL in current
5349 * context to avoid possible deadlock if usb mass
5350 * storage interface or usbnet interface(iSCSI case)
5351 * is included in current configuration. The easist
5352 * approach is to do it for every device reset,
5353 * because the device 'memalloc_noio' flag may have
5354 * not been set before reseting the usb device.
5356 noio_flag = memalloc_noio_save();
5358 /* Prevent autosuspend during the reset */
5359 usb_autoresume_device(udev);
5362 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5363 struct usb_interface *cintf = config->interface[i];
5364 struct usb_driver *drv;
5367 if (cintf->dev.driver) {
5368 drv = to_usb_driver(cintf->dev.driver);
5369 if (drv->pre_reset && drv->post_reset)
5370 unbind = (drv->pre_reset)(cintf);
5371 else if (cintf->condition ==
5372 USB_INTERFACE_BOUND)
5375 usb_forced_unbind_intf(cintf);
5380 ret = usb_reset_and_verify_device(udev);
5383 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5384 struct usb_interface *cintf = config->interface[i];
5385 struct usb_driver *drv;
5386 int rebind = cintf->needs_binding;
5388 if (!rebind && cintf->dev.driver) {
5389 drv = to_usb_driver(cintf->dev.driver);
5390 if (drv->post_reset)
5391 rebind = (drv->post_reset)(cintf);
5392 else if (cintf->condition ==
5393 USB_INTERFACE_BOUND)
5396 cintf->needs_binding = 1;
5399 usb_unbind_and_rebind_marked_interfaces(udev);
5402 usb_autosuspend_device(udev);
5403 memalloc_noio_restore(noio_flag);
5406 EXPORT_SYMBOL_GPL(usb_reset_device);
5410 * usb_queue_reset_device - Reset a USB device from an atomic context
5411 * @iface: USB interface belonging to the device to reset
5413 * This function can be used to reset a USB device from an atomic
5414 * context, where usb_reset_device() won't work (as it blocks).
5416 * Doing a reset via this method is functionally equivalent to calling
5417 * usb_reset_device(), except for the fact that it is delayed to a
5418 * workqueue. This means that any drivers bound to other interfaces
5419 * might be unbound, as well as users from usbfs in user space.
5423 * - Scheduling two resets at the same time from two different drivers
5424 * attached to two different interfaces of the same device is
5425 * possible; depending on how the driver attached to each interface
5426 * handles ->pre_reset(), the second reset might happen or not.
5428 * - If a driver is unbound and it had a pending reset, the reset will
5431 * - This function can be called during .probe() or .disconnect()
5432 * times. On return from .disconnect(), any pending resets will be
5435 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5438 * NOTE: We don't do any reference count tracking because it is not
5439 * needed. The lifecycle of the work_struct is tied to the
5440 * usb_interface. Before destroying the interface we cancel the
5441 * work_struct, so the fact that work_struct is queued and or
5442 * running means the interface (and thus, the device) exist and
5445 void usb_queue_reset_device(struct usb_interface *iface)
5447 schedule_work(&iface->reset_ws);
5449 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5452 * usb_hub_find_child - Get the pointer of child device
5453 * attached to the port which is specified by @port1.
5454 * @hdev: USB device belonging to the usb hub
5455 * @port1: port num to indicate which port the child device
5458 * USB drivers call this function to get hub's child device
5461 * Return: %NULL if input param is invalid and
5462 * child's usb_device pointer if non-NULL.
5464 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5467 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5469 if (port1 < 1 || port1 > hdev->maxchild)
5471 return hub->ports[port1 - 1]->child;
5473 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5476 * usb_set_hub_port_connect_type - set hub port connect type.
5477 * @hdev: USB device belonging to the usb hub
5478 * @port1: port num of the port
5479 * @type: connect type of the port
5481 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5482 enum usb_port_connect_type type)
5484 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5487 hub->ports[port1 - 1]->connect_type = type;
5491 * usb_get_hub_port_connect_type - Get the port's connect type
5492 * @hdev: USB device belonging to the usb hub
5493 * @port1: port num of the port
5495 * Return: The connect type of the port if successful. Or
5496 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5498 enum usb_port_connect_type
5499 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5501 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5504 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5506 return hub->ports[port1 - 1]->connect_type;
5509 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5510 struct usb_hub_descriptor *desc)
5512 enum usb_port_connect_type connect_type;
5515 if (!hub_is_superspeed(hdev)) {
5516 for (i = 1; i <= hdev->maxchild; i++) {
5517 connect_type = usb_get_hub_port_connect_type(hdev, i);
5519 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5520 u8 mask = 1 << (i%8);
5522 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5523 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5525 desc->u.hs.DeviceRemovable[i/8] |= mask;
5530 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5532 for (i = 1; i <= hdev->maxchild; i++) {
5533 connect_type = usb_get_hub_port_connect_type(hdev, i);
5535 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5538 if (!(port_removable & mask)) {
5539 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5541 port_removable |= mask;
5546 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5552 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5553 * @hdev: USB device belonging to the usb hub
5554 * @port1: port num of the port
5556 * Return: Port's acpi handle if successful, %NULL if params are
5559 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5562 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5567 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);