1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
10 * Released under the GPLv2 only.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/completion.h>
18 #include <linux/sched/mm.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/ioctl.h>
22 #include <linux/usb.h>
23 #include <linux/usbdevice_fs.h>
24 #include <linux/usb/hcd.h>
25 #include <linux/usb/otg.h>
26 #include <linux/usb/quirks.h>
27 #include <linux/workqueue.h>
28 #include <linux/mutex.h>
29 #include <linux/random.h>
30 #include <linux/pm_qos.h>
32 #include <linux/uaccess.h>
33 #include <asm/byteorder.h>
36 #include "otg_whitelist.h"
38 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
39 #define USB_VENDOR_SMSC 0x0424
40 #define USB_PRODUCT_USB5534B 0x5534
41 #define USB_VENDOR_CYPRESS 0x04b4
42 #define USB_PRODUCT_CY7C65632 0x6570
43 #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451
44 #define USB_PRODUCT_TUSB8041_USB3 0x8140
45 #define USB_PRODUCT_TUSB8041_USB2 0x8142
46 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
47 #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
49 #define USB_TP_TRANSMISSION_DELAY 40 /* ns */
50 #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
51 #define USB_PING_RESPONSE_TIME 400 /* ns */
53 /* Protect struct usb_device->state and ->children members
54 * Note: Both are also protected by ->dev.sem, except that ->state can
55 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
56 static DEFINE_SPINLOCK(device_state_lock);
58 /* workqueue to process hub events */
59 static struct workqueue_struct *hub_wq;
60 static void hub_event(struct work_struct *work);
62 /* synchronize hub-port add/remove and peering operations */
63 DEFINE_MUTEX(usb_port_peer_mutex);
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights;
67 module_param(blinkenlights, bool, S_IRUGO);
68 MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
76 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
77 MODULE_PARM_DESC(initial_descriptor_timeout,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first;
96 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
97 MODULE_PARM_DESC(old_scheme_first,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes = 1;
101 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
102 MODULE_PARM_DESC(use_both_schemes,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static void hub_release(struct kref *kref);
117 static int usb_reset_and_verify_device(struct usb_device *udev);
118 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
119 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
122 static inline char *portspeed(struct usb_hub *hub, int portstatus)
124 if (hub_is_superspeedplus(hub->hdev))
126 if (hub_is_superspeed(hub->hdev))
128 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
130 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
136 /* Note that hdev or one of its children must be locked! */
137 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
139 if (!hdev || !hdev->actconfig || !hdev->maxchild)
141 return usb_get_intfdata(hdev->actconfig->interface[0]);
144 int usb_device_supports_lpm(struct usb_device *udev)
146 /* Some devices have trouble with LPM */
147 if (udev->quirks & USB_QUIRK_NO_LPM)
150 /* USB 2.1 (and greater) devices indicate LPM support through
151 * their USB 2.0 Extended Capabilities BOS descriptor.
153 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
154 if (udev->bos->ext_cap &&
156 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
162 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
163 * However, there are some that don't, and they set the U1/U2 exit
166 if (!udev->bos->ss_cap) {
167 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
171 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
172 udev->bos->ss_cap->bU2DevExitLat == 0) {
174 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
176 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
180 if (!udev->parent || udev->parent->lpm_capable)
186 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
187 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
188 * See USB 3.1 section C.1.5.2
190 static void usb_set_lpm_mel(struct usb_device *udev,
191 struct usb3_lpm_parameters *udev_lpm_params,
192 unsigned int udev_exit_latency,
194 struct usb3_lpm_parameters *hub_lpm_params,
195 unsigned int hub_exit_latency)
197 unsigned int total_mel;
200 * tMEL1. time to transition path from host to device into U0.
201 * MEL for parent already contains the delay up to parent, so only add
202 * the exit latency for the last link (pick the slower exit latency),
203 * and the hub header decode latency. See USB 3.1 section C 2.2.1
204 * Store MEL in nanoseconds
206 total_mel = hub_lpm_params->mel +
207 max(udev_exit_latency, hub_exit_latency) * 1000 +
208 hub->descriptor->u.ss.bHubHdrDecLat * 100;
211 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
212 * each link + wHubDelay for each hub. Add only for last link.
213 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
214 * Multiply by 2 to include it as well.
216 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
217 USB_TP_TRANSMISSION_DELAY) * 2;
220 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
221 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
222 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
224 * Note these delays should be added only once for the entire path, so
225 * add them to the MEL of the device connected to the roothub.
227 if (!hub->hdev->parent)
228 total_mel += USB_PING_RESPONSE_TIME + 2100;
230 udev_lpm_params->mel = total_mel;
234 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
235 * a transition from either U1 or U2.
237 static void usb_set_lpm_pel(struct usb_device *udev,
238 struct usb3_lpm_parameters *udev_lpm_params,
239 unsigned int udev_exit_latency,
241 struct usb3_lpm_parameters *hub_lpm_params,
242 unsigned int hub_exit_latency,
243 unsigned int port_to_port_exit_latency)
245 unsigned int first_link_pel;
246 unsigned int hub_pel;
249 * First, the device sends an LFPS to transition the link between the
250 * device and the parent hub into U0. The exit latency is the bigger of
251 * the device exit latency or the hub exit latency.
253 if (udev_exit_latency > hub_exit_latency)
254 first_link_pel = udev_exit_latency * 1000;
256 first_link_pel = hub_exit_latency * 1000;
259 * When the hub starts to receive the LFPS, there is a slight delay for
260 * it to figure out that one of the ports is sending an LFPS. Then it
261 * will forward the LFPS to its upstream link. The exit latency is the
262 * delay, plus the PEL that we calculated for this hub.
264 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
267 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
268 * is the greater of the two exit latencies.
270 if (first_link_pel > hub_pel)
271 udev_lpm_params->pel = first_link_pel;
273 udev_lpm_params->pel = hub_pel;
277 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
278 * when a device initiates a transition to U0, until when it will receive the
279 * first packet from the host controller.
281 * Section C.1.5.1 describes the four components to this:
283 * - t2: time for the ERDY to make it from the device to the host.
284 * - t3: a host-specific delay to process the ERDY.
285 * - t4: time for the packet to make it from the host to the device.
287 * t3 is specific to both the xHCI host and the platform the host is integrated
288 * into. The Intel HW folks have said it's negligible, FIXME if a different
289 * vendor says otherwise.
291 static void usb_set_lpm_sel(struct usb_device *udev,
292 struct usb3_lpm_parameters *udev_lpm_params)
294 struct usb_device *parent;
295 unsigned int num_hubs;
296 unsigned int total_sel;
298 /* t1 = device PEL */
299 total_sel = udev_lpm_params->pel;
300 /* How many external hubs are in between the device & the root port. */
301 for (parent = udev->parent, num_hubs = 0; parent->parent;
302 parent = parent->parent)
304 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
306 total_sel += 2100 + 250 * (num_hubs - 1);
308 /* t4 = 250ns * num_hubs */
309 total_sel += 250 * num_hubs;
311 udev_lpm_params->sel = total_sel;
314 static void usb_set_lpm_parameters(struct usb_device *udev)
317 unsigned int port_to_port_delay;
318 unsigned int udev_u1_del;
319 unsigned int udev_u2_del;
320 unsigned int hub_u1_del;
321 unsigned int hub_u2_del;
323 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
326 hub = usb_hub_to_struct_hub(udev->parent);
327 /* It doesn't take time to transition the roothub into U0, since it
328 * doesn't have an upstream link.
333 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
334 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
335 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
336 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
338 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
339 hub, &udev->parent->u1_params, hub_u1_del);
341 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
342 hub, &udev->parent->u2_params, hub_u2_del);
345 * Appendix C, section C.2.2.2, says that there is a slight delay from
346 * when the parent hub notices the downstream port is trying to
347 * transition to U0 to when the hub initiates a U0 transition on its
348 * upstream port. The section says the delays are tPort2PortU1EL and
349 * tPort2PortU2EL, but it doesn't define what they are.
351 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
352 * about the same delays. Use the maximum delay calculations from those
353 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
354 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
355 * assume the device exit latencies they are talking about are the hub
358 * What do we do if the U2 exit latency is less than the U1 exit
359 * latency? It's possible, although not likely...
361 port_to_port_delay = 1;
363 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
364 hub, &udev->parent->u1_params, hub_u1_del,
367 if (hub_u2_del > hub_u1_del)
368 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
370 port_to_port_delay = 1 + hub_u1_del;
372 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
373 hub, &udev->parent->u2_params, hub_u2_del,
376 /* Now that we've got PEL, calculate SEL. */
377 usb_set_lpm_sel(udev, &udev->u1_params);
378 usb_set_lpm_sel(udev, &udev->u2_params);
381 /* USB 2.0 spec Section 11.24.4.5 */
382 static int get_hub_descriptor(struct usb_device *hdev,
383 struct usb_hub_descriptor *desc)
388 if (hub_is_superspeed(hdev)) {
389 dtype = USB_DT_SS_HUB;
390 size = USB_DT_SS_HUB_SIZE;
393 size = sizeof(struct usb_hub_descriptor);
396 for (i = 0; i < 3; i++) {
397 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
398 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
399 dtype << 8, 0, desc, size,
400 USB_CTRL_GET_TIMEOUT);
401 if (hub_is_superspeed(hdev)) {
404 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
405 /* Make sure we have the DeviceRemovable field. */
406 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
416 * USB 2.0 spec Section 11.24.2.1
418 static int clear_hub_feature(struct usb_device *hdev, int feature)
420 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
421 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
425 * USB 2.0 spec Section 11.24.2.2
427 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
429 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
430 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
435 * USB 2.0 spec Section 11.24.2.13
437 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
439 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
440 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
444 static char *to_led_name(int selector)
461 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
462 * for info about using port indicators
464 static void set_port_led(struct usb_hub *hub, int port1, int selector)
466 struct usb_port *port_dev = hub->ports[port1 - 1];
469 status = set_port_feature(hub->hdev, (selector << 8) | port1,
470 USB_PORT_FEAT_INDICATOR);
471 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
472 to_led_name(selector), status);
475 #define LED_CYCLE_PERIOD ((2*HZ)/3)
477 static void led_work(struct work_struct *work)
479 struct usb_hub *hub =
480 container_of(work, struct usb_hub, leds.work);
481 struct usb_device *hdev = hub->hdev;
483 unsigned changed = 0;
486 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
489 for (i = 0; i < hdev->maxchild; i++) {
490 unsigned selector, mode;
492 /* 30%-50% duty cycle */
494 switch (hub->indicator[i]) {
496 case INDICATOR_CYCLE:
498 selector = HUB_LED_AUTO;
499 mode = INDICATOR_AUTO;
501 /* blinking green = sw attention */
502 case INDICATOR_GREEN_BLINK:
503 selector = HUB_LED_GREEN;
504 mode = INDICATOR_GREEN_BLINK_OFF;
506 case INDICATOR_GREEN_BLINK_OFF:
507 selector = HUB_LED_OFF;
508 mode = INDICATOR_GREEN_BLINK;
510 /* blinking amber = hw attention */
511 case INDICATOR_AMBER_BLINK:
512 selector = HUB_LED_AMBER;
513 mode = INDICATOR_AMBER_BLINK_OFF;
515 case INDICATOR_AMBER_BLINK_OFF:
516 selector = HUB_LED_OFF;
517 mode = INDICATOR_AMBER_BLINK;
519 /* blink green/amber = reserved */
520 case INDICATOR_ALT_BLINK:
521 selector = HUB_LED_GREEN;
522 mode = INDICATOR_ALT_BLINK_OFF;
524 case INDICATOR_ALT_BLINK_OFF:
525 selector = HUB_LED_AMBER;
526 mode = INDICATOR_ALT_BLINK;
531 if (selector != HUB_LED_AUTO)
533 set_port_led(hub, i + 1, selector);
534 hub->indicator[i] = mode;
536 if (!changed && blinkenlights) {
538 cursor %= hdev->maxchild;
539 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
540 hub->indicator[cursor] = INDICATOR_CYCLE;
544 queue_delayed_work(system_power_efficient_wq,
545 &hub->leds, LED_CYCLE_PERIOD);
548 /* use a short timeout for hub/port status fetches */
549 #define USB_STS_TIMEOUT 1000
550 #define USB_STS_RETRIES 5
553 * USB 2.0 spec Section 11.24.2.6
555 static int get_hub_status(struct usb_device *hdev,
556 struct usb_hub_status *data)
558 int i, status = -ETIMEDOUT;
560 for (i = 0; i < USB_STS_RETRIES &&
561 (status == -ETIMEDOUT || status == -EPIPE); i++) {
562 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
563 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
564 data, sizeof(*data), USB_STS_TIMEOUT);
570 * USB 2.0 spec Section 11.24.2.7
571 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
573 static int get_port_status(struct usb_device *hdev, int port1,
574 void *data, u16 value, u16 length)
576 int i, status = -ETIMEDOUT;
578 for (i = 0; i < USB_STS_RETRIES &&
579 (status == -ETIMEDOUT || status == -EPIPE); i++) {
580 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
581 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
582 port1, data, length, USB_STS_TIMEOUT);
587 static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
588 u16 *status, u16 *change, u32 *ext_status)
593 if (type != HUB_PORT_STATUS)
596 mutex_lock(&hub->status_mutex);
597 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
600 dev_err(hub->intfdev,
601 "%s failed (err = %d)\n", __func__, ret);
605 *status = le16_to_cpu(hub->status->port.wPortStatus);
606 *change = le16_to_cpu(hub->status->port.wPortChange);
607 if (type != HUB_PORT_STATUS && ext_status)
608 *ext_status = le32_to_cpu(
609 hub->status->port.dwExtPortStatus);
612 mutex_unlock(&hub->status_mutex);
616 static int hub_port_status(struct usb_hub *hub, int port1,
617 u16 *status, u16 *change)
619 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
620 status, change, NULL);
623 static void kick_hub_wq(struct usb_hub *hub)
625 struct usb_interface *intf;
627 if (hub->disconnected || work_pending(&hub->events))
631 * Suppress autosuspend until the event is proceed.
633 * Be careful and make sure that the symmetric operation is
634 * always called. We are here only when there is no pending
635 * work for this hub. Therefore put the interface either when
636 * the new work is called or when it is canceled.
638 intf = to_usb_interface(hub->intfdev);
639 usb_autopm_get_interface_no_resume(intf);
640 kref_get(&hub->kref);
642 if (queue_work(hub_wq, &hub->events))
645 /* the work has already been scheduled */
646 usb_autopm_put_interface_async(intf);
647 kref_put(&hub->kref, hub_release);
650 void usb_kick_hub_wq(struct usb_device *hdev)
652 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
659 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
660 * Notification, which indicates it had initiated remote wakeup.
662 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
663 * device initiates resume, so the USB core will not receive notice of the
664 * resume through the normal hub interrupt URB.
666 void usb_wakeup_notification(struct usb_device *hdev,
667 unsigned int portnum)
670 struct usb_port *port_dev;
675 hub = usb_hub_to_struct_hub(hdev);
677 port_dev = hub->ports[portnum - 1];
678 if (port_dev && port_dev->child)
679 pm_wakeup_event(&port_dev->child->dev, 0);
681 set_bit(portnum, hub->wakeup_bits);
685 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
687 /* completion function, fires on port status changes and various faults */
688 static void hub_irq(struct urb *urb)
690 struct usb_hub *hub = urb->context;
691 int status = urb->status;
696 case -ENOENT: /* synchronous unlink */
697 case -ECONNRESET: /* async unlink */
698 case -ESHUTDOWN: /* hardware going away */
701 default: /* presumably an error */
702 /* Cause a hub reset after 10 consecutive errors */
703 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
704 if ((++hub->nerrors < 10) || hub->error)
709 /* let hub_wq handle things */
710 case 0: /* we got data: port status changed */
712 for (i = 0; i < urb->actual_length; ++i)
713 bits |= ((unsigned long) ((*hub->buffer)[i]))
715 hub->event_bits[0] = bits;
721 /* Something happened, let hub_wq figure it out */
728 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
729 if (status != 0 && status != -ENODEV && status != -EPERM)
730 dev_err(hub->intfdev, "resubmit --> %d\n", status);
733 /* USB 2.0 spec Section 11.24.2.3 */
735 hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
737 /* Need to clear both directions for control ep */
738 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
739 USB_ENDPOINT_XFER_CONTROL) {
740 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
741 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
742 devinfo ^ 0x8000, tt, NULL, 0, 1000);
746 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
747 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
752 * enumeration blocks hub_wq for a long time. we use keventd instead, since
753 * long blocking there is the exception, not the rule. accordingly, HCDs
754 * talking to TTs must queue control transfers (not just bulk and iso), so
755 * both can talk to the same hub concurrently.
757 static void hub_tt_work(struct work_struct *work)
759 struct usb_hub *hub =
760 container_of(work, struct usb_hub, tt.clear_work);
763 spin_lock_irqsave(&hub->tt.lock, flags);
764 while (!list_empty(&hub->tt.clear_list)) {
765 struct list_head *next;
766 struct usb_tt_clear *clear;
767 struct usb_device *hdev = hub->hdev;
768 const struct hc_driver *drv;
771 next = hub->tt.clear_list.next;
772 clear = list_entry(next, struct usb_tt_clear, clear_list);
773 list_del(&clear->clear_list);
775 /* drop lock so HCD can concurrently report other TT errors */
776 spin_unlock_irqrestore(&hub->tt.lock, flags);
777 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
778 if (status && status != -ENODEV)
780 "clear tt %d (%04x) error %d\n",
781 clear->tt, clear->devinfo, status);
783 /* Tell the HCD, even if the operation failed */
784 drv = clear->hcd->driver;
785 if (drv->clear_tt_buffer_complete)
786 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
789 spin_lock_irqsave(&hub->tt.lock, flags);
791 spin_unlock_irqrestore(&hub->tt.lock, flags);
795 * usb_hub_set_port_power - control hub port's power state
796 * @hdev: USB device belonging to the usb hub
799 * @set: expected status
801 * call this function to control port's power via setting or
802 * clearing the port's PORT_POWER feature.
804 * Return: 0 if successful. A negative error code otherwise.
806 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
812 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
814 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
820 set_bit(port1, hub->power_bits);
822 clear_bit(port1, hub->power_bits);
827 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
828 * @urb: an URB associated with the failed or incomplete split transaction
830 * High speed HCDs use this to tell the hub driver that some split control or
831 * bulk transaction failed in a way that requires clearing internal state of
832 * a transaction translator. This is normally detected (and reported) from
835 * It may not be possible for that hub to handle additional full (or low)
836 * speed transactions until that state is fully cleared out.
838 * Return: 0 if successful. A negative error code otherwise.
840 int usb_hub_clear_tt_buffer(struct urb *urb)
842 struct usb_device *udev = urb->dev;
843 int pipe = urb->pipe;
844 struct usb_tt *tt = udev->tt;
846 struct usb_tt_clear *clear;
848 /* we've got to cope with an arbitrary number of pending TT clears,
849 * since each TT has "at least two" buffers that can need it (and
850 * there can be many TTs per hub). even if they're uncommon.
852 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
854 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
855 /* FIXME recover somehow ... RESET_TT? */
859 /* info that CLEAR_TT_BUFFER needs */
860 clear->tt = tt->multi ? udev->ttport : 1;
861 clear->devinfo = usb_pipeendpoint (pipe);
862 clear->devinfo |= udev->devnum << 4;
863 clear->devinfo |= usb_pipecontrol(pipe)
864 ? (USB_ENDPOINT_XFER_CONTROL << 11)
865 : (USB_ENDPOINT_XFER_BULK << 11);
866 if (usb_pipein(pipe))
867 clear->devinfo |= 1 << 15;
869 /* info for completion callback */
870 clear->hcd = bus_to_hcd(udev->bus);
873 /* tell keventd to clear state for this TT */
874 spin_lock_irqsave(&tt->lock, flags);
875 list_add_tail(&clear->clear_list, &tt->clear_list);
876 schedule_work(&tt->clear_work);
877 spin_unlock_irqrestore(&tt->lock, flags);
880 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
882 static void hub_power_on(struct usb_hub *hub, bool do_delay)
886 /* Enable power on each port. Some hubs have reserved values
887 * of LPSM (> 2) in their descriptors, even though they are
888 * USB 2.0 hubs. Some hubs do not implement port-power switching
889 * but only emulate it. In all cases, the ports won't work
890 * unless we send these messages to the hub.
892 if (hub_is_port_power_switchable(hub))
893 dev_dbg(hub->intfdev, "enabling power on all ports\n");
895 dev_dbg(hub->intfdev, "trying to enable port power on "
896 "non-switchable hub\n");
897 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
898 if (test_bit(port1, hub->power_bits))
899 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
901 usb_clear_port_feature(hub->hdev, port1,
902 USB_PORT_FEAT_POWER);
904 msleep(hub_power_on_good_delay(hub));
907 static int hub_hub_status(struct usb_hub *hub,
908 u16 *status, u16 *change)
912 mutex_lock(&hub->status_mutex);
913 ret = get_hub_status(hub->hdev, &hub->status->hub);
916 dev_err(hub->intfdev,
917 "%s failed (err = %d)\n", __func__, ret);
919 *status = le16_to_cpu(hub->status->hub.wHubStatus);
920 *change = le16_to_cpu(hub->status->hub.wHubChange);
923 mutex_unlock(&hub->status_mutex);
927 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
928 unsigned int link_status)
930 return set_port_feature(hub->hdev,
931 port1 | (link_status << 3),
932 USB_PORT_FEAT_LINK_STATE);
936 * Disable a port and mark a logical connect-change event, so that some
937 * time later hub_wq will disconnect() any existing usb_device on the port
938 * and will re-enumerate if there actually is a device attached.
940 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
942 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
943 hub_port_disable(hub, port1, 1);
945 /* FIXME let caller ask to power down the port:
946 * - some devices won't enumerate without a VBUS power cycle
947 * - SRP saves power that way
948 * - ... new call, TBD ...
949 * That's easy if this hub can switch power per-port, and
950 * hub_wq reactivates the port later (timer, SRP, etc).
951 * Powerdown must be optional, because of reset/DFU.
954 set_bit(port1, hub->change_bits);
959 * usb_remove_device - disable a device's port on its parent hub
960 * @udev: device to be disabled and removed
961 * Context: @udev locked, must be able to sleep.
963 * After @udev's port has been disabled, hub_wq is notified and it will
964 * see that the device has been disconnected. When the device is
965 * physically unplugged and something is plugged in, the events will
966 * be received and processed normally.
968 * Return: 0 if successful. A negative error code otherwise.
970 int usb_remove_device(struct usb_device *udev)
973 struct usb_interface *intf;
976 if (!udev->parent) /* Can't remove a root hub */
978 hub = usb_hub_to_struct_hub(udev->parent);
979 intf = to_usb_interface(hub->intfdev);
981 ret = usb_autopm_get_interface(intf);
985 set_bit(udev->portnum, hub->removed_bits);
986 hub_port_logical_disconnect(hub, udev->portnum);
987 usb_autopm_put_interface(intf);
991 enum hub_activation_type {
992 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
993 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
996 static void hub_init_func2(struct work_struct *ws);
997 static void hub_init_func3(struct work_struct *ws);
999 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1001 struct usb_device *hdev = hub->hdev;
1002 struct usb_hcd *hcd;
1006 bool need_debounce_delay = false;
1009 /* Continue a partial initialization */
1010 if (type == HUB_INIT2 || type == HUB_INIT3) {
1011 device_lock(&hdev->dev);
1013 /* Was the hub disconnected while we were waiting? */
1014 if (hub->disconnected)
1016 if (type == HUB_INIT2)
1020 kref_get(&hub->kref);
1022 /* The superspeed hub except for root hub has to use Hub Depth
1023 * value as an offset into the route string to locate the bits
1024 * it uses to determine the downstream port number. So hub driver
1025 * should send a set hub depth request to superspeed hub after
1026 * the superspeed hub is set configuration in initialization or
1029 * After a resume, port power should still be on.
1030 * For any other type of activation, turn it on.
1032 if (type != HUB_RESUME) {
1033 if (hdev->parent && hub_is_superspeed(hdev)) {
1034 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1035 HUB_SET_DEPTH, USB_RT_HUB,
1036 hdev->level - 1, 0, NULL, 0,
1037 USB_CTRL_SET_TIMEOUT);
1039 dev_err(hub->intfdev,
1040 "set hub depth failed\n");
1043 /* Speed up system boot by using a delayed_work for the
1044 * hub's initial power-up delays. This is pretty awkward
1045 * and the implementation looks like a home-brewed sort of
1046 * setjmp/longjmp, but it saves at least 100 ms for each
1047 * root hub (assuming usbcore is compiled into the kernel
1048 * rather than as a module). It adds up.
1050 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1051 * because for those activation types the ports have to be
1052 * operational when we return. In theory this could be done
1053 * for HUB_POST_RESET, but it's easier not to.
1055 if (type == HUB_INIT) {
1056 delay = hub_power_on_good_delay(hub);
1058 hub_power_on(hub, false);
1059 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1060 queue_delayed_work(system_power_efficient_wq,
1062 msecs_to_jiffies(delay));
1064 /* Suppress autosuspend until init is done */
1065 usb_autopm_get_interface_no_resume(
1066 to_usb_interface(hub->intfdev));
1067 return; /* Continues at init2: below */
1068 } else if (type == HUB_RESET_RESUME) {
1069 /* The internal host controller state for the hub device
1070 * may be gone after a host power loss on system resume.
1071 * Update the device's info so the HW knows it's a hub.
1073 hcd = bus_to_hcd(hdev->bus);
1074 if (hcd->driver->update_hub_device) {
1075 ret = hcd->driver->update_hub_device(hcd, hdev,
1076 &hub->tt, GFP_NOIO);
1078 dev_err(hub->intfdev,
1079 "Host not accepting hub info update\n");
1080 dev_err(hub->intfdev,
1081 "LS/FS devices and hubs may not work under this hub\n");
1084 hub_power_on(hub, true);
1086 hub_power_on(hub, true);
1088 /* Give some time on remote wakeup to let links to transit to U0 */
1089 } else if (hub_is_superspeed(hub->hdev))
1095 * Check each port and set hub->change_bits to let hub_wq know
1096 * which ports need attention.
1098 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1099 struct usb_port *port_dev = hub->ports[port1 - 1];
1100 struct usb_device *udev = port_dev->child;
1101 u16 portstatus, portchange;
1103 portstatus = portchange = 0;
1104 status = hub_port_status(hub, port1, &portstatus, &portchange);
1108 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1109 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1110 portstatus, portchange);
1113 * After anything other than HUB_RESUME (i.e., initialization
1114 * or any sort of reset), every port should be disabled.
1115 * Unconnected ports should likewise be disabled (paranoia),
1116 * and so should ports for which we have no usb_device.
1118 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1119 type != HUB_RESUME ||
1120 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1122 udev->state == USB_STATE_NOTATTACHED)) {
1124 * USB3 protocol ports will automatically transition
1125 * to Enabled state when detect an USB3.0 device attach.
1126 * Do not disable USB3 protocol ports, just pretend
1129 portstatus &= ~USB_PORT_STAT_ENABLE;
1130 if (!hub_is_superspeed(hdev))
1131 usb_clear_port_feature(hdev, port1,
1132 USB_PORT_FEAT_ENABLE);
1135 /* Make sure a warm-reset request is handled by port_event */
1136 if (type == HUB_RESUME &&
1137 hub_port_warm_reset_required(hub, port1, portstatus))
1138 set_bit(port1, hub->event_bits);
1141 * Add debounce if USB3 link is in polling/link training state.
1142 * Link will automatically transition to Enabled state after
1143 * link training completes.
1145 if (hub_is_superspeed(hdev) &&
1146 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1147 USB_SS_PORT_LS_POLLING))
1148 need_debounce_delay = true;
1150 /* Clear status-change flags; we'll debounce later */
1151 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1152 need_debounce_delay = true;
1153 usb_clear_port_feature(hub->hdev, port1,
1154 USB_PORT_FEAT_C_CONNECTION);
1156 if (portchange & USB_PORT_STAT_C_ENABLE) {
1157 need_debounce_delay = true;
1158 usb_clear_port_feature(hub->hdev, port1,
1159 USB_PORT_FEAT_C_ENABLE);
1161 if (portchange & USB_PORT_STAT_C_RESET) {
1162 need_debounce_delay = true;
1163 usb_clear_port_feature(hub->hdev, port1,
1164 USB_PORT_FEAT_C_RESET);
1166 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1167 hub_is_superspeed(hub->hdev)) {
1168 need_debounce_delay = true;
1169 usb_clear_port_feature(hub->hdev, port1,
1170 USB_PORT_FEAT_C_BH_PORT_RESET);
1172 /* We can forget about a "removed" device when there's a
1173 * physical disconnect or the connect status changes.
1175 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1176 (portchange & USB_PORT_STAT_C_CONNECTION))
1177 clear_bit(port1, hub->removed_bits);
1179 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1180 /* Tell hub_wq to disconnect the device or
1181 * check for a new connection or over current condition.
1182 * Based on USB2.0 Spec Section 11.12.5,
1183 * C_PORT_OVER_CURRENT could be set while
1184 * PORT_OVER_CURRENT is not. So check for any of them.
1186 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1187 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1188 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1189 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1190 set_bit(port1, hub->change_bits);
1192 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1193 bool port_resumed = (portstatus &
1194 USB_PORT_STAT_LINK_STATE) ==
1196 /* The power session apparently survived the resume.
1197 * If there was an overcurrent or suspend change
1198 * (i.e., remote wakeup request), have hub_wq
1199 * take care of it. Look at the port link state
1200 * for USB 3.0 hubs, since they don't have a suspend
1201 * change bit, and they don't set the port link change
1202 * bit on device-initiated resume.
1204 if (portchange || (hub_is_superspeed(hub->hdev) &&
1206 set_bit(port1, hub->event_bits);
1208 } else if (udev->persist_enabled) {
1210 udev->reset_resume = 1;
1212 /* Don't set the change_bits when the device
1215 if (test_bit(port1, hub->power_bits))
1216 set_bit(port1, hub->change_bits);
1219 /* The power session is gone; tell hub_wq */
1220 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1221 set_bit(port1, hub->change_bits);
1225 /* If no port-status-change flags were set, we don't need any
1226 * debouncing. If flags were set we can try to debounce the
1227 * ports all at once right now, instead of letting hub_wq do them
1228 * one at a time later on.
1230 * If any port-status changes do occur during this delay, hub_wq
1231 * will see them later and handle them normally.
1233 if (need_debounce_delay) {
1234 delay = HUB_DEBOUNCE_STABLE;
1236 /* Don't do a long sleep inside a workqueue routine */
1237 if (type == HUB_INIT2) {
1238 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1239 queue_delayed_work(system_power_efficient_wq,
1241 msecs_to_jiffies(delay));
1242 device_unlock(&hdev->dev);
1243 return; /* Continues at init3: below */
1251 status = usb_submit_urb(hub->urb, GFP_NOIO);
1253 dev_err(hub->intfdev, "activate --> %d\n", status);
1254 if (hub->has_indicators && blinkenlights)
1255 queue_delayed_work(system_power_efficient_wq,
1256 &hub->leds, LED_CYCLE_PERIOD);
1258 /* Scan all ports that need attention */
1261 if (type == HUB_INIT2 || type == HUB_INIT3) {
1262 /* Allow autosuspend if it was suppressed */
1264 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1265 device_unlock(&hdev->dev);
1268 kref_put(&hub->kref, hub_release);
1271 /* Implement the continuations for the delays above */
1272 static void hub_init_func2(struct work_struct *ws)
1274 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1276 hub_activate(hub, HUB_INIT2);
1279 static void hub_init_func3(struct work_struct *ws)
1281 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1283 hub_activate(hub, HUB_INIT3);
1286 enum hub_quiescing_type {
1287 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1290 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1292 struct usb_device *hdev = hub->hdev;
1295 /* hub_wq and related activity won't re-trigger */
1298 if (type != HUB_SUSPEND) {
1299 /* Disconnect all the children */
1300 for (i = 0; i < hdev->maxchild; ++i) {
1301 if (hub->ports[i]->child)
1302 usb_disconnect(&hub->ports[i]->child);
1306 /* Stop hub_wq and related activity */
1307 usb_kill_urb(hub->urb);
1308 if (hub->has_indicators)
1309 cancel_delayed_work_sync(&hub->leds);
1311 flush_work(&hub->tt.clear_work);
1314 static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1318 for (i = 0; i < hub->hdev->maxchild; ++i)
1319 pm_runtime_barrier(&hub->ports[i]->dev);
1322 /* caller has locked the hub device */
1323 static int hub_pre_reset(struct usb_interface *intf)
1325 struct usb_hub *hub = usb_get_intfdata(intf);
1327 hub_quiesce(hub, HUB_PRE_RESET);
1329 hub_pm_barrier_for_all_ports(hub);
1333 /* caller has locked the hub device */
1334 static int hub_post_reset(struct usb_interface *intf)
1336 struct usb_hub *hub = usb_get_intfdata(intf);
1339 hub_pm_barrier_for_all_ports(hub);
1340 hub_activate(hub, HUB_POST_RESET);
1344 static int hub_configure(struct usb_hub *hub,
1345 struct usb_endpoint_descriptor *endpoint)
1347 struct usb_hcd *hcd;
1348 struct usb_device *hdev = hub->hdev;
1349 struct device *hub_dev = hub->intfdev;
1350 u16 hubstatus, hubchange;
1351 u16 wHubCharacteristics;
1354 char *message = "out of memory";
1359 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1365 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1370 mutex_init(&hub->status_mutex);
1372 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1373 if (!hub->descriptor) {
1378 /* Request the entire hub descriptor.
1379 * hub->descriptor can handle USB_MAXCHILDREN ports,
1380 * but a (non-SS) hub can/will return fewer bytes here.
1382 ret = get_hub_descriptor(hdev, hub->descriptor);
1384 message = "can't read hub descriptor";
1388 maxchild = USB_MAXCHILDREN;
1389 if (hub_is_superspeed(hdev))
1390 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1392 if (hub->descriptor->bNbrPorts > maxchild) {
1393 message = "hub has too many ports!";
1396 } else if (hub->descriptor->bNbrPorts == 0) {
1397 message = "hub doesn't have any ports!";
1403 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1404 * The resulting value will be used for SetIsochDelay() request.
1406 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1407 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1410 delay += hdev->parent->hub_delay;
1412 delay += USB_TP_TRANSMISSION_DELAY;
1413 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1416 maxchild = hub->descriptor->bNbrPorts;
1417 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1418 (maxchild == 1) ? "" : "s");
1420 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1426 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1427 if (hub_is_superspeed(hdev)) {
1435 /* FIXME for USB 3.0, skip for now */
1436 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1437 !(hub_is_superspeed(hdev))) {
1438 char portstr[USB_MAXCHILDREN + 1];
1440 for (i = 0; i < maxchild; i++)
1441 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1442 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1444 portstr[maxchild] = 0;
1445 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1447 dev_dbg(hub_dev, "standalone hub\n");
1449 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1450 case HUB_CHAR_COMMON_LPSM:
1451 dev_dbg(hub_dev, "ganged power switching\n");
1453 case HUB_CHAR_INDV_PORT_LPSM:
1454 dev_dbg(hub_dev, "individual port power switching\n");
1456 case HUB_CHAR_NO_LPSM:
1458 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1462 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1463 case HUB_CHAR_COMMON_OCPM:
1464 dev_dbg(hub_dev, "global over-current protection\n");
1466 case HUB_CHAR_INDV_PORT_OCPM:
1467 dev_dbg(hub_dev, "individual port over-current protection\n");
1469 case HUB_CHAR_NO_OCPM:
1471 dev_dbg(hub_dev, "no over-current protection\n");
1475 spin_lock_init(&hub->tt.lock);
1476 INIT_LIST_HEAD(&hub->tt.clear_list);
1477 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1478 switch (hdev->descriptor.bDeviceProtocol) {
1481 case USB_HUB_PR_HS_SINGLE_TT:
1482 dev_dbg(hub_dev, "Single TT\n");
1485 case USB_HUB_PR_HS_MULTI_TT:
1486 ret = usb_set_interface(hdev, 0, 1);
1488 dev_dbg(hub_dev, "TT per port\n");
1491 dev_err(hub_dev, "Using single TT (err %d)\n",
1496 /* USB 3.0 hubs don't have a TT */
1499 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1500 hdev->descriptor.bDeviceProtocol);
1504 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1505 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1506 case HUB_TTTT_8_BITS:
1507 if (hdev->descriptor.bDeviceProtocol != 0) {
1508 hub->tt.think_time = 666;
1509 dev_dbg(hub_dev, "TT requires at most %d "
1510 "FS bit times (%d ns)\n",
1511 8, hub->tt.think_time);
1514 case HUB_TTTT_16_BITS:
1515 hub->tt.think_time = 666 * 2;
1516 dev_dbg(hub_dev, "TT requires at most %d "
1517 "FS bit times (%d ns)\n",
1518 16, hub->tt.think_time);
1520 case HUB_TTTT_24_BITS:
1521 hub->tt.think_time = 666 * 3;
1522 dev_dbg(hub_dev, "TT requires at most %d "
1523 "FS bit times (%d ns)\n",
1524 24, hub->tt.think_time);
1526 case HUB_TTTT_32_BITS:
1527 hub->tt.think_time = 666 * 4;
1528 dev_dbg(hub_dev, "TT requires at most %d "
1529 "FS bit times (%d ns)\n",
1530 32, hub->tt.think_time);
1534 /* probe() zeroes hub->indicator[] */
1535 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1536 hub->has_indicators = 1;
1537 dev_dbg(hub_dev, "Port indicators are supported\n");
1540 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1541 hub->descriptor->bPwrOn2PwrGood * 2);
1543 /* power budgeting mostly matters with bus-powered hubs,
1544 * and battery-powered root hubs (may provide just 8 mA).
1546 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1548 message = "can't get hub status";
1551 hcd = bus_to_hcd(hdev->bus);
1552 if (hdev == hdev->bus->root_hub) {
1553 if (hcd->power_budget > 0)
1554 hdev->bus_mA = hcd->power_budget;
1556 hdev->bus_mA = full_load * maxchild;
1557 if (hdev->bus_mA >= full_load)
1558 hub->mA_per_port = full_load;
1560 hub->mA_per_port = hdev->bus_mA;
1561 hub->limited_power = 1;
1563 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1564 int remaining = hdev->bus_mA -
1565 hub->descriptor->bHubContrCurrent;
1567 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1568 hub->descriptor->bHubContrCurrent);
1569 hub->limited_power = 1;
1571 if (remaining < maxchild * unit_load)
1573 "insufficient power available "
1574 "to use all downstream ports\n");
1575 hub->mA_per_port = unit_load; /* 7.2.1 */
1577 } else { /* Self-powered external hub */
1578 /* FIXME: What about battery-powered external hubs that
1579 * provide less current per port? */
1580 hub->mA_per_port = full_load;
1582 if (hub->mA_per_port < full_load)
1583 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1586 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1588 message = "can't get hub status";
1592 /* local power status reports aren't always correct */
1593 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1594 dev_dbg(hub_dev, "local power source is %s\n",
1595 (hubstatus & HUB_STATUS_LOCAL_POWER)
1596 ? "lost (inactive)" : "good");
1598 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1599 dev_dbg(hub_dev, "%sover-current condition exists\n",
1600 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1602 /* set up the interrupt endpoint
1603 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1604 * bytes as USB2.0[11.12.3] says because some hubs are known
1605 * to send more data (and thus cause overflow). For root hubs,
1606 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1607 * to be big enough for at least USB_MAXCHILDREN ports. */
1608 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1609 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1611 if (maxp > sizeof(*hub->buffer))
1612 maxp = sizeof(*hub->buffer);
1614 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1620 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1621 hub, endpoint->bInterval);
1623 /* maybe cycle the hub leds */
1624 if (hub->has_indicators && blinkenlights)
1625 hub->indicator[0] = INDICATOR_CYCLE;
1627 mutex_lock(&usb_port_peer_mutex);
1628 for (i = 0; i < maxchild; i++) {
1629 ret = usb_hub_create_port_device(hub, i + 1);
1631 dev_err(hub->intfdev,
1632 "couldn't create port%d device.\n", i + 1);
1637 for (i = 0; i < hdev->maxchild; i++) {
1638 struct usb_port *port_dev = hub->ports[i];
1640 pm_runtime_put(&port_dev->dev);
1643 mutex_unlock(&usb_port_peer_mutex);
1647 /* Update the HCD's internal representation of this hub before hub_wq
1648 * starts getting port status changes for devices under the hub.
1650 if (hcd->driver->update_hub_device) {
1651 ret = hcd->driver->update_hub_device(hcd, hdev,
1652 &hub->tt, GFP_KERNEL);
1654 message = "can't update HCD hub info";
1659 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1661 hub_activate(hub, HUB_INIT);
1665 dev_err(hub_dev, "config failed, %s (err %d)\n",
1667 /* hub_disconnect() frees urb and descriptor */
1671 static void hub_release(struct kref *kref)
1673 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1675 usb_put_dev(hub->hdev);
1676 usb_put_intf(to_usb_interface(hub->intfdev));
1680 static unsigned highspeed_hubs;
1682 static void hub_disconnect(struct usb_interface *intf)
1684 struct usb_hub *hub = usb_get_intfdata(intf);
1685 struct usb_device *hdev = interface_to_usbdev(intf);
1689 * Stop adding new hub events. We do not want to block here and thus
1690 * will not try to remove any pending work item.
1692 hub->disconnected = 1;
1694 /* Disconnect all children and quiesce the hub */
1696 hub_quiesce(hub, HUB_DISCONNECT);
1698 mutex_lock(&usb_port_peer_mutex);
1700 /* Avoid races with recursively_mark_NOTATTACHED() */
1701 spin_lock_irq(&device_state_lock);
1702 port1 = hdev->maxchild;
1704 usb_set_intfdata(intf, NULL);
1705 spin_unlock_irq(&device_state_lock);
1707 for (; port1 > 0; --port1)
1708 usb_hub_remove_port_device(hub, port1);
1710 mutex_unlock(&usb_port_peer_mutex);
1712 if (hub->hdev->speed == USB_SPEED_HIGH)
1715 usb_free_urb(hub->urb);
1717 kfree(hub->descriptor);
1721 pm_suspend_ignore_children(&intf->dev, false);
1723 if (hub->quirk_disable_autosuspend)
1724 usb_autopm_put_interface(intf);
1726 kref_put(&hub->kref, hub_release);
1729 static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1731 /* Some hubs have a subclass of 1, which AFAICT according to the */
1732 /* specs is not defined, but it works */
1733 if (desc->desc.bInterfaceSubClass != 0 &&
1734 desc->desc.bInterfaceSubClass != 1)
1737 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1738 if (desc->desc.bNumEndpoints != 1)
1741 /* If the first endpoint is not interrupt IN, we'd better punt! */
1742 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1748 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1750 struct usb_host_interface *desc;
1751 struct usb_device *hdev;
1752 struct usb_hub *hub;
1754 desc = intf->cur_altsetting;
1755 hdev = interface_to_usbdev(intf);
1758 * Set default autosuspend delay as 0 to speedup bus suspend,
1759 * based on the below considerations:
1761 * - Unlike other drivers, the hub driver does not rely on the
1762 * autosuspend delay to provide enough time to handle a wakeup
1763 * event, and the submitted status URB is just to check future
1764 * change on hub downstream ports, so it is safe to do it.
1766 * - The patch might cause one or more auto supend/resume for
1767 * below very rare devices when they are plugged into hub
1770 * devices having trouble initializing, and disconnect
1771 * themselves from the bus and then reconnect a second
1774 * devices just for downloading firmware, and disconnects
1775 * themselves after completing it
1777 * For these quite rare devices, their drivers may change the
1778 * autosuspend delay of their parent hub in the probe() to one
1779 * appropriate value to avoid the subtle problem if someone
1782 * - The patch may cause one or more auto suspend/resume on
1783 * hub during running 'lsusb', but it is probably too
1784 * infrequent to worry about.
1786 * - Change autosuspend delay of hub can avoid unnecessary auto
1787 * suspend timer for hub, also may decrease power consumption
1790 * - If user has indicated to prevent autosuspend by passing
1791 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1794 if (hdev->dev.power.autosuspend_delay >= 0)
1795 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1799 * Hubs have proper suspend/resume support, except for root hubs
1800 * where the controller driver doesn't have bus_suspend and
1801 * bus_resume methods.
1803 if (hdev->parent) { /* normal device */
1804 usb_enable_autosuspend(hdev);
1805 } else { /* root hub */
1806 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1808 if (drv->bus_suspend && drv->bus_resume)
1809 usb_enable_autosuspend(hdev);
1812 if (hdev->level == MAX_TOPO_LEVEL) {
1814 "Unsupported bus topology: hub nested too deep\n");
1818 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1820 dev_warn(&intf->dev, "ignoring external hub\n");
1825 if (!hub_descriptor_is_sane(desc)) {
1826 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1830 /* We found a hub */
1831 dev_info(&intf->dev, "USB hub found\n");
1833 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1837 kref_init(&hub->kref);
1838 hub->intfdev = &intf->dev;
1840 INIT_DELAYED_WORK(&hub->leds, led_work);
1841 INIT_DELAYED_WORK(&hub->init_work, NULL);
1842 INIT_WORK(&hub->events, hub_event);
1846 usb_set_intfdata(intf, hub);
1847 intf->needs_remote_wakeup = 1;
1848 pm_suspend_ignore_children(&intf->dev, true);
1850 if (hdev->speed == USB_SPEED_HIGH)
1853 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1854 hub->quirk_check_port_auto_suspend = 1;
1856 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1857 hub->quirk_disable_autosuspend = 1;
1858 usb_autopm_get_interface_no_resume(intf);
1861 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1864 hub_disconnect(intf);
1869 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1871 struct usb_device *hdev = interface_to_usbdev(intf);
1872 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1874 /* assert ifno == 0 (part of hub spec) */
1876 case USBDEVFS_HUB_PORTINFO: {
1877 struct usbdevfs_hub_portinfo *info = user_data;
1880 spin_lock_irq(&device_state_lock);
1881 if (hdev->devnum <= 0)
1884 info->nports = hdev->maxchild;
1885 for (i = 0; i < info->nports; i++) {
1886 if (hub->ports[i]->child == NULL)
1890 hub->ports[i]->child->devnum;
1893 spin_unlock_irq(&device_state_lock);
1895 return info->nports + 1;
1904 * Allow user programs to claim ports on a hub. When a device is attached
1905 * to one of these "claimed" ports, the program will "own" the device.
1907 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1908 struct usb_dev_state ***ppowner)
1910 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1912 if (hdev->state == USB_STATE_NOTATTACHED)
1914 if (port1 == 0 || port1 > hdev->maxchild)
1917 /* Devices not managed by the hub driver
1918 * will always have maxchild equal to 0.
1920 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1924 /* In the following three functions, the caller must hold hdev's lock */
1925 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1926 struct usb_dev_state *owner)
1929 struct usb_dev_state **powner;
1931 rc = find_port_owner(hdev, port1, &powner);
1939 EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1941 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1942 struct usb_dev_state *owner)
1945 struct usb_dev_state **powner;
1947 rc = find_port_owner(hdev, port1, &powner);
1950 if (*powner != owner)
1955 EXPORT_SYMBOL_GPL(usb_hub_release_port);
1957 void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1959 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1962 for (n = 0; n < hdev->maxchild; n++) {
1963 if (hub->ports[n]->port_owner == owner)
1964 hub->ports[n]->port_owner = NULL;
1969 /* The caller must hold udev's lock */
1970 bool usb_device_is_owned(struct usb_device *udev)
1972 struct usb_hub *hub;
1974 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1976 hub = usb_hub_to_struct_hub(udev->parent);
1977 return !!hub->ports[udev->portnum - 1]->port_owner;
1980 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1982 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1985 for (i = 0; i < udev->maxchild; ++i) {
1986 if (hub->ports[i]->child)
1987 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1989 if (udev->state == USB_STATE_SUSPENDED)
1990 udev->active_duration -= jiffies;
1991 udev->state = USB_STATE_NOTATTACHED;
1995 * usb_set_device_state - change a device's current state (usbcore, hcds)
1996 * @udev: pointer to device whose state should be changed
1997 * @new_state: new state value to be stored
1999 * udev->state is _not_ fully protected by the device lock. Although
2000 * most transitions are made only while holding the lock, the state can
2001 * can change to USB_STATE_NOTATTACHED at almost any time. This
2002 * is so that devices can be marked as disconnected as soon as possible,
2003 * without having to wait for any semaphores to be released. As a result,
2004 * all changes to any device's state must be protected by the
2005 * device_state_lock spinlock.
2007 * Once a device has been added to the device tree, all changes to its state
2008 * should be made using this routine. The state should _not_ be set directly.
2010 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2011 * Otherwise udev->state is set to new_state, and if new_state is
2012 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2013 * to USB_STATE_NOTATTACHED.
2015 void usb_set_device_state(struct usb_device *udev,
2016 enum usb_device_state new_state)
2018 unsigned long flags;
2021 spin_lock_irqsave(&device_state_lock, flags);
2022 if (udev->state == USB_STATE_NOTATTACHED)
2024 else if (new_state != USB_STATE_NOTATTACHED) {
2026 /* root hub wakeup capabilities are managed out-of-band
2027 * and may involve silicon errata ... ignore them here.
2030 if (udev->state == USB_STATE_SUSPENDED
2031 || new_state == USB_STATE_SUSPENDED)
2032 ; /* No change to wakeup settings */
2033 else if (new_state == USB_STATE_CONFIGURED)
2034 wakeup = (udev->quirks &
2035 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2036 udev->actconfig->desc.bmAttributes &
2037 USB_CONFIG_ATT_WAKEUP;
2041 if (udev->state == USB_STATE_SUSPENDED &&
2042 new_state != USB_STATE_SUSPENDED)
2043 udev->active_duration -= jiffies;
2044 else if (new_state == USB_STATE_SUSPENDED &&
2045 udev->state != USB_STATE_SUSPENDED)
2046 udev->active_duration += jiffies;
2047 udev->state = new_state;
2049 recursively_mark_NOTATTACHED(udev);
2050 spin_unlock_irqrestore(&device_state_lock, flags);
2052 device_set_wakeup_capable(&udev->dev, wakeup);
2054 EXPORT_SYMBOL_GPL(usb_set_device_state);
2057 * Choose a device number.
2059 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2060 * USB-2.0 buses they are also used as device addresses, however on
2061 * USB-3.0 buses the address is assigned by the controller hardware
2062 * and it usually is not the same as the device number.
2064 * WUSB devices are simple: they have no hubs behind, so the mapping
2065 * device <-> virtual port number becomes 1:1. Why? to simplify the
2066 * life of the device connection logic in
2067 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2068 * handshake we need to assign a temporary address in the unauthorized
2069 * space. For simplicity we use the first virtual port number found to
2070 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2071 * and that becomes it's address [X < 128] or its unauthorized address
2074 * We add 1 as an offset to the one-based USB-stack port number
2075 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2076 * 0 is reserved by USB for default address; (b) Linux's USB stack
2077 * uses always #1 for the root hub of the controller. So USB stack's
2078 * port #1, which is wusb virtual-port #0 has address #2.
2080 * Devices connected under xHCI are not as simple. The host controller
2081 * supports virtualization, so the hardware assigns device addresses and
2082 * the HCD must setup data structures before issuing a set address
2083 * command to the hardware.
2085 static void choose_devnum(struct usb_device *udev)
2088 struct usb_bus *bus = udev->bus;
2090 /* be safe when more hub events are proceed in parallel */
2091 mutex_lock(&bus->devnum_next_mutex);
2093 devnum = udev->portnum + 1;
2094 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2096 /* Try to allocate the next devnum beginning at
2097 * bus->devnum_next. */
2098 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2101 devnum = find_next_zero_bit(bus->devmap.devicemap,
2103 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2106 set_bit(devnum, bus->devmap.devicemap);
2107 udev->devnum = devnum;
2109 mutex_unlock(&bus->devnum_next_mutex);
2112 static void release_devnum(struct usb_device *udev)
2114 if (udev->devnum > 0) {
2115 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2120 static void update_devnum(struct usb_device *udev, int devnum)
2122 /* The address for a WUSB device is managed by wusbcore. */
2124 udev->devnum = devnum;
2127 static void hub_free_dev(struct usb_device *udev)
2129 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2131 /* Root hubs aren't real devices, so don't free HCD resources */
2132 if (hcd->driver->free_dev && udev->parent)
2133 hcd->driver->free_dev(hcd, udev);
2136 static void hub_disconnect_children(struct usb_device *udev)
2138 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2141 /* Free up all the children before we remove this device */
2142 for (i = 0; i < udev->maxchild; i++) {
2143 if (hub->ports[i]->child)
2144 usb_disconnect(&hub->ports[i]->child);
2149 * usb_disconnect - disconnect a device (usbcore-internal)
2150 * @pdev: pointer to device being disconnected
2151 * Context: !in_interrupt ()
2153 * Something got disconnected. Get rid of it and all of its children.
2155 * If *pdev is a normal device then the parent hub must already be locked.
2156 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2157 * which protects the set of root hubs as well as the list of buses.
2159 * Only hub drivers (including virtual root hub drivers for host
2160 * controllers) should ever call this.
2162 * This call is synchronous, and may not be used in an interrupt context.
2164 void usb_disconnect(struct usb_device **pdev)
2166 struct usb_port *port_dev = NULL;
2167 struct usb_device *udev = *pdev;
2168 struct usb_hub *hub = NULL;
2171 /* mark the device as inactive, so any further urb submissions for
2172 * this device (and any of its children) will fail immediately.
2173 * this quiesces everything except pending urbs.
2175 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2176 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2180 * Ensure that the pm runtime code knows that the USB device
2181 * is in the process of being disconnected.
2183 pm_runtime_barrier(&udev->dev);
2185 usb_lock_device(udev);
2187 hub_disconnect_children(udev);
2189 /* deallocate hcd/hardware state ... nuking all pending urbs and
2190 * cleaning up all state associated with the current configuration
2191 * so that the hardware is now fully quiesced.
2193 dev_dbg(&udev->dev, "unregistering device\n");
2194 usb_disable_device(udev, 0);
2195 usb_hcd_synchronize_unlinks(udev);
2198 port1 = udev->portnum;
2199 hub = usb_hub_to_struct_hub(udev->parent);
2200 port_dev = hub->ports[port1 - 1];
2202 sysfs_remove_link(&udev->dev.kobj, "port");
2203 sysfs_remove_link(&port_dev->dev.kobj, "device");
2206 * As usb_port_runtime_resume() de-references udev, make
2207 * sure no resumes occur during removal
2209 if (!test_and_set_bit(port1, hub->child_usage_bits))
2210 pm_runtime_get_sync(&port_dev->dev);
2213 usb_remove_ep_devs(&udev->ep0);
2214 usb_unlock_device(udev);
2216 /* Unregister the device. The device driver is responsible
2217 * for de-configuring the device and invoking the remove-device
2218 * notifier chain (used by usbfs and possibly others).
2220 device_del(&udev->dev);
2222 /* Free the device number and delete the parent's children[]
2223 * (or root_hub) pointer.
2225 release_devnum(udev);
2227 /* Avoid races with recursively_mark_NOTATTACHED() */
2228 spin_lock_irq(&device_state_lock);
2230 spin_unlock_irq(&device_state_lock);
2232 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2233 pm_runtime_put(&port_dev->dev);
2237 put_device(&udev->dev);
2240 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2241 static void show_string(struct usb_device *udev, char *id, char *string)
2245 dev_info(&udev->dev, "%s: %s\n", id, string);
2248 static void announce_device(struct usb_device *udev)
2250 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2252 dev_info(&udev->dev,
2253 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2254 le16_to_cpu(udev->descriptor.idVendor),
2255 le16_to_cpu(udev->descriptor.idProduct),
2256 bcdDevice >> 8, bcdDevice & 0xff);
2257 dev_info(&udev->dev,
2258 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2259 udev->descriptor.iManufacturer,
2260 udev->descriptor.iProduct,
2261 udev->descriptor.iSerialNumber);
2262 show_string(udev, "Product", udev->product);
2263 show_string(udev, "Manufacturer", udev->manufacturer);
2264 show_string(udev, "SerialNumber", udev->serial);
2267 static inline void announce_device(struct usb_device *udev) { }
2272 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2273 * @udev: newly addressed device (in ADDRESS state)
2275 * Finish enumeration for On-The-Go devices
2277 * Return: 0 if successful. A negative error code otherwise.
2279 static int usb_enumerate_device_otg(struct usb_device *udev)
2283 #ifdef CONFIG_USB_OTG
2285 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2286 * to wake us after we've powered off VBUS; and HNP, switching roles
2287 * "host" to "peripheral". The OTG descriptor helps figure this out.
2289 if (!udev->bus->is_b_host
2291 && udev->parent == udev->bus->root_hub) {
2292 struct usb_otg_descriptor *desc = NULL;
2293 struct usb_bus *bus = udev->bus;
2294 unsigned port1 = udev->portnum;
2296 /* descriptor may appear anywhere in config */
2297 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2298 le16_to_cpu(udev->config[0].desc.wTotalLength),
2299 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2300 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2303 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2304 (port1 == bus->otg_port) ? "" : "non-");
2306 /* enable HNP before suspend, it's simpler */
2307 if (port1 == bus->otg_port) {
2308 bus->b_hnp_enable = 1;
2309 err = usb_control_msg(udev,
2310 usb_sndctrlpipe(udev, 0),
2311 USB_REQ_SET_FEATURE, 0,
2312 USB_DEVICE_B_HNP_ENABLE,
2314 USB_CTRL_SET_TIMEOUT);
2317 * OTG MESSAGE: report errors here,
2318 * customize to match your product.
2320 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2322 bus->b_hnp_enable = 0;
2324 } else if (desc->bLength == sizeof
2325 (struct usb_otg_descriptor)) {
2326 /* Set a_alt_hnp_support for legacy otg device */
2327 err = usb_control_msg(udev,
2328 usb_sndctrlpipe(udev, 0),
2329 USB_REQ_SET_FEATURE, 0,
2330 USB_DEVICE_A_ALT_HNP_SUPPORT,
2332 USB_CTRL_SET_TIMEOUT);
2335 "set a_alt_hnp_support failed: %d\n",
2345 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2346 * @udev: newly addressed device (in ADDRESS state)
2348 * This is only called by usb_new_device() -- all comments that apply there
2349 * apply here wrt to environment.
2351 * If the device is WUSB and not authorized, we don't attempt to read
2352 * the string descriptors, as they will be errored out by the device
2353 * until it has been authorized.
2355 * Return: 0 if successful. A negative error code otherwise.
2357 static int usb_enumerate_device(struct usb_device *udev)
2360 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2362 if (udev->config == NULL) {
2363 err = usb_get_configuration(udev);
2366 dev_err(&udev->dev, "can't read configurations, error %d\n",
2372 /* read the standard strings and cache them if present */
2373 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2374 udev->manufacturer = usb_cache_string(udev,
2375 udev->descriptor.iManufacturer);
2376 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2378 err = usb_enumerate_device_otg(udev);
2382 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
2383 !is_targeted(udev)) {
2384 /* Maybe it can talk to us, though we can't talk to it.
2385 * (Includes HNP test device.)
2387 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2388 || udev->bus->is_b_host)) {
2389 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2391 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2396 usb_detect_interface_quirks(udev);
2401 static void set_usb_port_removable(struct usb_device *udev)
2403 struct usb_device *hdev = udev->parent;
2404 struct usb_hub *hub;
2405 u8 port = udev->portnum;
2406 u16 wHubCharacteristics;
2407 bool removable = true;
2412 hub = usb_hub_to_struct_hub(udev->parent);
2415 * If the platform firmware has provided information about a port,
2416 * use that to determine whether it's removable.
2418 switch (hub->ports[udev->portnum - 1]->connect_type) {
2419 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2420 udev->removable = USB_DEVICE_REMOVABLE;
2422 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2423 case USB_PORT_NOT_USED:
2424 udev->removable = USB_DEVICE_FIXED;
2431 * Otherwise, check whether the hub knows whether a port is removable
2434 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2436 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2439 if (hub_is_superspeed(hdev)) {
2440 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2444 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2449 udev->removable = USB_DEVICE_REMOVABLE;
2451 udev->removable = USB_DEVICE_FIXED;
2456 * usb_new_device - perform initial device setup (usbcore-internal)
2457 * @udev: newly addressed device (in ADDRESS state)
2459 * This is called with devices which have been detected but not fully
2460 * enumerated. The device descriptor is available, but not descriptors
2461 * for any device configuration. The caller must have locked either
2462 * the parent hub (if udev is a normal device) or else the
2463 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2464 * udev has already been installed, but udev is not yet visible through
2465 * sysfs or other filesystem code.
2467 * This call is synchronous, and may not be used in an interrupt context.
2469 * Only the hub driver or root-hub registrar should ever call this.
2471 * Return: Whether the device is configured properly or not. Zero if the
2472 * interface was registered with the driver core; else a negative errno
2476 int usb_new_device(struct usb_device *udev)
2481 /* Initialize non-root-hub device wakeup to disabled;
2482 * device (un)configuration controls wakeup capable
2483 * sysfs power/wakeup controls wakeup enabled/disabled
2485 device_init_wakeup(&udev->dev, 0);
2488 /* Tell the runtime-PM framework the device is active */
2489 pm_runtime_set_active(&udev->dev);
2490 pm_runtime_get_noresume(&udev->dev);
2491 pm_runtime_use_autosuspend(&udev->dev);
2492 pm_runtime_enable(&udev->dev);
2494 /* By default, forbid autosuspend for all devices. It will be
2495 * allowed for hubs during binding.
2497 usb_disable_autosuspend(udev);
2499 err = usb_enumerate_device(udev); /* Read descriptors */
2502 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2503 udev->devnum, udev->bus->busnum,
2504 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2505 /* export the usbdev device-node for libusb */
2506 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2507 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2509 /* Tell the world! */
2510 announce_device(udev);
2513 add_device_randomness(udev->serial, strlen(udev->serial));
2515 add_device_randomness(udev->product, strlen(udev->product));
2516 if (udev->manufacturer)
2517 add_device_randomness(udev->manufacturer,
2518 strlen(udev->manufacturer));
2520 device_enable_async_suspend(&udev->dev);
2522 /* check whether the hub or firmware marks this port as non-removable */
2524 set_usb_port_removable(udev);
2526 /* Register the device. The device driver is responsible
2527 * for configuring the device and invoking the add-device
2528 * notifier chain (used by usbfs and possibly others).
2530 err = device_add(&udev->dev);
2532 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2536 /* Create link files between child device and usb port device. */
2538 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2539 int port1 = udev->portnum;
2540 struct usb_port *port_dev = hub->ports[port1 - 1];
2542 err = sysfs_create_link(&udev->dev.kobj,
2543 &port_dev->dev.kobj, "port");
2547 err = sysfs_create_link(&port_dev->dev.kobj,
2548 &udev->dev.kobj, "device");
2550 sysfs_remove_link(&udev->dev.kobj, "port");
2554 if (!test_and_set_bit(port1, hub->child_usage_bits))
2555 pm_runtime_get_sync(&port_dev->dev);
2558 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2559 usb_mark_last_busy(udev);
2560 pm_runtime_put_sync_autosuspend(&udev->dev);
2564 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2565 pm_runtime_disable(&udev->dev);
2566 pm_runtime_set_suspended(&udev->dev);
2572 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2573 * @usb_dev: USB device
2575 * Move the USB device to a very basic state where interfaces are disabled
2576 * and the device is in fact unconfigured and unusable.
2578 * We share a lock (that we have) with device_del(), so we need to
2583 int usb_deauthorize_device(struct usb_device *usb_dev)
2585 usb_lock_device(usb_dev);
2586 if (usb_dev->authorized == 0)
2587 goto out_unauthorized;
2589 usb_dev->authorized = 0;
2590 usb_set_configuration(usb_dev, -1);
2593 usb_unlock_device(usb_dev);
2598 int usb_authorize_device(struct usb_device *usb_dev)
2602 usb_lock_device(usb_dev);
2603 if (usb_dev->authorized == 1)
2604 goto out_authorized;
2606 result = usb_autoresume_device(usb_dev);
2608 dev_err(&usb_dev->dev,
2609 "can't autoresume for authorization: %d\n", result);
2610 goto error_autoresume;
2613 if (usb_dev->wusb) {
2614 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2616 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2617 "authorization: %d\n", result);
2618 goto error_device_descriptor;
2622 usb_dev->authorized = 1;
2623 /* Choose and set the configuration. This registers the interfaces
2624 * with the driver core and lets interface drivers bind to them.
2626 c = usb_choose_configuration(usb_dev);
2628 result = usb_set_configuration(usb_dev, c);
2630 dev_err(&usb_dev->dev,
2631 "can't set config #%d, error %d\n", c, result);
2632 /* This need not be fatal. The user can try to
2633 * set other configurations. */
2636 dev_info(&usb_dev->dev, "authorized to connect\n");
2638 error_device_descriptor:
2639 usb_autosuspend_device(usb_dev);
2642 usb_unlock_device(usb_dev); /* complements locktree */
2647 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2648 * check it from the link protocol field of the current speed ID attribute.
2649 * current speed ID is got from ext port status request. Sublink speed attribute
2650 * table is returned with the hub BOS SSP device capability descriptor
2652 static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2657 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2662 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2663 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2665 for (i = 0; i <= ssa_count; i++) {
2666 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2667 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2668 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2673 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2674 static unsigned hub_is_wusb(struct usb_hub *hub)
2676 struct usb_hcd *hcd;
2677 if (hub->hdev->parent != NULL) /* not a root hub? */
2679 hcd = bus_to_hcd(hub->hdev->bus);
2680 return hcd->wireless;
2684 #define PORT_RESET_TRIES 5
2685 #define SET_ADDRESS_TRIES 2
2686 #define GET_DESCRIPTOR_TRIES 2
2687 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2688 #define USE_NEW_SCHEME(i, scheme) ((i) / 2 == (int)(scheme))
2690 #define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2691 #define HUB_SHORT_RESET_TIME 10
2692 #define HUB_BH_RESET_TIME 50
2693 #define HUB_LONG_RESET_TIME 200
2694 #define HUB_RESET_TIMEOUT 800
2697 * "New scheme" enumeration causes an extra state transition to be
2698 * exposed to an xhci host and causes USB3 devices to receive control
2699 * commands in the default state. This has been seen to cause
2700 * enumeration failures, so disable this enumeration scheme for USB3
2703 static bool use_new_scheme(struct usb_device *udev, int retry,
2704 struct usb_port *port_dev)
2706 int old_scheme_first_port =
2707 port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME;
2709 if (udev->speed >= USB_SPEED_SUPER)
2712 return USE_NEW_SCHEME(retry, old_scheme_first_port || old_scheme_first);
2715 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2716 * Port worm reset is required to recover
2718 static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2723 if (!hub_is_superspeed(hub->hdev))
2726 if (test_bit(port1, hub->warm_reset_bits))
2729 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2730 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2731 || link_state == USB_SS_PORT_LS_COMP_MOD;
2734 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2735 struct usb_device *udev, unsigned int delay, bool warm)
2737 int delay_time, ret;
2740 u32 ext_portstatus = 0;
2742 for (delay_time = 0;
2743 delay_time < HUB_RESET_TIMEOUT;
2744 delay_time += delay) {
2745 /* wait to give the device a chance to reset */
2748 /* read and decode port status */
2749 if (hub_is_superspeedplus(hub->hdev))
2750 ret = hub_ext_port_status(hub, port1,
2751 HUB_EXT_PORT_STATUS,
2752 &portstatus, &portchange,
2755 ret = hub_port_status(hub, port1, &portstatus,
2761 * The port state is unknown until the reset completes.
2763 * On top of that, some chips may require additional time
2764 * to re-establish a connection after the reset is complete,
2765 * so also wait for the connection to be re-established.
2767 if (!(portstatus & USB_PORT_STAT_RESET) &&
2768 (portstatus & USB_PORT_STAT_CONNECTION))
2771 /* switch to the long delay after two short delay failures */
2772 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2773 delay = HUB_LONG_RESET_TIME;
2775 dev_dbg(&hub->ports[port1 - 1]->dev,
2776 "not %sreset yet, waiting %dms\n",
2777 warm ? "warm " : "", delay);
2780 if ((portstatus & USB_PORT_STAT_RESET))
2783 if (hub_port_warm_reset_required(hub, port1, portstatus))
2786 /* Device went away? */
2787 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2790 /* Retry if connect change is set but status is still connected.
2791 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2792 * but the device may have successfully re-connected. Ignore it.
2794 if (!hub_is_superspeed(hub->hdev) &&
2795 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2796 usb_clear_port_feature(hub->hdev, port1,
2797 USB_PORT_FEAT_C_CONNECTION);
2801 if (!(portstatus & USB_PORT_STAT_ENABLE))
2807 if (hub_is_superspeedplus(hub->hdev)) {
2808 /* extended portstatus Rx and Tx lane count are zero based */
2809 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2810 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2815 if (hub_is_wusb(hub))
2816 udev->speed = USB_SPEED_WIRELESS;
2817 else if (hub_is_superspeedplus(hub->hdev) &&
2818 port_speed_is_ssp(hub->hdev, ext_portstatus &
2819 USB_EXT_PORT_STAT_RX_SPEED_ID))
2820 udev->speed = USB_SPEED_SUPER_PLUS;
2821 else if (hub_is_superspeed(hub->hdev))
2822 udev->speed = USB_SPEED_SUPER;
2823 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2824 udev->speed = USB_SPEED_HIGH;
2825 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2826 udev->speed = USB_SPEED_LOW;
2828 udev->speed = USB_SPEED_FULL;
2832 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2833 static int hub_port_reset(struct usb_hub *hub, int port1,
2834 struct usb_device *udev, unsigned int delay, bool warm)
2837 u16 portchange, portstatus;
2838 struct usb_port *port_dev = hub->ports[port1 - 1];
2839 int reset_recovery_time;
2841 if (!hub_is_superspeed(hub->hdev)) {
2843 dev_err(hub->intfdev, "only USB3 hub support "
2847 /* Block EHCI CF initialization during the port reset.
2848 * Some companion controllers don't like it when they mix.
2850 down_read(&ehci_cf_port_reset_rwsem);
2853 * If the caller hasn't explicitly requested a warm reset,
2854 * double check and see if one is needed.
2856 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2857 if (hub_port_warm_reset_required(hub, port1,
2861 clear_bit(port1, hub->warm_reset_bits);
2863 /* Reset the port */
2864 for (i = 0; i < PORT_RESET_TRIES; i++) {
2865 status = set_port_feature(hub->hdev, port1, (warm ?
2866 USB_PORT_FEAT_BH_PORT_RESET :
2867 USB_PORT_FEAT_RESET));
2868 if (status == -ENODEV) {
2869 ; /* The hub is gone */
2870 } else if (status) {
2871 dev_err(&port_dev->dev,
2872 "cannot %sreset (err = %d)\n",
2873 warm ? "warm " : "", status);
2875 status = hub_port_wait_reset(hub, port1, udev, delay,
2877 if (status && status != -ENOTCONN && status != -ENODEV)
2878 dev_dbg(hub->intfdev,
2879 "port_wait_reset: err = %d\n",
2883 /* Check for disconnect or reset */
2884 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2885 usb_clear_port_feature(hub->hdev, port1,
2886 USB_PORT_FEAT_C_RESET);
2888 if (!hub_is_superspeed(hub->hdev))
2891 usb_clear_port_feature(hub->hdev, port1,
2892 USB_PORT_FEAT_C_BH_PORT_RESET);
2893 usb_clear_port_feature(hub->hdev, port1,
2894 USB_PORT_FEAT_C_PORT_LINK_STATE);
2897 usb_clear_port_feature(hub->hdev, port1,
2898 USB_PORT_FEAT_C_CONNECTION);
2901 * If a USB 3.0 device migrates from reset to an error
2902 * state, re-issue the warm reset.
2904 if (hub_port_status(hub, port1,
2905 &portstatus, &portchange) < 0)
2908 if (!hub_port_warm_reset_required(hub, port1,
2913 * If the port is in SS.Inactive or Compliance Mode, the
2914 * hot or warm reset failed. Try another warm reset.
2917 dev_dbg(&port_dev->dev,
2918 "hot reset failed, warm reset\n");
2923 dev_dbg(&port_dev->dev,
2924 "not enabled, trying %sreset again...\n",
2925 warm ? "warm " : "");
2926 delay = HUB_LONG_RESET_TIME;
2929 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
2933 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
2934 usleep_range(10000, 12000);
2936 /* TRSTRCY = 10 ms; plus some extra */
2937 reset_recovery_time = 10 + 40;
2939 /* Hub needs extra delay after resetting its port. */
2940 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
2941 reset_recovery_time += 100;
2943 msleep(reset_recovery_time);
2947 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2949 update_devnum(udev, 0);
2950 /* The xHC may think the device is already reset,
2951 * so ignore the status.
2953 if (hcd->driver->reset_device)
2954 hcd->driver->reset_device(hcd, udev);
2956 usb_set_device_state(udev, USB_STATE_DEFAULT);
2960 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2963 if (!hub_is_superspeed(hub->hdev))
2964 up_read(&ehci_cf_port_reset_rwsem);
2969 /* Check if a port is power on */
2970 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2974 if (hub_is_superspeed(hub->hdev)) {
2975 if (portstatus & USB_SS_PORT_STAT_POWER)
2978 if (portstatus & USB_PORT_STAT_POWER)
2985 static void usb_lock_port(struct usb_port *port_dev)
2986 __acquires(&port_dev->status_lock)
2988 mutex_lock(&port_dev->status_lock);
2989 __acquire(&port_dev->status_lock);
2992 static void usb_unlock_port(struct usb_port *port_dev)
2993 __releases(&port_dev->status_lock)
2995 mutex_unlock(&port_dev->status_lock);
2996 __release(&port_dev->status_lock);
3001 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3002 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3006 if (hub_is_superspeed(hub->hdev)) {
3007 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3008 == USB_SS_PORT_LS_U3)
3011 if (portstatus & USB_PORT_STAT_SUSPEND)
3018 /* Determine whether the device on a port is ready for a normal resume,
3019 * is ready for a reset-resume, or should be disconnected.
3021 static int check_port_resume_type(struct usb_device *udev,
3022 struct usb_hub *hub, int port1,
3023 int status, u16 portchange, u16 portstatus)
3025 struct usb_port *port_dev = hub->ports[port1 - 1];
3029 /* Is a warm reset needed to recover the connection? */
3030 if (status == 0 && udev->reset_resume
3031 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3034 /* Is the device still present? */
3035 else if (status || port_is_suspended(hub, portstatus) ||
3036 !port_is_power_on(hub, portstatus)) {
3039 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3041 usleep_range(200, 300);
3042 status = hub_port_status(hub, port1, &portstatus,
3049 /* Can't do a normal resume if the port isn't enabled,
3050 * so try a reset-resume instead.
3052 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3053 if (udev->persist_enabled)
3054 udev->reset_resume = 1;
3060 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3061 portchange, portstatus, status);
3062 } else if (udev->reset_resume) {
3064 /* Late port handoff can set status-change bits */
3065 if (portchange & USB_PORT_STAT_C_CONNECTION)
3066 usb_clear_port_feature(hub->hdev, port1,
3067 USB_PORT_FEAT_C_CONNECTION);
3068 if (portchange & USB_PORT_STAT_C_ENABLE)
3069 usb_clear_port_feature(hub->hdev, port1,
3070 USB_PORT_FEAT_C_ENABLE);
3073 * Whatever made this reset-resume necessary may have
3074 * turned on the port1 bit in hub->change_bits. But after
3075 * a successful reset-resume we want the bit to be clear;
3076 * if it was on it would indicate that something happened
3077 * following the reset-resume.
3079 clear_bit(port1, hub->change_bits);
3085 int usb_disable_ltm(struct usb_device *udev)
3087 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3089 /* Check if the roothub and device supports LTM. */
3090 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3091 !usb_device_supports_ltm(udev))
3094 /* Clear Feature LTM Enable can only be sent if the device is
3097 if (!udev->actconfig)
3100 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3101 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3102 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3103 USB_CTRL_SET_TIMEOUT);
3105 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3107 void usb_enable_ltm(struct usb_device *udev)
3109 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3111 /* Check if the roothub and device supports LTM. */
3112 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3113 !usb_device_supports_ltm(udev))
3116 /* Set Feature LTM Enable can only be sent if the device is
3119 if (!udev->actconfig)
3122 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3123 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3124 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3125 USB_CTRL_SET_TIMEOUT);
3127 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3130 * usb_enable_remote_wakeup - enable remote wakeup for a device
3131 * @udev: target device
3133 * For USB-2 devices: Set the device's remote wakeup feature.
3135 * For USB-3 devices: Assume there's only one function on the device and
3136 * enable remote wake for the first interface. FIXME if the interface
3137 * association descriptor shows there's more than one function.
3139 static int usb_enable_remote_wakeup(struct usb_device *udev)
3141 if (udev->speed < USB_SPEED_SUPER)
3142 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3143 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3144 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3145 USB_CTRL_SET_TIMEOUT);
3147 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3148 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3149 USB_INTRF_FUNC_SUSPEND,
3150 USB_INTRF_FUNC_SUSPEND_RW |
3151 USB_INTRF_FUNC_SUSPEND_LP,
3152 NULL, 0, USB_CTRL_SET_TIMEOUT);
3156 * usb_disable_remote_wakeup - disable remote wakeup for a device
3157 * @udev: target device
3159 * For USB-2 devices: Clear the device's remote wakeup feature.
3161 * For USB-3 devices: Assume there's only one function on the device and
3162 * disable remote wake for the first interface. FIXME if the interface
3163 * association descriptor shows there's more than one function.
3165 static int usb_disable_remote_wakeup(struct usb_device *udev)
3167 if (udev->speed < USB_SPEED_SUPER)
3168 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3169 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3170 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3171 USB_CTRL_SET_TIMEOUT);
3173 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3174 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3175 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3176 USB_CTRL_SET_TIMEOUT);
3179 /* Count of wakeup-enabled devices at or below udev */
3180 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3182 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3184 return udev->do_remote_wakeup +
3185 (hub ? hub->wakeup_enabled_descendants : 0);
3189 * usb_port_suspend - suspend a usb device's upstream port
3190 * @udev: device that's no longer in active use, not a root hub
3191 * Context: must be able to sleep; device not locked; pm locks held
3193 * Suspends a USB device that isn't in active use, conserving power.
3194 * Devices may wake out of a suspend, if anything important happens,
3195 * using the remote wakeup mechanism. They may also be taken out of
3196 * suspend by the host, using usb_port_resume(). It's also routine
3197 * to disconnect devices while they are suspended.
3199 * This only affects the USB hardware for a device; its interfaces
3200 * (and, for hubs, child devices) must already have been suspended.
3202 * Selective port suspend reduces power; most suspended devices draw
3203 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3204 * All devices below the suspended port are also suspended.
3206 * Devices leave suspend state when the host wakes them up. Some devices
3207 * also support "remote wakeup", where the device can activate the USB
3208 * tree above them to deliver data, such as a keypress or packet. In
3209 * some cases, this wakes the USB host.
3211 * Suspending OTG devices may trigger HNP, if that's been enabled
3212 * between a pair of dual-role devices. That will change roles, such
3213 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3215 * Devices on USB hub ports have only one "suspend" state, corresponding
3216 * to ACPI D2, "may cause the device to lose some context".
3217 * State transitions include:
3219 * - suspend, resume ... when the VBUS power link stays live
3220 * - suspend, disconnect ... VBUS lost
3222 * Once VBUS drop breaks the circuit, the port it's using has to go through
3223 * normal re-enumeration procedures, starting with enabling VBUS power.
3224 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3225 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3226 * timer, no SRP, no requests through sysfs.
3228 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3229 * suspended until their bus goes into global suspend (i.e., the root
3230 * hub is suspended). Nevertheless, we change @udev->state to
3231 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3232 * upstream port setting is stored in @udev->port_is_suspended.
3234 * Returns 0 on success, else negative errno.
3236 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3238 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3239 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3240 int port1 = udev->portnum;
3242 bool really_suspend = true;
3244 usb_lock_port(port_dev);
3246 /* enable remote wakeup when appropriate; this lets the device
3247 * wake up the upstream hub (including maybe the root hub).
3249 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3250 * we don't explicitly enable it here.
3252 if (udev->do_remote_wakeup) {
3253 status = usb_enable_remote_wakeup(udev);
3255 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3257 /* bail if autosuspend is requested */
3258 if (PMSG_IS_AUTO(msg))
3263 /* disable USB2 hardware LPM */
3264 usb_disable_usb2_hardware_lpm(udev);
3266 if (usb_disable_ltm(udev)) {
3267 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3269 if (PMSG_IS_AUTO(msg))
3274 if (hub_is_superspeed(hub->hdev))
3275 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3278 * For system suspend, we do not need to enable the suspend feature
3279 * on individual USB-2 ports. The devices will automatically go
3280 * into suspend a few ms after the root hub stops sending packets.
3281 * The USB 2.0 spec calls this "global suspend".
3283 * However, many USB hubs have a bug: They don't relay wakeup requests
3284 * from a downstream port if the port's suspend feature isn't on.
3285 * Therefore we will turn on the suspend feature if udev or any of its
3286 * descendants is enabled for remote wakeup.
3288 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3289 status = set_port_feature(hub->hdev, port1,
3290 USB_PORT_FEAT_SUSPEND);
3292 really_suspend = false;
3296 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3298 /* Try to enable USB3 LTM again */
3299 usb_enable_ltm(udev);
3301 /* Try to enable USB2 hardware LPM again */
3302 usb_enable_usb2_hardware_lpm(udev);
3304 if (udev->do_remote_wakeup)
3305 (void) usb_disable_remote_wakeup(udev);
3308 /* System sleep transitions should never fail */
3309 if (!PMSG_IS_AUTO(msg))
3312 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3313 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3314 udev->do_remote_wakeup);
3315 if (really_suspend) {
3316 udev->port_is_suspended = 1;
3318 /* device has up to 10 msec to fully suspend */
3321 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3324 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3325 && test_and_clear_bit(port1, hub->child_usage_bits))
3326 pm_runtime_put_sync(&port_dev->dev);
3328 usb_mark_last_busy(hub->hdev);
3330 usb_unlock_port(port_dev);
3335 * If the USB "suspend" state is in use (rather than "global suspend"),
3336 * many devices will be individually taken out of suspend state using
3337 * special "resume" signaling. This routine kicks in shortly after
3338 * hardware resume signaling is finished, either because of selective
3339 * resume (by host) or remote wakeup (by device) ... now see what changed
3340 * in the tree that's rooted at this device.
3342 * If @udev->reset_resume is set then the device is reset before the
3343 * status check is done.
3345 static int finish_port_resume(struct usb_device *udev)
3350 /* caller owns the udev device lock */
3351 dev_dbg(&udev->dev, "%s\n",
3352 udev->reset_resume ? "finish reset-resume" : "finish resume");
3354 /* usb ch9 identifies four variants of SUSPENDED, based on what
3355 * state the device resumes to. Linux currently won't see the
3356 * first two on the host side; they'd be inside hub_port_init()
3357 * during many timeouts, but hub_wq can't suspend until later.
3359 usb_set_device_state(udev, udev->actconfig
3360 ? USB_STATE_CONFIGURED
3361 : USB_STATE_ADDRESS);
3363 /* 10.5.4.5 says not to reset a suspended port if the attached
3364 * device is enabled for remote wakeup. Hence the reset
3365 * operation is carried out here, after the port has been
3368 if (udev->reset_resume) {
3370 * If the device morphs or switches modes when it is reset,
3371 * we don't want to perform a reset-resume. We'll fail the
3372 * resume, which will cause a logical disconnect, and then
3373 * the device will be rediscovered.
3376 if (udev->quirks & USB_QUIRK_RESET)
3379 status = usb_reset_and_verify_device(udev);
3382 /* 10.5.4.5 says be sure devices in the tree are still there.
3383 * For now let's assume the device didn't go crazy on resume,
3384 * and device drivers will know about any resume quirks.
3388 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3390 /* If a normal resume failed, try doing a reset-resume */
3391 if (status && !udev->reset_resume && udev->persist_enabled) {
3392 dev_dbg(&udev->dev, "retry with reset-resume\n");
3393 udev->reset_resume = 1;
3394 goto retry_reset_resume;
3399 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3402 * There are a few quirky devices which violate the standard
3403 * by claiming to have remote wakeup enabled after a reset,
3404 * which crash if the feature is cleared, hence check for
3405 * udev->reset_resume
3407 } else if (udev->actconfig && !udev->reset_resume) {
3408 if (udev->speed < USB_SPEED_SUPER) {
3409 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3410 status = usb_disable_remote_wakeup(udev);
3412 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3414 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3415 | USB_INTRF_STAT_FUNC_RW))
3416 status = usb_disable_remote_wakeup(udev);
3421 "disable remote wakeup, status %d\n",
3429 * There are some SS USB devices which take longer time for link training.
3430 * XHCI specs 4.19.4 says that when Link training is successful, port
3431 * sets CCS bit to 1. So if SW reads port status before successful link
3432 * training, then it will not find device to be present.
3433 * USB Analyzer log with such buggy devices show that in some cases
3434 * device switch on the RX termination after long delay of host enabling
3435 * the VBUS. In few other cases it has been seen that device fails to
3436 * negotiate link training in first attempt. It has been
3437 * reported till now that few devices take as long as 2000 ms to train
3438 * the link after host enabling its VBUS and termination. Following
3439 * routine implements a 2000 ms timeout for link training. If in a case
3440 * link trains before timeout, loop will exit earlier.
3442 * There are also some 2.0 hard drive based devices and 3.0 thumb
3443 * drives that, when plugged into a 2.0 only port, take a long
3444 * time to set CCS after VBUS enable.
3446 * FIXME: If a device was connected before suspend, but was removed
3447 * while system was asleep, then the loop in the following routine will
3448 * only exit at timeout.
3450 * This routine should only be called when persist is enabled.
3452 static int wait_for_connected(struct usb_device *udev,
3453 struct usb_hub *hub, int *port1,
3454 u16 *portchange, u16 *portstatus)
3456 int status = 0, delay_ms = 0;
3458 while (delay_ms < 2000) {
3459 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3461 if (!port_is_power_on(hub, *portstatus)) {
3467 status = hub_port_status(hub, *port1, portstatus, portchange);
3469 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3474 * usb_port_resume - re-activate a suspended usb device's upstream port
3475 * @udev: device to re-activate, not a root hub
3476 * Context: must be able to sleep; device not locked; pm locks held
3478 * This will re-activate the suspended device, increasing power usage
3479 * while letting drivers communicate again with its endpoints.
3480 * USB resume explicitly guarantees that the power session between
3481 * the host and the device is the same as it was when the device
3484 * If @udev->reset_resume is set then this routine won't check that the
3485 * port is still enabled. Furthermore, finish_port_resume() above will
3486 * reset @udev. The end result is that a broken power session can be
3487 * recovered and @udev will appear to persist across a loss of VBUS power.
3489 * For example, if a host controller doesn't maintain VBUS suspend current
3490 * during a system sleep or is reset when the system wakes up, all the USB
3491 * power sessions below it will be broken. This is especially troublesome
3492 * for mass-storage devices containing mounted filesystems, since the
3493 * device will appear to have disconnected and all the memory mappings
3494 * to it will be lost. Using the USB_PERSIST facility, the device can be
3495 * made to appear as if it had not disconnected.
3497 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3498 * every effort to insure that the same device is present after the
3499 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3500 * quite possible for a device to remain unaltered but its media to be
3501 * changed. If the user replaces a flash memory card while the system is
3502 * asleep, he will have only himself to blame when the filesystem on the
3503 * new card is corrupted and the system crashes.
3505 * Returns 0 on success, else negative errno.
3507 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3509 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3510 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3511 int port1 = udev->portnum;
3513 u16 portchange, portstatus;
3515 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3516 status = pm_runtime_get_sync(&port_dev->dev);
3518 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3524 usb_lock_port(port_dev);
3526 /* Skip the initial Clear-Suspend step for a remote wakeup */
3527 status = hub_port_status(hub, port1, &portstatus, &portchange);
3528 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3529 if (portchange & USB_PORT_STAT_C_SUSPEND)
3530 pm_wakeup_event(&udev->dev, 0);
3531 goto SuspendCleared;
3534 /* see 7.1.7.7; affects power usage, but not budgeting */
3535 if (hub_is_superspeed(hub->hdev))
3536 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3538 status = usb_clear_port_feature(hub->hdev,
3539 port1, USB_PORT_FEAT_SUSPEND);
3541 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3543 /* drive resume for USB_RESUME_TIMEOUT msec */
3544 dev_dbg(&udev->dev, "usb %sresume\n",
3545 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3546 msleep(USB_RESUME_TIMEOUT);
3548 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3549 * stop resume signaling. Then finish the resume
3552 status = hub_port_status(hub, port1, &portstatus, &portchange);
3557 udev->port_is_suspended = 0;
3558 if (hub_is_superspeed(hub->hdev)) {
3559 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3560 usb_clear_port_feature(hub->hdev, port1,
3561 USB_PORT_FEAT_C_PORT_LINK_STATE);
3563 if (portchange & USB_PORT_STAT_C_SUSPEND)
3564 usb_clear_port_feature(hub->hdev, port1,
3565 USB_PORT_FEAT_C_SUSPEND);
3568 /* TRSMRCY = 10 msec */
3572 if (udev->persist_enabled)
3573 status = wait_for_connected(udev, hub, &port1, &portchange,
3576 status = check_port_resume_type(udev,
3577 hub, port1, status, portchange, portstatus);
3579 status = finish_port_resume(udev);
3581 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3582 hub_port_logical_disconnect(hub, port1);
3584 /* Try to enable USB2 hardware LPM */
3585 usb_enable_usb2_hardware_lpm(udev);
3587 /* Try to enable USB3 LTM */
3588 usb_enable_ltm(udev);
3591 usb_unlock_port(port_dev);
3596 int usb_remote_wakeup(struct usb_device *udev)
3600 usb_lock_device(udev);
3601 if (udev->state == USB_STATE_SUSPENDED) {
3602 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3603 status = usb_autoresume_device(udev);
3605 /* Let the drivers do their thing, then... */
3606 usb_autosuspend_device(udev);
3609 usb_unlock_device(udev);
3613 /* Returns 1 if there was a remote wakeup and a connect status change. */
3614 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3615 u16 portstatus, u16 portchange)
3616 __must_hold(&port_dev->status_lock)
3618 struct usb_port *port_dev = hub->ports[port - 1];
3619 struct usb_device *hdev;
3620 struct usb_device *udev;
3621 int connect_change = 0;
3626 udev = port_dev->child;
3627 if (!hub_is_superspeed(hdev)) {
3628 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3630 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3632 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3633 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3634 (link_state != USB_SS_PORT_LS_U0 &&
3635 link_state != USB_SS_PORT_LS_U1 &&
3636 link_state != USB_SS_PORT_LS_U2))
3641 /* TRSMRCY = 10 msec */
3644 usb_unlock_port(port_dev);
3645 ret = usb_remote_wakeup(udev);
3646 usb_lock_port(port_dev);
3651 hub_port_disable(hub, port, 1);
3653 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3654 return connect_change;
3657 static int check_ports_changed(struct usb_hub *hub)
3661 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3662 u16 portstatus, portchange;
3665 status = hub_port_status(hub, port1, &portstatus, &portchange);
3666 if (!status && portchange)
3672 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3674 struct usb_hub *hub = usb_get_intfdata(intf);
3675 struct usb_device *hdev = hub->hdev;
3680 * Warn if children aren't already suspended.
3681 * Also, add up the number of wakeup-enabled descendants.
3683 hub->wakeup_enabled_descendants = 0;
3684 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3685 struct usb_port *port_dev = hub->ports[port1 - 1];
3686 struct usb_device *udev = port_dev->child;
3688 if (udev && udev->can_submit) {
3689 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3690 dev_name(&udev->dev));
3691 if (PMSG_IS_AUTO(msg))
3695 hub->wakeup_enabled_descendants +=
3696 wakeup_enabled_descendants(udev);
3699 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3700 /* check if there are changes pending on hub ports */
3701 if (check_ports_changed(hub)) {
3702 if (PMSG_IS_AUTO(msg))
3704 pm_wakeup_event(&hdev->dev, 2000);
3708 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3709 /* Enable hub to send remote wakeup for all ports. */
3710 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3711 status = set_port_feature(hdev,
3713 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3714 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3715 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3716 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3720 dev_dbg(&intf->dev, "%s\n", __func__);
3722 /* stop hub_wq and related activity */
3723 hub_quiesce(hub, HUB_SUSPEND);
3727 /* Report wakeup requests from the ports of a resuming root hub */
3728 static void report_wakeup_requests(struct usb_hub *hub)
3730 struct usb_device *hdev = hub->hdev;
3731 struct usb_device *udev;
3732 struct usb_hcd *hcd;
3733 unsigned long resuming_ports;
3737 return; /* Not a root hub */
3739 hcd = bus_to_hcd(hdev->bus);
3740 if (hcd->driver->get_resuming_ports) {
3743 * The get_resuming_ports() method returns a bitmap (origin 0)
3744 * of ports which have started wakeup signaling but have not
3745 * yet finished resuming. During system resume we will
3746 * resume all the enabled ports, regardless of any wakeup
3747 * signals, which means the wakeup requests would be lost.
3748 * To prevent this, report them to the PM core here.
3750 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3751 for (i = 0; i < hdev->maxchild; ++i) {
3752 if (test_bit(i, &resuming_ports)) {
3753 udev = hub->ports[i]->child;
3755 pm_wakeup_event(&udev->dev, 0);
3761 static int hub_resume(struct usb_interface *intf)
3763 struct usb_hub *hub = usb_get_intfdata(intf);
3765 dev_dbg(&intf->dev, "%s\n", __func__);
3766 hub_activate(hub, HUB_RESUME);
3769 * This should be called only for system resume, not runtime resume.
3770 * We can't tell the difference here, so some wakeup requests will be
3771 * reported at the wrong time or more than once. This shouldn't
3772 * matter much, so long as they do get reported.
3774 report_wakeup_requests(hub);
3778 static int hub_reset_resume(struct usb_interface *intf)
3780 struct usb_hub *hub = usb_get_intfdata(intf);
3782 dev_dbg(&intf->dev, "%s\n", __func__);
3783 hub_activate(hub, HUB_RESET_RESUME);
3788 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3789 * @rhdev: struct usb_device for the root hub
3791 * The USB host controller driver calls this function when its root hub
3792 * is resumed and Vbus power has been interrupted or the controller
3793 * has been reset. The routine marks @rhdev as having lost power.
3794 * When the hub driver is resumed it will take notice and carry out
3795 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3796 * the others will be disconnected.
3798 void usb_root_hub_lost_power(struct usb_device *rhdev)
3800 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3801 rhdev->reset_resume = 1;
3803 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3805 static const char * const usb3_lpm_names[] = {
3813 * Send a Set SEL control transfer to the device, prior to enabling
3814 * device-initiated U1 or U2. This lets the device know the exit latencies from
3815 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3816 * packet from the host.
3818 * This function will fail if the SEL or PEL values for udev are greater than
3819 * the maximum allowed values for the link state to be enabled.
3821 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3823 struct usb_set_sel_req *sel_values;
3824 unsigned long long u1_sel;
3825 unsigned long long u1_pel;
3826 unsigned long long u2_sel;
3827 unsigned long long u2_pel;
3830 if (udev->state != USB_STATE_CONFIGURED)
3833 /* Convert SEL and PEL stored in ns to us */
3834 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3835 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3836 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3837 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3840 * Make sure that the calculated SEL and PEL values for the link
3841 * state we're enabling aren't bigger than the max SEL/PEL
3842 * value that will fit in the SET SEL control transfer.
3843 * Otherwise the device would get an incorrect idea of the exit
3844 * latency for the link state, and could start a device-initiated
3845 * U1/U2 when the exit latencies are too high.
3847 if ((state == USB3_LPM_U1 &&
3848 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3849 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3850 (state == USB3_LPM_U2 &&
3851 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3852 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3853 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3854 usb3_lpm_names[state], u1_sel, u1_pel);
3859 * If we're enabling device-initiated LPM for one link state,
3860 * but the other link state has a too high SEL or PEL value,
3861 * just set those values to the max in the Set SEL request.
3863 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3864 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3866 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3867 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3869 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3870 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3872 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3873 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3876 * usb_enable_lpm() can be called as part of a failed device reset,
3877 * which may be initiated by an error path of a mass storage driver.
3878 * Therefore, use GFP_NOIO.
3880 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3884 sel_values->u1_sel = u1_sel;
3885 sel_values->u1_pel = u1_pel;
3886 sel_values->u2_sel = cpu_to_le16(u2_sel);
3887 sel_values->u2_pel = cpu_to_le16(u2_pel);
3889 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3893 sel_values, sizeof *(sel_values),
3894 USB_CTRL_SET_TIMEOUT);
3900 * Enable or disable device-initiated U1 or U2 transitions.
3902 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3903 enum usb3_link_state state, bool enable)
3910 feature = USB_DEVICE_U1_ENABLE;
3913 feature = USB_DEVICE_U2_ENABLE;
3916 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3917 __func__, enable ? "enable" : "disable");
3921 if (udev->state != USB_STATE_CONFIGURED) {
3922 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3923 "for unconfigured device.\n",
3924 __func__, enable ? "enable" : "disable",
3925 usb3_lpm_names[state]);
3931 * Now send the control transfer to enable device-initiated LPM
3932 * for either U1 or U2.
3934 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3935 USB_REQ_SET_FEATURE,
3939 USB_CTRL_SET_TIMEOUT);
3941 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3942 USB_REQ_CLEAR_FEATURE,
3946 USB_CTRL_SET_TIMEOUT);
3949 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3950 enable ? "Enable" : "Disable",
3951 usb3_lpm_names[state]);
3957 static int usb_set_lpm_timeout(struct usb_device *udev,
3958 enum usb3_link_state state, int timeout)
3965 feature = USB_PORT_FEAT_U1_TIMEOUT;
3968 feature = USB_PORT_FEAT_U2_TIMEOUT;
3971 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3976 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3977 timeout != USB3_LPM_DEVICE_INITIATED) {
3978 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3979 "which is a reserved value.\n",
3980 usb3_lpm_names[state], timeout);
3984 ret = set_port_feature(udev->parent,
3985 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3988 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3989 "error code %i\n", usb3_lpm_names[state],
3993 if (state == USB3_LPM_U1)
3994 udev->u1_params.timeout = timeout;
3996 udev->u2_params.timeout = timeout;
4001 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4002 * interval is greater than the minimum service interval of any active
4003 * periodic endpoint. See USB 3.2 section 9.4.9
4005 static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4006 enum usb3_link_state state)
4008 unsigned int sel; /* us */
4011 if (state == USB3_LPM_U1)
4012 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4013 else if (state == USB3_LPM_U2)
4014 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4018 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4019 struct usb_interface *intf;
4020 struct usb_endpoint_descriptor *desc;
4021 unsigned int interval;
4023 intf = udev->actconfig->interface[i];
4027 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4028 desc = &intf->cur_altsetting->endpoint[j].desc;
4030 if (usb_endpoint_xfer_int(desc) ||
4031 usb_endpoint_xfer_isoc(desc)) {
4032 interval = (1 << (desc->bInterval - 1)) * 125;
4033 if (sel + 125 > interval)
4042 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4045 * We will attempt to enable U1 or U2, but there are no guarantees that the
4046 * control transfers to set the hub timeout or enable device-initiated U1/U2
4047 * will be successful.
4049 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4050 * hub-initiated U1/U2 will be disabled.
4052 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4053 * driver know about it. If that call fails, it should be harmless, and just
4054 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4056 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4057 enum usb3_link_state state)
4060 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4061 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4063 /* If the device says it doesn't have *any* exit latency to come out of
4064 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4067 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4068 (state == USB3_LPM_U2 && u2_mel == 0))
4072 * First, let the device know about the exit latencies
4073 * associated with the link state we're about to enable.
4075 ret = usb_req_set_sel(udev, state);
4077 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4078 usb3_lpm_names[state]);
4082 /* We allow the host controller to set the U1/U2 timeout internally
4083 * first, so that it can change its schedule to account for the
4084 * additional latency to send data to a device in a lower power
4087 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4089 /* xHCI host controller doesn't want to enable this LPM state. */
4094 dev_warn(&udev->dev, "Could not enable %s link state, "
4095 "xHCI error %i.\n", usb3_lpm_names[state],
4100 if (usb_set_lpm_timeout(udev, state, timeout)) {
4101 /* If we can't set the parent hub U1/U2 timeout,
4102 * device-initiated LPM won't be allowed either, so let the xHCI
4103 * host know that this link state won't be enabled.
4105 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4109 /* Only a configured device will accept the Set Feature
4112 if (udev->actconfig &&
4113 usb_device_may_initiate_lpm(udev, state)) {
4114 if (usb_set_device_initiated_lpm(udev, state, true)) {
4116 * Request to enable device initiated U1/U2 failed,
4117 * better to turn off lpm in this case.
4119 usb_set_lpm_timeout(udev, state, 0);
4120 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4125 if (state == USB3_LPM_U1)
4126 udev->usb3_lpm_u1_enabled = 1;
4127 else if (state == USB3_LPM_U2)
4128 udev->usb3_lpm_u2_enabled = 1;
4131 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4134 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4135 * If zero is returned, the parent will not allow the link to go into U1/U2.
4137 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4138 * it won't have an effect on the bus link state because the parent hub will
4139 * still disallow device-initiated U1/U2 entry.
4141 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4142 * possible. The result will be slightly more bus bandwidth will be taken up
4143 * (to account for U1/U2 exit latency), but it should be harmless.
4145 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4146 enum usb3_link_state state)
4153 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4158 if (usb_set_lpm_timeout(udev, state, 0))
4161 usb_set_device_initiated_lpm(udev, state, false);
4163 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4164 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4165 "bus schedule bandwidth may be impacted.\n",
4166 usb3_lpm_names[state]);
4168 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4169 * is disabled. Hub will disallows link to enter U1/U2 as well,
4170 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4171 * timeout set to 0, no matter device-initiated LPM is disabled or
4174 if (state == USB3_LPM_U1)
4175 udev->usb3_lpm_u1_enabled = 0;
4176 else if (state == USB3_LPM_U2)
4177 udev->usb3_lpm_u2_enabled = 0;
4183 * Disable hub-initiated and device-initiated U1 and U2 entry.
4184 * Caller must own the bandwidth_mutex.
4186 * This will call usb_enable_lpm() on failure, which will decrement
4187 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4189 int usb_disable_lpm(struct usb_device *udev)
4191 struct usb_hcd *hcd;
4193 if (!udev || !udev->parent ||
4194 udev->speed < USB_SPEED_SUPER ||
4195 !udev->lpm_capable ||
4196 udev->state < USB_STATE_DEFAULT)
4199 hcd = bus_to_hcd(udev->bus);
4200 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4203 udev->lpm_disable_count++;
4204 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4207 /* If LPM is enabled, attempt to disable it. */
4208 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4210 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4216 usb_enable_lpm(udev);
4219 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4221 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4222 int usb_unlocked_disable_lpm(struct usb_device *udev)
4224 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4230 mutex_lock(hcd->bandwidth_mutex);
4231 ret = usb_disable_lpm(udev);
4232 mutex_unlock(hcd->bandwidth_mutex);
4236 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4239 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4240 * xHCI host policy may prevent U1 or U2 from being enabled.
4242 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4243 * until the lpm_disable_count drops to zero. Caller must own the
4246 void usb_enable_lpm(struct usb_device *udev)
4248 struct usb_hcd *hcd;
4249 struct usb_hub *hub;
4250 struct usb_port *port_dev;
4252 if (!udev || !udev->parent ||
4253 udev->speed < USB_SPEED_SUPER ||
4254 !udev->lpm_capable ||
4255 udev->state < USB_STATE_DEFAULT)
4258 udev->lpm_disable_count--;
4259 hcd = bus_to_hcd(udev->bus);
4260 /* Double check that we can both enable and disable LPM.
4261 * Device must be configured to accept set feature U1/U2 timeout.
4263 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4264 !hcd->driver->disable_usb3_lpm_timeout)
4267 if (udev->lpm_disable_count > 0)
4270 hub = usb_hub_to_struct_hub(udev->parent);
4274 port_dev = hub->ports[udev->portnum - 1];
4276 if (port_dev->usb3_lpm_u1_permit)
4277 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4279 if (port_dev->usb3_lpm_u2_permit)
4280 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4282 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4284 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4285 void usb_unlocked_enable_lpm(struct usb_device *udev)
4287 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4292 mutex_lock(hcd->bandwidth_mutex);
4293 usb_enable_lpm(udev);
4294 mutex_unlock(hcd->bandwidth_mutex);
4296 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4298 /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4299 static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4300 struct usb_port *port_dev)
4302 struct usb_device *udev = port_dev->child;
4305 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4306 ret = hub_set_port_link_state(hub, port_dev->portnum,
4309 msleep(USB_RESUME_TIMEOUT);
4310 ret = usb_disable_remote_wakeup(udev);
4313 dev_warn(&udev->dev,
4314 "Port disable: can't disable remote wake\n");
4315 udev->do_remote_wakeup = 0;
4319 #else /* CONFIG_PM */
4321 #define hub_suspend NULL
4322 #define hub_resume NULL
4323 #define hub_reset_resume NULL
4325 static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4326 struct usb_port *port_dev) { }
4328 int usb_disable_lpm(struct usb_device *udev)
4332 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4334 void usb_enable_lpm(struct usb_device *udev) { }
4335 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4337 int usb_unlocked_disable_lpm(struct usb_device *udev)
4341 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4343 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4344 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4346 int usb_disable_ltm(struct usb_device *udev)
4350 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4352 void usb_enable_ltm(struct usb_device *udev) { }
4353 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4355 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4356 u16 portstatus, u16 portchange)
4361 #endif /* CONFIG_PM */
4364 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4365 * a connection with a plugged-in cable but will signal the host when the cable
4366 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4368 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4370 struct usb_port *port_dev = hub->ports[port1 - 1];
4371 struct usb_device *hdev = hub->hdev;
4375 if (hub_is_superspeed(hub->hdev)) {
4376 hub_usb3_port_prepare_disable(hub, port_dev);
4377 ret = hub_set_port_link_state(hub, port_dev->portnum,
4380 ret = usb_clear_port_feature(hdev, port1,
4381 USB_PORT_FEAT_ENABLE);
4384 if (port_dev->child && set_state)
4385 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4386 if (ret && ret != -ENODEV)
4387 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4392 * usb_port_disable - disable a usb device's upstream port
4393 * @udev: device to disable
4394 * Context: @udev locked, must be able to sleep.
4396 * Disables a USB device that isn't in active use.
4398 int usb_port_disable(struct usb_device *udev)
4400 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4402 return hub_port_disable(hub, udev->portnum, 0);
4405 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4407 * Between connect detection and reset signaling there must be a delay
4408 * of 100ms at least for debounce and power-settling. The corresponding
4409 * timer shall restart whenever the downstream port detects a disconnect.
4411 * Apparently there are some bluetooth and irda-dongles and a number of
4412 * low-speed devices for which this debounce period may last over a second.
4413 * Not covered by the spec - but easy to deal with.
4415 * This implementation uses a 1500ms total debounce timeout; if the
4416 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4417 * every 25ms for transient disconnects. When the port status has been
4418 * unchanged for 100ms it returns the port status.
4420 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4423 u16 portchange, portstatus;
4424 unsigned connection = 0xffff;
4425 int total_time, stable_time = 0;
4426 struct usb_port *port_dev = hub->ports[port1 - 1];
4428 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4429 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4433 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4434 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4435 if (!must_be_connected ||
4436 (connection == USB_PORT_STAT_CONNECTION))
4437 stable_time += HUB_DEBOUNCE_STEP;
4438 if (stable_time >= HUB_DEBOUNCE_STABLE)
4442 connection = portstatus & USB_PORT_STAT_CONNECTION;
4445 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4446 usb_clear_port_feature(hub->hdev, port1,
4447 USB_PORT_FEAT_C_CONNECTION);
4450 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4452 msleep(HUB_DEBOUNCE_STEP);
4455 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4456 total_time, stable_time, portstatus);
4458 if (stable_time < HUB_DEBOUNCE_STABLE)
4463 void usb_ep0_reinit(struct usb_device *udev)
4465 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4466 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4467 usb_enable_endpoint(udev, &udev->ep0, true);
4469 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4471 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4472 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4474 static int hub_set_address(struct usb_device *udev, int devnum)
4477 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4480 * The host controller will choose the device address,
4481 * instead of the core having chosen it earlier
4483 if (!hcd->driver->address_device && devnum <= 1)
4485 if (udev->state == USB_STATE_ADDRESS)
4487 if (udev->state != USB_STATE_DEFAULT)
4489 if (hcd->driver->address_device)
4490 retval = hcd->driver->address_device(hcd, udev);
4492 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4493 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4494 NULL, 0, USB_CTRL_SET_TIMEOUT);
4496 update_devnum(udev, devnum);
4497 /* Device now using proper address. */
4498 usb_set_device_state(udev, USB_STATE_ADDRESS);
4499 usb_ep0_reinit(udev);
4505 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4506 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4509 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4510 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4511 * support bit in the BOS descriptor.
4513 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4515 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4516 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4518 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4522 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4524 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4525 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4526 udev->usb2_hw_lpm_allowed = 1;
4527 usb_enable_usb2_hardware_lpm(udev);
4531 static int hub_enable_device(struct usb_device *udev)
4533 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4535 if (!hcd->driver->enable_device)
4537 if (udev->state == USB_STATE_ADDRESS)
4539 if (udev->state != USB_STATE_DEFAULT)
4542 return hcd->driver->enable_device(hcd, udev);
4545 /* Reset device, (re)assign address, get device descriptor.
4546 * Device connection must be stable, no more debouncing needed.
4547 * Returns device in USB_STATE_ADDRESS, except on error.
4549 * If this is called for an already-existing device (as part of
4550 * usb_reset_and_verify_device), the caller must own the device lock and
4551 * the port lock. For a newly detected device that is not accessible
4552 * through any global pointers, it's not necessary to lock the device,
4553 * but it is still necessary to lock the port.
4556 hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4559 struct usb_device *hdev = hub->hdev;
4560 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4561 struct usb_port *port_dev = hub->ports[port1 - 1];
4562 int retries, operations, retval, i;
4563 unsigned delay = HUB_SHORT_RESET_TIME;
4564 enum usb_device_speed oldspeed = udev->speed;
4566 int devnum = udev->devnum;
4567 const char *driver_name;
4569 /* root hub ports have a slightly longer reset period
4570 * (from USB 2.0 spec, section 7.1.7.5)
4572 if (!hdev->parent) {
4573 delay = HUB_ROOT_RESET_TIME;
4574 if (port1 == hdev->bus->otg_port)
4575 hdev->bus->b_hnp_enable = 0;
4578 /* Some low speed devices have problems with the quick delay, so */
4579 /* be a bit pessimistic with those devices. RHbug #23670 */
4580 if (oldspeed == USB_SPEED_LOW)
4581 delay = HUB_LONG_RESET_TIME;
4583 /* Reset the device; full speed may morph to high speed */
4584 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4585 retval = hub_port_reset(hub, port1, udev, delay, false);
4586 if (retval < 0) /* error or disconnect */
4588 /* success, speed is known */
4592 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4593 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4594 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4595 dev_dbg(&udev->dev, "device reset changed speed!\n");
4598 oldspeed = udev->speed;
4600 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4601 * it's fixed size except for full speed devices.
4602 * For Wireless USB devices, ep0 max packet is always 512 (tho
4603 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4605 switch (udev->speed) {
4606 case USB_SPEED_SUPER_PLUS:
4607 case USB_SPEED_SUPER:
4608 case USB_SPEED_WIRELESS: /* fixed at 512 */
4609 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4611 case USB_SPEED_HIGH: /* fixed at 64 */
4612 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4614 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4615 /* to determine the ep0 maxpacket size, try to read
4616 * the device descriptor to get bMaxPacketSize0 and
4617 * then correct our initial guess.
4619 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4621 case USB_SPEED_LOW: /* fixed at 8 */
4622 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4628 if (udev->speed == USB_SPEED_WIRELESS)
4629 speed = "variable speed Wireless";
4631 speed = usb_speed_string(udev->speed);
4634 * The controller driver may be NULL if the controller device
4635 * is the middle device between platform device and roothub.
4636 * This middle device may not need a device driver due to
4637 * all hardware control can be at platform device driver, this
4638 * platform device is usually a dual-role USB controller device.
4640 if (udev->bus->controller->driver)
4641 driver_name = udev->bus->controller->driver->name;
4643 driver_name = udev->bus->sysdev->driver->name;
4645 if (udev->speed < USB_SPEED_SUPER)
4646 dev_info(&udev->dev,
4647 "%s %s USB device number %d using %s\n",
4648 (udev->config) ? "reset" : "new", speed,
4649 devnum, driver_name);
4651 /* Set up TT records, if needed */
4653 udev->tt = hdev->tt;
4654 udev->ttport = hdev->ttport;
4655 } else if (udev->speed != USB_SPEED_HIGH
4656 && hdev->speed == USB_SPEED_HIGH) {
4658 dev_err(&udev->dev, "parent hub has no TT\n");
4662 udev->tt = &hub->tt;
4663 udev->ttport = port1;
4666 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4667 * Because device hardware and firmware is sometimes buggy in
4668 * this area, and this is how Linux has done it for ages.
4669 * Change it cautiously.
4671 * NOTE: If use_new_scheme() is true we will start by issuing
4672 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4673 * so it may help with some non-standards-compliant devices.
4674 * Otherwise we start with SET_ADDRESS and then try to read the
4675 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4678 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4679 bool did_new_scheme = false;
4681 if (use_new_scheme(udev, retry_counter, port_dev)) {
4682 struct usb_device_descriptor *buf;
4685 did_new_scheme = true;
4686 retval = hub_enable_device(udev);
4689 "hub failed to enable device, error %d\n",
4694 #define GET_DESCRIPTOR_BUFSIZE 64
4695 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4701 /* Retry on all errors; some devices are flakey.
4702 * 255 is for WUSB devices, we actually need to use
4703 * 512 (WUSB1.0[4.8.1]).
4705 for (operations = 0; operations < 3; ++operations) {
4706 buf->bMaxPacketSize0 = 0;
4707 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4708 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4709 USB_DT_DEVICE << 8, 0,
4710 buf, GET_DESCRIPTOR_BUFSIZE,
4711 initial_descriptor_timeout);
4712 switch (buf->bMaxPacketSize0) {
4713 case 8: case 16: case 32: case 64: case 255:
4714 if (buf->bDescriptorType ==
4726 * Some devices time out if they are powered on
4727 * when already connected. They need a second
4728 * reset. But only on the first attempt,
4729 * lest we get into a time out/reset loop
4731 if (r == 0 || (r == -ETIMEDOUT &&
4733 udev->speed > USB_SPEED_FULL))
4736 udev->descriptor.bMaxPacketSize0 =
4737 buf->bMaxPacketSize0;
4740 retval = hub_port_reset(hub, port1, udev, delay, false);
4741 if (retval < 0) /* error or disconnect */
4743 if (oldspeed != udev->speed) {
4745 "device reset changed speed!\n");
4751 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4756 #undef GET_DESCRIPTOR_BUFSIZE
4760 * If device is WUSB, we already assigned an
4761 * unauthorized address in the Connect Ack sequence;
4762 * authorization will assign the final address.
4764 if (udev->wusb == 0) {
4765 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4766 retval = hub_set_address(udev, devnum);
4772 if (retval != -ENODEV)
4773 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4777 if (udev->speed >= USB_SPEED_SUPER) {
4778 devnum = udev->devnum;
4779 dev_info(&udev->dev,
4780 "%s SuperSpeed%s%s USB device number %d using %s\n",
4781 (udev->config) ? "reset" : "new",
4782 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4783 "Plus Gen 2" : " Gen 1",
4784 (udev->rx_lanes == 2 && udev->tx_lanes == 2) ?
4786 devnum, driver_name);
4789 /* cope with hardware quirkiness:
4790 * - let SET_ADDRESS settle, some device hardware wants it
4791 * - read ep0 maxpacket even for high and low speed,
4794 /* use_new_scheme() checks the speed which may have
4795 * changed since the initial look so we cache the result
4802 retval = usb_get_device_descriptor(udev, 8);
4804 if (retval != -ENODEV)
4806 "device descriptor read/8, error %d\n",
4815 delay = udev->parent->hub_delay;
4816 udev->hub_delay = min_t(u32, delay,
4817 USB_TP_TRANSMISSION_DELAY_MAX);
4818 retval = usb_set_isoch_delay(udev);
4821 "Failed set isoch delay, error %d\n",
4832 * Some superspeed devices have finished the link training process
4833 * and attached to a superspeed hub port, but the device descriptor
4834 * got from those devices show they aren't superspeed devices. Warm
4835 * reset the port attached by the devices can fix them.
4837 if ((udev->speed >= USB_SPEED_SUPER) &&
4838 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4839 dev_err(&udev->dev, "got a wrong device descriptor, "
4840 "warm reset device\n");
4841 hub_port_reset(hub, port1, udev,
4842 HUB_BH_RESET_TIME, true);
4847 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4848 udev->speed >= USB_SPEED_SUPER)
4851 i = udev->descriptor.bMaxPacketSize0;
4852 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4853 if (udev->speed == USB_SPEED_LOW ||
4854 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4855 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4859 if (udev->speed == USB_SPEED_FULL)
4860 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4862 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4863 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4864 usb_ep0_reinit(udev);
4867 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4868 if (retval < (signed)sizeof(udev->descriptor)) {
4869 if (retval != -ENODEV)
4870 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4877 usb_detect_quirks(udev);
4879 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4880 retval = usb_get_bos_descriptor(udev);
4882 udev->lpm_capable = usb_device_supports_lpm(udev);
4883 usb_set_lpm_parameters(udev);
4888 /* notify HCD that we have a device connected and addressed */
4889 if (hcd->driver->update_device)
4890 hcd->driver->update_device(hcd, udev);
4891 hub_set_initial_usb2_lpm_policy(udev);
4894 hub_port_disable(hub, port1, 0);
4895 update_devnum(udev, devnum); /* for disconnect processing */
4901 check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
4903 struct usb_qualifier_descriptor *qual;
4906 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4909 qual = kmalloc(sizeof *qual, GFP_KERNEL);
4913 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
4914 qual, sizeof *qual);
4915 if (status == sizeof *qual) {
4916 dev_info(&udev->dev, "not running at top speed; "
4917 "connect to a high speed hub\n");
4918 /* hub LEDs are probably harder to miss than syslog */
4919 if (hub->has_indicators) {
4920 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4921 queue_delayed_work(system_power_efficient_wq,
4929 hub_power_remaining(struct usb_hub *hub)
4931 struct usb_device *hdev = hub->hdev;
4935 if (!hub->limited_power)
4938 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4939 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4940 struct usb_port *port_dev = hub->ports[port1 - 1];
4941 struct usb_device *udev = port_dev->child;
4947 if (hub_is_superspeed(udev))
4953 * Unconfigured devices may not use more than one unit load,
4954 * or 8mA for OTG ports
4956 if (udev->actconfig)
4957 delta = usb_get_max_power(udev, udev->actconfig);
4958 else if (port1 != udev->bus->otg_port || hdev->parent)
4962 if (delta > hub->mA_per_port)
4963 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4964 delta, hub->mA_per_port);
4967 if (remaining < 0) {
4968 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4975 static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4978 int status = -ENODEV;
4981 struct usb_device *hdev = hub->hdev;
4982 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4983 struct usb_port *port_dev = hub->ports[port1 - 1];
4984 struct usb_device *udev = port_dev->child;
4985 static int unreliable_port = -1;
4988 /* Disconnect any existing devices under this port */
4990 if (hcd->usb_phy && !hdev->parent)
4991 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
4992 usb_disconnect(&port_dev->child);
4995 /* We can forget about a "removed" device when there's a physical
4996 * disconnect or the connect status changes.
4998 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4999 (portchange & USB_PORT_STAT_C_CONNECTION))
5000 clear_bit(port1, hub->removed_bits);
5002 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5003 USB_PORT_STAT_C_ENABLE)) {
5004 status = hub_port_debounce_be_stable(hub, port1);
5006 if (status != -ENODEV &&
5007 port1 != unreliable_port &&
5009 dev_err(&port_dev->dev, "connect-debounce failed\n");
5010 portstatus &= ~USB_PORT_STAT_CONNECTION;
5011 unreliable_port = port1;
5013 portstatus = status;
5017 /* Return now if debouncing failed or nothing is connected or
5018 * the device was "removed".
5020 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5021 test_bit(port1, hub->removed_bits)) {
5024 * maybe switch power back on (e.g. root hub was reset)
5025 * but only if the port isn't owned by someone else.
5027 if (hub_is_port_power_switchable(hub)
5028 && !port_is_power_on(hub, portstatus)
5029 && !port_dev->port_owner)
5030 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5032 if (portstatus & USB_PORT_STAT_ENABLE)
5036 if (hub_is_superspeed(hub->hdev))
5043 for (i = 0; i < SET_CONFIG_TRIES; i++) {
5044 usb_lock_port(port_dev);
5045 mutex_lock(hcd->address0_mutex);
5046 retry_locked = true;
5048 /* reallocate for each attempt, since references
5049 * to the previous one can escape in various ways
5051 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5053 dev_err(&port_dev->dev,
5054 "couldn't allocate usb_device\n");
5055 mutex_unlock(hcd->address0_mutex);
5056 usb_unlock_port(port_dev);
5060 usb_set_device_state(udev, USB_STATE_POWERED);
5061 udev->bus_mA = hub->mA_per_port;
5062 udev->level = hdev->level + 1;
5063 udev->wusb = hub_is_wusb(hub);
5065 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5066 if (hub_is_superspeed(hub->hdev))
5067 udev->speed = USB_SPEED_SUPER;
5069 udev->speed = USB_SPEED_UNKNOWN;
5071 choose_devnum(udev);
5072 if (udev->devnum <= 0) {
5073 status = -ENOTCONN; /* Don't retry */
5077 /* reset (non-USB 3.0 devices) and get descriptor */
5078 status = hub_port_init(hub, udev, port1, i);
5082 mutex_unlock(hcd->address0_mutex);
5083 usb_unlock_port(port_dev);
5084 retry_locked = false;
5086 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5089 /* consecutive bus-powered hubs aren't reliable; they can
5090 * violate the voltage drop budget. if the new child has
5091 * a "powered" LED, users should notice we didn't enable it
5092 * (without reading syslog), even without per-port LEDs
5095 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5096 && udev->bus_mA <= unit_load) {
5099 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5102 dev_dbg(&udev->dev, "get status %d ?\n", status);
5105 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5107 "can't connect bus-powered hub "
5109 if (hub->has_indicators) {
5110 hub->indicator[port1-1] =
5111 INDICATOR_AMBER_BLINK;
5113 system_power_efficient_wq,
5116 status = -ENOTCONN; /* Don't retry */
5121 /* check for devices running slower than they could */
5122 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5123 && udev->speed == USB_SPEED_FULL
5124 && highspeed_hubs != 0)
5125 check_highspeed(hub, udev, port1);
5127 /* Store the parent's children[] pointer. At this point
5128 * udev becomes globally accessible, although presumably
5129 * no one will look at it until hdev is unlocked.
5133 mutex_lock(&usb_port_peer_mutex);
5135 /* We mustn't add new devices if the parent hub has
5136 * been disconnected; we would race with the
5137 * recursively_mark_NOTATTACHED() routine.
5139 spin_lock_irq(&device_state_lock);
5140 if (hdev->state == USB_STATE_NOTATTACHED)
5143 port_dev->child = udev;
5144 spin_unlock_irq(&device_state_lock);
5145 mutex_unlock(&usb_port_peer_mutex);
5147 /* Run it through the hoops (find a driver, etc) */
5149 status = usb_new_device(udev);
5151 mutex_lock(&usb_port_peer_mutex);
5152 spin_lock_irq(&device_state_lock);
5153 port_dev->child = NULL;
5154 spin_unlock_irq(&device_state_lock);
5155 mutex_unlock(&usb_port_peer_mutex);
5157 if (hcd->usb_phy && !hdev->parent)
5158 usb_phy_notify_connect(hcd->usb_phy,
5166 status = hub_power_remaining(hub);
5168 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5173 hub_port_disable(hub, port1, 1);
5175 usb_ep0_reinit(udev);
5176 release_devnum(udev);
5179 mutex_unlock(hcd->address0_mutex);
5180 usb_unlock_port(port_dev);
5183 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5186 /* When halfway through our retry count, power-cycle the port */
5187 if (i == (SET_CONFIG_TRIES / 2) - 1) {
5188 dev_info(&port_dev->dev, "attempt power cycle\n");
5189 usb_hub_set_port_power(hdev, hub, port1, false);
5190 msleep(2 * hub_power_on_good_delay(hub));
5191 usb_hub_set_port_power(hdev, hub, port1, true);
5192 msleep(hub_power_on_good_delay(hub));
5195 if (hub->hdev->parent ||
5196 !hcd->driver->port_handed_over ||
5197 !(hcd->driver->port_handed_over)(hcd, port1)) {
5198 if (status != -ENOTCONN && status != -ENODEV)
5199 dev_err(&port_dev->dev,
5200 "unable to enumerate USB device\n");
5204 hub_port_disable(hub, port1, 1);
5205 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5206 if (status != -ENOTCONN && status != -ENODEV)
5207 hcd->driver->relinquish_port(hcd, port1);
5211 /* Handle physical or logical connection change events.
5212 * This routine is called when:
5213 * a port connection-change occurs;
5214 * a port enable-change occurs (often caused by EMI);
5215 * usb_reset_and_verify_device() encounters changed descriptors (as from
5216 * a firmware download)
5217 * caller already locked the hub
5219 static void hub_port_connect_change(struct usb_hub *hub, int port1,
5220 u16 portstatus, u16 portchange)
5221 __must_hold(&port_dev->status_lock)
5223 struct usb_port *port_dev = hub->ports[port1 - 1];
5224 struct usb_device *udev = port_dev->child;
5225 int status = -ENODEV;
5227 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5228 portchange, portspeed(hub, portstatus));
5230 if (hub->has_indicators) {
5231 set_port_led(hub, port1, HUB_LED_AUTO);
5232 hub->indicator[port1-1] = INDICATOR_AUTO;
5235 #ifdef CONFIG_USB_OTG
5236 /* during HNP, don't repeat the debounce */
5237 if (hub->hdev->bus->is_b_host)
5238 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5239 USB_PORT_STAT_C_ENABLE);
5242 /* Try to resuscitate an existing device */
5243 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5244 udev->state != USB_STATE_NOTATTACHED) {
5245 if (portstatus & USB_PORT_STAT_ENABLE) {
5246 status = 0; /* Nothing to do */
5248 } else if (udev->state == USB_STATE_SUSPENDED &&
5249 udev->persist_enabled) {
5250 /* For a suspended device, treat this as a
5251 * remote wakeup event.
5253 usb_unlock_port(port_dev);
5254 status = usb_remote_wakeup(udev);
5255 usb_lock_port(port_dev);
5258 /* Don't resuscitate */;
5261 clear_bit(port1, hub->change_bits);
5263 /* successfully revalidated the connection */
5267 usb_unlock_port(port_dev);
5268 hub_port_connect(hub, port1, portstatus, portchange);
5269 usb_lock_port(port_dev);
5272 static void port_event(struct usb_hub *hub, int port1)
5273 __must_hold(&port_dev->status_lock)
5276 struct usb_port *port_dev = hub->ports[port1 - 1];
5277 struct usb_device *udev = port_dev->child;
5278 struct usb_device *hdev = hub->hdev;
5279 u16 portstatus, portchange;
5281 connect_change = test_bit(port1, hub->change_bits);
5282 clear_bit(port1, hub->event_bits);
5283 clear_bit(port1, hub->wakeup_bits);
5285 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5288 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5289 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5293 if (portchange & USB_PORT_STAT_C_ENABLE) {
5294 if (!connect_change)
5295 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5297 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5300 * EM interference sometimes causes badly shielded USB devices
5301 * to be shutdown by the hub, this hack enables them again.
5302 * Works at least with mouse driver.
5304 if (!(portstatus & USB_PORT_STAT_ENABLE)
5305 && !connect_change && udev) {
5306 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5311 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5312 u16 status = 0, unused;
5313 port_dev->over_current_count++;
5315 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5316 port_dev->over_current_count);
5317 usb_clear_port_feature(hdev, port1,
5318 USB_PORT_FEAT_C_OVER_CURRENT);
5319 msleep(100); /* Cool down */
5320 hub_power_on(hub, true);
5321 hub_port_status(hub, port1, &status, &unused);
5322 if (status & USB_PORT_STAT_OVERCURRENT)
5323 dev_err(&port_dev->dev, "over-current condition\n");
5326 if (portchange & USB_PORT_STAT_C_RESET) {
5327 dev_dbg(&port_dev->dev, "reset change\n");
5328 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5330 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5331 && hub_is_superspeed(hdev)) {
5332 dev_dbg(&port_dev->dev, "warm reset change\n");
5333 usb_clear_port_feature(hdev, port1,
5334 USB_PORT_FEAT_C_BH_PORT_RESET);
5336 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5337 dev_dbg(&port_dev->dev, "link state change\n");
5338 usb_clear_port_feature(hdev, port1,
5339 USB_PORT_FEAT_C_PORT_LINK_STATE);
5341 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5342 dev_warn(&port_dev->dev, "config error\n");
5343 usb_clear_port_feature(hdev, port1,
5344 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5347 /* skip port actions that require the port to be powered on */
5348 if (!pm_runtime_active(&port_dev->dev))
5351 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5355 * Warm reset a USB3 protocol port if it's in
5356 * SS.Inactive state.
5358 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5359 dev_dbg(&port_dev->dev, "do warm reset\n");
5360 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5361 || udev->state == USB_STATE_NOTATTACHED) {
5362 if (hub_port_reset(hub, port1, NULL,
5363 HUB_BH_RESET_TIME, true) < 0)
5364 hub_port_disable(hub, port1, 1);
5366 usb_unlock_port(port_dev);
5367 usb_lock_device(udev);
5368 usb_reset_device(udev);
5369 usb_unlock_device(udev);
5370 usb_lock_port(port_dev);
5376 hub_port_connect_change(hub, port1, portstatus, portchange);
5379 static void hub_event(struct work_struct *work)
5381 struct usb_device *hdev;
5382 struct usb_interface *intf;
5383 struct usb_hub *hub;
5384 struct device *hub_dev;
5389 hub = container_of(work, struct usb_hub, events);
5391 hub_dev = hub->intfdev;
5392 intf = to_usb_interface(hub_dev);
5394 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5395 hdev->state, hdev->maxchild,
5396 /* NOTE: expects max 15 ports... */
5397 (u16) hub->change_bits[0],
5398 (u16) hub->event_bits[0]);
5400 /* Lock the device, then check to see if we were
5401 * disconnected while waiting for the lock to succeed. */
5402 usb_lock_device(hdev);
5403 if (unlikely(hub->disconnected))
5406 /* If the hub has died, clean up after it */
5407 if (hdev->state == USB_STATE_NOTATTACHED) {
5408 hub->error = -ENODEV;
5409 hub_quiesce(hub, HUB_DISCONNECT);
5414 ret = usb_autopm_get_interface(intf);
5416 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5420 /* If this is an inactive hub, do nothing */
5425 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5427 ret = usb_reset_device(hdev);
5429 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5437 /* deal with port status changes */
5438 for (i = 1; i <= hdev->maxchild; i++) {
5439 struct usb_port *port_dev = hub->ports[i - 1];
5441 if (test_bit(i, hub->event_bits)
5442 || test_bit(i, hub->change_bits)
5443 || test_bit(i, hub->wakeup_bits)) {
5445 * The get_noresume and barrier ensure that if
5446 * the port was in the process of resuming, we
5447 * flush that work and keep the port active for
5448 * the duration of the port_event(). However,
5449 * if the port is runtime pm suspended
5450 * (powered-off), we leave it in that state, run
5451 * an abbreviated port_event(), and move on.
5453 pm_runtime_get_noresume(&port_dev->dev);
5454 pm_runtime_barrier(&port_dev->dev);
5455 usb_lock_port(port_dev);
5457 usb_unlock_port(port_dev);
5458 pm_runtime_put_sync(&port_dev->dev);
5462 /* deal with hub status changes */
5463 if (test_and_clear_bit(0, hub->event_bits) == 0)
5465 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5466 dev_err(hub_dev, "get_hub_status failed\n");
5468 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5469 dev_dbg(hub_dev, "power change\n");
5470 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5471 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5472 /* FIXME: Is this always true? */
5473 hub->limited_power = 1;
5475 hub->limited_power = 0;
5477 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5481 dev_dbg(hub_dev, "over-current change\n");
5482 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5483 msleep(500); /* Cool down */
5484 hub_power_on(hub, true);
5485 hub_hub_status(hub, &status, &unused);
5486 if (status & HUB_STATUS_OVERCURRENT)
5487 dev_err(hub_dev, "over-current condition\n");
5492 /* Balance the usb_autopm_get_interface() above */
5493 usb_autopm_put_interface_no_suspend(intf);
5495 usb_unlock_device(hdev);
5497 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5498 usb_autopm_put_interface(intf);
5499 kref_put(&hub->kref, hub_release);
5502 static const struct usb_device_id hub_id_table[] = {
5503 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5504 | USB_DEVICE_ID_MATCH_PRODUCT
5505 | USB_DEVICE_ID_MATCH_INT_CLASS,
5506 .idVendor = USB_VENDOR_SMSC,
5507 .idProduct = USB_PRODUCT_USB5534B,
5508 .bInterfaceClass = USB_CLASS_HUB,
5509 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5510 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5511 | USB_DEVICE_ID_MATCH_PRODUCT,
5512 .idVendor = USB_VENDOR_CYPRESS,
5513 .idProduct = USB_PRODUCT_CY7C65632,
5514 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5515 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5516 | USB_DEVICE_ID_MATCH_INT_CLASS,
5517 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5518 .bInterfaceClass = USB_CLASS_HUB,
5519 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5520 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5521 | USB_DEVICE_ID_MATCH_PRODUCT,
5522 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5523 .idProduct = USB_PRODUCT_TUSB8041_USB2,
5524 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5525 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5526 | USB_DEVICE_ID_MATCH_PRODUCT,
5527 .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS,
5528 .idProduct = USB_PRODUCT_TUSB8041_USB3,
5529 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5530 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5531 .bDeviceClass = USB_CLASS_HUB},
5532 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5533 .bInterfaceClass = USB_CLASS_HUB},
5534 { } /* Terminating entry */
5537 MODULE_DEVICE_TABLE(usb, hub_id_table);
5539 static struct usb_driver hub_driver = {
5542 .disconnect = hub_disconnect,
5543 .suspend = hub_suspend,
5544 .resume = hub_resume,
5545 .reset_resume = hub_reset_resume,
5546 .pre_reset = hub_pre_reset,
5547 .post_reset = hub_post_reset,
5548 .unlocked_ioctl = hub_ioctl,
5549 .id_table = hub_id_table,
5550 .supports_autosuspend = 1,
5553 int usb_hub_init(void)
5555 if (usb_register(&hub_driver) < 0) {
5556 printk(KERN_ERR "%s: can't register hub driver\n",
5562 * The workqueue needs to be freezable to avoid interfering with
5563 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5564 * device was gone before the EHCI controller had handed its port
5565 * over to the companion full-speed controller.
5567 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5571 /* Fall through if kernel_thread failed */
5572 usb_deregister(&hub_driver);
5573 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5578 void usb_hub_cleanup(void)
5580 destroy_workqueue(hub_wq);
5583 * Hub resources are freed for us by usb_deregister. It calls
5584 * usb_driver_purge on every device which in turn calls that
5585 * devices disconnect function if it is using this driver.
5586 * The hub_disconnect function takes care of releasing the
5587 * individual hub resources. -greg
5589 usb_deregister(&hub_driver);
5590 } /* usb_hub_cleanup() */
5592 static int descriptors_changed(struct usb_device *udev,
5593 struct usb_device_descriptor *old_device_descriptor,
5594 struct usb_host_bos *old_bos)
5598 unsigned serial_len = 0;
5600 unsigned old_length;
5604 if (memcmp(&udev->descriptor, old_device_descriptor,
5605 sizeof(*old_device_descriptor)) != 0)
5608 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5611 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5612 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5614 if (memcmp(udev->bos->desc, old_bos->desc, len))
5618 /* Since the idVendor, idProduct, and bcdDevice values in the
5619 * device descriptor haven't changed, we will assume the
5620 * Manufacturer and Product strings haven't changed either.
5621 * But the SerialNumber string could be different (e.g., a
5622 * different flash card of the same brand).
5625 serial_len = strlen(udev->serial) + 1;
5628 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5629 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5630 len = max(len, old_length);
5633 buf = kmalloc(len, GFP_NOIO);
5635 /* assume the worst */
5638 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5639 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5640 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5642 if (length != old_length) {
5643 dev_dbg(&udev->dev, "config index %d, error %d\n",
5648 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5650 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5652 ((struct usb_config_descriptor *) buf)->
5653 bConfigurationValue);
5659 if (!changed && serial_len) {
5660 length = usb_string(udev, udev->descriptor.iSerialNumber,
5662 if (length + 1 != serial_len) {
5663 dev_dbg(&udev->dev, "serial string error %d\n",
5666 } else if (memcmp(buf, udev->serial, length) != 0) {
5667 dev_dbg(&udev->dev, "serial string changed\n");
5677 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5678 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5680 * WARNING - don't use this routine to reset a composite device
5681 * (one with multiple interfaces owned by separate drivers)!
5682 * Use usb_reset_device() instead.
5684 * Do a port reset, reassign the device's address, and establish its
5685 * former operating configuration. If the reset fails, or the device's
5686 * descriptors change from their values before the reset, or the original
5687 * configuration and altsettings cannot be restored, a flag will be set
5688 * telling hub_wq to pretend the device has been disconnected and then
5689 * re-connected. All drivers will be unbound, and the device will be
5690 * re-enumerated and probed all over again.
5692 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5693 * flagged for logical disconnection, or some other negative error code
5694 * if the reset wasn't even attempted.
5697 * The caller must own the device lock and the port lock, the latter is
5698 * taken by usb_reset_device(). For example, it's safe to use
5699 * usb_reset_device() from a driver probe() routine after downloading
5700 * new firmware. For calls that might not occur during probe(), drivers
5701 * should lock the device using usb_lock_device_for_reset().
5703 * Locking exception: This routine may also be called from within an
5704 * autoresume handler. Such usage won't conflict with other tasks
5705 * holding the device lock because these tasks should always call
5706 * usb_autopm_resume_device(), thereby preventing any unwanted
5707 * autoresume. The autoresume handler is expected to have already
5708 * acquired the port lock before calling this routine.
5710 static int usb_reset_and_verify_device(struct usb_device *udev)
5712 struct usb_device *parent_hdev = udev->parent;
5713 struct usb_hub *parent_hub;
5714 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5715 struct usb_device_descriptor descriptor = udev->descriptor;
5716 struct usb_host_bos *bos;
5718 int port1 = udev->portnum;
5720 if (udev->state == USB_STATE_NOTATTACHED ||
5721 udev->state == USB_STATE_SUSPENDED) {
5722 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5730 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5732 /* Disable USB2 hardware LPM.
5733 * It will be re-enabled by the enumeration process.
5735 usb_disable_usb2_hardware_lpm(udev);
5737 /* Disable LPM while we reset the device and reinstall the alt settings.
5738 * Device-initiated LPM, and system exit latency settings are cleared
5739 * when the device is reset, so we have to set them up again.
5741 ret = usb_unlocked_disable_lpm(udev);
5743 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5744 goto re_enumerate_no_bos;
5750 mutex_lock(hcd->address0_mutex);
5752 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5754 /* ep0 maxpacket size may change; let the HCD know about it.
5755 * Other endpoints will be handled by re-enumeration. */
5756 usb_ep0_reinit(udev);
5757 ret = hub_port_init(parent_hub, udev, port1, i);
5758 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5761 mutex_unlock(hcd->address0_mutex);
5766 /* Device might have changed firmware (DFU or similar) */
5767 if (descriptors_changed(udev, &descriptor, bos)) {
5768 dev_info(&udev->dev, "device firmware changed\n");
5769 udev->descriptor = descriptor; /* for disconnect() calls */
5773 /* Restore the device's previous configuration */
5774 if (!udev->actconfig)
5777 mutex_lock(hcd->bandwidth_mutex);
5778 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5780 dev_warn(&udev->dev,
5781 "Busted HC? Not enough HCD resources for "
5782 "old configuration.\n");
5783 mutex_unlock(hcd->bandwidth_mutex);
5786 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5787 USB_REQ_SET_CONFIGURATION, 0,
5788 udev->actconfig->desc.bConfigurationValue, 0,
5789 NULL, 0, USB_CTRL_SET_TIMEOUT);
5792 "can't restore configuration #%d (error=%d)\n",
5793 udev->actconfig->desc.bConfigurationValue, ret);
5794 mutex_unlock(hcd->bandwidth_mutex);
5797 mutex_unlock(hcd->bandwidth_mutex);
5798 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5800 /* Put interfaces back into the same altsettings as before.
5801 * Don't bother to send the Set-Interface request for interfaces
5802 * that were already in altsetting 0; besides being unnecessary,
5803 * many devices can't handle it. Instead just reset the host-side
5806 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5807 struct usb_host_config *config = udev->actconfig;
5808 struct usb_interface *intf = config->interface[i];
5809 struct usb_interface_descriptor *desc;
5811 desc = &intf->cur_altsetting->desc;
5812 if (desc->bAlternateSetting == 0) {
5813 usb_disable_interface(udev, intf, true);
5814 usb_enable_interface(udev, intf, true);
5817 /* Let the bandwidth allocation function know that this
5818 * device has been reset, and it will have to use
5819 * alternate setting 0 as the current alternate setting.
5821 intf->resetting_device = 1;
5822 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5823 desc->bAlternateSetting);
5824 intf->resetting_device = 0;
5827 dev_err(&udev->dev, "failed to restore interface %d "
5828 "altsetting %d (error=%d)\n",
5829 desc->bInterfaceNumber,
5830 desc->bAlternateSetting,
5834 /* Resetting also frees any allocated streams */
5835 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5836 intf->cur_altsetting->endpoint[j].streams = 0;
5840 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5841 usb_enable_usb2_hardware_lpm(udev);
5842 usb_unlocked_enable_lpm(udev);
5843 usb_enable_ltm(udev);
5844 usb_release_bos_descriptor(udev);
5849 usb_release_bos_descriptor(udev);
5851 re_enumerate_no_bos:
5852 /* LPM state doesn't matter when we're about to destroy the device. */
5853 hub_port_logical_disconnect(parent_hub, port1);
5858 * usb_reset_device - warn interface drivers and perform a USB port reset
5859 * @udev: device to reset (not in NOTATTACHED state)
5861 * Warns all drivers bound to registered interfaces (using their pre_reset
5862 * method), performs the port reset, and then lets the drivers know that
5863 * the reset is over (using their post_reset method).
5865 * Return: The same as for usb_reset_and_verify_device().
5866 * However, if a reset is already in progress (for instance, if a
5867 * driver doesn't have pre_reset() or post_reset() callbacks, and while
5868 * being unbound or re-bound during the ongoing reset its disconnect()
5869 * or probe() routine tries to perform a second, nested reset), the
5870 * routine returns -EINPROGRESS.
5873 * The caller must own the device lock. For example, it's safe to use
5874 * this from a driver probe() routine after downloading new firmware.
5875 * For calls that might not occur during probe(), drivers should lock
5876 * the device using usb_lock_device_for_reset().
5878 * If an interface is currently being probed or disconnected, we assume
5879 * its driver knows how to handle resets. For all other interfaces,
5880 * if the driver doesn't have pre_reset and post_reset methods then
5881 * we attempt to unbind it and rebind afterward.
5883 int usb_reset_device(struct usb_device *udev)
5887 unsigned int noio_flag;
5888 struct usb_port *port_dev;
5889 struct usb_host_config *config = udev->actconfig;
5890 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
5892 if (udev->state == USB_STATE_NOTATTACHED) {
5893 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5898 if (!udev->parent) {
5899 /* this requires hcd-specific logic; see ohci_restart() */
5900 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5904 if (udev->reset_in_progress)
5905 return -EINPROGRESS;
5906 udev->reset_in_progress = 1;
5908 port_dev = hub->ports[udev->portnum - 1];
5911 * Don't allocate memory with GFP_KERNEL in current
5912 * context to avoid possible deadlock if usb mass
5913 * storage interface or usbnet interface(iSCSI case)
5914 * is included in current configuration. The easist
5915 * approach is to do it for every device reset,
5916 * because the device 'memalloc_noio' flag may have
5917 * not been set before reseting the usb device.
5919 noio_flag = memalloc_noio_save();
5921 /* Prevent autosuspend during the reset */
5922 usb_autoresume_device(udev);
5925 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5926 struct usb_interface *cintf = config->interface[i];
5927 struct usb_driver *drv;
5930 if (cintf->dev.driver) {
5931 drv = to_usb_driver(cintf->dev.driver);
5932 if (drv->pre_reset && drv->post_reset)
5933 unbind = (drv->pre_reset)(cintf);
5934 else if (cintf->condition ==
5935 USB_INTERFACE_BOUND)
5938 usb_forced_unbind_intf(cintf);
5943 usb_lock_port(port_dev);
5944 ret = usb_reset_and_verify_device(udev);
5945 usb_unlock_port(port_dev);
5948 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5949 struct usb_interface *cintf = config->interface[i];
5950 struct usb_driver *drv;
5951 int rebind = cintf->needs_binding;
5953 if (!rebind && cintf->dev.driver) {
5954 drv = to_usb_driver(cintf->dev.driver);
5955 if (drv->post_reset)
5956 rebind = (drv->post_reset)(cintf);
5957 else if (cintf->condition ==
5958 USB_INTERFACE_BOUND)
5961 cintf->needs_binding = 1;
5965 /* If the reset failed, hub_wq will unbind drivers later */
5967 usb_unbind_and_rebind_marked_interfaces(udev);
5970 usb_autosuspend_device(udev);
5971 memalloc_noio_restore(noio_flag);
5972 udev->reset_in_progress = 0;
5975 EXPORT_SYMBOL_GPL(usb_reset_device);
5979 * usb_queue_reset_device - Reset a USB device from an atomic context
5980 * @iface: USB interface belonging to the device to reset
5982 * This function can be used to reset a USB device from an atomic
5983 * context, where usb_reset_device() won't work (as it blocks).
5985 * Doing a reset via this method is functionally equivalent to calling
5986 * usb_reset_device(), except for the fact that it is delayed to a
5987 * workqueue. This means that any drivers bound to other interfaces
5988 * might be unbound, as well as users from usbfs in user space.
5992 * - Scheduling two resets at the same time from two different drivers
5993 * attached to two different interfaces of the same device is
5994 * possible; depending on how the driver attached to each interface
5995 * handles ->pre_reset(), the second reset might happen or not.
5997 * - If the reset is delayed so long that the interface is unbound from
5998 * its driver, the reset will be skipped.
6000 * - This function can be called during .probe(). It can also be called
6001 * during .disconnect(), but doing so is pointless because the reset
6002 * will not occur. If you really want to reset the device during
6003 * .disconnect(), call usb_reset_device() directly -- but watch out
6004 * for nested unbinding issues!
6006 void usb_queue_reset_device(struct usb_interface *iface)
6008 if (schedule_work(&iface->reset_ws))
6009 usb_get_intf(iface);
6011 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6014 * usb_hub_find_child - Get the pointer of child device
6015 * attached to the port which is specified by @port1.
6016 * @hdev: USB device belonging to the usb hub
6017 * @port1: port num to indicate which port the child device
6020 * USB drivers call this function to get hub's child device
6023 * Return: %NULL if input param is invalid and
6024 * child's usb_device pointer if non-NULL.
6026 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6029 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6031 if (port1 < 1 || port1 > hdev->maxchild)
6033 return hub->ports[port1 - 1]->child;
6035 EXPORT_SYMBOL_GPL(usb_hub_find_child);
6037 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6038 struct usb_hub_descriptor *desc)
6040 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6041 enum usb_port_connect_type connect_type;
6047 if (!hub_is_superspeed(hdev)) {
6048 for (i = 1; i <= hdev->maxchild; i++) {
6049 struct usb_port *port_dev = hub->ports[i - 1];
6051 connect_type = port_dev->connect_type;
6052 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6053 u8 mask = 1 << (i%8);
6055 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6056 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6057 desc->u.hs.DeviceRemovable[i/8] |= mask;
6062 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6064 for (i = 1; i <= hdev->maxchild; i++) {
6065 struct usb_port *port_dev = hub->ports[i - 1];
6067 connect_type = port_dev->connect_type;
6068 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6071 if (!(port_removable & mask)) {
6072 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6073 port_removable |= mask;
6078 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6084 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6085 * @hdev: USB device belonging to the usb hub
6086 * @port1: port num of the port
6088 * Return: Port's acpi handle if successful, %NULL if params are
6091 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6094 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6099 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);