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;
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;
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);
105 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
108 static inline char *portspeed(struct usb_hub *hub, int portstatus)
110 if (hub_is_superspeedplus(hub->hdev))
112 if (hub_is_superspeed(hub->hdev))
114 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
116 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
122 /* Note that hdev or one of its children must be locked! */
123 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
125 if (!hdev || !hdev->actconfig || !hdev->maxchild)
127 return usb_get_intfdata(hdev->actconfig->interface[0]);
130 int usb_device_supports_lpm(struct usb_device *udev)
132 /* Some devices have trouble with LPM */
133 if (udev->quirks & USB_QUIRK_NO_LPM)
136 /* USB 2.1 (and greater) devices indicate LPM support through
137 * their USB 2.0 Extended Capabilities BOS descriptor.
139 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
140 if (udev->bos->ext_cap &&
142 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
148 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
149 * However, there are some that don't, and they set the U1/U2 exit
152 if (!udev->bos->ss_cap) {
153 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
157 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
158 udev->bos->ss_cap->bU2DevExitLat == 0) {
160 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
162 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
166 if (!udev->parent || udev->parent->lpm_capable)
172 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
175 static void usb_set_lpm_mel(struct usb_device *udev,
176 struct usb3_lpm_parameters *udev_lpm_params,
177 unsigned int udev_exit_latency,
179 struct usb3_lpm_parameters *hub_lpm_params,
180 unsigned int hub_exit_latency)
182 unsigned int total_mel;
183 unsigned int device_mel;
184 unsigned int hub_mel;
187 * Calculate the time it takes to transition all links from the roothub
188 * to the parent hub into U0. The parent hub must then decode the
189 * packet (hub header decode latency) to figure out which port it was
192 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
193 * means 0.1us). Multiply that by 100 to get nanoseconds.
195 total_mel = hub_lpm_params->mel +
196 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
199 * How long will it take to transition the downstream hub's port into
200 * U0? The greater of either the hub exit latency or the device exit
203 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
204 * Multiply that by 1000 to get nanoseconds.
206 device_mel = udev_exit_latency * 1000;
207 hub_mel = hub_exit_latency * 1000;
208 if (device_mel > hub_mel)
209 total_mel += device_mel;
211 total_mel += hub_mel;
213 udev_lpm_params->mel = total_mel;
217 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
218 * a transition from either U1 or U2.
220 static void usb_set_lpm_pel(struct usb_device *udev,
221 struct usb3_lpm_parameters *udev_lpm_params,
222 unsigned int udev_exit_latency,
224 struct usb3_lpm_parameters *hub_lpm_params,
225 unsigned int hub_exit_latency,
226 unsigned int port_to_port_exit_latency)
228 unsigned int first_link_pel;
229 unsigned int hub_pel;
232 * First, the device sends an LFPS to transition the link between the
233 * device and the parent hub into U0. The exit latency is the bigger of
234 * the device exit latency or the hub exit latency.
236 if (udev_exit_latency > hub_exit_latency)
237 first_link_pel = udev_exit_latency * 1000;
239 first_link_pel = hub_exit_latency * 1000;
242 * When the hub starts to receive the LFPS, there is a slight delay for
243 * it to figure out that one of the ports is sending an LFPS. Then it
244 * will forward the LFPS to its upstream link. The exit latency is the
245 * delay, plus the PEL that we calculated for this hub.
247 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
250 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
251 * is the greater of the two exit latencies.
253 if (first_link_pel > hub_pel)
254 udev_lpm_params->pel = first_link_pel;
256 udev_lpm_params->pel = hub_pel;
260 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
261 * when a device initiates a transition to U0, until when it will receive the
262 * first packet from the host controller.
264 * Section C.1.5.1 describes the four components to this:
266 * - t2: time for the ERDY to make it from the device to the host.
267 * - t3: a host-specific delay to process the ERDY.
268 * - t4: time for the packet to make it from the host to the device.
270 * t3 is specific to both the xHCI host and the platform the host is integrated
271 * into. The Intel HW folks have said it's negligible, FIXME if a different
272 * vendor says otherwise.
274 static void usb_set_lpm_sel(struct usb_device *udev,
275 struct usb3_lpm_parameters *udev_lpm_params)
277 struct usb_device *parent;
278 unsigned int num_hubs;
279 unsigned int total_sel;
281 /* t1 = device PEL */
282 total_sel = udev_lpm_params->pel;
283 /* How many external hubs are in between the device & the root port. */
284 for (parent = udev->parent, num_hubs = 0; parent->parent;
285 parent = parent->parent)
287 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
289 total_sel += 2100 + 250 * (num_hubs - 1);
291 /* t4 = 250ns * num_hubs */
292 total_sel += 250 * num_hubs;
294 udev_lpm_params->sel = total_sel;
297 static void usb_set_lpm_parameters(struct usb_device *udev)
300 unsigned int port_to_port_delay;
301 unsigned int udev_u1_del;
302 unsigned int udev_u2_del;
303 unsigned int hub_u1_del;
304 unsigned int hub_u2_del;
306 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
309 hub = usb_hub_to_struct_hub(udev->parent);
310 /* It doesn't take time to transition the roothub into U0, since it
311 * doesn't have an upstream link.
316 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
317 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
318 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
319 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
321 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
322 hub, &udev->parent->u1_params, hub_u1_del);
324 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
325 hub, &udev->parent->u2_params, hub_u2_del);
328 * Appendix C, section C.2.2.2, says that there is a slight delay from
329 * when the parent hub notices the downstream port is trying to
330 * transition to U0 to when the hub initiates a U0 transition on its
331 * upstream port. The section says the delays are tPort2PortU1EL and
332 * tPort2PortU2EL, but it doesn't define what they are.
334 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
335 * about the same delays. Use the maximum delay calculations from those
336 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
337 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
338 * assume the device exit latencies they are talking about are the hub
341 * What do we do if the U2 exit latency is less than the U1 exit
342 * latency? It's possible, although not likely...
344 port_to_port_delay = 1;
346 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
347 hub, &udev->parent->u1_params, hub_u1_del,
350 if (hub_u2_del > hub_u1_del)
351 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
353 port_to_port_delay = 1 + hub_u1_del;
355 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
356 hub, &udev->parent->u2_params, hub_u2_del,
359 /* Now that we've got PEL, calculate SEL. */
360 usb_set_lpm_sel(udev, &udev->u1_params);
361 usb_set_lpm_sel(udev, &udev->u2_params);
364 /* USB 2.0 spec Section 11.24.4.5 */
365 static int get_hub_descriptor(struct usb_device *hdev,
366 struct usb_hub_descriptor *desc)
371 if (hub_is_superspeed(hdev)) {
372 dtype = USB_DT_SS_HUB;
373 size = USB_DT_SS_HUB_SIZE;
376 size = sizeof(struct usb_hub_descriptor);
379 for (i = 0; i < 3; i++) {
380 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
381 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
382 dtype << 8, 0, desc, size,
383 USB_CTRL_GET_TIMEOUT);
384 if (hub_is_superspeed(hdev)) {
387 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
388 /* Make sure we have the DeviceRemovable field. */
389 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
399 * USB 2.0 spec Section 11.24.2.1
401 static int clear_hub_feature(struct usb_device *hdev, int feature)
403 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
404 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
408 * USB 2.0 spec Section 11.24.2.2
410 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
412 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
413 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
418 * USB 2.0 spec Section 11.24.2.13
420 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
422 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
423 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
427 static char *to_led_name(int selector)
444 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
445 * for info about using port indicators
447 static void set_port_led(struct usb_hub *hub, int port1, int selector)
449 struct usb_port *port_dev = hub->ports[port1 - 1];
452 status = set_port_feature(hub->hdev, (selector << 8) | port1,
453 USB_PORT_FEAT_INDICATOR);
454 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
455 to_led_name(selector), status);
458 #define LED_CYCLE_PERIOD ((2*HZ)/3)
460 static void led_work(struct work_struct *work)
462 struct usb_hub *hub =
463 container_of(work, struct usb_hub, leds.work);
464 struct usb_device *hdev = hub->hdev;
466 unsigned changed = 0;
469 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
472 for (i = 0; i < hdev->maxchild; i++) {
473 unsigned selector, mode;
475 /* 30%-50% duty cycle */
477 switch (hub->indicator[i]) {
479 case INDICATOR_CYCLE:
481 selector = HUB_LED_AUTO;
482 mode = INDICATOR_AUTO;
484 /* blinking green = sw attention */
485 case INDICATOR_GREEN_BLINK:
486 selector = HUB_LED_GREEN;
487 mode = INDICATOR_GREEN_BLINK_OFF;
489 case INDICATOR_GREEN_BLINK_OFF:
490 selector = HUB_LED_OFF;
491 mode = INDICATOR_GREEN_BLINK;
493 /* blinking amber = hw attention */
494 case INDICATOR_AMBER_BLINK:
495 selector = HUB_LED_AMBER;
496 mode = INDICATOR_AMBER_BLINK_OFF;
498 case INDICATOR_AMBER_BLINK_OFF:
499 selector = HUB_LED_OFF;
500 mode = INDICATOR_AMBER_BLINK;
502 /* blink green/amber = reserved */
503 case INDICATOR_ALT_BLINK:
504 selector = HUB_LED_GREEN;
505 mode = INDICATOR_ALT_BLINK_OFF;
507 case INDICATOR_ALT_BLINK_OFF:
508 selector = HUB_LED_AMBER;
509 mode = INDICATOR_ALT_BLINK;
514 if (selector != HUB_LED_AUTO)
516 set_port_led(hub, i + 1, selector);
517 hub->indicator[i] = mode;
519 if (!changed && blinkenlights) {
521 cursor %= hdev->maxchild;
522 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
523 hub->indicator[cursor] = INDICATOR_CYCLE;
527 queue_delayed_work(system_power_efficient_wq,
528 &hub->leds, LED_CYCLE_PERIOD);
531 /* use a short timeout for hub/port status fetches */
532 #define USB_STS_TIMEOUT 1000
533 #define USB_STS_RETRIES 5
536 * USB 2.0 spec Section 11.24.2.6
538 static int get_hub_status(struct usb_device *hdev,
539 struct usb_hub_status *data)
541 int i, status = -ETIMEDOUT;
543 for (i = 0; i < USB_STS_RETRIES &&
544 (status == -ETIMEDOUT || status == -EPIPE); i++) {
545 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
546 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
547 data, sizeof(*data), USB_STS_TIMEOUT);
553 * USB 2.0 spec Section 11.24.2.7
554 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
556 static int get_port_status(struct usb_device *hdev, int port1,
557 void *data, u16 value, u16 length)
559 int i, status = -ETIMEDOUT;
561 for (i = 0; i < USB_STS_RETRIES &&
562 (status == -ETIMEDOUT || status == -EPIPE); i++) {
563 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
564 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
565 port1, data, length, USB_STS_TIMEOUT);
570 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
571 u16 *status, u16 *change, u32 *ext_status)
576 if (type != HUB_PORT_STATUS)
579 mutex_lock(&hub->status_mutex);
580 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
583 dev_err(hub->intfdev,
584 "%s failed (err = %d)\n", __func__, ret);
588 *status = le16_to_cpu(hub->status->port.wPortStatus);
589 *change = le16_to_cpu(hub->status->port.wPortChange);
590 if (type != HUB_PORT_STATUS && ext_status)
591 *ext_status = le32_to_cpu(
592 hub->status->port.dwExtPortStatus);
595 mutex_unlock(&hub->status_mutex);
599 static int hub_port_status(struct usb_hub *hub, int port1,
600 u16 *status, u16 *change)
602 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
603 status, change, NULL);
606 static void kick_hub_wq(struct usb_hub *hub)
608 struct usb_interface *intf;
610 if (hub->disconnected || work_pending(&hub->events))
614 * Suppress autosuspend until the event is proceed.
616 * Be careful and make sure that the symmetric operation is
617 * always called. We are here only when there is no pending
618 * work for this hub. Therefore put the interface either when
619 * the new work is called or when it is canceled.
621 intf = to_usb_interface(hub->intfdev);
622 usb_autopm_get_interface_no_resume(intf);
623 kref_get(&hub->kref);
625 if (queue_work(hub_wq, &hub->events))
628 /* the work has already been scheduled */
629 usb_autopm_put_interface_async(intf);
630 kref_put(&hub->kref, hub_release);
633 void usb_kick_hub_wq(struct usb_device *hdev)
635 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
642 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
643 * Notification, which indicates it had initiated remote wakeup.
645 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
646 * device initiates resume, so the USB core will not receive notice of the
647 * resume through the normal hub interrupt URB.
649 void usb_wakeup_notification(struct usb_device *hdev,
650 unsigned int portnum)
653 struct usb_port *port_dev;
658 hub = usb_hub_to_struct_hub(hdev);
660 port_dev = hub->ports[portnum - 1];
661 if (port_dev && port_dev->child)
662 pm_wakeup_event(&port_dev->child->dev, 0);
664 set_bit(portnum, hub->wakeup_bits);
668 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
670 /* completion function, fires on port status changes and various faults */
671 static void hub_irq(struct urb *urb)
673 struct usb_hub *hub = urb->context;
674 int status = urb->status;
679 case -ENOENT: /* synchronous unlink */
680 case -ECONNRESET: /* async unlink */
681 case -ESHUTDOWN: /* hardware going away */
684 default: /* presumably an error */
685 /* Cause a hub reset after 10 consecutive errors */
686 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
687 if ((++hub->nerrors < 10) || hub->error)
692 /* let hub_wq handle things */
693 case 0: /* we got data: port status changed */
695 for (i = 0; i < urb->actual_length; ++i)
696 bits |= ((unsigned long) ((*hub->buffer)[i]))
698 hub->event_bits[0] = bits;
704 /* Something happened, let hub_wq figure it out */
711 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
712 if (status != 0 && status != -ENODEV && status != -EPERM)
713 dev_err(hub->intfdev, "resubmit --> %d\n", status);
716 /* USB 2.0 spec Section 11.24.2.3 */
718 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
720 /* Need to clear both directions for control ep */
721 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
722 USB_ENDPOINT_XFER_CONTROL) {
723 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
724 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
725 devinfo ^ 0x8000, tt, NULL, 0, 1000);
729 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
730 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
735 * enumeration blocks hub_wq for a long time. we use keventd instead, since
736 * long blocking there is the exception, not the rule. accordingly, HCDs
737 * talking to TTs must queue control transfers (not just bulk and iso), so
738 * both can talk to the same hub concurrently.
740 static void hub_tt_work(struct work_struct *work)
742 struct usb_hub *hub =
743 container_of(work, struct usb_hub, tt.clear_work);
746 spin_lock_irqsave(&hub->tt.lock, flags);
747 while (!list_empty(&hub->tt.clear_list)) {
748 struct list_head *next;
749 struct usb_tt_clear *clear;
750 struct usb_device *hdev = hub->hdev;
751 const struct hc_driver *drv;
754 next = hub->tt.clear_list.next;
755 clear = list_entry(next, struct usb_tt_clear, clear_list);
756 list_del(&clear->clear_list);
758 /* drop lock so HCD can concurrently report other TT errors */
759 spin_unlock_irqrestore(&hub->tt.lock, flags);
760 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
761 if (status && status != -ENODEV)
763 "clear tt %d (%04x) error %d\n",
764 clear->tt, clear->devinfo, status);
766 /* Tell the HCD, even if the operation failed */
767 drv = clear->hcd->driver;
768 if (drv->clear_tt_buffer_complete)
769 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
772 spin_lock_irqsave(&hub->tt.lock, flags);
774 spin_unlock_irqrestore(&hub->tt.lock, flags);
778 * usb_hub_set_port_power - control hub port's power state
779 * @hdev: USB device belonging to the usb hub
782 * @set: expected status
784 * call this function to control port's power via setting or
785 * clearing the port's PORT_POWER feature.
787 * Return: 0 if successful. A negative error code otherwise.
789 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
795 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
797 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
803 set_bit(port1, hub->power_bits);
805 clear_bit(port1, hub->power_bits);
810 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
811 * @urb: an URB associated with the failed or incomplete split transaction
813 * High speed HCDs use this to tell the hub driver that some split control or
814 * bulk transaction failed in a way that requires clearing internal state of
815 * a transaction translator. This is normally detected (and reported) from
818 * It may not be possible for that hub to handle additional full (or low)
819 * speed transactions until that state is fully cleared out.
821 * Return: 0 if successful. A negative error code otherwise.
823 int usb_hub_clear_tt_buffer(struct urb *urb)
825 struct usb_device *udev = urb->dev;
826 int pipe = urb->pipe;
827 struct usb_tt *tt = udev->tt;
829 struct usb_tt_clear *clear;
831 /* we've got to cope with an arbitrary number of pending TT clears,
832 * since each TT has "at least two" buffers that can need it (and
833 * there can be many TTs per hub). even if they're uncommon.
835 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
837 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
838 /* FIXME recover somehow ... RESET_TT? */
842 /* info that CLEAR_TT_BUFFER needs */
843 clear->tt = tt->multi ? udev->ttport : 1;
844 clear->devinfo = usb_pipeendpoint (pipe);
845 clear->devinfo |= udev->devnum << 4;
846 clear->devinfo |= usb_pipecontrol(pipe)
847 ? (USB_ENDPOINT_XFER_CONTROL << 11)
848 : (USB_ENDPOINT_XFER_BULK << 11);
849 if (usb_pipein(pipe))
850 clear->devinfo |= 1 << 15;
852 /* info for completion callback */
853 clear->hcd = bus_to_hcd(udev->bus);
856 /* tell keventd to clear state for this TT */
857 spin_lock_irqsave(&tt->lock, flags);
858 list_add_tail(&clear->clear_list, &tt->clear_list);
859 schedule_work(&tt->clear_work);
860 spin_unlock_irqrestore(&tt->lock, flags);
863 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
865 static void hub_power_on(struct usb_hub *hub, bool do_delay)
869 /* Enable power on each port. Some hubs have reserved values
870 * of LPSM (> 2) in their descriptors, even though they are
871 * USB 2.0 hubs. Some hubs do not implement port-power switching
872 * but only emulate it. In all cases, the ports won't work
873 * unless we send these messages to the hub.
875 if (hub_is_port_power_switchable(hub))
876 dev_dbg(hub->intfdev, "enabling power on all ports\n");
878 dev_dbg(hub->intfdev, "trying to enable port power on "
879 "non-switchable hub\n");
880 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
881 if (test_bit(port1, hub->power_bits))
882 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
884 usb_clear_port_feature(hub->hdev, port1,
885 USB_PORT_FEAT_POWER);
887 msleep(hub_power_on_good_delay(hub));
890 static int hub_hub_status(struct usb_hub *hub,
891 u16 *status, u16 *change)
895 mutex_lock(&hub->status_mutex);
896 ret = get_hub_status(hub->hdev, &hub->status->hub);
899 dev_err(hub->intfdev,
900 "%s failed (err = %d)\n", __func__, ret);
902 *status = le16_to_cpu(hub->status->hub.wHubStatus);
903 *change = le16_to_cpu(hub->status->hub.wHubChange);
906 mutex_unlock(&hub->status_mutex);
910 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
911 unsigned int link_status)
913 return set_port_feature(hub->hdev,
914 port1 | (link_status << 3),
915 USB_PORT_FEAT_LINK_STATE);
919 * Disable a port and mark a logical connect-change event, so that some
920 * time later hub_wq will disconnect() any existing usb_device on the port
921 * and will re-enumerate if there actually is a device attached.
923 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
925 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
926 hub_port_disable(hub, port1, 1);
928 /* FIXME let caller ask to power down the port:
929 * - some devices won't enumerate without a VBUS power cycle
930 * - SRP saves power that way
931 * - ... new call, TBD ...
932 * That's easy if this hub can switch power per-port, and
933 * hub_wq reactivates the port later (timer, SRP, etc).
934 * Powerdown must be optional, because of reset/DFU.
937 set_bit(port1, hub->change_bits);
942 * usb_remove_device - disable a device's port on its parent hub
943 * @udev: device to be disabled and removed
944 * Context: @udev locked, must be able to sleep.
946 * After @udev's port has been disabled, hub_wq is notified and it will
947 * see that the device has been disconnected. When the device is
948 * physically unplugged and something is plugged in, the events will
949 * be received and processed normally.
951 * Return: 0 if successful. A negative error code otherwise.
953 int usb_remove_device(struct usb_device *udev)
956 struct usb_interface *intf;
959 if (!udev->parent) /* Can't remove a root hub */
961 hub = usb_hub_to_struct_hub(udev->parent);
962 intf = to_usb_interface(hub->intfdev);
964 ret = usb_autopm_get_interface(intf);
968 set_bit(udev->portnum, hub->removed_bits);
969 hub_port_logical_disconnect(hub, udev->portnum);
970 usb_autopm_put_interface(intf);
974 enum hub_activation_type {
975 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
976 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
979 static void hub_init_func2(struct work_struct *ws);
980 static void hub_init_func3(struct work_struct *ws);
982 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
984 struct usb_device *hdev = hub->hdev;
989 bool need_debounce_delay = false;
992 /* Continue a partial initialization */
993 if (type == HUB_INIT2 || type == HUB_INIT3) {
994 device_lock(&hdev->dev);
996 /* Was the hub disconnected while we were waiting? */
997 if (hub->disconnected)
999 if (type == HUB_INIT2)
1003 kref_get(&hub->kref);
1005 /* The superspeed hub except for root hub has to use Hub Depth
1006 * value as an offset into the route string to locate the bits
1007 * it uses to determine the downstream port number. So hub driver
1008 * should send a set hub depth request to superspeed hub after
1009 * the superspeed hub is set configuration in initialization or
1012 * After a resume, port power should still be on.
1013 * For any other type of activation, turn it on.
1015 if (type != HUB_RESUME) {
1016 if (hdev->parent && hub_is_superspeed(hdev)) {
1017 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1018 HUB_SET_DEPTH, USB_RT_HUB,
1019 hdev->level - 1, 0, NULL, 0,
1020 USB_CTRL_SET_TIMEOUT);
1022 dev_err(hub->intfdev,
1023 "set hub depth failed\n");
1026 /* Speed up system boot by using a delayed_work for the
1027 * hub's initial power-up delays. This is pretty awkward
1028 * and the implementation looks like a home-brewed sort of
1029 * setjmp/longjmp, but it saves at least 100 ms for each
1030 * root hub (assuming usbcore is compiled into the kernel
1031 * rather than as a module). It adds up.
1033 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1034 * because for those activation types the ports have to be
1035 * operational when we return. In theory this could be done
1036 * for HUB_POST_RESET, but it's easier not to.
1038 if (type == HUB_INIT) {
1039 delay = hub_power_on_good_delay(hub);
1041 hub_power_on(hub, false);
1042 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1043 queue_delayed_work(system_power_efficient_wq,
1045 msecs_to_jiffies(delay));
1047 /* Suppress autosuspend until init is done */
1048 usb_autopm_get_interface_no_resume(
1049 to_usb_interface(hub->intfdev));
1050 return; /* Continues at init2: below */
1051 } else if (type == HUB_RESET_RESUME) {
1052 /* The internal host controller state for the hub device
1053 * may be gone after a host power loss on system resume.
1054 * Update the device's info so the HW knows it's a hub.
1056 hcd = bus_to_hcd(hdev->bus);
1057 if (hcd->driver->update_hub_device) {
1058 ret = hcd->driver->update_hub_device(hcd, hdev,
1059 &hub->tt, GFP_NOIO);
1061 dev_err(hub->intfdev, "Host not "
1062 "accepting hub info "
1064 dev_err(hub->intfdev, "LS/FS devices "
1065 "and hubs may not work "
1066 "under this hub\n.");
1069 hub_power_on(hub, true);
1071 hub_power_on(hub, true);
1077 * Check each port and set hub->change_bits to let hub_wq know
1078 * which ports need attention.
1080 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1081 struct usb_port *port_dev = hub->ports[port1 - 1];
1082 struct usb_device *udev = port_dev->child;
1083 u16 portstatus, portchange;
1085 portstatus = portchange = 0;
1086 status = hub_port_status(hub, port1, &portstatus, &portchange);
1090 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1091 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1092 portstatus, portchange);
1095 * After anything other than HUB_RESUME (i.e., initialization
1096 * or any sort of reset), every port should be disabled.
1097 * Unconnected ports should likewise be disabled (paranoia),
1098 * and so should ports for which we have no usb_device.
1100 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1101 type != HUB_RESUME ||
1102 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1104 udev->state == USB_STATE_NOTATTACHED)) {
1106 * USB3 protocol ports will automatically transition
1107 * to Enabled state when detect an USB3.0 device attach.
1108 * Do not disable USB3 protocol ports, just pretend
1111 portstatus &= ~USB_PORT_STAT_ENABLE;
1112 if (!hub_is_superspeed(hdev))
1113 usb_clear_port_feature(hdev, port1,
1114 USB_PORT_FEAT_ENABLE);
1117 /* Make sure a warm-reset request is handled by port_event */
1118 if (type == HUB_RESUME &&
1119 hub_port_warm_reset_required(hub, port1, portstatus))
1120 set_bit(port1, hub->event_bits);
1123 * Add debounce if USB3 link is in polling/link training state.
1124 * Link will automatically transition to Enabled state after
1125 * link training completes.
1127 if (hub_is_superspeed(hdev) &&
1128 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1129 USB_SS_PORT_LS_POLLING))
1130 need_debounce_delay = true;
1132 /* Clear status-change flags; we'll debounce later */
1133 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1134 need_debounce_delay = true;
1135 usb_clear_port_feature(hub->hdev, port1,
1136 USB_PORT_FEAT_C_CONNECTION);
1138 if (portchange & USB_PORT_STAT_C_ENABLE) {
1139 need_debounce_delay = true;
1140 usb_clear_port_feature(hub->hdev, port1,
1141 USB_PORT_FEAT_C_ENABLE);
1143 if (portchange & USB_PORT_STAT_C_RESET) {
1144 need_debounce_delay = true;
1145 usb_clear_port_feature(hub->hdev, port1,
1146 USB_PORT_FEAT_C_RESET);
1148 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1149 hub_is_superspeed(hub->hdev)) {
1150 need_debounce_delay = true;
1151 usb_clear_port_feature(hub->hdev, port1,
1152 USB_PORT_FEAT_C_BH_PORT_RESET);
1154 /* We can forget about a "removed" device when there's a
1155 * physical disconnect or the connect status changes.
1157 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1158 (portchange & USB_PORT_STAT_C_CONNECTION))
1159 clear_bit(port1, hub->removed_bits);
1161 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1162 /* Tell hub_wq to disconnect the device or
1163 * check for a new connection or over current condition.
1164 * Based on USB2.0 Spec Section 11.12.5,
1165 * C_PORT_OVER_CURRENT could be set while
1166 * PORT_OVER_CURRENT is not. So check for any of them.
1168 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1169 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1170 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1171 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1172 set_bit(port1, hub->change_bits);
1174 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1175 bool port_resumed = (portstatus &
1176 USB_PORT_STAT_LINK_STATE) ==
1178 /* The power session apparently survived the resume.
1179 * If there was an overcurrent or suspend change
1180 * (i.e., remote wakeup request), have hub_wq
1181 * take care of it. Look at the port link state
1182 * for USB 3.0 hubs, since they don't have a suspend
1183 * change bit, and they don't set the port link change
1184 * bit on device-initiated resume.
1186 if (portchange || (hub_is_superspeed(hub->hdev) &&
1188 set_bit(port1, hub->change_bits);
1190 } else if (udev->persist_enabled) {
1192 udev->reset_resume = 1;
1194 /* Don't set the change_bits when the device
1197 if (test_bit(port1, hub->power_bits))
1198 set_bit(port1, hub->change_bits);
1201 /* The power session is gone; tell hub_wq */
1202 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1203 set_bit(port1, hub->change_bits);
1207 /* If no port-status-change flags were set, we don't need any
1208 * debouncing. If flags were set we can try to debounce the
1209 * ports all at once right now, instead of letting hub_wq do them
1210 * one at a time later on.
1212 * If any port-status changes do occur during this delay, hub_wq
1213 * will see them later and handle them normally.
1215 if (need_debounce_delay) {
1216 delay = HUB_DEBOUNCE_STABLE;
1218 /* Don't do a long sleep inside a workqueue routine */
1219 if (type == HUB_INIT2) {
1220 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1221 queue_delayed_work(system_power_efficient_wq,
1223 msecs_to_jiffies(delay));
1224 device_unlock(&hdev->dev);
1225 return; /* Continues at init3: below */
1233 status = usb_submit_urb(hub->urb, GFP_NOIO);
1235 dev_err(hub->intfdev, "activate --> %d\n", status);
1236 if (hub->has_indicators && blinkenlights)
1237 queue_delayed_work(system_power_efficient_wq,
1238 &hub->leds, LED_CYCLE_PERIOD);
1240 /* Scan all ports that need attention */
1243 if (type == HUB_INIT2 || type == HUB_INIT3) {
1244 /* Allow autosuspend if it was suppressed */
1246 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1247 device_unlock(&hdev->dev);
1250 kref_put(&hub->kref, hub_release);
1253 /* Implement the continuations for the delays above */
1254 static void hub_init_func2(struct work_struct *ws)
1256 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1258 hub_activate(hub, HUB_INIT2);
1261 static void hub_init_func3(struct work_struct *ws)
1263 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1265 hub_activate(hub, HUB_INIT3);
1268 enum hub_quiescing_type {
1269 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1272 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1274 struct usb_device *hdev = hub->hdev;
1277 /* hub_wq and related activity won't re-trigger */
1280 if (type != HUB_SUSPEND) {
1281 /* Disconnect all the children */
1282 for (i = 0; i < hdev->maxchild; ++i) {
1283 if (hub->ports[i]->child)
1284 usb_disconnect(&hub->ports[i]->child);
1288 /* Stop hub_wq and related activity */
1289 usb_kill_urb(hub->urb);
1290 if (hub->has_indicators)
1291 cancel_delayed_work_sync(&hub->leds);
1293 flush_work(&hub->tt.clear_work);
1296 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1300 for (i = 0; i < hub->hdev->maxchild; ++i)
1301 pm_runtime_barrier(&hub->ports[i]->dev);
1304 /* caller has locked the hub device */
1305 static int hub_pre_reset(struct usb_interface *intf)
1307 struct usb_hub *hub = usb_get_intfdata(intf);
1309 hub_quiesce(hub, HUB_PRE_RESET);
1311 hub_pm_barrier_for_all_ports(hub);
1315 /* caller has locked the hub device */
1316 static int hub_post_reset(struct usb_interface *intf)
1318 struct usb_hub *hub = usb_get_intfdata(intf);
1321 hub_pm_barrier_for_all_ports(hub);
1322 hub_activate(hub, HUB_POST_RESET);
1326 static int hub_configure(struct usb_hub *hub,
1327 struct usb_endpoint_descriptor *endpoint)
1329 struct usb_hcd *hcd;
1330 struct usb_device *hdev = hub->hdev;
1331 struct device *hub_dev = hub->intfdev;
1332 u16 hubstatus, hubchange;
1333 u16 wHubCharacteristics;
1336 char *message = "out of memory";
1341 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1347 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1352 mutex_init(&hub->status_mutex);
1354 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1355 if (!hub->descriptor) {
1360 /* Request the entire hub descriptor.
1361 * hub->descriptor can handle USB_MAXCHILDREN ports,
1362 * but a (non-SS) hub can/will return fewer bytes here.
1364 ret = get_hub_descriptor(hdev, hub->descriptor);
1366 message = "can't read hub descriptor";
1370 maxchild = USB_MAXCHILDREN;
1371 if (hub_is_superspeed(hdev))
1372 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1374 if (hub->descriptor->bNbrPorts > maxchild) {
1375 message = "hub has too many ports!";
1378 } else if (hub->descriptor->bNbrPorts == 0) {
1379 message = "hub doesn't have any ports!";
1384 maxchild = hub->descriptor->bNbrPorts;
1385 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1386 (maxchild == 1) ? "" : "s");
1388 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
1394 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1395 if (hub_is_superspeed(hdev)) {
1403 /* FIXME for USB 3.0, skip for now */
1404 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1405 !(hub_is_superspeed(hdev))) {
1406 char portstr[USB_MAXCHILDREN + 1];
1408 for (i = 0; i < maxchild; i++)
1409 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1410 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1412 portstr[maxchild] = 0;
1413 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1415 dev_dbg(hub_dev, "standalone hub\n");
1417 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1418 case HUB_CHAR_COMMON_LPSM:
1419 dev_dbg(hub_dev, "ganged power switching\n");
1421 case HUB_CHAR_INDV_PORT_LPSM:
1422 dev_dbg(hub_dev, "individual port power switching\n");
1424 case HUB_CHAR_NO_LPSM:
1426 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1430 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1431 case HUB_CHAR_COMMON_OCPM:
1432 dev_dbg(hub_dev, "global over-current protection\n");
1434 case HUB_CHAR_INDV_PORT_OCPM:
1435 dev_dbg(hub_dev, "individual port over-current protection\n");
1437 case HUB_CHAR_NO_OCPM:
1439 dev_dbg(hub_dev, "no over-current protection\n");
1443 spin_lock_init(&hub->tt.lock);
1444 INIT_LIST_HEAD(&hub->tt.clear_list);
1445 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1446 switch (hdev->descriptor.bDeviceProtocol) {
1449 case USB_HUB_PR_HS_SINGLE_TT:
1450 dev_dbg(hub_dev, "Single TT\n");
1453 case USB_HUB_PR_HS_MULTI_TT:
1454 ret = usb_set_interface(hdev, 0, 1);
1456 dev_dbg(hub_dev, "TT per port\n");
1459 dev_err(hub_dev, "Using single TT (err %d)\n",
1464 /* USB 3.0 hubs don't have a TT */
1467 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1468 hdev->descriptor.bDeviceProtocol);
1472 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1473 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1474 case HUB_TTTT_8_BITS:
1475 if (hdev->descriptor.bDeviceProtocol != 0) {
1476 hub->tt.think_time = 666;
1477 dev_dbg(hub_dev, "TT requires at most %d "
1478 "FS bit times (%d ns)\n",
1479 8, hub->tt.think_time);
1482 case HUB_TTTT_16_BITS:
1483 hub->tt.think_time = 666 * 2;
1484 dev_dbg(hub_dev, "TT requires at most %d "
1485 "FS bit times (%d ns)\n",
1486 16, hub->tt.think_time);
1488 case HUB_TTTT_24_BITS:
1489 hub->tt.think_time = 666 * 3;
1490 dev_dbg(hub_dev, "TT requires at most %d "
1491 "FS bit times (%d ns)\n",
1492 24, hub->tt.think_time);
1494 case HUB_TTTT_32_BITS:
1495 hub->tt.think_time = 666 * 4;
1496 dev_dbg(hub_dev, "TT requires at most %d "
1497 "FS bit times (%d ns)\n",
1498 32, hub->tt.think_time);
1502 /* probe() zeroes hub->indicator[] */
1503 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1504 hub->has_indicators = 1;
1505 dev_dbg(hub_dev, "Port indicators are supported\n");
1508 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1509 hub->descriptor->bPwrOn2PwrGood * 2);
1511 /* power budgeting mostly matters with bus-powered hubs,
1512 * and battery-powered root hubs (may provide just 8 mA).
1514 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1516 message = "can't get hub status";
1519 hcd = bus_to_hcd(hdev->bus);
1520 if (hdev == hdev->bus->root_hub) {
1521 if (hcd->power_budget > 0)
1522 hdev->bus_mA = hcd->power_budget;
1524 hdev->bus_mA = full_load * maxchild;
1525 if (hdev->bus_mA >= full_load)
1526 hub->mA_per_port = full_load;
1528 hub->mA_per_port = hdev->bus_mA;
1529 hub->limited_power = 1;
1531 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1532 int remaining = hdev->bus_mA -
1533 hub->descriptor->bHubContrCurrent;
1535 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1536 hub->descriptor->bHubContrCurrent);
1537 hub->limited_power = 1;
1539 if (remaining < maxchild * unit_load)
1541 "insufficient power available "
1542 "to use all downstream ports\n");
1543 hub->mA_per_port = unit_load; /* 7.2.1 */
1545 } else { /* Self-powered external hub */
1546 /* FIXME: What about battery-powered external hubs that
1547 * provide less current per port? */
1548 hub->mA_per_port = full_load;
1550 if (hub->mA_per_port < full_load)
1551 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1554 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1556 message = "can't get hub status";
1560 /* local power status reports aren't always correct */
1561 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1562 dev_dbg(hub_dev, "local power source is %s\n",
1563 (hubstatus & HUB_STATUS_LOCAL_POWER)
1564 ? "lost (inactive)" : "good");
1566 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1567 dev_dbg(hub_dev, "%sover-current condition exists\n",
1568 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1570 /* set up the interrupt endpoint
1571 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1572 * bytes as USB2.0[11.12.3] says because some hubs are known
1573 * to send more data (and thus cause overflow). For root hubs,
1574 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1575 * to be big enough for at least USB_MAXCHILDREN ports. */
1576 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1577 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1579 if (maxp > sizeof(*hub->buffer))
1580 maxp = sizeof(*hub->buffer);
1582 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1588 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1589 hub, endpoint->bInterval);
1591 /* maybe cycle the hub leds */
1592 if (hub->has_indicators && blinkenlights)
1593 hub->indicator[0] = INDICATOR_CYCLE;
1595 mutex_lock(&usb_port_peer_mutex);
1596 for (i = 0; i < maxchild; i++) {
1597 ret = usb_hub_create_port_device(hub, i + 1);
1599 dev_err(hub->intfdev,
1600 "couldn't create port%d device.\n", i + 1);
1605 for (i = 0; i < hdev->maxchild; i++) {
1606 struct usb_port *port_dev = hub->ports[i];
1608 pm_runtime_put(&port_dev->dev);
1611 mutex_unlock(&usb_port_peer_mutex);
1615 /* Update the HCD's internal representation of this hub before hub_wq
1616 * starts getting port status changes for devices under the hub.
1618 if (hcd->driver->update_hub_device) {
1619 ret = hcd->driver->update_hub_device(hcd, hdev,
1620 &hub->tt, GFP_KERNEL);
1622 message = "can't update HCD hub info";
1627 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1629 hub_activate(hub, HUB_INIT);
1633 dev_err(hub_dev, "config failed, %s (err %d)\n",
1635 /* hub_disconnect() frees urb and descriptor */
1639 static void hub_release(struct kref *kref)
1641 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1643 usb_put_dev(hub->hdev);
1644 usb_put_intf(to_usb_interface(hub->intfdev));
1648 static unsigned highspeed_hubs;
1650 static void hub_disconnect(struct usb_interface *intf)
1652 struct usb_hub *hub = usb_get_intfdata(intf);
1653 struct usb_device *hdev = interface_to_usbdev(intf);
1657 * Stop adding new hub events. We do not want to block here and thus
1658 * will not try to remove any pending work item.
1660 hub->disconnected = 1;
1662 /* Disconnect all children and quiesce the hub */
1664 hub_quiesce(hub, HUB_DISCONNECT);
1666 mutex_lock(&usb_port_peer_mutex);
1668 /* Avoid races with recursively_mark_NOTATTACHED() */
1669 spin_lock_irq(&device_state_lock);
1670 port1 = hdev->maxchild;
1672 usb_set_intfdata(intf, NULL);
1673 spin_unlock_irq(&device_state_lock);
1675 for (; port1 > 0; --port1)
1676 usb_hub_remove_port_device(hub, port1);
1678 mutex_unlock(&usb_port_peer_mutex);
1680 if (hub->hdev->speed == USB_SPEED_HIGH)
1683 usb_free_urb(hub->urb);
1685 kfree(hub->descriptor);
1689 pm_suspend_ignore_children(&intf->dev, false);
1690 kref_put(&hub->kref, hub_release);
1693 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1695 struct usb_host_interface *desc;
1696 struct usb_endpoint_descriptor *endpoint;
1697 struct usb_device *hdev;
1698 struct usb_hub *hub;
1700 desc = intf->cur_altsetting;
1701 hdev = interface_to_usbdev(intf);
1704 * Set default autosuspend delay as 0 to speedup bus suspend,
1705 * based on the below considerations:
1707 * - Unlike other drivers, the hub driver does not rely on the
1708 * autosuspend delay to provide enough time to handle a wakeup
1709 * event, and the submitted status URB is just to check future
1710 * change on hub downstream ports, so it is safe to do it.
1712 * - The patch might cause one or more auto supend/resume for
1713 * below very rare devices when they are plugged into hub
1716 * devices having trouble initializing, and disconnect
1717 * themselves from the bus and then reconnect a second
1720 * devices just for downloading firmware, and disconnects
1721 * themselves after completing it
1723 * For these quite rare devices, their drivers may change the
1724 * autosuspend delay of their parent hub in the probe() to one
1725 * appropriate value to avoid the subtle problem if someone
1728 * - The patch may cause one or more auto suspend/resume on
1729 * hub during running 'lsusb', but it is probably too
1730 * infrequent to worry about.
1732 * - Change autosuspend delay of hub can avoid unnecessary auto
1733 * suspend timer for hub, also may decrease power consumption
1736 * - If user has indicated to prevent autosuspend by passing
1737 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1740 if (hdev->dev.power.autosuspend_delay >= 0)
1741 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1745 * Hubs have proper suspend/resume support, except for root hubs
1746 * where the controller driver doesn't have bus_suspend and
1747 * bus_resume methods.
1749 if (hdev->parent) { /* normal device */
1750 usb_enable_autosuspend(hdev);
1751 } else { /* root hub */
1752 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1754 if (drv->bus_suspend && drv->bus_resume)
1755 usb_enable_autosuspend(hdev);
1758 if (hdev->level == MAX_TOPO_LEVEL) {
1760 "Unsupported bus topology: hub nested too deep\n");
1764 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1766 dev_warn(&intf->dev, "ignoring external hub\n");
1771 /* Some hubs have a subclass of 1, which AFAICT according to the */
1772 /* specs is not defined, but it works */
1773 if ((desc->desc.bInterfaceSubClass != 0) &&
1774 (desc->desc.bInterfaceSubClass != 1)) {
1776 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1780 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1781 if (desc->desc.bNumEndpoints != 1)
1782 goto descriptor_error;
1784 endpoint = &desc->endpoint[0].desc;
1786 /* If it's not an interrupt in endpoint, we'd better punt! */
1787 if (!usb_endpoint_is_int_in(endpoint))
1788 goto descriptor_error;
1790 /* We found a hub */
1791 dev_info(&intf->dev, "USB hub found\n");
1793 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1797 kref_init(&hub->kref);
1798 hub->intfdev = &intf->dev;
1800 INIT_DELAYED_WORK(&hub->leds, led_work);
1801 INIT_DELAYED_WORK(&hub->init_work, NULL);
1802 INIT_WORK(&hub->events, hub_event);
1806 usb_set_intfdata(intf, hub);
1807 intf->needs_remote_wakeup = 1;
1808 pm_suspend_ignore_children(&intf->dev, true);
1810 if (hdev->speed == USB_SPEED_HIGH)
1813 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1814 hub->quirk_check_port_auto_suspend = 1;
1816 if (hub_configure(hub, endpoint) >= 0)
1819 hub_disconnect(intf);
1824 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1826 struct usb_device *hdev = interface_to_usbdev(intf);
1827 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1829 /* assert ifno == 0 (part of hub spec) */
1831 case USBDEVFS_HUB_PORTINFO: {
1832 struct usbdevfs_hub_portinfo *info = user_data;
1835 spin_lock_irq(&device_state_lock);
1836 if (hdev->devnum <= 0)
1839 info->nports = hdev->maxchild;
1840 for (i = 0; i < info->nports; i++) {
1841 if (hub->ports[i]->child == NULL)
1845 hub->ports[i]->child->devnum;
1848 spin_unlock_irq(&device_state_lock);
1850 return info->nports + 1;
1859 * Allow user programs to claim ports on a hub. When a device is attached
1860 * to one of these "claimed" ports, the program will "own" the device.
1862 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1863 struct usb_dev_state ***ppowner)
1865 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1867 if (hdev->state == USB_STATE_NOTATTACHED)
1869 if (port1 == 0 || port1 > hdev->maxchild)
1872 /* Devices not managed by the hub driver
1873 * will always have maxchild equal to 0.
1875 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1879 /* In the following three functions, the caller must hold hdev's lock */
1880 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1881 struct usb_dev_state *owner)
1884 struct usb_dev_state **powner;
1886 rc = find_port_owner(hdev, port1, &powner);
1894 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1896 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1897 struct usb_dev_state *owner)
1900 struct usb_dev_state **powner;
1902 rc = find_port_owner(hdev, port1, &powner);
1905 if (*powner != owner)
1910 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1912 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1914 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1917 for (n = 0; n < hdev->maxchild; n++) {
1918 if (hub->ports[n]->port_owner == owner)
1919 hub->ports[n]->port_owner = NULL;
1924 /* The caller must hold udev's lock */
1925 bool usb_device_is_owned(struct usb_device *udev)
1927 struct usb_hub *hub;
1929 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1931 hub = usb_hub_to_struct_hub(udev->parent);
1932 return !!hub->ports[udev->portnum - 1]->port_owner;
1935 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1937 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1940 for (i = 0; i < udev->maxchild; ++i) {
1941 if (hub->ports[i]->child)
1942 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1944 if (udev->state == USB_STATE_SUSPENDED)
1945 udev->active_duration -= jiffies;
1946 udev->state = USB_STATE_NOTATTACHED;
1950 * usb_set_device_state - change a device's current state (usbcore, hcds)
1951 * @udev: pointer to device whose state should be changed
1952 * @new_state: new state value to be stored
1954 * udev->state is _not_ fully protected by the device lock. Although
1955 * most transitions are made only while holding the lock, the state can
1956 * can change to USB_STATE_NOTATTACHED at almost any time. This
1957 * is so that devices can be marked as disconnected as soon as possible,
1958 * without having to wait for any semaphores to be released. As a result,
1959 * all changes to any device's state must be protected by the
1960 * device_state_lock spinlock.
1962 * Once a device has been added to the device tree, all changes to its state
1963 * should be made using this routine. The state should _not_ be set directly.
1965 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1966 * Otherwise udev->state is set to new_state, and if new_state is
1967 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1968 * to USB_STATE_NOTATTACHED.
1970 void usb_set_device_state(struct usb_device *udev,
1971 enum usb_device_state new_state)
1973 unsigned long flags;
1976 spin_lock_irqsave(&device_state_lock, flags);
1977 if (udev->state == USB_STATE_NOTATTACHED)
1979 else if (new_state != USB_STATE_NOTATTACHED) {
1981 /* root hub wakeup capabilities are managed out-of-band
1982 * and may involve silicon errata ... ignore them here.
1985 if (udev->state == USB_STATE_SUSPENDED
1986 || new_state == USB_STATE_SUSPENDED)
1987 ; /* No change to wakeup settings */
1988 else if (new_state == USB_STATE_CONFIGURED)
1989 wakeup = (udev->quirks &
1990 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1991 udev->actconfig->desc.bmAttributes &
1992 USB_CONFIG_ATT_WAKEUP;
1996 if (udev->state == USB_STATE_SUSPENDED &&
1997 new_state != USB_STATE_SUSPENDED)
1998 udev->active_duration -= jiffies;
1999 else if (new_state == USB_STATE_SUSPENDED &&
2000 udev->state != USB_STATE_SUSPENDED)
2001 udev->active_duration += jiffies;
2002 udev->state = new_state;
2004 recursively_mark_NOTATTACHED(udev);
2005 spin_unlock_irqrestore(&device_state_lock, flags);
2007 device_set_wakeup_capable(&udev->dev, wakeup);
2009 EXPORT_SYMBOL_GPL(usb_set_device_state);
2012 * Choose a device number.
2014 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2015 * USB-2.0 buses they are also used as device addresses, however on
2016 * USB-3.0 buses the address is assigned by the controller hardware
2017 * and it usually is not the same as the device number.
2019 * WUSB devices are simple: they have no hubs behind, so the mapping
2020 * device <-> virtual port number becomes 1:1. Why? to simplify the
2021 * life of the device connection logic in
2022 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2023 * handshake we need to assign a temporary address in the unauthorized
2024 * space. For simplicity we use the first virtual port number found to
2025 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2026 * and that becomes it's address [X < 128] or its unauthorized address
2029 * We add 1 as an offset to the one-based USB-stack port number
2030 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2031 * 0 is reserved by USB for default address; (b) Linux's USB stack
2032 * uses always #1 for the root hub of the controller. So USB stack's
2033 * port #1, which is wusb virtual-port #0 has address #2.
2035 * Devices connected under xHCI are not as simple. The host controller
2036 * supports virtualization, so the hardware assigns device addresses and
2037 * the HCD must setup data structures before issuing a set address
2038 * command to the hardware.
2040 static void choose_devnum(struct usb_device *udev)
2043 struct usb_bus *bus = udev->bus;
2045 /* be safe when more hub events are proceed in parallel */
2046 mutex_lock(&bus->devnum_next_mutex);
2048 devnum = udev->portnum + 1;
2049 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2051 /* Try to allocate the next devnum beginning at
2052 * bus->devnum_next. */
2053 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2056 devnum = find_next_zero_bit(bus->devmap.devicemap,
2058 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2061 set_bit(devnum, bus->devmap.devicemap);
2062 udev->devnum = devnum;
2064 mutex_unlock(&bus->devnum_next_mutex);
2067 static void release_devnum(struct usb_device *udev)
2069 if (udev->devnum > 0) {
2070 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2075 static void update_devnum(struct usb_device *udev, int devnum)
2077 /* The address for a WUSB device is managed by wusbcore. */
2079 udev->devnum = devnum;
2082 static void hub_free_dev(struct usb_device *udev)
2084 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2086 /* Root hubs aren't real devices, so don't free HCD resources */
2087 if (hcd->driver->free_dev && udev->parent)
2088 hcd->driver->free_dev(hcd, udev);
2091 static void hub_disconnect_children(struct usb_device *udev)
2093 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2096 /* Free up all the children before we remove this device */
2097 for (i = 0; i < udev->maxchild; i++) {
2098 if (hub->ports[i]->child)
2099 usb_disconnect(&hub->ports[i]->child);
2104 * usb_disconnect - disconnect a device (usbcore-internal)
2105 * @pdev: pointer to device being disconnected
2106 * Context: !in_interrupt ()
2108 * Something got disconnected. Get rid of it and all of its children.
2110 * If *pdev is a normal device then the parent hub must already be locked.
2111 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2112 * which protects the set of root hubs as well as the list of buses.
2114 * Only hub drivers (including virtual root hub drivers for host
2115 * controllers) should ever call this.
2117 * This call is synchronous, and may not be used in an interrupt context.
2119 void usb_disconnect(struct usb_device **pdev)
2121 struct usb_port *port_dev = NULL;
2122 struct usb_device *udev = *pdev;
2123 struct usb_hub *hub = NULL;
2126 /* mark the device as inactive, so any further urb submissions for
2127 * this device (and any of its children) will fail immediately.
2128 * this quiesces everything except pending urbs.
2130 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2131 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2135 * Ensure that the pm runtime code knows that the USB device
2136 * is in the process of being disconnected.
2138 pm_runtime_barrier(&udev->dev);
2140 usb_lock_device(udev);
2142 hub_disconnect_children(udev);
2144 /* deallocate hcd/hardware state ... nuking all pending urbs and
2145 * cleaning up all state associated with the current configuration
2146 * so that the hardware is now fully quiesced.
2148 dev_dbg(&udev->dev, "unregistering device\n");
2149 usb_disable_device(udev, 0);
2150 usb_hcd_synchronize_unlinks(udev);
2153 port1 = udev->portnum;
2154 hub = usb_hub_to_struct_hub(udev->parent);
2155 port_dev = hub->ports[port1 - 1];
2157 sysfs_remove_link(&udev->dev.kobj, "port");
2158 sysfs_remove_link(&port_dev->dev.kobj, "device");
2161 * As usb_port_runtime_resume() de-references udev, make
2162 * sure no resumes occur during removal
2164 if (!test_and_set_bit(port1, hub->child_usage_bits))
2165 pm_runtime_get_sync(&port_dev->dev);
2168 usb_remove_ep_devs(&udev->ep0);
2169 usb_unlock_device(udev);
2171 /* Unregister the device. The device driver is responsible
2172 * for de-configuring the device and invoking the remove-device
2173 * notifier chain (used by usbfs and possibly others).
2175 device_del(&udev->dev);
2177 /* Free the device number and delete the parent's children[]
2178 * (or root_hub) pointer.
2180 release_devnum(udev);
2182 /* Avoid races with recursively_mark_NOTATTACHED() */
2183 spin_lock_irq(&device_state_lock);
2185 spin_unlock_irq(&device_state_lock);
2187 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2188 pm_runtime_put(&port_dev->dev);
2192 put_device(&udev->dev);
2195 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2196 static void show_string(struct usb_device *udev, char *id, char *string)
2200 dev_info(&udev->dev, "%s: %s\n", id, string);
2203 static void announce_device(struct usb_device *udev)
2205 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2206 le16_to_cpu(udev->descriptor.idVendor),
2207 le16_to_cpu(udev->descriptor.idProduct));
2208 dev_info(&udev->dev,
2209 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2210 udev->descriptor.iManufacturer,
2211 udev->descriptor.iProduct,
2212 udev->descriptor.iSerialNumber);
2213 show_string(udev, "Product", udev->product);
2214 show_string(udev, "Manufacturer", udev->manufacturer);
2215 show_string(udev, "SerialNumber", udev->serial);
2218 static inline void announce_device(struct usb_device *udev) { }
2223 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2224 * @udev: newly addressed device (in ADDRESS state)
2226 * Finish enumeration for On-The-Go devices
2228 * Return: 0 if successful. A negative error code otherwise.
2230 static int usb_enumerate_device_otg(struct usb_device *udev)
2234 #ifdef CONFIG_USB_OTG
2236 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2237 * to wake us after we've powered off VBUS; and HNP, switching roles
2238 * "host" to "peripheral". The OTG descriptor helps figure this out.
2240 if (!udev->bus->is_b_host
2242 && udev->parent == udev->bus->root_hub) {
2243 struct usb_otg_descriptor *desc = NULL;
2244 struct usb_bus *bus = udev->bus;
2245 unsigned port1 = udev->portnum;
2247 /* descriptor may appear anywhere in config */
2248 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2249 le16_to_cpu(udev->config[0].desc.wTotalLength),
2250 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2251 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2254 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2255 (port1 == bus->otg_port) ? "" : "non-");
2257 /* enable HNP before suspend, it's simpler */
2258 if (port1 == bus->otg_port) {
2259 bus->b_hnp_enable = 1;
2260 err = usb_control_msg(udev,
2261 usb_sndctrlpipe(udev, 0),
2262 USB_REQ_SET_FEATURE, 0,
2263 USB_DEVICE_B_HNP_ENABLE,
2265 USB_CTRL_SET_TIMEOUT);
2268 * OTG MESSAGE: report errors here,
2269 * customize to match your product.
2271 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2273 bus->b_hnp_enable = 0;
2275 } else if (desc->bLength == sizeof
2276 (struct usb_otg_descriptor)) {
2277 /* Set a_alt_hnp_support for legacy otg device */
2278 err = usb_control_msg(udev,
2279 usb_sndctrlpipe(udev, 0),
2280 USB_REQ_SET_FEATURE, 0,
2281 USB_DEVICE_A_ALT_HNP_SUPPORT,
2283 USB_CTRL_SET_TIMEOUT);
2286 "set a_alt_hnp_support failed: %d\n",
2296 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2297 * @udev: newly addressed device (in ADDRESS state)
2299 * This is only called by usb_new_device() and usb_authorize_device()
2300 * and FIXME -- all comments that apply to them apply here wrt to
2303 * If the device is WUSB and not authorized, we don't attempt to read
2304 * the string descriptors, as they will be errored out by the device
2305 * until it has been authorized.
2307 * Return: 0 if successful. A negative error code otherwise.
2309 static int usb_enumerate_device(struct usb_device *udev)
2312 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2314 if (udev->config == NULL) {
2315 err = usb_get_configuration(udev);
2318 dev_err(&udev->dev, "can't read configurations, error %d\n",
2324 /* read the standard strings and cache them if present */
2325 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2326 udev->manufacturer = usb_cache_string(udev,
2327 udev->descriptor.iManufacturer);
2328 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2330 err = usb_enumerate_device_otg(udev);
2334 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2335 !is_targeted(udev)) {
2336 /* Maybe it can talk to us, though we can't talk to it.
2337 * (Includes HNP test device.)
2339 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2340 || udev->bus->is_b_host)) {
2341 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2343 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2348 usb_detect_interface_quirks(udev);
2353 static void set_usb_port_removable(struct usb_device *udev)
2355 struct usb_device *hdev = udev->parent;
2356 struct usb_hub *hub;
2357 u8 port = udev->portnum;
2358 u16 wHubCharacteristics;
2359 bool removable = true;
2364 hub = usb_hub_to_struct_hub(udev->parent);
2367 * If the platform firmware has provided information about a port,
2368 * use that to determine whether it's removable.
2370 switch (hub->ports[udev->portnum - 1]->connect_type) {
2371 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2372 udev->removable = USB_DEVICE_REMOVABLE;
2374 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2375 case USB_PORT_NOT_USED:
2376 udev->removable = USB_DEVICE_FIXED;
2383 * Otherwise, check whether the hub knows whether a port is removable
2386 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2388 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2391 if (hub_is_superspeed(hdev)) {
2392 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2396 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2401 udev->removable = USB_DEVICE_REMOVABLE;
2403 udev->removable = USB_DEVICE_FIXED;
2408 * usb_new_device - perform initial device setup (usbcore-internal)
2409 * @udev: newly addressed device (in ADDRESS state)
2411 * This is called with devices which have been detected but not fully
2412 * enumerated. The device descriptor is available, but not descriptors
2413 * for any device configuration. The caller must have locked either
2414 * the parent hub (if udev is a normal device) or else the
2415 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2416 * udev has already been installed, but udev is not yet visible through
2417 * sysfs or other filesystem code.
2419 * This call is synchronous, and may not be used in an interrupt context.
2421 * Only the hub driver or root-hub registrar should ever call this.
2423 * Return: Whether the device is configured properly or not. Zero if the
2424 * interface was registered with the driver core; else a negative errno
2428 int usb_new_device(struct usb_device *udev)
2433 /* Initialize non-root-hub device wakeup to disabled;
2434 * device (un)configuration controls wakeup capable
2435 * sysfs power/wakeup controls wakeup enabled/disabled
2437 device_init_wakeup(&udev->dev, 0);
2440 /* Tell the runtime-PM framework the device is active */
2441 pm_runtime_set_active(&udev->dev);
2442 pm_runtime_get_noresume(&udev->dev);
2443 pm_runtime_use_autosuspend(&udev->dev);
2444 pm_runtime_enable(&udev->dev);
2446 /* By default, forbid autosuspend for all devices. It will be
2447 * allowed for hubs during binding.
2449 usb_disable_autosuspend(udev);
2451 err = usb_enumerate_device(udev); /* Read descriptors */
2454 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2455 udev->devnum, udev->bus->busnum,
2456 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2457 /* export the usbdev device-node for libusb */
2458 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2459 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2461 /* Tell the world! */
2462 announce_device(udev);
2465 add_device_randomness(udev->serial, strlen(udev->serial));
2467 add_device_randomness(udev->product, strlen(udev->product));
2468 if (udev->manufacturer)
2469 add_device_randomness(udev->manufacturer,
2470 strlen(udev->manufacturer));
2472 device_enable_async_suspend(&udev->dev);
2474 /* check whether the hub or firmware marks this port as non-removable */
2476 set_usb_port_removable(udev);
2478 /* Register the device. The device driver is responsible
2479 * for configuring the device and invoking the add-device
2480 * notifier chain (used by usbfs and possibly others).
2482 err = device_add(&udev->dev);
2484 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2488 /* Create link files between child device and usb port device. */
2490 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2491 int port1 = udev->portnum;
2492 struct usb_port *port_dev = hub->ports[port1 - 1];
2494 err = sysfs_create_link(&udev->dev.kobj,
2495 &port_dev->dev.kobj, "port");
2499 err = sysfs_create_link(&port_dev->dev.kobj,
2500 &udev->dev.kobj, "device");
2502 sysfs_remove_link(&udev->dev.kobj, "port");
2506 if (!test_and_set_bit(port1, hub->child_usage_bits))
2507 pm_runtime_get_sync(&port_dev->dev);
2510 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2511 usb_mark_last_busy(udev);
2512 pm_runtime_put_sync_autosuspend(&udev->dev);
2516 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2517 pm_runtime_disable(&udev->dev);
2518 pm_runtime_set_suspended(&udev->dev);
2524 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2525 * @usb_dev: USB device
2527 * Move the USB device to a very basic state where interfaces are disabled
2528 * and the device is in fact unconfigured and unusable.
2530 * We share a lock (that we have) with device_del(), so we need to
2535 int usb_deauthorize_device(struct usb_device *usb_dev)
2537 usb_lock_device(usb_dev);
2538 if (usb_dev->authorized == 0)
2539 goto out_unauthorized;
2541 usb_dev->authorized = 0;
2542 usb_set_configuration(usb_dev, -1);
2545 usb_unlock_device(usb_dev);
2550 int usb_authorize_device(struct usb_device *usb_dev)
2554 usb_lock_device(usb_dev);
2555 if (usb_dev->authorized == 1)
2556 goto out_authorized;
2558 result = usb_autoresume_device(usb_dev);
2560 dev_err(&usb_dev->dev,
2561 "can't autoresume for authorization: %d\n", result);
2562 goto error_autoresume;
2565 if (usb_dev->wusb) {
2566 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2568 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2569 "authorization: %d\n", result);
2570 goto error_device_descriptor;
2574 usb_dev->authorized = 1;
2575 /* Choose and set the configuration. This registers the interfaces
2576 * with the driver core and lets interface drivers bind to them.
2578 c = usb_choose_configuration(usb_dev);
2580 result = usb_set_configuration(usb_dev, c);
2582 dev_err(&usb_dev->dev,
2583 "can't set config #%d, error %d\n", c, result);
2584 /* This need not be fatal. The user can try to
2585 * set other configurations. */
2588 dev_info(&usb_dev->dev, "authorized to connect\n");
2590 error_device_descriptor:
2591 usb_autosuspend_device(usb_dev);
2594 usb_unlock_device(usb_dev); /* complements locktree */
2599 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2600 * check it from the link protocol field of the current speed ID attribute.
2601 * current speed ID is got from ext port status request. Sublink speed attribute
2602 * table is returned with the hub BOS SSP device capability descriptor
2604 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2609 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2614 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2615 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2617 for (i = 0; i <= ssa_count; i++) {
2618 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2619 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2620 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2625 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2626 static unsigned hub_is_wusb(struct usb_hub *hub)
2628 struct usb_hcd *hcd;
2629 if (hub->hdev->parent != NULL) /* not a root hub? */
2631 hcd = bus_to_hcd(hub->hdev->bus);
2632 return hcd->wireless;
2636 #define PORT_RESET_TRIES 5
2637 #define SET_ADDRESS_TRIES 2
2638 #define GET_DESCRIPTOR_TRIES 2
2639 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2640 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2642 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2643 #define HUB_SHORT_RESET_TIME 10
2644 #define HUB_BH_RESET_TIME 50
2645 #define HUB_LONG_RESET_TIME 200
2646 #define HUB_RESET_TIMEOUT 800
2649 * "New scheme" enumeration causes an extra state transition to be
2650 * exposed to an xhci host and causes USB3 devices to receive control
2651 * commands in the default state. This has been seen to cause
2652 * enumeration failures, so disable this enumeration scheme for USB3
2655 static bool use_new_scheme(struct usb_device *udev, int retry)
2657 if (udev->speed >= USB_SPEED_SUPER)
2660 return USE_NEW_SCHEME(retry);
2663 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2664 * Port worm reset is required to recover
2666 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2671 if (!hub_is_superspeed(hub->hdev))
2674 if (test_bit(port1, hub->warm_reset_bits))
2677 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2678 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2679 || link_state == USB_SS_PORT_LS_COMP_MOD;
2682 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2683 struct usb_device *udev, unsigned int delay, bool warm)
2685 int delay_time, ret;
2688 u32 ext_portstatus = 0;
2690 for (delay_time = 0;
2691 delay_time < HUB_RESET_TIMEOUT;
2692 delay_time += delay) {
2693 /* wait to give the device a chance to reset */
2696 /* read and decode port status */
2697 if (hub_is_superspeedplus(hub->hdev))
2698 ret = hub_ext_port_status(hub, port1,
2699 HUB_EXT_PORT_STATUS,
2700 &portstatus, &portchange,
2703 ret = hub_port_status(hub, port1, &portstatus,
2709 * The port state is unknown until the reset completes.
2711 * On top of that, some chips may require additional time
2712 * to re-establish a connection after the reset is complete,
2713 * so also wait for the connection to be re-established.
2715 if (!(portstatus & USB_PORT_STAT_RESET) &&
2716 (portstatus & USB_PORT_STAT_CONNECTION))
2719 /* switch to the long delay after two short delay failures */
2720 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2721 delay = HUB_LONG_RESET_TIME;
2723 dev_dbg(&hub->ports[port1 - 1]->dev,
2724 "not %sreset yet, waiting %dms\n",
2725 warm ? "warm " : "", delay);
2728 if ((portstatus & USB_PORT_STAT_RESET))
2731 if (hub_port_warm_reset_required(hub, port1, portstatus))
2734 /* Device went away? */
2735 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2738 /* Retry if connect change is set but status is still connected.
2739 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2740 * but the device may have successfully re-connected. Ignore it.
2742 if (!hub_is_superspeed(hub->hdev) &&
2743 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2744 usb_clear_port_feature(hub->hdev, port1,
2745 USB_PORT_FEAT_C_CONNECTION);
2749 if (!(portstatus & USB_PORT_STAT_ENABLE))
2755 if (hub_is_wusb(hub))
2756 udev->speed = USB_SPEED_WIRELESS;
2757 else if (hub_is_superspeedplus(hub->hdev) &&
2758 port_speed_is_ssp(hub->hdev, ext_portstatus &
2759 USB_EXT_PORT_STAT_RX_SPEED_ID))
2760 udev->speed = USB_SPEED_SUPER_PLUS;
2761 else if (hub_is_superspeed(hub->hdev))
2762 udev->speed = USB_SPEED_SUPER;
2763 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2764 udev->speed = USB_SPEED_HIGH;
2765 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2766 udev->speed = USB_SPEED_LOW;
2768 udev->speed = USB_SPEED_FULL;
2772 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2773 static int hub_port_reset(struct usb_hub *hub, int port1,
2774 struct usb_device *udev, unsigned int delay, bool warm)
2777 u16 portchange, portstatus;
2778 struct usb_port *port_dev = hub->ports[port1 - 1];
2780 if (!hub_is_superspeed(hub->hdev)) {
2782 dev_err(hub->intfdev, "only USB3 hub support "
2786 /* Block EHCI CF initialization during the port reset.
2787 * Some companion controllers don't like it when they mix.
2789 down_read(&ehci_cf_port_reset_rwsem);
2792 * If the caller hasn't explicitly requested a warm reset,
2793 * double check and see if one is needed.
2795 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2796 if (hub_port_warm_reset_required(hub, port1,
2800 clear_bit(port1, hub->warm_reset_bits);
2802 /* Reset the port */
2803 for (i = 0; i < PORT_RESET_TRIES; i++) {
2804 status = set_port_feature(hub->hdev, port1, (warm ?
2805 USB_PORT_FEAT_BH_PORT_RESET :
2806 USB_PORT_FEAT_RESET));
2807 if (status == -ENODEV) {
2808 ; /* The hub is gone */
2809 } else if (status) {
2810 dev_err(&port_dev->dev,
2811 "cannot %sreset (err = %d)\n",
2812 warm ? "warm " : "", status);
2814 status = hub_port_wait_reset(hub, port1, udev, delay,
2816 if (status && status != -ENOTCONN && status != -ENODEV)
2817 dev_dbg(hub->intfdev,
2818 "port_wait_reset: err = %d\n",
2822 /* Check for disconnect or reset */
2823 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2824 usb_clear_port_feature(hub->hdev, port1,
2825 USB_PORT_FEAT_C_RESET);
2827 if (!hub_is_superspeed(hub->hdev))
2830 usb_clear_port_feature(hub->hdev, port1,
2831 USB_PORT_FEAT_C_BH_PORT_RESET);
2832 usb_clear_port_feature(hub->hdev, port1,
2833 USB_PORT_FEAT_C_PORT_LINK_STATE);
2836 usb_clear_port_feature(hub->hdev, port1,
2837 USB_PORT_FEAT_C_CONNECTION);
2840 * If a USB 3.0 device migrates from reset to an error
2841 * state, re-issue the warm reset.
2843 if (hub_port_status(hub, port1,
2844 &portstatus, &portchange) < 0)
2847 if (!hub_port_warm_reset_required(hub, port1,
2852 * If the port is in SS.Inactive or Compliance Mode, the
2853 * hot or warm reset failed. Try another warm reset.
2856 dev_dbg(&port_dev->dev,
2857 "hot reset failed, warm reset\n");
2862 dev_dbg(&port_dev->dev,
2863 "not enabled, trying %sreset again...\n",
2864 warm ? "warm " : "");
2865 delay = HUB_LONG_RESET_TIME;
2868 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2872 /* TRSTRCY = 10 ms; plus some extra */
2875 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2877 update_devnum(udev, 0);
2878 /* The xHC may think the device is already reset,
2879 * so ignore the status.
2881 if (hcd->driver->reset_device)
2882 hcd->driver->reset_device(hcd, udev);
2884 usb_set_device_state(udev, USB_STATE_DEFAULT);
2888 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2891 if (!hub_is_superspeed(hub->hdev))
2892 up_read(&ehci_cf_port_reset_rwsem);
2897 /* Check if a port is power on */
2898 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2902 if (hub_is_superspeed(hub->hdev)) {
2903 if (portstatus & USB_SS_PORT_STAT_POWER)
2906 if (portstatus & USB_PORT_STAT_POWER)
2913 static void usb_lock_port(struct usb_port *port_dev)
2914 __acquires(&port_dev->status_lock)
2916 mutex_lock(&port_dev->status_lock);
2917 __acquire(&port_dev->status_lock);
2920 static void usb_unlock_port(struct usb_port *port_dev)
2921 __releases(&port_dev->status_lock)
2923 mutex_unlock(&port_dev->status_lock);
2924 __release(&port_dev->status_lock);
2929 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2930 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2934 if (hub_is_superspeed(hub->hdev)) {
2935 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2936 == USB_SS_PORT_LS_U3)
2939 if (portstatus & USB_PORT_STAT_SUSPEND)
2946 /* Determine whether the device on a port is ready for a normal resume,
2947 * is ready for a reset-resume, or should be disconnected.
2949 static int check_port_resume_type(struct usb_device *udev,
2950 struct usb_hub *hub, int port1,
2951 int status, u16 portchange, u16 portstatus)
2953 struct usb_port *port_dev = hub->ports[port1 - 1];
2957 /* Is a warm reset needed to recover the connection? */
2958 if (status == 0 && udev->reset_resume
2959 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2962 /* Is the device still present? */
2963 else if (status || port_is_suspended(hub, portstatus) ||
2964 !port_is_power_on(hub, portstatus)) {
2967 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2969 usleep_range(200, 300);
2970 status = hub_port_status(hub, port1, &portstatus,
2977 /* Can't do a normal resume if the port isn't enabled,
2978 * so try a reset-resume instead.
2980 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2981 if (udev->persist_enabled)
2982 udev->reset_resume = 1;
2988 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2989 portchange, portstatus, status);
2990 } else if (udev->reset_resume) {
2992 /* Late port handoff can set status-change bits */
2993 if (portchange & USB_PORT_STAT_C_CONNECTION)
2994 usb_clear_port_feature(hub->hdev, port1,
2995 USB_PORT_FEAT_C_CONNECTION);
2996 if (portchange & USB_PORT_STAT_C_ENABLE)
2997 usb_clear_port_feature(hub->hdev, port1,
2998 USB_PORT_FEAT_C_ENABLE);
3001 * Whatever made this reset-resume necessary may have
3002 * turned on the port1 bit in hub->change_bits. But after
3003 * a successful reset-resume we want the bit to be clear;
3004 * if it was on it would indicate that something happened
3005 * following the reset-resume.
3007 clear_bit(port1, hub->change_bits);
3013 int usb_disable_ltm(struct usb_device *udev)
3015 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3017 /* Check if the roothub and device supports LTM. */
3018 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3019 !usb_device_supports_ltm(udev))
3022 /* Clear Feature LTM Enable can only be sent if the device is
3025 if (!udev->actconfig)
3028 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3029 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3030 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3031 USB_CTRL_SET_TIMEOUT);
3033 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3035 void usb_enable_ltm(struct usb_device *udev)
3037 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3039 /* Check if the roothub and device supports LTM. */
3040 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3041 !usb_device_supports_ltm(udev))
3044 /* Set Feature LTM Enable can only be sent if the device is
3047 if (!udev->actconfig)
3050 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3051 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3052 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3053 USB_CTRL_SET_TIMEOUT);
3055 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3058 * usb_enable_remote_wakeup - enable remote wakeup for a device
3059 * @udev: target device
3061 * For USB-2 devices: Set the device's remote wakeup feature.
3063 * For USB-3 devices: Assume there's only one function on the device and
3064 * enable remote wake for the first interface. FIXME if the interface
3065 * association descriptor shows there's more than one function.
3067 static int usb_enable_remote_wakeup(struct usb_device *udev)
3069 if (udev->speed < USB_SPEED_SUPER)
3070 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3071 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3072 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3073 USB_CTRL_SET_TIMEOUT);
3075 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3076 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3077 USB_INTRF_FUNC_SUSPEND,
3078 USB_INTRF_FUNC_SUSPEND_RW |
3079 USB_INTRF_FUNC_SUSPEND_LP,
3080 NULL, 0, USB_CTRL_SET_TIMEOUT);
3084 * usb_disable_remote_wakeup - disable remote wakeup for a device
3085 * @udev: target device
3087 * For USB-2 devices: Clear the device's remote wakeup feature.
3089 * For USB-3 devices: Assume there's only one function on the device and
3090 * disable remote wake for the first interface. FIXME if the interface
3091 * association descriptor shows there's more than one function.
3093 static int usb_disable_remote_wakeup(struct usb_device *udev)
3095 if (udev->speed < USB_SPEED_SUPER)
3096 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3097 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3098 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3099 USB_CTRL_SET_TIMEOUT);
3101 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3102 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3103 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3104 USB_CTRL_SET_TIMEOUT);
3107 /* Count of wakeup-enabled devices at or below udev */
3108 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3110 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3112 return udev->do_remote_wakeup +
3113 (hub ? hub->wakeup_enabled_descendants : 0);
3117 * usb_port_suspend - suspend a usb device's upstream port
3118 * @udev: device that's no longer in active use, not a root hub
3119 * Context: must be able to sleep; device not locked; pm locks held
3121 * Suspends a USB device that isn't in active use, conserving power.
3122 * Devices may wake out of a suspend, if anything important happens,
3123 * using the remote wakeup mechanism. They may also be taken out of
3124 * suspend by the host, using usb_port_resume(). It's also routine
3125 * to disconnect devices while they are suspended.
3127 * This only affects the USB hardware for a device; its interfaces
3128 * (and, for hubs, child devices) must already have been suspended.
3130 * Selective port suspend reduces power; most suspended devices draw
3131 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3132 * All devices below the suspended port are also suspended.
3134 * Devices leave suspend state when the host wakes them up. Some devices
3135 * also support "remote wakeup", where the device can activate the USB
3136 * tree above them to deliver data, such as a keypress or packet. In
3137 * some cases, this wakes the USB host.
3139 * Suspending OTG devices may trigger HNP, if that's been enabled
3140 * between a pair of dual-role devices. That will change roles, such
3141 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3143 * Devices on USB hub ports have only one "suspend" state, corresponding
3144 * to ACPI D2, "may cause the device to lose some context".
3145 * State transitions include:
3147 * - suspend, resume ... when the VBUS power link stays live
3148 * - suspend, disconnect ... VBUS lost
3150 * Once VBUS drop breaks the circuit, the port it's using has to go through
3151 * normal re-enumeration procedures, starting with enabling VBUS power.
3152 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3153 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3154 * timer, no SRP, no requests through sysfs.
3156 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3157 * suspended until their bus goes into global suspend (i.e., the root
3158 * hub is suspended). Nevertheless, we change @udev->state to
3159 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3160 * upstream port setting is stored in @udev->port_is_suspended.
3162 * Returns 0 on success, else negative errno.
3164 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3166 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3167 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3168 int port1 = udev->portnum;
3170 bool really_suspend = true;
3172 usb_lock_port(port_dev);
3174 /* enable remote wakeup when appropriate; this lets the device
3175 * wake up the upstream hub (including maybe the root hub).
3177 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3178 * we don't explicitly enable it here.
3180 if (udev->do_remote_wakeup) {
3181 status = usb_enable_remote_wakeup(udev);
3183 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3185 /* bail if autosuspend is requested */
3186 if (PMSG_IS_AUTO(msg))
3191 /* disable USB2 hardware LPM */
3192 usb_disable_usb2_hardware_lpm(udev);
3194 if (usb_disable_ltm(udev)) {
3195 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3197 if (PMSG_IS_AUTO(msg))
3200 if (usb_unlocked_disable_lpm(udev)) {
3201 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3203 if (PMSG_IS_AUTO(msg))
3208 if (hub_is_superspeed(hub->hdev))
3209 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3212 * For system suspend, we do not need to enable the suspend feature
3213 * on individual USB-2 ports. The devices will automatically go
3214 * into suspend a few ms after the root hub stops sending packets.
3215 * The USB 2.0 spec calls this "global suspend".
3217 * However, many USB hubs have a bug: They don't relay wakeup requests
3218 * from a downstream port if the port's suspend feature isn't on.
3219 * Therefore we will turn on the suspend feature if udev or any of its
3220 * descendants is enabled for remote wakeup.
3222 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3223 status = set_port_feature(hub->hdev, port1,
3224 USB_PORT_FEAT_SUSPEND);
3226 really_suspend = false;
3230 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3232 /* Try to enable USB3 LPM and LTM again */
3233 usb_unlocked_enable_lpm(udev);
3235 usb_enable_ltm(udev);
3237 /* Try to enable USB2 hardware LPM again */
3238 usb_enable_usb2_hardware_lpm(udev);
3240 if (udev->do_remote_wakeup)
3241 (void) usb_disable_remote_wakeup(udev);
3244 /* System sleep transitions should never fail */
3245 if (!PMSG_IS_AUTO(msg))
3248 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3249 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3250 udev->do_remote_wakeup);
3251 if (really_suspend) {
3252 udev->port_is_suspended = 1;
3254 /* device has up to 10 msec to fully suspend */
3257 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3260 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3261 && test_and_clear_bit(port1, hub->child_usage_bits))
3262 pm_runtime_put_sync(&port_dev->dev);
3264 usb_mark_last_busy(hub->hdev);
3266 usb_unlock_port(port_dev);
3271 * If the USB "suspend" state is in use (rather than "global suspend"),
3272 * many devices will be individually taken out of suspend state using
3273 * special "resume" signaling. This routine kicks in shortly after
3274 * hardware resume signaling is finished, either because of selective
3275 * resume (by host) or remote wakeup (by device) ... now see what changed
3276 * in the tree that's rooted at this device.
3278 * If @udev->reset_resume is set then the device is reset before the
3279 * status check is done.
3281 static int finish_port_resume(struct usb_device *udev)
3286 /* caller owns the udev device lock */
3287 dev_dbg(&udev->dev, "%s\n",
3288 udev->reset_resume ? "finish reset-resume" : "finish resume");
3290 /* usb ch9 identifies four variants of SUSPENDED, based on what
3291 * state the device resumes to. Linux currently won't see the
3292 * first two on the host side; they'd be inside hub_port_init()
3293 * during many timeouts, but hub_wq can't suspend until later.
3295 usb_set_device_state(udev, udev->actconfig
3296 ? USB_STATE_CONFIGURED
3297 : USB_STATE_ADDRESS);
3299 /* 10.5.4.5 says not to reset a suspended port if the attached
3300 * device is enabled for remote wakeup. Hence the reset
3301 * operation is carried out here, after the port has been
3304 if (udev->reset_resume) {
3306 * If the device morphs or switches modes when it is reset,
3307 * we don't want to perform a reset-resume. We'll fail the
3308 * resume, which will cause a logical disconnect, and then
3309 * the device will be rediscovered.
3312 if (udev->quirks & USB_QUIRK_RESET)
3315 status = usb_reset_and_verify_device(udev);
3318 /* 10.5.4.5 says be sure devices in the tree are still there.
3319 * For now let's assume the device didn't go crazy on resume,
3320 * and device drivers will know about any resume quirks.
3324 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3326 /* If a normal resume failed, try doing a reset-resume */
3327 if (status && !udev->reset_resume && udev->persist_enabled) {
3328 dev_dbg(&udev->dev, "retry with reset-resume\n");
3329 udev->reset_resume = 1;
3330 goto retry_reset_resume;
3335 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3338 * There are a few quirky devices which violate the standard
3339 * by claiming to have remote wakeup enabled after a reset,
3340 * which crash if the feature is cleared, hence check for
3341 * udev->reset_resume
3343 } else if (udev->actconfig && !udev->reset_resume) {
3344 if (udev->speed < USB_SPEED_SUPER) {
3345 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3346 status = usb_disable_remote_wakeup(udev);
3348 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3350 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3351 | USB_INTRF_STAT_FUNC_RW))
3352 status = usb_disable_remote_wakeup(udev);
3357 "disable remote wakeup, status %d\n",
3365 * There are some SS USB devices which take longer time for link training.
3366 * XHCI specs 4.19.4 says that when Link training is successful, port
3367 * sets CCS bit to 1. So if SW reads port status before successful link
3368 * training, then it will not find device to be present.
3369 * USB Analyzer log with such buggy devices show that in some cases
3370 * device switch on the RX termination after long delay of host enabling
3371 * the VBUS. In few other cases it has been seen that device fails to
3372 * negotiate link training in first attempt. It has been
3373 * reported till now that few devices take as long as 2000 ms to train
3374 * the link after host enabling its VBUS and termination. Following
3375 * routine implements a 2000 ms timeout for link training. If in a case
3376 * link trains before timeout, loop will exit earlier.
3378 * There are also some 2.0 hard drive based devices and 3.0 thumb
3379 * drives that, when plugged into a 2.0 only port, take a long
3380 * time to set CCS after VBUS enable.
3382 * FIXME: If a device was connected before suspend, but was removed
3383 * while system was asleep, then the loop in the following routine will
3384 * only exit at timeout.
3386 * This routine should only be called when persist is enabled.
3388 static int wait_for_connected(struct usb_device *udev,
3389 struct usb_hub *hub, int *port1,
3390 u16 *portchange, u16 *portstatus)
3392 int status = 0, delay_ms = 0;
3394 while (delay_ms < 2000) {
3395 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3397 if (!port_is_power_on(hub, *portstatus)) {
3403 status = hub_port_status(hub, *port1, portstatus, portchange);
3405 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3410 * usb_port_resume - re-activate a suspended usb device's upstream port
3411 * @udev: device to re-activate, not a root hub
3412 * Context: must be able to sleep; device not locked; pm locks held
3414 * This will re-activate the suspended device, increasing power usage
3415 * while letting drivers communicate again with its endpoints.
3416 * USB resume explicitly guarantees that the power session between
3417 * the host and the device is the same as it was when the device
3420 * If @udev->reset_resume is set then this routine won't check that the
3421 * port is still enabled. Furthermore, finish_port_resume() above will
3422 * reset @udev. The end result is that a broken power session can be
3423 * recovered and @udev will appear to persist across a loss of VBUS power.
3425 * For example, if a host controller doesn't maintain VBUS suspend current
3426 * during a system sleep or is reset when the system wakes up, all the USB
3427 * power sessions below it will be broken. This is especially troublesome
3428 * for mass-storage devices containing mounted filesystems, since the
3429 * device will appear to have disconnected and all the memory mappings
3430 * to it will be lost. Using the USB_PERSIST facility, the device can be
3431 * made to appear as if it had not disconnected.
3433 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3434 * every effort to insure that the same device is present after the
3435 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3436 * quite possible for a device to remain unaltered but its media to be
3437 * changed. If the user replaces a flash memory card while the system is
3438 * asleep, he will have only himself to blame when the filesystem on the
3439 * new card is corrupted and the system crashes.
3441 * Returns 0 on success, else negative errno.
3443 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3445 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3446 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3447 int port1 = udev->portnum;
3449 u16 portchange, portstatus;
3451 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3452 status = pm_runtime_get_sync(&port_dev->dev);
3454 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3460 usb_lock_port(port_dev);
3462 /* Skip the initial Clear-Suspend step for a remote wakeup */
3463 status = hub_port_status(hub, port1, &portstatus, &portchange);
3464 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3465 if (portchange & USB_PORT_STAT_C_SUSPEND)
3466 pm_wakeup_event(&udev->dev, 0);
3467 goto SuspendCleared;
3470 /* see 7.1.7.7; affects power usage, but not budgeting */
3471 if (hub_is_superspeed(hub->hdev))
3472 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3474 status = usb_clear_port_feature(hub->hdev,
3475 port1, USB_PORT_FEAT_SUSPEND);
3477 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3479 /* drive resume for USB_RESUME_TIMEOUT msec */
3480 dev_dbg(&udev->dev, "usb %sresume\n",
3481 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3482 msleep(USB_RESUME_TIMEOUT);
3484 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3485 * stop resume signaling. Then finish the resume
3488 status = hub_port_status(hub, port1, &portstatus, &portchange);
3493 udev->port_is_suspended = 0;
3494 if (hub_is_superspeed(hub->hdev)) {
3495 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3496 usb_clear_port_feature(hub->hdev, port1,
3497 USB_PORT_FEAT_C_PORT_LINK_STATE);
3499 if (portchange & USB_PORT_STAT_C_SUSPEND)
3500 usb_clear_port_feature(hub->hdev, port1,
3501 USB_PORT_FEAT_C_SUSPEND);
3504 /* TRSMRCY = 10 msec */
3508 if (udev->persist_enabled)
3509 status = wait_for_connected(udev, hub, &port1, &portchange,
3512 status = check_port_resume_type(udev,
3513 hub, port1, status, portchange, portstatus);
3515 status = finish_port_resume(udev);
3517 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3518 hub_port_logical_disconnect(hub, port1);
3520 /* Try to enable USB2 hardware LPM */
3521 usb_enable_usb2_hardware_lpm(udev);
3523 /* Try to enable USB3 LTM and LPM */
3524 usb_enable_ltm(udev);
3525 usb_unlocked_enable_lpm(udev);
3528 usb_unlock_port(port_dev);
3533 int usb_remote_wakeup(struct usb_device *udev)
3537 usb_lock_device(udev);
3538 if (udev->state == USB_STATE_SUSPENDED) {
3539 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3540 status = usb_autoresume_device(udev);
3542 /* Let the drivers do their thing, then... */
3543 usb_autosuspend_device(udev);
3546 usb_unlock_device(udev);
3550 /* Returns 1 if there was a remote wakeup and a connect status change. */
3551 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3552 u16 portstatus, u16 portchange)
3553 __must_hold(&port_dev->status_lock)
3555 struct usb_port *port_dev = hub->ports[port - 1];
3556 struct usb_device *hdev;
3557 struct usb_device *udev;
3558 int connect_change = 0;
3563 udev = port_dev->child;
3564 if (!hub_is_superspeed(hdev)) {
3565 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3567 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3569 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3570 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3571 (link_state != USB_SS_PORT_LS_U0 &&
3572 link_state != USB_SS_PORT_LS_U1 &&
3573 link_state != USB_SS_PORT_LS_U2))
3578 /* TRSMRCY = 10 msec */
3581 usb_unlock_port(port_dev);
3582 ret = usb_remote_wakeup(udev);
3583 usb_lock_port(port_dev);
3588 hub_port_disable(hub, port, 1);
3590 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3591 return connect_change;
3594 static int check_ports_changed(struct usb_hub *hub)
3598 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3599 u16 portstatus, portchange;
3602 status = hub_port_status(hub, port1, &portstatus, &portchange);
3603 if (!status && portchange)
3609 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3611 struct usb_hub *hub = usb_get_intfdata(intf);
3612 struct usb_device *hdev = hub->hdev;
3617 * Warn if children aren't already suspended.
3618 * Also, add up the number of wakeup-enabled descendants.
3620 hub->wakeup_enabled_descendants = 0;
3621 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3622 struct usb_port *port_dev = hub->ports[port1 - 1];
3623 struct usb_device *udev = port_dev->child;
3625 if (udev && udev->can_submit) {
3626 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3627 dev_name(&udev->dev));
3628 if (PMSG_IS_AUTO(msg))
3632 hub->wakeup_enabled_descendants +=
3633 wakeup_enabled_descendants(udev);
3636 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3637 /* check if there are changes pending on hub ports */
3638 if (check_ports_changed(hub)) {
3639 if (PMSG_IS_AUTO(msg))
3641 pm_wakeup_event(&hdev->dev, 2000);
3645 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3646 /* Enable hub to send remote wakeup for all ports. */
3647 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3648 status = set_port_feature(hdev,
3650 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3651 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3652 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3653 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3657 dev_dbg(&intf->dev, "%s\n", __func__);
3659 /* stop hub_wq and related activity */
3660 hub_quiesce(hub, HUB_SUSPEND);
3664 static int hub_resume(struct usb_interface *intf)
3666 struct usb_hub *hub = usb_get_intfdata(intf);
3668 dev_dbg(&intf->dev, "%s\n", __func__);
3669 hub_activate(hub, HUB_RESUME);
3673 static int hub_reset_resume(struct usb_interface *intf)
3675 struct usb_hub *hub = usb_get_intfdata(intf);
3677 dev_dbg(&intf->dev, "%s\n", __func__);
3678 hub_activate(hub, HUB_RESET_RESUME);
3683 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3684 * @rhdev: struct usb_device for the root hub
3686 * The USB host controller driver calls this function when its root hub
3687 * is resumed and Vbus power has been interrupted or the controller
3688 * has been reset. The routine marks @rhdev as having lost power.
3689 * When the hub driver is resumed it will take notice and carry out
3690 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3691 * the others will be disconnected.
3693 void usb_root_hub_lost_power(struct usb_device *rhdev)
3695 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3696 rhdev->reset_resume = 1;
3698 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3700 static const char * const usb3_lpm_names[] = {
3708 * Send a Set SEL control transfer to the device, prior to enabling
3709 * device-initiated U1 or U2. This lets the device know the exit latencies from
3710 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3711 * packet from the host.
3713 * This function will fail if the SEL or PEL values for udev are greater than
3714 * the maximum allowed values for the link state to be enabled.
3716 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3718 struct usb_set_sel_req *sel_values;
3719 unsigned long long u1_sel;
3720 unsigned long long u1_pel;
3721 unsigned long long u2_sel;
3722 unsigned long long u2_pel;
3725 if (udev->state != USB_STATE_CONFIGURED)
3728 /* Convert SEL and PEL stored in ns to us */
3729 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3730 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3731 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3732 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3735 * Make sure that the calculated SEL and PEL values for the link
3736 * state we're enabling aren't bigger than the max SEL/PEL
3737 * value that will fit in the SET SEL control transfer.
3738 * Otherwise the device would get an incorrect idea of the exit
3739 * latency for the link state, and could start a device-initiated
3740 * U1/U2 when the exit latencies are too high.
3742 if ((state == USB3_LPM_U1 &&
3743 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3744 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3745 (state == USB3_LPM_U2 &&
3746 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3747 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3748 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3749 usb3_lpm_names[state], u1_sel, u1_pel);
3754 * If we're enabling device-initiated LPM for one link state,
3755 * but the other link state has a too high SEL or PEL value,
3756 * just set those values to the max in the Set SEL request.
3758 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3759 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3761 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3762 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3764 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3765 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3767 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3768 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3771 * usb_enable_lpm() can be called as part of a failed device reset,
3772 * which may be initiated by an error path of a mass storage driver.
3773 * Therefore, use GFP_NOIO.
3775 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3779 sel_values->u1_sel = u1_sel;
3780 sel_values->u1_pel = u1_pel;
3781 sel_values->u2_sel = cpu_to_le16(u2_sel);
3782 sel_values->u2_pel = cpu_to_le16(u2_pel);
3784 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3788 sel_values, sizeof *(sel_values),
3789 USB_CTRL_SET_TIMEOUT);
3795 * Enable or disable device-initiated U1 or U2 transitions.
3797 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3798 enum usb3_link_state state, bool enable)
3805 feature = USB_DEVICE_U1_ENABLE;
3808 feature = USB_DEVICE_U2_ENABLE;
3811 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3812 __func__, enable ? "enable" : "disable");
3816 if (udev->state != USB_STATE_CONFIGURED) {
3817 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3818 "for unconfigured device.\n",
3819 __func__, enable ? "enable" : "disable",
3820 usb3_lpm_names[state]);
3826 * Now send the control transfer to enable device-initiated LPM
3827 * for either U1 or U2.
3829 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3830 USB_REQ_SET_FEATURE,
3834 USB_CTRL_SET_TIMEOUT);
3836 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3837 USB_REQ_CLEAR_FEATURE,
3841 USB_CTRL_SET_TIMEOUT);
3844 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3845 enable ? "Enable" : "Disable",
3846 usb3_lpm_names[state]);
3852 static int usb_set_lpm_timeout(struct usb_device *udev,
3853 enum usb3_link_state state, int timeout)
3860 feature = USB_PORT_FEAT_U1_TIMEOUT;
3863 feature = USB_PORT_FEAT_U2_TIMEOUT;
3866 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3871 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3872 timeout != USB3_LPM_DEVICE_INITIATED) {
3873 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3874 "which is a reserved value.\n",
3875 usb3_lpm_names[state], timeout);
3879 ret = set_port_feature(udev->parent,
3880 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3883 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3884 "error code %i\n", usb3_lpm_names[state],
3888 if (state == USB3_LPM_U1)
3889 udev->u1_params.timeout = timeout;
3891 udev->u2_params.timeout = timeout;
3896 * Don't allow device intiated U1/U2 if the system exit latency + one bus
3897 * interval is greater than the minimum service interval of any active
3898 * periodic endpoint. See USB 3.2 section 9.4.9
3900 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
3901 enum usb3_link_state state)
3903 unsigned int sel; /* us */
3906 if (state == USB3_LPM_U1)
3907 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3908 else if (state == USB3_LPM_U2)
3909 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3913 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3914 struct usb_interface *intf;
3915 struct usb_endpoint_descriptor *desc;
3916 unsigned int interval;
3918 intf = udev->actconfig->interface[i];
3922 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
3923 desc = &intf->cur_altsetting->endpoint[j].desc;
3925 if (usb_endpoint_xfer_int(desc) ||
3926 usb_endpoint_xfer_isoc(desc)) {
3927 interval = (1 << (desc->bInterval - 1)) * 125;
3928 if (sel + 125 > interval)
3937 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3940 * We will attempt to enable U1 or U2, but there are no guarantees that the
3941 * control transfers to set the hub timeout or enable device-initiated U1/U2
3942 * will be successful.
3944 * If the control transfer to enable device-initiated U1/U2 entry fails, then
3945 * hub-initiated U1/U2 will be disabled.
3947 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3948 * driver know about it. If that call fails, it should be harmless, and just
3949 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3951 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3952 enum usb3_link_state state)
3955 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3956 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3958 /* If the device says it doesn't have *any* exit latency to come out of
3959 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3962 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3963 (state == USB3_LPM_U2 && u2_mel == 0))
3967 * First, let the device know about the exit latencies
3968 * associated with the link state we're about to enable.
3970 ret = usb_req_set_sel(udev, state);
3972 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3973 usb3_lpm_names[state]);
3977 /* We allow the host controller to set the U1/U2 timeout internally
3978 * first, so that it can change its schedule to account for the
3979 * additional latency to send data to a device in a lower power
3982 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3984 /* xHCI host controller doesn't want to enable this LPM state. */
3989 dev_warn(&udev->dev, "Could not enable %s link state, "
3990 "xHCI error %i.\n", usb3_lpm_names[state],
3995 if (usb_set_lpm_timeout(udev, state, timeout)) {
3996 /* If we can't set the parent hub U1/U2 timeout,
3997 * device-initiated LPM won't be allowed either, so let the xHCI
3998 * host know that this link state won't be enabled.
4000 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4004 /* Only a configured device will accept the Set Feature
4007 if (udev->actconfig &&
4008 usb_device_may_initiate_lpm(udev, state)) {
4009 if (usb_set_device_initiated_lpm(udev, state, true)) {
4011 * Request to enable device initiated U1/U2 failed,
4012 * better to turn off lpm in this case.
4014 usb_set_lpm_timeout(udev, state, 0);
4015 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4020 if (state == USB3_LPM_U1)
4021 udev->usb3_lpm_u1_enabled = 1;
4022 else if (state == USB3_LPM_U2)
4023 udev->usb3_lpm_u2_enabled = 1;
4026 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4029 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4030 * If zero is returned, the parent will not allow the link to go into U1/U2.
4032 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4033 * it won't have an effect on the bus link state because the parent hub will
4034 * still disallow device-initiated U1/U2 entry.
4036 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4037 * possible. The result will be slightly more bus bandwidth will be taken up
4038 * (to account for U1/U2 exit latency), but it should be harmless.
4040 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4041 enum usb3_link_state state)
4048 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4053 if (usb_set_lpm_timeout(udev, state, 0))
4056 usb_set_device_initiated_lpm(udev, state, false);
4058 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4059 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4060 "bus schedule bandwidth may be impacted.\n",
4061 usb3_lpm_names[state]);
4063 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4064 * is disabled. Hub will disallows link to enter U1/U2 as well,
4065 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4066 * timeout set to 0, no matter device-initiated LPM is disabled or
4069 if (state == USB3_LPM_U1)
4070 udev->usb3_lpm_u1_enabled = 0;
4071 else if (state == USB3_LPM_U2)
4072 udev->usb3_lpm_u2_enabled = 0;
4078 * Disable hub-initiated and device-initiated U1 and U2 entry.
4079 * Caller must own the bandwidth_mutex.
4081 * This will call usb_enable_lpm() on failure, which will decrement
4082 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4084 int usb_disable_lpm(struct usb_device *udev)
4086 struct usb_hcd *hcd;
4088 if (!udev || !udev->parent ||
4089 udev->speed < USB_SPEED_SUPER ||
4090 !udev->lpm_capable ||
4091 udev->state < USB_STATE_DEFAULT)
4094 hcd = bus_to_hcd(udev->bus);
4095 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4098 udev->lpm_disable_count++;
4099 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4102 /* If LPM is enabled, attempt to disable it. */
4103 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4105 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4111 usb_enable_lpm(udev);
4114 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4116 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4117 int usb_unlocked_disable_lpm(struct usb_device *udev)
4119 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4125 mutex_lock(hcd->bandwidth_mutex);
4126 ret = usb_disable_lpm(udev);
4127 mutex_unlock(hcd->bandwidth_mutex);
4131 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4134 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4135 * xHCI host policy may prevent U1 or U2 from being enabled.
4137 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4138 * until the lpm_disable_count drops to zero. Caller must own the
4141 void usb_enable_lpm(struct usb_device *udev)
4143 struct usb_hcd *hcd;
4144 struct usb_hub *hub;
4145 struct usb_port *port_dev;
4147 if (!udev || !udev->parent ||
4148 udev->speed < USB_SPEED_SUPER ||
4149 !udev->lpm_capable ||
4150 udev->state < USB_STATE_DEFAULT)
4153 udev->lpm_disable_count--;
4154 hcd = bus_to_hcd(udev->bus);
4155 /* Double check that we can both enable and disable LPM.
4156 * Device must be configured to accept set feature U1/U2 timeout.
4158 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4159 !hcd->driver->disable_usb3_lpm_timeout)
4162 if (udev->lpm_disable_count > 0)
4165 hub = usb_hub_to_struct_hub(udev->parent);
4169 port_dev = hub->ports[udev->portnum - 1];
4171 if (port_dev->usb3_lpm_u1_permit)
4172 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4174 if (port_dev->usb3_lpm_u2_permit)
4175 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4177 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4179 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4180 void usb_unlocked_enable_lpm(struct usb_device *udev)
4182 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4187 mutex_lock(hcd->bandwidth_mutex);
4188 usb_enable_lpm(udev);
4189 mutex_unlock(hcd->bandwidth_mutex);
4191 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4193 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4194 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4195 struct usb_port *port_dev)
4197 struct usb_device *udev = port_dev->child;
4200 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4201 ret = hub_set_port_link_state(hub, port_dev->portnum,
4204 msleep(USB_RESUME_TIMEOUT);
4205 ret = usb_disable_remote_wakeup(udev);
4208 dev_warn(&udev->dev,
4209 "Port disable: can't disable remote wake\n");
4210 udev->do_remote_wakeup = 0;
4214 #else /* CONFIG_PM */
4216 #define hub_suspend NULL
4217 #define hub_resume NULL
4218 #define hub_reset_resume NULL
4220 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4221 struct usb_port *port_dev) { }
4223 int usb_disable_lpm(struct usb_device *udev)
4227 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4229 void usb_enable_lpm(struct usb_device *udev) { }
4230 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4232 int usb_unlocked_disable_lpm(struct usb_device *udev)
4236 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4238 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4239 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4241 int usb_disable_ltm(struct usb_device *udev)
4245 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4247 void usb_enable_ltm(struct usb_device *udev) { }
4248 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4250 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4251 u16 portstatus, u16 portchange)
4256 #endif /* CONFIG_PM */
4259 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4260 * a connection with a plugged-in cable but will signal the host when the cable
4261 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4263 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4265 struct usb_port *port_dev = hub->ports[port1 - 1];
4266 struct usb_device *hdev = hub->hdev;
4270 if (hub_is_superspeed(hub->hdev)) {
4271 hub_usb3_port_prepare_disable(hub, port_dev);
4272 ret = hub_set_port_link_state(hub, port_dev->portnum,
4275 ret = usb_clear_port_feature(hdev, port1,
4276 USB_PORT_FEAT_ENABLE);
4279 if (port_dev->child && set_state)
4280 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4281 if (ret && ret != -ENODEV)
4282 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4287 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4289 * Between connect detection and reset signaling there must be a delay
4290 * of 100ms at least for debounce and power-settling. The corresponding
4291 * timer shall restart whenever the downstream port detects a disconnect.
4293 * Apparently there are some bluetooth and irda-dongles and a number of
4294 * low-speed devices for which this debounce period may last over a second.
4295 * Not covered by the spec - but easy to deal with.
4297 * This implementation uses a 1500ms total debounce timeout; if the
4298 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4299 * every 25ms for transient disconnects. When the port status has been
4300 * unchanged for 100ms it returns the port status.
4302 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4305 u16 portchange, portstatus;
4306 unsigned connection = 0xffff;
4307 int total_time, stable_time = 0;
4308 struct usb_port *port_dev = hub->ports[port1 - 1];
4310 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4311 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4315 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4316 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4317 if (!must_be_connected ||
4318 (connection == USB_PORT_STAT_CONNECTION))
4319 stable_time += HUB_DEBOUNCE_STEP;
4320 if (stable_time >= HUB_DEBOUNCE_STABLE)
4324 connection = portstatus & USB_PORT_STAT_CONNECTION;
4327 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4328 usb_clear_port_feature(hub->hdev, port1,
4329 USB_PORT_FEAT_C_CONNECTION);
4332 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4334 msleep(HUB_DEBOUNCE_STEP);
4337 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4338 total_time, stable_time, portstatus);
4340 if (stable_time < HUB_DEBOUNCE_STABLE)
4345 void usb_ep0_reinit(struct usb_device *udev)
4347 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4348 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4349 usb_enable_endpoint(udev, &udev->ep0, true);
4351 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4353 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4354 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4356 static int hub_set_address(struct usb_device *udev, int devnum)
4359 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4362 * The host controller will choose the device address,
4363 * instead of the core having chosen it earlier
4365 if (!hcd->driver->address_device && devnum <= 1)
4367 if (udev->state == USB_STATE_ADDRESS)
4369 if (udev->state != USB_STATE_DEFAULT)
4371 if (hcd->driver->address_device)
4372 retval = hcd->driver->address_device(hcd, udev);
4374 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4375 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4376 NULL, 0, USB_CTRL_SET_TIMEOUT);
4378 update_devnum(udev, devnum);
4379 /* Device now using proper address. */
4380 usb_set_device_state(udev, USB_STATE_ADDRESS);
4381 usb_ep0_reinit(udev);
4387 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4388 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4391 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4392 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4393 * support bit in the BOS descriptor.
4395 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4397 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4398 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4400 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4404 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4406 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4407 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4408 udev->usb2_hw_lpm_allowed = 1;
4409 usb_enable_usb2_hardware_lpm(udev);
4413 static int hub_enable_device(struct usb_device *udev)
4415 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4417 if (!hcd->driver->enable_device)
4419 if (udev->state == USB_STATE_ADDRESS)
4421 if (udev->state != USB_STATE_DEFAULT)
4424 return hcd->driver->enable_device(hcd, udev);
4427 /* Reset device, (re)assign address, get device descriptor.
4428 * Device connection must be stable, no more debouncing needed.
4429 * Returns device in USB_STATE_ADDRESS, except on error.
4431 * If this is called for an already-existing device (as part of
4432 * usb_reset_and_verify_device), the caller must own the device lock and
4433 * the port lock. For a newly detected device that is not accessible
4434 * through any global pointers, it's not necessary to lock the device,
4435 * but it is still necessary to lock the port.
4438 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4441 struct usb_device *hdev = hub->hdev;
4442 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4443 int retries, operations, retval, i;
4444 unsigned delay = HUB_SHORT_RESET_TIME;
4445 enum usb_device_speed oldspeed = udev->speed;
4447 int devnum = udev->devnum;
4449 /* root hub ports have a slightly longer reset period
4450 * (from USB 2.0 spec, section 7.1.7.5)
4452 if (!hdev->parent) {
4453 delay = HUB_ROOT_RESET_TIME;
4454 if (port1 == hdev->bus->otg_port)
4455 hdev->bus->b_hnp_enable = 0;
4458 /* Some low speed devices have problems with the quick delay, so */
4459 /* be a bit pessimistic with those devices. RHbug #23670 */
4460 if (oldspeed == USB_SPEED_LOW)
4461 delay = HUB_LONG_RESET_TIME;
4463 /* Reset the device; full speed may morph to high speed */
4464 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4465 retval = hub_port_reset(hub, port1, udev, delay, false);
4466 if (retval < 0) /* error or disconnect */
4468 /* success, speed is known */
4472 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4473 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4474 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4475 dev_dbg(&udev->dev, "device reset changed speed!\n");
4478 oldspeed = udev->speed;
4480 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4481 * it's fixed size except for full speed devices.
4482 * For Wireless USB devices, ep0 max packet is always 512 (tho
4483 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4485 switch (udev->speed) {
4486 case USB_SPEED_SUPER_PLUS:
4487 case USB_SPEED_SUPER:
4488 case USB_SPEED_WIRELESS: /* fixed at 512 */
4489 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4491 case USB_SPEED_HIGH: /* fixed at 64 */
4492 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4494 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4495 /* to determine the ep0 maxpacket size, try to read
4496 * the device descriptor to get bMaxPacketSize0 and
4497 * then correct our initial guess.
4499 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4501 case USB_SPEED_LOW: /* fixed at 8 */
4502 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4508 if (udev->speed == USB_SPEED_WIRELESS)
4509 speed = "variable speed Wireless";
4511 speed = usb_speed_string(udev->speed);
4513 if (udev->speed < USB_SPEED_SUPER)
4514 dev_info(&udev->dev,
4515 "%s %s USB device number %d using %s\n",
4516 (udev->config) ? "reset" : "new", speed,
4517 devnum, udev->bus->controller->driver->name);
4519 /* Set up TT records, if needed */
4521 udev->tt = hdev->tt;
4522 udev->ttport = hdev->ttport;
4523 } else if (udev->speed != USB_SPEED_HIGH
4524 && hdev->speed == USB_SPEED_HIGH) {
4526 dev_err(&udev->dev, "parent hub has no TT\n");
4530 udev->tt = &hub->tt;
4531 udev->ttport = port1;
4534 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4535 * Because device hardware and firmware is sometimes buggy in
4536 * this area, and this is how Linux has done it for ages.
4537 * Change it cautiously.
4539 * NOTE: If use_new_scheme() is true we will start by issuing
4540 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4541 * so it may help with some non-standards-compliant devices.
4542 * Otherwise we start with SET_ADDRESS and then try to read the
4543 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4546 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4547 bool did_new_scheme = false;
4549 if (use_new_scheme(udev, retry_counter)) {
4550 struct usb_device_descriptor *buf;
4553 did_new_scheme = true;
4554 retval = hub_enable_device(udev);
4557 "hub failed to enable device, error %d\n",
4562 #define GET_DESCRIPTOR_BUFSIZE 64
4563 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4569 /* Retry on all errors; some devices are flakey.
4570 * 255 is for WUSB devices, we actually need to use
4571 * 512 (WUSB1.0[4.8.1]).
4573 for (operations = 0; operations < 3; ++operations) {
4574 buf->bMaxPacketSize0 = 0;
4575 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4576 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4577 USB_DT_DEVICE << 8, 0,
4578 buf, GET_DESCRIPTOR_BUFSIZE,
4579 initial_descriptor_timeout);
4580 switch (buf->bMaxPacketSize0) {
4581 case 8: case 16: case 32: case 64: case 255:
4582 if (buf->bDescriptorType ==
4594 * Some devices time out if they are powered on
4595 * when already connected. They need a second
4596 * reset. But only on the first attempt,
4597 * lest we get into a time out/reset loop
4599 if (r == 0 || (r == -ETIMEDOUT &&
4601 udev->speed > USB_SPEED_FULL))
4604 udev->descriptor.bMaxPacketSize0 =
4605 buf->bMaxPacketSize0;
4608 retval = hub_port_reset(hub, port1, udev, delay, false);
4609 if (retval < 0) /* error or disconnect */
4611 if (oldspeed != udev->speed) {
4613 "device reset changed speed!\n");
4619 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4624 #undef GET_DESCRIPTOR_BUFSIZE
4628 * If device is WUSB, we already assigned an
4629 * unauthorized address in the Connect Ack sequence;
4630 * authorization will assign the final address.
4632 if (udev->wusb == 0) {
4633 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4634 retval = hub_set_address(udev, devnum);
4640 if (retval != -ENODEV)
4641 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4645 if (udev->speed >= USB_SPEED_SUPER) {
4646 devnum = udev->devnum;
4647 dev_info(&udev->dev,
4648 "%s SuperSpeed%s USB device number %d using %s\n",
4649 (udev->config) ? "reset" : "new",
4650 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
4651 devnum, udev->bus->controller->driver->name);
4654 /* cope with hardware quirkiness:
4655 * - let SET_ADDRESS settle, some device hardware wants it
4656 * - read ep0 maxpacket even for high and low speed,
4659 /* use_new_scheme() checks the speed which may have
4660 * changed since the initial look so we cache the result
4667 retval = usb_get_device_descriptor(udev, 8);
4669 if (retval != -ENODEV)
4671 "device descriptor read/8, error %d\n",
4684 * Some superspeed devices have finished the link training process
4685 * and attached to a superspeed hub port, but the device descriptor
4686 * got from those devices show they aren't superspeed devices. Warm
4687 * reset the port attached by the devices can fix them.
4689 if ((udev->speed >= USB_SPEED_SUPER) &&
4690 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4691 dev_err(&udev->dev, "got a wrong device descriptor, "
4692 "warm reset device\n");
4693 hub_port_reset(hub, port1, udev,
4694 HUB_BH_RESET_TIME, true);
4699 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4700 udev->speed >= USB_SPEED_SUPER)
4703 i = udev->descriptor.bMaxPacketSize0;
4704 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4705 if (udev->speed == USB_SPEED_LOW ||
4706 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4707 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4711 if (udev->speed == USB_SPEED_FULL)
4712 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4714 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4715 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4716 usb_ep0_reinit(udev);
4719 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4720 if (retval < (signed)sizeof(udev->descriptor)) {
4721 if (retval != -ENODEV)
4722 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4729 usb_detect_quirks(udev);
4731 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4732 retval = usb_get_bos_descriptor(udev);
4734 udev->lpm_capable = usb_device_supports_lpm(udev);
4735 usb_set_lpm_parameters(udev);
4740 /* notify HCD that we have a device connected and addressed */
4741 if (hcd->driver->update_device)
4742 hcd->driver->update_device(hcd, udev);
4743 hub_set_initial_usb2_lpm_policy(udev);
4746 hub_port_disable(hub, port1, 0);
4747 update_devnum(udev, devnum); /* for disconnect processing */
4753 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4755 struct usb_qualifier_descriptor *qual;
4758 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4761 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4765 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4766 qual, sizeof *qual);
4767 if (status == sizeof *qual) {
4768 dev_info(&udev->dev, "not running at top speed; "
4769 "connect to a high speed hub\n");
4770 /* hub LEDs are probably harder to miss than syslog */
4771 if (hub->has_indicators) {
4772 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4773 queue_delayed_work(system_power_efficient_wq,
4781 hub_power_remaining(struct usb_hub *hub)
4783 struct usb_device *hdev = hub->hdev;
4787 if (!hub->limited_power)
4790 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4791 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4792 struct usb_port *port_dev = hub->ports[port1 - 1];
4793 struct usb_device *udev = port_dev->child;
4799 if (hub_is_superspeed(udev))
4805 * Unconfigured devices may not use more than one unit load,
4806 * or 8mA for OTG ports
4808 if (udev->actconfig)
4809 delta = usb_get_max_power(udev, udev->actconfig);
4810 else if (port1 != udev->bus->otg_port || hdev->parent)
4814 if (delta > hub->mA_per_port)
4815 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4816 delta, hub->mA_per_port);
4819 if (remaining < 0) {
4820 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4827 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4830 int status = -ENODEV;
4833 struct usb_device *hdev = hub->hdev;
4834 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4835 struct usb_port *port_dev = hub->ports[port1 - 1];
4836 struct usb_device *udev = port_dev->child;
4837 static int unreliable_port = -1;
4840 /* Disconnect any existing devices under this port */
4842 if (hcd->usb_phy && !hdev->parent)
4843 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4844 usb_disconnect(&port_dev->child);
4847 /* We can forget about a "removed" device when there's a physical
4848 * disconnect or the connect status changes.
4850 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4851 (portchange & USB_PORT_STAT_C_CONNECTION))
4852 clear_bit(port1, hub->removed_bits);
4854 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4855 USB_PORT_STAT_C_ENABLE)) {
4856 status = hub_port_debounce_be_stable(hub, port1);
4858 if (status != -ENODEV &&
4859 port1 != unreliable_port &&
4861 dev_err(&port_dev->dev, "connect-debounce failed\n");
4862 portstatus &= ~USB_PORT_STAT_CONNECTION;
4863 unreliable_port = port1;
4865 portstatus = status;
4869 /* Return now if debouncing failed or nothing is connected or
4870 * the device was "removed".
4872 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4873 test_bit(port1, hub->removed_bits)) {
4876 * maybe switch power back on (e.g. root hub was reset)
4877 * but only if the port isn't owned by someone else.
4879 if (hub_is_port_power_switchable(hub)
4880 && !port_is_power_on(hub, portstatus)
4881 && !port_dev->port_owner)
4882 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4884 if (portstatus & USB_PORT_STAT_ENABLE)
4888 if (hub_is_superspeed(hub->hdev))
4895 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4896 usb_lock_port(port_dev);
4897 mutex_lock(hcd->address0_mutex);
4898 retry_locked = true;
4900 /* reallocate for each attempt, since references
4901 * to the previous one can escape in various ways
4903 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4905 dev_err(&port_dev->dev,
4906 "couldn't allocate usb_device\n");
4907 mutex_unlock(hcd->address0_mutex);
4908 usb_unlock_port(port_dev);
4912 usb_set_device_state(udev, USB_STATE_POWERED);
4913 udev->bus_mA = hub->mA_per_port;
4914 udev->level = hdev->level + 1;
4915 udev->wusb = hub_is_wusb(hub);
4917 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
4918 if (hub_is_superspeed(hub->hdev))
4919 udev->speed = USB_SPEED_SUPER;
4921 udev->speed = USB_SPEED_UNKNOWN;
4923 choose_devnum(udev);
4924 if (udev->devnum <= 0) {
4925 status = -ENOTCONN; /* Don't retry */
4929 /* reset (non-USB 3.0 devices) and get descriptor */
4930 status = hub_port_init(hub, udev, port1, i);
4934 mutex_unlock(hcd->address0_mutex);
4935 usb_unlock_port(port_dev);
4936 retry_locked = false;
4938 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4941 /* consecutive bus-powered hubs aren't reliable; they can
4942 * violate the voltage drop budget. if the new child has
4943 * a "powered" LED, users should notice we didn't enable it
4944 * (without reading syslog), even without per-port LEDs
4947 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4948 && udev->bus_mA <= unit_load) {
4951 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4954 dev_dbg(&udev->dev, "get status %d ?\n", status);
4957 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4959 "can't connect bus-powered hub "
4961 if (hub->has_indicators) {
4962 hub->indicator[port1-1] =
4963 INDICATOR_AMBER_BLINK;
4965 system_power_efficient_wq,
4968 status = -ENOTCONN; /* Don't retry */
4973 /* check for devices running slower than they could */
4974 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4975 && udev->speed == USB_SPEED_FULL
4976 && highspeed_hubs != 0)
4977 check_highspeed(hub, udev, port1);
4979 /* Store the parent's children[] pointer. At this point
4980 * udev becomes globally accessible, although presumably
4981 * no one will look at it until hdev is unlocked.
4985 mutex_lock(&usb_port_peer_mutex);
4987 /* We mustn't add new devices if the parent hub has
4988 * been disconnected; we would race with the
4989 * recursively_mark_NOTATTACHED() routine.
4991 spin_lock_irq(&device_state_lock);
4992 if (hdev->state == USB_STATE_NOTATTACHED)
4995 port_dev->child = udev;
4996 spin_unlock_irq(&device_state_lock);
4997 mutex_unlock(&usb_port_peer_mutex);
4999 /* Run it through the hoops (find a driver, etc) */
5001 status = usb_new_device(udev);
5003 mutex_lock(&usb_port_peer_mutex);
5004 spin_lock_irq(&device_state_lock);
5005 port_dev->child = NULL;
5006 spin_unlock_irq(&device_state_lock);
5007 mutex_unlock(&usb_port_peer_mutex);
5009 if (hcd->usb_phy && !hdev->parent)
5010 usb_phy_notify_connect(hcd->usb_phy,
5018 status = hub_power_remaining(hub);
5020 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5025 hub_port_disable(hub, port1, 1);
5027 usb_ep0_reinit(udev);
5028 release_devnum(udev);
5031 mutex_unlock(hcd->address0_mutex);
5032 usb_unlock_port(port_dev);
5035 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5038 /* When halfway through our retry count, power-cycle the port */
5039 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5040 dev_info(&port_dev->dev, "attempt power cycle\n");
5041 usb_hub_set_port_power(hdev, hub, port1, false);
5042 msleep(2 * hub_power_on_good_delay(hub));
5043 usb_hub_set_port_power(hdev, hub, port1, true);
5044 msleep(hub_power_on_good_delay(hub));
5047 if (hub->hdev->parent ||
5048 !hcd->driver->port_handed_over ||
5049 !(hcd->driver->port_handed_over)(hcd, port1)) {
5050 if (status != -ENOTCONN && status != -ENODEV)
5051 dev_err(&port_dev->dev,
5052 "unable to enumerate USB device\n");
5056 hub_port_disable(hub, port1, 1);
5057 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5058 if (status != -ENOTCONN && status != -ENODEV)
5059 hcd->driver->relinquish_port(hcd, port1);
5063 /* Handle physical or logical connection change events.
5064 * This routine is called when:
5065 * a port connection-change occurs;
5066 * a port enable-change occurs (often caused by EMI);
5067 * usb_reset_and_verify_device() encounters changed descriptors (as from
5068 * a firmware download)
5069 * caller already locked the hub
5071 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5072 u16 portstatus, u16 portchange)
5073 __must_hold(&port_dev->status_lock)
5075 struct usb_port *port_dev = hub->ports[port1 - 1];
5076 struct usb_device *udev = port_dev->child;
5077 int status = -ENODEV;
5079 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5080 portchange, portspeed(hub, portstatus));
5082 if (hub->has_indicators) {
5083 set_port_led(hub, port1, HUB_LED_AUTO);
5084 hub->indicator[port1-1] = INDICATOR_AUTO;
5087 #ifdef CONFIG_USB_OTG
5088 /* during HNP, don't repeat the debounce */
5089 if (hub->hdev->bus->is_b_host)
5090 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5091 USB_PORT_STAT_C_ENABLE);
5094 /* Try to resuscitate an existing device */
5095 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5096 udev->state != USB_STATE_NOTATTACHED) {
5097 if (portstatus & USB_PORT_STAT_ENABLE) {
5098 status = 0; /* Nothing to do */
5100 } else if (udev->state == USB_STATE_SUSPENDED &&
5101 udev->persist_enabled) {
5102 /* For a suspended device, treat this as a
5103 * remote wakeup event.
5105 usb_unlock_port(port_dev);
5106 status = usb_remote_wakeup(udev);
5107 usb_lock_port(port_dev);
5110 /* Don't resuscitate */;
5113 clear_bit(port1, hub->change_bits);
5115 /* successfully revalidated the connection */
5119 usb_unlock_port(port_dev);
5120 hub_port_connect(hub, port1, portstatus, portchange);
5121 usb_lock_port(port_dev);
5124 static void port_event(struct usb_hub *hub, int port1)
5125 __must_hold(&port_dev->status_lock)
5128 struct usb_port *port_dev = hub->ports[port1 - 1];
5129 struct usb_device *udev = port_dev->child;
5130 struct usb_device *hdev = hub->hdev;
5131 u16 portstatus, portchange;
5133 connect_change = test_bit(port1, hub->change_bits);
5134 clear_bit(port1, hub->event_bits);
5135 clear_bit(port1, hub->wakeup_bits);
5137 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5140 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5141 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5145 if (portchange & USB_PORT_STAT_C_ENABLE) {
5146 if (!connect_change)
5147 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5149 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5152 * EM interference sometimes causes badly shielded USB devices
5153 * to be shutdown by the hub, this hack enables them again.
5154 * Works at least with mouse driver.
5156 if (!(portstatus & USB_PORT_STAT_ENABLE)
5157 && !connect_change && udev) {
5158 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5163 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5164 u16 status = 0, unused;
5166 dev_dbg(&port_dev->dev, "over-current change\n");
5167 usb_clear_port_feature(hdev, port1,
5168 USB_PORT_FEAT_C_OVER_CURRENT);
5169 msleep(100); /* Cool down */
5170 hub_power_on(hub, true);
5171 hub_port_status(hub, port1, &status, &unused);
5172 if (status & USB_PORT_STAT_OVERCURRENT)
5173 dev_err(&port_dev->dev, "over-current condition\n");
5176 if (portchange & USB_PORT_STAT_C_RESET) {
5177 dev_dbg(&port_dev->dev, "reset change\n");
5178 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5180 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5181 && hub_is_superspeed(hdev)) {
5182 dev_dbg(&port_dev->dev, "warm reset change\n");
5183 usb_clear_port_feature(hdev, port1,
5184 USB_PORT_FEAT_C_BH_PORT_RESET);
5186 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5187 dev_dbg(&port_dev->dev, "link state change\n");
5188 usb_clear_port_feature(hdev, port1,
5189 USB_PORT_FEAT_C_PORT_LINK_STATE);
5191 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5192 dev_warn(&port_dev->dev, "config error\n");
5193 usb_clear_port_feature(hdev, port1,
5194 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5197 /* skip port actions that require the port to be powered on */
5198 if (!pm_runtime_active(&port_dev->dev))
5201 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5205 * Warm reset a USB3 protocol port if it's in
5206 * SS.Inactive state.
5208 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5209 dev_dbg(&port_dev->dev, "do warm reset\n");
5210 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5211 || udev->state == USB_STATE_NOTATTACHED) {
5212 if (hub_port_reset(hub, port1, NULL,
5213 HUB_BH_RESET_TIME, true) < 0)
5214 hub_port_disable(hub, port1, 1);
5216 usb_unlock_port(port_dev);
5217 usb_lock_device(udev);
5218 usb_reset_device(udev);
5219 usb_unlock_device(udev);
5220 usb_lock_port(port_dev);
5226 hub_port_connect_change(hub, port1, portstatus, portchange);
5229 static void hub_event(struct work_struct *work)
5231 struct usb_device *hdev;
5232 struct usb_interface *intf;
5233 struct usb_hub *hub;
5234 struct device *hub_dev;
5239 hub = container_of(work, struct usb_hub, events);
5241 hub_dev = hub->intfdev;
5242 intf = to_usb_interface(hub_dev);
5244 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5245 hdev->state, hdev->maxchild,
5246 /* NOTE: expects max 15 ports... */
5247 (u16) hub->change_bits[0],
5248 (u16) hub->event_bits[0]);
5250 /* Lock the device, then check to see if we were
5251 * disconnected while waiting for the lock to succeed. */
5252 usb_lock_device(hdev);
5253 if (unlikely(hub->disconnected))
5256 /* If the hub has died, clean up after it */
5257 if (hdev->state == USB_STATE_NOTATTACHED) {
5258 hub->error = -ENODEV;
5259 hub_quiesce(hub, HUB_DISCONNECT);
5264 ret = usb_autopm_get_interface(intf);
5266 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5270 /* If this is an inactive hub, do nothing */
5275 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5277 ret = usb_reset_device(hdev);
5279 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5287 /* deal with port status changes */
5288 for (i = 1; i <= hdev->maxchild; i++) {
5289 struct usb_port *port_dev = hub->ports[i - 1];
5291 if (test_bit(i, hub->event_bits)
5292 || test_bit(i, hub->change_bits)
5293 || test_bit(i, hub->wakeup_bits)) {
5295 * The get_noresume and barrier ensure that if
5296 * the port was in the process of resuming, we
5297 * flush that work and keep the port active for
5298 * the duration of the port_event(). However,
5299 * if the port is runtime pm suspended
5300 * (powered-off), we leave it in that state, run
5301 * an abbreviated port_event(), and move on.
5303 pm_runtime_get_noresume(&port_dev->dev);
5304 pm_runtime_barrier(&port_dev->dev);
5305 usb_lock_port(port_dev);
5307 usb_unlock_port(port_dev);
5308 pm_runtime_put_sync(&port_dev->dev);
5312 /* deal with hub status changes */
5313 if (test_and_clear_bit(0, hub->event_bits) == 0)
5315 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5316 dev_err(hub_dev, "get_hub_status failed\n");
5318 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5319 dev_dbg(hub_dev, "power change\n");
5320 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5321 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5322 /* FIXME: Is this always true? */
5323 hub->limited_power = 1;
5325 hub->limited_power = 0;
5327 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5331 dev_dbg(hub_dev, "over-current change\n");
5332 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5333 msleep(500); /* Cool down */
5334 hub_power_on(hub, true);
5335 hub_hub_status(hub, &status, &unused);
5336 if (status & HUB_STATUS_OVERCURRENT)
5337 dev_err(hub_dev, "over-current condition\n");
5342 /* Balance the usb_autopm_get_interface() above */
5343 usb_autopm_put_interface_no_suspend(intf);
5345 usb_unlock_device(hdev);
5347 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5348 usb_autopm_put_interface(intf);
5349 kref_put(&hub->kref, hub_release);
5352 static const struct usb_device_id hub_id_table[] = {
5353 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5354 | USB_DEVICE_ID_MATCH_INT_CLASS,
5355 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5356 .bInterfaceClass = USB_CLASS_HUB,
5357 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5358 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5359 .bDeviceClass = USB_CLASS_HUB},
5360 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5361 .bInterfaceClass = USB_CLASS_HUB},
5362 { } /* Terminating entry */
5365 MODULE_DEVICE_TABLE(usb, hub_id_table);
5367 static struct usb_driver hub_driver = {
5370 .disconnect = hub_disconnect,
5371 .suspend = hub_suspend,
5372 .resume = hub_resume,
5373 .reset_resume = hub_reset_resume,
5374 .pre_reset = hub_pre_reset,
5375 .post_reset = hub_post_reset,
5376 .unlocked_ioctl = hub_ioctl,
5377 .id_table = hub_id_table,
5378 .supports_autosuspend = 1,
5381 int usb_hub_init(void)
5383 if (usb_register(&hub_driver) < 0) {
5384 printk(KERN_ERR "%s: can't register hub driver\n",
5390 * The workqueue needs to be freezable to avoid interfering with
5391 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5392 * device was gone before the EHCI controller had handed its port
5393 * over to the companion full-speed controller.
5395 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5399 /* Fall through if kernel_thread failed */
5400 usb_deregister(&hub_driver);
5401 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5406 void usb_hub_cleanup(void)
5408 destroy_workqueue(hub_wq);
5411 * Hub resources are freed for us by usb_deregister. It calls
5412 * usb_driver_purge on every device which in turn calls that
5413 * devices disconnect function if it is using this driver.
5414 * The hub_disconnect function takes care of releasing the
5415 * individual hub resources. -greg
5417 usb_deregister(&hub_driver);
5418 } /* usb_hub_cleanup() */
5420 static int descriptors_changed(struct usb_device *udev,
5421 struct usb_device_descriptor *old_device_descriptor,
5422 struct usb_host_bos *old_bos)
5426 unsigned serial_len = 0;
5428 unsigned old_length;
5432 if (memcmp(&udev->descriptor, old_device_descriptor,
5433 sizeof(*old_device_descriptor)) != 0)
5436 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5439 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5440 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5442 if (memcmp(udev->bos->desc, old_bos->desc, len))
5446 /* Since the idVendor, idProduct, and bcdDevice values in the
5447 * device descriptor haven't changed, we will assume the
5448 * Manufacturer and Product strings haven't changed either.
5449 * But the SerialNumber string could be different (e.g., a
5450 * different flash card of the same brand).
5453 serial_len = strlen(udev->serial) + 1;
5456 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5457 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5458 len = max(len, old_length);
5461 buf = kmalloc(len, GFP_NOIO);
5463 /* assume the worst */
5466 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5467 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5468 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5470 if (length != old_length) {
5471 dev_dbg(&udev->dev, "config index %d, error %d\n",
5476 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5478 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5480 ((struct usb_config_descriptor *) buf)->
5481 bConfigurationValue);
5487 if (!changed && serial_len) {
5488 length = usb_string(udev, udev->descriptor.iSerialNumber,
5490 if (length + 1 != serial_len) {
5491 dev_dbg(&udev->dev, "serial string error %d\n",
5494 } else if (memcmp(buf, udev->serial, length) != 0) {
5495 dev_dbg(&udev->dev, "serial string changed\n");
5505 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5506 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5508 * WARNING - don't use this routine to reset a composite device
5509 * (one with multiple interfaces owned by separate drivers)!
5510 * Use usb_reset_device() instead.
5512 * Do a port reset, reassign the device's address, and establish its
5513 * former operating configuration. If the reset fails, or the device's
5514 * descriptors change from their values before the reset, or the original
5515 * configuration and altsettings cannot be restored, a flag will be set
5516 * telling hub_wq to pretend the device has been disconnected and then
5517 * re-connected. All drivers will be unbound, and the device will be
5518 * re-enumerated and probed all over again.
5520 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5521 * flagged for logical disconnection, or some other negative error code
5522 * if the reset wasn't even attempted.
5525 * The caller must own the device lock and the port lock, the latter is
5526 * taken by usb_reset_device(). For example, it's safe to use
5527 * usb_reset_device() from a driver probe() routine after downloading
5528 * new firmware. For calls that might not occur during probe(), drivers
5529 * should lock the device using usb_lock_device_for_reset().
5531 * Locking exception: This routine may also be called from within an
5532 * autoresume handler. Such usage won't conflict with other tasks
5533 * holding the device lock because these tasks should always call
5534 * usb_autopm_resume_device(), thereby preventing any unwanted
5535 * autoresume. The autoresume handler is expected to have already
5536 * acquired the port lock before calling this routine.
5538 static int usb_reset_and_verify_device(struct usb_device *udev)
5540 struct usb_device *parent_hdev = udev->parent;
5541 struct usb_hub *parent_hub;
5542 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5543 struct usb_device_descriptor descriptor = udev->descriptor;
5544 struct usb_host_bos *bos;
5546 int port1 = udev->portnum;
5548 if (udev->state == USB_STATE_NOTATTACHED ||
5549 udev->state == USB_STATE_SUSPENDED) {
5550 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5558 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5560 /* Disable USB2 hardware LPM.
5561 * It will be re-enabled by the enumeration process.
5563 usb_disable_usb2_hardware_lpm(udev);
5565 /* Disable LPM and LTM while we reset the device and reinstall the alt
5566 * settings. Device-initiated LPM settings, and system exit latency
5567 * settings are cleared when the device is reset, so we have to set
5570 ret = usb_unlocked_disable_lpm(udev);
5572 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5573 goto re_enumerate_no_bos;
5575 ret = usb_disable_ltm(udev);
5577 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5579 goto re_enumerate_no_bos;
5585 mutex_lock(hcd->address0_mutex);
5587 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5589 /* ep0 maxpacket size may change; let the HCD know about it.
5590 * Other endpoints will be handled by re-enumeration. */
5591 usb_ep0_reinit(udev);
5592 ret = hub_port_init(parent_hub, udev, port1, i);
5593 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5596 mutex_unlock(hcd->address0_mutex);
5601 /* Device might have changed firmware (DFU or similar) */
5602 if (descriptors_changed(udev, &descriptor, bos)) {
5603 dev_info(&udev->dev, "device firmware changed\n");
5604 udev->descriptor = descriptor; /* for disconnect() calls */
5608 /* Restore the device's previous configuration */
5609 if (!udev->actconfig)
5612 mutex_lock(hcd->bandwidth_mutex);
5613 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5615 dev_warn(&udev->dev,
5616 "Busted HC? Not enough HCD resources for "
5617 "old configuration.\n");
5618 mutex_unlock(hcd->bandwidth_mutex);
5621 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5622 USB_REQ_SET_CONFIGURATION, 0,
5623 udev->actconfig->desc.bConfigurationValue, 0,
5624 NULL, 0, USB_CTRL_SET_TIMEOUT);
5627 "can't restore configuration #%d (error=%d)\n",
5628 udev->actconfig->desc.bConfigurationValue, ret);
5629 mutex_unlock(hcd->bandwidth_mutex);
5632 mutex_unlock(hcd->bandwidth_mutex);
5633 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5635 /* Put interfaces back into the same altsettings as before.
5636 * Don't bother to send the Set-Interface request for interfaces
5637 * that were already in altsetting 0; besides being unnecessary,
5638 * many devices can't handle it. Instead just reset the host-side
5641 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5642 struct usb_host_config *config = udev->actconfig;
5643 struct usb_interface *intf = config->interface[i];
5644 struct usb_interface_descriptor *desc;
5646 desc = &intf->cur_altsetting->desc;
5647 if (desc->bAlternateSetting == 0) {
5648 usb_disable_interface(udev, intf, true);
5649 usb_enable_interface(udev, intf, true);
5652 /* Let the bandwidth allocation function know that this
5653 * device has been reset, and it will have to use
5654 * alternate setting 0 as the current alternate setting.
5656 intf->resetting_device = 1;
5657 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5658 desc->bAlternateSetting);
5659 intf->resetting_device = 0;
5662 dev_err(&udev->dev, "failed to restore interface %d "
5663 "altsetting %d (error=%d)\n",
5664 desc->bInterfaceNumber,
5665 desc->bAlternateSetting,
5669 /* Resetting also frees any allocated streams */
5670 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5671 intf->cur_altsetting->endpoint[j].streams = 0;
5675 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5676 usb_enable_usb2_hardware_lpm(udev);
5677 usb_unlocked_enable_lpm(udev);
5678 usb_enable_ltm(udev);
5679 usb_release_bos_descriptor(udev);
5684 usb_release_bos_descriptor(udev);
5686 re_enumerate_no_bos:
5687 /* LPM state doesn't matter when we're about to destroy the device. */
5688 hub_port_logical_disconnect(parent_hub, port1);
5693 * usb_reset_device - warn interface drivers and perform a USB port reset
5694 * @udev: device to reset (not in NOTATTACHED state)
5696 * Warns all drivers bound to registered interfaces (using their pre_reset
5697 * method), performs the port reset, and then lets the drivers know that
5698 * the reset is over (using their post_reset method).
5700 * Return: The same as for usb_reset_and_verify_device().
5703 * The caller must own the device lock. For example, it's safe to use
5704 * this from a driver probe() routine after downloading new firmware.
5705 * For calls that might not occur during probe(), drivers should lock
5706 * the device using usb_lock_device_for_reset().
5708 * If an interface is currently being probed or disconnected, we assume
5709 * its driver knows how to handle resets. For all other interfaces,
5710 * if the driver doesn't have pre_reset and post_reset methods then
5711 * we attempt to unbind it and rebind afterward.
5713 int usb_reset_device(struct usb_device *udev)
5717 unsigned int noio_flag;
5718 struct usb_port *port_dev;
5719 struct usb_host_config *config = udev->actconfig;
5720 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5722 if (udev->state == USB_STATE_NOTATTACHED) {
5723 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5728 if (!udev->parent) {
5729 /* this requires hcd-specific logic; see ohci_restart() */
5730 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5734 port_dev = hub->ports[udev->portnum - 1];
5737 * Don't allocate memory with GFP_KERNEL in current
5738 * context to avoid possible deadlock if usb mass
5739 * storage interface or usbnet interface(iSCSI case)
5740 * is included in current configuration. The easist
5741 * approach is to do it for every device reset,
5742 * because the device 'memalloc_noio' flag may have
5743 * not been set before reseting the usb device.
5745 noio_flag = memalloc_noio_save();
5747 /* Prevent autosuspend during the reset */
5748 usb_autoresume_device(udev);
5751 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5752 struct usb_interface *cintf = config->interface[i];
5753 struct usb_driver *drv;
5756 if (cintf->dev.driver) {
5757 drv = to_usb_driver(cintf->dev.driver);
5758 if (drv->pre_reset && drv->post_reset)
5759 unbind = (drv->pre_reset)(cintf);
5760 else if (cintf->condition ==
5761 USB_INTERFACE_BOUND)
5764 usb_forced_unbind_intf(cintf);
5769 usb_lock_port(port_dev);
5770 ret = usb_reset_and_verify_device(udev);
5771 usb_unlock_port(port_dev);
5774 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5775 struct usb_interface *cintf = config->interface[i];
5776 struct usb_driver *drv;
5777 int rebind = cintf->needs_binding;
5779 if (!rebind && cintf->dev.driver) {
5780 drv = to_usb_driver(cintf->dev.driver);
5781 if (drv->post_reset)
5782 rebind = (drv->post_reset)(cintf);
5783 else if (cintf->condition ==
5784 USB_INTERFACE_BOUND)
5787 cintf->needs_binding = 1;
5791 /* If the reset failed, hub_wq will unbind drivers later */
5793 usb_unbind_and_rebind_marked_interfaces(udev);
5796 usb_autosuspend_device(udev);
5797 memalloc_noio_restore(noio_flag);
5800 EXPORT_SYMBOL_GPL(usb_reset_device);
5804 * usb_queue_reset_device - Reset a USB device from an atomic context
5805 * @iface: USB interface belonging to the device to reset
5807 * This function can be used to reset a USB device from an atomic
5808 * context, where usb_reset_device() won't work (as it blocks).
5810 * Doing a reset via this method is functionally equivalent to calling
5811 * usb_reset_device(), except for the fact that it is delayed to a
5812 * workqueue. This means that any drivers bound to other interfaces
5813 * might be unbound, as well as users from usbfs in user space.
5817 * - Scheduling two resets at the same time from two different drivers
5818 * attached to two different interfaces of the same device is
5819 * possible; depending on how the driver attached to each interface
5820 * handles ->pre_reset(), the second reset might happen or not.
5822 * - If the reset is delayed so long that the interface is unbound from
5823 * its driver, the reset will be skipped.
5825 * - This function can be called during .probe(). It can also be called
5826 * during .disconnect(), but doing so is pointless because the reset
5827 * will not occur. If you really want to reset the device during
5828 * .disconnect(), call usb_reset_device() directly -- but watch out
5829 * for nested unbinding issues!
5831 void usb_queue_reset_device(struct usb_interface *iface)
5833 if (schedule_work(&iface->reset_ws))
5834 usb_get_intf(iface);
5836 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5839 * usb_hub_find_child - Get the pointer of child device
5840 * attached to the port which is specified by @port1.
5841 * @hdev: USB device belonging to the usb hub
5842 * @port1: port num to indicate which port the child device
5845 * USB drivers call this function to get hub's child device
5848 * Return: %NULL if input param is invalid and
5849 * child's usb_device pointer if non-NULL.
5851 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5854 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5856 if (port1 < 1 || port1 > hdev->maxchild)
5858 return hub->ports[port1 - 1]->child;
5860 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5862 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5863 struct usb_hub_descriptor *desc)
5865 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5866 enum usb_port_connect_type connect_type;
5872 if (!hub_is_superspeed(hdev)) {
5873 for (i = 1; i <= hdev->maxchild; i++) {
5874 struct usb_port *port_dev = hub->ports[i - 1];
5876 connect_type = port_dev->connect_type;
5877 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5878 u8 mask = 1 << (i%8);
5880 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5881 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5882 desc->u.hs.DeviceRemovable[i/8] |= mask;
5887 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5889 for (i = 1; i <= hdev->maxchild; i++) {
5890 struct usb_port *port_dev = hub->ports[i - 1];
5892 connect_type = port_dev->connect_type;
5893 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5896 if (!(port_removable & mask)) {
5897 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
5898 port_removable |= mask;
5903 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5909 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5910 * @hdev: USB device belonging to the usb hub
5911 * @port1: port num of the port
5913 * Return: Port's acpi handle if successful, %NULL if params are
5916 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5919 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5924 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);