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 /* if we are in debug mode, always announce new devices */
38 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
39 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
43 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
44 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
46 static inline int hub_is_superspeed(struct usb_device *hdev)
48 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
51 /* Protect struct usb_device->state and ->children members
52 * Note: Both are also protected by ->dev.sem, except that ->state can
53 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
54 static DEFINE_SPINLOCK(device_state_lock);
56 /* khubd's worklist and its lock */
57 static DEFINE_SPINLOCK(hub_event_lock);
58 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
61 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
63 static struct task_struct *khubd_task;
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights = 0;
67 module_param (blinkenlights, bool, S_IRUGO);
68 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
76 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
77 MODULE_PARM_DESC(initial_descriptor_timeout,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first = 0;
96 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
97 MODULE_PARM_DESC(old_scheme_first,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes = 1;
101 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
102 MODULE_PARM_DESC(use_both_schemes,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static int usb_reset_and_verify_device(struct usb_device *udev);
118 static inline char *portspeed(struct usb_hub *hub, int portstatus)
120 if (hub_is_superspeed(hub->hdev))
122 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
124 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
130 /* Note that hdev or one of its children must be locked! */
131 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
133 if (!hdev || !hdev->actconfig || !hdev->maxchild)
135 return usb_get_intfdata(hdev->actconfig->interface[0]);
138 int usb_device_supports_lpm(struct usb_device *udev)
140 /* USB 2.1 (and greater) devices indicate LPM support through
141 * their USB 2.0 Extended Capabilities BOS descriptor.
143 if (udev->speed == USB_SPEED_HIGH) {
144 if (udev->bos->ext_cap &&
146 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
151 /* All USB 3.0 must support LPM, but we need their max exit latency
152 * information from the SuperSpeed Extended Capabilities BOS descriptor.
154 if (!udev->bos->ss_cap) {
155 dev_warn(&udev->dev, "No LPM exit latency info found. "
156 "Power management will be impacted.\n");
160 /* udev is root hub */
164 if (udev->parent->lpm_capable)
167 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
168 "Power management will be impacted.\n");
173 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
176 static void usb_set_lpm_mel(struct usb_device *udev,
177 struct usb3_lpm_parameters *udev_lpm_params,
178 unsigned int udev_exit_latency,
180 struct usb3_lpm_parameters *hub_lpm_params,
181 unsigned int hub_exit_latency)
183 unsigned int total_mel;
184 unsigned int device_mel;
185 unsigned int hub_mel;
188 * Calculate the time it takes to transition all links from the roothub
189 * to the parent hub into U0. The parent hub must then decode the
190 * packet (hub header decode latency) to figure out which port it was
193 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
194 * means 0.1us). Multiply that by 100 to get nanoseconds.
196 total_mel = hub_lpm_params->mel +
197 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
200 * How long will it take to transition the downstream hub's port into
201 * U0? The greater of either the hub exit latency or the device exit
204 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
205 * Multiply that by 1000 to get nanoseconds.
207 device_mel = udev_exit_latency * 1000;
208 hub_mel = hub_exit_latency * 1000;
209 if (device_mel > hub_mel)
210 total_mel += device_mel;
212 total_mel += hub_mel;
214 udev_lpm_params->mel = total_mel;
218 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
219 * a transition from either U1 or U2.
221 static void usb_set_lpm_pel(struct usb_device *udev,
222 struct usb3_lpm_parameters *udev_lpm_params,
223 unsigned int udev_exit_latency,
225 struct usb3_lpm_parameters *hub_lpm_params,
226 unsigned int hub_exit_latency,
227 unsigned int port_to_port_exit_latency)
229 unsigned int first_link_pel;
230 unsigned int hub_pel;
233 * First, the device sends an LFPS to transition the link between the
234 * device and the parent hub into U0. The exit latency is the bigger of
235 * the device exit latency or the hub exit latency.
237 if (udev_exit_latency > hub_exit_latency)
238 first_link_pel = udev_exit_latency * 1000;
240 first_link_pel = hub_exit_latency * 1000;
243 * When the hub starts to receive the LFPS, there is a slight delay for
244 * it to figure out that one of the ports is sending an LFPS. Then it
245 * will forward the LFPS to its upstream link. The exit latency is the
246 * delay, plus the PEL that we calculated for this hub.
248 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
251 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
252 * is the greater of the two exit latencies.
254 if (first_link_pel > hub_pel)
255 udev_lpm_params->pel = first_link_pel;
257 udev_lpm_params->pel = hub_pel;
261 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
262 * when a device initiates a transition to U0, until when it will receive the
263 * first packet from the host controller.
265 * Section C.1.5.1 describes the four components to this:
267 * - t2: time for the ERDY to make it from the device to the host.
268 * - t3: a host-specific delay to process the ERDY.
269 * - t4: time for the packet to make it from the host to the device.
271 * t3 is specific to both the xHCI host and the platform the host is integrated
272 * into. The Intel HW folks have said it's negligible, FIXME if a different
273 * vendor says otherwise.
275 static void usb_set_lpm_sel(struct usb_device *udev,
276 struct usb3_lpm_parameters *udev_lpm_params)
278 struct usb_device *parent;
279 unsigned int num_hubs;
280 unsigned int total_sel;
282 /* t1 = device PEL */
283 total_sel = udev_lpm_params->pel;
284 /* How many external hubs are in between the device & the root port. */
285 for (parent = udev->parent, num_hubs = 0; parent->parent;
286 parent = parent->parent)
288 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
290 total_sel += 2100 + 250 * (num_hubs - 1);
292 /* t4 = 250ns * num_hubs */
293 total_sel += 250 * num_hubs;
295 udev_lpm_params->sel = total_sel;
298 static void usb_set_lpm_parameters(struct usb_device *udev)
301 unsigned int port_to_port_delay;
302 unsigned int udev_u1_del;
303 unsigned int udev_u2_del;
304 unsigned int hub_u1_del;
305 unsigned int hub_u2_del;
307 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
310 hub = usb_hub_to_struct_hub(udev->parent);
311 /* It doesn't take time to transition the roothub into U0, since it
312 * doesn't have an upstream link.
317 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
318 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
319 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
320 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
322 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
323 hub, &udev->parent->u1_params, hub_u1_del);
325 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
326 hub, &udev->parent->u2_params, hub_u2_del);
329 * Appendix C, section C.2.2.2, says that there is a slight delay from
330 * when the parent hub notices the downstream port is trying to
331 * transition to U0 to when the hub initiates a U0 transition on its
332 * upstream port. The section says the delays are tPort2PortU1EL and
333 * tPort2PortU2EL, but it doesn't define what they are.
335 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
336 * about the same delays. Use the maximum delay calculations from those
337 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
338 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
339 * assume the device exit latencies they are talking about are the hub
342 * What do we do if the U2 exit latency is less than the U1 exit
343 * latency? It's possible, although not likely...
345 port_to_port_delay = 1;
347 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
348 hub, &udev->parent->u1_params, hub_u1_del,
351 if (hub_u2_del > hub_u1_del)
352 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
354 port_to_port_delay = 1 + hub_u1_del;
356 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
357 hub, &udev->parent->u2_params, hub_u2_del,
360 /* Now that we've got PEL, calculate SEL. */
361 usb_set_lpm_sel(udev, &udev->u1_params);
362 usb_set_lpm_sel(udev, &udev->u2_params);
365 /* USB 2.0 spec Section 11.24.4.5 */
366 static int get_hub_descriptor(struct usb_device *hdev, void *data)
371 if (hub_is_superspeed(hdev)) {
372 dtype = USB_DT_SS_HUB;
373 size = USB_DT_SS_HUB_SIZE;
376 size = sizeof(struct usb_hub_descriptor);
379 for (i = 0; i < 3; i++) {
380 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
381 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
382 dtype << 8, 0, data, size,
383 USB_CTRL_GET_TIMEOUT);
384 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
391 * USB 2.0 spec Section 11.24.2.1
393 static int clear_hub_feature(struct usb_device *hdev, int feature)
395 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
396 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
400 * USB 2.0 spec Section 11.24.2.2
402 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
404 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
405 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
410 * USB 2.0 spec Section 11.24.2.13
412 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
414 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
415 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
420 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
421 * for info about using port indicators
423 static void set_port_led(
429 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
430 USB_PORT_FEAT_INDICATOR);
432 dev_dbg (hub->intfdev,
433 "port %d indicator %s status %d\n",
435 ({ char *s; switch (selector) {
436 case HUB_LED_AMBER: s = "amber"; break;
437 case HUB_LED_GREEN: s = "green"; break;
438 case HUB_LED_OFF: s = "off"; break;
439 case HUB_LED_AUTO: s = "auto"; break;
440 default: s = "??"; break;
445 #define LED_CYCLE_PERIOD ((2*HZ)/3)
447 static void led_work (struct work_struct *work)
449 struct usb_hub *hub =
450 container_of(work, struct usb_hub, leds.work);
451 struct usb_device *hdev = hub->hdev;
453 unsigned changed = 0;
456 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
459 for (i = 0; i < hdev->maxchild; i++) {
460 unsigned selector, mode;
462 /* 30%-50% duty cycle */
464 switch (hub->indicator[i]) {
466 case INDICATOR_CYCLE:
468 selector = HUB_LED_AUTO;
469 mode = INDICATOR_AUTO;
471 /* blinking green = sw attention */
472 case INDICATOR_GREEN_BLINK:
473 selector = HUB_LED_GREEN;
474 mode = INDICATOR_GREEN_BLINK_OFF;
476 case INDICATOR_GREEN_BLINK_OFF:
477 selector = HUB_LED_OFF;
478 mode = INDICATOR_GREEN_BLINK;
480 /* blinking amber = hw attention */
481 case INDICATOR_AMBER_BLINK:
482 selector = HUB_LED_AMBER;
483 mode = INDICATOR_AMBER_BLINK_OFF;
485 case INDICATOR_AMBER_BLINK_OFF:
486 selector = HUB_LED_OFF;
487 mode = INDICATOR_AMBER_BLINK;
489 /* blink green/amber = reserved */
490 case INDICATOR_ALT_BLINK:
491 selector = HUB_LED_GREEN;
492 mode = INDICATOR_ALT_BLINK_OFF;
494 case INDICATOR_ALT_BLINK_OFF:
495 selector = HUB_LED_AMBER;
496 mode = INDICATOR_ALT_BLINK;
501 if (selector != HUB_LED_AUTO)
503 set_port_led(hub, i + 1, selector);
504 hub->indicator[i] = mode;
506 if (!changed && blinkenlights) {
508 cursor %= hdev->maxchild;
509 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
510 hub->indicator[cursor] = INDICATOR_CYCLE;
514 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
517 /* use a short timeout for hub/port status fetches */
518 #define USB_STS_TIMEOUT 1000
519 #define USB_STS_RETRIES 5
522 * USB 2.0 spec Section 11.24.2.6
524 static int get_hub_status(struct usb_device *hdev,
525 struct usb_hub_status *data)
527 int i, status = -ETIMEDOUT;
529 for (i = 0; i < USB_STS_RETRIES &&
530 (status == -ETIMEDOUT || status == -EPIPE); i++) {
531 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
532 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
533 data, sizeof(*data), USB_STS_TIMEOUT);
539 * USB 2.0 spec Section 11.24.2.7
541 static int get_port_status(struct usb_device *hdev, int port1,
542 struct usb_port_status *data)
544 int i, status = -ETIMEDOUT;
546 for (i = 0; i < USB_STS_RETRIES &&
547 (status == -ETIMEDOUT || status == -EPIPE); i++) {
548 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
549 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
550 data, sizeof(*data), USB_STS_TIMEOUT);
555 static int hub_port_status(struct usb_hub *hub, int port1,
556 u16 *status, u16 *change)
560 mutex_lock(&hub->status_mutex);
561 ret = get_port_status(hub->hdev, port1, &hub->status->port);
564 dev_err(hub->intfdev,
565 "%s failed (err = %d)\n", __func__, ret);
569 *status = le16_to_cpu(hub->status->port.wPortStatus);
570 *change = le16_to_cpu(hub->status->port.wPortChange);
574 mutex_unlock(&hub->status_mutex);
578 static void kick_khubd(struct usb_hub *hub)
582 spin_lock_irqsave(&hub_event_lock, flags);
583 if (!hub->disconnected && list_empty(&hub->event_list)) {
584 list_add_tail(&hub->event_list, &hub_event_list);
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub->intfdev));
589 wake_up(&khubd_wait);
591 spin_unlock_irqrestore(&hub_event_lock, flags);
594 void usb_kick_khubd(struct usb_device *hdev)
596 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
610 void usb_wakeup_notification(struct usb_device *hdev,
611 unsigned int portnum)
618 hub = usb_hub_to_struct_hub(hdev);
620 set_bit(portnum, hub->wakeup_bits);
624 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
626 /* completion function, fires on port status changes and various faults */
627 static void hub_irq(struct urb *urb)
629 struct usb_hub *hub = urb->context;
630 int status = urb->status;
635 case -ENOENT: /* synchronous unlink */
636 case -ECONNRESET: /* async unlink */
637 case -ESHUTDOWN: /* hardware going away */
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
642 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
643 if ((++hub->nerrors < 10) || hub->error)
648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
651 for (i = 0; i < urb->actual_length; ++i)
652 bits |= ((unsigned long) ((*hub->buffer)[i]))
654 hub->event_bits[0] = bits;
660 /* Something happened, let khubd figure it out */
667 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
668 && status != -ENODEV && status != -EPERM)
669 dev_err (hub->intfdev, "resubmit --> %d\n", status);
672 /* USB 2.0 spec Section 11.24.2.3 */
674 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
676 /* Need to clear both directions for control ep */
677 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
678 USB_ENDPOINT_XFER_CONTROL) {
679 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
680 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
681 devinfo ^ 0x8000, tt, NULL, 0, 1000);
685 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
686 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
696 static void hub_tt_work(struct work_struct *work)
698 struct usb_hub *hub =
699 container_of(work, struct usb_hub, tt.clear_work);
702 spin_lock_irqsave (&hub->tt.lock, flags);
703 while (!list_empty(&hub->tt.clear_list)) {
704 struct list_head *next;
705 struct usb_tt_clear *clear;
706 struct usb_device *hdev = hub->hdev;
707 const struct hc_driver *drv;
710 next = hub->tt.clear_list.next;
711 clear = list_entry (next, struct usb_tt_clear, clear_list);
712 list_del (&clear->clear_list);
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub->tt.lock, flags);
716 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
717 if (status && status != -ENODEV)
719 "clear tt %d (%04x) error %d\n",
720 clear->tt, clear->devinfo, status);
722 /* Tell the HCD, even if the operation failed */
723 drv = clear->hcd->driver;
724 if (drv->clear_tt_buffer_complete)
725 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
728 spin_lock_irqsave(&hub->tt.lock, flags);
730 spin_unlock_irqrestore (&hub->tt.lock, flags);
734 * usb_hub_set_port_power - control hub port's power state
735 * @hdev: USB device belonging to the usb hub
738 * @set: expected status
740 * call this function to control port's power via setting or
741 * clearing the port's PORT_POWER feature.
743 * Return: 0 if successful. A negative error code otherwise.
745 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
749 struct usb_port *port_dev = hub->ports[port1 - 1];
752 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
754 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
757 port_dev->power_is_on = set;
762 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
763 * @urb: an URB associated with the failed or incomplete split transaction
765 * High speed HCDs use this to tell the hub driver that some split control or
766 * bulk transaction failed in a way that requires clearing internal state of
767 * a transaction translator. This is normally detected (and reported) from
770 * It may not be possible for that hub to handle additional full (or low)
771 * speed transactions until that state is fully cleared out.
773 * Return: 0 if successful. A negative error code otherwise.
775 int usb_hub_clear_tt_buffer(struct urb *urb)
777 struct usb_device *udev = urb->dev;
778 int pipe = urb->pipe;
779 struct usb_tt *tt = udev->tt;
781 struct usb_tt_clear *clear;
783 /* we've got to cope with an arbitrary number of pending TT clears,
784 * since each TT has "at least two" buffers that can need it (and
785 * there can be many TTs per hub). even if they're uncommon.
787 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
788 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
789 /* FIXME recover somehow ... RESET_TT? */
793 /* info that CLEAR_TT_BUFFER needs */
794 clear->tt = tt->multi ? udev->ttport : 1;
795 clear->devinfo = usb_pipeendpoint (pipe);
796 clear->devinfo |= udev->devnum << 4;
797 clear->devinfo |= usb_pipecontrol (pipe)
798 ? (USB_ENDPOINT_XFER_CONTROL << 11)
799 : (USB_ENDPOINT_XFER_BULK << 11);
800 if (usb_pipein (pipe))
801 clear->devinfo |= 1 << 15;
803 /* info for completion callback */
804 clear->hcd = bus_to_hcd(udev->bus);
807 /* tell keventd to clear state for this TT */
808 spin_lock_irqsave (&tt->lock, flags);
809 list_add_tail (&clear->clear_list, &tt->clear_list);
810 schedule_work(&tt->clear_work);
811 spin_unlock_irqrestore (&tt->lock, flags);
814 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
816 /* If do_delay is false, return the number of milliseconds the caller
819 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
822 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
824 u16 wHubCharacteristics =
825 le16_to_cpu(hub->descriptor->wHubCharacteristics);
827 /* Enable power on each port. Some hubs have reserved values
828 * of LPSM (> 2) in their descriptors, even though they are
829 * USB 2.0 hubs. Some hubs do not implement port-power switching
830 * but only emulate it. In all cases, the ports won't work
831 * unless we send these messages to the hub.
833 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
834 dev_dbg(hub->intfdev, "enabling power on all ports\n");
836 dev_dbg(hub->intfdev, "trying to enable port power on "
837 "non-switchable hub\n");
838 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
839 if (hub->ports[port1 - 1]->power_is_on)
840 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
842 usb_clear_port_feature(hub->hdev, port1,
843 USB_PORT_FEAT_POWER);
845 /* Wait at least 100 msec for power to become stable */
846 delay = max(pgood_delay, (unsigned) 100);
852 static int hub_hub_status(struct usb_hub *hub,
853 u16 *status, u16 *change)
857 mutex_lock(&hub->status_mutex);
858 ret = get_hub_status(hub->hdev, &hub->status->hub);
861 dev_err(hub->intfdev,
862 "%s failed (err = %d)\n", __func__, ret);
864 *status = le16_to_cpu(hub->status->hub.wHubStatus);
865 *change = le16_to_cpu(hub->status->hub.wHubChange);
868 mutex_unlock(&hub->status_mutex);
872 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
873 unsigned int link_status)
875 return set_port_feature(hub->hdev,
876 port1 | (link_status << 3),
877 USB_PORT_FEAT_LINK_STATE);
881 * If USB 3.0 ports are placed into the Disabled state, they will no longer
882 * detect any device connects or disconnects. This is generally not what the
883 * USB core wants, since it expects a disabled port to produce a port status
884 * change event when a new device connects.
886 * Instead, set the link state to Disabled, wait for the link to settle into
887 * that state, clear any change bits, and then put the port into the RxDetect
890 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
894 u16 portchange, portstatus;
896 if (!hub_is_superspeed(hub->hdev))
899 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
903 /* Wait for the link to enter the disabled state. */
904 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
905 ret = hub_port_status(hub, port1, &portstatus, &portchange);
909 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
910 USB_SS_PORT_LS_SS_DISABLED)
912 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
914 msleep(HUB_DEBOUNCE_STEP);
916 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
917 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
920 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
923 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
925 struct usb_device *hdev = hub->hdev;
928 if (hub->ports[port1 - 1]->child && set_state)
929 usb_set_device_state(hub->ports[port1 - 1]->child,
930 USB_STATE_NOTATTACHED);
932 if (hub_is_superspeed(hub->hdev))
933 ret = hub_usb3_port_disable(hub, port1);
935 ret = usb_clear_port_feature(hdev, port1,
936 USB_PORT_FEAT_ENABLE);
938 if (ret && ret != -ENODEV)
939 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
945 * Disable a port and mark a logical connect-change event, so that some
946 * time later khubd will disconnect() any existing usb_device on the port
947 * and will re-enumerate if there actually is a device attached.
949 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
951 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
952 hub_port_disable(hub, port1, 1);
954 /* FIXME let caller ask to power down the port:
955 * - some devices won't enumerate without a VBUS power cycle
956 * - SRP saves power that way
957 * - ... new call, TBD ...
958 * That's easy if this hub can switch power per-port, and
959 * khubd reactivates the port later (timer, SRP, etc).
960 * Powerdown must be optional, because of reset/DFU.
963 set_bit(port1, hub->change_bits);
968 * usb_remove_device - disable a device's port on its parent hub
969 * @udev: device to be disabled and removed
970 * Context: @udev locked, must be able to sleep.
972 * After @udev's port has been disabled, khubd is notified and it will
973 * see that the device has been disconnected. When the device is
974 * physically unplugged and something is plugged in, the events will
975 * be received and processed normally.
977 * Return: 0 if successful. A negative error code otherwise.
979 int usb_remove_device(struct usb_device *udev)
982 struct usb_interface *intf;
984 if (!udev->parent) /* Can't remove a root hub */
986 hub = usb_hub_to_struct_hub(udev->parent);
987 intf = to_usb_interface(hub->intfdev);
989 usb_autopm_get_interface(intf);
990 set_bit(udev->portnum, hub->removed_bits);
991 hub_port_logical_disconnect(hub, udev->portnum);
992 usb_autopm_put_interface(intf);
996 enum hub_activation_type {
997 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
998 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1001 static void hub_init_func2(struct work_struct *ws);
1002 static void hub_init_func3(struct work_struct *ws);
1004 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1006 struct usb_device *hdev = hub->hdev;
1007 struct usb_hcd *hcd;
1011 bool need_debounce_delay = false;
1014 /* Continue a partial initialization */
1015 if (type == HUB_INIT2)
1017 if (type == HUB_INIT3)
1020 /* The superspeed hub except for root hub has to use Hub Depth
1021 * value as an offset into the route string to locate the bits
1022 * it uses to determine the downstream port number. So hub driver
1023 * should send a set hub depth request to superspeed hub after
1024 * the superspeed hub is set configuration in initialization or
1027 * After a resume, port power should still be on.
1028 * For any other type of activation, turn it on.
1030 if (type != HUB_RESUME) {
1031 if (hdev->parent && hub_is_superspeed(hdev)) {
1032 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1033 HUB_SET_DEPTH, USB_RT_HUB,
1034 hdev->level - 1, 0, NULL, 0,
1035 USB_CTRL_SET_TIMEOUT);
1037 dev_err(hub->intfdev,
1038 "set hub depth failed\n");
1041 /* Speed up system boot by using a delayed_work for the
1042 * hub's initial power-up delays. This is pretty awkward
1043 * and the implementation looks like a home-brewed sort of
1044 * setjmp/longjmp, but it saves at least 100 ms for each
1045 * root hub (assuming usbcore is compiled into the kernel
1046 * rather than as a module). It adds up.
1048 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1049 * because for those activation types the ports have to be
1050 * operational when we return. In theory this could be done
1051 * for HUB_POST_RESET, but it's easier not to.
1053 if (type == HUB_INIT) {
1054 delay = hub_power_on(hub, false);
1055 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1056 schedule_delayed_work(&hub->init_work,
1057 msecs_to_jiffies(delay));
1059 /* Suppress autosuspend until init is done */
1060 usb_autopm_get_interface_no_resume(
1061 to_usb_interface(hub->intfdev));
1062 return; /* Continues at init2: below */
1063 } else if (type == HUB_RESET_RESUME) {
1064 /* The internal host controller state for the hub device
1065 * may be gone after a host power loss on system resume.
1066 * Update the device's info so the HW knows it's a hub.
1068 hcd = bus_to_hcd(hdev->bus);
1069 if (hcd->driver->update_hub_device) {
1070 ret = hcd->driver->update_hub_device(hcd, hdev,
1071 &hub->tt, GFP_NOIO);
1073 dev_err(hub->intfdev, "Host not "
1074 "accepting hub info "
1076 dev_err(hub->intfdev, "LS/FS devices "
1077 "and hubs may not work "
1078 "under this hub\n.");
1081 hub_power_on(hub, true);
1083 hub_power_on(hub, true);
1088 /* Check each port and set hub->change_bits to let khubd know
1089 * which ports need attention.
1091 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1092 struct usb_device *udev = hub->ports[port1 - 1]->child;
1093 u16 portstatus, portchange;
1095 portstatus = portchange = 0;
1096 status = hub_port_status(hub, port1, &portstatus, &portchange);
1097 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1098 dev_dbg(hub->intfdev,
1099 "port %d: status %04x change %04x\n",
1100 port1, portstatus, portchange);
1102 /* After anything other than HUB_RESUME (i.e., initialization
1103 * or any sort of reset), every port should be disabled.
1104 * Unconnected ports should likewise be disabled (paranoia),
1105 * and so should ports for which we have no usb_device.
1107 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1108 type != HUB_RESUME ||
1109 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1111 udev->state == USB_STATE_NOTATTACHED)) {
1113 * USB3 protocol ports will automatically transition
1114 * to Enabled state when detect an USB3.0 device attach.
1115 * Do not disable USB3 protocol ports, just pretend
1118 portstatus &= ~USB_PORT_STAT_ENABLE;
1119 if (!hub_is_superspeed(hdev))
1120 usb_clear_port_feature(hdev, port1,
1121 USB_PORT_FEAT_ENABLE);
1124 /* Clear status-change flags; we'll debounce later */
1125 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1126 need_debounce_delay = true;
1127 usb_clear_port_feature(hub->hdev, port1,
1128 USB_PORT_FEAT_C_CONNECTION);
1130 if (portchange & USB_PORT_STAT_C_ENABLE) {
1131 need_debounce_delay = true;
1132 usb_clear_port_feature(hub->hdev, port1,
1133 USB_PORT_FEAT_C_ENABLE);
1135 if (portchange & USB_PORT_STAT_C_RESET) {
1136 need_debounce_delay = true;
1137 usb_clear_port_feature(hub->hdev, port1,
1138 USB_PORT_FEAT_C_RESET);
1140 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1141 hub_is_superspeed(hub->hdev)) {
1142 need_debounce_delay = true;
1143 usb_clear_port_feature(hub->hdev, port1,
1144 USB_PORT_FEAT_C_BH_PORT_RESET);
1146 /* We can forget about a "removed" device when there's a
1147 * physical disconnect or the connect status changes.
1149 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1150 (portchange & USB_PORT_STAT_C_CONNECTION))
1151 clear_bit(port1, hub->removed_bits);
1153 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1154 /* Tell khubd to disconnect the device or
1155 * check for a new connection
1157 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1158 set_bit(port1, hub->change_bits);
1160 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1161 bool port_resumed = (portstatus &
1162 USB_PORT_STAT_LINK_STATE) ==
1164 /* The power session apparently survived the resume.
1165 * If there was an overcurrent or suspend change
1166 * (i.e., remote wakeup request), have khubd
1167 * take care of it. Look at the port link state
1168 * for USB 3.0 hubs, since they don't have a suspend
1169 * change bit, and they don't set the port link change
1170 * bit on device-initiated resume.
1172 if (portchange || (hub_is_superspeed(hub->hdev) &&
1174 set_bit(port1, hub->change_bits);
1176 } else if (udev->persist_enabled) {
1177 struct usb_port *port_dev = hub->ports[port1 - 1];
1180 udev->reset_resume = 1;
1182 /* Don't set the change_bits when the device
1185 if (port_dev->power_is_on)
1186 set_bit(port1, hub->change_bits);
1189 /* The power session is gone; tell khubd */
1190 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1191 set_bit(port1, hub->change_bits);
1195 /* If no port-status-change flags were set, we don't need any
1196 * debouncing. If flags were set we can try to debounce the
1197 * ports all at once right now, instead of letting khubd do them
1198 * one at a time later on.
1200 * If any port-status changes do occur during this delay, khubd
1201 * will see them later and handle them normally.
1203 if (need_debounce_delay) {
1204 delay = HUB_DEBOUNCE_STABLE;
1206 /* Don't do a long sleep inside a workqueue routine */
1207 if (type == HUB_INIT2) {
1208 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1209 schedule_delayed_work(&hub->init_work,
1210 msecs_to_jiffies(delay));
1211 return; /* Continues at init3: below */
1219 status = usb_submit_urb(hub->urb, GFP_NOIO);
1221 dev_err(hub->intfdev, "activate --> %d\n", status);
1222 if (hub->has_indicators && blinkenlights)
1223 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1225 /* Scan all ports that need attention */
1228 /* Allow autosuspend if it was suppressed */
1229 if (type <= HUB_INIT3)
1230 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1233 /* Implement the continuations for the delays above */
1234 static void hub_init_func2(struct work_struct *ws)
1236 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1238 hub_activate(hub, HUB_INIT2);
1241 static void hub_init_func3(struct work_struct *ws)
1243 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1245 hub_activate(hub, HUB_INIT3);
1248 enum hub_quiescing_type {
1249 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1252 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1254 struct usb_device *hdev = hub->hdev;
1257 cancel_delayed_work_sync(&hub->init_work);
1259 /* khubd and related activity won't re-trigger */
1262 if (type != HUB_SUSPEND) {
1263 /* Disconnect all the children */
1264 for (i = 0; i < hdev->maxchild; ++i) {
1265 if (hub->ports[i]->child)
1266 usb_disconnect(&hub->ports[i]->child);
1270 /* Stop khubd and related activity */
1271 usb_kill_urb(hub->urb);
1272 if (hub->has_indicators)
1273 cancel_delayed_work_sync(&hub->leds);
1275 flush_work(&hub->tt.clear_work);
1278 /* caller has locked the hub device */
1279 static int hub_pre_reset(struct usb_interface *intf)
1281 struct usb_hub *hub = usb_get_intfdata(intf);
1283 hub_quiesce(hub, HUB_PRE_RESET);
1287 /* caller has locked the hub device */
1288 static int hub_post_reset(struct usb_interface *intf)
1290 struct usb_hub *hub = usb_get_intfdata(intf);
1292 hub_activate(hub, HUB_POST_RESET);
1296 static int hub_configure(struct usb_hub *hub,
1297 struct usb_endpoint_descriptor *endpoint)
1299 struct usb_hcd *hcd;
1300 struct usb_device *hdev = hub->hdev;
1301 struct device *hub_dev = hub->intfdev;
1302 u16 hubstatus, hubchange;
1303 u16 wHubCharacteristics;
1306 char *message = "out of memory";
1310 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1316 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1321 mutex_init(&hub->status_mutex);
1323 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1324 if (!hub->descriptor) {
1329 /* Request the entire hub descriptor.
1330 * hub->descriptor can handle USB_MAXCHILDREN ports,
1331 * but the hub can/will return fewer bytes here.
1333 ret = get_hub_descriptor(hdev, hub->descriptor);
1335 message = "can't read hub descriptor";
1337 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1338 message = "hub has too many ports!";
1341 } else if (hub->descriptor->bNbrPorts == 0) {
1342 message = "hub doesn't have any ports!";
1347 hdev->maxchild = hub->descriptor->bNbrPorts;
1348 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1349 (hdev->maxchild == 1) ? "" : "s");
1351 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1358 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1359 if (hub_is_superspeed(hdev)) {
1367 /* FIXME for USB 3.0, skip for now */
1368 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1369 !(hub_is_superspeed(hdev))) {
1371 char portstr[USB_MAXCHILDREN + 1];
1373 for (i = 0; i < hdev->maxchild; i++)
1374 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1375 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1377 portstr[hdev->maxchild] = 0;
1378 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1380 dev_dbg(hub_dev, "standalone hub\n");
1382 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1383 case HUB_CHAR_COMMON_LPSM:
1384 dev_dbg(hub_dev, "ganged power switching\n");
1386 case HUB_CHAR_INDV_PORT_LPSM:
1387 dev_dbg(hub_dev, "individual port power switching\n");
1389 case HUB_CHAR_NO_LPSM:
1391 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1395 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1396 case HUB_CHAR_COMMON_OCPM:
1397 dev_dbg(hub_dev, "global over-current protection\n");
1399 case HUB_CHAR_INDV_PORT_OCPM:
1400 dev_dbg(hub_dev, "individual port over-current protection\n");
1402 case HUB_CHAR_NO_OCPM:
1404 dev_dbg(hub_dev, "no over-current protection\n");
1408 spin_lock_init (&hub->tt.lock);
1409 INIT_LIST_HEAD (&hub->tt.clear_list);
1410 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1411 switch (hdev->descriptor.bDeviceProtocol) {
1414 case USB_HUB_PR_HS_SINGLE_TT:
1415 dev_dbg(hub_dev, "Single TT\n");
1418 case USB_HUB_PR_HS_MULTI_TT:
1419 ret = usb_set_interface(hdev, 0, 1);
1421 dev_dbg(hub_dev, "TT per port\n");
1424 dev_err(hub_dev, "Using single TT (err %d)\n",
1429 /* USB 3.0 hubs don't have a TT */
1432 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1433 hdev->descriptor.bDeviceProtocol);
1437 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1438 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1439 case HUB_TTTT_8_BITS:
1440 if (hdev->descriptor.bDeviceProtocol != 0) {
1441 hub->tt.think_time = 666;
1442 dev_dbg(hub_dev, "TT requires at most %d "
1443 "FS bit times (%d ns)\n",
1444 8, hub->tt.think_time);
1447 case HUB_TTTT_16_BITS:
1448 hub->tt.think_time = 666 * 2;
1449 dev_dbg(hub_dev, "TT requires at most %d "
1450 "FS bit times (%d ns)\n",
1451 16, hub->tt.think_time);
1453 case HUB_TTTT_24_BITS:
1454 hub->tt.think_time = 666 * 3;
1455 dev_dbg(hub_dev, "TT requires at most %d "
1456 "FS bit times (%d ns)\n",
1457 24, hub->tt.think_time);
1459 case HUB_TTTT_32_BITS:
1460 hub->tt.think_time = 666 * 4;
1461 dev_dbg(hub_dev, "TT requires at most %d "
1462 "FS bit times (%d ns)\n",
1463 32, hub->tt.think_time);
1467 /* probe() zeroes hub->indicator[] */
1468 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1469 hub->has_indicators = 1;
1470 dev_dbg(hub_dev, "Port indicators are supported\n");
1473 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1474 hub->descriptor->bPwrOn2PwrGood * 2);
1476 /* power budgeting mostly matters with bus-powered hubs,
1477 * and battery-powered root hubs (may provide just 8 mA).
1479 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1481 message = "can't get hub status";
1484 hcd = bus_to_hcd(hdev->bus);
1485 if (hdev == hdev->bus->root_hub) {
1486 if (hcd->power_budget > 0)
1487 hdev->bus_mA = hcd->power_budget;
1489 hdev->bus_mA = full_load * hdev->maxchild;
1490 if (hdev->bus_mA >= full_load)
1491 hub->mA_per_port = full_load;
1493 hub->mA_per_port = hdev->bus_mA;
1494 hub->limited_power = 1;
1496 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1497 int remaining = hdev->bus_mA -
1498 hub->descriptor->bHubContrCurrent;
1500 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1501 hub->descriptor->bHubContrCurrent);
1502 hub->limited_power = 1;
1504 if (remaining < hdev->maxchild * unit_load)
1506 "insufficient power available "
1507 "to use all downstream ports\n");
1508 hub->mA_per_port = unit_load; /* 7.2.1 */
1510 } else { /* Self-powered external hub */
1511 /* FIXME: What about battery-powered external hubs that
1512 * provide less current per port? */
1513 hub->mA_per_port = full_load;
1515 if (hub->mA_per_port < full_load)
1516 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1519 /* Update the HCD's internal representation of this hub before khubd
1520 * starts getting port status changes for devices under the hub.
1522 if (hcd->driver->update_hub_device) {
1523 ret = hcd->driver->update_hub_device(hcd, hdev,
1524 &hub->tt, GFP_KERNEL);
1526 message = "can't update HCD hub info";
1531 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1533 message = "can't get hub status";
1537 /* local power status reports aren't always correct */
1538 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1539 dev_dbg(hub_dev, "local power source is %s\n",
1540 (hubstatus & HUB_STATUS_LOCAL_POWER)
1541 ? "lost (inactive)" : "good");
1543 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1544 dev_dbg(hub_dev, "%sover-current condition exists\n",
1545 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1547 /* set up the interrupt endpoint
1548 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1549 * bytes as USB2.0[11.12.3] says because some hubs are known
1550 * to send more data (and thus cause overflow). For root hubs,
1551 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1552 * to be big enough for at least USB_MAXCHILDREN ports. */
1553 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1554 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1556 if (maxp > sizeof(*hub->buffer))
1557 maxp = sizeof(*hub->buffer);
1559 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1565 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1566 hub, endpoint->bInterval);
1568 /* maybe cycle the hub leds */
1569 if (hub->has_indicators && blinkenlights)
1570 hub->indicator[0] = INDICATOR_CYCLE;
1572 for (i = 0; i < hdev->maxchild; i++) {
1573 ret = usb_hub_create_port_device(hub, i + 1);
1575 dev_err(hub->intfdev,
1576 "couldn't create port%d device.\n", i + 1);
1578 goto fail_keep_maxchild;
1582 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1584 hub_activate(hub, HUB_INIT);
1590 dev_err (hub_dev, "config failed, %s (err %d)\n",
1592 /* hub_disconnect() frees urb and descriptor */
1596 static void hub_release(struct kref *kref)
1598 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1600 usb_put_intf(to_usb_interface(hub->intfdev));
1604 static unsigned highspeed_hubs;
1606 static void hub_disconnect(struct usb_interface *intf)
1608 struct usb_hub *hub = usb_get_intfdata(intf);
1609 struct usb_device *hdev = interface_to_usbdev(intf);
1612 /* Take the hub off the event list and don't let it be added again */
1613 spin_lock_irq(&hub_event_lock);
1614 if (!list_empty(&hub->event_list)) {
1615 list_del_init(&hub->event_list);
1616 usb_autopm_put_interface_no_suspend(intf);
1618 hub->disconnected = 1;
1619 spin_unlock_irq(&hub_event_lock);
1621 /* Disconnect all children and quiesce the hub */
1623 hub_quiesce(hub, HUB_DISCONNECT);
1625 usb_set_intfdata (intf, NULL);
1627 for (i = 0; i < hdev->maxchild; i++)
1628 usb_hub_remove_port_device(hub, i + 1);
1629 hub->hdev->maxchild = 0;
1631 if (hub->hdev->speed == USB_SPEED_HIGH)
1634 usb_free_urb(hub->urb);
1636 kfree(hub->descriptor);
1640 pm_suspend_ignore_children(&intf->dev, false);
1641 kref_put(&hub->kref, hub_release);
1644 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1646 struct usb_host_interface *desc;
1647 struct usb_endpoint_descriptor *endpoint;
1648 struct usb_device *hdev;
1649 struct usb_hub *hub;
1651 desc = intf->cur_altsetting;
1652 hdev = interface_to_usbdev(intf);
1655 * Set default autosuspend delay as 0 to speedup bus suspend,
1656 * based on the below considerations:
1658 * - Unlike other drivers, the hub driver does not rely on the
1659 * autosuspend delay to provide enough time to handle a wakeup
1660 * event, and the submitted status URB is just to check future
1661 * change on hub downstream ports, so it is safe to do it.
1663 * - The patch might cause one or more auto supend/resume for
1664 * below very rare devices when they are plugged into hub
1667 * devices having trouble initializing, and disconnect
1668 * themselves from the bus and then reconnect a second
1671 * devices just for downloading firmware, and disconnects
1672 * themselves after completing it
1674 * For these quite rare devices, their drivers may change the
1675 * autosuspend delay of their parent hub in the probe() to one
1676 * appropriate value to avoid the subtle problem if someone
1679 * - The patch may cause one or more auto suspend/resume on
1680 * hub during running 'lsusb', but it is probably too
1681 * infrequent to worry about.
1683 * - Change autosuspend delay of hub can avoid unnecessary auto
1684 * suspend timer for hub, also may decrease power consumption
1687 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1689 /* Hubs have proper suspend/resume support. */
1690 usb_enable_autosuspend(hdev);
1692 if (hdev->level == MAX_TOPO_LEVEL) {
1694 "Unsupported bus topology: hub nested too deep\n");
1698 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1700 dev_warn(&intf->dev, "ignoring external hub\n");
1705 /* Some hubs have a subclass of 1, which AFAICT according to the */
1706 /* specs is not defined, but it works */
1707 if ((desc->desc.bInterfaceSubClass != 0) &&
1708 (desc->desc.bInterfaceSubClass != 1)) {
1710 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1714 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1715 if (desc->desc.bNumEndpoints != 1)
1716 goto descriptor_error;
1718 endpoint = &desc->endpoint[0].desc;
1720 /* If it's not an interrupt in endpoint, we'd better punt! */
1721 if (!usb_endpoint_is_int_in(endpoint))
1722 goto descriptor_error;
1724 /* We found a hub */
1725 dev_info (&intf->dev, "USB hub found\n");
1727 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1729 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1733 kref_init(&hub->kref);
1734 INIT_LIST_HEAD(&hub->event_list);
1735 hub->intfdev = &intf->dev;
1737 INIT_DELAYED_WORK(&hub->leds, led_work);
1738 INIT_DELAYED_WORK(&hub->init_work, NULL);
1741 usb_set_intfdata (intf, hub);
1742 intf->needs_remote_wakeup = 1;
1743 pm_suspend_ignore_children(&intf->dev, true);
1745 if (hdev->speed == USB_SPEED_HIGH)
1748 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1749 hub->quirk_check_port_auto_suspend = 1;
1751 if (hub_configure(hub, endpoint) >= 0)
1754 hub_disconnect (intf);
1759 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1761 struct usb_device *hdev = interface_to_usbdev (intf);
1762 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1764 /* assert ifno == 0 (part of hub spec) */
1766 case USBDEVFS_HUB_PORTINFO: {
1767 struct usbdevfs_hub_portinfo *info = user_data;
1770 spin_lock_irq(&device_state_lock);
1771 if (hdev->devnum <= 0)
1774 info->nports = hdev->maxchild;
1775 for (i = 0; i < info->nports; i++) {
1776 if (hub->ports[i]->child == NULL)
1780 hub->ports[i]->child->devnum;
1783 spin_unlock_irq(&device_state_lock);
1785 return info->nports + 1;
1794 * Allow user programs to claim ports on a hub. When a device is attached
1795 * to one of these "claimed" ports, the program will "own" the device.
1797 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1798 struct dev_state ***ppowner)
1800 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1802 if (hdev->state == USB_STATE_NOTATTACHED)
1804 if (port1 == 0 || port1 > hdev->maxchild)
1807 /* Devices not managed by the hub driver
1808 * will always have maxchild equal to 0.
1810 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1814 /* In the following three functions, the caller must hold hdev's lock */
1815 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1816 struct dev_state *owner)
1819 struct dev_state **powner;
1821 rc = find_port_owner(hdev, port1, &powner);
1830 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1831 struct dev_state *owner)
1834 struct dev_state **powner;
1836 rc = find_port_owner(hdev, port1, &powner);
1839 if (*powner != owner)
1845 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1847 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1850 for (n = 0; n < hdev->maxchild; n++) {
1851 if (hub->ports[n]->port_owner == owner)
1852 hub->ports[n]->port_owner = NULL;
1857 /* The caller must hold udev's lock */
1858 bool usb_device_is_owned(struct usb_device *udev)
1860 struct usb_hub *hub;
1862 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1864 hub = usb_hub_to_struct_hub(udev->parent);
1865 return !!hub->ports[udev->portnum - 1]->port_owner;
1868 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1870 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1873 for (i = 0; i < udev->maxchild; ++i) {
1874 if (hub->ports[i]->child)
1875 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1877 if (udev->state == USB_STATE_SUSPENDED)
1878 udev->active_duration -= jiffies;
1879 udev->state = USB_STATE_NOTATTACHED;
1883 * usb_set_device_state - change a device's current state (usbcore, hcds)
1884 * @udev: pointer to device whose state should be changed
1885 * @new_state: new state value to be stored
1887 * udev->state is _not_ fully protected by the device lock. Although
1888 * most transitions are made only while holding the lock, the state can
1889 * can change to USB_STATE_NOTATTACHED at almost any time. This
1890 * is so that devices can be marked as disconnected as soon as possible,
1891 * without having to wait for any semaphores to be released. As a result,
1892 * all changes to any device's state must be protected by the
1893 * device_state_lock spinlock.
1895 * Once a device has been added to the device tree, all changes to its state
1896 * should be made using this routine. The state should _not_ be set directly.
1898 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1899 * Otherwise udev->state is set to new_state, and if new_state is
1900 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1901 * to USB_STATE_NOTATTACHED.
1903 void usb_set_device_state(struct usb_device *udev,
1904 enum usb_device_state new_state)
1906 unsigned long flags;
1909 spin_lock_irqsave(&device_state_lock, flags);
1910 if (udev->state == USB_STATE_NOTATTACHED)
1912 else if (new_state != USB_STATE_NOTATTACHED) {
1914 /* root hub wakeup capabilities are managed out-of-band
1915 * and may involve silicon errata ... ignore them here.
1918 if (udev->state == USB_STATE_SUSPENDED
1919 || new_state == USB_STATE_SUSPENDED)
1920 ; /* No change to wakeup settings */
1921 else if (new_state == USB_STATE_CONFIGURED)
1922 wakeup = udev->actconfig->desc.bmAttributes
1923 & USB_CONFIG_ATT_WAKEUP;
1927 if (udev->state == USB_STATE_SUSPENDED &&
1928 new_state != USB_STATE_SUSPENDED)
1929 udev->active_duration -= jiffies;
1930 else if (new_state == USB_STATE_SUSPENDED &&
1931 udev->state != USB_STATE_SUSPENDED)
1932 udev->active_duration += jiffies;
1933 udev->state = new_state;
1935 recursively_mark_NOTATTACHED(udev);
1936 spin_unlock_irqrestore(&device_state_lock, flags);
1938 device_set_wakeup_capable(&udev->dev, wakeup);
1940 EXPORT_SYMBOL_GPL(usb_set_device_state);
1943 * Choose a device number.
1945 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1946 * USB-2.0 buses they are also used as device addresses, however on
1947 * USB-3.0 buses the address is assigned by the controller hardware
1948 * and it usually is not the same as the device number.
1950 * WUSB devices are simple: they have no hubs behind, so the mapping
1951 * device <-> virtual port number becomes 1:1. Why? to simplify the
1952 * life of the device connection logic in
1953 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1954 * handshake we need to assign a temporary address in the unauthorized
1955 * space. For simplicity we use the first virtual port number found to
1956 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1957 * and that becomes it's address [X < 128] or its unauthorized address
1960 * We add 1 as an offset to the one-based USB-stack port number
1961 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1962 * 0 is reserved by USB for default address; (b) Linux's USB stack
1963 * uses always #1 for the root hub of the controller. So USB stack's
1964 * port #1, which is wusb virtual-port #0 has address #2.
1966 * Devices connected under xHCI are not as simple. The host controller
1967 * supports virtualization, so the hardware assigns device addresses and
1968 * the HCD must setup data structures before issuing a set address
1969 * command to the hardware.
1971 static void choose_devnum(struct usb_device *udev)
1974 struct usb_bus *bus = udev->bus;
1976 /* If khubd ever becomes multithreaded, this will need a lock */
1978 devnum = udev->portnum + 1;
1979 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1981 /* Try to allocate the next devnum beginning at
1982 * bus->devnum_next. */
1983 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1986 devnum = find_next_zero_bit(bus->devmap.devicemap,
1988 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
1991 set_bit(devnum, bus->devmap.devicemap);
1992 udev->devnum = devnum;
1996 static void release_devnum(struct usb_device *udev)
1998 if (udev->devnum > 0) {
1999 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2004 static void update_devnum(struct usb_device *udev, int devnum)
2006 /* The address for a WUSB device is managed by wusbcore. */
2008 udev->devnum = devnum;
2011 static void hub_free_dev(struct usb_device *udev)
2013 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2015 /* Root hubs aren't real devices, so don't free HCD resources */
2016 if (hcd->driver->free_dev && udev->parent)
2017 hcd->driver->free_dev(hcd, udev);
2021 * usb_disconnect - disconnect a device (usbcore-internal)
2022 * @pdev: pointer to device being disconnected
2023 * Context: !in_interrupt ()
2025 * Something got disconnected. Get rid of it and all of its children.
2027 * If *pdev is a normal device then the parent hub must already be locked.
2028 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2029 * which protects the set of root hubs as well as the list of buses.
2031 * Only hub drivers (including virtual root hub drivers for host
2032 * controllers) should ever call this.
2034 * This call is synchronous, and may not be used in an interrupt context.
2036 void usb_disconnect(struct usb_device **pdev)
2038 struct usb_device *udev = *pdev;
2039 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2042 /* mark the device as inactive, so any further urb submissions for
2043 * this device (and any of its children) will fail immediately.
2044 * this quiesces everything except pending urbs.
2046 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2047 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2050 usb_lock_device(udev);
2052 /* Free up all the children before we remove this device */
2053 for (i = 0; i < udev->maxchild; i++) {
2054 if (hub->ports[i]->child)
2055 usb_disconnect(&hub->ports[i]->child);
2058 /* deallocate hcd/hardware state ... nuking all pending urbs and
2059 * cleaning up all state associated with the current configuration
2060 * so that the hardware is now fully quiesced.
2062 dev_dbg (&udev->dev, "unregistering device\n");
2063 usb_disable_device(udev, 0);
2064 usb_hcd_synchronize_unlinks(udev);
2067 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2068 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2070 sysfs_remove_link(&udev->dev.kobj, "port");
2071 sysfs_remove_link(&port_dev->dev.kobj, "device");
2073 if (!port_dev->did_runtime_put)
2074 pm_runtime_put(&port_dev->dev);
2076 port_dev->did_runtime_put = false;
2079 usb_remove_ep_devs(&udev->ep0);
2080 usb_unlock_device(udev);
2082 /* Unregister the device. The device driver is responsible
2083 * for de-configuring the device and invoking the remove-device
2084 * notifier chain (used by usbfs and possibly others).
2086 device_del(&udev->dev);
2088 /* Free the device number and delete the parent's children[]
2089 * (or root_hub) pointer.
2091 release_devnum(udev);
2093 /* Avoid races with recursively_mark_NOTATTACHED() */
2094 spin_lock_irq(&device_state_lock);
2096 spin_unlock_irq(&device_state_lock);
2100 put_device(&udev->dev);
2103 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2104 static void show_string(struct usb_device *udev, char *id, char *string)
2108 dev_info(&udev->dev, "%s: %s\n", id, string);
2111 static void announce_device(struct usb_device *udev)
2113 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2114 le16_to_cpu(udev->descriptor.idVendor),
2115 le16_to_cpu(udev->descriptor.idProduct));
2116 dev_info(&udev->dev,
2117 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2118 udev->descriptor.iManufacturer,
2119 udev->descriptor.iProduct,
2120 udev->descriptor.iSerialNumber);
2121 show_string(udev, "Product", udev->product);
2122 show_string(udev, "Manufacturer", udev->manufacturer);
2123 show_string(udev, "SerialNumber", udev->serial);
2126 static inline void announce_device(struct usb_device *udev) { }
2129 #ifdef CONFIG_USB_OTG
2130 #include "otg_whitelist.h"
2134 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2135 * @udev: newly addressed device (in ADDRESS state)
2137 * Finish enumeration for On-The-Go devices
2139 * Return: 0 if successful. A negative error code otherwise.
2141 static int usb_enumerate_device_otg(struct usb_device *udev)
2145 #ifdef CONFIG_USB_OTG
2147 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2148 * to wake us after we've powered off VBUS; and HNP, switching roles
2149 * "host" to "peripheral". The OTG descriptor helps figure this out.
2151 if (!udev->bus->is_b_host
2153 && udev->parent == udev->bus->root_hub) {
2154 struct usb_otg_descriptor *desc = NULL;
2155 struct usb_bus *bus = udev->bus;
2157 /* descriptor may appear anywhere in config */
2158 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2159 le16_to_cpu(udev->config[0].desc.wTotalLength),
2160 USB_DT_OTG, (void **) &desc) == 0) {
2161 if (desc->bmAttributes & USB_OTG_HNP) {
2162 unsigned port1 = udev->portnum;
2164 dev_info(&udev->dev,
2165 "Dual-Role OTG device on %sHNP port\n",
2166 (port1 == bus->otg_port)
2169 /* enable HNP before suspend, it's simpler */
2170 if (port1 == bus->otg_port)
2171 bus->b_hnp_enable = 1;
2172 err = usb_control_msg(udev,
2173 usb_sndctrlpipe(udev, 0),
2174 USB_REQ_SET_FEATURE, 0,
2176 ? USB_DEVICE_B_HNP_ENABLE
2177 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2178 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2180 /* OTG MESSAGE: report errors here,
2181 * customize to match your product.
2183 dev_info(&udev->dev,
2184 "can't set HNP mode: %d\n",
2186 bus->b_hnp_enable = 0;
2192 if (!is_targeted(udev)) {
2194 /* Maybe it can talk to us, though we can't talk to it.
2195 * (Includes HNP test device.)
2197 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2198 err = usb_port_suspend(udev, PMSG_SUSPEND);
2200 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2212 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2213 * @udev: newly addressed device (in ADDRESS state)
2215 * This is only called by usb_new_device() and usb_authorize_device()
2216 * and FIXME -- all comments that apply to them apply here wrt to
2219 * If the device is WUSB and not authorized, we don't attempt to read
2220 * the string descriptors, as they will be errored out by the device
2221 * until it has been authorized.
2223 * Return: 0 if successful. A negative error code otherwise.
2225 static int usb_enumerate_device(struct usb_device *udev)
2229 if (udev->config == NULL) {
2230 err = usb_get_configuration(udev);
2233 dev_err(&udev->dev, "can't read configurations, error %d\n",
2239 /* read the standard strings and cache them if present */
2240 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2241 udev->manufacturer = usb_cache_string(udev,
2242 udev->descriptor.iManufacturer);
2243 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2245 err = usb_enumerate_device_otg(udev);
2249 usb_detect_interface_quirks(udev);
2254 static void set_usb_port_removable(struct usb_device *udev)
2256 struct usb_device *hdev = udev->parent;
2257 struct usb_hub *hub;
2258 u8 port = udev->portnum;
2259 u16 wHubCharacteristics;
2260 bool removable = true;
2265 hub = usb_hub_to_struct_hub(udev->parent);
2267 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2269 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2272 if (hub_is_superspeed(hdev)) {
2273 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2277 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2282 udev->removable = USB_DEVICE_REMOVABLE;
2284 udev->removable = USB_DEVICE_FIXED;
2288 * usb_new_device - perform initial device setup (usbcore-internal)
2289 * @udev: newly addressed device (in ADDRESS state)
2291 * This is called with devices which have been detected but not fully
2292 * enumerated. The device descriptor is available, but not descriptors
2293 * for any device configuration. The caller must have locked either
2294 * the parent hub (if udev is a normal device) or else the
2295 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2296 * udev has already been installed, but udev is not yet visible through
2297 * sysfs or other filesystem code.
2299 * This call is synchronous, and may not be used in an interrupt context.
2301 * Only the hub driver or root-hub registrar should ever call this.
2303 * Return: Whether the device is configured properly or not. Zero if the
2304 * interface was registered with the driver core; else a negative errno
2308 int usb_new_device(struct usb_device *udev)
2313 /* Initialize non-root-hub device wakeup to disabled;
2314 * device (un)configuration controls wakeup capable
2315 * sysfs power/wakeup controls wakeup enabled/disabled
2317 device_init_wakeup(&udev->dev, 0);
2320 /* Tell the runtime-PM framework the device is active */
2321 pm_runtime_set_active(&udev->dev);
2322 pm_runtime_get_noresume(&udev->dev);
2323 pm_runtime_use_autosuspend(&udev->dev);
2324 pm_runtime_enable(&udev->dev);
2326 /* By default, forbid autosuspend for all devices. It will be
2327 * allowed for hubs during binding.
2329 usb_disable_autosuspend(udev);
2331 err = usb_enumerate_device(udev); /* Read descriptors */
2334 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2335 udev->devnum, udev->bus->busnum,
2336 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2337 /* export the usbdev device-node for libusb */
2338 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2339 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2341 /* Tell the world! */
2342 announce_device(udev);
2345 add_device_randomness(udev->serial, strlen(udev->serial));
2347 add_device_randomness(udev->product, strlen(udev->product));
2348 if (udev->manufacturer)
2349 add_device_randomness(udev->manufacturer,
2350 strlen(udev->manufacturer));
2352 device_enable_async_suspend(&udev->dev);
2355 * check whether the hub marks this port as non-removable. Do it
2356 * now so that platform-specific data can override it in
2360 set_usb_port_removable(udev);
2362 /* Register the device. The device driver is responsible
2363 * for configuring the device and invoking the add-device
2364 * notifier chain (used by usbfs and possibly others).
2366 err = device_add(&udev->dev);
2368 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2372 /* Create link files between child device and usb port device. */
2374 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2375 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2377 err = sysfs_create_link(&udev->dev.kobj,
2378 &port_dev->dev.kobj, "port");
2382 err = sysfs_create_link(&port_dev->dev.kobj,
2383 &udev->dev.kobj, "device");
2385 sysfs_remove_link(&udev->dev.kobj, "port");
2389 pm_runtime_get_sync(&port_dev->dev);
2392 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2393 usb_mark_last_busy(udev);
2394 pm_runtime_put_sync_autosuspend(&udev->dev);
2398 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2399 pm_runtime_disable(&udev->dev);
2400 pm_runtime_set_suspended(&udev->dev);
2406 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2407 * @usb_dev: USB device
2409 * Move the USB device to a very basic state where interfaces are disabled
2410 * and the device is in fact unconfigured and unusable.
2412 * We share a lock (that we have) with device_del(), so we need to
2417 int usb_deauthorize_device(struct usb_device *usb_dev)
2419 usb_lock_device(usb_dev);
2420 if (usb_dev->authorized == 0)
2421 goto out_unauthorized;
2423 usb_dev->authorized = 0;
2424 usb_set_configuration(usb_dev, -1);
2427 usb_unlock_device(usb_dev);
2432 int usb_authorize_device(struct usb_device *usb_dev)
2436 usb_lock_device(usb_dev);
2437 if (usb_dev->authorized == 1)
2438 goto out_authorized;
2440 result = usb_autoresume_device(usb_dev);
2442 dev_err(&usb_dev->dev,
2443 "can't autoresume for authorization: %d\n", result);
2444 goto error_autoresume;
2446 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2448 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2449 "authorization: %d\n", result);
2450 goto error_device_descriptor;
2453 usb_dev->authorized = 1;
2454 /* Choose and set the configuration. This registers the interfaces
2455 * with the driver core and lets interface drivers bind to them.
2457 c = usb_choose_configuration(usb_dev);
2459 result = usb_set_configuration(usb_dev, c);
2461 dev_err(&usb_dev->dev,
2462 "can't set config #%d, error %d\n", c, result);
2463 /* This need not be fatal. The user can try to
2464 * set other configurations. */
2467 dev_info(&usb_dev->dev, "authorized to connect\n");
2469 error_device_descriptor:
2470 usb_autosuspend_device(usb_dev);
2473 usb_unlock_device(usb_dev); /* complements locktree */
2478 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2479 static unsigned hub_is_wusb(struct usb_hub *hub)
2481 struct usb_hcd *hcd;
2482 if (hub->hdev->parent != NULL) /* not a root hub? */
2484 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2485 return hcd->wireless;
2489 #define PORT_RESET_TRIES 5
2490 #define SET_ADDRESS_TRIES 2
2491 #define GET_DESCRIPTOR_TRIES 2
2492 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2493 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2495 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2496 #define HUB_SHORT_RESET_TIME 10
2497 #define HUB_BH_RESET_TIME 50
2498 #define HUB_LONG_RESET_TIME 200
2499 #define HUB_RESET_TIMEOUT 800
2502 * "New scheme" enumeration causes an extra state transition to be
2503 * exposed to an xhci host and causes USB3 devices to receive control
2504 * commands in the default state. This has been seen to cause
2505 * enumeration failures, so disable this enumeration scheme for USB3
2508 static bool use_new_scheme(struct usb_device *udev, int retry)
2510 if (udev->speed == USB_SPEED_SUPER)
2513 return USE_NEW_SCHEME(retry);
2516 static int hub_port_reset(struct usb_hub *hub, int port1,
2517 struct usb_device *udev, unsigned int delay, bool warm);
2519 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2520 * Port worm reset is required to recover
2522 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2524 return hub_is_superspeed(hub->hdev) &&
2525 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2526 USB_SS_PORT_LS_SS_INACTIVE) ||
2527 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2528 USB_SS_PORT_LS_COMP_MOD)) ;
2531 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2532 struct usb_device *udev, unsigned int delay, bool warm)
2534 int delay_time, ret;
2538 for (delay_time = 0;
2539 delay_time < HUB_RESET_TIMEOUT;
2540 delay_time += delay) {
2541 /* wait to give the device a chance to reset */
2544 /* read and decode port status */
2545 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2549 /* The port state is unknown until the reset completes. */
2550 if (!(portstatus & USB_PORT_STAT_RESET))
2553 /* switch to the long delay after two short delay failures */
2554 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2555 delay = HUB_LONG_RESET_TIME;
2557 dev_dbg (hub->intfdev,
2558 "port %d not %sreset yet, waiting %dms\n",
2559 port1, warm ? "warm " : "", delay);
2562 if ((portstatus & USB_PORT_STAT_RESET))
2565 if (hub_port_warm_reset_required(hub, portstatus))
2568 /* Device went away? */
2569 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2572 /* bomb out completely if the connection bounced. A USB 3.0
2573 * connection may bounce if multiple warm resets were issued,
2574 * but the device may have successfully re-connected. Ignore it.
2576 if (!hub_is_superspeed(hub->hdev) &&
2577 (portchange & USB_PORT_STAT_C_CONNECTION))
2580 if (!(portstatus & USB_PORT_STAT_ENABLE))
2586 if (hub_is_wusb(hub))
2587 udev->speed = USB_SPEED_WIRELESS;
2588 else if (hub_is_superspeed(hub->hdev))
2589 udev->speed = USB_SPEED_SUPER;
2590 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2591 udev->speed = USB_SPEED_HIGH;
2592 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2593 udev->speed = USB_SPEED_LOW;
2595 udev->speed = USB_SPEED_FULL;
2599 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2600 struct usb_device *udev, int *status)
2604 /* TRSTRCY = 10 ms; plus some extra */
2607 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2609 update_devnum(udev, 0);
2610 /* The xHC may think the device is already reset,
2611 * so ignore the status.
2613 if (hcd->driver->reset_device)
2614 hcd->driver->reset_device(hcd, udev);
2619 usb_clear_port_feature(hub->hdev,
2620 port1, USB_PORT_FEAT_C_RESET);
2621 if (hub_is_superspeed(hub->hdev)) {
2622 usb_clear_port_feature(hub->hdev, port1,
2623 USB_PORT_FEAT_C_BH_PORT_RESET);
2624 usb_clear_port_feature(hub->hdev, port1,
2625 USB_PORT_FEAT_C_PORT_LINK_STATE);
2626 usb_clear_port_feature(hub->hdev, port1,
2627 USB_PORT_FEAT_C_CONNECTION);
2630 usb_set_device_state(udev, *status
2631 ? USB_STATE_NOTATTACHED
2632 : USB_STATE_DEFAULT);
2637 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2638 static int hub_port_reset(struct usb_hub *hub, int port1,
2639 struct usb_device *udev, unsigned int delay, bool warm)
2642 u16 portchange, portstatus;
2644 if (!hub_is_superspeed(hub->hdev)) {
2646 dev_err(hub->intfdev, "only USB3 hub support "
2650 /* Block EHCI CF initialization during the port reset.
2651 * Some companion controllers don't like it when they mix.
2653 down_read(&ehci_cf_port_reset_rwsem);
2656 * If the caller hasn't explicitly requested a warm reset,
2657 * double check and see if one is needed.
2659 status = hub_port_status(hub, port1,
2660 &portstatus, &portchange);
2664 if (hub_port_warm_reset_required(hub, portstatus))
2668 /* Reset the port */
2669 for (i = 0; i < PORT_RESET_TRIES; i++) {
2670 status = set_port_feature(hub->hdev, port1, (warm ?
2671 USB_PORT_FEAT_BH_PORT_RESET :
2672 USB_PORT_FEAT_RESET));
2673 if (status == -ENODEV) {
2674 ; /* The hub is gone */
2675 } else if (status) {
2676 dev_err(hub->intfdev,
2677 "cannot %sreset port %d (err = %d)\n",
2678 warm ? "warm " : "", port1, status);
2680 status = hub_port_wait_reset(hub, port1, udev, delay,
2682 if (status && status != -ENOTCONN && status != -ENODEV)
2683 dev_dbg(hub->intfdev,
2684 "port_wait_reset: err = %d\n",
2688 /* Check for disconnect or reset */
2689 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2690 hub_port_finish_reset(hub, port1, udev, &status);
2692 if (!hub_is_superspeed(hub->hdev))
2696 * If a USB 3.0 device migrates from reset to an error
2697 * state, re-issue the warm reset.
2699 if (hub_port_status(hub, port1,
2700 &portstatus, &portchange) < 0)
2703 if (!hub_port_warm_reset_required(hub, portstatus))
2707 * If the port is in SS.Inactive or Compliance Mode, the
2708 * hot or warm reset failed. Try another warm reset.
2711 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2717 dev_dbg (hub->intfdev,
2718 "port %d not enabled, trying %sreset again...\n",
2719 port1, warm ? "warm " : "");
2720 delay = HUB_LONG_RESET_TIME;
2723 dev_err (hub->intfdev,
2724 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2728 if (!hub_is_superspeed(hub->hdev))
2729 up_read(&ehci_cf_port_reset_rwsem);
2734 /* Check if a port is power on */
2735 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2739 if (hub_is_superspeed(hub->hdev)) {
2740 if (portstatus & USB_SS_PORT_STAT_POWER)
2743 if (portstatus & USB_PORT_STAT_POWER)
2752 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2753 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2757 if (hub_is_superspeed(hub->hdev)) {
2758 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2759 == USB_SS_PORT_LS_U3)
2762 if (portstatus & USB_PORT_STAT_SUSPEND)
2769 /* Determine whether the device on a port is ready for a normal resume,
2770 * is ready for a reset-resume, or should be disconnected.
2772 static int check_port_resume_type(struct usb_device *udev,
2773 struct usb_hub *hub, int port1,
2774 int status, unsigned portchange, unsigned portstatus)
2776 /* Is the device still present? */
2777 if (status || port_is_suspended(hub, portstatus) ||
2778 !port_is_power_on(hub, portstatus) ||
2779 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2784 /* Can't do a normal resume if the port isn't enabled,
2785 * so try a reset-resume instead.
2787 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2788 if (udev->persist_enabled)
2789 udev->reset_resume = 1;
2795 dev_dbg(hub->intfdev,
2796 "port %d status %04x.%04x after resume, %d\n",
2797 port1, portchange, portstatus, status);
2798 } else if (udev->reset_resume) {
2800 /* Late port handoff can set status-change bits */
2801 if (portchange & USB_PORT_STAT_C_CONNECTION)
2802 usb_clear_port_feature(hub->hdev, port1,
2803 USB_PORT_FEAT_C_CONNECTION);
2804 if (portchange & USB_PORT_STAT_C_ENABLE)
2805 usb_clear_port_feature(hub->hdev, port1,
2806 USB_PORT_FEAT_C_ENABLE);
2812 int usb_disable_ltm(struct usb_device *udev)
2814 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2816 /* Check if the roothub and device supports LTM. */
2817 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2818 !usb_device_supports_ltm(udev))
2821 /* Clear Feature LTM Enable can only be sent if the device is
2824 if (!udev->actconfig)
2827 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2828 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2829 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2830 USB_CTRL_SET_TIMEOUT);
2832 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2834 void usb_enable_ltm(struct usb_device *udev)
2836 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2838 /* Check if the roothub and device supports LTM. */
2839 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2840 !usb_device_supports_ltm(udev))
2843 /* Set Feature LTM Enable can only be sent if the device is
2846 if (!udev->actconfig)
2849 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2850 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2851 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2852 USB_CTRL_SET_TIMEOUT);
2854 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2857 * usb_enable_remote_wakeup - enable remote wakeup for a device
2858 * @udev: target device
2860 * For USB-2 devices: Set the device's remote wakeup feature.
2862 * For USB-3 devices: Assume there's only one function on the device and
2863 * enable remote wake for the first interface. FIXME if the interface
2864 * association descriptor shows there's more than one function.
2866 static int usb_enable_remote_wakeup(struct usb_device *udev)
2868 if (udev->speed < USB_SPEED_SUPER)
2869 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2870 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2871 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2872 USB_CTRL_SET_TIMEOUT);
2874 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2875 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2876 USB_INTRF_FUNC_SUSPEND,
2877 USB_INTRF_FUNC_SUSPEND_RW |
2878 USB_INTRF_FUNC_SUSPEND_LP,
2879 NULL, 0, USB_CTRL_SET_TIMEOUT);
2883 * usb_disable_remote_wakeup - disable remote wakeup for a device
2884 * @udev: target device
2886 * For USB-2 devices: Clear the device's remote wakeup feature.
2888 * For USB-3 devices: Assume there's only one function on the device and
2889 * disable remote wake for the first interface. FIXME if the interface
2890 * association descriptor shows there's more than one function.
2892 static int usb_disable_remote_wakeup(struct usb_device *udev)
2894 if (udev->speed < USB_SPEED_SUPER)
2895 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2896 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2897 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2898 USB_CTRL_SET_TIMEOUT);
2900 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2901 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2902 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2903 USB_CTRL_SET_TIMEOUT);
2906 /* Count of wakeup-enabled devices at or below udev */
2907 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2909 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2911 return udev->do_remote_wakeup +
2912 (hub ? hub->wakeup_enabled_descendants : 0);
2916 * usb_port_suspend - suspend a usb device's upstream port
2917 * @udev: device that's no longer in active use, not a root hub
2918 * Context: must be able to sleep; device not locked; pm locks held
2920 * Suspends a USB device that isn't in active use, conserving power.
2921 * Devices may wake out of a suspend, if anything important happens,
2922 * using the remote wakeup mechanism. They may also be taken out of
2923 * suspend by the host, using usb_port_resume(). It's also routine
2924 * to disconnect devices while they are suspended.
2926 * This only affects the USB hardware for a device; its interfaces
2927 * (and, for hubs, child devices) must already have been suspended.
2929 * Selective port suspend reduces power; most suspended devices draw
2930 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2931 * All devices below the suspended port are also suspended.
2933 * Devices leave suspend state when the host wakes them up. Some devices
2934 * also support "remote wakeup", where the device can activate the USB
2935 * tree above them to deliver data, such as a keypress or packet. In
2936 * some cases, this wakes the USB host.
2938 * Suspending OTG devices may trigger HNP, if that's been enabled
2939 * between a pair of dual-role devices. That will change roles, such
2940 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2942 * Devices on USB hub ports have only one "suspend" state, corresponding
2943 * to ACPI D2, "may cause the device to lose some context".
2944 * State transitions include:
2946 * - suspend, resume ... when the VBUS power link stays live
2947 * - suspend, disconnect ... VBUS lost
2949 * Once VBUS drop breaks the circuit, the port it's using has to go through
2950 * normal re-enumeration procedures, starting with enabling VBUS power.
2951 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2952 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2953 * timer, no SRP, no requests through sysfs.
2955 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2956 * suspended until their bus goes into global suspend (i.e., the root
2957 * hub is suspended). Nevertheless, we change @udev->state to
2958 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2959 * upstream port setting is stored in @udev->port_is_suspended.
2961 * Returns 0 on success, else negative errno.
2963 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2965 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2966 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2967 int port1 = udev->portnum;
2969 bool really_suspend = true;
2971 /* enable remote wakeup when appropriate; this lets the device
2972 * wake up the upstream hub (including maybe the root hub).
2974 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2975 * we don't explicitly enable it here.
2977 if (udev->do_remote_wakeup) {
2978 status = usb_enable_remote_wakeup(udev);
2980 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2982 /* bail if autosuspend is requested */
2983 if (PMSG_IS_AUTO(msg))
2988 /* disable USB2 hardware LPM */
2989 if (udev->usb2_hw_lpm_enabled == 1)
2990 usb_set_usb2_hardware_lpm(udev, 0);
2992 if (usb_disable_ltm(udev)) {
2993 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
2995 if (PMSG_IS_AUTO(msg))
2998 if (usb_unlocked_disable_lpm(udev)) {
2999 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3001 if (PMSG_IS_AUTO(msg))
3006 if (hub_is_superspeed(hub->hdev))
3007 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3010 * For system suspend, we do not need to enable the suspend feature
3011 * on individual USB-2 ports. The devices will automatically go
3012 * into suspend a few ms after the root hub stops sending packets.
3013 * The USB 2.0 spec calls this "global suspend".
3015 * However, many USB hubs have a bug: They don't relay wakeup requests
3016 * from a downstream port if the port's suspend feature isn't on.
3017 * Therefore we will turn on the suspend feature if udev or any of its
3018 * descendants is enabled for remote wakeup.
3020 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3021 status = set_port_feature(hub->hdev, port1,
3022 USB_PORT_FEAT_SUSPEND);
3024 really_suspend = false;
3028 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3031 /* Try to enable USB3 LPM and LTM again */
3032 usb_unlocked_enable_lpm(udev);
3034 usb_enable_ltm(udev);
3036 /* Try to enable USB2 hardware LPM again */
3037 if (udev->usb2_hw_lpm_capable == 1)
3038 usb_set_usb2_hardware_lpm(udev, 1);
3040 if (udev->do_remote_wakeup)
3041 (void) usb_disable_remote_wakeup(udev);
3044 /* System sleep transitions should never fail */
3045 if (!PMSG_IS_AUTO(msg))
3048 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3049 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3050 udev->do_remote_wakeup);
3051 if (really_suspend) {
3052 udev->port_is_suspended = 1;
3054 /* device has up to 10 msec to fully suspend */
3057 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3060 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3061 pm_runtime_put_sync(&port_dev->dev);
3062 port_dev->did_runtime_put = true;
3065 usb_mark_last_busy(hub->hdev);
3070 * If the USB "suspend" state is in use (rather than "global suspend"),
3071 * many devices will be individually taken out of suspend state using
3072 * special "resume" signaling. This routine kicks in shortly after
3073 * hardware resume signaling is finished, either because of selective
3074 * resume (by host) or remote wakeup (by device) ... now see what changed
3075 * in the tree that's rooted at this device.
3077 * If @udev->reset_resume is set then the device is reset before the
3078 * status check is done.
3080 static int finish_port_resume(struct usb_device *udev)
3085 /* caller owns the udev device lock */
3086 dev_dbg(&udev->dev, "%s\n",
3087 udev->reset_resume ? "finish reset-resume" : "finish resume");
3089 /* usb ch9 identifies four variants of SUSPENDED, based on what
3090 * state the device resumes to. Linux currently won't see the
3091 * first two on the host side; they'd be inside hub_port_init()
3092 * during many timeouts, but khubd can't suspend until later.
3094 usb_set_device_state(udev, udev->actconfig
3095 ? USB_STATE_CONFIGURED
3096 : USB_STATE_ADDRESS);
3098 /* 10.5.4.5 says not to reset a suspended port if the attached
3099 * device is enabled for remote wakeup. Hence the reset
3100 * operation is carried out here, after the port has been
3103 if (udev->reset_resume)
3105 status = usb_reset_and_verify_device(udev);
3107 /* 10.5.4.5 says be sure devices in the tree are still there.
3108 * For now let's assume the device didn't go crazy on resume,
3109 * and device drivers will know about any resume quirks.
3113 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3115 /* If a normal resume failed, try doing a reset-resume */
3116 if (status && !udev->reset_resume && udev->persist_enabled) {
3117 dev_dbg(&udev->dev, "retry with reset-resume\n");
3118 udev->reset_resume = 1;
3119 goto retry_reset_resume;
3124 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3127 * There are a few quirky devices which violate the standard
3128 * by claiming to have remote wakeup enabled after a reset,
3129 * which crash if the feature is cleared, hence check for
3130 * udev->reset_resume
3132 } else if (udev->actconfig && !udev->reset_resume) {
3133 if (udev->speed < USB_SPEED_SUPER) {
3134 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3135 status = usb_disable_remote_wakeup(udev);
3137 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3139 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3140 | USB_INTRF_STAT_FUNC_RW))
3141 status = usb_disable_remote_wakeup(udev);
3146 "disable remote wakeup, status %d\n",
3154 * usb_port_resume - re-activate a suspended usb device's upstream port
3155 * @udev: device to re-activate, not a root hub
3156 * Context: must be able to sleep; device not locked; pm locks held
3158 * This will re-activate the suspended device, increasing power usage
3159 * while letting drivers communicate again with its endpoints.
3160 * USB resume explicitly guarantees that the power session between
3161 * the host and the device is the same as it was when the device
3164 * If @udev->reset_resume is set then this routine won't check that the
3165 * port is still enabled. Furthermore, finish_port_resume() above will
3166 * reset @udev. The end result is that a broken power session can be
3167 * recovered and @udev will appear to persist across a loss of VBUS power.
3169 * For example, if a host controller doesn't maintain VBUS suspend current
3170 * during a system sleep or is reset when the system wakes up, all the USB
3171 * power sessions below it will be broken. This is especially troublesome
3172 * for mass-storage devices containing mounted filesystems, since the
3173 * device will appear to have disconnected and all the memory mappings
3174 * to it will be lost. Using the USB_PERSIST facility, the device can be
3175 * made to appear as if it had not disconnected.
3177 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3178 * every effort to insure that the same device is present after the
3179 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3180 * quite possible for a device to remain unaltered but its media to be
3181 * changed. If the user replaces a flash memory card while the system is
3182 * asleep, he will have only himself to blame when the filesystem on the
3183 * new card is corrupted and the system crashes.
3185 * Returns 0 on success, else negative errno.
3187 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3189 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3190 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3191 int port1 = udev->portnum;
3193 u16 portchange, portstatus;
3195 if (port_dev->did_runtime_put) {
3196 status = pm_runtime_get_sync(&port_dev->dev);
3197 port_dev->did_runtime_put = false;
3199 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3205 /* Skip the initial Clear-Suspend step for a remote wakeup */
3206 status = hub_port_status(hub, port1, &portstatus, &portchange);
3207 if (status == 0 && !port_is_suspended(hub, portstatus))
3208 goto SuspendCleared;
3210 /* dev_dbg(hub->intfdev, "resume port %d\n", port1); */
3212 set_bit(port1, hub->busy_bits);
3214 /* see 7.1.7.7; affects power usage, but not budgeting */
3215 if (hub_is_superspeed(hub->hdev))
3216 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3218 status = usb_clear_port_feature(hub->hdev,
3219 port1, USB_PORT_FEAT_SUSPEND);
3221 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3224 /* drive resume for at least 20 msec */
3225 dev_dbg(&udev->dev, "usb %sresume\n",
3226 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3229 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3230 * stop resume signaling. Then finish the resume
3233 status = hub_port_status(hub, port1, &portstatus, &portchange);
3235 /* TRSMRCY = 10 msec */
3241 udev->port_is_suspended = 0;
3242 if (hub_is_superspeed(hub->hdev)) {
3243 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3244 usb_clear_port_feature(hub->hdev, port1,
3245 USB_PORT_FEAT_C_PORT_LINK_STATE);
3247 if (portchange & USB_PORT_STAT_C_SUSPEND)
3248 usb_clear_port_feature(hub->hdev, port1,
3249 USB_PORT_FEAT_C_SUSPEND);
3253 clear_bit(port1, hub->busy_bits);
3255 status = check_port_resume_type(udev,
3256 hub, port1, status, portchange, portstatus);
3258 status = finish_port_resume(udev);
3260 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3261 hub_port_logical_disconnect(hub, port1);
3263 /* Try to enable USB2 hardware LPM */
3264 if (udev->usb2_hw_lpm_capable == 1)
3265 usb_set_usb2_hardware_lpm(udev, 1);
3267 /* Try to enable USB3 LTM and LPM */
3268 usb_enable_ltm(udev);
3269 usb_unlocked_enable_lpm(udev);
3275 #ifdef CONFIG_PM_RUNTIME
3277 /* caller has locked udev */
3278 int usb_remote_wakeup(struct usb_device *udev)
3282 if (udev->state == USB_STATE_SUSPENDED) {
3283 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3284 status = usb_autoresume_device(udev);
3286 /* Let the drivers do their thing, then... */
3287 usb_autosuspend_device(udev);
3295 static int check_ports_changed(struct usb_hub *hub)
3299 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3300 u16 portstatus, portchange;
3303 status = hub_port_status(hub, port1, &portstatus, &portchange);
3304 if (!status && portchange)
3310 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3312 struct usb_hub *hub = usb_get_intfdata (intf);
3313 struct usb_device *hdev = hub->hdev;
3318 * Warn if children aren't already suspended.
3319 * Also, add up the number of wakeup-enabled descendants.
3321 hub->wakeup_enabled_descendants = 0;
3322 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3323 struct usb_device *udev;
3325 udev = hub->ports[port1 - 1]->child;
3326 if (udev && udev->can_submit) {
3327 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3328 if (PMSG_IS_AUTO(msg))
3332 hub->wakeup_enabled_descendants +=
3333 wakeup_enabled_descendants(udev);
3336 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3337 /* check if there are changes pending on hub ports */
3338 if (check_ports_changed(hub)) {
3339 if (PMSG_IS_AUTO(msg))
3341 pm_wakeup_event(&hdev->dev, 2000);
3345 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3346 /* Enable hub to send remote wakeup for all ports. */
3347 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3348 status = set_port_feature(hdev,
3350 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3351 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3352 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3353 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3357 dev_dbg(&intf->dev, "%s\n", __func__);
3359 /* stop khubd and related activity */
3360 hub_quiesce(hub, HUB_SUSPEND);
3364 static int hub_resume(struct usb_interface *intf)
3366 struct usb_hub *hub = usb_get_intfdata(intf);
3368 dev_dbg(&intf->dev, "%s\n", __func__);
3369 hub_activate(hub, HUB_RESUME);
3373 static int hub_reset_resume(struct usb_interface *intf)
3375 struct usb_hub *hub = usb_get_intfdata(intf);
3377 dev_dbg(&intf->dev, "%s\n", __func__);
3378 hub_activate(hub, HUB_RESET_RESUME);
3383 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3384 * @rhdev: struct usb_device for the root hub
3386 * The USB host controller driver calls this function when its root hub
3387 * is resumed and Vbus power has been interrupted or the controller
3388 * has been reset. The routine marks @rhdev as having lost power.
3389 * When the hub driver is resumed it will take notice and carry out
3390 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3391 * the others will be disconnected.
3393 void usb_root_hub_lost_power(struct usb_device *rhdev)
3395 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3396 rhdev->reset_resume = 1;
3398 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3400 static const char * const usb3_lpm_names[] = {
3408 * Send a Set SEL control transfer to the device, prior to enabling
3409 * device-initiated U1 or U2. This lets the device know the exit latencies from
3410 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3411 * packet from the host.
3413 * This function will fail if the SEL or PEL values for udev are greater than
3414 * the maximum allowed values for the link state to be enabled.
3416 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3418 struct usb_set_sel_req *sel_values;
3419 unsigned long long u1_sel;
3420 unsigned long long u1_pel;
3421 unsigned long long u2_sel;
3422 unsigned long long u2_pel;
3425 if (udev->state != USB_STATE_CONFIGURED)
3428 /* Convert SEL and PEL stored in ns to us */
3429 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3430 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3431 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3432 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3435 * Make sure that the calculated SEL and PEL values for the link
3436 * state we're enabling aren't bigger than the max SEL/PEL
3437 * value that will fit in the SET SEL control transfer.
3438 * Otherwise the device would get an incorrect idea of the exit
3439 * latency for the link state, and could start a device-initiated
3440 * U1/U2 when the exit latencies are too high.
3442 if ((state == USB3_LPM_U1 &&
3443 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3444 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3445 (state == USB3_LPM_U2 &&
3446 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3447 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3448 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3449 usb3_lpm_names[state], u1_sel, u1_pel);
3454 * If we're enabling device-initiated LPM for one link state,
3455 * but the other link state has a too high SEL or PEL value,
3456 * just set those values to the max in the Set SEL request.
3458 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3459 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3461 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3462 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3464 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3465 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3467 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3468 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3471 * usb_enable_lpm() can be called as part of a failed device reset,
3472 * which may be initiated by an error path of a mass storage driver.
3473 * Therefore, use GFP_NOIO.
3475 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3479 sel_values->u1_sel = u1_sel;
3480 sel_values->u1_pel = u1_pel;
3481 sel_values->u2_sel = cpu_to_le16(u2_sel);
3482 sel_values->u2_pel = cpu_to_le16(u2_pel);
3484 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3488 sel_values, sizeof *(sel_values),
3489 USB_CTRL_SET_TIMEOUT);
3495 * Enable or disable device-initiated U1 or U2 transitions.
3497 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3498 enum usb3_link_state state, bool enable)
3505 feature = USB_DEVICE_U1_ENABLE;
3508 feature = USB_DEVICE_U2_ENABLE;
3511 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3512 __func__, enable ? "enable" : "disable");
3516 if (udev->state != USB_STATE_CONFIGURED) {
3517 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3518 "for unconfigured device.\n",
3519 __func__, enable ? "enable" : "disable",
3520 usb3_lpm_names[state]);
3526 * Now send the control transfer to enable device-initiated LPM
3527 * for either U1 or U2.
3529 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3530 USB_REQ_SET_FEATURE,
3534 USB_CTRL_SET_TIMEOUT);
3536 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3537 USB_REQ_CLEAR_FEATURE,
3541 USB_CTRL_SET_TIMEOUT);
3544 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3545 enable ? "Enable" : "Disable",
3546 usb3_lpm_names[state]);
3552 static int usb_set_lpm_timeout(struct usb_device *udev,
3553 enum usb3_link_state state, int timeout)
3560 feature = USB_PORT_FEAT_U1_TIMEOUT;
3563 feature = USB_PORT_FEAT_U2_TIMEOUT;
3566 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3571 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3572 timeout != USB3_LPM_DEVICE_INITIATED) {
3573 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3574 "which is a reserved value.\n",
3575 usb3_lpm_names[state], timeout);
3579 ret = set_port_feature(udev->parent,
3580 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3583 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3584 "error code %i\n", usb3_lpm_names[state],
3588 if (state == USB3_LPM_U1)
3589 udev->u1_params.timeout = timeout;
3591 udev->u2_params.timeout = timeout;
3596 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3599 * We will attempt to enable U1 or U2, but there are no guarantees that the
3600 * control transfers to set the hub timeout or enable device-initiated U1/U2
3601 * will be successful.
3603 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3604 * driver know about it. If that call fails, it should be harmless, and just
3605 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3607 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3608 enum usb3_link_state state)
3611 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3612 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3614 /* If the device says it doesn't have *any* exit latency to come out of
3615 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3618 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3619 (state == USB3_LPM_U2 && u2_mel == 0))
3623 * First, let the device know about the exit latencies
3624 * associated with the link state we're about to enable.
3626 ret = usb_req_set_sel(udev, state);
3628 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3629 usb3_lpm_names[state]);
3633 /* We allow the host controller to set the U1/U2 timeout internally
3634 * first, so that it can change its schedule to account for the
3635 * additional latency to send data to a device in a lower power
3638 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3640 /* xHCI host controller doesn't want to enable this LPM state. */
3645 dev_warn(&udev->dev, "Could not enable %s link state, "
3646 "xHCI error %i.\n", usb3_lpm_names[state],
3651 if (usb_set_lpm_timeout(udev, state, timeout))
3652 /* If we can't set the parent hub U1/U2 timeout,
3653 * device-initiated LPM won't be allowed either, so let the xHCI
3654 * host know that this link state won't be enabled.
3656 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3658 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3659 else if (udev->actconfig)
3660 usb_set_device_initiated_lpm(udev, state, true);
3665 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3668 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3669 * If zero is returned, the parent will not allow the link to go into U1/U2.
3671 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3672 * it won't have an effect on the bus link state because the parent hub will
3673 * still disallow device-initiated U1/U2 entry.
3675 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3676 * possible. The result will be slightly more bus bandwidth will be taken up
3677 * (to account for U1/U2 exit latency), but it should be harmless.
3679 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3680 enum usb3_link_state state)
3686 feature = USB_PORT_FEAT_U1_TIMEOUT;
3689 feature = USB_PORT_FEAT_U2_TIMEOUT;
3692 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3697 if (usb_set_lpm_timeout(udev, state, 0))
3700 usb_set_device_initiated_lpm(udev, state, false);
3702 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3703 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3704 "bus schedule bandwidth may be impacted.\n",
3705 usb3_lpm_names[state]);
3710 * Disable hub-initiated and device-initiated U1 and U2 entry.
3711 * Caller must own the bandwidth_mutex.
3713 * This will call usb_enable_lpm() on failure, which will decrement
3714 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3716 int usb_disable_lpm(struct usb_device *udev)
3718 struct usb_hcd *hcd;
3720 if (!udev || !udev->parent ||
3721 udev->speed != USB_SPEED_SUPER ||
3725 hcd = bus_to_hcd(udev->bus);
3726 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3729 udev->lpm_disable_count++;
3730 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3733 /* If LPM is enabled, attempt to disable it. */
3734 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3736 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3742 usb_enable_lpm(udev);
3745 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3747 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3748 int usb_unlocked_disable_lpm(struct usb_device *udev)
3750 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3756 mutex_lock(hcd->bandwidth_mutex);
3757 ret = usb_disable_lpm(udev);
3758 mutex_unlock(hcd->bandwidth_mutex);
3762 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3765 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3766 * xHCI host policy may prevent U1 or U2 from being enabled.
3768 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3769 * until the lpm_disable_count drops to zero. Caller must own the
3772 void usb_enable_lpm(struct usb_device *udev)
3774 struct usb_hcd *hcd;
3776 if (!udev || !udev->parent ||
3777 udev->speed != USB_SPEED_SUPER ||
3781 udev->lpm_disable_count--;
3782 hcd = bus_to_hcd(udev->bus);
3783 /* Double check that we can both enable and disable LPM.
3784 * Device must be configured to accept set feature U1/U2 timeout.
3786 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3787 !hcd->driver->disable_usb3_lpm_timeout)
3790 if (udev->lpm_disable_count > 0)
3793 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3794 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3796 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3798 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3799 void usb_unlocked_enable_lpm(struct usb_device *udev)
3801 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3806 mutex_lock(hcd->bandwidth_mutex);
3807 usb_enable_lpm(udev);
3808 mutex_unlock(hcd->bandwidth_mutex);
3810 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3813 #else /* CONFIG_PM */
3815 #define hub_suspend NULL
3816 #define hub_resume NULL
3817 #define hub_reset_resume NULL
3819 int usb_disable_lpm(struct usb_device *udev)
3823 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3825 void usb_enable_lpm(struct usb_device *udev) { }
3826 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3828 int usb_unlocked_disable_lpm(struct usb_device *udev)
3832 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3834 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3835 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3837 int usb_disable_ltm(struct usb_device *udev)
3841 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3843 void usb_enable_ltm(struct usb_device *udev) { }
3844 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3846 #endif /* CONFIG_PM */
3849 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3851 * Between connect detection and reset signaling there must be a delay
3852 * of 100ms at least for debounce and power-settling. The corresponding
3853 * timer shall restart whenever the downstream port detects a disconnect.
3855 * Apparently there are some bluetooth and irda-dongles and a number of
3856 * low-speed devices for which this debounce period may last over a second.
3857 * Not covered by the spec - but easy to deal with.
3859 * This implementation uses a 1500ms total debounce timeout; if the
3860 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3861 * every 25ms for transient disconnects. When the port status has been
3862 * unchanged for 100ms it returns the port status.
3864 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3867 int total_time, stable_time = 0;
3868 u16 portchange, portstatus;
3869 unsigned connection = 0xffff;
3871 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3872 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3876 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3877 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3878 if (!must_be_connected ||
3879 (connection == USB_PORT_STAT_CONNECTION))
3880 stable_time += HUB_DEBOUNCE_STEP;
3881 if (stable_time >= HUB_DEBOUNCE_STABLE)
3885 connection = portstatus & USB_PORT_STAT_CONNECTION;
3888 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3889 usb_clear_port_feature(hub->hdev, port1,
3890 USB_PORT_FEAT_C_CONNECTION);
3893 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3895 msleep(HUB_DEBOUNCE_STEP);
3898 dev_dbg (hub->intfdev,
3899 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3900 port1, total_time, stable_time, portstatus);
3902 if (stable_time < HUB_DEBOUNCE_STABLE)
3907 void usb_ep0_reinit(struct usb_device *udev)
3909 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3910 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3911 usb_enable_endpoint(udev, &udev->ep0, true);
3913 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3915 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3916 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3918 static int hub_set_address(struct usb_device *udev, int devnum)
3921 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3924 * The host controller will choose the device address,
3925 * instead of the core having chosen it earlier
3927 if (!hcd->driver->address_device && devnum <= 1)
3929 if (udev->state == USB_STATE_ADDRESS)
3931 if (udev->state != USB_STATE_DEFAULT)
3933 if (hcd->driver->address_device)
3934 retval = hcd->driver->address_device(hcd, udev);
3936 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3937 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3938 NULL, 0, USB_CTRL_SET_TIMEOUT);
3940 update_devnum(udev, devnum);
3941 /* Device now using proper address. */
3942 usb_set_device_state(udev, USB_STATE_ADDRESS);
3943 usb_ep0_reinit(udev);
3949 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
3950 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
3953 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
3954 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
3955 * support bit in the BOS descriptor.
3957 static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
3961 if (!udev->usb2_hw_lpm_capable)
3964 connect_type = usb_get_hub_port_connect_type(udev->parent,
3967 if ((udev->bos->ext_cap->bmAttributes & USB_BESL_SUPPORT) ||
3968 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
3969 udev->usb2_hw_lpm_allowed = 1;
3970 usb_set_usb2_hardware_lpm(udev, 1);
3974 static int hub_enable_device(struct usb_device *udev)
3976 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3978 if (!hcd->driver->enable_device)
3980 if (udev->state == USB_STATE_ADDRESS)
3982 if (udev->state != USB_STATE_DEFAULT)
3985 return hcd->driver->enable_device(hcd, udev);
3988 /* Reset device, (re)assign address, get device descriptor.
3989 * Device connection must be stable, no more debouncing needed.
3990 * Returns device in USB_STATE_ADDRESS, except on error.
3992 * If this is called for an already-existing device (as part of
3993 * usb_reset_and_verify_device), the caller must own the device lock. For a
3994 * newly detected device that is not accessible through any global
3995 * pointers, it's not necessary to lock the device.
3998 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4001 static DEFINE_MUTEX(usb_address0_mutex);
4003 struct usb_device *hdev = hub->hdev;
4004 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4006 unsigned delay = HUB_SHORT_RESET_TIME;
4007 enum usb_device_speed oldspeed = udev->speed;
4009 int devnum = udev->devnum;
4011 /* root hub ports have a slightly longer reset period
4012 * (from USB 2.0 spec, section 7.1.7.5)
4014 if (!hdev->parent) {
4015 delay = HUB_ROOT_RESET_TIME;
4016 if (port1 == hdev->bus->otg_port)
4017 hdev->bus->b_hnp_enable = 0;
4020 /* Some low speed devices have problems with the quick delay, so */
4021 /* be a bit pessimistic with those devices. RHbug #23670 */
4022 if (oldspeed == USB_SPEED_LOW)
4023 delay = HUB_LONG_RESET_TIME;
4025 mutex_lock(&usb_address0_mutex);
4027 /* Reset the device; full speed may morph to high speed */
4028 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4029 retval = hub_port_reset(hub, port1, udev, delay, false);
4030 if (retval < 0) /* error or disconnect */
4032 /* success, speed is known */
4036 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4037 dev_dbg(&udev->dev, "device reset changed speed!\n");
4040 oldspeed = udev->speed;
4042 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4043 * it's fixed size except for full speed devices.
4044 * For Wireless USB devices, ep0 max packet is always 512 (tho
4045 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4047 switch (udev->speed) {
4048 case USB_SPEED_SUPER:
4049 case USB_SPEED_WIRELESS: /* fixed at 512 */
4050 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4052 case USB_SPEED_HIGH: /* fixed at 64 */
4053 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4055 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4056 /* to determine the ep0 maxpacket size, try to read
4057 * the device descriptor to get bMaxPacketSize0 and
4058 * then correct our initial guess.
4060 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4062 case USB_SPEED_LOW: /* fixed at 8 */
4063 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4069 if (udev->speed == USB_SPEED_WIRELESS)
4070 speed = "variable speed Wireless";
4072 speed = usb_speed_string(udev->speed);
4074 if (udev->speed != USB_SPEED_SUPER)
4075 dev_info(&udev->dev,
4076 "%s %s USB device number %d using %s\n",
4077 (udev->config) ? "reset" : "new", speed,
4078 devnum, udev->bus->controller->driver->name);
4080 /* Set up TT records, if needed */
4082 udev->tt = hdev->tt;
4083 udev->ttport = hdev->ttport;
4084 } else if (udev->speed != USB_SPEED_HIGH
4085 && hdev->speed == USB_SPEED_HIGH) {
4087 dev_err(&udev->dev, "parent hub has no TT\n");
4091 udev->tt = &hub->tt;
4092 udev->ttport = port1;
4095 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4096 * Because device hardware and firmware is sometimes buggy in
4097 * this area, and this is how Linux has done it for ages.
4098 * Change it cautiously.
4100 * NOTE: If use_new_scheme() is true we will start by issuing
4101 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4102 * so it may help with some non-standards-compliant devices.
4103 * Otherwise we start with SET_ADDRESS and then try to read the
4104 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4107 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4108 bool did_new_scheme = false;
4110 if (use_new_scheme(udev, retry_counter)) {
4111 struct usb_device_descriptor *buf;
4114 did_new_scheme = true;
4115 retval = hub_enable_device(udev);
4119 #define GET_DESCRIPTOR_BUFSIZE 64
4120 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4126 /* Retry on all errors; some devices are flakey.
4127 * 255 is for WUSB devices, we actually need to use
4128 * 512 (WUSB1.0[4.8.1]).
4130 for (j = 0; j < 3; ++j) {
4131 buf->bMaxPacketSize0 = 0;
4132 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4133 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4134 USB_DT_DEVICE << 8, 0,
4135 buf, GET_DESCRIPTOR_BUFSIZE,
4136 initial_descriptor_timeout);
4137 switch (buf->bMaxPacketSize0) {
4138 case 8: case 16: case 32: case 64: case 255:
4139 if (buf->bDescriptorType ==
4153 udev->descriptor.bMaxPacketSize0 =
4154 buf->bMaxPacketSize0;
4157 retval = hub_port_reset(hub, port1, udev, delay, false);
4158 if (retval < 0) /* error or disconnect */
4160 if (oldspeed != udev->speed) {
4162 "device reset changed speed!\n");
4168 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4173 #undef GET_DESCRIPTOR_BUFSIZE
4177 * If device is WUSB, we already assigned an
4178 * unauthorized address in the Connect Ack sequence;
4179 * authorization will assign the final address.
4181 if (udev->wusb == 0) {
4182 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4183 retval = hub_set_address(udev, devnum);
4189 if (retval != -ENODEV)
4190 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4194 if (udev->speed == USB_SPEED_SUPER) {
4195 devnum = udev->devnum;
4196 dev_info(&udev->dev,
4197 "%s SuperSpeed USB device number %d using %s\n",
4198 (udev->config) ? "reset" : "new",
4199 devnum, udev->bus->controller->driver->name);
4202 /* cope with hardware quirkiness:
4203 * - let SET_ADDRESS settle, some device hardware wants it
4204 * - read ep0 maxpacket even for high and low speed,
4207 /* use_new_scheme() checks the speed which may have
4208 * changed since the initial look so we cache the result
4215 retval = usb_get_device_descriptor(udev, 8);
4217 if (retval != -ENODEV)
4219 "device descriptor read/8, error %d\n",
4231 if (hcd->phy && !hdev->parent)
4232 usb_phy_notify_connect(hcd->phy, udev->speed);
4235 * Some superspeed devices have finished the link training process
4236 * and attached to a superspeed hub port, but the device descriptor
4237 * got from those devices show they aren't superspeed devices. Warm
4238 * reset the port attached by the devices can fix them.
4240 if ((udev->speed == USB_SPEED_SUPER) &&
4241 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4242 dev_err(&udev->dev, "got a wrong device descriptor, "
4243 "warm reset device\n");
4244 hub_port_reset(hub, port1, udev,
4245 HUB_BH_RESET_TIME, true);
4250 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4251 udev->speed == USB_SPEED_SUPER)
4254 i = udev->descriptor.bMaxPacketSize0;
4255 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4256 if (udev->speed == USB_SPEED_LOW ||
4257 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4258 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4262 if (udev->speed == USB_SPEED_FULL)
4263 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4265 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4266 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4267 usb_ep0_reinit(udev);
4270 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4271 if (retval < (signed)sizeof(udev->descriptor)) {
4272 if (retval != -ENODEV)
4273 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4280 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4281 retval = usb_get_bos_descriptor(udev);
4283 udev->lpm_capable = usb_device_supports_lpm(udev);
4284 usb_set_lpm_parameters(udev);
4289 /* notify HCD that we have a device connected and addressed */
4290 if (hcd->driver->update_device)
4291 hcd->driver->update_device(hcd, udev);
4292 hub_set_initial_usb2_lpm_policy(udev);
4295 hub_port_disable(hub, port1, 0);
4296 update_devnum(udev, devnum); /* for disconnect processing */
4298 mutex_unlock(&usb_address0_mutex);
4303 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4305 struct usb_qualifier_descriptor *qual;
4308 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4312 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4313 qual, sizeof *qual);
4314 if (status == sizeof *qual) {
4315 dev_info(&udev->dev, "not running at top speed; "
4316 "connect to a high speed hub\n");
4317 /* hub LEDs are probably harder to miss than syslog */
4318 if (hub->has_indicators) {
4319 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4320 schedule_delayed_work (&hub->leds, 0);
4327 hub_power_remaining (struct usb_hub *hub)
4329 struct usb_device *hdev = hub->hdev;
4333 if (!hub->limited_power)
4336 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4337 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4338 struct usb_device *udev = hub->ports[port1 - 1]->child;
4344 if (hub_is_superspeed(udev))
4350 * Unconfigured devices may not use more than one unit load,
4351 * or 8mA for OTG ports
4353 if (udev->actconfig)
4354 delta = usb_get_max_power(udev, udev->actconfig);
4355 else if (port1 != udev->bus->otg_port || hdev->parent)
4359 if (delta > hub->mA_per_port)
4360 dev_warn(&udev->dev,
4361 "%dmA is over %umA budget for port %d!\n",
4362 delta, hub->mA_per_port, port1);
4365 if (remaining < 0) {
4366 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4373 /* Handle physical or logical connection change events.
4374 * This routine is called when:
4375 * a port connection-change occurs;
4376 * a port enable-change occurs (often caused by EMI);
4377 * usb_reset_and_verify_device() encounters changed descriptors (as from
4378 * a firmware download)
4379 * caller already locked the hub
4381 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4382 u16 portstatus, u16 portchange)
4384 struct usb_device *hdev = hub->hdev;
4385 struct device *hub_dev = hub->intfdev;
4386 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4387 unsigned wHubCharacteristics =
4388 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4389 struct usb_device *udev;
4394 "port %d, status %04x, change %04x, %s\n",
4395 port1, portstatus, portchange, portspeed(hub, portstatus));
4397 if (hub->has_indicators) {
4398 set_port_led(hub, port1, HUB_LED_AUTO);
4399 hub->indicator[port1-1] = INDICATOR_AUTO;
4402 #ifdef CONFIG_USB_OTG
4403 /* during HNP, don't repeat the debounce */
4404 if (hdev->bus->is_b_host)
4405 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4406 USB_PORT_STAT_C_ENABLE);
4409 /* Try to resuscitate an existing device */
4410 udev = hub->ports[port1 - 1]->child;
4411 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4412 udev->state != USB_STATE_NOTATTACHED) {
4413 usb_lock_device(udev);
4414 if (portstatus & USB_PORT_STAT_ENABLE) {
4415 status = 0; /* Nothing to do */
4417 #ifdef CONFIG_PM_RUNTIME
4418 } else if (udev->state == USB_STATE_SUSPENDED &&
4419 udev->persist_enabled) {
4420 /* For a suspended device, treat this as a
4421 * remote wakeup event.
4423 status = usb_remote_wakeup(udev);
4427 status = -ENODEV; /* Don't resuscitate */
4429 usb_unlock_device(udev);
4432 clear_bit(port1, hub->change_bits);
4437 /* Disconnect any existing devices under this port */
4439 if (hcd->phy && !hdev->parent &&
4440 !(portstatus & USB_PORT_STAT_CONNECTION))
4441 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4442 usb_disconnect(&hub->ports[port1 - 1]->child);
4444 clear_bit(port1, hub->change_bits);
4446 /* We can forget about a "removed" device when there's a physical
4447 * disconnect or the connect status changes.
4449 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4450 (portchange & USB_PORT_STAT_C_CONNECTION))
4451 clear_bit(port1, hub->removed_bits);
4453 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4454 USB_PORT_STAT_C_ENABLE)) {
4455 status = hub_port_debounce_be_stable(hub, port1);
4457 if (status != -ENODEV && printk_ratelimit())
4458 dev_err(hub_dev, "connect-debounce failed, "
4459 "port %d disabled\n", port1);
4460 portstatus &= ~USB_PORT_STAT_CONNECTION;
4462 portstatus = status;
4466 /* Return now if debouncing failed or nothing is connected or
4467 * the device was "removed".
4469 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4470 test_bit(port1, hub->removed_bits)) {
4472 /* maybe switch power back on (e.g. root hub was reset) */
4473 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4474 && !port_is_power_on(hub, portstatus))
4475 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4477 if (portstatus & USB_PORT_STAT_ENABLE)
4481 if (hub_is_superspeed(hub->hdev))
4487 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4489 /* reallocate for each attempt, since references
4490 * to the previous one can escape in various ways
4492 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4495 "couldn't allocate port %d usb_device\n",
4500 usb_set_device_state(udev, USB_STATE_POWERED);
4501 udev->bus_mA = hub->mA_per_port;
4502 udev->level = hdev->level + 1;
4503 udev->wusb = hub_is_wusb(hub);
4505 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4506 if (hub_is_superspeed(hub->hdev))
4507 udev->speed = USB_SPEED_SUPER;
4509 udev->speed = USB_SPEED_UNKNOWN;
4511 choose_devnum(udev);
4512 if (udev->devnum <= 0) {
4513 status = -ENOTCONN; /* Don't retry */
4517 /* reset (non-USB 3.0 devices) and get descriptor */
4518 status = hub_port_init(hub, udev, port1, i);
4522 usb_detect_quirks(udev);
4523 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4526 /* consecutive bus-powered hubs aren't reliable; they can
4527 * violate the voltage drop budget. if the new child has
4528 * a "powered" LED, users should notice we didn't enable it
4529 * (without reading syslog), even without per-port LEDs
4532 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4533 && udev->bus_mA <= unit_load) {
4536 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4539 dev_dbg(&udev->dev, "get status %d ?\n", status);
4542 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4544 "can't connect bus-powered hub "
4546 if (hub->has_indicators) {
4547 hub->indicator[port1-1] =
4548 INDICATOR_AMBER_BLINK;
4549 schedule_delayed_work (&hub->leds, 0);
4551 status = -ENOTCONN; /* Don't retry */
4556 /* check for devices running slower than they could */
4557 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4558 && udev->speed == USB_SPEED_FULL
4559 && highspeed_hubs != 0)
4560 check_highspeed (hub, udev, port1);
4562 /* Store the parent's children[] pointer. At this point
4563 * udev becomes globally accessible, although presumably
4564 * no one will look at it until hdev is unlocked.
4568 /* We mustn't add new devices if the parent hub has
4569 * been disconnected; we would race with the
4570 * recursively_mark_NOTATTACHED() routine.
4572 spin_lock_irq(&device_state_lock);
4573 if (hdev->state == USB_STATE_NOTATTACHED)
4576 hub->ports[port1 - 1]->child = udev;
4577 spin_unlock_irq(&device_state_lock);
4579 /* Run it through the hoops (find a driver, etc) */
4581 status = usb_new_device(udev);
4583 spin_lock_irq(&device_state_lock);
4584 hub->ports[port1 - 1]->child = NULL;
4585 spin_unlock_irq(&device_state_lock);
4592 status = hub_power_remaining(hub);
4594 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4599 hub_port_disable(hub, port1, 1);
4601 usb_ep0_reinit(udev);
4602 release_devnum(udev);
4605 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4608 if (hub->hdev->parent ||
4609 !hcd->driver->port_handed_over ||
4610 !(hcd->driver->port_handed_over)(hcd, port1)) {
4611 if (status != -ENOTCONN && status != -ENODEV)
4612 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4617 hub_port_disable(hub, port1, 1);
4618 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4619 hcd->driver->relinquish_port(hcd, port1);
4622 /* Returns 1 if there was a remote wakeup and a connect status change. */
4623 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4624 u16 portstatus, u16 portchange)
4626 struct usb_device *hdev;
4627 struct usb_device *udev;
4628 int connect_change = 0;
4632 udev = hub->ports[port - 1]->child;
4633 if (!hub_is_superspeed(hdev)) {
4634 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4636 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4638 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4639 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4645 /* TRSMRCY = 10 msec */
4648 usb_lock_device(udev);
4649 ret = usb_remote_wakeup(udev);
4650 usb_unlock_device(udev);
4655 hub_port_disable(hub, port, 1);
4657 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4659 return connect_change;
4662 static void hub_events(void)
4664 struct list_head *tmp;
4665 struct usb_device *hdev;
4666 struct usb_interface *intf;
4667 struct usb_hub *hub;
4668 struct device *hub_dev;
4674 int connect_change, wakeup_change;
4677 * We restart the list every time to avoid a deadlock with
4678 * deleting hubs downstream from this one. This should be
4679 * safe since we delete the hub from the event list.
4680 * Not the most efficient, but avoids deadlocks.
4684 /* Grab the first entry at the beginning of the list */
4685 spin_lock_irq(&hub_event_lock);
4686 if (list_empty(&hub_event_list)) {
4687 spin_unlock_irq(&hub_event_lock);
4691 tmp = hub_event_list.next;
4694 hub = list_entry(tmp, struct usb_hub, event_list);
4695 kref_get(&hub->kref);
4696 spin_unlock_irq(&hub_event_lock);
4699 hub_dev = hub->intfdev;
4700 intf = to_usb_interface(hub_dev);
4701 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4702 hdev->state, hdev->maxchild,
4703 /* NOTE: expects max 15 ports... */
4704 (u16) hub->change_bits[0],
4705 (u16) hub->event_bits[0]);
4707 /* Lock the device, then check to see if we were
4708 * disconnected while waiting for the lock to succeed. */
4709 usb_lock_device(hdev);
4710 if (unlikely(hub->disconnected))
4711 goto loop_disconnected;
4713 /* If the hub has died, clean up after it */
4714 if (hdev->state == USB_STATE_NOTATTACHED) {
4715 hub->error = -ENODEV;
4716 hub_quiesce(hub, HUB_DISCONNECT);
4721 ret = usb_autopm_get_interface(intf);
4723 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4727 /* If this is an inactive hub, do nothing */
4732 dev_dbg (hub_dev, "resetting for error %d\n",
4735 ret = usb_reset_device(hdev);
4738 "error resetting hub: %d\n", ret);
4746 /* deal with port status changes */
4747 for (i = 1; i <= hdev->maxchild; i++) {
4748 if (test_bit(i, hub->busy_bits))
4750 connect_change = test_bit(i, hub->change_bits);
4751 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4752 if (!test_and_clear_bit(i, hub->event_bits) &&
4753 !connect_change && !wakeup_change)
4756 ret = hub_port_status(hub, i,
4757 &portstatus, &portchange);
4761 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4762 usb_clear_port_feature(hdev, i,
4763 USB_PORT_FEAT_C_CONNECTION);
4767 if (portchange & USB_PORT_STAT_C_ENABLE) {
4768 if (!connect_change)
4770 "port %d enable change, "
4773 usb_clear_port_feature(hdev, i,
4774 USB_PORT_FEAT_C_ENABLE);
4777 * EM interference sometimes causes badly
4778 * shielded USB devices to be shutdown by
4779 * the hub, this hack enables them again.
4780 * Works at least with mouse driver.
4782 if (!(portstatus & USB_PORT_STAT_ENABLE)
4784 && hub->ports[i - 1]->child) {
4787 "disabled by hub (EMI?), "
4794 if (hub_handle_remote_wakeup(hub, i,
4795 portstatus, portchange))
4798 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4802 dev_dbg(hub_dev, "over-current change on port "
4804 usb_clear_port_feature(hdev, i,
4805 USB_PORT_FEAT_C_OVER_CURRENT);
4806 msleep(100); /* Cool down */
4807 hub_power_on(hub, true);
4808 hub_port_status(hub, i, &status, &unused);
4809 if (status & USB_PORT_STAT_OVERCURRENT)
4810 dev_err(hub_dev, "over-current "
4811 "condition on port %d\n", i);
4814 if (portchange & USB_PORT_STAT_C_RESET) {
4816 "reset change on port %d\n",
4818 usb_clear_port_feature(hdev, i,
4819 USB_PORT_FEAT_C_RESET);
4821 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4822 hub_is_superspeed(hub->hdev)) {
4824 "warm reset change on port %d\n",
4826 usb_clear_port_feature(hdev, i,
4827 USB_PORT_FEAT_C_BH_PORT_RESET);
4829 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4830 usb_clear_port_feature(hub->hdev, i,
4831 USB_PORT_FEAT_C_PORT_LINK_STATE);
4833 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4835 "config error on port %d\n",
4837 usb_clear_port_feature(hub->hdev, i,
4838 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4841 /* Warm reset a USB3 protocol port if it's in
4842 * SS.Inactive state.
4844 if (hub_port_warm_reset_required(hub, portstatus)) {
4846 struct usb_device *udev =
4847 hub->ports[i - 1]->child;
4849 dev_dbg(hub_dev, "warm reset port %d\n", i);
4851 !(portstatus & USB_PORT_STAT_CONNECTION) ||
4852 udev->state == USB_STATE_NOTATTACHED) {
4853 status = hub_port_reset(hub, i,
4854 NULL, HUB_BH_RESET_TIME,
4857 hub_port_disable(hub, i, 1);
4859 usb_lock_device(udev);
4860 status = usb_reset_device(udev);
4861 usb_unlock_device(udev);
4867 hub_port_connect_change(hub, i,
4868 portstatus, portchange);
4871 /* deal with hub status changes */
4872 if (test_and_clear_bit(0, hub->event_bits) == 0)
4874 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4875 dev_err (hub_dev, "get_hub_status failed\n");
4877 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4878 dev_dbg (hub_dev, "power change\n");
4879 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4880 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4881 /* FIXME: Is this always true? */
4882 hub->limited_power = 1;
4884 hub->limited_power = 0;
4886 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4890 dev_dbg(hub_dev, "over-current change\n");
4891 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4892 msleep(500); /* Cool down */
4893 hub_power_on(hub, true);
4894 hub_hub_status(hub, &status, &unused);
4895 if (status & HUB_STATUS_OVERCURRENT)
4896 dev_err(hub_dev, "over-current "
4902 /* Balance the usb_autopm_get_interface() above */
4903 usb_autopm_put_interface_no_suspend(intf);
4905 /* Balance the usb_autopm_get_interface_no_resume() in
4906 * kick_khubd() and allow autosuspend.
4908 usb_autopm_put_interface(intf);
4910 usb_unlock_device(hdev);
4911 kref_put(&hub->kref, hub_release);
4913 } /* end while (1) */
4916 static int hub_thread(void *__unused)
4918 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4919 * port handover. Otherwise it might see that a full-speed device
4920 * was gone before the EHCI controller had handed its port over to
4921 * the companion full-speed controller.
4927 wait_event_freezable(khubd_wait,
4928 !list_empty(&hub_event_list) ||
4929 kthread_should_stop());
4930 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4932 pr_debug("%s: khubd exiting\n", usbcore_name);
4936 static const struct usb_device_id hub_id_table[] = {
4937 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4938 | USB_DEVICE_ID_MATCH_INT_CLASS,
4939 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4940 .bInterfaceClass = USB_CLASS_HUB,
4941 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4942 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4943 .bDeviceClass = USB_CLASS_HUB},
4944 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4945 .bInterfaceClass = USB_CLASS_HUB},
4946 { } /* Terminating entry */
4949 MODULE_DEVICE_TABLE (usb, hub_id_table);
4951 static struct usb_driver hub_driver = {
4954 .disconnect = hub_disconnect,
4955 .suspend = hub_suspend,
4956 .resume = hub_resume,
4957 .reset_resume = hub_reset_resume,
4958 .pre_reset = hub_pre_reset,
4959 .post_reset = hub_post_reset,
4960 .unlocked_ioctl = hub_ioctl,
4961 .id_table = hub_id_table,
4962 .supports_autosuspend = 1,
4965 int usb_hub_init(void)
4967 if (usb_register(&hub_driver) < 0) {
4968 printk(KERN_ERR "%s: can't register hub driver\n",
4973 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4974 if (!IS_ERR(khubd_task))
4977 /* Fall through if kernel_thread failed */
4978 usb_deregister(&hub_driver);
4979 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4984 void usb_hub_cleanup(void)
4986 kthread_stop(khubd_task);
4989 * Hub resources are freed for us by usb_deregister. It calls
4990 * usb_driver_purge on every device which in turn calls that
4991 * devices disconnect function if it is using this driver.
4992 * The hub_disconnect function takes care of releasing the
4993 * individual hub resources. -greg
4995 usb_deregister(&hub_driver);
4996 } /* usb_hub_cleanup() */
4998 static int descriptors_changed(struct usb_device *udev,
4999 struct usb_device_descriptor *old_device_descriptor,
5000 struct usb_host_bos *old_bos)
5004 unsigned serial_len = 0;
5006 unsigned old_length;
5010 if (memcmp(&udev->descriptor, old_device_descriptor,
5011 sizeof(*old_device_descriptor)) != 0)
5014 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5017 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5018 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5020 if (memcmp(udev->bos->desc, old_bos->desc, len))
5024 /* Since the idVendor, idProduct, and bcdDevice values in the
5025 * device descriptor haven't changed, we will assume the
5026 * Manufacturer and Product strings haven't changed either.
5027 * But the SerialNumber string could be different (e.g., a
5028 * different flash card of the same brand).
5031 serial_len = strlen(udev->serial) + 1;
5034 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5035 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5036 len = max(len, old_length);
5039 buf = kmalloc(len, GFP_NOIO);
5041 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5042 /* assume the worst */
5045 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5046 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5047 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5049 if (length != old_length) {
5050 dev_dbg(&udev->dev, "config index %d, error %d\n",
5055 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5057 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5059 ((struct usb_config_descriptor *) buf)->
5060 bConfigurationValue);
5066 if (!changed && serial_len) {
5067 length = usb_string(udev, udev->descriptor.iSerialNumber,
5069 if (length + 1 != serial_len) {
5070 dev_dbg(&udev->dev, "serial string error %d\n",
5073 } else if (memcmp(buf, udev->serial, length) != 0) {
5074 dev_dbg(&udev->dev, "serial string changed\n");
5084 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5085 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5087 * WARNING - don't use this routine to reset a composite device
5088 * (one with multiple interfaces owned by separate drivers)!
5089 * Use usb_reset_device() instead.
5091 * Do a port reset, reassign the device's address, and establish its
5092 * former operating configuration. If the reset fails, or the device's
5093 * descriptors change from their values before the reset, or the original
5094 * configuration and altsettings cannot be restored, a flag will be set
5095 * telling khubd to pretend the device has been disconnected and then
5096 * re-connected. All drivers will be unbound, and the device will be
5097 * re-enumerated and probed all over again.
5099 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5100 * flagged for logical disconnection, or some other negative error code
5101 * if the reset wasn't even attempted.
5104 * The caller must own the device lock. For example, it's safe to use
5105 * this from a driver probe() routine after downloading new firmware.
5106 * For calls that might not occur during probe(), drivers should lock
5107 * the device using usb_lock_device_for_reset().
5109 * Locking exception: This routine may also be called from within an
5110 * autoresume handler. Such usage won't conflict with other tasks
5111 * holding the device lock because these tasks should always call
5112 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5114 static int usb_reset_and_verify_device(struct usb_device *udev)
5116 struct usb_device *parent_hdev = udev->parent;
5117 struct usb_hub *parent_hub;
5118 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5119 struct usb_device_descriptor descriptor = udev->descriptor;
5120 struct usb_host_bos *bos;
5122 int port1 = udev->portnum;
5124 if (udev->state == USB_STATE_NOTATTACHED ||
5125 udev->state == USB_STATE_SUSPENDED) {
5126 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5132 /* this requires hcd-specific logic; see ohci_restart() */
5133 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5136 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5138 /* Disable USB2 hardware LPM.
5139 * It will be re-enabled by the enumeration process.
5141 if (udev->usb2_hw_lpm_enabled == 1)
5142 usb_set_usb2_hardware_lpm(udev, 0);
5147 /* Disable LPM and LTM while we reset the device and reinstall the alt
5148 * settings. Device-initiated LPM settings, and system exit latency
5149 * settings are cleared when the device is reset, so we have to set
5152 ret = usb_unlocked_disable_lpm(udev);
5154 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5157 ret = usb_disable_ltm(udev);
5159 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5164 set_bit(port1, parent_hub->busy_bits);
5165 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5167 /* ep0 maxpacket size may change; let the HCD know about it.
5168 * Other endpoints will be handled by re-enumeration. */
5169 usb_ep0_reinit(udev);
5170 ret = hub_port_init(parent_hub, udev, port1, i);
5171 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5174 clear_bit(port1, parent_hub->busy_bits);
5179 /* Device might have changed firmware (DFU or similar) */
5180 if (descriptors_changed(udev, &descriptor, bos)) {
5181 dev_info(&udev->dev, "device firmware changed\n");
5182 udev->descriptor = descriptor; /* for disconnect() calls */
5186 /* Restore the device's previous configuration */
5187 if (!udev->actconfig)
5190 mutex_lock(hcd->bandwidth_mutex);
5191 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5193 dev_warn(&udev->dev,
5194 "Busted HC? Not enough HCD resources for "
5195 "old configuration.\n");
5196 mutex_unlock(hcd->bandwidth_mutex);
5199 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5200 USB_REQ_SET_CONFIGURATION, 0,
5201 udev->actconfig->desc.bConfigurationValue, 0,
5202 NULL, 0, USB_CTRL_SET_TIMEOUT);
5205 "can't restore configuration #%d (error=%d)\n",
5206 udev->actconfig->desc.bConfigurationValue, ret);
5207 mutex_unlock(hcd->bandwidth_mutex);
5210 mutex_unlock(hcd->bandwidth_mutex);
5211 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5213 /* Put interfaces back into the same altsettings as before.
5214 * Don't bother to send the Set-Interface request for interfaces
5215 * that were already in altsetting 0; besides being unnecessary,
5216 * many devices can't handle it. Instead just reset the host-side
5219 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5220 struct usb_host_config *config = udev->actconfig;
5221 struct usb_interface *intf = config->interface[i];
5222 struct usb_interface_descriptor *desc;
5224 desc = &intf->cur_altsetting->desc;
5225 if (desc->bAlternateSetting == 0) {
5226 usb_disable_interface(udev, intf, true);
5227 usb_enable_interface(udev, intf, true);
5230 /* Let the bandwidth allocation function know that this
5231 * device has been reset, and it will have to use
5232 * alternate setting 0 as the current alternate setting.
5234 intf->resetting_device = 1;
5235 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5236 desc->bAlternateSetting);
5237 intf->resetting_device = 0;
5240 dev_err(&udev->dev, "failed to restore interface %d "
5241 "altsetting %d (error=%d)\n",
5242 desc->bInterfaceNumber,
5243 desc->bAlternateSetting,
5250 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5251 usb_set_usb2_hardware_lpm(udev, 1);
5252 usb_unlocked_enable_lpm(udev);
5253 usb_enable_ltm(udev);
5254 usb_release_bos_descriptor(udev);
5259 /* LPM state doesn't matter when we're about to destroy the device. */
5260 hub_port_logical_disconnect(parent_hub, port1);
5261 usb_release_bos_descriptor(udev);
5267 * usb_reset_device - warn interface drivers and perform a USB port reset
5268 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5270 * Warns all drivers bound to registered interfaces (using their pre_reset
5271 * method), performs the port reset, and then lets the drivers know that
5272 * the reset is over (using their post_reset method).
5274 * Return: The same as for usb_reset_and_verify_device().
5277 * The caller must own the device lock. For example, it's safe to use
5278 * this from a driver probe() routine after downloading new firmware.
5279 * For calls that might not occur during probe(), drivers should lock
5280 * the device using usb_lock_device_for_reset().
5282 * If an interface is currently being probed or disconnected, we assume
5283 * its driver knows how to handle resets. For all other interfaces,
5284 * if the driver doesn't have pre_reset and post_reset methods then
5285 * we attempt to unbind it and rebind afterward.
5287 int usb_reset_device(struct usb_device *udev)
5291 unsigned int noio_flag;
5292 struct usb_host_config *config = udev->actconfig;
5294 if (udev->state == USB_STATE_NOTATTACHED ||
5295 udev->state == USB_STATE_SUSPENDED) {
5296 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5302 * Don't allocate memory with GFP_KERNEL in current
5303 * context to avoid possible deadlock if usb mass
5304 * storage interface or usbnet interface(iSCSI case)
5305 * is included in current configuration. The easist
5306 * approach is to do it for every device reset,
5307 * because the device 'memalloc_noio' flag may have
5308 * not been set before reseting the usb device.
5310 noio_flag = memalloc_noio_save();
5312 /* Prevent autosuspend during the reset */
5313 usb_autoresume_device(udev);
5316 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5317 struct usb_interface *cintf = config->interface[i];
5318 struct usb_driver *drv;
5321 if (cintf->dev.driver) {
5322 drv = to_usb_driver(cintf->dev.driver);
5323 if (drv->pre_reset && drv->post_reset)
5324 unbind = (drv->pre_reset)(cintf);
5325 else if (cintf->condition ==
5326 USB_INTERFACE_BOUND)
5329 usb_forced_unbind_intf(cintf);
5334 ret = usb_reset_and_verify_device(udev);
5337 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5338 struct usb_interface *cintf = config->interface[i];
5339 struct usb_driver *drv;
5340 int rebind = cintf->needs_binding;
5342 if (!rebind && cintf->dev.driver) {
5343 drv = to_usb_driver(cintf->dev.driver);
5344 if (drv->post_reset)
5345 rebind = (drv->post_reset)(cintf);
5346 else if (cintf->condition ==
5347 USB_INTERFACE_BOUND)
5350 if (ret == 0 && rebind)
5351 usb_rebind_intf(cintf);
5355 usb_autosuspend_device(udev);
5356 memalloc_noio_restore(noio_flag);
5359 EXPORT_SYMBOL_GPL(usb_reset_device);
5363 * usb_queue_reset_device - Reset a USB device from an atomic context
5364 * @iface: USB interface belonging to the device to reset
5366 * This function can be used to reset a USB device from an atomic
5367 * context, where usb_reset_device() won't work (as it blocks).
5369 * Doing a reset via this method is functionally equivalent to calling
5370 * usb_reset_device(), except for the fact that it is delayed to a
5371 * workqueue. This means that any drivers bound to other interfaces
5372 * might be unbound, as well as users from usbfs in user space.
5376 * - Scheduling two resets at the same time from two different drivers
5377 * attached to two different interfaces of the same device is
5378 * possible; depending on how the driver attached to each interface
5379 * handles ->pre_reset(), the second reset might happen or not.
5381 * - If a driver is unbound and it had a pending reset, the reset will
5384 * - This function can be called during .probe() or .disconnect()
5385 * times. On return from .disconnect(), any pending resets will be
5388 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5391 * NOTE: We don't do any reference count tracking because it is not
5392 * needed. The lifecycle of the work_struct is tied to the
5393 * usb_interface. Before destroying the interface we cancel the
5394 * work_struct, so the fact that work_struct is queued and or
5395 * running means the interface (and thus, the device) exist and
5398 void usb_queue_reset_device(struct usb_interface *iface)
5400 schedule_work(&iface->reset_ws);
5402 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5405 * usb_hub_find_child - Get the pointer of child device
5406 * attached to the port which is specified by @port1.
5407 * @hdev: USB device belonging to the usb hub
5408 * @port1: port num to indicate which port the child device
5411 * USB drivers call this function to get hub's child device
5414 * Return: %NULL if input param is invalid and
5415 * child's usb_device pointer if non-NULL.
5417 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5420 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5422 if (port1 < 1 || port1 > hdev->maxchild)
5424 return hub->ports[port1 - 1]->child;
5426 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5429 * usb_set_hub_port_connect_type - set hub port connect type.
5430 * @hdev: USB device belonging to the usb hub
5431 * @port1: port num of the port
5432 * @type: connect type of the port
5434 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5435 enum usb_port_connect_type type)
5437 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5440 hub->ports[port1 - 1]->connect_type = type;
5444 * usb_get_hub_port_connect_type - Get the port's connect type
5445 * @hdev: USB device belonging to the usb hub
5446 * @port1: port num of the port
5448 * Return: The connect type of the port if successful. Or
5449 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5451 enum usb_port_connect_type
5452 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5454 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5457 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5459 return hub->ports[port1 - 1]->connect_type;
5462 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5463 struct usb_hub_descriptor *desc)
5465 enum usb_port_connect_type connect_type;
5468 if (!hub_is_superspeed(hdev)) {
5469 for (i = 1; i <= hdev->maxchild; i++) {
5470 connect_type = usb_get_hub_port_connect_type(hdev, i);
5472 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5473 u8 mask = 1 << (i%8);
5475 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5476 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5478 desc->u.hs.DeviceRemovable[i/8] |= mask;
5483 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5485 for (i = 1; i <= hdev->maxchild; i++) {
5486 connect_type = usb_get_hub_port_connect_type(hdev, i);
5488 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5491 if (!(port_removable & mask)) {
5492 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5494 port_removable |= mask;
5499 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5505 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5506 * @hdev: USB device belonging to the usb hub
5507 * @port1: port num of the port
5509 * Return: Port's acpi handle if successful, %NULL if params are
5512 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5515 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5520 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);