4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
37 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
39 static inline int hub_is_superspeed(struct usb_device *hdev)
41 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
44 /* Protect struct usb_device->state and ->children members
45 * Note: Both are also protected by ->dev.sem, except that ->state can
46 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
47 static DEFINE_SPINLOCK(device_state_lock);
49 /* khubd's worklist and its lock */
50 static DEFINE_SPINLOCK(hub_event_lock);
51 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
54 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
56 static struct task_struct *khubd_task;
58 /* cycle leds on hubs that aren't blinking for attention */
59 static bool blinkenlights = 0;
60 module_param (blinkenlights, bool, S_IRUGO);
61 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
64 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
65 * 10 seconds to send reply for the initial 64-byte descriptor request.
67 /* define initial 64-byte descriptor request timeout in milliseconds */
68 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
69 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
70 MODULE_PARM_DESC(initial_descriptor_timeout,
71 "initial 64-byte descriptor request timeout in milliseconds "
72 "(default 5000 - 5.0 seconds)");
75 * As of 2.6.10 we introduce a new USB device initialization scheme which
76 * closely resembles the way Windows works. Hopefully it will be compatible
77 * with a wider range of devices than the old scheme. However some previously
78 * working devices may start giving rise to "device not accepting address"
79 * errors; if that happens the user can try the old scheme by adjusting the
80 * following module parameters.
82 * For maximum flexibility there are two boolean parameters to control the
83 * hub driver's behavior. On the first initialization attempt, if the
84 * "old_scheme_first" parameter is set then the old scheme will be used,
85 * otherwise the new scheme is used. If that fails and "use_both_schemes"
86 * is set, then the driver will make another attempt, using the other scheme.
88 static bool old_scheme_first = 0;
89 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
90 MODULE_PARM_DESC(old_scheme_first,
91 "start with the old device initialization scheme");
93 static bool use_both_schemes = 1;
94 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
95 MODULE_PARM_DESC(use_both_schemes,
96 "try the other device initialization scheme if the "
99 /* Mutual exclusion for EHCI CF initialization. This interferes with
100 * port reset on some companion controllers.
102 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
103 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
105 #define HUB_DEBOUNCE_TIMEOUT 2000
106 #define HUB_DEBOUNCE_STEP 25
107 #define HUB_DEBOUNCE_STABLE 100
109 static int usb_reset_and_verify_device(struct usb_device *udev);
111 static inline char *portspeed(struct usb_hub *hub, int portstatus)
113 if (hub_is_superspeed(hub->hdev))
115 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
117 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
123 /* Note that hdev or one of its children must be locked! */
124 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
126 if (!hdev || !hdev->actconfig || !hdev->maxchild)
128 return usb_get_intfdata(hdev->actconfig->interface[0]);
131 static int usb_device_supports_lpm(struct usb_device *udev)
133 /* USB 2.1 (and greater) devices indicate LPM support through
134 * their USB 2.0 Extended Capabilities BOS descriptor.
136 if (udev->speed == USB_SPEED_HIGH) {
137 if (udev->bos->ext_cap &&
139 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
144 /* All USB 3.0 must support LPM, but we need their max exit latency
145 * information from the SuperSpeed Extended Capabilities BOS descriptor.
147 if (!udev->bos->ss_cap) {
148 dev_warn(&udev->dev, "No LPM exit latency info found. "
149 "Power management will be impacted.\n");
152 if (udev->parent->lpm_capable)
155 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
156 "Power management will be impacted.\n");
161 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
164 static void usb_set_lpm_mel(struct usb_device *udev,
165 struct usb3_lpm_parameters *udev_lpm_params,
166 unsigned int udev_exit_latency,
168 struct usb3_lpm_parameters *hub_lpm_params,
169 unsigned int hub_exit_latency)
171 unsigned int total_mel;
172 unsigned int device_mel;
173 unsigned int hub_mel;
176 * Calculate the time it takes to transition all links from the roothub
177 * to the parent hub into U0. The parent hub must then decode the
178 * packet (hub header decode latency) to figure out which port it was
181 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
182 * means 0.1us). Multiply that by 100 to get nanoseconds.
184 total_mel = hub_lpm_params->mel +
185 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
188 * How long will it take to transition the downstream hub's port into
189 * U0? The greater of either the hub exit latency or the device exit
192 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
193 * Multiply that by 1000 to get nanoseconds.
195 device_mel = udev_exit_latency * 1000;
196 hub_mel = hub_exit_latency * 1000;
197 if (device_mel > hub_mel)
198 total_mel += device_mel;
200 total_mel += hub_mel;
202 udev_lpm_params->mel = total_mel;
206 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
207 * a transition from either U1 or U2.
209 static void usb_set_lpm_pel(struct usb_device *udev,
210 struct usb3_lpm_parameters *udev_lpm_params,
211 unsigned int udev_exit_latency,
213 struct usb3_lpm_parameters *hub_lpm_params,
214 unsigned int hub_exit_latency,
215 unsigned int port_to_port_exit_latency)
217 unsigned int first_link_pel;
218 unsigned int hub_pel;
221 * First, the device sends an LFPS to transition the link between the
222 * device and the parent hub into U0. The exit latency is the bigger of
223 * the device exit latency or the hub exit latency.
225 if (udev_exit_latency > hub_exit_latency)
226 first_link_pel = udev_exit_latency * 1000;
228 first_link_pel = hub_exit_latency * 1000;
231 * When the hub starts to receive the LFPS, there is a slight delay for
232 * it to figure out that one of the ports is sending an LFPS. Then it
233 * will forward the LFPS to its upstream link. The exit latency is the
234 * delay, plus the PEL that we calculated for this hub.
236 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
239 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
240 * is the greater of the two exit latencies.
242 if (first_link_pel > hub_pel)
243 udev_lpm_params->pel = first_link_pel;
245 udev_lpm_params->pel = hub_pel;
249 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
250 * when a device initiates a transition to U0, until when it will receive the
251 * first packet from the host controller.
253 * Section C.1.5.1 describes the four components to this:
255 * - t2: time for the ERDY to make it from the device to the host.
256 * - t3: a host-specific delay to process the ERDY.
257 * - t4: time for the packet to make it from the host to the device.
259 * t3 is specific to both the xHCI host and the platform the host is integrated
260 * into. The Intel HW folks have said it's negligible, FIXME if a different
261 * vendor says otherwise.
263 static void usb_set_lpm_sel(struct usb_device *udev,
264 struct usb3_lpm_parameters *udev_lpm_params)
266 struct usb_device *parent;
267 unsigned int num_hubs;
268 unsigned int total_sel;
270 /* t1 = device PEL */
271 total_sel = udev_lpm_params->pel;
272 /* How many external hubs are in between the device & the root port. */
273 for (parent = udev->parent, num_hubs = 0; parent->parent;
274 parent = parent->parent)
276 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
278 total_sel += 2100 + 250 * (num_hubs - 1);
280 /* t4 = 250ns * num_hubs */
281 total_sel += 250 * num_hubs;
283 udev_lpm_params->sel = total_sel;
286 static void usb_set_lpm_parameters(struct usb_device *udev)
289 unsigned int port_to_port_delay;
290 unsigned int udev_u1_del;
291 unsigned int udev_u2_del;
292 unsigned int hub_u1_del;
293 unsigned int hub_u2_del;
295 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
298 hub = usb_hub_to_struct_hub(udev->parent);
299 /* It doesn't take time to transition the roothub into U0, since it
300 * doesn't have an upstream link.
305 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
306 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
307 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
308 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
310 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
311 hub, &udev->parent->u1_params, hub_u1_del);
313 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
314 hub, &udev->parent->u2_params, hub_u2_del);
317 * Appendix C, section C.2.2.2, says that there is a slight delay from
318 * when the parent hub notices the downstream port is trying to
319 * transition to U0 to when the hub initiates a U0 transition on its
320 * upstream port. The section says the delays are tPort2PortU1EL and
321 * tPort2PortU2EL, but it doesn't define what they are.
323 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
324 * about the same delays. Use the maximum delay calculations from those
325 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
326 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
327 * assume the device exit latencies they are talking about are the hub
330 * What do we do if the U2 exit latency is less than the U1 exit
331 * latency? It's possible, although not likely...
333 port_to_port_delay = 1;
335 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
336 hub, &udev->parent->u1_params, hub_u1_del,
339 if (hub_u2_del > hub_u1_del)
340 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
342 port_to_port_delay = 1 + hub_u1_del;
344 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
345 hub, &udev->parent->u2_params, hub_u2_del,
348 /* Now that we've got PEL, calculate SEL. */
349 usb_set_lpm_sel(udev, &udev->u1_params);
350 usb_set_lpm_sel(udev, &udev->u2_params);
353 /* USB 2.0 spec Section 11.24.4.5 */
354 static int get_hub_descriptor(struct usb_device *hdev, void *data)
359 if (hub_is_superspeed(hdev)) {
360 dtype = USB_DT_SS_HUB;
361 size = USB_DT_SS_HUB_SIZE;
364 size = sizeof(struct usb_hub_descriptor);
367 for (i = 0; i < 3; i++) {
368 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
369 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
370 dtype << 8, 0, data, size,
371 USB_CTRL_GET_TIMEOUT);
372 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
379 * USB 2.0 spec Section 11.24.2.1
381 static int clear_hub_feature(struct usb_device *hdev, int feature)
383 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
384 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
388 * USB 2.0 spec Section 11.24.2.2
390 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
392 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
393 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
398 * USB 2.0 spec Section 11.24.2.13
400 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
402 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
403 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
408 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
409 * for info about using port indicators
411 static void set_port_led(
417 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
418 USB_PORT_FEAT_INDICATOR);
420 dev_dbg (hub->intfdev,
421 "port %d indicator %s status %d\n",
423 ({ char *s; switch (selector) {
424 case HUB_LED_AMBER: s = "amber"; break;
425 case HUB_LED_GREEN: s = "green"; break;
426 case HUB_LED_OFF: s = "off"; break;
427 case HUB_LED_AUTO: s = "auto"; break;
428 default: s = "??"; break;
433 #define LED_CYCLE_PERIOD ((2*HZ)/3)
435 static void led_work (struct work_struct *work)
437 struct usb_hub *hub =
438 container_of(work, struct usb_hub, leds.work);
439 struct usb_device *hdev = hub->hdev;
441 unsigned changed = 0;
444 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
447 for (i = 0; i < hdev->maxchild; i++) {
448 unsigned selector, mode;
450 /* 30%-50% duty cycle */
452 switch (hub->indicator[i]) {
454 case INDICATOR_CYCLE:
456 selector = HUB_LED_AUTO;
457 mode = INDICATOR_AUTO;
459 /* blinking green = sw attention */
460 case INDICATOR_GREEN_BLINK:
461 selector = HUB_LED_GREEN;
462 mode = INDICATOR_GREEN_BLINK_OFF;
464 case INDICATOR_GREEN_BLINK_OFF:
465 selector = HUB_LED_OFF;
466 mode = INDICATOR_GREEN_BLINK;
468 /* blinking amber = hw attention */
469 case INDICATOR_AMBER_BLINK:
470 selector = HUB_LED_AMBER;
471 mode = INDICATOR_AMBER_BLINK_OFF;
473 case INDICATOR_AMBER_BLINK_OFF:
474 selector = HUB_LED_OFF;
475 mode = INDICATOR_AMBER_BLINK;
477 /* blink green/amber = reserved */
478 case INDICATOR_ALT_BLINK:
479 selector = HUB_LED_GREEN;
480 mode = INDICATOR_ALT_BLINK_OFF;
482 case INDICATOR_ALT_BLINK_OFF:
483 selector = HUB_LED_AMBER;
484 mode = INDICATOR_ALT_BLINK;
489 if (selector != HUB_LED_AUTO)
491 set_port_led(hub, i + 1, selector);
492 hub->indicator[i] = mode;
494 if (!changed && blinkenlights) {
496 cursor %= hdev->maxchild;
497 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
498 hub->indicator[cursor] = INDICATOR_CYCLE;
502 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
505 /* use a short timeout for hub/port status fetches */
506 #define USB_STS_TIMEOUT 1000
507 #define USB_STS_RETRIES 5
510 * USB 2.0 spec Section 11.24.2.6
512 static int get_hub_status(struct usb_device *hdev,
513 struct usb_hub_status *data)
515 int i, status = -ETIMEDOUT;
517 for (i = 0; i < USB_STS_RETRIES &&
518 (status == -ETIMEDOUT || status == -EPIPE); i++) {
519 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
520 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
521 data, sizeof(*data), USB_STS_TIMEOUT);
527 * USB 2.0 spec Section 11.24.2.7
529 static int get_port_status(struct usb_device *hdev, int port1,
530 struct usb_port_status *data)
532 int i, status = -ETIMEDOUT;
534 for (i = 0; i < USB_STS_RETRIES &&
535 (status == -ETIMEDOUT || status == -EPIPE); i++) {
536 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
537 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
538 data, sizeof(*data), USB_STS_TIMEOUT);
543 static int hub_port_status(struct usb_hub *hub, int port1,
544 u16 *status, u16 *change)
548 mutex_lock(&hub->status_mutex);
549 ret = get_port_status(hub->hdev, port1, &hub->status->port);
552 dev_err(hub->intfdev,
553 "%s failed (err = %d)\n", __func__, ret);
557 *status = le16_to_cpu(hub->status->port.wPortStatus);
558 *change = le16_to_cpu(hub->status->port.wPortChange);
562 mutex_unlock(&hub->status_mutex);
566 static void kick_khubd(struct usb_hub *hub)
570 spin_lock_irqsave(&hub_event_lock, flags);
571 if (!hub->disconnected && list_empty(&hub->event_list)) {
572 list_add_tail(&hub->event_list, &hub_event_list);
574 /* Suppress autosuspend until khubd runs */
575 usb_autopm_get_interface_no_resume(
576 to_usb_interface(hub->intfdev));
577 wake_up(&khubd_wait);
579 spin_unlock_irqrestore(&hub_event_lock, flags);
582 void usb_kick_khubd(struct usb_device *hdev)
584 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
591 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
592 * Notification, which indicates it had initiated remote wakeup.
594 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
595 * device initiates resume, so the USB core will not receive notice of the
596 * resume through the normal hub interrupt URB.
598 void usb_wakeup_notification(struct usb_device *hdev,
599 unsigned int portnum)
606 hub = usb_hub_to_struct_hub(hdev);
608 set_bit(portnum, hub->wakeup_bits);
612 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
614 /* completion function, fires on port status changes and various faults */
615 static void hub_irq(struct urb *urb)
617 struct usb_hub *hub = urb->context;
618 int status = urb->status;
623 case -ENOENT: /* synchronous unlink */
624 case -ECONNRESET: /* async unlink */
625 case -ESHUTDOWN: /* hardware going away */
628 default: /* presumably an error */
629 /* Cause a hub reset after 10 consecutive errors */
630 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
631 if ((++hub->nerrors < 10) || hub->error)
636 /* let khubd handle things */
637 case 0: /* we got data: port status changed */
639 for (i = 0; i < urb->actual_length; ++i)
640 bits |= ((unsigned long) ((*hub->buffer)[i]))
642 hub->event_bits[0] = bits;
648 /* Something happened, let khubd figure it out */
655 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
656 && status != -ENODEV && status != -EPERM)
657 dev_err (hub->intfdev, "resubmit --> %d\n", status);
660 /* USB 2.0 spec Section 11.24.2.3 */
662 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
664 /* Need to clear both directions for control ep */
665 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
666 USB_ENDPOINT_XFER_CONTROL) {
667 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
668 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
669 devinfo ^ 0x8000, tt, NULL, 0, 1000);
673 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
674 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
679 * enumeration blocks khubd for a long time. we use keventd instead, since
680 * long blocking there is the exception, not the rule. accordingly, HCDs
681 * talking to TTs must queue control transfers (not just bulk and iso), so
682 * both can talk to the same hub concurrently.
684 static void hub_tt_work(struct work_struct *work)
686 struct usb_hub *hub =
687 container_of(work, struct usb_hub, tt.clear_work);
690 spin_lock_irqsave (&hub->tt.lock, flags);
691 while (!list_empty(&hub->tt.clear_list)) {
692 struct list_head *next;
693 struct usb_tt_clear *clear;
694 struct usb_device *hdev = hub->hdev;
695 const struct hc_driver *drv;
698 next = hub->tt.clear_list.next;
699 clear = list_entry (next, struct usb_tt_clear, clear_list);
700 list_del (&clear->clear_list);
702 /* drop lock so HCD can concurrently report other TT errors */
703 spin_unlock_irqrestore (&hub->tt.lock, flags);
704 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
705 if (status && status != -ENODEV)
707 "clear tt %d (%04x) error %d\n",
708 clear->tt, clear->devinfo, status);
710 /* Tell the HCD, even if the operation failed */
711 drv = clear->hcd->driver;
712 if (drv->clear_tt_buffer_complete)
713 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
716 spin_lock_irqsave(&hub->tt.lock, flags);
718 spin_unlock_irqrestore (&hub->tt.lock, flags);
722 * usb_hub_set_port_power - control hub port's power state
723 * @hdev: USB device belonging to the usb hub
726 * @set: expected status
728 * call this function to control port's power via setting or
729 * clearing the port's PORT_POWER feature.
731 * Return: 0 if successful. A negative error code otherwise.
733 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
737 struct usb_port *port_dev = hub->ports[port1 - 1];
740 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
742 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
745 port_dev->power_is_on = set;
750 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
751 * @urb: an URB associated with the failed or incomplete split transaction
753 * High speed HCDs use this to tell the hub driver that some split control or
754 * bulk transaction failed in a way that requires clearing internal state of
755 * a transaction translator. This is normally detected (and reported) from
758 * It may not be possible for that hub to handle additional full (or low)
759 * speed transactions until that state is fully cleared out.
761 * Return: 0 if successful. A negative error code otherwise.
763 int usb_hub_clear_tt_buffer(struct urb *urb)
765 struct usb_device *udev = urb->dev;
766 int pipe = urb->pipe;
767 struct usb_tt *tt = udev->tt;
769 struct usb_tt_clear *clear;
771 /* we've got to cope with an arbitrary number of pending TT clears,
772 * since each TT has "at least two" buffers that can need it (and
773 * there can be many TTs per hub). even if they're uncommon.
775 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
776 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
777 /* FIXME recover somehow ... RESET_TT? */
781 /* info that CLEAR_TT_BUFFER needs */
782 clear->tt = tt->multi ? udev->ttport : 1;
783 clear->devinfo = usb_pipeendpoint (pipe);
784 clear->devinfo |= udev->devnum << 4;
785 clear->devinfo |= usb_pipecontrol (pipe)
786 ? (USB_ENDPOINT_XFER_CONTROL << 11)
787 : (USB_ENDPOINT_XFER_BULK << 11);
788 if (usb_pipein (pipe))
789 clear->devinfo |= 1 << 15;
791 /* info for completion callback */
792 clear->hcd = bus_to_hcd(udev->bus);
795 /* tell keventd to clear state for this TT */
796 spin_lock_irqsave (&tt->lock, flags);
797 list_add_tail (&clear->clear_list, &tt->clear_list);
798 schedule_work(&tt->clear_work);
799 spin_unlock_irqrestore (&tt->lock, flags);
802 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
804 /* If do_delay is false, return the number of milliseconds the caller
807 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
810 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
813 /* Enable power on each port. Some hubs have reserved values
814 * of LPSM (> 2) in their descriptors, even though they are
815 * USB 2.0 hubs. Some hubs do not implement port-power switching
816 * but only emulate it. In all cases, the ports won't work
817 * unless we send these messages to the hub.
819 if (hub_is_port_power_switchable(hub))
820 dev_dbg(hub->intfdev, "enabling power on all ports\n");
822 dev_dbg(hub->intfdev, "trying to enable port power on "
823 "non-switchable hub\n");
824 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
825 if (hub->ports[port1 - 1]->power_is_on)
826 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
828 usb_clear_port_feature(hub->hdev, port1,
829 USB_PORT_FEAT_POWER);
831 /* Wait at least 100 msec for power to become stable */
832 delay = max(pgood_delay, (unsigned) 100);
838 static int hub_hub_status(struct usb_hub *hub,
839 u16 *status, u16 *change)
843 mutex_lock(&hub->status_mutex);
844 ret = get_hub_status(hub->hdev, &hub->status->hub);
847 dev_err(hub->intfdev,
848 "%s failed (err = %d)\n", __func__, ret);
850 *status = le16_to_cpu(hub->status->hub.wHubStatus);
851 *change = le16_to_cpu(hub->status->hub.wHubChange);
854 mutex_unlock(&hub->status_mutex);
858 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
859 unsigned int link_status)
861 return set_port_feature(hub->hdev,
862 port1 | (link_status << 3),
863 USB_PORT_FEAT_LINK_STATE);
867 * If USB 3.0 ports are placed into the Disabled state, they will no longer
868 * detect any device connects or disconnects. This is generally not what the
869 * USB core wants, since it expects a disabled port to produce a port status
870 * change event when a new device connects.
872 * Instead, set the link state to Disabled, wait for the link to settle into
873 * that state, clear any change bits, and then put the port into the RxDetect
876 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
880 u16 portchange, portstatus;
882 if (!hub_is_superspeed(hub->hdev))
885 ret = hub_port_status(hub, port1, &portstatus, &portchange);
890 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
891 * Controller [1022:7814] will have spurious result making the following
892 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
893 * as high-speed device if we set the usb 3.0 port link state to
894 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
895 * check the state here to avoid the bug.
897 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
898 USB_SS_PORT_LS_RX_DETECT) {
899 dev_dbg(&hub->ports[port1 - 1]->dev,
900 "Not disabling port; link state is RxDetect\n");
904 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
908 /* Wait for the link to enter the disabled state. */
909 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
910 ret = hub_port_status(hub, port1, &portstatus, &portchange);
914 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
915 USB_SS_PORT_LS_SS_DISABLED)
917 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
919 msleep(HUB_DEBOUNCE_STEP);
921 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
922 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
925 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
928 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
930 struct usb_device *hdev = hub->hdev;
933 if (hub->ports[port1 - 1]->child && set_state)
934 usb_set_device_state(hub->ports[port1 - 1]->child,
935 USB_STATE_NOTATTACHED);
937 if (hub_is_superspeed(hub->hdev))
938 ret = hub_usb3_port_disable(hub, port1);
940 ret = usb_clear_port_feature(hdev, port1,
941 USB_PORT_FEAT_ENABLE);
943 if (ret && ret != -ENODEV)
944 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
950 * Disable a port and mark a logical connect-change event, so that some
951 * time later khubd will disconnect() any existing usb_device on the port
952 * and will re-enumerate if there actually is a device attached.
954 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
956 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
957 hub_port_disable(hub, port1, 1);
959 /* FIXME let caller ask to power down the port:
960 * - some devices won't enumerate without a VBUS power cycle
961 * - SRP saves power that way
962 * - ... new call, TBD ...
963 * That's easy if this hub can switch power per-port, and
964 * khubd reactivates the port later (timer, SRP, etc).
965 * Powerdown must be optional, because of reset/DFU.
968 set_bit(port1, hub->change_bits);
973 * usb_remove_device - disable a device's port on its parent hub
974 * @udev: device to be disabled and removed
975 * Context: @udev locked, must be able to sleep.
977 * After @udev's port has been disabled, khubd is notified and it will
978 * see that the device has been disconnected. When the device is
979 * physically unplugged and something is plugged in, the events will
980 * be received and processed normally.
982 * Return: 0 if successful. A negative error code otherwise.
984 int usb_remove_device(struct usb_device *udev)
987 struct usb_interface *intf;
989 if (!udev->parent) /* Can't remove a root hub */
991 hub = usb_hub_to_struct_hub(udev->parent);
992 intf = to_usb_interface(hub->intfdev);
994 usb_autopm_get_interface(intf);
995 set_bit(udev->portnum, hub->removed_bits);
996 hub_port_logical_disconnect(hub, udev->portnum);
997 usb_autopm_put_interface(intf);
1001 enum hub_activation_type {
1002 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1003 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1006 static void hub_init_func2(struct work_struct *ws);
1007 static void hub_init_func3(struct work_struct *ws);
1009 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1011 struct usb_device *hdev = hub->hdev;
1012 struct usb_hcd *hcd;
1016 bool need_debounce_delay = false;
1019 /* Continue a partial initialization */
1020 if (type == HUB_INIT2)
1022 if (type == HUB_INIT3)
1025 /* The superspeed hub except for root hub has to use Hub Depth
1026 * value as an offset into the route string to locate the bits
1027 * it uses to determine the downstream port number. So hub driver
1028 * should send a set hub depth request to superspeed hub after
1029 * the superspeed hub is set configuration in initialization or
1032 * After a resume, port power should still be on.
1033 * For any other type of activation, turn it on.
1035 if (type != HUB_RESUME) {
1036 if (hdev->parent && hub_is_superspeed(hdev)) {
1037 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1038 HUB_SET_DEPTH, USB_RT_HUB,
1039 hdev->level - 1, 0, NULL, 0,
1040 USB_CTRL_SET_TIMEOUT);
1042 dev_err(hub->intfdev,
1043 "set hub depth failed\n");
1046 /* Speed up system boot by using a delayed_work for the
1047 * hub's initial power-up delays. This is pretty awkward
1048 * and the implementation looks like a home-brewed sort of
1049 * setjmp/longjmp, but it saves at least 100 ms for each
1050 * root hub (assuming usbcore is compiled into the kernel
1051 * rather than as a module). It adds up.
1053 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1054 * because for those activation types the ports have to be
1055 * operational when we return. In theory this could be done
1056 * for HUB_POST_RESET, but it's easier not to.
1058 if (type == HUB_INIT) {
1059 delay = hub_power_on(hub, false);
1060 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1061 schedule_delayed_work(&hub->init_work,
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, "Host not "
1079 "accepting hub info "
1081 dev_err(hub->intfdev, "LS/FS devices "
1082 "and hubs may not work "
1083 "under this hub\n.");
1086 hub_power_on(hub, true);
1088 hub_power_on(hub, true);
1093 /* Check each port and set hub->change_bits to let khubd know
1094 * which ports need attention.
1096 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1097 struct usb_device *udev = hub->ports[port1 - 1]->child;
1098 u16 portstatus, portchange;
1100 portstatus = portchange = 0;
1101 status = hub_port_status(hub, port1, &portstatus, &portchange);
1102 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1103 dev_dbg(hub->intfdev,
1104 "port %d: status %04x change %04x\n",
1105 port1, portstatus, portchange);
1107 /* After anything other than HUB_RESUME (i.e., initialization
1108 * or any sort of reset), every port should be disabled.
1109 * Unconnected ports should likewise be disabled (paranoia),
1110 * and so should ports for which we have no usb_device.
1112 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1113 type != HUB_RESUME ||
1114 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1116 udev->state == USB_STATE_NOTATTACHED)) {
1118 * USB3 protocol ports will automatically transition
1119 * to Enabled state when detect an USB3.0 device attach.
1120 * Do not disable USB3 protocol ports, just pretend
1123 portstatus &= ~USB_PORT_STAT_ENABLE;
1124 if (!hub_is_superspeed(hdev))
1125 usb_clear_port_feature(hdev, port1,
1126 USB_PORT_FEAT_ENABLE);
1129 /* Clear status-change flags; we'll debounce later */
1130 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1131 need_debounce_delay = true;
1132 usb_clear_port_feature(hub->hdev, port1,
1133 USB_PORT_FEAT_C_CONNECTION);
1135 if (portchange & USB_PORT_STAT_C_ENABLE) {
1136 need_debounce_delay = true;
1137 usb_clear_port_feature(hub->hdev, port1,
1138 USB_PORT_FEAT_C_ENABLE);
1140 if (portchange & USB_PORT_STAT_C_RESET) {
1141 need_debounce_delay = true;
1142 usb_clear_port_feature(hub->hdev, port1,
1143 USB_PORT_FEAT_C_RESET);
1145 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1146 hub_is_superspeed(hub->hdev)) {
1147 need_debounce_delay = true;
1148 usb_clear_port_feature(hub->hdev, port1,
1149 USB_PORT_FEAT_C_BH_PORT_RESET);
1151 /* We can forget about a "removed" device when there's a
1152 * physical disconnect or the connect status changes.
1154 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1155 (portchange & USB_PORT_STAT_C_CONNECTION))
1156 clear_bit(port1, hub->removed_bits);
1158 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1159 /* Tell khubd to disconnect the device or
1160 * check for a new connection
1162 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1163 (portstatus & USB_PORT_STAT_OVERCURRENT))
1164 set_bit(port1, hub->change_bits);
1166 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1167 bool port_resumed = (portstatus &
1168 USB_PORT_STAT_LINK_STATE) ==
1170 /* The power session apparently survived the resume.
1171 * If there was an overcurrent or suspend change
1172 * (i.e., remote wakeup request), have khubd
1173 * take care of it. Look at the port link state
1174 * for USB 3.0 hubs, since they don't have a suspend
1175 * change bit, and they don't set the port link change
1176 * bit on device-initiated resume.
1178 if (portchange || (hub_is_superspeed(hub->hdev) &&
1180 set_bit(port1, hub->change_bits);
1182 } else if (udev->persist_enabled) {
1183 struct usb_port *port_dev = hub->ports[port1 - 1];
1186 udev->reset_resume = 1;
1188 /* Don't set the change_bits when the device
1191 if (port_dev->power_is_on)
1192 set_bit(port1, hub->change_bits);
1195 /* The power session is gone; tell khubd */
1196 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1197 set_bit(port1, hub->change_bits);
1201 /* If no port-status-change flags were set, we don't need any
1202 * debouncing. If flags were set we can try to debounce the
1203 * ports all at once right now, instead of letting khubd do them
1204 * one at a time later on.
1206 * If any port-status changes do occur during this delay, khubd
1207 * will see them later and handle them normally.
1209 if (need_debounce_delay) {
1210 delay = HUB_DEBOUNCE_STABLE;
1212 /* Don't do a long sleep inside a workqueue routine */
1213 if (type == HUB_INIT2) {
1214 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1215 schedule_delayed_work(&hub->init_work,
1216 msecs_to_jiffies(delay));
1217 return; /* Continues at init3: below */
1225 status = usb_submit_urb(hub->urb, GFP_NOIO);
1227 dev_err(hub->intfdev, "activate --> %d\n", status);
1228 if (hub->has_indicators && blinkenlights)
1229 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1231 /* Scan all ports that need attention */
1234 /* Allow autosuspend if it was suppressed */
1235 if (type <= HUB_INIT3)
1236 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1239 /* Implement the continuations for the delays above */
1240 static void hub_init_func2(struct work_struct *ws)
1242 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1244 hub_activate(hub, HUB_INIT2);
1247 static void hub_init_func3(struct work_struct *ws)
1249 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1251 hub_activate(hub, HUB_INIT3);
1254 enum hub_quiescing_type {
1255 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1258 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1260 struct usb_device *hdev = hub->hdev;
1263 cancel_delayed_work_sync(&hub->init_work);
1265 /* khubd and related activity won't re-trigger */
1268 if (type != HUB_SUSPEND) {
1269 /* Disconnect all the children */
1270 for (i = 0; i < hdev->maxchild; ++i) {
1271 if (hub->ports[i]->child)
1272 usb_disconnect(&hub->ports[i]->child);
1276 /* Stop khubd and related activity */
1277 usb_kill_urb(hub->urb);
1278 if (hub->has_indicators)
1279 cancel_delayed_work_sync(&hub->leds);
1281 flush_work(&hub->tt.clear_work);
1284 /* caller has locked the hub device */
1285 static int hub_pre_reset(struct usb_interface *intf)
1287 struct usb_hub *hub = usb_get_intfdata(intf);
1289 hub_quiesce(hub, HUB_PRE_RESET);
1293 /* caller has locked the hub device */
1294 static int hub_post_reset(struct usb_interface *intf)
1296 struct usb_hub *hub = usb_get_intfdata(intf);
1298 hub_activate(hub, HUB_POST_RESET);
1302 static int hub_configure(struct usb_hub *hub,
1303 struct usb_endpoint_descriptor *endpoint)
1305 struct usb_hcd *hcd;
1306 struct usb_device *hdev = hub->hdev;
1307 struct device *hub_dev = hub->intfdev;
1308 u16 hubstatus, hubchange;
1309 u16 wHubCharacteristics;
1312 char *message = "out of memory";
1316 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1322 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1327 mutex_init(&hub->status_mutex);
1329 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1330 if (!hub->descriptor) {
1335 /* Request the entire hub descriptor.
1336 * hub->descriptor can handle USB_MAXCHILDREN ports,
1337 * but the hub can/will return fewer bytes here.
1339 ret = get_hub_descriptor(hdev, hub->descriptor);
1341 message = "can't read hub descriptor";
1343 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1344 message = "hub has too many ports!";
1347 } else if (hub->descriptor->bNbrPorts == 0) {
1348 message = "hub doesn't have any ports!";
1353 hdev->maxchild = hub->descriptor->bNbrPorts;
1354 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1355 (hdev->maxchild == 1) ? "" : "s");
1357 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1364 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1365 if (hub_is_superspeed(hdev)) {
1373 /* FIXME for USB 3.0, skip for now */
1374 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1375 !(hub_is_superspeed(hdev))) {
1377 char portstr[USB_MAXCHILDREN + 1];
1379 for (i = 0; i < hdev->maxchild; i++)
1380 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1381 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1383 portstr[hdev->maxchild] = 0;
1384 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1386 dev_dbg(hub_dev, "standalone hub\n");
1388 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1389 case HUB_CHAR_COMMON_LPSM:
1390 dev_dbg(hub_dev, "ganged power switching\n");
1392 case HUB_CHAR_INDV_PORT_LPSM:
1393 dev_dbg(hub_dev, "individual port power switching\n");
1395 case HUB_CHAR_NO_LPSM:
1397 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1401 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1402 case HUB_CHAR_COMMON_OCPM:
1403 dev_dbg(hub_dev, "global over-current protection\n");
1405 case HUB_CHAR_INDV_PORT_OCPM:
1406 dev_dbg(hub_dev, "individual port over-current protection\n");
1408 case HUB_CHAR_NO_OCPM:
1410 dev_dbg(hub_dev, "no over-current protection\n");
1414 spin_lock_init (&hub->tt.lock);
1415 INIT_LIST_HEAD (&hub->tt.clear_list);
1416 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1417 switch (hdev->descriptor.bDeviceProtocol) {
1420 case USB_HUB_PR_HS_SINGLE_TT:
1421 dev_dbg(hub_dev, "Single TT\n");
1424 case USB_HUB_PR_HS_MULTI_TT:
1425 ret = usb_set_interface(hdev, 0, 1);
1427 dev_dbg(hub_dev, "TT per port\n");
1430 dev_err(hub_dev, "Using single TT (err %d)\n",
1435 /* USB 3.0 hubs don't have a TT */
1438 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1439 hdev->descriptor.bDeviceProtocol);
1443 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1444 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1445 case HUB_TTTT_8_BITS:
1446 if (hdev->descriptor.bDeviceProtocol != 0) {
1447 hub->tt.think_time = 666;
1448 dev_dbg(hub_dev, "TT requires at most %d "
1449 "FS bit times (%d ns)\n",
1450 8, hub->tt.think_time);
1453 case HUB_TTTT_16_BITS:
1454 hub->tt.think_time = 666 * 2;
1455 dev_dbg(hub_dev, "TT requires at most %d "
1456 "FS bit times (%d ns)\n",
1457 16, hub->tt.think_time);
1459 case HUB_TTTT_24_BITS:
1460 hub->tt.think_time = 666 * 3;
1461 dev_dbg(hub_dev, "TT requires at most %d "
1462 "FS bit times (%d ns)\n",
1463 24, hub->tt.think_time);
1465 case HUB_TTTT_32_BITS:
1466 hub->tt.think_time = 666 * 4;
1467 dev_dbg(hub_dev, "TT requires at most %d "
1468 "FS bit times (%d ns)\n",
1469 32, hub->tt.think_time);
1473 /* probe() zeroes hub->indicator[] */
1474 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1475 hub->has_indicators = 1;
1476 dev_dbg(hub_dev, "Port indicators are supported\n");
1479 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1480 hub->descriptor->bPwrOn2PwrGood * 2);
1482 /* power budgeting mostly matters with bus-powered hubs,
1483 * and battery-powered root hubs (may provide just 8 mA).
1485 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1487 message = "can't get hub status";
1490 hcd = bus_to_hcd(hdev->bus);
1491 if (hdev == hdev->bus->root_hub) {
1492 if (hcd->power_budget > 0)
1493 hdev->bus_mA = hcd->power_budget;
1495 hdev->bus_mA = full_load * hdev->maxchild;
1496 if (hdev->bus_mA >= full_load)
1497 hub->mA_per_port = full_load;
1499 hub->mA_per_port = hdev->bus_mA;
1500 hub->limited_power = 1;
1502 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1503 int remaining = hdev->bus_mA -
1504 hub->descriptor->bHubContrCurrent;
1506 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1507 hub->descriptor->bHubContrCurrent);
1508 hub->limited_power = 1;
1510 if (remaining < hdev->maxchild * unit_load)
1512 "insufficient power available "
1513 "to use all downstream ports\n");
1514 hub->mA_per_port = unit_load; /* 7.2.1 */
1516 } else { /* Self-powered external hub */
1517 /* FIXME: What about battery-powered external hubs that
1518 * provide less current per port? */
1519 hub->mA_per_port = full_load;
1521 if (hub->mA_per_port < full_load)
1522 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1525 /* Update the HCD's internal representation of this hub before khubd
1526 * starts getting port status changes for devices under the hub.
1528 if (hcd->driver->update_hub_device) {
1529 ret = hcd->driver->update_hub_device(hcd, hdev,
1530 &hub->tt, GFP_KERNEL);
1532 message = "can't update HCD hub info";
1537 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1539 message = "can't get hub status";
1543 /* local power status reports aren't always correct */
1544 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1545 dev_dbg(hub_dev, "local power source is %s\n",
1546 (hubstatus & HUB_STATUS_LOCAL_POWER)
1547 ? "lost (inactive)" : "good");
1549 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1550 dev_dbg(hub_dev, "%sover-current condition exists\n",
1551 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1553 /* set up the interrupt endpoint
1554 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1555 * bytes as USB2.0[11.12.3] says because some hubs are known
1556 * to send more data (and thus cause overflow). For root hubs,
1557 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1558 * to be big enough for at least USB_MAXCHILDREN ports. */
1559 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1560 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1562 if (maxp > sizeof(*hub->buffer))
1563 maxp = sizeof(*hub->buffer);
1565 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1571 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1572 hub, endpoint->bInterval);
1574 /* maybe cycle the hub leds */
1575 if (hub->has_indicators && blinkenlights)
1576 hub->indicator[0] = INDICATOR_CYCLE;
1578 for (i = 0; i < hdev->maxchild; i++) {
1579 ret = usb_hub_create_port_device(hub, i + 1);
1581 dev_err(hub->intfdev,
1582 "couldn't create port%d device.\n", i + 1);
1584 goto fail_keep_maxchild;
1588 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1590 hub_activate(hub, HUB_INIT);
1596 dev_err (hub_dev, "config failed, %s (err %d)\n",
1598 /* hub_disconnect() frees urb and descriptor */
1602 static void hub_release(struct kref *kref)
1604 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1606 usb_put_intf(to_usb_interface(hub->intfdev));
1610 static unsigned highspeed_hubs;
1612 static void hub_disconnect(struct usb_interface *intf)
1614 struct usb_hub *hub = usb_get_intfdata(intf);
1615 struct usb_device *hdev = interface_to_usbdev(intf);
1618 /* Take the hub off the event list and don't let it be added again */
1619 spin_lock_irq(&hub_event_lock);
1620 if (!list_empty(&hub->event_list)) {
1621 list_del_init(&hub->event_list);
1622 usb_autopm_put_interface_no_suspend(intf);
1624 hub->disconnected = 1;
1625 spin_unlock_irq(&hub_event_lock);
1627 /* Disconnect all children and quiesce the hub */
1629 hub_quiesce(hub, HUB_DISCONNECT);
1631 /* Avoid races with recursively_mark_NOTATTACHED() */
1632 spin_lock_irq(&device_state_lock);
1633 port1 = hdev->maxchild;
1635 usb_set_intfdata(intf, NULL);
1636 spin_unlock_irq(&device_state_lock);
1638 for (; port1 > 0; --port1)
1639 usb_hub_remove_port_device(hub, port1);
1641 if (hub->hdev->speed == USB_SPEED_HIGH)
1644 usb_free_urb(hub->urb);
1646 kfree(hub->descriptor);
1650 pm_suspend_ignore_children(&intf->dev, false);
1651 kref_put(&hub->kref, hub_release);
1654 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1656 struct usb_host_interface *desc;
1657 struct usb_endpoint_descriptor *endpoint;
1658 struct usb_device *hdev;
1659 struct usb_hub *hub;
1661 desc = intf->cur_altsetting;
1662 hdev = interface_to_usbdev(intf);
1665 * Set default autosuspend delay as 0 to speedup bus suspend,
1666 * based on the below considerations:
1668 * - Unlike other drivers, the hub driver does not rely on the
1669 * autosuspend delay to provide enough time to handle a wakeup
1670 * event, and the submitted status URB is just to check future
1671 * change on hub downstream ports, so it is safe to do it.
1673 * - The patch might cause one or more auto supend/resume for
1674 * below very rare devices when they are plugged into hub
1677 * devices having trouble initializing, and disconnect
1678 * themselves from the bus and then reconnect a second
1681 * devices just for downloading firmware, and disconnects
1682 * themselves after completing it
1684 * For these quite rare devices, their drivers may change the
1685 * autosuspend delay of their parent hub in the probe() to one
1686 * appropriate value to avoid the subtle problem if someone
1689 * - The patch may cause one or more auto suspend/resume on
1690 * hub during running 'lsusb', but it is probably too
1691 * infrequent to worry about.
1693 * - Change autosuspend delay of hub can avoid unnecessary auto
1694 * suspend timer for hub, also may decrease power consumption
1697 * - If user has indicated to prevent autosuspend by passing
1698 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1700 #ifdef CONFIG_PM_RUNTIME
1701 if (hdev->dev.power.autosuspend_delay >= 0)
1702 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1706 * Hubs have proper suspend/resume support, except for root hubs
1707 * where the controller driver doesn't have bus_suspend and
1708 * bus_resume methods.
1710 if (hdev->parent) { /* normal device */
1711 usb_enable_autosuspend(hdev);
1712 } else { /* root hub */
1713 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1715 if (drv->bus_suspend && drv->bus_resume)
1716 usb_enable_autosuspend(hdev);
1719 if (hdev->level == MAX_TOPO_LEVEL) {
1721 "Unsupported bus topology: hub nested too deep\n");
1725 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1727 dev_warn(&intf->dev, "ignoring external hub\n");
1732 /* Some hubs have a subclass of 1, which AFAICT according to the */
1733 /* specs is not defined, but it works */
1734 if ((desc->desc.bInterfaceSubClass != 0) &&
1735 (desc->desc.bInterfaceSubClass != 1)) {
1737 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1741 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1742 if (desc->desc.bNumEndpoints != 1)
1743 goto descriptor_error;
1745 endpoint = &desc->endpoint[0].desc;
1747 /* If it's not an interrupt in endpoint, we'd better punt! */
1748 if (!usb_endpoint_is_int_in(endpoint))
1749 goto descriptor_error;
1751 /* We found a hub */
1752 dev_info (&intf->dev, "USB hub found\n");
1754 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1756 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1760 kref_init(&hub->kref);
1761 INIT_LIST_HEAD(&hub->event_list);
1762 hub->intfdev = &intf->dev;
1764 INIT_DELAYED_WORK(&hub->leds, led_work);
1765 INIT_DELAYED_WORK(&hub->init_work, NULL);
1768 usb_set_intfdata (intf, hub);
1769 intf->needs_remote_wakeup = 1;
1770 pm_suspend_ignore_children(&intf->dev, true);
1772 if (hdev->speed == USB_SPEED_HIGH)
1775 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1776 hub->quirk_check_port_auto_suspend = 1;
1778 if (hub_configure(hub, endpoint) >= 0)
1781 hub_disconnect (intf);
1786 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1788 struct usb_device *hdev = interface_to_usbdev (intf);
1789 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1791 /* assert ifno == 0 (part of hub spec) */
1793 case USBDEVFS_HUB_PORTINFO: {
1794 struct usbdevfs_hub_portinfo *info = user_data;
1797 spin_lock_irq(&device_state_lock);
1798 if (hdev->devnum <= 0)
1801 info->nports = hdev->maxchild;
1802 for (i = 0; i < info->nports; i++) {
1803 if (hub->ports[i]->child == NULL)
1807 hub->ports[i]->child->devnum;
1810 spin_unlock_irq(&device_state_lock);
1812 return info->nports + 1;
1821 * Allow user programs to claim ports on a hub. When a device is attached
1822 * to one of these "claimed" ports, the program will "own" the device.
1824 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1825 struct dev_state ***ppowner)
1827 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1829 if (hdev->state == USB_STATE_NOTATTACHED)
1831 if (port1 == 0 || port1 > hdev->maxchild)
1834 /* Devices not managed by the hub driver
1835 * will always have maxchild equal to 0.
1837 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1841 /* In the following three functions, the caller must hold hdev's lock */
1842 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1843 struct dev_state *owner)
1846 struct dev_state **powner;
1848 rc = find_port_owner(hdev, port1, &powner);
1857 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1858 struct dev_state *owner)
1861 struct dev_state **powner;
1863 rc = find_port_owner(hdev, port1, &powner);
1866 if (*powner != owner)
1872 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1874 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1877 for (n = 0; n < hdev->maxchild; n++) {
1878 if (hub->ports[n]->port_owner == owner)
1879 hub->ports[n]->port_owner = NULL;
1884 /* The caller must hold udev's lock */
1885 bool usb_device_is_owned(struct usb_device *udev)
1887 struct usb_hub *hub;
1889 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1891 hub = usb_hub_to_struct_hub(udev->parent);
1892 return !!hub->ports[udev->portnum - 1]->port_owner;
1895 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1897 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1900 for (i = 0; i < udev->maxchild; ++i) {
1901 if (hub->ports[i]->child)
1902 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1904 if (udev->state == USB_STATE_SUSPENDED)
1905 udev->active_duration -= jiffies;
1906 udev->state = USB_STATE_NOTATTACHED;
1910 * usb_set_device_state - change a device's current state (usbcore, hcds)
1911 * @udev: pointer to device whose state should be changed
1912 * @new_state: new state value to be stored
1914 * udev->state is _not_ fully protected by the device lock. Although
1915 * most transitions are made only while holding the lock, the state can
1916 * can change to USB_STATE_NOTATTACHED at almost any time. This
1917 * is so that devices can be marked as disconnected as soon as possible,
1918 * without having to wait for any semaphores to be released. As a result,
1919 * all changes to any device's state must be protected by the
1920 * device_state_lock spinlock.
1922 * Once a device has been added to the device tree, all changes to its state
1923 * should be made using this routine. The state should _not_ be set directly.
1925 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1926 * Otherwise udev->state is set to new_state, and if new_state is
1927 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1928 * to USB_STATE_NOTATTACHED.
1930 void usb_set_device_state(struct usb_device *udev,
1931 enum usb_device_state new_state)
1933 unsigned long flags;
1936 spin_lock_irqsave(&device_state_lock, flags);
1937 if (udev->state == USB_STATE_NOTATTACHED)
1939 else if (new_state != USB_STATE_NOTATTACHED) {
1941 /* root hub wakeup capabilities are managed out-of-band
1942 * and may involve silicon errata ... ignore them here.
1945 if (udev->state == USB_STATE_SUSPENDED
1946 || new_state == USB_STATE_SUSPENDED)
1947 ; /* No change to wakeup settings */
1948 else if (new_state == USB_STATE_CONFIGURED)
1949 wakeup = (udev->quirks &
1950 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1951 udev->actconfig->desc.bmAttributes &
1952 USB_CONFIG_ATT_WAKEUP;
1956 if (udev->state == USB_STATE_SUSPENDED &&
1957 new_state != USB_STATE_SUSPENDED)
1958 udev->active_duration -= jiffies;
1959 else if (new_state == USB_STATE_SUSPENDED &&
1960 udev->state != USB_STATE_SUSPENDED)
1961 udev->active_duration += jiffies;
1962 udev->state = new_state;
1964 recursively_mark_NOTATTACHED(udev);
1965 spin_unlock_irqrestore(&device_state_lock, flags);
1967 device_set_wakeup_capable(&udev->dev, wakeup);
1969 EXPORT_SYMBOL_GPL(usb_set_device_state);
1972 * Choose a device number.
1974 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1975 * USB-2.0 buses they are also used as device addresses, however on
1976 * USB-3.0 buses the address is assigned by the controller hardware
1977 * and it usually is not the same as the device number.
1979 * WUSB devices are simple: they have no hubs behind, so the mapping
1980 * device <-> virtual port number becomes 1:1. Why? to simplify the
1981 * life of the device connection logic in
1982 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1983 * handshake we need to assign a temporary address in the unauthorized
1984 * space. For simplicity we use the first virtual port number found to
1985 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1986 * and that becomes it's address [X < 128] or its unauthorized address
1989 * We add 1 as an offset to the one-based USB-stack port number
1990 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1991 * 0 is reserved by USB for default address; (b) Linux's USB stack
1992 * uses always #1 for the root hub of the controller. So USB stack's
1993 * port #1, which is wusb virtual-port #0 has address #2.
1995 * Devices connected under xHCI are not as simple. The host controller
1996 * supports virtualization, so the hardware assigns device addresses and
1997 * the HCD must setup data structures before issuing a set address
1998 * command to the hardware.
2000 static void choose_devnum(struct usb_device *udev)
2003 struct usb_bus *bus = udev->bus;
2005 /* If khubd ever becomes multithreaded, this will need a lock */
2007 devnum = udev->portnum + 1;
2008 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2010 /* Try to allocate the next devnum beginning at
2011 * bus->devnum_next. */
2012 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2015 devnum = find_next_zero_bit(bus->devmap.devicemap,
2017 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2020 set_bit(devnum, bus->devmap.devicemap);
2021 udev->devnum = devnum;
2025 static void release_devnum(struct usb_device *udev)
2027 if (udev->devnum > 0) {
2028 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2033 static void update_devnum(struct usb_device *udev, int devnum)
2035 /* The address for a WUSB device is managed by wusbcore. */
2037 udev->devnum = devnum;
2040 static void hub_free_dev(struct usb_device *udev)
2042 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2044 /* Root hubs aren't real devices, so don't free HCD resources */
2045 if (hcd->driver->free_dev && udev->parent)
2046 hcd->driver->free_dev(hcd, udev);
2050 * usb_disconnect - disconnect a device (usbcore-internal)
2051 * @pdev: pointer to device being disconnected
2052 * Context: !in_interrupt ()
2054 * Something got disconnected. Get rid of it and all of its children.
2056 * If *pdev is a normal device then the parent hub must already be locked.
2057 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2058 * which protects the set of root hubs as well as the list of buses.
2060 * Only hub drivers (including virtual root hub drivers for host
2061 * controllers) should ever call this.
2063 * This call is synchronous, and may not be used in an interrupt context.
2065 void usb_disconnect(struct usb_device **pdev)
2067 struct usb_device *udev = *pdev;
2068 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2071 /* mark the device as inactive, so any further urb submissions for
2072 * this device (and any of its children) will fail immediately.
2073 * this quiesces everything except pending urbs.
2075 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2076 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2079 usb_lock_device(udev);
2081 /* Free up all the children before we remove this device */
2082 for (i = 0; i < udev->maxchild; i++) {
2083 if (hub->ports[i]->child)
2084 usb_disconnect(&hub->ports[i]->child);
2087 /* deallocate hcd/hardware state ... nuking all pending urbs and
2088 * cleaning up all state associated with the current configuration
2089 * so that the hardware is now fully quiesced.
2091 dev_dbg (&udev->dev, "unregistering device\n");
2092 usb_disable_device(udev, 0);
2093 usb_hcd_synchronize_unlinks(udev);
2096 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2097 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2099 sysfs_remove_link(&udev->dev.kobj, "port");
2100 sysfs_remove_link(&port_dev->dev.kobj, "device");
2102 if (!port_dev->did_runtime_put)
2103 pm_runtime_put(&port_dev->dev);
2105 port_dev->did_runtime_put = false;
2108 usb_remove_ep_devs(&udev->ep0);
2109 usb_unlock_device(udev);
2111 /* Unregister the device. The device driver is responsible
2112 * for de-configuring the device and invoking the remove-device
2113 * notifier chain (used by usbfs and possibly others).
2115 device_del(&udev->dev);
2117 /* Free the device number and delete the parent's children[]
2118 * (or root_hub) pointer.
2120 release_devnum(udev);
2122 /* Avoid races with recursively_mark_NOTATTACHED() */
2123 spin_lock_irq(&device_state_lock);
2125 spin_unlock_irq(&device_state_lock);
2129 put_device(&udev->dev);
2132 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2133 static void show_string(struct usb_device *udev, char *id, char *string)
2137 dev_info(&udev->dev, "%s: %s\n", id, string);
2140 static void announce_device(struct usb_device *udev)
2142 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2143 le16_to_cpu(udev->descriptor.idVendor),
2144 le16_to_cpu(udev->descriptor.idProduct));
2145 dev_info(&udev->dev,
2146 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2147 udev->descriptor.iManufacturer,
2148 udev->descriptor.iProduct,
2149 udev->descriptor.iSerialNumber);
2150 show_string(udev, "Product", udev->product);
2151 show_string(udev, "Manufacturer", udev->manufacturer);
2152 show_string(udev, "SerialNumber", udev->serial);
2155 static inline void announce_device(struct usb_device *udev) { }
2158 #ifdef CONFIG_USB_OTG
2159 #include "otg_whitelist.h"
2163 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2164 * @udev: newly addressed device (in ADDRESS state)
2166 * Finish enumeration for On-The-Go devices
2168 * Return: 0 if successful. A negative error code otherwise.
2170 static int usb_enumerate_device_otg(struct usb_device *udev)
2174 #ifdef CONFIG_USB_OTG
2176 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2177 * to wake us after we've powered off VBUS; and HNP, switching roles
2178 * "host" to "peripheral". The OTG descriptor helps figure this out.
2180 if (!udev->bus->is_b_host
2182 && udev->parent == udev->bus->root_hub) {
2183 struct usb_otg_descriptor *desc = NULL;
2184 struct usb_bus *bus = udev->bus;
2186 /* descriptor may appear anywhere in config */
2187 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2188 le16_to_cpu(udev->config[0].desc.wTotalLength),
2189 USB_DT_OTG, (void **) &desc) == 0) {
2190 if (desc->bmAttributes & USB_OTG_HNP) {
2191 unsigned port1 = udev->portnum;
2193 dev_info(&udev->dev,
2194 "Dual-Role OTG device on %sHNP port\n",
2195 (port1 == bus->otg_port)
2198 /* enable HNP before suspend, it's simpler */
2199 if (port1 == bus->otg_port)
2200 bus->b_hnp_enable = 1;
2201 err = usb_control_msg(udev,
2202 usb_sndctrlpipe(udev, 0),
2203 USB_REQ_SET_FEATURE, 0,
2205 ? USB_DEVICE_B_HNP_ENABLE
2206 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2207 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2209 /* OTG MESSAGE: report errors here,
2210 * customize to match your product.
2212 dev_info(&udev->dev,
2213 "can't set HNP mode: %d\n",
2215 bus->b_hnp_enable = 0;
2221 if (!is_targeted(udev)) {
2223 /* Maybe it can talk to us, though we can't talk to it.
2224 * (Includes HNP test device.)
2226 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2227 err = usb_port_suspend(udev, PMSG_SUSPEND);
2229 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2241 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2242 * @udev: newly addressed device (in ADDRESS state)
2244 * This is only called by usb_new_device() and usb_authorize_device()
2245 * and FIXME -- all comments that apply to them apply here wrt to
2248 * If the device is WUSB and not authorized, we don't attempt to read
2249 * the string descriptors, as they will be errored out by the device
2250 * until it has been authorized.
2252 * Return: 0 if successful. A negative error code otherwise.
2254 static int usb_enumerate_device(struct usb_device *udev)
2258 if (udev->config == NULL) {
2259 err = usb_get_configuration(udev);
2262 dev_err(&udev->dev, "can't read configurations, error %d\n",
2268 /* read the standard strings and cache them if present */
2269 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2270 udev->manufacturer = usb_cache_string(udev,
2271 udev->descriptor.iManufacturer);
2272 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2274 err = usb_enumerate_device_otg(udev);
2278 usb_detect_interface_quirks(udev);
2283 static void set_usb_port_removable(struct usb_device *udev)
2285 struct usb_device *hdev = udev->parent;
2286 struct usb_hub *hub;
2287 u8 port = udev->portnum;
2288 u16 wHubCharacteristics;
2289 bool removable = true;
2294 hub = usb_hub_to_struct_hub(udev->parent);
2296 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2298 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2301 if (hub_is_superspeed(hdev)) {
2302 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2306 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2311 udev->removable = USB_DEVICE_REMOVABLE;
2313 udev->removable = USB_DEVICE_FIXED;
2317 * usb_new_device - perform initial device setup (usbcore-internal)
2318 * @udev: newly addressed device (in ADDRESS state)
2320 * This is called with devices which have been detected but not fully
2321 * enumerated. The device descriptor is available, but not descriptors
2322 * for any device configuration. The caller must have locked either
2323 * the parent hub (if udev is a normal device) or else the
2324 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2325 * udev has already been installed, but udev is not yet visible through
2326 * sysfs or other filesystem code.
2328 * This call is synchronous, and may not be used in an interrupt context.
2330 * Only the hub driver or root-hub registrar should ever call this.
2332 * Return: Whether the device is configured properly or not. Zero if the
2333 * interface was registered with the driver core; else a negative errno
2337 int usb_new_device(struct usb_device *udev)
2342 /* Initialize non-root-hub device wakeup to disabled;
2343 * device (un)configuration controls wakeup capable
2344 * sysfs power/wakeup controls wakeup enabled/disabled
2346 device_init_wakeup(&udev->dev, 0);
2349 /* Tell the runtime-PM framework the device is active */
2350 pm_runtime_set_active(&udev->dev);
2351 pm_runtime_get_noresume(&udev->dev);
2352 pm_runtime_use_autosuspend(&udev->dev);
2353 pm_runtime_enable(&udev->dev);
2355 /* By default, forbid autosuspend for all devices. It will be
2356 * allowed for hubs during binding.
2358 usb_disable_autosuspend(udev);
2360 err = usb_enumerate_device(udev); /* Read descriptors */
2363 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2364 udev->devnum, udev->bus->busnum,
2365 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2366 /* export the usbdev device-node for libusb */
2367 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2368 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2370 /* Tell the world! */
2371 announce_device(udev);
2374 add_device_randomness(udev->serial, strlen(udev->serial));
2376 add_device_randomness(udev->product, strlen(udev->product));
2377 if (udev->manufacturer)
2378 add_device_randomness(udev->manufacturer,
2379 strlen(udev->manufacturer));
2381 device_enable_async_suspend(&udev->dev);
2384 * check whether the hub marks this port as non-removable. Do it
2385 * now so that platform-specific data can override it in
2389 set_usb_port_removable(udev);
2391 /* Register the device. The device driver is responsible
2392 * for configuring the device and invoking the add-device
2393 * notifier chain (used by usbfs and possibly others).
2395 err = device_add(&udev->dev);
2397 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2401 /* Create link files between child device and usb port device. */
2403 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2404 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2406 err = sysfs_create_link(&udev->dev.kobj,
2407 &port_dev->dev.kobj, "port");
2411 err = sysfs_create_link(&port_dev->dev.kobj,
2412 &udev->dev.kobj, "device");
2414 sysfs_remove_link(&udev->dev.kobj, "port");
2418 pm_runtime_get_sync(&port_dev->dev);
2421 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2422 usb_mark_last_busy(udev);
2423 pm_runtime_put_sync_autosuspend(&udev->dev);
2427 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2428 pm_runtime_disable(&udev->dev);
2429 pm_runtime_set_suspended(&udev->dev);
2435 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2436 * @usb_dev: USB device
2438 * Move the USB device to a very basic state where interfaces are disabled
2439 * and the device is in fact unconfigured and unusable.
2441 * We share a lock (that we have) with device_del(), so we need to
2446 int usb_deauthorize_device(struct usb_device *usb_dev)
2448 usb_lock_device(usb_dev);
2449 if (usb_dev->authorized == 0)
2450 goto out_unauthorized;
2452 usb_dev->authorized = 0;
2453 usb_set_configuration(usb_dev, -1);
2456 usb_unlock_device(usb_dev);
2461 int usb_authorize_device(struct usb_device *usb_dev)
2465 usb_lock_device(usb_dev);
2466 if (usb_dev->authorized == 1)
2467 goto out_authorized;
2469 result = usb_autoresume_device(usb_dev);
2471 dev_err(&usb_dev->dev,
2472 "can't autoresume for authorization: %d\n", result);
2473 goto error_autoresume;
2475 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2477 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2478 "authorization: %d\n", result);
2479 goto error_device_descriptor;
2482 usb_dev->authorized = 1;
2483 /* Choose and set the configuration. This registers the interfaces
2484 * with the driver core and lets interface drivers bind to them.
2486 c = usb_choose_configuration(usb_dev);
2488 result = usb_set_configuration(usb_dev, c);
2490 dev_err(&usb_dev->dev,
2491 "can't set config #%d, error %d\n", c, result);
2492 /* This need not be fatal. The user can try to
2493 * set other configurations. */
2496 dev_info(&usb_dev->dev, "authorized to connect\n");
2498 error_device_descriptor:
2499 usb_autosuspend_device(usb_dev);
2502 usb_unlock_device(usb_dev); /* complements locktree */
2507 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2508 static unsigned hub_is_wusb(struct usb_hub *hub)
2510 struct usb_hcd *hcd;
2511 if (hub->hdev->parent != NULL) /* not a root hub? */
2513 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2514 return hcd->wireless;
2518 #define PORT_RESET_TRIES 5
2519 #define SET_ADDRESS_TRIES 2
2520 #define GET_DESCRIPTOR_TRIES 2
2521 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2522 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2524 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2525 #define HUB_SHORT_RESET_TIME 10
2526 #define HUB_BH_RESET_TIME 50
2527 #define HUB_LONG_RESET_TIME 200
2528 #define HUB_RESET_TIMEOUT 800
2531 * "New scheme" enumeration causes an extra state transition to be
2532 * exposed to an xhci host and causes USB3 devices to receive control
2533 * commands in the default state. This has been seen to cause
2534 * enumeration failures, so disable this enumeration scheme for USB3
2537 static bool use_new_scheme(struct usb_device *udev, int retry)
2539 if (udev->speed == USB_SPEED_SUPER)
2542 return USE_NEW_SCHEME(retry);
2545 static int hub_port_reset(struct usb_hub *hub, int port1,
2546 struct usb_device *udev, unsigned int delay, bool warm);
2548 /* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2549 * Port worm reset is required to recover
2551 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2553 return hub_is_superspeed(hub->hdev) &&
2554 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2555 USB_SS_PORT_LS_SS_INACTIVE) ||
2556 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2557 USB_SS_PORT_LS_COMP_MOD)) ;
2560 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2561 struct usb_device *udev, unsigned int delay, bool warm)
2563 int delay_time, ret;
2567 for (delay_time = 0;
2568 delay_time < HUB_RESET_TIMEOUT;
2569 delay_time += delay) {
2570 /* wait to give the device a chance to reset */
2573 /* read and decode port status */
2574 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2578 /* The port state is unknown until the reset completes. */
2579 if (!(portstatus & USB_PORT_STAT_RESET))
2582 /* switch to the long delay after two short delay failures */
2583 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2584 delay = HUB_LONG_RESET_TIME;
2586 dev_dbg (hub->intfdev,
2587 "port %d not %sreset yet, waiting %dms\n",
2588 port1, warm ? "warm " : "", delay);
2591 if ((portstatus & USB_PORT_STAT_RESET))
2594 if (hub_port_warm_reset_required(hub, portstatus))
2597 /* Device went away? */
2598 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2601 /* bomb out completely if the connection bounced. A USB 3.0
2602 * connection may bounce if multiple warm resets were issued,
2603 * but the device may have successfully re-connected. Ignore it.
2605 if (!hub_is_superspeed(hub->hdev) &&
2606 (portchange & USB_PORT_STAT_C_CONNECTION))
2609 if (!(portstatus & USB_PORT_STAT_ENABLE))
2615 if (hub_is_wusb(hub))
2616 udev->speed = USB_SPEED_WIRELESS;
2617 else if (hub_is_superspeed(hub->hdev))
2618 udev->speed = USB_SPEED_SUPER;
2619 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2620 udev->speed = USB_SPEED_HIGH;
2621 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2622 udev->speed = USB_SPEED_LOW;
2624 udev->speed = USB_SPEED_FULL;
2628 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2629 struct usb_device *udev, int *status)
2633 /* TRSTRCY = 10 ms; plus some extra */
2636 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2638 update_devnum(udev, 0);
2639 /* The xHC may think the device is already reset,
2640 * so ignore the status.
2642 if (hcd->driver->reset_device)
2643 hcd->driver->reset_device(hcd, udev);
2648 usb_clear_port_feature(hub->hdev,
2649 port1, USB_PORT_FEAT_C_RESET);
2650 if (hub_is_superspeed(hub->hdev)) {
2651 usb_clear_port_feature(hub->hdev, port1,
2652 USB_PORT_FEAT_C_BH_PORT_RESET);
2653 usb_clear_port_feature(hub->hdev, port1,
2654 USB_PORT_FEAT_C_PORT_LINK_STATE);
2655 usb_clear_port_feature(hub->hdev, port1,
2656 USB_PORT_FEAT_C_CONNECTION);
2659 usb_set_device_state(udev, *status
2660 ? USB_STATE_NOTATTACHED
2661 : USB_STATE_DEFAULT);
2666 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2667 static int hub_port_reset(struct usb_hub *hub, int port1,
2668 struct usb_device *udev, unsigned int delay, bool warm)
2671 u16 portchange, portstatus;
2673 if (!hub_is_superspeed(hub->hdev)) {
2675 dev_err(hub->intfdev, "only USB3 hub support "
2679 /* Block EHCI CF initialization during the port reset.
2680 * Some companion controllers don't like it when they mix.
2682 down_read(&ehci_cf_port_reset_rwsem);
2685 * If the caller hasn't explicitly requested a warm reset,
2686 * double check and see if one is needed.
2688 status = hub_port_status(hub, port1,
2689 &portstatus, &portchange);
2693 if (hub_port_warm_reset_required(hub, portstatus))
2697 /* Reset the port */
2698 for (i = 0; i < PORT_RESET_TRIES; i++) {
2699 status = set_port_feature(hub->hdev, port1, (warm ?
2700 USB_PORT_FEAT_BH_PORT_RESET :
2701 USB_PORT_FEAT_RESET));
2702 if (status == -ENODEV) {
2703 ; /* The hub is gone */
2704 } else if (status) {
2705 dev_err(hub->intfdev,
2706 "cannot %sreset port %d (err = %d)\n",
2707 warm ? "warm " : "", port1, status);
2709 status = hub_port_wait_reset(hub, port1, udev, delay,
2711 if (status && status != -ENOTCONN && status != -ENODEV)
2712 dev_dbg(hub->intfdev,
2713 "port_wait_reset: err = %d\n",
2717 /* Check for disconnect or reset */
2718 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2719 hub_port_finish_reset(hub, port1, udev, &status);
2721 if (!hub_is_superspeed(hub->hdev))
2725 * If a USB 3.0 device migrates from reset to an error
2726 * state, re-issue the warm reset.
2728 if (hub_port_status(hub, port1,
2729 &portstatus, &portchange) < 0)
2732 if (!hub_port_warm_reset_required(hub, portstatus))
2736 * If the port is in SS.Inactive or Compliance Mode, the
2737 * hot or warm reset failed. Try another warm reset.
2740 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2746 dev_dbg (hub->intfdev,
2747 "port %d not enabled, trying %sreset again...\n",
2748 port1, warm ? "warm " : "");
2749 delay = HUB_LONG_RESET_TIME;
2752 dev_err (hub->intfdev,
2753 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2757 if (!hub_is_superspeed(hub->hdev))
2758 up_read(&ehci_cf_port_reset_rwsem);
2763 /* Check if a port is power on */
2764 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2768 if (hub_is_superspeed(hub->hdev)) {
2769 if (portstatus & USB_SS_PORT_STAT_POWER)
2772 if (portstatus & USB_PORT_STAT_POWER)
2781 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2782 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2786 if (hub_is_superspeed(hub->hdev)) {
2787 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2788 == USB_SS_PORT_LS_U3)
2791 if (portstatus & USB_PORT_STAT_SUSPEND)
2798 /* Determine whether the device on a port is ready for a normal resume,
2799 * is ready for a reset-resume, or should be disconnected.
2801 static int check_port_resume_type(struct usb_device *udev,
2802 struct usb_hub *hub, int port1,
2803 int status, unsigned portchange, unsigned portstatus)
2805 /* Is the device still present? */
2806 if (status || port_is_suspended(hub, portstatus) ||
2807 !port_is_power_on(hub, portstatus) ||
2808 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2813 /* Can't do a normal resume if the port isn't enabled,
2814 * so try a reset-resume instead.
2816 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2817 if (udev->persist_enabled)
2818 udev->reset_resume = 1;
2824 dev_dbg(hub->intfdev,
2825 "port %d status %04x.%04x after resume, %d\n",
2826 port1, portchange, portstatus, status);
2827 } else if (udev->reset_resume) {
2829 /* Late port handoff can set status-change bits */
2830 if (portchange & USB_PORT_STAT_C_CONNECTION)
2831 usb_clear_port_feature(hub->hdev, port1,
2832 USB_PORT_FEAT_C_CONNECTION);
2833 if (portchange & USB_PORT_STAT_C_ENABLE)
2834 usb_clear_port_feature(hub->hdev, port1,
2835 USB_PORT_FEAT_C_ENABLE);
2841 int usb_disable_ltm(struct usb_device *udev)
2843 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2845 /* Check if the roothub and device supports LTM. */
2846 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2847 !usb_device_supports_ltm(udev))
2850 /* Clear Feature LTM Enable can only be sent if the device is
2853 if (!udev->actconfig)
2856 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2857 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2858 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2859 USB_CTRL_SET_TIMEOUT);
2861 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2863 void usb_enable_ltm(struct usb_device *udev)
2865 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2867 /* Check if the roothub and device supports LTM. */
2868 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2869 !usb_device_supports_ltm(udev))
2872 /* Set Feature LTM Enable can only be sent if the device is
2875 if (!udev->actconfig)
2878 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2879 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2880 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2881 USB_CTRL_SET_TIMEOUT);
2883 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2886 * usb_enable_remote_wakeup - enable remote wakeup for a device
2887 * @udev: target device
2889 * For USB-2 devices: Set the device's remote wakeup feature.
2891 * For USB-3 devices: Assume there's only one function on the device and
2892 * enable remote wake for the first interface. FIXME if the interface
2893 * association descriptor shows there's more than one function.
2895 static int usb_enable_remote_wakeup(struct usb_device *udev)
2897 if (udev->speed < USB_SPEED_SUPER)
2898 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2899 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2900 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2901 USB_CTRL_SET_TIMEOUT);
2903 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2904 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2905 USB_INTRF_FUNC_SUSPEND,
2906 USB_INTRF_FUNC_SUSPEND_RW |
2907 USB_INTRF_FUNC_SUSPEND_LP,
2908 NULL, 0, USB_CTRL_SET_TIMEOUT);
2912 * usb_disable_remote_wakeup - disable remote wakeup for a device
2913 * @udev: target device
2915 * For USB-2 devices: Clear the device's remote wakeup feature.
2917 * For USB-3 devices: Assume there's only one function on the device and
2918 * disable remote wake for the first interface. FIXME if the interface
2919 * association descriptor shows there's more than one function.
2921 static int usb_disable_remote_wakeup(struct usb_device *udev)
2923 if (udev->speed < USB_SPEED_SUPER)
2924 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2925 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2926 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2927 USB_CTRL_SET_TIMEOUT);
2929 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2930 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2931 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2932 USB_CTRL_SET_TIMEOUT);
2935 /* Count of wakeup-enabled devices at or below udev */
2936 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2938 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2940 return udev->do_remote_wakeup +
2941 (hub ? hub->wakeup_enabled_descendants : 0);
2945 * usb_port_suspend - suspend a usb device's upstream port
2946 * @udev: device that's no longer in active use, not a root hub
2947 * Context: must be able to sleep; device not locked; pm locks held
2949 * Suspends a USB device that isn't in active use, conserving power.
2950 * Devices may wake out of a suspend, if anything important happens,
2951 * using the remote wakeup mechanism. They may also be taken out of
2952 * suspend by the host, using usb_port_resume(). It's also routine
2953 * to disconnect devices while they are suspended.
2955 * This only affects the USB hardware for a device; its interfaces
2956 * (and, for hubs, child devices) must already have been suspended.
2958 * Selective port suspend reduces power; most suspended devices draw
2959 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2960 * All devices below the suspended port are also suspended.
2962 * Devices leave suspend state when the host wakes them up. Some devices
2963 * also support "remote wakeup", where the device can activate the USB
2964 * tree above them to deliver data, such as a keypress or packet. In
2965 * some cases, this wakes the USB host.
2967 * Suspending OTG devices may trigger HNP, if that's been enabled
2968 * between a pair of dual-role devices. That will change roles, such
2969 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2971 * Devices on USB hub ports have only one "suspend" state, corresponding
2972 * to ACPI D2, "may cause the device to lose some context".
2973 * State transitions include:
2975 * - suspend, resume ... when the VBUS power link stays live
2976 * - suspend, disconnect ... VBUS lost
2978 * Once VBUS drop breaks the circuit, the port it's using has to go through
2979 * normal re-enumeration procedures, starting with enabling VBUS power.
2980 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2981 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2982 * timer, no SRP, no requests through sysfs.
2984 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2985 * suspended until their bus goes into global suspend (i.e., the root
2986 * hub is suspended). Nevertheless, we change @udev->state to
2987 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2988 * upstream port setting is stored in @udev->port_is_suspended.
2990 * Returns 0 on success, else negative errno.
2992 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2994 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2995 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2996 int port1 = udev->portnum;
2998 bool really_suspend = true;
3000 /* enable remote wakeup when appropriate; this lets the device
3001 * wake up the upstream hub (including maybe the root hub).
3003 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3004 * we don't explicitly enable it here.
3006 if (udev->do_remote_wakeup) {
3007 status = usb_enable_remote_wakeup(udev);
3009 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3011 /* bail if autosuspend is requested */
3012 if (PMSG_IS_AUTO(msg))
3017 /* disable USB2 hardware LPM */
3018 if (udev->usb2_hw_lpm_enabled == 1)
3019 usb_set_usb2_hardware_lpm(udev, 0);
3021 if (usb_disable_ltm(udev)) {
3022 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3024 if (PMSG_IS_AUTO(msg))
3027 if (usb_unlocked_disable_lpm(udev)) {
3028 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3030 if (PMSG_IS_AUTO(msg))
3035 if (hub_is_superspeed(hub->hdev))
3036 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3039 * For system suspend, we do not need to enable the suspend feature
3040 * on individual USB-2 ports. The devices will automatically go
3041 * into suspend a few ms after the root hub stops sending packets.
3042 * The USB 2.0 spec calls this "global suspend".
3044 * However, many USB hubs have a bug: They don't relay wakeup requests
3045 * from a downstream port if the port's suspend feature isn't on.
3046 * Therefore we will turn on the suspend feature if udev or any of its
3047 * descendants is enabled for remote wakeup.
3049 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3050 status = set_port_feature(hub->hdev, port1,
3051 USB_PORT_FEAT_SUSPEND);
3053 really_suspend = false;
3057 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3060 /* Try to enable USB3 LPM and LTM again */
3061 usb_unlocked_enable_lpm(udev);
3063 usb_enable_ltm(udev);
3065 /* Try to enable USB2 hardware LPM again */
3066 if (udev->usb2_hw_lpm_capable == 1)
3067 usb_set_usb2_hardware_lpm(udev, 1);
3069 if (udev->do_remote_wakeup)
3070 (void) usb_disable_remote_wakeup(udev);
3073 /* System sleep transitions should never fail */
3074 if (!PMSG_IS_AUTO(msg))
3077 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3078 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3079 udev->do_remote_wakeup);
3080 if (really_suspend) {
3081 udev->port_is_suspended = 1;
3083 /* device has up to 10 msec to fully suspend */
3086 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3089 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3090 pm_runtime_put_sync(&port_dev->dev);
3091 port_dev->did_runtime_put = true;
3094 usb_mark_last_busy(hub->hdev);
3099 * If the USB "suspend" state is in use (rather than "global suspend"),
3100 * many devices will be individually taken out of suspend state using
3101 * special "resume" signaling. This routine kicks in shortly after
3102 * hardware resume signaling is finished, either because of selective
3103 * resume (by host) or remote wakeup (by device) ... now see what changed
3104 * in the tree that's rooted at this device.
3106 * If @udev->reset_resume is set then the device is reset before the
3107 * status check is done.
3109 static int finish_port_resume(struct usb_device *udev)
3114 /* caller owns the udev device lock */
3115 dev_dbg(&udev->dev, "%s\n",
3116 udev->reset_resume ? "finish reset-resume" : "finish resume");
3118 /* usb ch9 identifies four variants of SUSPENDED, based on what
3119 * state the device resumes to. Linux currently won't see the
3120 * first two on the host side; they'd be inside hub_port_init()
3121 * during many timeouts, but khubd can't suspend until later.
3123 usb_set_device_state(udev, udev->actconfig
3124 ? USB_STATE_CONFIGURED
3125 : USB_STATE_ADDRESS);
3127 /* 10.5.4.5 says not to reset a suspended port if the attached
3128 * device is enabled for remote wakeup. Hence the reset
3129 * operation is carried out here, after the port has been
3132 if (udev->reset_resume)
3134 status = usb_reset_and_verify_device(udev);
3136 /* 10.5.4.5 says be sure devices in the tree are still there.
3137 * For now let's assume the device didn't go crazy on resume,
3138 * and device drivers will know about any resume quirks.
3142 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3144 /* If a normal resume failed, try doing a reset-resume */
3145 if (status && !udev->reset_resume && udev->persist_enabled) {
3146 dev_dbg(&udev->dev, "retry with reset-resume\n");
3147 udev->reset_resume = 1;
3148 goto retry_reset_resume;
3153 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3156 * There are a few quirky devices which violate the standard
3157 * by claiming to have remote wakeup enabled after a reset,
3158 * which crash if the feature is cleared, hence check for
3159 * udev->reset_resume
3161 } else if (udev->actconfig && !udev->reset_resume) {
3162 if (udev->speed < USB_SPEED_SUPER) {
3163 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3164 status = usb_disable_remote_wakeup(udev);
3166 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3168 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3169 | USB_INTRF_STAT_FUNC_RW))
3170 status = usb_disable_remote_wakeup(udev);
3175 "disable remote wakeup, status %d\n",
3183 * There are some SS USB devices which take longer time for link training.
3184 * XHCI specs 4.19.4 says that when Link training is successful, port
3185 * sets CSC bit to 1. So if SW reads port status before successful link
3186 * training, then it will not find device to be present.
3187 * USB Analyzer log with such buggy devices show that in some cases
3188 * device switch on the RX termination after long delay of host enabling
3189 * the VBUS. In few other cases it has been seen that device fails to
3190 * negotiate link training in first attempt. It has been
3191 * reported till now that few devices take as long as 2000 ms to train
3192 * the link after host enabling its VBUS and termination. Following
3193 * routine implements a 2000 ms timeout for link training. If in a case
3194 * link trains before timeout, loop will exit earlier.
3196 * FIXME: If a device was connected before suspend, but was removed
3197 * while system was asleep, then the loop in the following routine will
3198 * only exit at timeout.
3200 * This routine should only be called when persist is enabled for a SS
3203 static int wait_for_ss_port_enable(struct usb_device *udev,
3204 struct usb_hub *hub, int *port1,
3205 u16 *portchange, u16 *portstatus)
3207 int status = 0, delay_ms = 0;
3209 while (delay_ms < 2000) {
3210 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3214 status = hub_port_status(hub, *port1, portstatus, portchange);
3220 * usb_port_resume - re-activate a suspended usb device's upstream port
3221 * @udev: device to re-activate, not a root hub
3222 * Context: must be able to sleep; device not locked; pm locks held
3224 * This will re-activate the suspended device, increasing power usage
3225 * while letting drivers communicate again with its endpoints.
3226 * USB resume explicitly guarantees that the power session between
3227 * the host and the device is the same as it was when the device
3230 * If @udev->reset_resume is set then this routine won't check that the
3231 * port is still enabled. Furthermore, finish_port_resume() above will
3232 * reset @udev. The end result is that a broken power session can be
3233 * recovered and @udev will appear to persist across a loss of VBUS power.
3235 * For example, if a host controller doesn't maintain VBUS suspend current
3236 * during a system sleep or is reset when the system wakes up, all the USB
3237 * power sessions below it will be broken. This is especially troublesome
3238 * for mass-storage devices containing mounted filesystems, since the
3239 * device will appear to have disconnected and all the memory mappings
3240 * to it will be lost. Using the USB_PERSIST facility, the device can be
3241 * made to appear as if it had not disconnected.
3243 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3244 * every effort to insure that the same device is present after the
3245 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3246 * quite possible for a device to remain unaltered but its media to be
3247 * changed. If the user replaces a flash memory card while the system is
3248 * asleep, he will have only himself to blame when the filesystem on the
3249 * new card is corrupted and the system crashes.
3251 * Returns 0 on success, else negative errno.
3253 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3255 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3256 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3257 int port1 = udev->portnum;
3259 u16 portchange, portstatus;
3261 if (port_dev->did_runtime_put) {
3262 status = pm_runtime_get_sync(&port_dev->dev);
3263 port_dev->did_runtime_put = false;
3265 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3271 /* Skip the initial Clear-Suspend step for a remote wakeup */
3272 status = hub_port_status(hub, port1, &portstatus, &portchange);
3273 if (status == 0 && !port_is_suspended(hub, portstatus))
3274 goto SuspendCleared;
3276 /* dev_dbg(hub->intfdev, "resume port %d\n", port1); */
3278 set_bit(port1, hub->busy_bits);
3280 /* see 7.1.7.7; affects power usage, but not budgeting */
3281 if (hub_is_superspeed(hub->hdev))
3282 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3284 status = usb_clear_port_feature(hub->hdev,
3285 port1, USB_PORT_FEAT_SUSPEND);
3287 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3290 /* drive resume for at least 20 msec */
3291 dev_dbg(&udev->dev, "usb %sresume\n",
3292 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3295 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3296 * stop resume signaling. Then finish the resume
3299 status = hub_port_status(hub, port1, &portstatus, &portchange);
3301 /* TRSMRCY = 10 msec */
3307 udev->port_is_suspended = 0;
3308 if (hub_is_superspeed(hub->hdev)) {
3309 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3310 usb_clear_port_feature(hub->hdev, port1,
3311 USB_PORT_FEAT_C_PORT_LINK_STATE);
3313 if (portchange & USB_PORT_STAT_C_SUSPEND)
3314 usb_clear_port_feature(hub->hdev, port1,
3315 USB_PORT_FEAT_C_SUSPEND);
3319 clear_bit(port1, hub->busy_bits);
3321 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3322 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3325 status = check_port_resume_type(udev,
3326 hub, port1, status, portchange, portstatus);
3328 status = finish_port_resume(udev);
3330 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3331 hub_port_logical_disconnect(hub, port1);
3333 /* Try to enable USB2 hardware LPM */
3334 if (udev->usb2_hw_lpm_capable == 1)
3335 usb_set_usb2_hardware_lpm(udev, 1);
3337 /* Try to enable USB3 LTM and LPM */
3338 usb_enable_ltm(udev);
3339 usb_unlocked_enable_lpm(udev);
3345 #ifdef CONFIG_PM_RUNTIME
3347 /* caller has locked udev */
3348 int usb_remote_wakeup(struct usb_device *udev)
3352 if (udev->state == USB_STATE_SUSPENDED) {
3353 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3354 status = usb_autoresume_device(udev);
3356 /* Let the drivers do their thing, then... */
3357 usb_autosuspend_device(udev);
3365 static int check_ports_changed(struct usb_hub *hub)
3369 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3370 u16 portstatus, portchange;
3373 status = hub_port_status(hub, port1, &portstatus, &portchange);
3374 if (!status && portchange)
3380 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3382 struct usb_hub *hub = usb_get_intfdata (intf);
3383 struct usb_device *hdev = hub->hdev;
3388 * Warn if children aren't already suspended.
3389 * Also, add up the number of wakeup-enabled descendants.
3391 hub->wakeup_enabled_descendants = 0;
3392 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3393 struct usb_device *udev;
3395 udev = hub->ports[port1 - 1]->child;
3396 if (udev && udev->can_submit) {
3397 dev_warn(&intf->dev, "port %d not suspended yet\n",
3399 if (PMSG_IS_AUTO(msg))
3403 hub->wakeup_enabled_descendants +=
3404 wakeup_enabled_descendants(udev);
3407 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3408 /* check if there are changes pending on hub ports */
3409 if (check_ports_changed(hub)) {
3410 if (PMSG_IS_AUTO(msg))
3412 pm_wakeup_event(&hdev->dev, 2000);
3416 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3417 /* Enable hub to send remote wakeup for all ports. */
3418 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3419 status = set_port_feature(hdev,
3421 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3422 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3423 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3424 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3428 dev_dbg(&intf->dev, "%s\n", __func__);
3430 /* stop khubd and related activity */
3431 hub_quiesce(hub, HUB_SUSPEND);
3435 static int hub_resume(struct usb_interface *intf)
3437 struct usb_hub *hub = usb_get_intfdata(intf);
3439 dev_dbg(&intf->dev, "%s\n", __func__);
3440 hub_activate(hub, HUB_RESUME);
3444 static int hub_reset_resume(struct usb_interface *intf)
3446 struct usb_hub *hub = usb_get_intfdata(intf);
3448 dev_dbg(&intf->dev, "%s\n", __func__);
3449 hub_activate(hub, HUB_RESET_RESUME);
3454 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3455 * @rhdev: struct usb_device for the root hub
3457 * The USB host controller driver calls this function when its root hub
3458 * is resumed and Vbus power has been interrupted or the controller
3459 * has been reset. The routine marks @rhdev as having lost power.
3460 * When the hub driver is resumed it will take notice and carry out
3461 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3462 * the others will be disconnected.
3464 void usb_root_hub_lost_power(struct usb_device *rhdev)
3466 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3467 rhdev->reset_resume = 1;
3469 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3471 static const char * const usb3_lpm_names[] = {
3479 * Send a Set SEL control transfer to the device, prior to enabling
3480 * device-initiated U1 or U2. This lets the device know the exit latencies from
3481 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3482 * packet from the host.
3484 * This function will fail if the SEL or PEL values for udev are greater than
3485 * the maximum allowed values for the link state to be enabled.
3487 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3489 struct usb_set_sel_req *sel_values;
3490 unsigned long long u1_sel;
3491 unsigned long long u1_pel;
3492 unsigned long long u2_sel;
3493 unsigned long long u2_pel;
3496 if (udev->state != USB_STATE_CONFIGURED)
3499 /* Convert SEL and PEL stored in ns to us */
3500 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3501 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3502 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3503 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3506 * Make sure that the calculated SEL and PEL values for the link
3507 * state we're enabling aren't bigger than the max SEL/PEL
3508 * value that will fit in the SET SEL control transfer.
3509 * Otherwise the device would get an incorrect idea of the exit
3510 * latency for the link state, and could start a device-initiated
3511 * U1/U2 when the exit latencies are too high.
3513 if ((state == USB3_LPM_U1 &&
3514 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3515 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3516 (state == USB3_LPM_U2 &&
3517 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3518 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3519 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3520 usb3_lpm_names[state], u1_sel, u1_pel);
3525 * If we're enabling device-initiated LPM for one link state,
3526 * but the other link state has a too high SEL or PEL value,
3527 * just set those values to the max in the Set SEL request.
3529 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3530 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3532 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3533 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3535 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3536 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3538 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3539 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3542 * usb_enable_lpm() can be called as part of a failed device reset,
3543 * which may be initiated by an error path of a mass storage driver.
3544 * Therefore, use GFP_NOIO.
3546 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3550 sel_values->u1_sel = u1_sel;
3551 sel_values->u1_pel = u1_pel;
3552 sel_values->u2_sel = cpu_to_le16(u2_sel);
3553 sel_values->u2_pel = cpu_to_le16(u2_pel);
3555 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3559 sel_values, sizeof *(sel_values),
3560 USB_CTRL_SET_TIMEOUT);
3566 * Enable or disable device-initiated U1 or U2 transitions.
3568 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3569 enum usb3_link_state state, bool enable)
3576 feature = USB_DEVICE_U1_ENABLE;
3579 feature = USB_DEVICE_U2_ENABLE;
3582 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3583 __func__, enable ? "enable" : "disable");
3587 if (udev->state != USB_STATE_CONFIGURED) {
3588 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3589 "for unconfigured device.\n",
3590 __func__, enable ? "enable" : "disable",
3591 usb3_lpm_names[state]);
3597 * Now send the control transfer to enable device-initiated LPM
3598 * for either U1 or U2.
3600 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3601 USB_REQ_SET_FEATURE,
3605 USB_CTRL_SET_TIMEOUT);
3607 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3608 USB_REQ_CLEAR_FEATURE,
3612 USB_CTRL_SET_TIMEOUT);
3615 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3616 enable ? "Enable" : "Disable",
3617 usb3_lpm_names[state]);
3623 static int usb_set_lpm_timeout(struct usb_device *udev,
3624 enum usb3_link_state state, int timeout)
3631 feature = USB_PORT_FEAT_U1_TIMEOUT;
3634 feature = USB_PORT_FEAT_U2_TIMEOUT;
3637 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3642 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3643 timeout != USB3_LPM_DEVICE_INITIATED) {
3644 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3645 "which is a reserved value.\n",
3646 usb3_lpm_names[state], timeout);
3650 ret = set_port_feature(udev->parent,
3651 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3654 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3655 "error code %i\n", usb3_lpm_names[state],
3659 if (state == USB3_LPM_U1)
3660 udev->u1_params.timeout = timeout;
3662 udev->u2_params.timeout = timeout;
3667 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3670 * We will attempt to enable U1 or U2, but there are no guarantees that the
3671 * control transfers to set the hub timeout or enable device-initiated U1/U2
3672 * will be successful.
3674 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3675 * driver know about it. If that call fails, it should be harmless, and just
3676 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3678 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3679 enum usb3_link_state state)
3682 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3683 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3685 /* If the device says it doesn't have *any* exit latency to come out of
3686 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3689 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3690 (state == USB3_LPM_U2 && u2_mel == 0))
3694 * First, let the device know about the exit latencies
3695 * associated with the link state we're about to enable.
3697 ret = usb_req_set_sel(udev, state);
3699 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3700 usb3_lpm_names[state]);
3704 /* We allow the host controller to set the U1/U2 timeout internally
3705 * first, so that it can change its schedule to account for the
3706 * additional latency to send data to a device in a lower power
3709 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3711 /* xHCI host controller doesn't want to enable this LPM state. */
3716 dev_warn(&udev->dev, "Could not enable %s link state, "
3717 "xHCI error %i.\n", usb3_lpm_names[state],
3722 if (usb_set_lpm_timeout(udev, state, timeout))
3723 /* If we can't set the parent hub U1/U2 timeout,
3724 * device-initiated LPM won't be allowed either, so let the xHCI
3725 * host know that this link state won't be enabled.
3727 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3729 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3730 else if (udev->actconfig)
3731 usb_set_device_initiated_lpm(udev, state, true);
3736 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3739 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3740 * If zero is returned, the parent will not allow the link to go into U1/U2.
3742 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3743 * it won't have an effect on the bus link state because the parent hub will
3744 * still disallow device-initiated U1/U2 entry.
3746 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3747 * possible. The result will be slightly more bus bandwidth will be taken up
3748 * (to account for U1/U2 exit latency), but it should be harmless.
3750 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3751 enum usb3_link_state state)
3757 feature = USB_PORT_FEAT_U1_TIMEOUT;
3760 feature = USB_PORT_FEAT_U2_TIMEOUT;
3763 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3768 if (usb_set_lpm_timeout(udev, state, 0))
3771 usb_set_device_initiated_lpm(udev, state, false);
3773 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3774 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3775 "bus schedule bandwidth may be impacted.\n",
3776 usb3_lpm_names[state]);
3781 * Disable hub-initiated and device-initiated U1 and U2 entry.
3782 * Caller must own the bandwidth_mutex.
3784 * This will call usb_enable_lpm() on failure, which will decrement
3785 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3787 int usb_disable_lpm(struct usb_device *udev)
3789 struct usb_hcd *hcd;
3791 if (!udev || !udev->parent ||
3792 udev->speed != USB_SPEED_SUPER ||
3796 hcd = bus_to_hcd(udev->bus);
3797 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3800 udev->lpm_disable_count++;
3801 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3804 /* If LPM is enabled, attempt to disable it. */
3805 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3807 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3813 usb_enable_lpm(udev);
3816 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3818 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3819 int usb_unlocked_disable_lpm(struct usb_device *udev)
3821 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3827 mutex_lock(hcd->bandwidth_mutex);
3828 ret = usb_disable_lpm(udev);
3829 mutex_unlock(hcd->bandwidth_mutex);
3833 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3836 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3837 * xHCI host policy may prevent U1 or U2 from being enabled.
3839 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3840 * until the lpm_disable_count drops to zero. Caller must own the
3843 void usb_enable_lpm(struct usb_device *udev)
3845 struct usb_hcd *hcd;
3847 if (!udev || !udev->parent ||
3848 udev->speed != USB_SPEED_SUPER ||
3852 udev->lpm_disable_count--;
3853 hcd = bus_to_hcd(udev->bus);
3854 /* Double check that we can both enable and disable LPM.
3855 * Device must be configured to accept set feature U1/U2 timeout.
3857 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3858 !hcd->driver->disable_usb3_lpm_timeout)
3861 if (udev->lpm_disable_count > 0)
3864 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3865 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3867 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3869 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3870 void usb_unlocked_enable_lpm(struct usb_device *udev)
3872 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3877 mutex_lock(hcd->bandwidth_mutex);
3878 usb_enable_lpm(udev);
3879 mutex_unlock(hcd->bandwidth_mutex);
3881 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3884 #else /* CONFIG_PM */
3886 #define hub_suspend NULL
3887 #define hub_resume NULL
3888 #define hub_reset_resume NULL
3890 int usb_disable_lpm(struct usb_device *udev)
3894 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3896 void usb_enable_lpm(struct usb_device *udev) { }
3897 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3899 int usb_unlocked_disable_lpm(struct usb_device *udev)
3903 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3905 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3906 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3908 int usb_disable_ltm(struct usb_device *udev)
3912 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3914 void usb_enable_ltm(struct usb_device *udev) { }
3915 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3917 #endif /* CONFIG_PM */
3920 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3922 * Between connect detection and reset signaling there must be a delay
3923 * of 100ms at least for debounce and power-settling. The corresponding
3924 * timer shall restart whenever the downstream port detects a disconnect.
3926 * Apparently there are some bluetooth and irda-dongles and a number of
3927 * low-speed devices for which this debounce period may last over a second.
3928 * Not covered by the spec - but easy to deal with.
3930 * This implementation uses a 1500ms total debounce timeout; if the
3931 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3932 * every 25ms for transient disconnects. When the port status has been
3933 * unchanged for 100ms it returns the port status.
3935 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3938 int total_time, stable_time = 0;
3939 u16 portchange, portstatus;
3940 unsigned connection = 0xffff;
3942 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3943 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3947 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3948 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3949 if (!must_be_connected ||
3950 (connection == USB_PORT_STAT_CONNECTION))
3951 stable_time += HUB_DEBOUNCE_STEP;
3952 if (stable_time >= HUB_DEBOUNCE_STABLE)
3956 connection = portstatus & USB_PORT_STAT_CONNECTION;
3959 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3960 usb_clear_port_feature(hub->hdev, port1,
3961 USB_PORT_FEAT_C_CONNECTION);
3964 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3966 msleep(HUB_DEBOUNCE_STEP);
3969 dev_dbg (hub->intfdev,
3970 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3971 port1, total_time, stable_time, portstatus);
3973 if (stable_time < HUB_DEBOUNCE_STABLE)
3978 void usb_ep0_reinit(struct usb_device *udev)
3980 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3981 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3982 usb_enable_endpoint(udev, &udev->ep0, true);
3984 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3986 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3987 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3989 static int hub_set_address(struct usb_device *udev, int devnum)
3992 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3995 * The host controller will choose the device address,
3996 * instead of the core having chosen it earlier
3998 if (!hcd->driver->address_device && devnum <= 1)
4000 if (udev->state == USB_STATE_ADDRESS)
4002 if (udev->state != USB_STATE_DEFAULT)
4004 if (hcd->driver->address_device)
4005 retval = hcd->driver->address_device(hcd, udev);
4007 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4008 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4009 NULL, 0, USB_CTRL_SET_TIMEOUT);
4011 update_devnum(udev, devnum);
4012 /* Device now using proper address. */
4013 usb_set_device_state(udev, USB_STATE_ADDRESS);
4014 usb_ep0_reinit(udev);
4020 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4021 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4024 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4025 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4026 * support bit in the BOS descriptor.
4028 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4032 if (!udev->usb2_hw_lpm_capable)
4035 connect_type = usb_get_hub_port_connect_type(udev->parent,
4038 if ((udev->bos->ext_cap->bmAttributes & USB_BESL_SUPPORT) ||
4039 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4040 udev->usb2_hw_lpm_allowed = 1;
4041 usb_set_usb2_hardware_lpm(udev, 1);
4045 static int hub_enable_device(struct usb_device *udev)
4047 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4049 if (!hcd->driver->enable_device)
4051 if (udev->state == USB_STATE_ADDRESS)
4053 if (udev->state != USB_STATE_DEFAULT)
4056 return hcd->driver->enable_device(hcd, udev);
4059 /* Reset device, (re)assign address, get device descriptor.
4060 * Device connection must be stable, no more debouncing needed.
4061 * Returns device in USB_STATE_ADDRESS, except on error.
4063 * If this is called for an already-existing device (as part of
4064 * usb_reset_and_verify_device), the caller must own the device lock. For a
4065 * newly detected device that is not accessible through any global
4066 * pointers, it's not necessary to lock the device.
4069 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4072 static DEFINE_MUTEX(usb_address0_mutex);
4074 struct usb_device *hdev = hub->hdev;
4075 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4077 unsigned delay = HUB_SHORT_RESET_TIME;
4078 enum usb_device_speed oldspeed = udev->speed;
4080 int devnum = udev->devnum;
4082 /* root hub ports have a slightly longer reset period
4083 * (from USB 2.0 spec, section 7.1.7.5)
4085 if (!hdev->parent) {
4086 delay = HUB_ROOT_RESET_TIME;
4087 if (port1 == hdev->bus->otg_port)
4088 hdev->bus->b_hnp_enable = 0;
4091 /* Some low speed devices have problems with the quick delay, so */
4092 /* be a bit pessimistic with those devices. RHbug #23670 */
4093 if (oldspeed == USB_SPEED_LOW)
4094 delay = HUB_LONG_RESET_TIME;
4096 mutex_lock(&usb_address0_mutex);
4098 /* Reset the device; full speed may morph to high speed */
4099 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4100 retval = hub_port_reset(hub, port1, udev, delay, false);
4101 if (retval < 0) /* error or disconnect */
4103 /* success, speed is known */
4107 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4108 dev_dbg(&udev->dev, "device reset changed speed!\n");
4111 oldspeed = udev->speed;
4113 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4114 * it's fixed size except for full speed devices.
4115 * For Wireless USB devices, ep0 max packet is always 512 (tho
4116 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4118 switch (udev->speed) {
4119 case USB_SPEED_SUPER:
4120 case USB_SPEED_WIRELESS: /* fixed at 512 */
4121 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4123 case USB_SPEED_HIGH: /* fixed at 64 */
4124 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4126 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4127 /* to determine the ep0 maxpacket size, try to read
4128 * the device descriptor to get bMaxPacketSize0 and
4129 * then correct our initial guess.
4131 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4133 case USB_SPEED_LOW: /* fixed at 8 */
4134 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4140 if (udev->speed == USB_SPEED_WIRELESS)
4141 speed = "variable speed Wireless";
4143 speed = usb_speed_string(udev->speed);
4145 if (udev->speed != USB_SPEED_SUPER)
4146 dev_info(&udev->dev,
4147 "%s %s USB device number %d using %s\n",
4148 (udev->config) ? "reset" : "new", speed,
4149 devnum, udev->bus->controller->driver->name);
4151 /* Set up TT records, if needed */
4153 udev->tt = hdev->tt;
4154 udev->ttport = hdev->ttport;
4155 } else if (udev->speed != USB_SPEED_HIGH
4156 && hdev->speed == USB_SPEED_HIGH) {
4158 dev_err(&udev->dev, "parent hub has no TT\n");
4162 udev->tt = &hub->tt;
4163 udev->ttport = port1;
4166 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4167 * Because device hardware and firmware is sometimes buggy in
4168 * this area, and this is how Linux has done it for ages.
4169 * Change it cautiously.
4171 * NOTE: If use_new_scheme() is true we will start by issuing
4172 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4173 * so it may help with some non-standards-compliant devices.
4174 * Otherwise we start with SET_ADDRESS and then try to read the
4175 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4178 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4179 bool did_new_scheme = false;
4181 if (use_new_scheme(udev, retry_counter)) {
4182 struct usb_device_descriptor *buf;
4185 did_new_scheme = true;
4186 retval = hub_enable_device(udev);
4190 #define GET_DESCRIPTOR_BUFSIZE 64
4191 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4197 /* Retry on all errors; some devices are flakey.
4198 * 255 is for WUSB devices, we actually need to use
4199 * 512 (WUSB1.0[4.8.1]).
4201 for (j = 0; j < 3; ++j) {
4202 buf->bMaxPacketSize0 = 0;
4203 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4204 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4205 USB_DT_DEVICE << 8, 0,
4206 buf, GET_DESCRIPTOR_BUFSIZE,
4207 initial_descriptor_timeout);
4208 switch (buf->bMaxPacketSize0) {
4209 case 8: case 16: case 32: case 64: case 255:
4210 if (buf->bDescriptorType ==
4224 udev->descriptor.bMaxPacketSize0 =
4225 buf->bMaxPacketSize0;
4228 retval = hub_port_reset(hub, port1, udev, delay, false);
4229 if (retval < 0) /* error or disconnect */
4231 if (oldspeed != udev->speed) {
4233 "device reset changed speed!\n");
4239 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4244 #undef GET_DESCRIPTOR_BUFSIZE
4248 * If device is WUSB, we already assigned an
4249 * unauthorized address in the Connect Ack sequence;
4250 * authorization will assign the final address.
4252 if (udev->wusb == 0) {
4253 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4254 retval = hub_set_address(udev, devnum);
4260 if (retval != -ENODEV)
4261 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4265 if (udev->speed == USB_SPEED_SUPER) {
4266 devnum = udev->devnum;
4267 dev_info(&udev->dev,
4268 "%s SuperSpeed USB device number %d using %s\n",
4269 (udev->config) ? "reset" : "new",
4270 devnum, udev->bus->controller->driver->name);
4273 /* cope with hardware quirkiness:
4274 * - let SET_ADDRESS settle, some device hardware wants it
4275 * - read ep0 maxpacket even for high and low speed,
4278 /* use_new_scheme() checks the speed which may have
4279 * changed since the initial look so we cache the result
4286 retval = usb_get_device_descriptor(udev, 8);
4288 if (retval != -ENODEV)
4290 "device descriptor read/8, error %d\n",
4302 if (hcd->phy && !hdev->parent)
4303 usb_phy_notify_connect(hcd->phy, udev->speed);
4306 * Some superspeed devices have finished the link training process
4307 * and attached to a superspeed hub port, but the device descriptor
4308 * got from those devices show they aren't superspeed devices. Warm
4309 * reset the port attached by the devices can fix them.
4311 if ((udev->speed == USB_SPEED_SUPER) &&
4312 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4313 dev_err(&udev->dev, "got a wrong device descriptor, "
4314 "warm reset device\n");
4315 hub_port_reset(hub, port1, udev,
4316 HUB_BH_RESET_TIME, true);
4321 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4322 udev->speed == USB_SPEED_SUPER)
4325 i = udev->descriptor.bMaxPacketSize0;
4326 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4327 if (udev->speed == USB_SPEED_LOW ||
4328 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4329 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4333 if (udev->speed == USB_SPEED_FULL)
4334 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4336 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4337 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4338 usb_ep0_reinit(udev);
4341 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4342 if (retval < (signed)sizeof(udev->descriptor)) {
4343 if (retval != -ENODEV)
4344 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4351 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4352 retval = usb_get_bos_descriptor(udev);
4354 udev->lpm_capable = usb_device_supports_lpm(udev);
4355 usb_set_lpm_parameters(udev);
4360 /* notify HCD that we have a device connected and addressed */
4361 if (hcd->driver->update_device)
4362 hcd->driver->update_device(hcd, udev);
4363 hub_set_initial_usb2_lpm_policy(udev);
4366 hub_port_disable(hub, port1, 0);
4367 update_devnum(udev, devnum); /* for disconnect processing */
4369 mutex_unlock(&usb_address0_mutex);
4374 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4376 struct usb_qualifier_descriptor *qual;
4379 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4382 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4386 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4387 qual, sizeof *qual);
4388 if (status == sizeof *qual) {
4389 dev_info(&udev->dev, "not running at top speed; "
4390 "connect to a high speed hub\n");
4391 /* hub LEDs are probably harder to miss than syslog */
4392 if (hub->has_indicators) {
4393 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4394 schedule_delayed_work (&hub->leds, 0);
4401 hub_power_remaining (struct usb_hub *hub)
4403 struct usb_device *hdev = hub->hdev;
4407 if (!hub->limited_power)
4410 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4411 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4412 struct usb_device *udev = hub->ports[port1 - 1]->child;
4418 if (hub_is_superspeed(udev))
4424 * Unconfigured devices may not use more than one unit load,
4425 * or 8mA for OTG ports
4427 if (udev->actconfig)
4428 delta = usb_get_max_power(udev, udev->actconfig);
4429 else if (port1 != udev->bus->otg_port || hdev->parent)
4433 if (delta > hub->mA_per_port)
4434 dev_warn(&udev->dev,
4435 "%dmA is over %umA budget for port %d!\n",
4436 delta, hub->mA_per_port, port1);
4439 if (remaining < 0) {
4440 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4447 /* Handle physical or logical connection change events.
4448 * This routine is called when:
4449 * a port connection-change occurs;
4450 * a port enable-change occurs (often caused by EMI);
4451 * usb_reset_and_verify_device() encounters changed descriptors (as from
4452 * a firmware download)
4453 * caller already locked the hub
4455 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4456 u16 portstatus, u16 portchange)
4458 struct usb_device *hdev = hub->hdev;
4459 struct device *hub_dev = hub->intfdev;
4460 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4461 struct usb_device *udev;
4466 "port %d, status %04x, change %04x, %s\n",
4467 port1, portstatus, portchange, portspeed(hub, portstatus));
4469 if (hub->has_indicators) {
4470 set_port_led(hub, port1, HUB_LED_AUTO);
4471 hub->indicator[port1-1] = INDICATOR_AUTO;
4474 #ifdef CONFIG_USB_OTG
4475 /* during HNP, don't repeat the debounce */
4476 if (hdev->bus->is_b_host)
4477 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4478 USB_PORT_STAT_C_ENABLE);
4481 /* Try to resuscitate an existing device */
4482 udev = hub->ports[port1 - 1]->child;
4483 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4484 udev->state != USB_STATE_NOTATTACHED) {
4485 usb_lock_device(udev);
4486 if (portstatus & USB_PORT_STAT_ENABLE) {
4487 status = 0; /* Nothing to do */
4489 #ifdef CONFIG_PM_RUNTIME
4490 } else if (udev->state == USB_STATE_SUSPENDED &&
4491 udev->persist_enabled) {
4492 /* For a suspended device, treat this as a
4493 * remote wakeup event.
4495 status = usb_remote_wakeup(udev);
4499 status = -ENODEV; /* Don't resuscitate */
4501 usb_unlock_device(udev);
4504 clear_bit(port1, hub->change_bits);
4509 /* Disconnect any existing devices under this port */
4511 if (hcd->phy && !hdev->parent &&
4512 !(portstatus & USB_PORT_STAT_CONNECTION))
4513 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4514 usb_disconnect(&hub->ports[port1 - 1]->child);
4516 clear_bit(port1, hub->change_bits);
4518 /* We can forget about a "removed" device when there's a physical
4519 * disconnect or the connect status changes.
4521 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4522 (portchange & USB_PORT_STAT_C_CONNECTION))
4523 clear_bit(port1, hub->removed_bits);
4525 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4526 USB_PORT_STAT_C_ENABLE)) {
4527 status = hub_port_debounce_be_stable(hub, port1);
4529 if (status != -ENODEV && printk_ratelimit())
4530 dev_err(hub_dev, "connect-debounce failed, "
4531 "port %d disabled\n", port1);
4532 portstatus &= ~USB_PORT_STAT_CONNECTION;
4534 portstatus = status;
4538 /* Return now if debouncing failed or nothing is connected or
4539 * the device was "removed".
4541 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4542 test_bit(port1, hub->removed_bits)) {
4544 /* maybe switch power back on (e.g. root hub was reset) */
4545 if (hub_is_port_power_switchable(hub)
4546 && !port_is_power_on(hub, portstatus))
4547 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4549 if (portstatus & USB_PORT_STAT_ENABLE)
4553 if (hub_is_superspeed(hub->hdev))
4559 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4561 /* reallocate for each attempt, since references
4562 * to the previous one can escape in various ways
4564 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4567 "couldn't allocate port %d usb_device\n",
4572 usb_set_device_state(udev, USB_STATE_POWERED);
4573 udev->bus_mA = hub->mA_per_port;
4574 udev->level = hdev->level + 1;
4575 udev->wusb = hub_is_wusb(hub);
4577 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4578 if (hub_is_superspeed(hub->hdev))
4579 udev->speed = USB_SPEED_SUPER;
4581 udev->speed = USB_SPEED_UNKNOWN;
4583 choose_devnum(udev);
4584 if (udev->devnum <= 0) {
4585 status = -ENOTCONN; /* Don't retry */
4589 /* reset (non-USB 3.0 devices) and get descriptor */
4590 status = hub_port_init(hub, udev, port1, i);
4594 usb_detect_quirks(udev);
4595 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4598 /* consecutive bus-powered hubs aren't reliable; they can
4599 * violate the voltage drop budget. if the new child has
4600 * a "powered" LED, users should notice we didn't enable it
4601 * (without reading syslog), even without per-port LEDs
4604 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4605 && udev->bus_mA <= unit_load) {
4608 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4611 dev_dbg(&udev->dev, "get status %d ?\n", status);
4614 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4616 "can't connect bus-powered hub "
4618 if (hub->has_indicators) {
4619 hub->indicator[port1-1] =
4620 INDICATOR_AMBER_BLINK;
4621 schedule_delayed_work (&hub->leds, 0);
4623 status = -ENOTCONN; /* Don't retry */
4628 /* check for devices running slower than they could */
4629 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4630 && udev->speed == USB_SPEED_FULL
4631 && highspeed_hubs != 0)
4632 check_highspeed (hub, udev, port1);
4634 /* Store the parent's children[] pointer. At this point
4635 * udev becomes globally accessible, although presumably
4636 * no one will look at it until hdev is unlocked.
4640 /* We mustn't add new devices if the parent hub has
4641 * been disconnected; we would race with the
4642 * recursively_mark_NOTATTACHED() routine.
4644 spin_lock_irq(&device_state_lock);
4645 if (hdev->state == USB_STATE_NOTATTACHED)
4648 hub->ports[port1 - 1]->child = udev;
4649 spin_unlock_irq(&device_state_lock);
4651 /* Run it through the hoops (find a driver, etc) */
4653 status = usb_new_device(udev);
4655 spin_lock_irq(&device_state_lock);
4656 hub->ports[port1 - 1]->child = NULL;
4657 spin_unlock_irq(&device_state_lock);
4664 status = hub_power_remaining(hub);
4666 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4671 hub_port_disable(hub, port1, 1);
4673 usb_ep0_reinit(udev);
4674 release_devnum(udev);
4677 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4680 if (hub->hdev->parent ||
4681 !hcd->driver->port_handed_over ||
4682 !(hcd->driver->port_handed_over)(hcd, port1)) {
4683 if (status != -ENOTCONN && status != -ENODEV)
4684 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4689 hub_port_disable(hub, port1, 1);
4690 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4691 hcd->driver->relinquish_port(hcd, port1);
4694 /* Returns 1 if there was a remote wakeup and a connect status change. */
4695 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4696 u16 portstatus, u16 portchange)
4698 struct usb_device *hdev;
4699 struct usb_device *udev;
4700 int connect_change = 0;
4704 udev = hub->ports[port - 1]->child;
4705 if (!hub_is_superspeed(hdev)) {
4706 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4708 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4710 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4711 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4717 /* TRSMRCY = 10 msec */
4720 usb_lock_device(udev);
4721 ret = usb_remote_wakeup(udev);
4722 usb_unlock_device(udev);
4727 hub_port_disable(hub, port, 1);
4729 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4731 return connect_change;
4734 static void hub_events(void)
4736 struct list_head *tmp;
4737 struct usb_device *hdev;
4738 struct usb_interface *intf;
4739 struct usb_hub *hub;
4740 struct device *hub_dev;
4746 int connect_change, wakeup_change;
4749 * We restart the list every time to avoid a deadlock with
4750 * deleting hubs downstream from this one. This should be
4751 * safe since we delete the hub from the event list.
4752 * Not the most efficient, but avoids deadlocks.
4756 /* Grab the first entry at the beginning of the list */
4757 spin_lock_irq(&hub_event_lock);
4758 if (list_empty(&hub_event_list)) {
4759 spin_unlock_irq(&hub_event_lock);
4763 tmp = hub_event_list.next;
4766 hub = list_entry(tmp, struct usb_hub, event_list);
4767 kref_get(&hub->kref);
4770 spin_unlock_irq(&hub_event_lock);
4772 hub_dev = hub->intfdev;
4773 intf = to_usb_interface(hub_dev);
4774 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4775 hdev->state, hdev->maxchild,
4776 /* NOTE: expects max 15 ports... */
4777 (u16) hub->change_bits[0],
4778 (u16) hub->event_bits[0]);
4780 /* Lock the device, then check to see if we were
4781 * disconnected while waiting for the lock to succeed. */
4782 usb_lock_device(hdev);
4783 if (unlikely(hub->disconnected))
4784 goto loop_disconnected;
4786 /* If the hub has died, clean up after it */
4787 if (hdev->state == USB_STATE_NOTATTACHED) {
4788 hub->error = -ENODEV;
4789 hub_quiesce(hub, HUB_DISCONNECT);
4794 ret = usb_autopm_get_interface(intf);
4796 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4800 /* If this is an inactive hub, do nothing */
4805 dev_dbg (hub_dev, "resetting for error %d\n",
4808 ret = usb_reset_device(hdev);
4811 "error resetting hub: %d\n", ret);
4819 /* deal with port status changes */
4820 for (i = 1; i <= hdev->maxchild; i++) {
4821 struct usb_device *udev = hub->ports[i - 1]->child;
4823 if (test_bit(i, hub->busy_bits))
4825 connect_change = test_bit(i, hub->change_bits);
4826 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4827 if (!test_and_clear_bit(i, hub->event_bits) &&
4828 !connect_change && !wakeup_change)
4831 ret = hub_port_status(hub, i,
4832 &portstatus, &portchange);
4836 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4837 usb_clear_port_feature(hdev, i,
4838 USB_PORT_FEAT_C_CONNECTION);
4842 if (portchange & USB_PORT_STAT_C_ENABLE) {
4843 if (!connect_change)
4845 "port %d enable change, "
4848 usb_clear_port_feature(hdev, i,
4849 USB_PORT_FEAT_C_ENABLE);
4852 * EM interference sometimes causes badly
4853 * shielded USB devices to be shutdown by
4854 * the hub, this hack enables them again.
4855 * Works at least with mouse driver.
4857 if (!(portstatus & USB_PORT_STAT_ENABLE)
4859 && hub->ports[i - 1]->child) {
4862 "disabled by hub (EMI?), "
4869 if (hub_handle_remote_wakeup(hub, i,
4870 portstatus, portchange))
4873 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4877 dev_dbg(hub_dev, "over-current change on port "
4879 usb_clear_port_feature(hdev, i,
4880 USB_PORT_FEAT_C_OVER_CURRENT);
4881 msleep(100); /* Cool down */
4882 hub_power_on(hub, true);
4883 hub_port_status(hub, i, &status, &unused);
4884 if (status & USB_PORT_STAT_OVERCURRENT)
4885 dev_err(hub_dev, "over-current "
4886 "condition on port %d\n", i);
4889 if (portchange & USB_PORT_STAT_C_RESET) {
4891 "reset change on port %d\n",
4893 usb_clear_port_feature(hdev, i,
4894 USB_PORT_FEAT_C_RESET);
4896 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4897 hub_is_superspeed(hub->hdev)) {
4899 "warm reset change on port %d\n",
4901 usb_clear_port_feature(hdev, i,
4902 USB_PORT_FEAT_C_BH_PORT_RESET);
4904 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4905 usb_clear_port_feature(hub->hdev, i,
4906 USB_PORT_FEAT_C_PORT_LINK_STATE);
4908 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4910 "config error on port %d\n",
4912 usb_clear_port_feature(hub->hdev, i,
4913 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4916 /* Warm reset a USB3 protocol port if it's in
4917 * SS.Inactive state.
4919 if (hub_port_warm_reset_required(hub, portstatus)) {
4922 dev_dbg(hub_dev, "warm reset port %d\n", i);
4924 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4925 udev->state == USB_STATE_NOTATTACHED) {
4926 status = hub_port_reset(hub, i,
4927 NULL, HUB_BH_RESET_TIME,
4930 hub_port_disable(hub, i, 1);
4932 usb_lock_device(udev);
4933 status = usb_reset_device(udev);
4934 usb_unlock_device(udev);
4938 * On disconnect USB3 protocol ports transit from U0 to
4939 * SS.Inactive to Rx.Detect. If this happens a warm-
4940 * reset is not needed, but a (re)connect may happen
4941 * before khubd runs and sees the disconnect, and the
4942 * device may be an unknown state.
4944 * If the port went through SS.Inactive without khubd
4945 * seeing it the C_LINK_STATE change flag will be set,
4946 * and we reset the dev to put it in a known state.
4948 } else if (udev && hub_is_superspeed(hub->hdev) &&
4949 (portchange & USB_PORT_STAT_C_LINK_STATE) &&
4950 (portstatus & USB_PORT_STAT_CONNECTION)) {
4951 usb_lock_device(udev);
4952 usb_reset_device(udev);
4953 usb_unlock_device(udev);
4958 hub_port_connect_change(hub, i,
4959 portstatus, portchange);
4962 /* deal with hub status changes */
4963 if (test_and_clear_bit(0, hub->event_bits) == 0)
4965 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4966 dev_err (hub_dev, "get_hub_status failed\n");
4968 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4969 dev_dbg (hub_dev, "power change\n");
4970 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4971 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4972 /* FIXME: Is this always true? */
4973 hub->limited_power = 1;
4975 hub->limited_power = 0;
4977 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4981 dev_dbg(hub_dev, "over-current change\n");
4982 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4983 msleep(500); /* Cool down */
4984 hub_power_on(hub, true);
4985 hub_hub_status(hub, &status, &unused);
4986 if (status & HUB_STATUS_OVERCURRENT)
4987 dev_err(hub_dev, "over-current "
4993 /* Balance the usb_autopm_get_interface() above */
4994 usb_autopm_put_interface_no_suspend(intf);
4996 /* Balance the usb_autopm_get_interface_no_resume() in
4997 * kick_khubd() and allow autosuspend.
4999 usb_autopm_put_interface(intf);
5001 usb_unlock_device(hdev);
5003 kref_put(&hub->kref, hub_release);
5005 } /* end while (1) */
5008 static int hub_thread(void *__unused)
5010 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
5011 * port handover. Otherwise it might see that a full-speed device
5012 * was gone before the EHCI controller had handed its port over to
5013 * the companion full-speed controller.
5019 wait_event_freezable(khubd_wait,
5020 !list_empty(&hub_event_list) ||
5021 kthread_should_stop());
5022 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
5024 pr_debug("%s: khubd exiting\n", usbcore_name);
5028 static const struct usb_device_id hub_id_table[] = {
5029 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5030 | USB_DEVICE_ID_MATCH_INT_CLASS,
5031 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5032 .bInterfaceClass = USB_CLASS_HUB,
5033 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5034 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5035 .bDeviceClass = USB_CLASS_HUB},
5036 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5037 .bInterfaceClass = USB_CLASS_HUB},
5038 { } /* Terminating entry */
5041 MODULE_DEVICE_TABLE (usb, hub_id_table);
5043 static struct usb_driver hub_driver = {
5046 .disconnect = hub_disconnect,
5047 .suspend = hub_suspend,
5048 .resume = hub_resume,
5049 .reset_resume = hub_reset_resume,
5050 .pre_reset = hub_pre_reset,
5051 .post_reset = hub_post_reset,
5052 .unlocked_ioctl = hub_ioctl,
5053 .id_table = hub_id_table,
5054 .supports_autosuspend = 1,
5057 int usb_hub_init(void)
5059 if (usb_register(&hub_driver) < 0) {
5060 printk(KERN_ERR "%s: can't register hub driver\n",
5065 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5066 if (!IS_ERR(khubd_task))
5069 /* Fall through if kernel_thread failed */
5070 usb_deregister(&hub_driver);
5071 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5076 void usb_hub_cleanup(void)
5078 kthread_stop(khubd_task);
5081 * Hub resources are freed for us by usb_deregister. It calls
5082 * usb_driver_purge on every device which in turn calls that
5083 * devices disconnect function if it is using this driver.
5084 * The hub_disconnect function takes care of releasing the
5085 * individual hub resources. -greg
5087 usb_deregister(&hub_driver);
5088 } /* usb_hub_cleanup() */
5090 static int descriptors_changed(struct usb_device *udev,
5091 struct usb_device_descriptor *old_device_descriptor,
5092 struct usb_host_bos *old_bos)
5096 unsigned serial_len = 0;
5098 unsigned old_length;
5102 if (memcmp(&udev->descriptor, old_device_descriptor,
5103 sizeof(*old_device_descriptor)) != 0)
5106 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5109 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5110 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5112 if (memcmp(udev->bos->desc, old_bos->desc, len))
5116 /* Since the idVendor, idProduct, and bcdDevice values in the
5117 * device descriptor haven't changed, we will assume the
5118 * Manufacturer and Product strings haven't changed either.
5119 * But the SerialNumber string could be different (e.g., a
5120 * different flash card of the same brand).
5123 serial_len = strlen(udev->serial) + 1;
5126 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5127 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5128 len = max(len, old_length);
5131 buf = kmalloc(len, GFP_NOIO);
5133 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5134 /* assume the worst */
5137 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5138 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5139 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5141 if (length != old_length) {
5142 dev_dbg(&udev->dev, "config index %d, error %d\n",
5147 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5149 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5151 ((struct usb_config_descriptor *) buf)->
5152 bConfigurationValue);
5158 if (!changed && serial_len) {
5159 length = usb_string(udev, udev->descriptor.iSerialNumber,
5161 if (length + 1 != serial_len) {
5162 dev_dbg(&udev->dev, "serial string error %d\n",
5165 } else if (memcmp(buf, udev->serial, length) != 0) {
5166 dev_dbg(&udev->dev, "serial string changed\n");
5176 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5177 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5179 * WARNING - don't use this routine to reset a composite device
5180 * (one with multiple interfaces owned by separate drivers)!
5181 * Use usb_reset_device() instead.
5183 * Do a port reset, reassign the device's address, and establish its
5184 * former operating configuration. If the reset fails, or the device's
5185 * descriptors change from their values before the reset, or the original
5186 * configuration and altsettings cannot be restored, a flag will be set
5187 * telling khubd to pretend the device has been disconnected and then
5188 * re-connected. All drivers will be unbound, and the device will be
5189 * re-enumerated and probed all over again.
5191 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5192 * flagged for logical disconnection, or some other negative error code
5193 * if the reset wasn't even attempted.
5196 * The caller must own the device lock. For example, it's safe to use
5197 * this from a driver probe() routine after downloading new firmware.
5198 * For calls that might not occur during probe(), drivers should lock
5199 * the device using usb_lock_device_for_reset().
5201 * Locking exception: This routine may also be called from within an
5202 * autoresume handler. Such usage won't conflict with other tasks
5203 * holding the device lock because these tasks should always call
5204 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5206 static int usb_reset_and_verify_device(struct usb_device *udev)
5208 struct usb_device *parent_hdev = udev->parent;
5209 struct usb_hub *parent_hub;
5210 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5211 struct usb_device_descriptor descriptor = udev->descriptor;
5212 struct usb_host_bos *bos;
5214 int port1 = udev->portnum;
5216 if (udev->state == USB_STATE_NOTATTACHED ||
5217 udev->state == USB_STATE_SUSPENDED) {
5218 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5224 /* this requires hcd-specific logic; see ohci_restart() */
5225 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5228 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5230 /* Disable USB2 hardware LPM.
5231 * It will be re-enabled by the enumeration process.
5233 if (udev->usb2_hw_lpm_enabled == 1)
5234 usb_set_usb2_hardware_lpm(udev, 0);
5239 /* Disable LPM and LTM while we reset the device and reinstall the alt
5240 * settings. Device-initiated LPM settings, and system exit latency
5241 * settings are cleared when the device is reset, so we have to set
5244 ret = usb_unlocked_disable_lpm(udev);
5246 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5249 ret = usb_disable_ltm(udev);
5251 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5256 set_bit(port1, parent_hub->busy_bits);
5257 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5259 /* ep0 maxpacket size may change; let the HCD know about it.
5260 * Other endpoints will be handled by re-enumeration. */
5261 usb_ep0_reinit(udev);
5262 ret = hub_port_init(parent_hub, udev, port1, i);
5263 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5266 clear_bit(port1, parent_hub->busy_bits);
5271 /* Device might have changed firmware (DFU or similar) */
5272 if (descriptors_changed(udev, &descriptor, bos)) {
5273 dev_info(&udev->dev, "device firmware changed\n");
5274 udev->descriptor = descriptor; /* for disconnect() calls */
5278 /* Restore the device's previous configuration */
5279 if (!udev->actconfig)
5282 mutex_lock(hcd->bandwidth_mutex);
5283 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5285 dev_warn(&udev->dev,
5286 "Busted HC? Not enough HCD resources for "
5287 "old configuration.\n");
5288 mutex_unlock(hcd->bandwidth_mutex);
5291 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5292 USB_REQ_SET_CONFIGURATION, 0,
5293 udev->actconfig->desc.bConfigurationValue, 0,
5294 NULL, 0, USB_CTRL_SET_TIMEOUT);
5297 "can't restore configuration #%d (error=%d)\n",
5298 udev->actconfig->desc.bConfigurationValue, ret);
5299 mutex_unlock(hcd->bandwidth_mutex);
5302 mutex_unlock(hcd->bandwidth_mutex);
5303 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5305 /* Put interfaces back into the same altsettings as before.
5306 * Don't bother to send the Set-Interface request for interfaces
5307 * that were already in altsetting 0; besides being unnecessary,
5308 * many devices can't handle it. Instead just reset the host-side
5311 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5312 struct usb_host_config *config = udev->actconfig;
5313 struct usb_interface *intf = config->interface[i];
5314 struct usb_interface_descriptor *desc;
5316 desc = &intf->cur_altsetting->desc;
5317 if (desc->bAlternateSetting == 0) {
5318 usb_disable_interface(udev, intf, true);
5319 usb_enable_interface(udev, intf, true);
5322 /* Let the bandwidth allocation function know that this
5323 * device has been reset, and it will have to use
5324 * alternate setting 0 as the current alternate setting.
5326 intf->resetting_device = 1;
5327 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5328 desc->bAlternateSetting);
5329 intf->resetting_device = 0;
5332 dev_err(&udev->dev, "failed to restore interface %d "
5333 "altsetting %d (error=%d)\n",
5334 desc->bInterfaceNumber,
5335 desc->bAlternateSetting,
5342 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5343 usb_set_usb2_hardware_lpm(udev, 1);
5344 usb_unlocked_enable_lpm(udev);
5345 usb_enable_ltm(udev);
5346 usb_release_bos_descriptor(udev);
5351 /* LPM state doesn't matter when we're about to destroy the device. */
5352 hub_port_logical_disconnect(parent_hub, port1);
5353 usb_release_bos_descriptor(udev);
5359 * usb_reset_device - warn interface drivers and perform a USB port reset
5360 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5362 * Warns all drivers bound to registered interfaces (using their pre_reset
5363 * method), performs the port reset, and then lets the drivers know that
5364 * the reset is over (using their post_reset method).
5366 * Return: The same as for usb_reset_and_verify_device().
5369 * The caller must own the device lock. For example, it's safe to use
5370 * this from a driver probe() routine after downloading new firmware.
5371 * For calls that might not occur during probe(), drivers should lock
5372 * the device using usb_lock_device_for_reset().
5374 * If an interface is currently being probed or disconnected, we assume
5375 * its driver knows how to handle resets. For all other interfaces,
5376 * if the driver doesn't have pre_reset and post_reset methods then
5377 * we attempt to unbind it and rebind afterward.
5379 int usb_reset_device(struct usb_device *udev)
5383 unsigned int noio_flag;
5384 struct usb_host_config *config = udev->actconfig;
5386 if (udev->state == USB_STATE_NOTATTACHED ||
5387 udev->state == USB_STATE_SUSPENDED) {
5388 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5394 * Don't allocate memory with GFP_KERNEL in current
5395 * context to avoid possible deadlock if usb mass
5396 * storage interface or usbnet interface(iSCSI case)
5397 * is included in current configuration. The easist
5398 * approach is to do it for every device reset,
5399 * because the device 'memalloc_noio' flag may have
5400 * not been set before reseting the usb device.
5402 noio_flag = memalloc_noio_save();
5404 /* Prevent autosuspend during the reset */
5405 usb_autoresume_device(udev);
5408 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5409 struct usb_interface *cintf = config->interface[i];
5410 struct usb_driver *drv;
5413 if (cintf->dev.driver) {
5414 drv = to_usb_driver(cintf->dev.driver);
5415 if (drv->pre_reset && drv->post_reset)
5416 unbind = (drv->pre_reset)(cintf);
5417 else if (cintf->condition ==
5418 USB_INTERFACE_BOUND)
5421 usb_forced_unbind_intf(cintf);
5426 ret = usb_reset_and_verify_device(udev);
5429 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5430 struct usb_interface *cintf = config->interface[i];
5431 struct usb_driver *drv;
5432 int rebind = cintf->needs_binding;
5434 if (!rebind && cintf->dev.driver) {
5435 drv = to_usb_driver(cintf->dev.driver);
5436 if (drv->post_reset)
5437 rebind = (drv->post_reset)(cintf);
5438 else if (cintf->condition ==
5439 USB_INTERFACE_BOUND)
5442 cintf->needs_binding = 1;
5445 usb_unbind_and_rebind_marked_interfaces(udev);
5448 usb_autosuspend_device(udev);
5449 memalloc_noio_restore(noio_flag);
5452 EXPORT_SYMBOL_GPL(usb_reset_device);
5456 * usb_queue_reset_device - Reset a USB device from an atomic context
5457 * @iface: USB interface belonging to the device to reset
5459 * This function can be used to reset a USB device from an atomic
5460 * context, where usb_reset_device() won't work (as it blocks).
5462 * Doing a reset via this method is functionally equivalent to calling
5463 * usb_reset_device(), except for the fact that it is delayed to a
5464 * workqueue. This means that any drivers bound to other interfaces
5465 * might be unbound, as well as users from usbfs in user space.
5469 * - Scheduling two resets at the same time from two different drivers
5470 * attached to two different interfaces of the same device is
5471 * possible; depending on how the driver attached to each interface
5472 * handles ->pre_reset(), the second reset might happen or not.
5474 * - If a driver is unbound and it had a pending reset, the reset will
5477 * - This function can be called during .probe() or .disconnect()
5478 * times. On return from .disconnect(), any pending resets will be
5481 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5484 * NOTE: We don't do any reference count tracking because it is not
5485 * needed. The lifecycle of the work_struct is tied to the
5486 * usb_interface. Before destroying the interface we cancel the
5487 * work_struct, so the fact that work_struct is queued and or
5488 * running means the interface (and thus, the device) exist and
5491 void usb_queue_reset_device(struct usb_interface *iface)
5493 schedule_work(&iface->reset_ws);
5495 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5498 * usb_hub_find_child - Get the pointer of child device
5499 * attached to the port which is specified by @port1.
5500 * @hdev: USB device belonging to the usb hub
5501 * @port1: port num to indicate which port the child device
5504 * USB drivers call this function to get hub's child device
5507 * Return: %NULL if input param is invalid and
5508 * child's usb_device pointer if non-NULL.
5510 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5513 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5515 if (port1 < 1 || port1 > hdev->maxchild)
5517 return hub->ports[port1 - 1]->child;
5519 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5522 * usb_set_hub_port_connect_type - set hub port connect type.
5523 * @hdev: USB device belonging to the usb hub
5524 * @port1: port num of the port
5525 * @type: connect type of the port
5527 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5528 enum usb_port_connect_type type)
5530 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5533 hub->ports[port1 - 1]->connect_type = type;
5537 * usb_get_hub_port_connect_type - Get the port's connect type
5538 * @hdev: USB device belonging to the usb hub
5539 * @port1: port num of the port
5541 * Return: The connect type of the port if successful. Or
5542 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5544 enum usb_port_connect_type
5545 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5547 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5550 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5552 return hub->ports[port1 - 1]->connect_type;
5555 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5556 struct usb_hub_descriptor *desc)
5558 enum usb_port_connect_type connect_type;
5561 if (!hub_is_superspeed(hdev)) {
5562 for (i = 1; i <= hdev->maxchild; i++) {
5563 connect_type = usb_get_hub_port_connect_type(hdev, i);
5565 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5566 u8 mask = 1 << (i%8);
5568 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5569 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5571 desc->u.hs.DeviceRemovable[i/8] |= mask;
5576 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5578 for (i = 1; i <= hdev->maxchild; i++) {
5579 connect_type = usb_get_hub_port_connect_type(hdev, i);
5581 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5584 if (!(port_removable & mask)) {
5585 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5587 port_removable |= mask;
5592 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5598 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5599 * @hdev: USB device belonging to the usb hub
5600 * @port1: port num of the port
5602 * Return: Port's acpi handle if successful, %NULL if params are
5605 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5608 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5613 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);