4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/workqueue.h>
26 #include <linux/mutex.h>
27 #include <linux/random.h>
28 #include <linux/pm_qos.h>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
34 #include "otg_whitelist.h"
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->dev.sem, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock);
44 /* workqueue to process hub events */
45 static struct workqueue_struct *hub_wq;
46 static void hub_event(struct work_struct *work);
48 /* synchronize hub-port add/remove and peering operations */
49 DEFINE_MUTEX(usb_port_peer_mutex);
51 /* cycle leds on hubs that aren't blinking for attention */
52 static bool blinkenlights = 0;
53 module_param(blinkenlights, bool, S_IRUGO);
54 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
57 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
58 * 10 seconds to send reply for the initial 64-byte descriptor request.
60 /* define initial 64-byte descriptor request timeout in milliseconds */
61 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
62 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
63 MODULE_PARM_DESC(initial_descriptor_timeout,
64 "initial 64-byte descriptor request timeout in milliseconds "
65 "(default 5000 - 5.0 seconds)");
68 * As of 2.6.10 we introduce a new USB device initialization scheme which
69 * closely resembles the way Windows works. Hopefully it will be compatible
70 * with a wider range of devices than the old scheme. However some previously
71 * working devices may start giving rise to "device not accepting address"
72 * errors; if that happens the user can try the old scheme by adjusting the
73 * following module parameters.
75 * For maximum flexibility there are two boolean parameters to control the
76 * hub driver's behavior. On the first initialization attempt, if the
77 * "old_scheme_first" parameter is set then the old scheme will be used,
78 * otherwise the new scheme is used. If that fails and "use_both_schemes"
79 * is set, then the driver will make another attempt, using the other scheme.
81 static bool old_scheme_first = 0;
82 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
83 MODULE_PARM_DESC(old_scheme_first,
84 "start with the old device initialization scheme");
86 static bool use_both_schemes = 1;
87 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
88 MODULE_PARM_DESC(use_both_schemes,
89 "try the other device initialization scheme if the "
92 /* Mutual exclusion for EHCI CF initialization. This interferes with
93 * port reset on some companion controllers.
95 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
96 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
98 #define HUB_DEBOUNCE_TIMEOUT 2000
99 #define HUB_DEBOUNCE_STEP 25
100 #define HUB_DEBOUNCE_STABLE 100
102 static void hub_release(struct kref *kref);
103 static int usb_reset_and_verify_device(struct usb_device *udev);
104 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
106 static inline char *portspeed(struct usb_hub *hub, int portstatus)
108 if (hub_is_superspeed(hub->hdev))
110 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
112 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
118 /* Note that hdev or one of its children must be locked! */
119 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
121 if (!hdev || !hdev->actconfig || !hdev->maxchild)
123 return usb_get_intfdata(hdev->actconfig->interface[0]);
126 int usb_device_supports_lpm(struct usb_device *udev)
128 /* Some devices have trouble with LPM */
129 if (udev->quirks & USB_QUIRK_NO_LPM)
132 /* USB 2.1 (and greater) devices indicate LPM support through
133 * their USB 2.0 Extended Capabilities BOS descriptor.
135 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
136 if (udev->bos->ext_cap &&
138 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
144 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
145 * However, there are some that don't, and they set the U1/U2 exit
148 if (!udev->bos->ss_cap) {
149 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
153 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
154 udev->bos->ss_cap->bU2DevExitLat == 0) {
156 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
158 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
162 if (!udev->parent || udev->parent->lpm_capable)
168 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
171 static void usb_set_lpm_mel(struct usb_device *udev,
172 struct usb3_lpm_parameters *udev_lpm_params,
173 unsigned int udev_exit_latency,
175 struct usb3_lpm_parameters *hub_lpm_params,
176 unsigned int hub_exit_latency)
178 unsigned int total_mel;
179 unsigned int device_mel;
180 unsigned int hub_mel;
183 * Calculate the time it takes to transition all links from the roothub
184 * to the parent hub into U0. The parent hub must then decode the
185 * packet (hub header decode latency) to figure out which port it was
188 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
189 * means 0.1us). Multiply that by 100 to get nanoseconds.
191 total_mel = hub_lpm_params->mel +
192 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
195 * How long will it take to transition the downstream hub's port into
196 * U0? The greater of either the hub exit latency or the device exit
199 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
200 * Multiply that by 1000 to get nanoseconds.
202 device_mel = udev_exit_latency * 1000;
203 hub_mel = hub_exit_latency * 1000;
204 if (device_mel > hub_mel)
205 total_mel += device_mel;
207 total_mel += hub_mel;
209 udev_lpm_params->mel = total_mel;
213 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
214 * a transition from either U1 or U2.
216 static void usb_set_lpm_pel(struct usb_device *udev,
217 struct usb3_lpm_parameters *udev_lpm_params,
218 unsigned int udev_exit_latency,
220 struct usb3_lpm_parameters *hub_lpm_params,
221 unsigned int hub_exit_latency,
222 unsigned int port_to_port_exit_latency)
224 unsigned int first_link_pel;
225 unsigned int hub_pel;
228 * First, the device sends an LFPS to transition the link between the
229 * device and the parent hub into U0. The exit latency is the bigger of
230 * the device exit latency or the hub exit latency.
232 if (udev_exit_latency > hub_exit_latency)
233 first_link_pel = udev_exit_latency * 1000;
235 first_link_pel = hub_exit_latency * 1000;
238 * When the hub starts to receive the LFPS, there is a slight delay for
239 * it to figure out that one of the ports is sending an LFPS. Then it
240 * will forward the LFPS to its upstream link. The exit latency is the
241 * delay, plus the PEL that we calculated for this hub.
243 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
246 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
247 * is the greater of the two exit latencies.
249 if (first_link_pel > hub_pel)
250 udev_lpm_params->pel = first_link_pel;
252 udev_lpm_params->pel = hub_pel;
256 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
257 * when a device initiates a transition to U0, until when it will receive the
258 * first packet from the host controller.
260 * Section C.1.5.1 describes the four components to this:
262 * - t2: time for the ERDY to make it from the device to the host.
263 * - t3: a host-specific delay to process the ERDY.
264 * - t4: time for the packet to make it from the host to the device.
266 * t3 is specific to both the xHCI host and the platform the host is integrated
267 * into. The Intel HW folks have said it's negligible, FIXME if a different
268 * vendor says otherwise.
270 static void usb_set_lpm_sel(struct usb_device *udev,
271 struct usb3_lpm_parameters *udev_lpm_params)
273 struct usb_device *parent;
274 unsigned int num_hubs;
275 unsigned int total_sel;
277 /* t1 = device PEL */
278 total_sel = udev_lpm_params->pel;
279 /* How many external hubs are in between the device & the root port. */
280 for (parent = udev->parent, num_hubs = 0; parent->parent;
281 parent = parent->parent)
283 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
285 total_sel += 2100 + 250 * (num_hubs - 1);
287 /* t4 = 250ns * num_hubs */
288 total_sel += 250 * num_hubs;
290 udev_lpm_params->sel = total_sel;
293 static void usb_set_lpm_parameters(struct usb_device *udev)
296 unsigned int port_to_port_delay;
297 unsigned int udev_u1_del;
298 unsigned int udev_u2_del;
299 unsigned int hub_u1_del;
300 unsigned int hub_u2_del;
302 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
305 hub = usb_hub_to_struct_hub(udev->parent);
306 /* It doesn't take time to transition the roothub into U0, since it
307 * doesn't have an upstream link.
312 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
313 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
314 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
315 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
317 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
318 hub, &udev->parent->u1_params, hub_u1_del);
320 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
321 hub, &udev->parent->u2_params, hub_u2_del);
324 * Appendix C, section C.2.2.2, says that there is a slight delay from
325 * when the parent hub notices the downstream port is trying to
326 * transition to U0 to when the hub initiates a U0 transition on its
327 * upstream port. The section says the delays are tPort2PortU1EL and
328 * tPort2PortU2EL, but it doesn't define what they are.
330 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
331 * about the same delays. Use the maximum delay calculations from those
332 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
333 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
334 * assume the device exit latencies they are talking about are the hub
337 * What do we do if the U2 exit latency is less than the U1 exit
338 * latency? It's possible, although not likely...
340 port_to_port_delay = 1;
342 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
343 hub, &udev->parent->u1_params, hub_u1_del,
346 if (hub_u2_del > hub_u1_del)
347 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
349 port_to_port_delay = 1 + hub_u1_del;
351 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
352 hub, &udev->parent->u2_params, hub_u2_del,
355 /* Now that we've got PEL, calculate SEL. */
356 usb_set_lpm_sel(udev, &udev->u1_params);
357 usb_set_lpm_sel(udev, &udev->u2_params);
360 /* USB 2.0 spec Section 11.24.4.5 */
361 static int get_hub_descriptor(struct usb_device *hdev, void *data)
366 if (hub_is_superspeed(hdev)) {
367 dtype = USB_DT_SS_HUB;
368 size = USB_DT_SS_HUB_SIZE;
371 size = sizeof(struct usb_hub_descriptor);
374 for (i = 0; i < 3; i++) {
375 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
376 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
377 dtype << 8, 0, data, size,
378 USB_CTRL_GET_TIMEOUT);
379 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
386 * USB 2.0 spec Section 11.24.2.1
388 static int clear_hub_feature(struct usb_device *hdev, int feature)
390 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
391 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
395 * USB 2.0 spec Section 11.24.2.2
397 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
399 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
400 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
405 * USB 2.0 spec Section 11.24.2.13
407 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
409 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
410 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
414 static char *to_led_name(int selector)
431 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
432 * for info about using port indicators
434 static void set_port_led(struct usb_hub *hub, int port1, int selector)
436 struct usb_port *port_dev = hub->ports[port1 - 1];
439 status = set_port_feature(hub->hdev, (selector << 8) | port1,
440 USB_PORT_FEAT_INDICATOR);
441 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
442 to_led_name(selector), status);
445 #define LED_CYCLE_PERIOD ((2*HZ)/3)
447 static void led_work(struct work_struct *work)
449 struct usb_hub *hub =
450 container_of(work, struct usb_hub, leds.work);
451 struct usb_device *hdev = hub->hdev;
453 unsigned changed = 0;
456 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
459 for (i = 0; i < hdev->maxchild; i++) {
460 unsigned selector, mode;
462 /* 30%-50% duty cycle */
464 switch (hub->indicator[i]) {
466 case INDICATOR_CYCLE:
468 selector = HUB_LED_AUTO;
469 mode = INDICATOR_AUTO;
471 /* blinking green = sw attention */
472 case INDICATOR_GREEN_BLINK:
473 selector = HUB_LED_GREEN;
474 mode = INDICATOR_GREEN_BLINK_OFF;
476 case INDICATOR_GREEN_BLINK_OFF:
477 selector = HUB_LED_OFF;
478 mode = INDICATOR_GREEN_BLINK;
480 /* blinking amber = hw attention */
481 case INDICATOR_AMBER_BLINK:
482 selector = HUB_LED_AMBER;
483 mode = INDICATOR_AMBER_BLINK_OFF;
485 case INDICATOR_AMBER_BLINK_OFF:
486 selector = HUB_LED_OFF;
487 mode = INDICATOR_AMBER_BLINK;
489 /* blink green/amber = reserved */
490 case INDICATOR_ALT_BLINK:
491 selector = HUB_LED_GREEN;
492 mode = INDICATOR_ALT_BLINK_OFF;
494 case INDICATOR_ALT_BLINK_OFF:
495 selector = HUB_LED_AMBER;
496 mode = INDICATOR_ALT_BLINK;
501 if (selector != HUB_LED_AUTO)
503 set_port_led(hub, i + 1, selector);
504 hub->indicator[i] = mode;
506 if (!changed && blinkenlights) {
508 cursor %= hdev->maxchild;
509 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
510 hub->indicator[cursor] = INDICATOR_CYCLE;
514 queue_delayed_work(system_power_efficient_wq,
515 &hub->leds, LED_CYCLE_PERIOD);
518 /* use a short timeout for hub/port status fetches */
519 #define USB_STS_TIMEOUT 1000
520 #define USB_STS_RETRIES 5
523 * USB 2.0 spec Section 11.24.2.6
525 static int get_hub_status(struct usb_device *hdev,
526 struct usb_hub_status *data)
528 int i, status = -ETIMEDOUT;
530 for (i = 0; i < USB_STS_RETRIES &&
531 (status == -ETIMEDOUT || status == -EPIPE); i++) {
532 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
533 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
534 data, sizeof(*data), USB_STS_TIMEOUT);
540 * USB 2.0 spec Section 11.24.2.7
542 static int get_port_status(struct usb_device *hdev, int port1,
543 struct usb_port_status *data)
545 int i, status = -ETIMEDOUT;
547 for (i = 0; i < USB_STS_RETRIES &&
548 (status == -ETIMEDOUT || status == -EPIPE); i++) {
549 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
550 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
551 data, sizeof(*data), USB_STS_TIMEOUT);
556 static int hub_port_status(struct usb_hub *hub, int port1,
557 u16 *status, u16 *change)
561 mutex_lock(&hub->status_mutex);
562 ret = get_port_status(hub->hdev, port1, &hub->status->port);
565 dev_err(hub->intfdev,
566 "%s failed (err = %d)\n", __func__, ret);
570 *status = le16_to_cpu(hub->status->port.wPortStatus);
571 *change = le16_to_cpu(hub->status->port.wPortChange);
575 mutex_unlock(&hub->status_mutex);
579 static void kick_hub_wq(struct usb_hub *hub)
581 struct usb_interface *intf;
583 if (hub->disconnected || work_pending(&hub->events))
587 * Suppress autosuspend until the event is proceed.
589 * Be careful and make sure that the symmetric operation is
590 * always called. We are here only when there is no pending
591 * work for this hub. Therefore put the interface either when
592 * the new work is called or when it is canceled.
594 intf = to_usb_interface(hub->intfdev);
595 usb_autopm_get_interface_no_resume(intf);
596 kref_get(&hub->kref);
598 if (queue_work(hub_wq, &hub->events))
601 /* the work has already been scheduled */
602 usb_autopm_put_interface_async(intf);
603 kref_put(&hub->kref, hub_release);
606 void usb_kick_hub_wq(struct usb_device *hdev)
608 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
615 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
616 * Notification, which indicates it had initiated remote wakeup.
618 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
619 * device initiates resume, so the USB core will not receive notice of the
620 * resume through the normal hub interrupt URB.
622 void usb_wakeup_notification(struct usb_device *hdev,
623 unsigned int portnum)
630 hub = usb_hub_to_struct_hub(hdev);
632 set_bit(portnum, hub->wakeup_bits);
636 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
638 /* completion function, fires on port status changes and various faults */
639 static void hub_irq(struct urb *urb)
641 struct usb_hub *hub = urb->context;
642 int status = urb->status;
647 case -ENOENT: /* synchronous unlink */
648 case -ECONNRESET: /* async unlink */
649 case -ESHUTDOWN: /* hardware going away */
652 default: /* presumably an error */
653 /* Cause a hub reset after 10 consecutive errors */
654 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
655 if ((++hub->nerrors < 10) || hub->error)
660 /* let hub_wq handle things */
661 case 0: /* we got data: port status changed */
663 for (i = 0; i < urb->actual_length; ++i)
664 bits |= ((unsigned long) ((*hub->buffer)[i]))
666 hub->event_bits[0] = bits;
672 /* Something happened, let hub_wq figure it out */
679 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
680 if (status != 0 && status != -ENODEV && status != -EPERM)
681 dev_err(hub->intfdev, "resubmit --> %d\n", status);
684 /* USB 2.0 spec Section 11.24.2.3 */
686 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
688 /* Need to clear both directions for control ep */
689 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
690 USB_ENDPOINT_XFER_CONTROL) {
691 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
692 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
693 devinfo ^ 0x8000, tt, NULL, 0, 1000);
697 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
698 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
703 * enumeration blocks hub_wq for a long time. we use keventd instead, since
704 * long blocking there is the exception, not the rule. accordingly, HCDs
705 * talking to TTs must queue control transfers (not just bulk and iso), so
706 * both can talk to the same hub concurrently.
708 static void hub_tt_work(struct work_struct *work)
710 struct usb_hub *hub =
711 container_of(work, struct usb_hub, tt.clear_work);
714 spin_lock_irqsave(&hub->tt.lock, flags);
715 while (!list_empty(&hub->tt.clear_list)) {
716 struct list_head *next;
717 struct usb_tt_clear *clear;
718 struct usb_device *hdev = hub->hdev;
719 const struct hc_driver *drv;
722 next = hub->tt.clear_list.next;
723 clear = list_entry(next, struct usb_tt_clear, clear_list);
724 list_del(&clear->clear_list);
726 /* drop lock so HCD can concurrently report other TT errors */
727 spin_unlock_irqrestore(&hub->tt.lock, flags);
728 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
729 if (status && status != -ENODEV)
731 "clear tt %d (%04x) error %d\n",
732 clear->tt, clear->devinfo, status);
734 /* Tell the HCD, even if the operation failed */
735 drv = clear->hcd->driver;
736 if (drv->clear_tt_buffer_complete)
737 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
740 spin_lock_irqsave(&hub->tt.lock, flags);
742 spin_unlock_irqrestore(&hub->tt.lock, flags);
746 * usb_hub_set_port_power - control hub port's power state
747 * @hdev: USB device belonging to the usb hub
750 * @set: expected status
752 * call this function to control port's power via setting or
753 * clearing the port's PORT_POWER feature.
755 * Return: 0 if successful. A negative error code otherwise.
757 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
763 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
765 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
771 set_bit(port1, hub->power_bits);
773 clear_bit(port1, hub->power_bits);
778 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
779 * @urb: an URB associated with the failed or incomplete split transaction
781 * High speed HCDs use this to tell the hub driver that some split control or
782 * bulk transaction failed in a way that requires clearing internal state of
783 * a transaction translator. This is normally detected (and reported) from
786 * It may not be possible for that hub to handle additional full (or low)
787 * speed transactions until that state is fully cleared out.
789 * Return: 0 if successful. A negative error code otherwise.
791 int usb_hub_clear_tt_buffer(struct urb *urb)
793 struct usb_device *udev = urb->dev;
794 int pipe = urb->pipe;
795 struct usb_tt *tt = udev->tt;
797 struct usb_tt_clear *clear;
799 /* we've got to cope with an arbitrary number of pending TT clears,
800 * since each TT has "at least two" buffers that can need it (and
801 * there can be many TTs per hub). even if they're uncommon.
803 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
805 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
806 /* FIXME recover somehow ... RESET_TT? */
810 /* info that CLEAR_TT_BUFFER needs */
811 clear->tt = tt->multi ? udev->ttport : 1;
812 clear->devinfo = usb_pipeendpoint (pipe);
813 clear->devinfo |= udev->devnum << 4;
814 clear->devinfo |= usb_pipecontrol(pipe)
815 ? (USB_ENDPOINT_XFER_CONTROL << 11)
816 : (USB_ENDPOINT_XFER_BULK << 11);
817 if (usb_pipein(pipe))
818 clear->devinfo |= 1 << 15;
820 /* info for completion callback */
821 clear->hcd = bus_to_hcd(udev->bus);
824 /* tell keventd to clear state for this TT */
825 spin_lock_irqsave(&tt->lock, flags);
826 list_add_tail(&clear->clear_list, &tt->clear_list);
827 schedule_work(&tt->clear_work);
828 spin_unlock_irqrestore(&tt->lock, flags);
831 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
833 static void hub_power_on(struct usb_hub *hub, bool do_delay)
837 /* Enable power on each port. Some hubs have reserved values
838 * of LPSM (> 2) in their descriptors, even though they are
839 * USB 2.0 hubs. Some hubs do not implement port-power switching
840 * but only emulate it. In all cases, the ports won't work
841 * unless we send these messages to the hub.
843 if (hub_is_port_power_switchable(hub))
844 dev_dbg(hub->intfdev, "enabling power on all ports\n");
846 dev_dbg(hub->intfdev, "trying to enable port power on "
847 "non-switchable hub\n");
848 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
849 if (test_bit(port1, hub->power_bits))
850 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
852 usb_clear_port_feature(hub->hdev, port1,
853 USB_PORT_FEAT_POWER);
855 msleep(hub_power_on_good_delay(hub));
858 static int hub_hub_status(struct usb_hub *hub,
859 u16 *status, u16 *change)
863 mutex_lock(&hub->status_mutex);
864 ret = get_hub_status(hub->hdev, &hub->status->hub);
867 dev_err(hub->intfdev,
868 "%s failed (err = %d)\n", __func__, ret);
870 *status = le16_to_cpu(hub->status->hub.wHubStatus);
871 *change = le16_to_cpu(hub->status->hub.wHubChange);
874 mutex_unlock(&hub->status_mutex);
878 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
879 unsigned int link_status)
881 return set_port_feature(hub->hdev,
882 port1 | (link_status << 3),
883 USB_PORT_FEAT_LINK_STATE);
887 * Disable a port and mark a logical connect-change event, so that some
888 * time later hub_wq will disconnect() any existing usb_device on the port
889 * and will re-enumerate if there actually is a device attached.
891 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
893 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
894 hub_port_disable(hub, port1, 1);
896 /* FIXME let caller ask to power down the port:
897 * - some devices won't enumerate without a VBUS power cycle
898 * - SRP saves power that way
899 * - ... new call, TBD ...
900 * That's easy if this hub can switch power per-port, and
901 * hub_wq reactivates the port later (timer, SRP, etc).
902 * Powerdown must be optional, because of reset/DFU.
905 set_bit(port1, hub->change_bits);
910 * usb_remove_device - disable a device's port on its parent hub
911 * @udev: device to be disabled and removed
912 * Context: @udev locked, must be able to sleep.
914 * After @udev's port has been disabled, hub_wq is notified and it will
915 * see that the device has been disconnected. When the device is
916 * physically unplugged and something is plugged in, the events will
917 * be received and processed normally.
919 * Return: 0 if successful. A negative error code otherwise.
921 int usb_remove_device(struct usb_device *udev)
924 struct usb_interface *intf;
926 if (!udev->parent) /* Can't remove a root hub */
928 hub = usb_hub_to_struct_hub(udev->parent);
929 intf = to_usb_interface(hub->intfdev);
931 usb_autopm_get_interface(intf);
932 set_bit(udev->portnum, hub->removed_bits);
933 hub_port_logical_disconnect(hub, udev->portnum);
934 usb_autopm_put_interface(intf);
938 enum hub_activation_type {
939 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
940 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
943 static void hub_init_func2(struct work_struct *ws);
944 static void hub_init_func3(struct work_struct *ws);
946 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
948 struct usb_device *hdev = hub->hdev;
953 bool need_debounce_delay = false;
956 /* Continue a partial initialization */
957 if (type == HUB_INIT2 || type == HUB_INIT3) {
958 device_lock(&hdev->dev);
960 /* Was the hub disconnected while we were waiting? */
961 if (hub->disconnected)
963 if (type == HUB_INIT2)
967 kref_get(&hub->kref);
969 /* The superspeed hub except for root hub has to use Hub Depth
970 * value as an offset into the route string to locate the bits
971 * it uses to determine the downstream port number. So hub driver
972 * should send a set hub depth request to superspeed hub after
973 * the superspeed hub is set configuration in initialization or
976 * After a resume, port power should still be on.
977 * For any other type of activation, turn it on.
979 if (type != HUB_RESUME) {
980 if (hdev->parent && hub_is_superspeed(hdev)) {
981 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
982 HUB_SET_DEPTH, USB_RT_HUB,
983 hdev->level - 1, 0, NULL, 0,
984 USB_CTRL_SET_TIMEOUT);
986 dev_err(hub->intfdev,
987 "set hub depth failed\n");
990 /* Speed up system boot by using a delayed_work for the
991 * hub's initial power-up delays. This is pretty awkward
992 * and the implementation looks like a home-brewed sort of
993 * setjmp/longjmp, but it saves at least 100 ms for each
994 * root hub (assuming usbcore is compiled into the kernel
995 * rather than as a module). It adds up.
997 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
998 * because for those activation types the ports have to be
999 * operational when we return. In theory this could be done
1000 * for HUB_POST_RESET, but it's easier not to.
1002 if (type == HUB_INIT) {
1003 delay = hub_power_on_good_delay(hub);
1005 hub_power_on(hub, false);
1006 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1007 queue_delayed_work(system_power_efficient_wq,
1009 msecs_to_jiffies(delay));
1011 /* Suppress autosuspend until init is done */
1012 usb_autopm_get_interface_no_resume(
1013 to_usb_interface(hub->intfdev));
1014 return; /* Continues at init2: below */
1015 } else if (type == HUB_RESET_RESUME) {
1016 /* The internal host controller state for the hub device
1017 * may be gone after a host power loss on system resume.
1018 * Update the device's info so the HW knows it's a hub.
1020 hcd = bus_to_hcd(hdev->bus);
1021 if (hcd->driver->update_hub_device) {
1022 ret = hcd->driver->update_hub_device(hcd, hdev,
1023 &hub->tt, GFP_NOIO);
1025 dev_err(hub->intfdev, "Host not "
1026 "accepting hub info "
1028 dev_err(hub->intfdev, "LS/FS devices "
1029 "and hubs may not work "
1030 "under this hub\n.");
1033 hub_power_on(hub, true);
1035 hub_power_on(hub, true);
1041 * Check each port and set hub->change_bits to let hub_wq know
1042 * which ports need attention.
1044 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1045 struct usb_port *port_dev = hub->ports[port1 - 1];
1046 struct usb_device *udev = port_dev->child;
1047 u16 portstatus, portchange;
1049 portstatus = portchange = 0;
1050 status = hub_port_status(hub, port1, &portstatus, &portchange);
1051 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1052 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1053 portstatus, portchange);
1056 * After anything other than HUB_RESUME (i.e., initialization
1057 * or any sort of reset), every port should be disabled.
1058 * Unconnected ports should likewise be disabled (paranoia),
1059 * and so should ports for which we have no usb_device.
1061 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1062 type != HUB_RESUME ||
1063 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1065 udev->state == USB_STATE_NOTATTACHED)) {
1067 * USB3 protocol ports will automatically transition
1068 * to Enabled state when detect an USB3.0 device attach.
1069 * Do not disable USB3 protocol ports, just pretend
1072 portstatus &= ~USB_PORT_STAT_ENABLE;
1073 if (!hub_is_superspeed(hdev))
1074 usb_clear_port_feature(hdev, port1,
1075 USB_PORT_FEAT_ENABLE);
1078 /* Clear status-change flags; we'll debounce later */
1079 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1080 need_debounce_delay = true;
1081 usb_clear_port_feature(hub->hdev, port1,
1082 USB_PORT_FEAT_C_CONNECTION);
1084 if (portchange & USB_PORT_STAT_C_ENABLE) {
1085 need_debounce_delay = true;
1086 usb_clear_port_feature(hub->hdev, port1,
1087 USB_PORT_FEAT_C_ENABLE);
1089 if (portchange & USB_PORT_STAT_C_RESET) {
1090 need_debounce_delay = true;
1091 usb_clear_port_feature(hub->hdev, port1,
1092 USB_PORT_FEAT_C_RESET);
1094 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1095 hub_is_superspeed(hub->hdev)) {
1096 need_debounce_delay = true;
1097 usb_clear_port_feature(hub->hdev, port1,
1098 USB_PORT_FEAT_C_BH_PORT_RESET);
1100 /* We can forget about a "removed" device when there's a
1101 * physical disconnect or the connect status changes.
1103 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1104 (portchange & USB_PORT_STAT_C_CONNECTION))
1105 clear_bit(port1, hub->removed_bits);
1107 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1108 /* Tell hub_wq to disconnect the device or
1109 * check for a new connection
1111 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1112 (portstatus & USB_PORT_STAT_OVERCURRENT))
1113 set_bit(port1, hub->change_bits);
1115 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1116 bool port_resumed = (portstatus &
1117 USB_PORT_STAT_LINK_STATE) ==
1119 /* The power session apparently survived the resume.
1120 * If there was an overcurrent or suspend change
1121 * (i.e., remote wakeup request), have hub_wq
1122 * take care of it. Look at the port link state
1123 * for USB 3.0 hubs, since they don't have a suspend
1124 * change bit, and they don't set the port link change
1125 * bit on device-initiated resume.
1127 if (portchange || (hub_is_superspeed(hub->hdev) &&
1129 set_bit(port1, hub->change_bits);
1131 } else if (udev->persist_enabled) {
1133 udev->reset_resume = 1;
1135 /* Don't set the change_bits when the device
1138 if (test_bit(port1, hub->power_bits))
1139 set_bit(port1, hub->change_bits);
1142 /* The power session is gone; tell hub_wq */
1143 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1144 set_bit(port1, hub->change_bits);
1148 /* If no port-status-change flags were set, we don't need any
1149 * debouncing. If flags were set we can try to debounce the
1150 * ports all at once right now, instead of letting hub_wq do them
1151 * one at a time later on.
1153 * If any port-status changes do occur during this delay, hub_wq
1154 * will see them later and handle them normally.
1156 if (need_debounce_delay) {
1157 delay = HUB_DEBOUNCE_STABLE;
1159 /* Don't do a long sleep inside a workqueue routine */
1160 if (type == HUB_INIT2) {
1161 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1162 queue_delayed_work(system_power_efficient_wq,
1164 msecs_to_jiffies(delay));
1165 device_unlock(&hdev->dev);
1166 return; /* Continues at init3: below */
1174 status = usb_submit_urb(hub->urb, GFP_NOIO);
1176 dev_err(hub->intfdev, "activate --> %d\n", status);
1177 if (hub->has_indicators && blinkenlights)
1178 queue_delayed_work(system_power_efficient_wq,
1179 &hub->leds, LED_CYCLE_PERIOD);
1181 /* Scan all ports that need attention */
1184 if (type == HUB_INIT2 || type == HUB_INIT3) {
1185 /* Allow autosuspend if it was suppressed */
1187 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1188 device_unlock(&hdev->dev);
1191 kref_put(&hub->kref, hub_release);
1194 /* Implement the continuations for the delays above */
1195 static void hub_init_func2(struct work_struct *ws)
1197 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1199 hub_activate(hub, HUB_INIT2);
1202 static void hub_init_func3(struct work_struct *ws)
1204 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1206 hub_activate(hub, HUB_INIT3);
1209 enum hub_quiescing_type {
1210 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1213 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1215 struct usb_device *hdev = hub->hdev;
1218 /* hub_wq and related activity won't re-trigger */
1221 if (type != HUB_SUSPEND) {
1222 /* Disconnect all the children */
1223 for (i = 0; i < hdev->maxchild; ++i) {
1224 if (hub->ports[i]->child)
1225 usb_disconnect(&hub->ports[i]->child);
1229 /* Stop hub_wq and related activity */
1230 usb_kill_urb(hub->urb);
1231 if (hub->has_indicators)
1232 cancel_delayed_work_sync(&hub->leds);
1234 flush_work(&hub->tt.clear_work);
1237 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1241 for (i = 0; i < hub->hdev->maxchild; ++i)
1242 pm_runtime_barrier(&hub->ports[i]->dev);
1245 /* caller has locked the hub device */
1246 static int hub_pre_reset(struct usb_interface *intf)
1248 struct usb_hub *hub = usb_get_intfdata(intf);
1250 hub_quiesce(hub, HUB_PRE_RESET);
1252 hub_pm_barrier_for_all_ports(hub);
1256 /* caller has locked the hub device */
1257 static int hub_post_reset(struct usb_interface *intf)
1259 struct usb_hub *hub = usb_get_intfdata(intf);
1262 hub_pm_barrier_for_all_ports(hub);
1263 hub_activate(hub, HUB_POST_RESET);
1267 static int hub_configure(struct usb_hub *hub,
1268 struct usb_endpoint_descriptor *endpoint)
1270 struct usb_hcd *hcd;
1271 struct usb_device *hdev = hub->hdev;
1272 struct device *hub_dev = hub->intfdev;
1273 u16 hubstatus, hubchange;
1274 u16 wHubCharacteristics;
1277 char *message = "out of memory";
1282 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1288 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1293 mutex_init(&hub->status_mutex);
1295 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1296 if (!hub->descriptor) {
1301 /* Request the entire hub descriptor.
1302 * hub->descriptor can handle USB_MAXCHILDREN ports,
1303 * but the hub can/will return fewer bytes here.
1305 ret = get_hub_descriptor(hdev, hub->descriptor);
1307 message = "can't read hub descriptor";
1309 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1310 message = "hub has too many ports!";
1313 } else if (hub->descriptor->bNbrPorts == 0) {
1314 message = "hub doesn't have any ports!";
1319 maxchild = hub->descriptor->bNbrPorts;
1320 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1321 (maxchild == 1) ? "" : "s");
1323 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1329 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1330 if (hub_is_superspeed(hdev)) {
1338 /* FIXME for USB 3.0, skip for now */
1339 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1340 !(hub_is_superspeed(hdev))) {
1341 char portstr[USB_MAXCHILDREN + 1];
1343 for (i = 0; i < maxchild; i++)
1344 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1345 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1347 portstr[maxchild] = 0;
1348 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1350 dev_dbg(hub_dev, "standalone hub\n");
1352 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1353 case HUB_CHAR_COMMON_LPSM:
1354 dev_dbg(hub_dev, "ganged power switching\n");
1356 case HUB_CHAR_INDV_PORT_LPSM:
1357 dev_dbg(hub_dev, "individual port power switching\n");
1359 case HUB_CHAR_NO_LPSM:
1361 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1365 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1366 case HUB_CHAR_COMMON_OCPM:
1367 dev_dbg(hub_dev, "global over-current protection\n");
1369 case HUB_CHAR_INDV_PORT_OCPM:
1370 dev_dbg(hub_dev, "individual port over-current protection\n");
1372 case HUB_CHAR_NO_OCPM:
1374 dev_dbg(hub_dev, "no over-current protection\n");
1378 spin_lock_init(&hub->tt.lock);
1379 INIT_LIST_HEAD(&hub->tt.clear_list);
1380 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1381 switch (hdev->descriptor.bDeviceProtocol) {
1384 case USB_HUB_PR_HS_SINGLE_TT:
1385 dev_dbg(hub_dev, "Single TT\n");
1388 case USB_HUB_PR_HS_MULTI_TT:
1389 ret = usb_set_interface(hdev, 0, 1);
1391 dev_dbg(hub_dev, "TT per port\n");
1394 dev_err(hub_dev, "Using single TT (err %d)\n",
1399 /* USB 3.0 hubs don't have a TT */
1402 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1403 hdev->descriptor.bDeviceProtocol);
1407 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1408 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1409 case HUB_TTTT_8_BITS:
1410 if (hdev->descriptor.bDeviceProtocol != 0) {
1411 hub->tt.think_time = 666;
1412 dev_dbg(hub_dev, "TT requires at most %d "
1413 "FS bit times (%d ns)\n",
1414 8, hub->tt.think_time);
1417 case HUB_TTTT_16_BITS:
1418 hub->tt.think_time = 666 * 2;
1419 dev_dbg(hub_dev, "TT requires at most %d "
1420 "FS bit times (%d ns)\n",
1421 16, hub->tt.think_time);
1423 case HUB_TTTT_24_BITS:
1424 hub->tt.think_time = 666 * 3;
1425 dev_dbg(hub_dev, "TT requires at most %d "
1426 "FS bit times (%d ns)\n",
1427 24, hub->tt.think_time);
1429 case HUB_TTTT_32_BITS:
1430 hub->tt.think_time = 666 * 4;
1431 dev_dbg(hub_dev, "TT requires at most %d "
1432 "FS bit times (%d ns)\n",
1433 32, hub->tt.think_time);
1437 /* probe() zeroes hub->indicator[] */
1438 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1439 hub->has_indicators = 1;
1440 dev_dbg(hub_dev, "Port indicators are supported\n");
1443 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1444 hub->descriptor->bPwrOn2PwrGood * 2);
1446 /* power budgeting mostly matters with bus-powered hubs,
1447 * and battery-powered root hubs (may provide just 8 mA).
1449 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1451 message = "can't get hub status";
1454 hcd = bus_to_hcd(hdev->bus);
1455 if (hdev == hdev->bus->root_hub) {
1456 if (hcd->power_budget > 0)
1457 hdev->bus_mA = hcd->power_budget;
1459 hdev->bus_mA = full_load * maxchild;
1460 if (hdev->bus_mA >= full_load)
1461 hub->mA_per_port = full_load;
1463 hub->mA_per_port = hdev->bus_mA;
1464 hub->limited_power = 1;
1466 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1467 int remaining = hdev->bus_mA -
1468 hub->descriptor->bHubContrCurrent;
1470 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1471 hub->descriptor->bHubContrCurrent);
1472 hub->limited_power = 1;
1474 if (remaining < maxchild * unit_load)
1476 "insufficient power available "
1477 "to use all downstream ports\n");
1478 hub->mA_per_port = unit_load; /* 7.2.1 */
1480 } else { /* Self-powered external hub */
1481 /* FIXME: What about battery-powered external hubs that
1482 * provide less current per port? */
1483 hub->mA_per_port = full_load;
1485 if (hub->mA_per_port < full_load)
1486 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1489 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1491 message = "can't get hub status";
1495 /* local power status reports aren't always correct */
1496 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1497 dev_dbg(hub_dev, "local power source is %s\n",
1498 (hubstatus & HUB_STATUS_LOCAL_POWER)
1499 ? "lost (inactive)" : "good");
1501 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1502 dev_dbg(hub_dev, "%sover-current condition exists\n",
1503 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1505 /* set up the interrupt endpoint
1506 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1507 * bytes as USB2.0[11.12.3] says because some hubs are known
1508 * to send more data (and thus cause overflow). For root hubs,
1509 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1510 * to be big enough for at least USB_MAXCHILDREN ports. */
1511 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1512 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1514 if (maxp > sizeof(*hub->buffer))
1515 maxp = sizeof(*hub->buffer);
1517 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1523 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1524 hub, endpoint->bInterval);
1526 /* maybe cycle the hub leds */
1527 if (hub->has_indicators && blinkenlights)
1528 hub->indicator[0] = INDICATOR_CYCLE;
1530 mutex_lock(&usb_port_peer_mutex);
1531 for (i = 0; i < maxchild; i++) {
1532 ret = usb_hub_create_port_device(hub, i + 1);
1534 dev_err(hub->intfdev,
1535 "couldn't create port%d device.\n", i + 1);
1540 for (i = 0; i < hdev->maxchild; i++) {
1541 struct usb_port *port_dev = hub->ports[i];
1543 pm_runtime_put(&port_dev->dev);
1546 mutex_unlock(&usb_port_peer_mutex);
1550 /* Update the HCD's internal representation of this hub before hub_wq
1551 * starts getting port status changes for devices under the hub.
1553 if (hcd->driver->update_hub_device) {
1554 ret = hcd->driver->update_hub_device(hcd, hdev,
1555 &hub->tt, GFP_KERNEL);
1557 message = "can't update HCD hub info";
1562 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1564 hub_activate(hub, HUB_INIT);
1568 dev_err(hub_dev, "config failed, %s (err %d)\n",
1570 /* hub_disconnect() frees urb and descriptor */
1574 static void hub_release(struct kref *kref)
1576 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1578 usb_put_dev(hub->hdev);
1579 usb_put_intf(to_usb_interface(hub->intfdev));
1583 static unsigned highspeed_hubs;
1585 static void hub_disconnect(struct usb_interface *intf)
1587 struct usb_hub *hub = usb_get_intfdata(intf);
1588 struct usb_device *hdev = interface_to_usbdev(intf);
1592 * Stop adding new hub events. We do not want to block here and thus
1593 * will not try to remove any pending work item.
1595 hub->disconnected = 1;
1597 /* Disconnect all children and quiesce the hub */
1599 hub_quiesce(hub, HUB_DISCONNECT);
1601 mutex_lock(&usb_port_peer_mutex);
1603 /* Avoid races with recursively_mark_NOTATTACHED() */
1604 spin_lock_irq(&device_state_lock);
1605 port1 = hdev->maxchild;
1607 usb_set_intfdata(intf, NULL);
1608 spin_unlock_irq(&device_state_lock);
1610 for (; port1 > 0; --port1)
1611 usb_hub_remove_port_device(hub, port1);
1613 mutex_unlock(&usb_port_peer_mutex);
1615 if (hub->hdev->speed == USB_SPEED_HIGH)
1618 usb_free_urb(hub->urb);
1620 kfree(hub->descriptor);
1624 pm_suspend_ignore_children(&intf->dev, false);
1625 kref_put(&hub->kref, hub_release);
1628 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1630 struct usb_host_interface *desc;
1631 struct usb_endpoint_descriptor *endpoint;
1632 struct usb_device *hdev;
1633 struct usb_hub *hub;
1635 desc = intf->cur_altsetting;
1636 hdev = interface_to_usbdev(intf);
1639 * Set default autosuspend delay as 0 to speedup bus suspend,
1640 * based on the below considerations:
1642 * - Unlike other drivers, the hub driver does not rely on the
1643 * autosuspend delay to provide enough time to handle a wakeup
1644 * event, and the submitted status URB is just to check future
1645 * change on hub downstream ports, so it is safe to do it.
1647 * - The patch might cause one or more auto supend/resume for
1648 * below very rare devices when they are plugged into hub
1651 * devices having trouble initializing, and disconnect
1652 * themselves from the bus and then reconnect a second
1655 * devices just for downloading firmware, and disconnects
1656 * themselves after completing it
1658 * For these quite rare devices, their drivers may change the
1659 * autosuspend delay of their parent hub in the probe() to one
1660 * appropriate value to avoid the subtle problem if someone
1663 * - The patch may cause one or more auto suspend/resume on
1664 * hub during running 'lsusb', but it is probably too
1665 * infrequent to worry about.
1667 * - Change autosuspend delay of hub can avoid unnecessary auto
1668 * suspend timer for hub, also may decrease power consumption
1671 * - If user has indicated to prevent autosuspend by passing
1672 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1675 if (hdev->dev.power.autosuspend_delay >= 0)
1676 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1680 * Hubs have proper suspend/resume support, except for root hubs
1681 * where the controller driver doesn't have bus_suspend and
1682 * bus_resume methods.
1684 if (hdev->parent) { /* normal device */
1685 if (!(hdev->parent->quirks & USB_QUIRK_AUTO_SUSPEND))
1686 usb_enable_autosuspend(hdev);
1687 } else { /* root hub */
1688 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1690 if (drv->bus_suspend && drv->bus_resume)
1691 usb_enable_autosuspend(hdev);
1694 if (hdev->level == MAX_TOPO_LEVEL) {
1696 "Unsupported bus topology: hub nested too deep\n");
1700 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1702 dev_warn(&intf->dev, "ignoring external hub\n");
1707 /* Some hubs have a subclass of 1, which AFAICT according to the */
1708 /* specs is not defined, but it works */
1709 if ((desc->desc.bInterfaceSubClass != 0) &&
1710 (desc->desc.bInterfaceSubClass != 1)) {
1712 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1716 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1717 if (desc->desc.bNumEndpoints != 1)
1718 goto descriptor_error;
1720 endpoint = &desc->endpoint[0].desc;
1722 /* If it's not an interrupt in endpoint, we'd better punt! */
1723 if (!usb_endpoint_is_int_in(endpoint))
1724 goto descriptor_error;
1726 /* We found a hub */
1727 dev_info(&intf->dev, "USB hub found\n");
1729 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1731 dev_dbg(&intf->dev, "couldn't kmalloc hub struct\n");
1735 kref_init(&hub->kref);
1736 hub->intfdev = &intf->dev;
1738 INIT_DELAYED_WORK(&hub->leds, led_work);
1739 INIT_DELAYED_WORK(&hub->init_work, NULL);
1740 INIT_WORK(&hub->events, hub_event);
1744 usb_set_intfdata(intf, hub);
1745 intf->needs_remote_wakeup = 1;
1746 pm_suspend_ignore_children(&intf->dev, true);
1748 if (hdev->speed == USB_SPEED_HIGH)
1751 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1752 hub->quirk_check_port_auto_suspend = 1;
1754 if (hub_configure(hub, endpoint) >= 0)
1757 hub_disconnect(intf);
1762 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1764 struct usb_device *hdev = interface_to_usbdev(intf);
1765 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1767 /* assert ifno == 0 (part of hub spec) */
1769 case USBDEVFS_HUB_PORTINFO: {
1770 struct usbdevfs_hub_portinfo *info = user_data;
1773 spin_lock_irq(&device_state_lock);
1774 if (hdev->devnum <= 0)
1777 info->nports = hdev->maxchild;
1778 for (i = 0; i < info->nports; i++) {
1779 if (hub->ports[i]->child == NULL)
1783 hub->ports[i]->child->devnum;
1786 spin_unlock_irq(&device_state_lock);
1788 return info->nports + 1;
1797 * Allow user programs to claim ports on a hub. When a device is attached
1798 * to one of these "claimed" ports, the program will "own" the device.
1800 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1801 struct usb_dev_state ***ppowner)
1803 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1805 if (hdev->state == USB_STATE_NOTATTACHED)
1807 if (port1 == 0 || port1 > hdev->maxchild)
1810 /* Devices not managed by the hub driver
1811 * will always have maxchild equal to 0.
1813 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1817 /* In the following three functions, the caller must hold hdev's lock */
1818 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1819 struct usb_dev_state *owner)
1822 struct usb_dev_state **powner;
1824 rc = find_port_owner(hdev, port1, &powner);
1832 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1834 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1835 struct usb_dev_state *owner)
1838 struct usb_dev_state **powner;
1840 rc = find_port_owner(hdev, port1, &powner);
1843 if (*powner != owner)
1848 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1850 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1852 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1855 for (n = 0; n < hdev->maxchild; n++) {
1856 if (hub->ports[n]->port_owner == owner)
1857 hub->ports[n]->port_owner = NULL;
1862 /* The caller must hold udev's lock */
1863 bool usb_device_is_owned(struct usb_device *udev)
1865 struct usb_hub *hub;
1867 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1869 hub = usb_hub_to_struct_hub(udev->parent);
1870 return !!hub->ports[udev->portnum - 1]->port_owner;
1873 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1875 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1878 for (i = 0; i < udev->maxchild; ++i) {
1879 if (hub->ports[i]->child)
1880 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1882 if (udev->state == USB_STATE_SUSPENDED)
1883 udev->active_duration -= jiffies;
1884 udev->state = USB_STATE_NOTATTACHED;
1888 * usb_set_device_state - change a device's current state (usbcore, hcds)
1889 * @udev: pointer to device whose state should be changed
1890 * @new_state: new state value to be stored
1892 * udev->state is _not_ fully protected by the device lock. Although
1893 * most transitions are made only while holding the lock, the state can
1894 * can change to USB_STATE_NOTATTACHED at almost any time. This
1895 * is so that devices can be marked as disconnected as soon as possible,
1896 * without having to wait for any semaphores to be released. As a result,
1897 * all changes to any device's state must be protected by the
1898 * device_state_lock spinlock.
1900 * Once a device has been added to the device tree, all changes to its state
1901 * should be made using this routine. The state should _not_ be set directly.
1903 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1904 * Otherwise udev->state is set to new_state, and if new_state is
1905 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1906 * to USB_STATE_NOTATTACHED.
1908 void usb_set_device_state(struct usb_device *udev,
1909 enum usb_device_state new_state)
1911 unsigned long flags;
1914 spin_lock_irqsave(&device_state_lock, flags);
1915 if (udev->state == USB_STATE_NOTATTACHED)
1917 else if (new_state != USB_STATE_NOTATTACHED) {
1919 /* root hub wakeup capabilities are managed out-of-band
1920 * and may involve silicon errata ... ignore them here.
1923 if (udev->state == USB_STATE_SUSPENDED
1924 || new_state == USB_STATE_SUSPENDED)
1925 ; /* No change to wakeup settings */
1926 else if (new_state == USB_STATE_CONFIGURED)
1927 wakeup = (udev->quirks &
1928 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1929 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 /* be safe when more hub events are proceed in parallel */
1984 mutex_lock(&bus->devnum_next_mutex);
1986 devnum = udev->portnum + 1;
1987 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1989 /* Try to allocate the next devnum beginning at
1990 * bus->devnum_next. */
1991 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1994 devnum = find_next_zero_bit(bus->devmap.devicemap,
1996 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
1999 set_bit(devnum, bus->devmap.devicemap);
2000 udev->devnum = devnum;
2002 mutex_unlock(&bus->devnum_next_mutex);
2005 static void release_devnum(struct usb_device *udev)
2007 if (udev->devnum > 0) {
2008 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2013 static void update_devnum(struct usb_device *udev, int devnum)
2015 /* The address for a WUSB device is managed by wusbcore. */
2017 udev->devnum = devnum;
2020 static void hub_free_dev(struct usb_device *udev)
2022 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2024 /* Root hubs aren't real devices, so don't free HCD resources */
2025 if (hcd->driver->free_dev && udev->parent)
2026 hcd->driver->free_dev(hcd, udev);
2029 static void hub_disconnect_children(struct usb_device *udev)
2031 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2034 /* Free up all the children before we remove this device */
2035 for (i = 0; i < udev->maxchild; i++) {
2036 if (hub->ports[i]->child)
2037 usb_disconnect(&hub->ports[i]->child);
2042 * usb_disconnect - disconnect a device (usbcore-internal)
2043 * @pdev: pointer to device being disconnected
2044 * Context: !in_interrupt ()
2046 * Something got disconnected. Get rid of it and all of its children.
2048 * If *pdev is a normal device then the parent hub must already be locked.
2049 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2050 * which protects the set of root hubs as well as the list of buses.
2052 * Only hub drivers (including virtual root hub drivers for host
2053 * controllers) should ever call this.
2055 * This call is synchronous, and may not be used in an interrupt context.
2057 void usb_disconnect(struct usb_device **pdev)
2059 struct usb_port *port_dev = NULL;
2060 struct usb_device *udev = *pdev;
2061 struct usb_hub *hub = NULL;
2064 /* mark the device as inactive, so any further urb submissions for
2065 * this device (and any of its children) will fail immediately.
2066 * this quiesces everything except pending urbs.
2068 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2069 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2072 usb_lock_device(udev);
2074 hub_disconnect_children(udev);
2076 /* deallocate hcd/hardware state ... nuking all pending urbs and
2077 * cleaning up all state associated with the current configuration
2078 * so that the hardware is now fully quiesced.
2080 dev_dbg(&udev->dev, "unregistering device\n");
2081 usb_disable_device(udev, 0);
2082 usb_hcd_synchronize_unlinks(udev);
2085 port1 = udev->portnum;
2086 hub = usb_hub_to_struct_hub(udev->parent);
2087 port_dev = hub->ports[port1 - 1];
2089 sysfs_remove_link(&udev->dev.kobj, "port");
2090 sysfs_remove_link(&port_dev->dev.kobj, "device");
2093 * As usb_port_runtime_resume() de-references udev, make
2094 * sure no resumes occur during removal
2096 if (!test_and_set_bit(port1, hub->child_usage_bits))
2097 pm_runtime_get_sync(&port_dev->dev);
2100 usb_remove_ep_devs(&udev->ep0);
2101 usb_unlock_device(udev);
2103 /* Unregister the device. The device driver is responsible
2104 * for de-configuring the device and invoking the remove-device
2105 * notifier chain (used by usbfs and possibly others).
2107 device_del(&udev->dev);
2109 /* Free the device number and delete the parent's children[]
2110 * (or root_hub) pointer.
2112 release_devnum(udev);
2114 /* Avoid races with recursively_mark_NOTATTACHED() */
2115 spin_lock_irq(&device_state_lock);
2117 spin_unlock_irq(&device_state_lock);
2119 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2120 pm_runtime_put(&port_dev->dev);
2124 put_device(&udev->dev);
2127 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2128 static void show_string(struct usb_device *udev, char *id, char *string)
2132 dev_info(&udev->dev, "%s: %s\n", id, string);
2135 static void announce_device(struct usb_device *udev)
2137 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2138 le16_to_cpu(udev->descriptor.idVendor),
2139 le16_to_cpu(udev->descriptor.idProduct));
2140 dev_info(&udev->dev,
2141 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2142 udev->descriptor.iManufacturer,
2143 udev->descriptor.iProduct,
2144 udev->descriptor.iSerialNumber);
2145 show_string(udev, "Product", udev->product);
2146 show_string(udev, "Manufacturer", udev->manufacturer);
2147 show_string(udev, "SerialNumber", udev->serial);
2150 static inline void announce_device(struct usb_device *udev) { }
2155 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2156 * @udev: newly addressed device (in ADDRESS state)
2158 * Finish enumeration for On-The-Go devices
2160 * Return: 0 if successful. A negative error code otherwise.
2162 static int usb_enumerate_device_otg(struct usb_device *udev)
2166 #ifdef CONFIG_USB_OTG
2168 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2169 * to wake us after we've powered off VBUS; and HNP, switching roles
2170 * "host" to "peripheral". The OTG descriptor helps figure this out.
2172 if (!udev->bus->is_b_host
2174 && udev->parent == udev->bus->root_hub) {
2175 struct usb_otg_descriptor *desc = NULL;
2176 struct usb_bus *bus = udev->bus;
2177 unsigned port1 = udev->portnum;
2179 /* descriptor may appear anywhere in config */
2180 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2181 le16_to_cpu(udev->config[0].desc.wTotalLength),
2182 USB_DT_OTG, (void **) &desc);
2183 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2186 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2187 (port1 == bus->otg_port) ? "" : "non-");
2189 /* enable HNP before suspend, it's simpler */
2190 if (port1 == bus->otg_port) {
2191 bus->b_hnp_enable = 1;
2192 err = usb_control_msg(udev,
2193 usb_sndctrlpipe(udev, 0),
2194 USB_REQ_SET_FEATURE, 0,
2195 USB_DEVICE_B_HNP_ENABLE,
2197 USB_CTRL_SET_TIMEOUT);
2200 * OTG MESSAGE: report errors here,
2201 * customize to match your product.
2203 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2205 bus->b_hnp_enable = 0;
2207 } else if (desc->bLength == sizeof
2208 (struct usb_otg_descriptor)) {
2209 /* Set a_alt_hnp_support for legacy otg device */
2210 err = usb_control_msg(udev,
2211 usb_sndctrlpipe(udev, 0),
2212 USB_REQ_SET_FEATURE, 0,
2213 USB_DEVICE_A_ALT_HNP_SUPPORT,
2215 USB_CTRL_SET_TIMEOUT);
2218 "set a_alt_hnp_support failed: %d\n",
2228 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2229 * @udev: newly addressed device (in ADDRESS state)
2231 * This is only called by usb_new_device() and usb_authorize_device()
2232 * and FIXME -- all comments that apply to them apply here wrt to
2235 * If the device is WUSB and not authorized, we don't attempt to read
2236 * the string descriptors, as they will be errored out by the device
2237 * until it has been authorized.
2239 * Return: 0 if successful. A negative error code otherwise.
2241 static int usb_enumerate_device(struct usb_device *udev)
2244 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2246 if (udev->config == NULL) {
2247 err = usb_get_configuration(udev);
2250 dev_err(&udev->dev, "can't read configurations, error %d\n",
2256 /* read the standard strings and cache them if present */
2257 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2258 udev->manufacturer = usb_cache_string(udev,
2259 udev->descriptor.iManufacturer);
2260 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2262 err = usb_enumerate_device_otg(udev);
2266 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2267 !is_targeted(udev)) {
2268 /* Maybe it can talk to us, though we can't talk to it.
2269 * (Includes HNP test device.)
2271 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2272 || udev->bus->is_b_host)) {
2273 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2275 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2280 usb_detect_interface_quirks(udev);
2285 static void set_usb_port_removable(struct usb_device *udev)
2287 struct usb_device *hdev = udev->parent;
2288 struct usb_hub *hub;
2289 u8 port = udev->portnum;
2290 u16 wHubCharacteristics;
2291 bool removable = true;
2296 hub = usb_hub_to_struct_hub(udev->parent);
2299 * If the platform firmware has provided information about a port,
2300 * use that to determine whether it's removable.
2302 switch (hub->ports[udev->portnum - 1]->connect_type) {
2303 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2304 udev->removable = USB_DEVICE_REMOVABLE;
2306 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2307 case USB_PORT_NOT_USED:
2308 udev->removable = USB_DEVICE_FIXED;
2315 * Otherwise, check whether the hub knows whether a port is removable
2318 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2320 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2323 if (hub_is_superspeed(hdev)) {
2324 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2328 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2333 udev->removable = USB_DEVICE_REMOVABLE;
2335 udev->removable = USB_DEVICE_FIXED;
2340 * usb_new_device - perform initial device setup (usbcore-internal)
2341 * @udev: newly addressed device (in ADDRESS state)
2343 * This is called with devices which have been detected but not fully
2344 * enumerated. The device descriptor is available, but not descriptors
2345 * for any device configuration. The caller must have locked either
2346 * the parent hub (if udev is a normal device) or else the
2347 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2348 * udev has already been installed, but udev is not yet visible through
2349 * sysfs or other filesystem code.
2351 * This call is synchronous, and may not be used in an interrupt context.
2353 * Only the hub driver or root-hub registrar should ever call this.
2355 * Return: Whether the device is configured properly or not. Zero if the
2356 * interface was registered with the driver core; else a negative errno
2360 int usb_new_device(struct usb_device *udev)
2365 /* Initialize non-root-hub device wakeup to disabled;
2366 * device (un)configuration controls wakeup capable
2367 * sysfs power/wakeup controls wakeup enabled/disabled
2369 device_init_wakeup(&udev->dev, 0);
2372 /* Tell the runtime-PM framework the device is active */
2373 pm_runtime_set_active(&udev->dev);
2374 pm_runtime_get_noresume(&udev->dev);
2375 pm_runtime_use_autosuspend(&udev->dev);
2376 pm_runtime_enable(&udev->dev);
2378 /* By default, forbid autosuspend for all devices. It will be
2379 * allowed for hubs during binding.
2381 usb_disable_autosuspend(udev);
2383 err = usb_enumerate_device(udev); /* Read descriptors */
2386 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2387 udev->devnum, udev->bus->busnum,
2388 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2389 /* export the usbdev device-node for libusb */
2390 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2391 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2393 /* Tell the world! */
2394 announce_device(udev);
2397 add_device_randomness(udev->serial, strlen(udev->serial));
2399 add_device_randomness(udev->product, strlen(udev->product));
2400 if (udev->manufacturer)
2401 add_device_randomness(udev->manufacturer,
2402 strlen(udev->manufacturer));
2404 device_enable_async_suspend(&udev->dev);
2406 /* check whether the hub or firmware marks this port as non-removable */
2408 set_usb_port_removable(udev);
2410 /* Register the device. The device driver is responsible
2411 * for configuring the device and invoking the add-device
2412 * notifier chain (used by usbfs and possibly others).
2414 err = device_add(&udev->dev);
2416 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2420 /* Create link files between child device and usb port device. */
2422 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2423 int port1 = udev->portnum;
2424 struct usb_port *port_dev = hub->ports[port1 - 1];
2426 err = sysfs_create_link(&udev->dev.kobj,
2427 &port_dev->dev.kobj, "port");
2431 err = sysfs_create_link(&port_dev->dev.kobj,
2432 &udev->dev.kobj, "device");
2434 sysfs_remove_link(&udev->dev.kobj, "port");
2438 if (!test_and_set_bit(port1, hub->child_usage_bits))
2439 pm_runtime_get_sync(&port_dev->dev);
2442 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2443 usb_mark_last_busy(udev);
2444 pm_runtime_put_sync_autosuspend(&udev->dev);
2448 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2449 pm_runtime_disable(&udev->dev);
2450 pm_runtime_set_suspended(&udev->dev);
2456 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2457 * @usb_dev: USB device
2459 * Move the USB device to a very basic state where interfaces are disabled
2460 * and the device is in fact unconfigured and unusable.
2462 * We share a lock (that we have) with device_del(), so we need to
2467 int usb_deauthorize_device(struct usb_device *usb_dev)
2469 usb_lock_device(usb_dev);
2470 if (usb_dev->authorized == 0)
2471 goto out_unauthorized;
2473 usb_dev->authorized = 0;
2474 usb_set_configuration(usb_dev, -1);
2477 usb_unlock_device(usb_dev);
2482 int usb_authorize_device(struct usb_device *usb_dev)
2486 usb_lock_device(usb_dev);
2487 if (usb_dev->authorized == 1)
2488 goto out_authorized;
2490 result = usb_autoresume_device(usb_dev);
2492 dev_err(&usb_dev->dev,
2493 "can't autoresume for authorization: %d\n", result);
2494 goto error_autoresume;
2497 if (usb_dev->wusb) {
2498 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2500 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2501 "authorization: %d\n", result);
2502 goto error_device_descriptor;
2506 usb_dev->authorized = 1;
2507 /* Choose and set the configuration. This registers the interfaces
2508 * with the driver core and lets interface drivers bind to them.
2510 c = usb_choose_configuration(usb_dev);
2512 result = usb_set_configuration(usb_dev, c);
2514 dev_err(&usb_dev->dev,
2515 "can't set config #%d, error %d\n", c, result);
2516 /* This need not be fatal. The user can try to
2517 * set other configurations. */
2520 dev_info(&usb_dev->dev, "authorized to connect\n");
2522 error_device_descriptor:
2523 usb_autosuspend_device(usb_dev);
2526 usb_unlock_device(usb_dev); /* complements locktree */
2531 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2532 static unsigned hub_is_wusb(struct usb_hub *hub)
2534 struct usb_hcd *hcd;
2535 if (hub->hdev->parent != NULL) /* not a root hub? */
2537 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2538 return hcd->wireless;
2542 #define PORT_RESET_TRIES 5
2543 #define SET_ADDRESS_TRIES 2
2544 #define GET_DESCRIPTOR_TRIES 2
2545 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2546 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2548 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2549 #define HUB_SHORT_RESET_TIME 10
2550 #define HUB_BH_RESET_TIME 50
2551 #define HUB_LONG_RESET_TIME 200
2552 #define HUB_RESET_TIMEOUT 800
2555 * "New scheme" enumeration causes an extra state transition to be
2556 * exposed to an xhci host and causes USB3 devices to receive control
2557 * commands in the default state. This has been seen to cause
2558 * enumeration failures, so disable this enumeration scheme for USB3
2561 static bool use_new_scheme(struct usb_device *udev, int retry)
2563 if (udev->speed >= USB_SPEED_SUPER)
2566 return USE_NEW_SCHEME(retry);
2569 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2570 * Port worm reset is required to recover
2572 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2577 if (!hub_is_superspeed(hub->hdev))
2580 if (test_bit(port1, hub->warm_reset_bits))
2583 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2584 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2585 || link_state == USB_SS_PORT_LS_COMP_MOD;
2588 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2589 struct usb_device *udev, unsigned int delay, bool warm)
2591 int delay_time, ret;
2595 for (delay_time = 0;
2596 delay_time < HUB_RESET_TIMEOUT;
2597 delay_time += delay) {
2598 /* wait to give the device a chance to reset */
2601 /* read and decode port status */
2602 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2606 /* The port state is unknown until the reset completes. */
2607 if (!(portstatus & USB_PORT_STAT_RESET))
2610 /* switch to the long delay after two short delay failures */
2611 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2612 delay = HUB_LONG_RESET_TIME;
2614 dev_dbg(&hub->ports[port1 - 1]->dev,
2615 "not %sreset yet, waiting %dms\n",
2616 warm ? "warm " : "", delay);
2619 if ((portstatus & USB_PORT_STAT_RESET))
2622 if (hub_port_warm_reset_required(hub, port1, portstatus))
2625 /* Device went away? */
2626 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2629 /* bomb out completely if the connection bounced. A USB 3.0
2630 * connection may bounce if multiple warm resets were issued,
2631 * but the device may have successfully re-connected. Ignore it.
2633 if (!hub_is_superspeed(hub->hdev) &&
2634 (portchange & USB_PORT_STAT_C_CONNECTION))
2637 if (!(portstatus & USB_PORT_STAT_ENABLE))
2643 if (hub_is_wusb(hub))
2644 udev->speed = USB_SPEED_WIRELESS;
2645 else if (hub_is_superspeed(hub->hdev))
2646 udev->speed = USB_SPEED_SUPER;
2647 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2648 udev->speed = USB_SPEED_HIGH;
2649 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2650 udev->speed = USB_SPEED_LOW;
2652 udev->speed = USB_SPEED_FULL;
2656 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2657 static int hub_port_reset(struct usb_hub *hub, int port1,
2658 struct usb_device *udev, unsigned int delay, bool warm)
2661 u16 portchange, portstatus;
2662 struct usb_port *port_dev = hub->ports[port1 - 1];
2664 if (!hub_is_superspeed(hub->hdev)) {
2666 dev_err(hub->intfdev, "only USB3 hub support "
2670 /* Block EHCI CF initialization during the port reset.
2671 * Some companion controllers don't like it when they mix.
2673 down_read(&ehci_cf_port_reset_rwsem);
2676 * If the caller hasn't explicitly requested a warm reset,
2677 * double check and see if one is needed.
2679 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2680 if (hub_port_warm_reset_required(hub, port1,
2684 clear_bit(port1, hub->warm_reset_bits);
2686 /* Reset the port */
2687 for (i = 0; i < PORT_RESET_TRIES; i++) {
2688 status = set_port_feature(hub->hdev, port1, (warm ?
2689 USB_PORT_FEAT_BH_PORT_RESET :
2690 USB_PORT_FEAT_RESET));
2691 if (status == -ENODEV) {
2692 ; /* The hub is gone */
2693 } else if (status) {
2694 dev_err(&port_dev->dev,
2695 "cannot %sreset (err = %d)\n",
2696 warm ? "warm " : "", status);
2698 status = hub_port_wait_reset(hub, port1, udev, delay,
2700 if (status && status != -ENOTCONN && status != -ENODEV)
2701 dev_dbg(hub->intfdev,
2702 "port_wait_reset: err = %d\n",
2706 /* Check for disconnect or reset */
2707 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2708 usb_clear_port_feature(hub->hdev, port1,
2709 USB_PORT_FEAT_C_RESET);
2711 if (!hub_is_superspeed(hub->hdev))
2714 usb_clear_port_feature(hub->hdev, port1,
2715 USB_PORT_FEAT_C_BH_PORT_RESET);
2716 usb_clear_port_feature(hub->hdev, port1,
2717 USB_PORT_FEAT_C_PORT_LINK_STATE);
2718 usb_clear_port_feature(hub->hdev, port1,
2719 USB_PORT_FEAT_C_CONNECTION);
2722 * If a USB 3.0 device migrates from reset to an error
2723 * state, re-issue the warm reset.
2725 if (hub_port_status(hub, port1,
2726 &portstatus, &portchange) < 0)
2729 if (!hub_port_warm_reset_required(hub, port1,
2734 * If the port is in SS.Inactive or Compliance Mode, the
2735 * hot or warm reset failed. Try another warm reset.
2738 dev_dbg(&port_dev->dev,
2739 "hot reset failed, warm reset\n");
2744 dev_dbg(&port_dev->dev,
2745 "not enabled, trying %sreset again...\n",
2746 warm ? "warm " : "");
2747 delay = HUB_LONG_RESET_TIME;
2750 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2754 /* TRSTRCY = 10 ms; plus some extra */
2757 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2759 update_devnum(udev, 0);
2760 /* The xHC may think the device is already reset,
2761 * so ignore the status.
2763 if (hcd->driver->reset_device)
2764 hcd->driver->reset_device(hcd, udev);
2766 usb_set_device_state(udev, USB_STATE_DEFAULT);
2770 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2773 if (!hub_is_superspeed(hub->hdev))
2774 up_read(&ehci_cf_port_reset_rwsem);
2779 /* Check if a port is power on */
2780 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2784 if (hub_is_superspeed(hub->hdev)) {
2785 if (portstatus & USB_SS_PORT_STAT_POWER)
2788 if (portstatus & USB_PORT_STAT_POWER)
2795 static void usb_lock_port(struct usb_port *port_dev)
2796 __acquires(&port_dev->status_lock)
2798 mutex_lock(&port_dev->status_lock);
2799 __acquire(&port_dev->status_lock);
2802 static void usb_unlock_port(struct usb_port *port_dev)
2803 __releases(&port_dev->status_lock)
2805 mutex_unlock(&port_dev->status_lock);
2806 __release(&port_dev->status_lock);
2811 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2812 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2816 if (hub_is_superspeed(hub->hdev)) {
2817 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2818 == USB_SS_PORT_LS_U3)
2821 if (portstatus & USB_PORT_STAT_SUSPEND)
2828 /* Determine whether the device on a port is ready for a normal resume,
2829 * is ready for a reset-resume, or should be disconnected.
2831 static int check_port_resume_type(struct usb_device *udev,
2832 struct usb_hub *hub, int port1,
2833 int status, u16 portchange, u16 portstatus)
2835 struct usb_port *port_dev = hub->ports[port1 - 1];
2839 /* Is a warm reset needed to recover the connection? */
2840 if (status == 0 && udev->reset_resume
2841 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2844 /* Is the device still present? */
2845 else if (status || port_is_suspended(hub, portstatus) ||
2846 !port_is_power_on(hub, portstatus)) {
2849 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2851 usleep_range(200, 300);
2852 status = hub_port_status(hub, port1, &portstatus,
2859 /* Can't do a normal resume if the port isn't enabled,
2860 * so try a reset-resume instead.
2862 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2863 if (udev->persist_enabled)
2864 udev->reset_resume = 1;
2870 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2871 portchange, portstatus, status);
2872 } else if (udev->reset_resume) {
2874 /* Late port handoff can set status-change bits */
2875 if (portchange & USB_PORT_STAT_C_CONNECTION)
2876 usb_clear_port_feature(hub->hdev, port1,
2877 USB_PORT_FEAT_C_CONNECTION);
2878 if (portchange & USB_PORT_STAT_C_ENABLE)
2879 usb_clear_port_feature(hub->hdev, port1,
2880 USB_PORT_FEAT_C_ENABLE);
2886 int usb_disable_ltm(struct usb_device *udev)
2888 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2890 /* Check if the roothub and device supports LTM. */
2891 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2892 !usb_device_supports_ltm(udev))
2895 /* Clear Feature LTM Enable can only be sent if the device is
2898 if (!udev->actconfig)
2901 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2902 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2903 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2904 USB_CTRL_SET_TIMEOUT);
2906 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2908 void usb_enable_ltm(struct usb_device *udev)
2910 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2912 /* Check if the roothub and device supports LTM. */
2913 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2914 !usb_device_supports_ltm(udev))
2917 /* Set Feature LTM Enable can only be sent if the device is
2920 if (!udev->actconfig)
2923 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2924 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2925 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2926 USB_CTRL_SET_TIMEOUT);
2928 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2931 * usb_enable_remote_wakeup - enable remote wakeup for a device
2932 * @udev: target device
2934 * For USB-2 devices: Set the device's remote wakeup feature.
2936 * For USB-3 devices: Assume there's only one function on the device and
2937 * enable remote wake for the first interface. FIXME if the interface
2938 * association descriptor shows there's more than one function.
2940 static int usb_enable_remote_wakeup(struct usb_device *udev)
2942 if (udev->speed < USB_SPEED_SUPER)
2943 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2944 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2945 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2946 USB_CTRL_SET_TIMEOUT);
2948 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2949 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2950 USB_INTRF_FUNC_SUSPEND,
2951 USB_INTRF_FUNC_SUSPEND_RW |
2952 USB_INTRF_FUNC_SUSPEND_LP,
2953 NULL, 0, USB_CTRL_SET_TIMEOUT);
2957 * usb_disable_remote_wakeup - disable remote wakeup for a device
2958 * @udev: target device
2960 * For USB-2 devices: Clear the device's remote wakeup feature.
2962 * For USB-3 devices: Assume there's only one function on the device and
2963 * disable remote wake for the first interface. FIXME if the interface
2964 * association descriptor shows there's more than one function.
2966 static int usb_disable_remote_wakeup(struct usb_device *udev)
2968 if (udev->speed < USB_SPEED_SUPER)
2969 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2970 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2971 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2972 USB_CTRL_SET_TIMEOUT);
2974 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2975 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2976 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2977 USB_CTRL_SET_TIMEOUT);
2980 /* Count of wakeup-enabled devices at or below udev */
2981 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2983 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2985 return udev->do_remote_wakeup +
2986 (hub ? hub->wakeup_enabled_descendants : 0);
2990 * usb_port_suspend - suspend a usb device's upstream port
2991 * @udev: device that's no longer in active use, not a root hub
2992 * Context: must be able to sleep; device not locked; pm locks held
2994 * Suspends a USB device that isn't in active use, conserving power.
2995 * Devices may wake out of a suspend, if anything important happens,
2996 * using the remote wakeup mechanism. They may also be taken out of
2997 * suspend by the host, using usb_port_resume(). It's also routine
2998 * to disconnect devices while they are suspended.
3000 * This only affects the USB hardware for a device; its interfaces
3001 * (and, for hubs, child devices) must already have been suspended.
3003 * Selective port suspend reduces power; most suspended devices draw
3004 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3005 * All devices below the suspended port are also suspended.
3007 * Devices leave suspend state when the host wakes them up. Some devices
3008 * also support "remote wakeup", where the device can activate the USB
3009 * tree above them to deliver data, such as a keypress or packet. In
3010 * some cases, this wakes the USB host.
3012 * Suspending OTG devices may trigger HNP, if that's been enabled
3013 * between a pair of dual-role devices. That will change roles, such
3014 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3016 * Devices on USB hub ports have only one "suspend" state, corresponding
3017 * to ACPI D2, "may cause the device to lose some context".
3018 * State transitions include:
3020 * - suspend, resume ... when the VBUS power link stays live
3021 * - suspend, disconnect ... VBUS lost
3023 * Once VBUS drop breaks the circuit, the port it's using has to go through
3024 * normal re-enumeration procedures, starting with enabling VBUS power.
3025 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3026 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3027 * timer, no SRP, no requests through sysfs.
3029 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3030 * suspended until their bus goes into global suspend (i.e., the root
3031 * hub is suspended). Nevertheless, we change @udev->state to
3032 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3033 * upstream port setting is stored in @udev->port_is_suspended.
3035 * Returns 0 on success, else negative errno.
3037 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3039 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3040 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3041 int port1 = udev->portnum;
3043 bool really_suspend = true;
3045 usb_lock_port(port_dev);
3047 /* enable remote wakeup when appropriate; this lets the device
3048 * wake up the upstream hub (including maybe the root hub).
3050 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3051 * we don't explicitly enable it here.
3053 if (udev->do_remote_wakeup) {
3054 status = usb_enable_remote_wakeup(udev);
3056 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3058 /* bail if autosuspend is requested */
3059 if (PMSG_IS_AUTO(msg))
3064 /* disable USB2 hardware LPM */
3065 if (udev->usb2_hw_lpm_enabled == 1)
3066 usb_set_usb2_hardware_lpm(udev, 0);
3068 if (usb_disable_ltm(udev)) {
3069 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3071 if (PMSG_IS_AUTO(msg))
3074 if (usb_unlocked_disable_lpm(udev)) {
3075 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3077 if (PMSG_IS_AUTO(msg))
3082 if (hub_is_superspeed(hub->hdev))
3083 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3086 * For system suspend, we do not need to enable the suspend feature
3087 * on individual USB-2 ports. The devices will automatically go
3088 * into suspend a few ms after the root hub stops sending packets.
3089 * The USB 2.0 spec calls this "global suspend".
3091 * However, many USB hubs have a bug: They don't relay wakeup requests
3092 * from a downstream port if the port's suspend feature isn't on.
3093 * Therefore we will turn on the suspend feature if udev or any of its
3094 * descendants is enabled for remote wakeup.
3096 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3097 status = set_port_feature(hub->hdev, port1,
3098 USB_PORT_FEAT_SUSPEND);
3100 really_suspend = false;
3104 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3106 /* Try to enable USB3 LPM and LTM again */
3107 usb_unlocked_enable_lpm(udev);
3109 usb_enable_ltm(udev);
3111 /* Try to enable USB2 hardware LPM again */
3112 if (udev->usb2_hw_lpm_capable == 1)
3113 usb_set_usb2_hardware_lpm(udev, 1);
3115 if (udev->do_remote_wakeup)
3116 (void) usb_disable_remote_wakeup(udev);
3119 /* System sleep transitions should never fail */
3120 if (!PMSG_IS_AUTO(msg))
3123 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3124 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3125 udev->do_remote_wakeup);
3126 if (really_suspend) {
3127 udev->port_is_suspended = 1;
3129 /* device has up to 10 msec to fully suspend */
3132 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3135 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3136 && test_and_clear_bit(port1, hub->child_usage_bits))
3137 pm_runtime_put_sync(&port_dev->dev);
3139 usb_mark_last_busy(hub->hdev);
3141 usb_unlock_port(port_dev);
3146 * If the USB "suspend" state is in use (rather than "global suspend"),
3147 * many devices will be individually taken out of suspend state using
3148 * special "resume" signaling. This routine kicks in shortly after
3149 * hardware resume signaling is finished, either because of selective
3150 * resume (by host) or remote wakeup (by device) ... now see what changed
3151 * in the tree that's rooted at this device.
3153 * If @udev->reset_resume is set then the device is reset before the
3154 * status check is done.
3156 static int finish_port_resume(struct usb_device *udev)
3161 /* caller owns the udev device lock */
3162 dev_dbg(&udev->dev, "%s\n",
3163 udev->reset_resume ? "finish reset-resume" : "finish resume");
3165 /* usb ch9 identifies four variants of SUSPENDED, based on what
3166 * state the device resumes to. Linux currently won't see the
3167 * first two on the host side; they'd be inside hub_port_init()
3168 * during many timeouts, but hub_wq can't suspend until later.
3170 usb_set_device_state(udev, udev->actconfig
3171 ? USB_STATE_CONFIGURED
3172 : USB_STATE_ADDRESS);
3174 /* 10.5.4.5 says not to reset a suspended port if the attached
3175 * device is enabled for remote wakeup. Hence the reset
3176 * operation is carried out here, after the port has been
3179 if (udev->reset_resume) {
3181 * If the device morphs or switches modes when it is reset,
3182 * we don't want to perform a reset-resume. We'll fail the
3183 * resume, which will cause a logical disconnect, and then
3184 * the device will be rediscovered.
3187 if (udev->quirks & USB_QUIRK_RESET)
3190 status = usb_reset_and_verify_device(udev);
3193 /* 10.5.4.5 says be sure devices in the tree are still there.
3194 * For now let's assume the device didn't go crazy on resume,
3195 * and device drivers will know about any resume quirks.
3199 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3201 /* If a normal resume failed, try doing a reset-resume */
3202 if (status && !udev->reset_resume && udev->persist_enabled) {
3203 dev_dbg(&udev->dev, "retry with reset-resume\n");
3204 udev->reset_resume = 1;
3205 goto retry_reset_resume;
3210 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3213 * There are a few quirky devices which violate the standard
3214 * by claiming to have remote wakeup enabled after a reset,
3215 * which crash if the feature is cleared, hence check for
3216 * udev->reset_resume
3218 } else if (udev->actconfig && !udev->reset_resume) {
3219 if (udev->speed < USB_SPEED_SUPER) {
3220 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3221 status = usb_disable_remote_wakeup(udev);
3223 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3225 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3226 | USB_INTRF_STAT_FUNC_RW))
3227 status = usb_disable_remote_wakeup(udev);
3232 "disable remote wakeup, status %d\n",
3240 * There are some SS USB devices which take longer time for link training.
3241 * XHCI specs 4.19.4 says that when Link training is successful, port
3242 * sets CSC bit to 1. So if SW reads port status before successful link
3243 * training, then it will not find device to be present.
3244 * USB Analyzer log with such buggy devices show that in some cases
3245 * device switch on the RX termination after long delay of host enabling
3246 * the VBUS. In few other cases it has been seen that device fails to
3247 * negotiate link training in first attempt. It has been
3248 * reported till now that few devices take as long as 2000 ms to train
3249 * the link after host enabling its VBUS and termination. Following
3250 * routine implements a 2000 ms timeout for link training. If in a case
3251 * link trains before timeout, loop will exit earlier.
3253 * FIXME: If a device was connected before suspend, but was removed
3254 * while system was asleep, then the loop in the following routine will
3255 * only exit at timeout.
3257 * This routine should only be called when persist is enabled for a SS
3260 static int wait_for_ss_port_enable(struct usb_device *udev,
3261 struct usb_hub *hub, int *port1,
3262 u16 *portchange, u16 *portstatus)
3264 int status = 0, delay_ms = 0;
3266 while (delay_ms < 2000) {
3267 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3271 status = hub_port_status(hub, *port1, portstatus, portchange);
3277 * usb_port_resume - re-activate a suspended usb device's upstream port
3278 * @udev: device to re-activate, not a root hub
3279 * Context: must be able to sleep; device not locked; pm locks held
3281 * This will re-activate the suspended device, increasing power usage
3282 * while letting drivers communicate again with its endpoints.
3283 * USB resume explicitly guarantees that the power session between
3284 * the host and the device is the same as it was when the device
3287 * If @udev->reset_resume is set then this routine won't check that the
3288 * port is still enabled. Furthermore, finish_port_resume() above will
3289 * reset @udev. The end result is that a broken power session can be
3290 * recovered and @udev will appear to persist across a loss of VBUS power.
3292 * For example, if a host controller doesn't maintain VBUS suspend current
3293 * during a system sleep or is reset when the system wakes up, all the USB
3294 * power sessions below it will be broken. This is especially troublesome
3295 * for mass-storage devices containing mounted filesystems, since the
3296 * device will appear to have disconnected and all the memory mappings
3297 * to it will be lost. Using the USB_PERSIST facility, the device can be
3298 * made to appear as if it had not disconnected.
3300 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3301 * every effort to insure that the same device is present after the
3302 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3303 * quite possible for a device to remain unaltered but its media to be
3304 * changed. If the user replaces a flash memory card while the system is
3305 * asleep, he will have only himself to blame when the filesystem on the
3306 * new card is corrupted and the system crashes.
3308 * Returns 0 on success, else negative errno.
3310 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3312 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3313 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3314 int port1 = udev->portnum;
3316 u16 portchange, portstatus;
3318 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3319 status = pm_runtime_get_sync(&port_dev->dev);
3321 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3327 usb_lock_port(port_dev);
3329 /* Skip the initial Clear-Suspend step for a remote wakeup */
3330 status = hub_port_status(hub, port1, &portstatus, &portchange);
3331 if (status == 0 && !port_is_suspended(hub, portstatus))
3332 goto SuspendCleared;
3334 /* see 7.1.7.7; affects power usage, but not budgeting */
3335 if (hub_is_superspeed(hub->hdev))
3336 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3338 status = usb_clear_port_feature(hub->hdev,
3339 port1, USB_PORT_FEAT_SUSPEND);
3341 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3343 /* drive resume for USB_RESUME_TIMEOUT msec */
3344 dev_dbg(&udev->dev, "usb %sresume\n",
3345 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3346 msleep(USB_RESUME_TIMEOUT);
3348 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3349 * stop resume signaling. Then finish the resume
3352 status = hub_port_status(hub, port1, &portstatus, &portchange);
3354 /* TRSMRCY = 10 msec */
3360 udev->port_is_suspended = 0;
3361 if (hub_is_superspeed(hub->hdev)) {
3362 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3363 usb_clear_port_feature(hub->hdev, port1,
3364 USB_PORT_FEAT_C_PORT_LINK_STATE);
3366 if (portchange & USB_PORT_STAT_C_SUSPEND)
3367 usb_clear_port_feature(hub->hdev, port1,
3368 USB_PORT_FEAT_C_SUSPEND);
3372 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3373 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3376 status = check_port_resume_type(udev,
3377 hub, port1, status, portchange, portstatus);
3379 status = finish_port_resume(udev);
3381 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3382 hub_port_logical_disconnect(hub, port1);
3384 /* Try to enable USB2 hardware LPM */
3385 if (udev->usb2_hw_lpm_capable == 1)
3386 usb_set_usb2_hardware_lpm(udev, 1);
3388 /* Try to enable USB3 LTM and LPM */
3389 usb_enable_ltm(udev);
3390 usb_unlocked_enable_lpm(udev);
3393 usb_unlock_port(port_dev);
3398 int usb_remote_wakeup(struct usb_device *udev)
3402 usb_lock_device(udev);
3403 if (udev->state == USB_STATE_SUSPENDED) {
3404 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3405 status = usb_autoresume_device(udev);
3407 /* Let the drivers do their thing, then... */
3408 usb_autosuspend_device(udev);
3411 usb_unlock_device(udev);
3415 /* Returns 1 if there was a remote wakeup and a connect status change. */
3416 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3417 u16 portstatus, u16 portchange)
3418 __must_hold(&port_dev->status_lock)
3420 struct usb_port *port_dev = hub->ports[port - 1];
3421 struct usb_device *hdev;
3422 struct usb_device *udev;
3423 int connect_change = 0;
3427 udev = port_dev->child;
3428 if (!hub_is_superspeed(hdev)) {
3429 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3431 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3433 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3434 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3440 /* TRSMRCY = 10 msec */
3443 usb_unlock_port(port_dev);
3444 ret = usb_remote_wakeup(udev);
3445 usb_lock_port(port_dev);
3450 hub_port_disable(hub, port, 1);
3452 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3453 return connect_change;
3456 static int check_ports_changed(struct usb_hub *hub)
3460 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3461 u16 portstatus, portchange;
3464 status = hub_port_status(hub, port1, &portstatus, &portchange);
3465 if (!status && portchange)
3471 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3473 struct usb_hub *hub = usb_get_intfdata(intf);
3474 struct usb_device *hdev = hub->hdev;
3479 * Warn if children aren't already suspended.
3480 * Also, add up the number of wakeup-enabled descendants.
3482 hub->wakeup_enabled_descendants = 0;
3483 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3484 struct usb_port *port_dev = hub->ports[port1 - 1];
3485 struct usb_device *udev = port_dev->child;
3487 if (udev && udev->can_submit) {
3488 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3489 dev_name(&udev->dev));
3490 if (PMSG_IS_AUTO(msg))
3494 hub->wakeup_enabled_descendants +=
3495 wakeup_enabled_descendants(udev);
3498 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3499 /* check if there are changes pending on hub ports */
3500 if (check_ports_changed(hub)) {
3501 if (PMSG_IS_AUTO(msg))
3503 pm_wakeup_event(&hdev->dev, 2000);
3507 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3508 /* Enable hub to send remote wakeup for all ports. */
3509 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3510 status = set_port_feature(hdev,
3512 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3513 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3514 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3515 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3519 dev_dbg(&intf->dev, "%s\n", __func__);
3521 /* stop hub_wq and related activity */
3522 hub_quiesce(hub, HUB_SUSPEND);
3526 static int hub_resume(struct usb_interface *intf)
3528 struct usb_hub *hub = usb_get_intfdata(intf);
3530 dev_dbg(&intf->dev, "%s\n", __func__);
3531 hub_activate(hub, HUB_RESUME);
3535 static int hub_reset_resume(struct usb_interface *intf)
3537 struct usb_hub *hub = usb_get_intfdata(intf);
3539 dev_dbg(&intf->dev, "%s\n", __func__);
3540 hub_activate(hub, HUB_RESET_RESUME);
3545 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3546 * @rhdev: struct usb_device for the root hub
3548 * The USB host controller driver calls this function when its root hub
3549 * is resumed and Vbus power has been interrupted or the controller
3550 * has been reset. The routine marks @rhdev as having lost power.
3551 * When the hub driver is resumed it will take notice and carry out
3552 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3553 * the others will be disconnected.
3555 void usb_root_hub_lost_power(struct usb_device *rhdev)
3557 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3558 rhdev->reset_resume = 1;
3560 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3562 static const char * const usb3_lpm_names[] = {
3570 * Send a Set SEL control transfer to the device, prior to enabling
3571 * device-initiated U1 or U2. This lets the device know the exit latencies from
3572 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3573 * packet from the host.
3575 * This function will fail if the SEL or PEL values for udev are greater than
3576 * the maximum allowed values for the link state to be enabled.
3578 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3580 struct usb_set_sel_req *sel_values;
3581 unsigned long long u1_sel;
3582 unsigned long long u1_pel;
3583 unsigned long long u2_sel;
3584 unsigned long long u2_pel;
3587 if (udev->state != USB_STATE_CONFIGURED)
3590 /* Convert SEL and PEL stored in ns to us */
3591 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3592 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3593 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3594 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3597 * Make sure that the calculated SEL and PEL values for the link
3598 * state we're enabling aren't bigger than the max SEL/PEL
3599 * value that will fit in the SET SEL control transfer.
3600 * Otherwise the device would get an incorrect idea of the exit
3601 * latency for the link state, and could start a device-initiated
3602 * U1/U2 when the exit latencies are too high.
3604 if ((state == USB3_LPM_U1 &&
3605 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3606 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3607 (state == USB3_LPM_U2 &&
3608 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3609 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3610 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3611 usb3_lpm_names[state], u1_sel, u1_pel);
3616 * If we're enabling device-initiated LPM for one link state,
3617 * but the other link state has a too high SEL or PEL value,
3618 * just set those values to the max in the Set SEL request.
3620 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3621 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3623 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3624 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3626 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3627 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3629 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3630 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3633 * usb_enable_lpm() can be called as part of a failed device reset,
3634 * which may be initiated by an error path of a mass storage driver.
3635 * Therefore, use GFP_NOIO.
3637 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3641 sel_values->u1_sel = u1_sel;
3642 sel_values->u1_pel = u1_pel;
3643 sel_values->u2_sel = cpu_to_le16(u2_sel);
3644 sel_values->u2_pel = cpu_to_le16(u2_pel);
3646 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3650 sel_values, sizeof *(sel_values),
3651 USB_CTRL_SET_TIMEOUT);
3657 * Enable or disable device-initiated U1 or U2 transitions.
3659 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3660 enum usb3_link_state state, bool enable)
3667 feature = USB_DEVICE_U1_ENABLE;
3670 feature = USB_DEVICE_U2_ENABLE;
3673 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3674 __func__, enable ? "enable" : "disable");
3678 if (udev->state != USB_STATE_CONFIGURED) {
3679 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3680 "for unconfigured device.\n",
3681 __func__, enable ? "enable" : "disable",
3682 usb3_lpm_names[state]);
3688 * Now send the control transfer to enable device-initiated LPM
3689 * for either U1 or U2.
3691 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3692 USB_REQ_SET_FEATURE,
3696 USB_CTRL_SET_TIMEOUT);
3698 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3699 USB_REQ_CLEAR_FEATURE,
3703 USB_CTRL_SET_TIMEOUT);
3706 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3707 enable ? "Enable" : "Disable",
3708 usb3_lpm_names[state]);
3714 static int usb_set_lpm_timeout(struct usb_device *udev,
3715 enum usb3_link_state state, int timeout)
3722 feature = USB_PORT_FEAT_U1_TIMEOUT;
3725 feature = USB_PORT_FEAT_U2_TIMEOUT;
3728 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3733 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3734 timeout != USB3_LPM_DEVICE_INITIATED) {
3735 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3736 "which is a reserved value.\n",
3737 usb3_lpm_names[state], timeout);
3741 ret = set_port_feature(udev->parent,
3742 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3745 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3746 "error code %i\n", usb3_lpm_names[state],
3750 if (state == USB3_LPM_U1)
3751 udev->u1_params.timeout = timeout;
3753 udev->u2_params.timeout = timeout;
3758 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3761 * We will attempt to enable U1 or U2, but there are no guarantees that the
3762 * control transfers to set the hub timeout or enable device-initiated U1/U2
3763 * will be successful.
3765 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3766 * driver know about it. If that call fails, it should be harmless, and just
3767 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3769 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3770 enum usb3_link_state state)
3773 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3774 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3776 /* If the device says it doesn't have *any* exit latency to come out of
3777 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3780 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3781 (state == USB3_LPM_U2 && u2_mel == 0))
3785 * First, let the device know about the exit latencies
3786 * associated with the link state we're about to enable.
3788 ret = usb_req_set_sel(udev, state);
3790 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3791 usb3_lpm_names[state]);
3795 /* We allow the host controller to set the U1/U2 timeout internally
3796 * first, so that it can change its schedule to account for the
3797 * additional latency to send data to a device in a lower power
3800 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3802 /* xHCI host controller doesn't want to enable this LPM state. */
3807 dev_warn(&udev->dev, "Could not enable %s link state, "
3808 "xHCI error %i.\n", usb3_lpm_names[state],
3813 if (usb_set_lpm_timeout(udev, state, timeout)) {
3814 /* If we can't set the parent hub U1/U2 timeout,
3815 * device-initiated LPM won't be allowed either, so let the xHCI
3816 * host know that this link state won't be enabled.
3818 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3820 /* Only a configured device will accept the Set Feature
3823 if (udev->actconfig)
3824 usb_set_device_initiated_lpm(udev, state, true);
3826 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3827 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3828 * matter the result of usb_set_device_initiated_lpm().
3829 * The only difference is whether device is able to initiate
3832 if (state == USB3_LPM_U1)
3833 udev->usb3_lpm_u1_enabled = 1;
3834 else if (state == USB3_LPM_U2)
3835 udev->usb3_lpm_u2_enabled = 1;
3840 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3843 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3844 * If zero is returned, the parent will not allow the link to go into U1/U2.
3846 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3847 * it won't have an effect on the bus link state because the parent hub will
3848 * still disallow device-initiated U1/U2 entry.
3850 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3851 * possible. The result will be slightly more bus bandwidth will be taken up
3852 * (to account for U1/U2 exit latency), but it should be harmless.
3854 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3855 enum usb3_link_state state)
3862 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3867 if (usb_set_lpm_timeout(udev, state, 0))
3870 usb_set_device_initiated_lpm(udev, state, false);
3872 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3873 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3874 "bus schedule bandwidth may be impacted.\n",
3875 usb3_lpm_names[state]);
3877 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3878 * is disabled. Hub will disallows link to enter U1/U2 as well,
3879 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3880 * timeout set to 0, no matter device-initiated LPM is disabled or
3883 if (state == USB3_LPM_U1)
3884 udev->usb3_lpm_u1_enabled = 0;
3885 else if (state == USB3_LPM_U2)
3886 udev->usb3_lpm_u2_enabled = 0;
3892 * Disable hub-initiated and device-initiated U1 and U2 entry.
3893 * Caller must own the bandwidth_mutex.
3895 * This will call usb_enable_lpm() on failure, which will decrement
3896 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3898 int usb_disable_lpm(struct usb_device *udev)
3900 struct usb_hcd *hcd;
3902 if (!udev || !udev->parent ||
3903 udev->speed < USB_SPEED_SUPER ||
3904 !udev->lpm_capable ||
3905 udev->state < USB_STATE_DEFAULT)
3908 hcd = bus_to_hcd(udev->bus);
3909 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3912 udev->lpm_disable_count++;
3913 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3916 /* If LPM is enabled, attempt to disable it. */
3917 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3919 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3925 usb_enable_lpm(udev);
3928 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3930 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3931 int usb_unlocked_disable_lpm(struct usb_device *udev)
3933 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3939 mutex_lock(hcd->bandwidth_mutex);
3940 ret = usb_disable_lpm(udev);
3941 mutex_unlock(hcd->bandwidth_mutex);
3945 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3948 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3949 * xHCI host policy may prevent U1 or U2 from being enabled.
3951 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3952 * until the lpm_disable_count drops to zero. Caller must own the
3955 void usb_enable_lpm(struct usb_device *udev)
3957 struct usb_hcd *hcd;
3959 if (!udev || !udev->parent ||
3960 udev->speed < USB_SPEED_SUPER ||
3961 !udev->lpm_capable ||
3962 udev->state < USB_STATE_DEFAULT)
3965 udev->lpm_disable_count--;
3966 hcd = bus_to_hcd(udev->bus);
3967 /* Double check that we can both enable and disable LPM.
3968 * Device must be configured to accept set feature U1/U2 timeout.
3970 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3971 !hcd->driver->disable_usb3_lpm_timeout)
3974 if (udev->lpm_disable_count > 0)
3977 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3978 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3980 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3982 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3983 void usb_unlocked_enable_lpm(struct usb_device *udev)
3985 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3990 mutex_lock(hcd->bandwidth_mutex);
3991 usb_enable_lpm(udev);
3992 mutex_unlock(hcd->bandwidth_mutex);
3994 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3996 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
3997 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
3998 struct usb_port *port_dev)
4000 struct usb_device *udev = port_dev->child;
4003 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4004 ret = hub_set_port_link_state(hub, port_dev->portnum,
4007 msleep(USB_RESUME_TIMEOUT);
4008 ret = usb_disable_remote_wakeup(udev);
4011 dev_warn(&udev->dev,
4012 "Port disable: can't disable remote wake\n");
4013 udev->do_remote_wakeup = 0;
4017 #else /* CONFIG_PM */
4019 #define hub_suspend NULL
4020 #define hub_resume NULL
4021 #define hub_reset_resume NULL
4023 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4024 struct usb_port *port_dev) { }
4026 int usb_disable_lpm(struct usb_device *udev)
4030 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4032 void usb_enable_lpm(struct usb_device *udev) { }
4033 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4035 int usb_unlocked_disable_lpm(struct usb_device *udev)
4039 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4041 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4042 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4044 int usb_disable_ltm(struct usb_device *udev)
4048 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4050 void usb_enable_ltm(struct usb_device *udev) { }
4051 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4053 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4054 u16 portstatus, u16 portchange)
4059 #endif /* CONFIG_PM */
4062 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4063 * a connection with a plugged-in cable but will signal the host when the cable
4064 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4066 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4068 struct usb_port *port_dev = hub->ports[port1 - 1];
4069 struct usb_device *hdev = hub->hdev;
4073 if (hub_is_superspeed(hub->hdev)) {
4074 hub_usb3_port_prepare_disable(hub, port_dev);
4075 ret = hub_set_port_link_state(hub, port_dev->portnum,
4078 ret = usb_clear_port_feature(hdev, port1,
4079 USB_PORT_FEAT_ENABLE);
4082 if (port_dev->child && set_state)
4083 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4084 if (ret && ret != -ENODEV)
4085 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4090 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4092 * Between connect detection and reset signaling there must be a delay
4093 * of 100ms at least for debounce and power-settling. The corresponding
4094 * timer shall restart whenever the downstream port detects a disconnect.
4096 * Apparently there are some bluetooth and irda-dongles and a number of
4097 * low-speed devices for which this debounce period may last over a second.
4098 * Not covered by the spec - but easy to deal with.
4100 * This implementation uses a 1500ms total debounce timeout; if the
4101 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4102 * every 25ms for transient disconnects. When the port status has been
4103 * unchanged for 100ms it returns the port status.
4105 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4108 u16 portchange, portstatus;
4109 unsigned connection = 0xffff;
4110 int total_time, stable_time = 0;
4111 struct usb_port *port_dev = hub->ports[port1 - 1];
4113 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4114 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4118 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4119 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4120 if (!must_be_connected ||
4121 (connection == USB_PORT_STAT_CONNECTION))
4122 stable_time += HUB_DEBOUNCE_STEP;
4123 if (stable_time >= HUB_DEBOUNCE_STABLE)
4127 connection = portstatus & USB_PORT_STAT_CONNECTION;
4130 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4131 usb_clear_port_feature(hub->hdev, port1,
4132 USB_PORT_FEAT_C_CONNECTION);
4135 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4137 msleep(HUB_DEBOUNCE_STEP);
4140 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4141 total_time, stable_time, portstatus);
4143 if (stable_time < HUB_DEBOUNCE_STABLE)
4148 void usb_ep0_reinit(struct usb_device *udev)
4150 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4151 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4152 usb_enable_endpoint(udev, &udev->ep0, true);
4154 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4156 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4157 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4159 static int hub_set_address(struct usb_device *udev, int devnum)
4162 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4165 * The host controller will choose the device address,
4166 * instead of the core having chosen it earlier
4168 if (!hcd->driver->address_device && devnum <= 1)
4170 if (udev->state == USB_STATE_ADDRESS)
4172 if (udev->state != USB_STATE_DEFAULT)
4174 if (hcd->driver->address_device)
4175 retval = hcd->driver->address_device(hcd, udev);
4177 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4178 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4179 NULL, 0, USB_CTRL_SET_TIMEOUT);
4181 update_devnum(udev, devnum);
4182 /* Device now using proper address. */
4183 usb_set_device_state(udev, USB_STATE_ADDRESS);
4184 usb_ep0_reinit(udev);
4190 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4191 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4194 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4195 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4196 * support bit in the BOS descriptor.
4198 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4200 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4201 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4203 if (!udev->usb2_hw_lpm_capable)
4207 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4209 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4210 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4211 udev->usb2_hw_lpm_allowed = 1;
4212 usb_set_usb2_hardware_lpm(udev, 1);
4216 static int hub_enable_device(struct usb_device *udev)
4218 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4220 if (!hcd->driver->enable_device)
4222 if (udev->state == USB_STATE_ADDRESS)
4224 if (udev->state != USB_STATE_DEFAULT)
4227 return hcd->driver->enable_device(hcd, udev);
4230 /* Reset device, (re)assign address, get device descriptor.
4231 * Device connection must be stable, no more debouncing needed.
4232 * Returns device in USB_STATE_ADDRESS, except on error.
4234 * If this is called for an already-existing device (as part of
4235 * usb_reset_and_verify_device), the caller must own the device lock and
4236 * the port lock. For a newly detected device that is not accessible
4237 * through any global pointers, it's not necessary to lock the device,
4238 * but it is still necessary to lock the port.
4241 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4244 struct usb_device *hdev = hub->hdev;
4245 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4246 int retries, operations, retval, i;
4247 unsigned delay = HUB_SHORT_RESET_TIME;
4248 enum usb_device_speed oldspeed = udev->speed;
4250 int devnum = udev->devnum;
4252 /* root hub ports have a slightly longer reset period
4253 * (from USB 2.0 spec, section 7.1.7.5)
4255 if (!hdev->parent) {
4256 delay = HUB_ROOT_RESET_TIME;
4257 if (port1 == hdev->bus->otg_port)
4258 hdev->bus->b_hnp_enable = 0;
4261 /* Some low speed devices have problems with the quick delay, so */
4262 /* be a bit pessimistic with those devices. RHbug #23670 */
4263 if (oldspeed == USB_SPEED_LOW)
4264 delay = HUB_LONG_RESET_TIME;
4266 mutex_lock(hcd->address0_mutex);
4268 /* Reset the device; full speed may morph to high speed */
4269 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4270 retval = hub_port_reset(hub, port1, udev, delay, false);
4271 if (retval < 0) /* error or disconnect */
4273 /* success, speed is known */
4277 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4278 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4279 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4280 dev_dbg(&udev->dev, "device reset changed speed!\n");
4283 oldspeed = udev->speed;
4285 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4286 * it's fixed size except for full speed devices.
4287 * For Wireless USB devices, ep0 max packet is always 512 (tho
4288 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4290 switch (udev->speed) {
4291 case USB_SPEED_SUPER_PLUS:
4292 case USB_SPEED_SUPER:
4293 case USB_SPEED_WIRELESS: /* fixed at 512 */
4294 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4296 case USB_SPEED_HIGH: /* fixed at 64 */
4297 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4299 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4300 /* to determine the ep0 maxpacket size, try to read
4301 * the device descriptor to get bMaxPacketSize0 and
4302 * then correct our initial guess.
4304 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4306 case USB_SPEED_LOW: /* fixed at 8 */
4307 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4313 if (udev->speed == USB_SPEED_WIRELESS)
4314 speed = "variable speed Wireless";
4316 speed = usb_speed_string(udev->speed);
4318 if (udev->speed < USB_SPEED_SUPER)
4319 dev_info(&udev->dev,
4320 "%s %s USB device number %d using %s\n",
4321 (udev->config) ? "reset" : "new", speed,
4322 devnum, udev->bus->controller->driver->name);
4324 /* Set up TT records, if needed */
4326 udev->tt = hdev->tt;
4327 udev->ttport = hdev->ttport;
4328 } else if (udev->speed != USB_SPEED_HIGH
4329 && hdev->speed == USB_SPEED_HIGH) {
4331 dev_err(&udev->dev, "parent hub has no TT\n");
4335 udev->tt = &hub->tt;
4336 udev->ttport = port1;
4339 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4340 * Because device hardware and firmware is sometimes buggy in
4341 * this area, and this is how Linux has done it for ages.
4342 * Change it cautiously.
4344 * NOTE: If use_new_scheme() is true we will start by issuing
4345 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4346 * so it may help with some non-standards-compliant devices.
4347 * Otherwise we start with SET_ADDRESS and then try to read the
4348 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4351 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4352 bool did_new_scheme = false;
4354 if (use_new_scheme(udev, retry_counter)) {
4355 struct usb_device_descriptor *buf;
4358 did_new_scheme = true;
4359 retval = hub_enable_device(udev);
4362 "hub failed to enable device, error %d\n",
4367 #define GET_DESCRIPTOR_BUFSIZE 64
4368 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4374 /* Retry on all errors; some devices are flakey.
4375 * 255 is for WUSB devices, we actually need to use
4376 * 512 (WUSB1.0[4.8.1]).
4378 for (operations = 0; operations < 3; ++operations) {
4379 buf->bMaxPacketSize0 = 0;
4380 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4381 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4382 USB_DT_DEVICE << 8, 0,
4383 buf, GET_DESCRIPTOR_BUFSIZE,
4384 initial_descriptor_timeout);
4385 switch (buf->bMaxPacketSize0) {
4386 case 8: case 16: case 32: case 64: case 255:
4387 if (buf->bDescriptorType ==
4399 * Some devices time out if they are powered on
4400 * when already connected. They need a second
4401 * reset. But only on the first attempt,
4402 * lest we get into a time out/reset loop
4404 if (r == 0 || (r == -ETIMEDOUT && retries == 0))
4407 udev->descriptor.bMaxPacketSize0 =
4408 buf->bMaxPacketSize0;
4411 retval = hub_port_reset(hub, port1, udev, delay, false);
4412 if (retval < 0) /* error or disconnect */
4414 if (oldspeed != udev->speed) {
4416 "device reset changed speed!\n");
4422 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4427 #undef GET_DESCRIPTOR_BUFSIZE
4431 * If device is WUSB, we already assigned an
4432 * unauthorized address in the Connect Ack sequence;
4433 * authorization will assign the final address.
4435 if (udev->wusb == 0) {
4436 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4437 retval = hub_set_address(udev, devnum);
4443 if (retval != -ENODEV)
4444 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4448 if (udev->speed >= USB_SPEED_SUPER) {
4449 devnum = udev->devnum;
4450 dev_info(&udev->dev,
4451 "%s SuperSpeed%s USB device number %d using %s\n",
4452 (udev->config) ? "reset" : "new",
4453 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4454 devnum, udev->bus->controller->driver->name);
4457 /* cope with hardware quirkiness:
4458 * - let SET_ADDRESS settle, some device hardware wants it
4459 * - read ep0 maxpacket even for high and low speed,
4462 /* use_new_scheme() checks the speed which may have
4463 * changed since the initial look so we cache the result
4470 retval = usb_get_device_descriptor(udev, 8);
4472 if (retval != -ENODEV)
4474 "device descriptor read/8, error %d\n",
4487 * Some superspeed devices have finished the link training process
4488 * and attached to a superspeed hub port, but the device descriptor
4489 * got from those devices show they aren't superspeed devices. Warm
4490 * reset the port attached by the devices can fix them.
4492 if ((udev->speed >= USB_SPEED_SUPER) &&
4493 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4494 dev_err(&udev->dev, "got a wrong device descriptor, "
4495 "warm reset device\n");
4496 hub_port_reset(hub, port1, udev,
4497 HUB_BH_RESET_TIME, true);
4502 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4503 udev->speed >= USB_SPEED_SUPER)
4506 i = udev->descriptor.bMaxPacketSize0;
4507 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4508 if (udev->speed == USB_SPEED_LOW ||
4509 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4510 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4514 if (udev->speed == USB_SPEED_FULL)
4515 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4517 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4518 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4519 usb_ep0_reinit(udev);
4522 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4523 if (retval < (signed)sizeof(udev->descriptor)) {
4524 if (retval != -ENODEV)
4525 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4532 usb_detect_quirks(udev);
4534 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4535 retval = usb_get_bos_descriptor(udev);
4537 udev->lpm_capable = usb_device_supports_lpm(udev);
4538 usb_set_lpm_parameters(udev);
4543 /* notify HCD that we have a device connected and addressed */
4544 if (hcd->driver->update_device)
4545 hcd->driver->update_device(hcd, udev);
4546 hub_set_initial_usb2_lpm_policy(udev);
4549 hub_port_disable(hub, port1, 0);
4550 update_devnum(udev, devnum); /* for disconnect processing */
4552 mutex_unlock(hcd->address0_mutex);
4557 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4559 struct usb_qualifier_descriptor *qual;
4562 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4565 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4569 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4570 qual, sizeof *qual);
4571 if (status == sizeof *qual) {
4572 dev_info(&udev->dev, "not running at top speed; "
4573 "connect to a high speed hub\n");
4574 /* hub LEDs are probably harder to miss than syslog */
4575 if (hub->has_indicators) {
4576 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4577 queue_delayed_work(system_power_efficient_wq,
4585 hub_power_remaining(struct usb_hub *hub)
4587 struct usb_device *hdev = hub->hdev;
4591 if (!hub->limited_power)
4594 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4595 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4596 struct usb_port *port_dev = hub->ports[port1 - 1];
4597 struct usb_device *udev = port_dev->child;
4603 if (hub_is_superspeed(udev))
4609 * Unconfigured devices may not use more than one unit load,
4610 * or 8mA for OTG ports
4612 if (udev->actconfig)
4613 delta = usb_get_max_power(udev, udev->actconfig);
4614 else if (port1 != udev->bus->otg_port || hdev->parent)
4618 if (delta > hub->mA_per_port)
4619 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4620 delta, hub->mA_per_port);
4623 if (remaining < 0) {
4624 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4631 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4636 struct usb_device *hdev = hub->hdev;
4637 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4638 struct usb_port *port_dev = hub->ports[port1 - 1];
4639 struct usb_device *udev = port_dev->child;
4640 static int unreliable_port = -1;
4642 /* Disconnect any existing devices under this port */
4644 if (hcd->usb_phy && !hdev->parent)
4645 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4646 usb_disconnect(&port_dev->child);
4649 /* We can forget about a "removed" device when there's a physical
4650 * disconnect or the connect status changes.
4652 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4653 (portchange & USB_PORT_STAT_C_CONNECTION))
4654 clear_bit(port1, hub->removed_bits);
4656 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4657 USB_PORT_STAT_C_ENABLE)) {
4658 status = hub_port_debounce_be_stable(hub, port1);
4660 if (status != -ENODEV &&
4661 port1 != unreliable_port &&
4663 dev_err(&port_dev->dev, "connect-debounce failed\n");
4664 portstatus &= ~USB_PORT_STAT_CONNECTION;
4665 unreliable_port = port1;
4667 portstatus = status;
4671 /* Return now if debouncing failed or nothing is connected or
4672 * the device was "removed".
4674 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4675 test_bit(port1, hub->removed_bits)) {
4678 * maybe switch power back on (e.g. root hub was reset)
4679 * but only if the port isn't owned by someone else.
4681 if (hub_is_port_power_switchable(hub)
4682 && !port_is_power_on(hub, portstatus)
4683 && !port_dev->port_owner)
4684 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4686 if (portstatus & USB_PORT_STAT_ENABLE)
4690 if (hub_is_superspeed(hub->hdev))
4696 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4698 /* reallocate for each attempt, since references
4699 * to the previous one can escape in various ways
4701 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4703 dev_err(&port_dev->dev,
4704 "couldn't allocate usb_device\n");
4708 usb_set_device_state(udev, USB_STATE_POWERED);
4709 udev->bus_mA = hub->mA_per_port;
4710 udev->level = hdev->level + 1;
4711 udev->wusb = hub_is_wusb(hub);
4713 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4714 if (hub_is_superspeed(hub->hdev))
4715 udev->speed = USB_SPEED_SUPER;
4717 udev->speed = USB_SPEED_UNKNOWN;
4719 choose_devnum(udev);
4720 if (udev->devnum <= 0) {
4721 status = -ENOTCONN; /* Don't retry */
4725 /* reset (non-USB 3.0 devices) and get descriptor */
4726 usb_lock_port(port_dev);
4727 status = hub_port_init(hub, udev, port1, i);
4728 usb_unlock_port(port_dev);
4732 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4735 /* consecutive bus-powered hubs aren't reliable; they can
4736 * violate the voltage drop budget. if the new child has
4737 * a "powered" LED, users should notice we didn't enable it
4738 * (without reading syslog), even without per-port LEDs
4741 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4742 && udev->bus_mA <= unit_load) {
4745 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4748 dev_dbg(&udev->dev, "get status %d ?\n", status);
4751 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4753 "can't connect bus-powered hub "
4755 if (hub->has_indicators) {
4756 hub->indicator[port1-1] =
4757 INDICATOR_AMBER_BLINK;
4759 system_power_efficient_wq,
4762 status = -ENOTCONN; /* Don't retry */
4767 /* check for devices running slower than they could */
4768 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4769 && udev->speed == USB_SPEED_FULL
4770 && highspeed_hubs != 0)
4771 check_highspeed(hub, udev, port1);
4773 /* Store the parent's children[] pointer. At this point
4774 * udev becomes globally accessible, although presumably
4775 * no one will look at it until hdev is unlocked.
4779 mutex_lock(&usb_port_peer_mutex);
4781 /* We mustn't add new devices if the parent hub has
4782 * been disconnected; we would race with the
4783 * recursively_mark_NOTATTACHED() routine.
4785 spin_lock_irq(&device_state_lock);
4786 if (hdev->state == USB_STATE_NOTATTACHED)
4789 port_dev->child = udev;
4790 spin_unlock_irq(&device_state_lock);
4791 mutex_unlock(&usb_port_peer_mutex);
4793 /* Run it through the hoops (find a driver, etc) */
4795 status = usb_new_device(udev);
4797 mutex_lock(&usb_port_peer_mutex);
4798 spin_lock_irq(&device_state_lock);
4799 port_dev->child = NULL;
4800 spin_unlock_irq(&device_state_lock);
4801 mutex_unlock(&usb_port_peer_mutex);
4803 if (hcd->usb_phy && !hdev->parent)
4804 usb_phy_notify_connect(hcd->usb_phy,
4812 status = hub_power_remaining(hub);
4814 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
4819 hub_port_disable(hub, port1, 1);
4821 usb_ep0_reinit(udev);
4822 release_devnum(udev);
4825 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4828 if (hub->hdev->parent ||
4829 !hcd->driver->port_handed_over ||
4830 !(hcd->driver->port_handed_over)(hcd, port1)) {
4831 if (status != -ENOTCONN && status != -ENODEV)
4832 dev_err(&port_dev->dev,
4833 "unable to enumerate USB device\n");
4837 hub_port_disable(hub, port1, 1);
4838 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4839 hcd->driver->relinquish_port(hcd, port1);
4843 /* Handle physical or logical connection change events.
4844 * This routine is called when:
4845 * a port connection-change occurs;
4846 * a port enable-change occurs (often caused by EMI);
4847 * usb_reset_and_verify_device() encounters changed descriptors (as from
4848 * a firmware download)
4849 * caller already locked the hub
4851 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4852 u16 portstatus, u16 portchange)
4853 __must_hold(&port_dev->status_lock)
4855 struct usb_port *port_dev = hub->ports[port1 - 1];
4856 struct usb_device *udev = port_dev->child;
4857 int status = -ENODEV;
4859 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4860 portchange, portspeed(hub, portstatus));
4862 if (hub->has_indicators) {
4863 set_port_led(hub, port1, HUB_LED_AUTO);
4864 hub->indicator[port1-1] = INDICATOR_AUTO;
4867 #ifdef CONFIG_USB_OTG
4868 /* during HNP, don't repeat the debounce */
4869 if (hub->hdev->bus->is_b_host)
4870 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4871 USB_PORT_STAT_C_ENABLE);
4874 /* Try to resuscitate an existing device */
4875 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4876 udev->state != USB_STATE_NOTATTACHED) {
4877 if (portstatus & USB_PORT_STAT_ENABLE) {
4878 status = 0; /* Nothing to do */
4880 } else if (udev->state == USB_STATE_SUSPENDED &&
4881 udev->persist_enabled) {
4882 /* For a suspended device, treat this as a
4883 * remote wakeup event.
4885 usb_unlock_port(port_dev);
4886 status = usb_remote_wakeup(udev);
4887 usb_lock_port(port_dev);
4890 /* Don't resuscitate */;
4893 clear_bit(port1, hub->change_bits);
4895 /* successfully revalidated the connection */
4899 usb_unlock_port(port_dev);
4900 hub_port_connect(hub, port1, portstatus, portchange);
4901 usb_lock_port(port_dev);
4904 static void port_event(struct usb_hub *hub, int port1)
4905 __must_hold(&port_dev->status_lock)
4908 struct usb_port *port_dev = hub->ports[port1 - 1];
4909 struct usb_device *udev = port_dev->child;
4910 struct usb_device *hdev = hub->hdev;
4911 u16 portstatus, portchange;
4913 connect_change = test_bit(port1, hub->change_bits);
4914 clear_bit(port1, hub->event_bits);
4915 clear_bit(port1, hub->wakeup_bits);
4917 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
4920 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4921 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
4925 if (portchange & USB_PORT_STAT_C_ENABLE) {
4926 if (!connect_change)
4927 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
4929 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
4932 * EM interference sometimes causes badly shielded USB devices
4933 * to be shutdown by the hub, this hack enables them again.
4934 * Works at least with mouse driver.
4936 if (!(portstatus & USB_PORT_STAT_ENABLE)
4937 && !connect_change && udev) {
4938 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
4943 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4944 u16 status = 0, unused;
4946 dev_dbg(&port_dev->dev, "over-current change\n");
4947 usb_clear_port_feature(hdev, port1,
4948 USB_PORT_FEAT_C_OVER_CURRENT);
4949 msleep(100); /* Cool down */
4950 hub_power_on(hub, true);
4951 hub_port_status(hub, port1, &status, &unused);
4952 if (status & USB_PORT_STAT_OVERCURRENT)
4953 dev_err(&port_dev->dev, "over-current condition\n");
4956 if (portchange & USB_PORT_STAT_C_RESET) {
4957 dev_dbg(&port_dev->dev, "reset change\n");
4958 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
4960 if ((portchange & USB_PORT_STAT_C_BH_RESET)
4961 && hub_is_superspeed(hdev)) {
4962 dev_dbg(&port_dev->dev, "warm reset change\n");
4963 usb_clear_port_feature(hdev, port1,
4964 USB_PORT_FEAT_C_BH_PORT_RESET);
4966 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4967 dev_dbg(&port_dev->dev, "link state change\n");
4968 usb_clear_port_feature(hdev, port1,
4969 USB_PORT_FEAT_C_PORT_LINK_STATE);
4971 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4972 dev_warn(&port_dev->dev, "config error\n");
4973 usb_clear_port_feature(hdev, port1,
4974 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4977 /* skip port actions that require the port to be powered on */
4978 if (!pm_runtime_active(&port_dev->dev))
4981 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
4985 * Warm reset a USB3 protocol port if it's in
4986 * SS.Inactive state.
4988 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
4989 dev_dbg(&port_dev->dev, "do warm reset\n");
4990 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
4991 || udev->state == USB_STATE_NOTATTACHED) {
4992 if (hub_port_reset(hub, port1, NULL,
4993 HUB_BH_RESET_TIME, true) < 0)
4994 hub_port_disable(hub, port1, 1);
4996 usb_unlock_port(port_dev);
4997 usb_lock_device(udev);
4998 usb_reset_device(udev);
4999 usb_unlock_device(udev);
5000 usb_lock_port(port_dev);
5006 hub_port_connect_change(hub, port1, portstatus, portchange);
5009 static void hub_event(struct work_struct *work)
5011 struct usb_device *hdev;
5012 struct usb_interface *intf;
5013 struct usb_hub *hub;
5014 struct device *hub_dev;
5019 hub = container_of(work, struct usb_hub, events);
5021 hub_dev = hub->intfdev;
5022 intf = to_usb_interface(hub_dev);
5024 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5025 hdev->state, hdev->maxchild,
5026 /* NOTE: expects max 15 ports... */
5027 (u16) hub->change_bits[0],
5028 (u16) hub->event_bits[0]);
5030 /* Lock the device, then check to see if we were
5031 * disconnected while waiting for the lock to succeed. */
5032 usb_lock_device(hdev);
5033 if (unlikely(hub->disconnected))
5036 /* If the hub has died, clean up after it */
5037 if (hdev->state == USB_STATE_NOTATTACHED) {
5038 hub->error = -ENODEV;
5039 hub_quiesce(hub, HUB_DISCONNECT);
5044 ret = usb_autopm_get_interface(intf);
5046 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5050 /* If this is an inactive hub, do nothing */
5055 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5057 ret = usb_reset_device(hdev);
5059 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5067 /* deal with port status changes */
5068 for (i = 1; i <= hdev->maxchild; i++) {
5069 struct usb_port *port_dev = hub->ports[i - 1];
5071 if (test_bit(i, hub->event_bits)
5072 || test_bit(i, hub->change_bits)
5073 || test_bit(i, hub->wakeup_bits)) {
5075 * The get_noresume and barrier ensure that if
5076 * the port was in the process of resuming, we
5077 * flush that work and keep the port active for
5078 * the duration of the port_event(). However,
5079 * if the port is runtime pm suspended
5080 * (powered-off), we leave it in that state, run
5081 * an abbreviated port_event(), and move on.
5083 pm_runtime_get_noresume(&port_dev->dev);
5084 pm_runtime_barrier(&port_dev->dev);
5085 usb_lock_port(port_dev);
5087 usb_unlock_port(port_dev);
5088 pm_runtime_put_sync(&port_dev->dev);
5092 /* deal with hub status changes */
5093 if (test_and_clear_bit(0, hub->event_bits) == 0)
5095 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5096 dev_err(hub_dev, "get_hub_status failed\n");
5098 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5099 dev_dbg(hub_dev, "power change\n");
5100 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5101 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5102 /* FIXME: Is this always true? */
5103 hub->limited_power = 1;
5105 hub->limited_power = 0;
5107 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5111 dev_dbg(hub_dev, "over-current change\n");
5112 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5113 msleep(500); /* Cool down */
5114 hub_power_on(hub, true);
5115 hub_hub_status(hub, &status, &unused);
5116 if (status & HUB_STATUS_OVERCURRENT)
5117 dev_err(hub_dev, "over-current condition\n");
5122 /* Balance the usb_autopm_get_interface() above */
5123 usb_autopm_put_interface_no_suspend(intf);
5125 usb_unlock_device(hdev);
5127 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5128 usb_autopm_put_interface(intf);
5129 kref_put(&hub->kref, hub_release);
5132 static const struct usb_device_id hub_id_table[] = {
5133 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5134 | USB_DEVICE_ID_MATCH_INT_CLASS,
5135 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5136 .bInterfaceClass = USB_CLASS_HUB,
5137 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5138 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5139 .bDeviceClass = USB_CLASS_HUB},
5140 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5141 .bInterfaceClass = USB_CLASS_HUB},
5142 { } /* Terminating entry */
5145 MODULE_DEVICE_TABLE(usb, hub_id_table);
5147 static struct usb_driver hub_driver = {
5150 .disconnect = hub_disconnect,
5151 .suspend = hub_suspend,
5152 .resume = hub_resume,
5153 .reset_resume = hub_reset_resume,
5154 .pre_reset = hub_pre_reset,
5155 .post_reset = hub_post_reset,
5156 .unlocked_ioctl = hub_ioctl,
5157 .id_table = hub_id_table,
5158 .supports_autosuspend = 1,
5161 int usb_hub_init(void)
5163 if (usb_register(&hub_driver) < 0) {
5164 printk(KERN_ERR "%s: can't register hub driver\n",
5170 * The workqueue needs to be freezable to avoid interfering with
5171 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5172 * device was gone before the EHCI controller had handed its port
5173 * over to the companion full-speed controller.
5175 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5179 /* Fall through if kernel_thread failed */
5180 usb_deregister(&hub_driver);
5181 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5186 void usb_hub_cleanup(void)
5188 destroy_workqueue(hub_wq);
5191 * Hub resources are freed for us by usb_deregister. It calls
5192 * usb_driver_purge on every device which in turn calls that
5193 * devices disconnect function if it is using this driver.
5194 * The hub_disconnect function takes care of releasing the
5195 * individual hub resources. -greg
5197 usb_deregister(&hub_driver);
5198 } /* usb_hub_cleanup() */
5200 static int descriptors_changed(struct usb_device *udev,
5201 struct usb_device_descriptor *old_device_descriptor,
5202 struct usb_host_bos *old_bos)
5206 unsigned serial_len = 0;
5208 unsigned old_length;
5212 if (memcmp(&udev->descriptor, old_device_descriptor,
5213 sizeof(*old_device_descriptor)) != 0)
5216 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5219 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5220 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5222 if (memcmp(udev->bos->desc, old_bos->desc, len))
5226 /* Since the idVendor, idProduct, and bcdDevice values in the
5227 * device descriptor haven't changed, we will assume the
5228 * Manufacturer and Product strings haven't changed either.
5229 * But the SerialNumber string could be different (e.g., a
5230 * different flash card of the same brand).
5233 serial_len = strlen(udev->serial) + 1;
5236 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5237 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5238 len = max(len, old_length);
5241 buf = kmalloc(len, GFP_NOIO);
5243 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5244 /* assume the worst */
5247 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5248 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5249 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5251 if (length != old_length) {
5252 dev_dbg(&udev->dev, "config index %d, error %d\n",
5257 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5259 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5261 ((struct usb_config_descriptor *) buf)->
5262 bConfigurationValue);
5268 if (!changed && serial_len) {
5269 length = usb_string(udev, udev->descriptor.iSerialNumber,
5271 if (length + 1 != serial_len) {
5272 dev_dbg(&udev->dev, "serial string error %d\n",
5275 } else if (memcmp(buf, udev->serial, length) != 0) {
5276 dev_dbg(&udev->dev, "serial string changed\n");
5286 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5287 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5289 * WARNING - don't use this routine to reset a composite device
5290 * (one with multiple interfaces owned by separate drivers)!
5291 * Use usb_reset_device() instead.
5293 * Do a port reset, reassign the device's address, and establish its
5294 * former operating configuration. If the reset fails, or the device's
5295 * descriptors change from their values before the reset, or the original
5296 * configuration and altsettings cannot be restored, a flag will be set
5297 * telling hub_wq to pretend the device has been disconnected and then
5298 * re-connected. All drivers will be unbound, and the device will be
5299 * re-enumerated and probed all over again.
5301 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5302 * flagged for logical disconnection, or some other negative error code
5303 * if the reset wasn't even attempted.
5306 * The caller must own the device lock and the port lock, the latter is
5307 * taken by usb_reset_device(). For example, it's safe to use
5308 * usb_reset_device() from a driver probe() routine after downloading
5309 * new firmware. For calls that might not occur during probe(), drivers
5310 * should lock the device using usb_lock_device_for_reset().
5312 * Locking exception: This routine may also be called from within an
5313 * autoresume handler. Such usage won't conflict with other tasks
5314 * holding the device lock because these tasks should always call
5315 * usb_autopm_resume_device(), thereby preventing any unwanted
5316 * autoresume. The autoresume handler is expected to have already
5317 * acquired the port lock before calling this routine.
5319 static int usb_reset_and_verify_device(struct usb_device *udev)
5321 struct usb_device *parent_hdev = udev->parent;
5322 struct usb_hub *parent_hub;
5323 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5324 struct usb_device_descriptor descriptor = udev->descriptor;
5325 struct usb_host_bos *bos;
5327 int port1 = udev->portnum;
5329 if (udev->state == USB_STATE_NOTATTACHED ||
5330 udev->state == USB_STATE_SUSPENDED) {
5331 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5339 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5341 /* Disable USB2 hardware LPM.
5342 * It will be re-enabled by the enumeration process.
5344 if (udev->usb2_hw_lpm_enabled == 1)
5345 usb_set_usb2_hardware_lpm(udev, 0);
5347 /* Disable LPM and LTM while we reset the device and reinstall the alt
5348 * settings. Device-initiated LPM settings, and system exit latency
5349 * settings are cleared when the device is reset, so we have to set
5352 ret = usb_unlocked_disable_lpm(udev);
5354 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5355 goto re_enumerate_no_bos;
5357 ret = usb_disable_ltm(udev);
5359 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5361 goto re_enumerate_no_bos;
5367 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5369 /* ep0 maxpacket size may change; let the HCD know about it.
5370 * Other endpoints will be handled by re-enumeration. */
5371 usb_ep0_reinit(udev);
5372 ret = hub_port_init(parent_hub, udev, port1, i);
5373 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5380 /* Device might have changed firmware (DFU or similar) */
5381 if (descriptors_changed(udev, &descriptor, bos)) {
5382 dev_info(&udev->dev, "device firmware changed\n");
5383 udev->descriptor = descriptor; /* for disconnect() calls */
5387 /* Restore the device's previous configuration */
5388 if (!udev->actconfig)
5391 mutex_lock(hcd->bandwidth_mutex);
5392 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5394 dev_warn(&udev->dev,
5395 "Busted HC? Not enough HCD resources for "
5396 "old configuration.\n");
5397 mutex_unlock(hcd->bandwidth_mutex);
5400 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5401 USB_REQ_SET_CONFIGURATION, 0,
5402 udev->actconfig->desc.bConfigurationValue, 0,
5403 NULL, 0, USB_CTRL_SET_TIMEOUT);
5406 "can't restore configuration #%d (error=%d)\n",
5407 udev->actconfig->desc.bConfigurationValue, ret);
5408 mutex_unlock(hcd->bandwidth_mutex);
5411 mutex_unlock(hcd->bandwidth_mutex);
5412 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5414 /* Put interfaces back into the same altsettings as before.
5415 * Don't bother to send the Set-Interface request for interfaces
5416 * that were already in altsetting 0; besides being unnecessary,
5417 * many devices can't handle it. Instead just reset the host-side
5420 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5421 struct usb_host_config *config = udev->actconfig;
5422 struct usb_interface *intf = config->interface[i];
5423 struct usb_interface_descriptor *desc;
5425 desc = &intf->cur_altsetting->desc;
5426 if (desc->bAlternateSetting == 0) {
5427 usb_disable_interface(udev, intf, true);
5428 usb_enable_interface(udev, intf, true);
5431 /* Let the bandwidth allocation function know that this
5432 * device has been reset, and it will have to use
5433 * alternate setting 0 as the current alternate setting.
5435 intf->resetting_device = 1;
5436 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5437 desc->bAlternateSetting);
5438 intf->resetting_device = 0;
5441 dev_err(&udev->dev, "failed to restore interface %d "
5442 "altsetting %d (error=%d)\n",
5443 desc->bInterfaceNumber,
5444 desc->bAlternateSetting,
5448 /* Resetting also frees any allocated streams */
5449 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5450 intf->cur_altsetting->endpoint[j].streams = 0;
5454 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5455 usb_set_usb2_hardware_lpm(udev, 1);
5456 usb_unlocked_enable_lpm(udev);
5457 usb_enable_ltm(udev);
5458 usb_release_bos_descriptor(udev);
5463 usb_release_bos_descriptor(udev);
5465 re_enumerate_no_bos:
5466 /* LPM state doesn't matter when we're about to destroy the device. */
5467 hub_port_logical_disconnect(parent_hub, port1);
5472 * usb_reset_device - warn interface drivers and perform a USB port reset
5473 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5475 * Warns all drivers bound to registered interfaces (using their pre_reset
5476 * method), performs the port reset, and then lets the drivers know that
5477 * the reset is over (using their post_reset method).
5479 * Return: The same as for usb_reset_and_verify_device().
5482 * The caller must own the device lock. For example, it's safe to use
5483 * this from a driver probe() routine after downloading new firmware.
5484 * For calls that might not occur during probe(), drivers should lock
5485 * the device using usb_lock_device_for_reset().
5487 * If an interface is currently being probed or disconnected, we assume
5488 * its driver knows how to handle resets. For all other interfaces,
5489 * if the driver doesn't have pre_reset and post_reset methods then
5490 * we attempt to unbind it and rebind afterward.
5492 int usb_reset_device(struct usb_device *udev)
5496 unsigned int noio_flag;
5497 struct usb_port *port_dev;
5498 struct usb_host_config *config = udev->actconfig;
5499 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5501 if (udev->state == USB_STATE_NOTATTACHED ||
5502 udev->state == USB_STATE_SUSPENDED) {
5503 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5508 if (!udev->parent) {
5509 /* this requires hcd-specific logic; see ohci_restart() */
5510 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5514 port_dev = hub->ports[udev->portnum - 1];
5517 * Don't allocate memory with GFP_KERNEL in current
5518 * context to avoid possible deadlock if usb mass
5519 * storage interface or usbnet interface(iSCSI case)
5520 * is included in current configuration. The easist
5521 * approach is to do it for every device reset,
5522 * because the device 'memalloc_noio' flag may have
5523 * not been set before reseting the usb device.
5525 noio_flag = memalloc_noio_save();
5527 /* Prevent autosuspend during the reset */
5528 usb_autoresume_device(udev);
5531 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5532 struct usb_interface *cintf = config->interface[i];
5533 struct usb_driver *drv;
5536 if (cintf->dev.driver) {
5537 drv = to_usb_driver(cintf->dev.driver);
5538 if (drv->pre_reset && drv->post_reset)
5539 unbind = (drv->pre_reset)(cintf);
5540 else if (cintf->condition ==
5541 USB_INTERFACE_BOUND)
5544 usb_forced_unbind_intf(cintf);
5549 usb_lock_port(port_dev);
5550 ret = usb_reset_and_verify_device(udev);
5551 usb_unlock_port(port_dev);
5554 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5555 struct usb_interface *cintf = config->interface[i];
5556 struct usb_driver *drv;
5557 int rebind = cintf->needs_binding;
5559 if (!rebind && cintf->dev.driver) {
5560 drv = to_usb_driver(cintf->dev.driver);
5561 if (drv->post_reset)
5562 rebind = (drv->post_reset)(cintf);
5563 else if (cintf->condition ==
5564 USB_INTERFACE_BOUND)
5567 cintf->needs_binding = 1;
5570 usb_unbind_and_rebind_marked_interfaces(udev);
5573 usb_autosuspend_device(udev);
5574 memalloc_noio_restore(noio_flag);
5577 EXPORT_SYMBOL_GPL(usb_reset_device);
5581 * usb_queue_reset_device - Reset a USB device from an atomic context
5582 * @iface: USB interface belonging to the device to reset
5584 * This function can be used to reset a USB device from an atomic
5585 * context, where usb_reset_device() won't work (as it blocks).
5587 * Doing a reset via this method is functionally equivalent to calling
5588 * usb_reset_device(), except for the fact that it is delayed to a
5589 * workqueue. This means that any drivers bound to other interfaces
5590 * might be unbound, as well as users from usbfs in user space.
5594 * - Scheduling two resets at the same time from two different drivers
5595 * attached to two different interfaces of the same device is
5596 * possible; depending on how the driver attached to each interface
5597 * handles ->pre_reset(), the second reset might happen or not.
5599 * - If the reset is delayed so long that the interface is unbound from
5600 * its driver, the reset will be skipped.
5602 * - This function can be called during .probe(). It can also be called
5603 * during .disconnect(), but doing so is pointless because the reset
5604 * will not occur. If you really want to reset the device during
5605 * .disconnect(), call usb_reset_device() directly -- but watch out
5606 * for nested unbinding issues!
5608 void usb_queue_reset_device(struct usb_interface *iface)
5610 if (schedule_work(&iface->reset_ws))
5611 usb_get_intf(iface);
5613 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5616 * usb_hub_find_child - Get the pointer of child device
5617 * attached to the port which is specified by @port1.
5618 * @hdev: USB device belonging to the usb hub
5619 * @port1: port num to indicate which port the child device
5622 * USB drivers call this function to get hub's child device
5625 * Return: %NULL if input param is invalid and
5626 * child's usb_device pointer if non-NULL.
5628 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5631 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5633 if (port1 < 1 || port1 > hdev->maxchild)
5635 return hub->ports[port1 - 1]->child;
5637 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5639 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5640 struct usb_hub_descriptor *desc)
5642 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5643 enum usb_port_connect_type connect_type;
5649 if (!hub_is_superspeed(hdev)) {
5650 for (i = 1; i <= hdev->maxchild; i++) {
5651 struct usb_port *port_dev = hub->ports[i - 1];
5653 connect_type = port_dev->connect_type;
5654 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5655 u8 mask = 1 << (i%8);
5657 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5658 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5659 desc->u.hs.DeviceRemovable[i/8] |= mask;
5664 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5666 for (i = 1; i <= hdev->maxchild; i++) {
5667 struct usb_port *port_dev = hub->ports[i - 1];
5669 connect_type = port_dev->connect_type;
5670 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5673 if (!(port_removable & mask)) {
5674 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5675 port_removable |= mask;
5680 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5686 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5687 * @hdev: USB device belonging to the usb hub
5688 * @port1: port num of the port
5690 * Return: Port's acpi handle if successful, %NULL if params are
5693 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5696 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5701 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);