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 static 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");
159 if (udev->parent->lpm_capable)
162 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
163 "Power management will be impacted.\n");
168 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
171 static void usb_set_lpm_mel(struct usb_device *udev,
172 struct usb3_lpm_parameters *udev_lpm_params,
173 unsigned int udev_exit_latency,
175 struct usb3_lpm_parameters *hub_lpm_params,
176 unsigned int hub_exit_latency)
178 unsigned int total_mel;
179 unsigned int device_mel;
180 unsigned int hub_mel;
183 * Calculate the time it takes to transition all links from the roothub
184 * to the parent hub into U0. The parent hub must then decode the
185 * packet (hub header decode latency) to figure out which port it was
188 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
189 * means 0.1us). Multiply that by 100 to get nanoseconds.
191 total_mel = hub_lpm_params->mel +
192 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
195 * How long will it take to transition the downstream hub's port into
196 * U0? The greater of either the hub exit latency or the device exit
199 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
200 * Multiply that by 1000 to get nanoseconds.
202 device_mel = udev_exit_latency * 1000;
203 hub_mel = hub_exit_latency * 1000;
204 if (device_mel > hub_mel)
205 total_mel += device_mel;
207 total_mel += hub_mel;
209 udev_lpm_params->mel = total_mel;
213 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
214 * a transition from either U1 or U2.
216 static void usb_set_lpm_pel(struct usb_device *udev,
217 struct usb3_lpm_parameters *udev_lpm_params,
218 unsigned int udev_exit_latency,
220 struct usb3_lpm_parameters *hub_lpm_params,
221 unsigned int hub_exit_latency,
222 unsigned int port_to_port_exit_latency)
224 unsigned int first_link_pel;
225 unsigned int hub_pel;
228 * First, the device sends an LFPS to transition the link between the
229 * device and the parent hub into U0. The exit latency is the bigger of
230 * the device exit latency or the hub exit latency.
232 if (udev_exit_latency > hub_exit_latency)
233 first_link_pel = udev_exit_latency * 1000;
235 first_link_pel = hub_exit_latency * 1000;
238 * When the hub starts to receive the LFPS, there is a slight delay for
239 * it to figure out that one of the ports is sending an LFPS. Then it
240 * will forward the LFPS to its upstream link. The exit latency is the
241 * delay, plus the PEL that we calculated for this hub.
243 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
246 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
247 * is the greater of the two exit latencies.
249 if (first_link_pel > hub_pel)
250 udev_lpm_params->pel = first_link_pel;
252 udev_lpm_params->pel = hub_pel;
256 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
257 * when a device initiates a transition to U0, until when it will receive the
258 * first packet from the host controller.
260 * Section C.1.5.1 describes the four components to this:
262 * - t2: time for the ERDY to make it from the device to the host.
263 * - t3: a host-specific delay to process the ERDY.
264 * - t4: time for the packet to make it from the host to the device.
266 * t3 is specific to both the xHCI host and the platform the host is integrated
267 * into. The Intel HW folks have said it's negligible, FIXME if a different
268 * vendor says otherwise.
270 static void usb_set_lpm_sel(struct usb_device *udev,
271 struct usb3_lpm_parameters *udev_lpm_params)
273 struct usb_device *parent;
274 unsigned int num_hubs;
275 unsigned int total_sel;
277 /* t1 = device PEL */
278 total_sel = udev_lpm_params->pel;
279 /* How many external hubs are in between the device & the root port. */
280 for (parent = udev->parent, num_hubs = 0; parent->parent;
281 parent = parent->parent)
283 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
285 total_sel += 2100 + 250 * (num_hubs - 1);
287 /* t4 = 250ns * num_hubs */
288 total_sel += 250 * num_hubs;
290 udev_lpm_params->sel = total_sel;
293 static void usb_set_lpm_parameters(struct usb_device *udev)
296 unsigned int port_to_port_delay;
297 unsigned int udev_u1_del;
298 unsigned int udev_u2_del;
299 unsigned int hub_u1_del;
300 unsigned int hub_u2_del;
302 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
305 hub = usb_hub_to_struct_hub(udev->parent);
306 /* It doesn't take time to transition the roothub into U0, since it
307 * doesn't have an upstream link.
312 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
313 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
314 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
315 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
317 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
318 hub, &udev->parent->u1_params, hub_u1_del);
320 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
321 hub, &udev->parent->u2_params, hub_u2_del);
324 * Appendix C, section C.2.2.2, says that there is a slight delay from
325 * when the parent hub notices the downstream port is trying to
326 * transition to U0 to when the hub initiates a U0 transition on its
327 * upstream port. The section says the delays are tPort2PortU1EL and
328 * tPort2PortU2EL, but it doesn't define what they are.
330 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
331 * about the same delays. Use the maximum delay calculations from those
332 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
333 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
334 * assume the device exit latencies they are talking about are the hub
337 * What do we do if the U2 exit latency is less than the U1 exit
338 * latency? It's possible, although not likely...
340 port_to_port_delay = 1;
342 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
343 hub, &udev->parent->u1_params, hub_u1_del,
346 if (hub_u2_del > hub_u1_del)
347 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
349 port_to_port_delay = 1 + hub_u1_del;
351 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
352 hub, &udev->parent->u2_params, hub_u2_del,
355 /* Now that we've got PEL, calculate SEL. */
356 usb_set_lpm_sel(udev, &udev->u1_params);
357 usb_set_lpm_sel(udev, &udev->u2_params);
360 /* USB 2.0 spec Section 11.24.4.5 */
361 static int get_hub_descriptor(struct usb_device *hdev, void *data)
366 if (hub_is_superspeed(hdev)) {
367 dtype = USB_DT_SS_HUB;
368 size = USB_DT_SS_HUB_SIZE;
371 size = sizeof(struct usb_hub_descriptor);
374 for (i = 0; i < 3; i++) {
375 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
376 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
377 dtype << 8, 0, data, size,
378 USB_CTRL_GET_TIMEOUT);
379 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
386 * USB 2.0 spec Section 11.24.2.1
388 static int clear_hub_feature(struct usb_device *hdev, int feature)
390 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
391 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
395 * USB 2.0 spec Section 11.24.2.2
397 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
399 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
400 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
405 * USB 2.0 spec Section 11.24.2.13
407 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
409 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
410 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
415 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
416 * for info about using port indicators
418 static void set_port_led(
424 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
425 USB_PORT_FEAT_INDICATOR);
427 dev_dbg (hub->intfdev,
428 "port %d indicator %s status %d\n",
430 ({ char *s; switch (selector) {
431 case HUB_LED_AMBER: s = "amber"; break;
432 case HUB_LED_GREEN: s = "green"; break;
433 case HUB_LED_OFF: s = "off"; break;
434 case HUB_LED_AUTO: s = "auto"; break;
435 default: s = "??"; break;
440 #define LED_CYCLE_PERIOD ((2*HZ)/3)
442 static void led_work (struct work_struct *work)
444 struct usb_hub *hub =
445 container_of(work, struct usb_hub, leds.work);
446 struct usb_device *hdev = hub->hdev;
448 unsigned changed = 0;
451 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
454 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
455 unsigned selector, mode;
457 /* 30%-50% duty cycle */
459 switch (hub->indicator[i]) {
461 case INDICATOR_CYCLE:
463 selector = HUB_LED_AUTO;
464 mode = INDICATOR_AUTO;
466 /* blinking green = sw attention */
467 case INDICATOR_GREEN_BLINK:
468 selector = HUB_LED_GREEN;
469 mode = INDICATOR_GREEN_BLINK_OFF;
471 case INDICATOR_GREEN_BLINK_OFF:
472 selector = HUB_LED_OFF;
473 mode = INDICATOR_GREEN_BLINK;
475 /* blinking amber = hw attention */
476 case INDICATOR_AMBER_BLINK:
477 selector = HUB_LED_AMBER;
478 mode = INDICATOR_AMBER_BLINK_OFF;
480 case INDICATOR_AMBER_BLINK_OFF:
481 selector = HUB_LED_OFF;
482 mode = INDICATOR_AMBER_BLINK;
484 /* blink green/amber = reserved */
485 case INDICATOR_ALT_BLINK:
486 selector = HUB_LED_GREEN;
487 mode = INDICATOR_ALT_BLINK_OFF;
489 case INDICATOR_ALT_BLINK_OFF:
490 selector = HUB_LED_AMBER;
491 mode = INDICATOR_ALT_BLINK;
496 if (selector != HUB_LED_AUTO)
498 set_port_led(hub, i + 1, selector);
499 hub->indicator[i] = mode;
501 if (!changed && blinkenlights) {
503 cursor %= hub->descriptor->bNbrPorts;
504 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
505 hub->indicator[cursor] = INDICATOR_CYCLE;
509 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
512 /* use a short timeout for hub/port status fetches */
513 #define USB_STS_TIMEOUT 1000
514 #define USB_STS_RETRIES 5
517 * USB 2.0 spec Section 11.24.2.6
519 static int get_hub_status(struct usb_device *hdev,
520 struct usb_hub_status *data)
522 int i, status = -ETIMEDOUT;
524 for (i = 0; i < USB_STS_RETRIES &&
525 (status == -ETIMEDOUT || status == -EPIPE); i++) {
526 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
527 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
528 data, sizeof(*data), USB_STS_TIMEOUT);
534 * USB 2.0 spec Section 11.24.2.7
536 static int get_port_status(struct usb_device *hdev, int port1,
537 struct usb_port_status *data)
539 int i, status = -ETIMEDOUT;
541 for (i = 0; i < USB_STS_RETRIES &&
542 (status == -ETIMEDOUT || status == -EPIPE); i++) {
543 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
544 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
545 data, sizeof(*data), USB_STS_TIMEOUT);
550 static int hub_port_status(struct usb_hub *hub, int port1,
551 u16 *status, u16 *change)
555 mutex_lock(&hub->status_mutex);
556 ret = get_port_status(hub->hdev, port1, &hub->status->port);
559 dev_err(hub->intfdev,
560 "%s failed (err = %d)\n", __func__, ret);
564 *status = le16_to_cpu(hub->status->port.wPortStatus);
565 *change = le16_to_cpu(hub->status->port.wPortChange);
569 mutex_unlock(&hub->status_mutex);
573 static void kick_khubd(struct usb_hub *hub)
577 spin_lock_irqsave(&hub_event_lock, flags);
578 if (!hub->disconnected && list_empty(&hub->event_list)) {
579 list_add_tail(&hub->event_list, &hub_event_list);
581 /* Suppress autosuspend until khubd runs */
582 usb_autopm_get_interface_no_resume(
583 to_usb_interface(hub->intfdev));
584 wake_up(&khubd_wait);
586 spin_unlock_irqrestore(&hub_event_lock, flags);
589 void usb_kick_khubd(struct usb_device *hdev)
591 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
598 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
599 * Notification, which indicates it had initiated remote wakeup.
601 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
602 * device initiates resume, so the USB core will not receive notice of the
603 * resume through the normal hub interrupt URB.
605 void usb_wakeup_notification(struct usb_device *hdev,
606 unsigned int portnum)
613 hub = usb_hub_to_struct_hub(hdev);
615 set_bit(portnum, hub->wakeup_bits);
619 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
621 /* completion function, fires on port status changes and various faults */
622 static void hub_irq(struct urb *urb)
624 struct usb_hub *hub = urb->context;
625 int status = urb->status;
630 case -ENOENT: /* synchronous unlink */
631 case -ECONNRESET: /* async unlink */
632 case -ESHUTDOWN: /* hardware going away */
635 default: /* presumably an error */
636 /* Cause a hub reset after 10 consecutive errors */
637 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
638 if ((++hub->nerrors < 10) || hub->error)
643 /* let khubd handle things */
644 case 0: /* we got data: port status changed */
646 for (i = 0; i < urb->actual_length; ++i)
647 bits |= ((unsigned long) ((*hub->buffer)[i]))
649 hub->event_bits[0] = bits;
655 /* Something happened, let khubd figure it out */
662 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
663 && status != -ENODEV && status != -EPERM)
664 dev_err (hub->intfdev, "resubmit --> %d\n", status);
667 /* USB 2.0 spec Section 11.24.2.3 */
669 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
671 /* Need to clear both directions for control ep */
672 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
673 USB_ENDPOINT_XFER_CONTROL) {
674 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
675 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
676 devinfo ^ 0x8000, tt, NULL, 0, 1000);
680 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
681 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
686 * enumeration blocks khubd for a long time. we use keventd instead, since
687 * long blocking there is the exception, not the rule. accordingly, HCDs
688 * talking to TTs must queue control transfers (not just bulk and iso), so
689 * both can talk to the same hub concurrently.
691 static void hub_tt_work(struct work_struct *work)
693 struct usb_hub *hub =
694 container_of(work, struct usb_hub, tt.clear_work);
697 spin_lock_irqsave (&hub->tt.lock, flags);
698 while (!list_empty(&hub->tt.clear_list)) {
699 struct list_head *next;
700 struct usb_tt_clear *clear;
701 struct usb_device *hdev = hub->hdev;
702 const struct hc_driver *drv;
705 next = hub->tt.clear_list.next;
706 clear = list_entry (next, struct usb_tt_clear, clear_list);
707 list_del (&clear->clear_list);
709 /* drop lock so HCD can concurrently report other TT errors */
710 spin_unlock_irqrestore (&hub->tt.lock, flags);
711 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
712 if (status && status != -ENODEV)
714 "clear tt %d (%04x) error %d\n",
715 clear->tt, clear->devinfo, status);
717 /* Tell the HCD, even if the operation failed */
718 drv = clear->hcd->driver;
719 if (drv->clear_tt_buffer_complete)
720 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
723 spin_lock_irqsave(&hub->tt.lock, flags);
725 spin_unlock_irqrestore (&hub->tt.lock, flags);
729 * usb_hub_set_port_power - control hub port's power state
730 * @hdev: USB device belonging to the usb hub
733 * @set: expected status
735 * call this function to control port's power via setting or
736 * clearing the port's PORT_POWER feature.
738 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
742 struct usb_port *port_dev = hub->ports[port1 - 1];
745 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
747 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
750 port_dev->power_is_on = set;
755 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
756 * @urb: an URB associated with the failed or incomplete split transaction
758 * High speed HCDs use this to tell the hub driver that some split control or
759 * bulk transaction failed in a way that requires clearing internal state of
760 * a transaction translator. This is normally detected (and reported) from
763 * It may not be possible for that hub to handle additional full (or low)
764 * speed transactions until that state is fully cleared out.
766 int usb_hub_clear_tt_buffer(struct urb *urb)
768 struct usb_device *udev = urb->dev;
769 int pipe = urb->pipe;
770 struct usb_tt *tt = udev->tt;
772 struct usb_tt_clear *clear;
774 /* we've got to cope with an arbitrary number of pending TT clears,
775 * since each TT has "at least two" buffers that can need it (and
776 * there can be many TTs per hub). even if they're uncommon.
778 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
779 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
780 /* FIXME recover somehow ... RESET_TT? */
784 /* info that CLEAR_TT_BUFFER needs */
785 clear->tt = tt->multi ? udev->ttport : 1;
786 clear->devinfo = usb_pipeendpoint (pipe);
787 clear->devinfo |= udev->devnum << 4;
788 clear->devinfo |= usb_pipecontrol (pipe)
789 ? (USB_ENDPOINT_XFER_CONTROL << 11)
790 : (USB_ENDPOINT_XFER_BULK << 11);
791 if (usb_pipein (pipe))
792 clear->devinfo |= 1 << 15;
794 /* info for completion callback */
795 clear->hcd = bus_to_hcd(udev->bus);
798 /* tell keventd to clear state for this TT */
799 spin_lock_irqsave (&tt->lock, flags);
800 list_add_tail (&clear->clear_list, &tt->clear_list);
801 schedule_work(&tt->clear_work);
802 spin_unlock_irqrestore (&tt->lock, flags);
805 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
807 /* If do_delay is false, return the number of milliseconds the caller
810 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
813 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
815 u16 wHubCharacteristics =
816 le16_to_cpu(hub->descriptor->wHubCharacteristics);
818 /* Enable power on each port. Some hubs have reserved values
819 * of LPSM (> 2) in their descriptors, even though they are
820 * USB 2.0 hubs. Some hubs do not implement port-power switching
821 * but only emulate it. In all cases, the ports won't work
822 * unless we send these messages to the hub.
824 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
825 dev_dbg(hub->intfdev, "enabling power on all ports\n");
827 dev_dbg(hub->intfdev, "trying to enable port power on "
828 "non-switchable hub\n");
829 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
830 if (hub->ports[port1 - 1]->power_is_on)
831 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
833 usb_clear_port_feature(hub->hdev, port1,
834 USB_PORT_FEAT_POWER);
836 /* Wait at least 100 msec for power to become stable */
837 delay = max(pgood_delay, (unsigned) 100);
843 static int hub_hub_status(struct usb_hub *hub,
844 u16 *status, u16 *change)
848 mutex_lock(&hub->status_mutex);
849 ret = get_hub_status(hub->hdev, &hub->status->hub);
852 dev_err(hub->intfdev,
853 "%s failed (err = %d)\n", __func__, ret);
855 *status = le16_to_cpu(hub->status->hub.wHubStatus);
856 *change = le16_to_cpu(hub->status->hub.wHubChange);
859 mutex_unlock(&hub->status_mutex);
863 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
864 unsigned int link_status)
866 return set_port_feature(hub->hdev,
867 port1 | (link_status << 3),
868 USB_PORT_FEAT_LINK_STATE);
872 * If USB 3.0 ports are placed into the Disabled state, they will no longer
873 * detect any device connects or disconnects. This is generally not what the
874 * USB core wants, since it expects a disabled port to produce a port status
875 * change event when a new device connects.
877 * Instead, set the link state to Disabled, wait for the link to settle into
878 * that state, clear any change bits, and then put the port into the RxDetect
881 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
885 u16 portchange, portstatus;
887 if (!hub_is_superspeed(hub->hdev))
890 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
894 /* Wait for the link to enter the disabled state. */
895 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
896 ret = hub_port_status(hub, port1, &portstatus, &portchange);
900 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
901 USB_SS_PORT_LS_SS_DISABLED)
903 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
905 msleep(HUB_DEBOUNCE_STEP);
907 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
908 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
911 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
914 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
916 struct usb_device *hdev = hub->hdev;
919 if (hub->ports[port1 - 1]->child && set_state)
920 usb_set_device_state(hub->ports[port1 - 1]->child,
921 USB_STATE_NOTATTACHED);
923 if (hub_is_superspeed(hub->hdev))
924 ret = hub_usb3_port_disable(hub, port1);
926 ret = usb_clear_port_feature(hdev, port1,
927 USB_PORT_FEAT_ENABLE);
929 if (ret && ret != -ENODEV)
930 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
936 * Disable a port and mark a logical connect-change event, so that some
937 * time later khubd will disconnect() any existing usb_device on the port
938 * and will re-enumerate if there actually is a device attached.
940 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
942 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
943 hub_port_disable(hub, port1, 1);
945 /* FIXME let caller ask to power down the port:
946 * - some devices won't enumerate without a VBUS power cycle
947 * - SRP saves power that way
948 * - ... new call, TBD ...
949 * That's easy if this hub can switch power per-port, and
950 * khubd reactivates the port later (timer, SRP, etc).
951 * Powerdown must be optional, because of reset/DFU.
954 set_bit(port1, hub->change_bits);
959 * usb_remove_device - disable a device's port on its parent hub
960 * @udev: device to be disabled and removed
961 * Context: @udev locked, must be able to sleep.
963 * After @udev's port has been disabled, khubd is notified and it will
964 * see that the device has been disconnected. When the device is
965 * physically unplugged and something is plugged in, the events will
966 * be received and processed normally.
968 int usb_remove_device(struct usb_device *udev)
971 struct usb_interface *intf;
973 if (!udev->parent) /* Can't remove a root hub */
975 hub = usb_hub_to_struct_hub(udev->parent);
976 intf = to_usb_interface(hub->intfdev);
978 usb_autopm_get_interface(intf);
979 set_bit(udev->portnum, hub->removed_bits);
980 hub_port_logical_disconnect(hub, udev->portnum);
981 usb_autopm_put_interface(intf);
985 enum hub_activation_type {
986 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
987 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
990 static void hub_init_func2(struct work_struct *ws);
991 static void hub_init_func3(struct work_struct *ws);
993 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
995 struct usb_device *hdev = hub->hdev;
1000 bool need_debounce_delay = false;
1003 /* Continue a partial initialization */
1004 if (type == HUB_INIT2)
1006 if (type == HUB_INIT3)
1009 /* The superspeed hub except for root hub has to use Hub Depth
1010 * value as an offset into the route string to locate the bits
1011 * it uses to determine the downstream port number. So hub driver
1012 * should send a set hub depth request to superspeed hub after
1013 * the superspeed hub is set configuration in initialization or
1016 * After a resume, port power should still be on.
1017 * For any other type of activation, turn it on.
1019 if (type != HUB_RESUME) {
1020 if (hdev->parent && hub_is_superspeed(hdev)) {
1021 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1022 HUB_SET_DEPTH, USB_RT_HUB,
1023 hdev->level - 1, 0, NULL, 0,
1024 USB_CTRL_SET_TIMEOUT);
1026 dev_err(hub->intfdev,
1027 "set hub depth failed\n");
1030 /* Speed up system boot by using a delayed_work for the
1031 * hub's initial power-up delays. This is pretty awkward
1032 * and the implementation looks like a home-brewed sort of
1033 * setjmp/longjmp, but it saves at least 100 ms for each
1034 * root hub (assuming usbcore is compiled into the kernel
1035 * rather than as a module). It adds up.
1037 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1038 * because for those activation types the ports have to be
1039 * operational when we return. In theory this could be done
1040 * for HUB_POST_RESET, but it's easier not to.
1042 if (type == HUB_INIT) {
1043 delay = hub_power_on(hub, false);
1044 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1045 schedule_delayed_work(&hub->init_work,
1046 msecs_to_jiffies(delay));
1048 /* Suppress autosuspend until init is done */
1049 usb_autopm_get_interface_no_resume(
1050 to_usb_interface(hub->intfdev));
1051 return; /* Continues at init2: below */
1052 } else if (type == HUB_RESET_RESUME) {
1053 /* The internal host controller state for the hub device
1054 * may be gone after a host power loss on system resume.
1055 * Update the device's info so the HW knows it's a hub.
1057 hcd = bus_to_hcd(hdev->bus);
1058 if (hcd->driver->update_hub_device) {
1059 ret = hcd->driver->update_hub_device(hcd, hdev,
1060 &hub->tt, GFP_NOIO);
1062 dev_err(hub->intfdev, "Host not "
1063 "accepting hub info "
1065 dev_err(hub->intfdev, "LS/FS devices "
1066 "and hubs may not work "
1067 "under this hub\n.");
1070 hub_power_on(hub, true);
1072 hub_power_on(hub, true);
1077 /* Check each port and set hub->change_bits to let khubd know
1078 * which ports need attention.
1080 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1081 struct usb_device *udev = hub->ports[port1 - 1]->child;
1082 u16 portstatus, portchange;
1084 portstatus = portchange = 0;
1085 status = hub_port_status(hub, port1, &portstatus, &portchange);
1086 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1087 dev_dbg(hub->intfdev,
1088 "port %d: status %04x change %04x\n",
1089 port1, portstatus, portchange);
1091 /* After anything other than HUB_RESUME (i.e., initialization
1092 * or any sort of reset), every port should be disabled.
1093 * Unconnected ports should likewise be disabled (paranoia),
1094 * and so should ports for which we have no usb_device.
1096 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1097 type != HUB_RESUME ||
1098 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1100 udev->state == USB_STATE_NOTATTACHED)) {
1102 * USB3 protocol ports will automatically transition
1103 * to Enabled state when detect an USB3.0 device attach.
1104 * Do not disable USB3 protocol ports.
1106 if (!hub_is_superspeed(hdev)) {
1107 usb_clear_port_feature(hdev, port1,
1108 USB_PORT_FEAT_ENABLE);
1109 portstatus &= ~USB_PORT_STAT_ENABLE;
1111 /* Pretend that power was lost for USB3 devs */
1112 portstatus &= ~USB_PORT_STAT_ENABLE;
1116 /* Clear status-change flags; we'll debounce later */
1117 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1118 need_debounce_delay = true;
1119 usb_clear_port_feature(hub->hdev, port1,
1120 USB_PORT_FEAT_C_CONNECTION);
1122 if (portchange & USB_PORT_STAT_C_ENABLE) {
1123 need_debounce_delay = true;
1124 usb_clear_port_feature(hub->hdev, port1,
1125 USB_PORT_FEAT_C_ENABLE);
1127 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1128 hub_is_superspeed(hub->hdev)) {
1129 need_debounce_delay = true;
1130 usb_clear_port_feature(hub->hdev, port1,
1131 USB_PORT_FEAT_C_BH_PORT_RESET);
1133 /* We can forget about a "removed" device when there's a
1134 * physical disconnect or the connect status changes.
1136 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1137 (portchange & USB_PORT_STAT_C_CONNECTION))
1138 clear_bit(port1, hub->removed_bits);
1140 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1141 /* Tell khubd to disconnect the device or
1142 * check for a new connection
1144 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1145 set_bit(port1, hub->change_bits);
1147 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1148 bool port_resumed = (portstatus &
1149 USB_PORT_STAT_LINK_STATE) ==
1151 /* The power session apparently survived the resume.
1152 * If there was an overcurrent or suspend change
1153 * (i.e., remote wakeup request), have khubd
1154 * take care of it. Look at the port link state
1155 * for USB 3.0 hubs, since they don't have a suspend
1156 * change bit, and they don't set the port link change
1157 * bit on device-initiated resume.
1159 if (portchange || (hub_is_superspeed(hub->hdev) &&
1161 set_bit(port1, hub->change_bits);
1163 } else if (udev->persist_enabled) {
1164 struct usb_port *port_dev = hub->ports[port1 - 1];
1167 udev->reset_resume = 1;
1169 /* Don't set the change_bits when the device
1172 if (port_dev->power_is_on)
1173 set_bit(port1, hub->change_bits);
1176 /* The power session is gone; tell khubd */
1177 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1178 set_bit(port1, hub->change_bits);
1182 /* If no port-status-change flags were set, we don't need any
1183 * debouncing. If flags were set we can try to debounce the
1184 * ports all at once right now, instead of letting khubd do them
1185 * one at a time later on.
1187 * If any port-status changes do occur during this delay, khubd
1188 * will see them later and handle them normally.
1190 if (need_debounce_delay) {
1191 delay = HUB_DEBOUNCE_STABLE;
1193 /* Don't do a long sleep inside a workqueue routine */
1194 if (type == HUB_INIT2) {
1195 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1196 schedule_delayed_work(&hub->init_work,
1197 msecs_to_jiffies(delay));
1198 return; /* Continues at init3: below */
1206 status = usb_submit_urb(hub->urb, GFP_NOIO);
1208 dev_err(hub->intfdev, "activate --> %d\n", status);
1209 if (hub->has_indicators && blinkenlights)
1210 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1212 /* Scan all ports that need attention */
1215 /* Allow autosuspend if it was suppressed */
1216 if (type <= HUB_INIT3)
1217 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1220 /* Implement the continuations for the delays above */
1221 static void hub_init_func2(struct work_struct *ws)
1223 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1225 hub_activate(hub, HUB_INIT2);
1228 static void hub_init_func3(struct work_struct *ws)
1230 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1232 hub_activate(hub, HUB_INIT3);
1235 enum hub_quiescing_type {
1236 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1239 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1241 struct usb_device *hdev = hub->hdev;
1244 cancel_delayed_work_sync(&hub->init_work);
1246 /* khubd and related activity won't re-trigger */
1249 if (type != HUB_SUSPEND) {
1250 /* Disconnect all the children */
1251 for (i = 0; i < hdev->maxchild; ++i) {
1252 if (hub->ports[i]->child)
1253 usb_disconnect(&hub->ports[i]->child);
1257 /* Stop khubd and related activity */
1258 usb_kill_urb(hub->urb);
1259 if (hub->has_indicators)
1260 cancel_delayed_work_sync(&hub->leds);
1262 flush_work(&hub->tt.clear_work);
1265 /* caller has locked the hub device */
1266 static int hub_pre_reset(struct usb_interface *intf)
1268 struct usb_hub *hub = usb_get_intfdata(intf);
1270 hub_quiesce(hub, HUB_PRE_RESET);
1274 /* caller has locked the hub device */
1275 static int hub_post_reset(struct usb_interface *intf)
1277 struct usb_hub *hub = usb_get_intfdata(intf);
1279 hub_activate(hub, HUB_POST_RESET);
1283 static int hub_configure(struct usb_hub *hub,
1284 struct usb_endpoint_descriptor *endpoint)
1286 struct usb_hcd *hcd;
1287 struct usb_device *hdev = hub->hdev;
1288 struct device *hub_dev = hub->intfdev;
1289 u16 hubstatus, hubchange;
1290 u16 wHubCharacteristics;
1293 char *message = "out of memory";
1297 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1303 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1308 mutex_init(&hub->status_mutex);
1310 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1311 if (!hub->descriptor) {
1316 /* Request the entire hub descriptor.
1317 * hub->descriptor can handle USB_MAXCHILDREN ports,
1318 * but the hub can/will return fewer bytes here.
1320 ret = get_hub_descriptor(hdev, hub->descriptor);
1322 message = "can't read hub descriptor";
1324 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1325 message = "hub has too many ports!";
1328 } else if (hub->descriptor->bNbrPorts == 0) {
1329 message = "hub doesn't have any ports!";
1334 hdev->maxchild = hub->descriptor->bNbrPorts;
1335 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1336 (hdev->maxchild == 1) ? "" : "s");
1338 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1345 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1346 if (hub_is_superspeed(hdev)) {
1354 /* FIXME for USB 3.0, skip for now */
1355 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1356 !(hub_is_superspeed(hdev))) {
1358 char portstr [USB_MAXCHILDREN + 1];
1360 for (i = 0; i < hdev->maxchild; i++)
1361 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1362 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1364 portstr[hdev->maxchild] = 0;
1365 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1367 dev_dbg(hub_dev, "standalone hub\n");
1369 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1370 case HUB_CHAR_COMMON_LPSM:
1371 dev_dbg(hub_dev, "ganged power switching\n");
1373 case HUB_CHAR_INDV_PORT_LPSM:
1374 dev_dbg(hub_dev, "individual port power switching\n");
1376 case HUB_CHAR_NO_LPSM:
1378 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1382 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1383 case HUB_CHAR_COMMON_OCPM:
1384 dev_dbg(hub_dev, "global over-current protection\n");
1386 case HUB_CHAR_INDV_PORT_OCPM:
1387 dev_dbg(hub_dev, "individual port over-current protection\n");
1389 case HUB_CHAR_NO_OCPM:
1391 dev_dbg(hub_dev, "no over-current protection\n");
1395 spin_lock_init (&hub->tt.lock);
1396 INIT_LIST_HEAD (&hub->tt.clear_list);
1397 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1398 switch (hdev->descriptor.bDeviceProtocol) {
1401 case USB_HUB_PR_HS_SINGLE_TT:
1402 dev_dbg(hub_dev, "Single TT\n");
1405 case USB_HUB_PR_HS_MULTI_TT:
1406 ret = usb_set_interface(hdev, 0, 1);
1408 dev_dbg(hub_dev, "TT per port\n");
1411 dev_err(hub_dev, "Using single TT (err %d)\n",
1416 /* USB 3.0 hubs don't have a TT */
1419 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1420 hdev->descriptor.bDeviceProtocol);
1424 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1425 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1426 case HUB_TTTT_8_BITS:
1427 if (hdev->descriptor.bDeviceProtocol != 0) {
1428 hub->tt.think_time = 666;
1429 dev_dbg(hub_dev, "TT requires at most %d "
1430 "FS bit times (%d ns)\n",
1431 8, hub->tt.think_time);
1434 case HUB_TTTT_16_BITS:
1435 hub->tt.think_time = 666 * 2;
1436 dev_dbg(hub_dev, "TT requires at most %d "
1437 "FS bit times (%d ns)\n",
1438 16, hub->tt.think_time);
1440 case HUB_TTTT_24_BITS:
1441 hub->tt.think_time = 666 * 3;
1442 dev_dbg(hub_dev, "TT requires at most %d "
1443 "FS bit times (%d ns)\n",
1444 24, hub->tt.think_time);
1446 case HUB_TTTT_32_BITS:
1447 hub->tt.think_time = 666 * 4;
1448 dev_dbg(hub_dev, "TT requires at most %d "
1449 "FS bit times (%d ns)\n",
1450 32, hub->tt.think_time);
1454 /* probe() zeroes hub->indicator[] */
1455 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1456 hub->has_indicators = 1;
1457 dev_dbg(hub_dev, "Port indicators are supported\n");
1460 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1461 hub->descriptor->bPwrOn2PwrGood * 2);
1463 /* power budgeting mostly matters with bus-powered hubs,
1464 * and battery-powered root hubs (may provide just 8 mA).
1466 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1468 message = "can't get hub status";
1471 hcd = bus_to_hcd(hdev->bus);
1472 if (hdev == hdev->bus->root_hub) {
1473 if (hcd->power_budget > 0)
1474 hdev->bus_mA = hcd->power_budget;
1476 hdev->bus_mA = full_load * hdev->maxchild;
1477 if (hdev->bus_mA >= full_load)
1478 hub->mA_per_port = full_load;
1480 hub->mA_per_port = hdev->bus_mA;
1481 hub->limited_power = 1;
1483 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1484 int remaining = hdev->bus_mA -
1485 hub->descriptor->bHubContrCurrent;
1487 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1488 hub->descriptor->bHubContrCurrent);
1489 hub->limited_power = 1;
1491 if (remaining < hdev->maxchild * unit_load)
1493 "insufficient power available "
1494 "to use all downstream ports\n");
1495 hub->mA_per_port = unit_load; /* 7.2.1 */
1497 } else { /* Self-powered external hub */
1498 /* FIXME: What about battery-powered external hubs that
1499 * provide less current per port? */
1500 hub->mA_per_port = full_load;
1502 if (hub->mA_per_port < full_load)
1503 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1506 /* Update the HCD's internal representation of this hub before khubd
1507 * starts getting port status changes for devices under the hub.
1509 if (hcd->driver->update_hub_device) {
1510 ret = hcd->driver->update_hub_device(hcd, hdev,
1511 &hub->tt, GFP_KERNEL);
1513 message = "can't update HCD hub info";
1518 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1520 message = "can't get hub status";
1524 /* local power status reports aren't always correct */
1525 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1526 dev_dbg(hub_dev, "local power source is %s\n",
1527 (hubstatus & HUB_STATUS_LOCAL_POWER)
1528 ? "lost (inactive)" : "good");
1530 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1531 dev_dbg(hub_dev, "%sover-current condition exists\n",
1532 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1534 /* set up the interrupt endpoint
1535 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1536 * bytes as USB2.0[11.12.3] says because some hubs are known
1537 * to send more data (and thus cause overflow). For root hubs,
1538 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1539 * to be big enough for at least USB_MAXCHILDREN ports. */
1540 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1541 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1543 if (maxp > sizeof(*hub->buffer))
1544 maxp = sizeof(*hub->buffer);
1546 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1552 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1553 hub, endpoint->bInterval);
1555 /* maybe cycle the hub leds */
1556 if (hub->has_indicators && blinkenlights)
1557 hub->indicator [0] = INDICATOR_CYCLE;
1559 for (i = 0; i < hdev->maxchild; i++)
1560 if (usb_hub_create_port_device(hub, i + 1) < 0)
1561 dev_err(hub->intfdev,
1562 "couldn't create port%d device.\n", i + 1);
1564 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1566 hub_activate(hub, HUB_INIT);
1570 dev_err (hub_dev, "config failed, %s (err %d)\n",
1572 /* hub_disconnect() frees urb and descriptor */
1576 static void hub_release(struct kref *kref)
1578 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1580 usb_put_intf(to_usb_interface(hub->intfdev));
1584 static unsigned highspeed_hubs;
1586 static void hub_disconnect(struct usb_interface *intf)
1588 struct usb_hub *hub = usb_get_intfdata(intf);
1589 struct usb_device *hdev = interface_to_usbdev(intf);
1592 /* Take the hub off the event list and don't let it be added again */
1593 spin_lock_irq(&hub_event_lock);
1594 if (!list_empty(&hub->event_list)) {
1595 list_del_init(&hub->event_list);
1596 usb_autopm_put_interface_no_suspend(intf);
1598 hub->disconnected = 1;
1599 spin_unlock_irq(&hub_event_lock);
1601 /* Disconnect all children and quiesce the hub */
1603 hub_quiesce(hub, HUB_DISCONNECT);
1605 usb_set_intfdata (intf, NULL);
1607 for (i = 0; i < hdev->maxchild; i++)
1608 usb_hub_remove_port_device(hub, i + 1);
1609 hub->hdev->maxchild = 0;
1611 if (hub->hdev->speed == USB_SPEED_HIGH)
1614 usb_free_urb(hub->urb);
1616 kfree(hub->descriptor);
1620 pm_suspend_ignore_children(&intf->dev, false);
1621 kref_put(&hub->kref, hub_release);
1624 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1626 struct usb_host_interface *desc;
1627 struct usb_endpoint_descriptor *endpoint;
1628 struct usb_device *hdev;
1629 struct usb_hub *hub;
1631 desc = intf->cur_altsetting;
1632 hdev = interface_to_usbdev(intf);
1635 * Set default autosuspend delay as 0 to speedup bus suspend,
1636 * based on the below considerations:
1638 * - Unlike other drivers, the hub driver does not rely on the
1639 * autosuspend delay to provide enough time to handle a wakeup
1640 * event, and the submitted status URB is just to check future
1641 * change on hub downstream ports, so it is safe to do it.
1643 * - The patch might cause one or more auto supend/resume for
1644 * below very rare devices when they are plugged into hub
1647 * devices having trouble initializing, and disconnect
1648 * themselves from the bus and then reconnect a second
1651 * devices just for downloading firmware, and disconnects
1652 * themselves after completing it
1654 * For these quite rare devices, their drivers may change the
1655 * autosuspend delay of their parent hub in the probe() to one
1656 * appropriate value to avoid the subtle problem if someone
1659 * - The patch may cause one or more auto suspend/resume on
1660 * hub during running 'lsusb', but it is probably too
1661 * infrequent to worry about.
1663 * - Change autosuspend delay of hub can avoid unnecessary auto
1664 * suspend timer for hub, also may decrease power consumption
1667 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1669 /* Hubs have proper suspend/resume support. */
1670 usb_enable_autosuspend(hdev);
1672 if (hdev->level == MAX_TOPO_LEVEL) {
1674 "Unsupported bus topology: hub nested too deep\n");
1678 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1680 dev_warn(&intf->dev, "ignoring external hub\n");
1685 /* Some hubs have a subclass of 1, which AFAICT according to the */
1686 /* specs is not defined, but it works */
1687 if ((desc->desc.bInterfaceSubClass != 0) &&
1688 (desc->desc.bInterfaceSubClass != 1)) {
1690 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1694 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1695 if (desc->desc.bNumEndpoints != 1)
1696 goto descriptor_error;
1698 endpoint = &desc->endpoint[0].desc;
1700 /* If it's not an interrupt in endpoint, we'd better punt! */
1701 if (!usb_endpoint_is_int_in(endpoint))
1702 goto descriptor_error;
1704 /* We found a hub */
1705 dev_info (&intf->dev, "USB hub found\n");
1707 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1709 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1713 kref_init(&hub->kref);
1714 INIT_LIST_HEAD(&hub->event_list);
1715 hub->intfdev = &intf->dev;
1717 INIT_DELAYED_WORK(&hub->leds, led_work);
1718 INIT_DELAYED_WORK(&hub->init_work, NULL);
1721 usb_set_intfdata (intf, hub);
1722 intf->needs_remote_wakeup = 1;
1723 pm_suspend_ignore_children(&intf->dev, true);
1725 if (hdev->speed == USB_SPEED_HIGH)
1728 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1729 hub->quirk_check_port_auto_suspend = 1;
1731 if (hub_configure(hub, endpoint) >= 0)
1734 hub_disconnect (intf);
1739 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1741 struct usb_device *hdev = interface_to_usbdev (intf);
1742 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1744 /* assert ifno == 0 (part of hub spec) */
1746 case USBDEVFS_HUB_PORTINFO: {
1747 struct usbdevfs_hub_portinfo *info = user_data;
1750 spin_lock_irq(&device_state_lock);
1751 if (hdev->devnum <= 0)
1754 info->nports = hdev->maxchild;
1755 for (i = 0; i < info->nports; i++) {
1756 if (hub->ports[i]->child == NULL)
1760 hub->ports[i]->child->devnum;
1763 spin_unlock_irq(&device_state_lock);
1765 return info->nports + 1;
1774 * Allow user programs to claim ports on a hub. When a device is attached
1775 * to one of these "claimed" ports, the program will "own" the device.
1777 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1778 struct dev_state ***ppowner)
1780 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1782 if (hdev->state == USB_STATE_NOTATTACHED)
1784 if (port1 == 0 || port1 > hdev->maxchild)
1787 /* Devices not managed by the hub driver
1788 * will always have maxchild equal to 0.
1790 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1794 /* In the following three functions, the caller must hold hdev's lock */
1795 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1796 struct dev_state *owner)
1799 struct dev_state **powner;
1801 rc = find_port_owner(hdev, port1, &powner);
1810 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1811 struct dev_state *owner)
1814 struct dev_state **powner;
1816 rc = find_port_owner(hdev, port1, &powner);
1819 if (*powner != owner)
1825 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1827 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1830 for (n = 0; n < hdev->maxchild; n++) {
1831 if (hub->ports[n]->port_owner == owner)
1832 hub->ports[n]->port_owner = NULL;
1837 /* The caller must hold udev's lock */
1838 bool usb_device_is_owned(struct usb_device *udev)
1840 struct usb_hub *hub;
1842 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1844 hub = usb_hub_to_struct_hub(udev->parent);
1845 return !!hub->ports[udev->portnum - 1]->port_owner;
1848 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1850 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1853 for (i = 0; i < udev->maxchild; ++i) {
1854 if (hub->ports[i]->child)
1855 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1857 if (udev->state == USB_STATE_SUSPENDED)
1858 udev->active_duration -= jiffies;
1859 udev->state = USB_STATE_NOTATTACHED;
1863 * usb_set_device_state - change a device's current state (usbcore, hcds)
1864 * @udev: pointer to device whose state should be changed
1865 * @new_state: new state value to be stored
1867 * udev->state is _not_ fully protected by the device lock. Although
1868 * most transitions are made only while holding the lock, the state can
1869 * can change to USB_STATE_NOTATTACHED at almost any time. This
1870 * is so that devices can be marked as disconnected as soon as possible,
1871 * without having to wait for any semaphores to be released. As a result,
1872 * all changes to any device's state must be protected by the
1873 * device_state_lock spinlock.
1875 * Once a device has been added to the device tree, all changes to its state
1876 * should be made using this routine. The state should _not_ be set directly.
1878 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1879 * Otherwise udev->state is set to new_state, and if new_state is
1880 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1881 * to USB_STATE_NOTATTACHED.
1883 void usb_set_device_state(struct usb_device *udev,
1884 enum usb_device_state new_state)
1886 unsigned long flags;
1889 spin_lock_irqsave(&device_state_lock, flags);
1890 if (udev->state == USB_STATE_NOTATTACHED)
1892 else if (new_state != USB_STATE_NOTATTACHED) {
1894 /* root hub wakeup capabilities are managed out-of-band
1895 * and may involve silicon errata ... ignore them here.
1898 if (udev->state == USB_STATE_SUSPENDED
1899 || new_state == USB_STATE_SUSPENDED)
1900 ; /* No change to wakeup settings */
1901 else if (new_state == USB_STATE_CONFIGURED)
1902 wakeup = udev->actconfig->desc.bmAttributes
1903 & USB_CONFIG_ATT_WAKEUP;
1907 if (udev->state == USB_STATE_SUSPENDED &&
1908 new_state != USB_STATE_SUSPENDED)
1909 udev->active_duration -= jiffies;
1910 else if (new_state == USB_STATE_SUSPENDED &&
1911 udev->state != USB_STATE_SUSPENDED)
1912 udev->active_duration += jiffies;
1913 udev->state = new_state;
1915 recursively_mark_NOTATTACHED(udev);
1916 spin_unlock_irqrestore(&device_state_lock, flags);
1918 device_set_wakeup_capable(&udev->dev, wakeup);
1920 EXPORT_SYMBOL_GPL(usb_set_device_state);
1923 * Choose a device number.
1925 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1926 * USB-2.0 buses they are also used as device addresses, however on
1927 * USB-3.0 buses the address is assigned by the controller hardware
1928 * and it usually is not the same as the device number.
1930 * WUSB devices are simple: they have no hubs behind, so the mapping
1931 * device <-> virtual port number becomes 1:1. Why? to simplify the
1932 * life of the device connection logic in
1933 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1934 * handshake we need to assign a temporary address in the unauthorized
1935 * space. For simplicity we use the first virtual port number found to
1936 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1937 * and that becomes it's address [X < 128] or its unauthorized address
1940 * We add 1 as an offset to the one-based USB-stack port number
1941 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1942 * 0 is reserved by USB for default address; (b) Linux's USB stack
1943 * uses always #1 for the root hub of the controller. So USB stack's
1944 * port #1, which is wusb virtual-port #0 has address #2.
1946 * Devices connected under xHCI are not as simple. The host controller
1947 * supports virtualization, so the hardware assigns device addresses and
1948 * the HCD must setup data structures before issuing a set address
1949 * command to the hardware.
1951 static void choose_devnum(struct usb_device *udev)
1954 struct usb_bus *bus = udev->bus;
1956 /* If khubd ever becomes multithreaded, this will need a lock */
1958 devnum = udev->portnum + 1;
1959 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1961 /* Try to allocate the next devnum beginning at
1962 * bus->devnum_next. */
1963 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1966 devnum = find_next_zero_bit(bus->devmap.devicemap,
1968 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1971 set_bit(devnum, bus->devmap.devicemap);
1972 udev->devnum = devnum;
1976 static void release_devnum(struct usb_device *udev)
1978 if (udev->devnum > 0) {
1979 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1984 static void update_devnum(struct usb_device *udev, int devnum)
1986 /* The address for a WUSB device is managed by wusbcore. */
1988 udev->devnum = devnum;
1991 static void hub_free_dev(struct usb_device *udev)
1993 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1995 /* Root hubs aren't real devices, so don't free HCD resources */
1996 if (hcd->driver->free_dev && udev->parent)
1997 hcd->driver->free_dev(hcd, udev);
2001 * usb_disconnect - disconnect a device (usbcore-internal)
2002 * @pdev: pointer to device being disconnected
2003 * Context: !in_interrupt ()
2005 * Something got disconnected. Get rid of it and all of its children.
2007 * If *pdev is a normal device then the parent hub must already be locked.
2008 * If *pdev is a root hub then this routine will acquire the
2009 * usb_bus_list_lock on behalf of the caller.
2011 * Only hub drivers (including virtual root hub drivers for host
2012 * controllers) should ever call this.
2014 * This call is synchronous, and may not be used in an interrupt context.
2016 void usb_disconnect(struct usb_device **pdev)
2018 struct usb_device *udev = *pdev;
2019 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2022 /* mark the device as inactive, so any further urb submissions for
2023 * this device (and any of its children) will fail immediately.
2024 * this quiesces everything except pending urbs.
2026 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2027 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2030 usb_lock_device(udev);
2032 /* Free up all the children before we remove this device */
2033 for (i = 0; i < udev->maxchild; i++) {
2034 if (hub->ports[i]->child)
2035 usb_disconnect(&hub->ports[i]->child);
2038 /* deallocate hcd/hardware state ... nuking all pending urbs and
2039 * cleaning up all state associated with the current configuration
2040 * so that the hardware is now fully quiesced.
2042 dev_dbg (&udev->dev, "unregistering device\n");
2043 usb_disable_device(udev, 0);
2044 usb_hcd_synchronize_unlinks(udev);
2047 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2048 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2050 sysfs_remove_link(&udev->dev.kobj, "port");
2051 sysfs_remove_link(&port_dev->dev.kobj, "device");
2053 if (!port_dev->did_runtime_put)
2054 pm_runtime_put(&port_dev->dev);
2056 port_dev->did_runtime_put = false;
2059 usb_remove_ep_devs(&udev->ep0);
2060 usb_unlock_device(udev);
2062 /* Unregister the device. The device driver is responsible
2063 * for de-configuring the device and invoking the remove-device
2064 * notifier chain (used by usbfs and possibly others).
2066 device_del(&udev->dev);
2068 /* Free the device number and delete the parent's children[]
2069 * (or root_hub) pointer.
2071 release_devnum(udev);
2073 /* Avoid races with recursively_mark_NOTATTACHED() */
2074 spin_lock_irq(&device_state_lock);
2076 spin_unlock_irq(&device_state_lock);
2080 put_device(&udev->dev);
2083 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2084 static void show_string(struct usb_device *udev, char *id, char *string)
2088 dev_info(&udev->dev, "%s: %s\n", id, string);
2091 static void announce_device(struct usb_device *udev)
2093 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2094 le16_to_cpu(udev->descriptor.idVendor),
2095 le16_to_cpu(udev->descriptor.idProduct));
2096 dev_info(&udev->dev,
2097 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2098 udev->descriptor.iManufacturer,
2099 udev->descriptor.iProduct,
2100 udev->descriptor.iSerialNumber);
2101 show_string(udev, "Product", udev->product);
2102 show_string(udev, "Manufacturer", udev->manufacturer);
2103 show_string(udev, "SerialNumber", udev->serial);
2106 static inline void announce_device(struct usb_device *udev) { }
2109 #ifdef CONFIG_USB_OTG
2110 #include "otg_whitelist.h"
2114 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2115 * @udev: newly addressed device (in ADDRESS state)
2117 * Finish enumeration for On-The-Go devices
2119 static int usb_enumerate_device_otg(struct usb_device *udev)
2123 #ifdef CONFIG_USB_OTG
2125 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2126 * to wake us after we've powered off VBUS; and HNP, switching roles
2127 * "host" to "peripheral". The OTG descriptor helps figure this out.
2129 if (!udev->bus->is_b_host
2131 && udev->parent == udev->bus->root_hub) {
2132 struct usb_otg_descriptor *desc = NULL;
2133 struct usb_bus *bus = udev->bus;
2135 /* descriptor may appear anywhere in config */
2136 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2137 le16_to_cpu(udev->config[0].desc.wTotalLength),
2138 USB_DT_OTG, (void **) &desc) == 0) {
2139 if (desc->bmAttributes & USB_OTG_HNP) {
2140 unsigned port1 = udev->portnum;
2142 dev_info(&udev->dev,
2143 "Dual-Role OTG device on %sHNP port\n",
2144 (port1 == bus->otg_port)
2147 /* enable HNP before suspend, it's simpler */
2148 if (port1 == bus->otg_port)
2149 bus->b_hnp_enable = 1;
2150 err = usb_control_msg(udev,
2151 usb_sndctrlpipe(udev, 0),
2152 USB_REQ_SET_FEATURE, 0,
2154 ? USB_DEVICE_B_HNP_ENABLE
2155 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2156 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2158 /* OTG MESSAGE: report errors here,
2159 * customize to match your product.
2161 dev_info(&udev->dev,
2162 "can't set HNP mode: %d\n",
2164 bus->b_hnp_enable = 0;
2170 if (!is_targeted(udev)) {
2172 /* Maybe it can talk to us, though we can't talk to it.
2173 * (Includes HNP test device.)
2175 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2176 err = usb_port_suspend(udev, PMSG_SUSPEND);
2178 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2190 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2191 * @udev: newly addressed device (in ADDRESS state)
2193 * This is only called by usb_new_device() and usb_authorize_device()
2194 * and FIXME -- all comments that apply to them apply here wrt to
2197 * If the device is WUSB and not authorized, we don't attempt to read
2198 * the string descriptors, as they will be errored out by the device
2199 * until it has been authorized.
2201 static int usb_enumerate_device(struct usb_device *udev)
2205 if (udev->config == NULL) {
2206 err = usb_get_configuration(udev);
2209 dev_err(&udev->dev, "can't read configurations, error %d\n",
2214 if (udev->wusb == 1 && udev->authorized == 0) {
2215 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2216 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2217 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2220 /* read the standard strings and cache them if present */
2221 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2222 udev->manufacturer = usb_cache_string(udev,
2223 udev->descriptor.iManufacturer);
2224 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2226 err = usb_enumerate_device_otg(udev);
2230 usb_detect_interface_quirks(udev);
2235 static void set_usb_port_removable(struct usb_device *udev)
2237 struct usb_device *hdev = udev->parent;
2238 struct usb_hub *hub;
2239 u8 port = udev->portnum;
2240 u16 wHubCharacteristics;
2241 bool removable = true;
2246 hub = usb_hub_to_struct_hub(udev->parent);
2248 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2250 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2253 if (hub_is_superspeed(hdev)) {
2254 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2258 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2263 udev->removable = USB_DEVICE_REMOVABLE;
2265 udev->removable = USB_DEVICE_FIXED;
2269 * usb_new_device - perform initial device setup (usbcore-internal)
2270 * @udev: newly addressed device (in ADDRESS state)
2272 * This is called with devices which have been detected but not fully
2273 * enumerated. The device descriptor is available, but not descriptors
2274 * for any device configuration. The caller must have locked either
2275 * the parent hub (if udev is a normal device) or else the
2276 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2277 * udev has already been installed, but udev is not yet visible through
2278 * sysfs or other filesystem code.
2280 * It will return if the device is configured properly or not. Zero if
2281 * the interface was registered with the driver core; else a negative
2284 * This call is synchronous, and may not be used in an interrupt context.
2286 * Only the hub driver or root-hub registrar should ever call this.
2288 int usb_new_device(struct usb_device *udev)
2293 /* Initialize non-root-hub device wakeup to disabled;
2294 * device (un)configuration controls wakeup capable
2295 * sysfs power/wakeup controls wakeup enabled/disabled
2297 device_init_wakeup(&udev->dev, 0);
2300 /* Tell the runtime-PM framework the device is active */
2301 pm_runtime_set_active(&udev->dev);
2302 pm_runtime_get_noresume(&udev->dev);
2303 pm_runtime_use_autosuspend(&udev->dev);
2304 pm_runtime_enable(&udev->dev);
2306 /* By default, forbid autosuspend for all devices. It will be
2307 * allowed for hubs during binding.
2309 usb_disable_autosuspend(udev);
2311 err = usb_enumerate_device(udev); /* Read descriptors */
2314 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2315 udev->devnum, udev->bus->busnum,
2316 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2317 /* export the usbdev device-node for libusb */
2318 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2319 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2321 /* Tell the world! */
2322 announce_device(udev);
2325 add_device_randomness(udev->serial, strlen(udev->serial));
2327 add_device_randomness(udev->product, strlen(udev->product));
2328 if (udev->manufacturer)
2329 add_device_randomness(udev->manufacturer,
2330 strlen(udev->manufacturer));
2332 device_enable_async_suspend(&udev->dev);
2335 * check whether the hub marks this port as non-removable. Do it
2336 * now so that platform-specific data can override it in
2340 set_usb_port_removable(udev);
2342 /* Register the device. The device driver is responsible
2343 * for configuring the device and invoking the add-device
2344 * notifier chain (used by usbfs and possibly others).
2346 err = device_add(&udev->dev);
2348 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2352 /* Create link files between child device and usb port device. */
2354 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2355 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2357 err = sysfs_create_link(&udev->dev.kobj,
2358 &port_dev->dev.kobj, "port");
2362 err = sysfs_create_link(&port_dev->dev.kobj,
2363 &udev->dev.kobj, "device");
2365 sysfs_remove_link(&udev->dev.kobj, "port");
2369 pm_runtime_get_sync(&port_dev->dev);
2372 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2373 usb_mark_last_busy(udev);
2374 pm_runtime_put_sync_autosuspend(&udev->dev);
2378 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2379 pm_runtime_disable(&udev->dev);
2380 pm_runtime_set_suspended(&udev->dev);
2386 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2387 * @usb_dev: USB device
2389 * Move the USB device to a very basic state where interfaces are disabled
2390 * and the device is in fact unconfigured and unusable.
2392 * We share a lock (that we have) with device_del(), so we need to
2395 int usb_deauthorize_device(struct usb_device *usb_dev)
2397 usb_lock_device(usb_dev);
2398 if (usb_dev->authorized == 0)
2399 goto out_unauthorized;
2401 usb_dev->authorized = 0;
2402 usb_set_configuration(usb_dev, -1);
2404 kfree(usb_dev->product);
2405 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2406 kfree(usb_dev->manufacturer);
2407 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2408 kfree(usb_dev->serial);
2409 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2411 usb_destroy_configuration(usb_dev);
2412 usb_dev->descriptor.bNumConfigurations = 0;
2415 usb_unlock_device(usb_dev);
2420 int usb_authorize_device(struct usb_device *usb_dev)
2424 usb_lock_device(usb_dev);
2425 if (usb_dev->authorized == 1)
2426 goto out_authorized;
2428 result = usb_autoresume_device(usb_dev);
2430 dev_err(&usb_dev->dev,
2431 "can't autoresume for authorization: %d\n", result);
2432 goto error_autoresume;
2434 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2436 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2437 "authorization: %d\n", result);
2438 goto error_device_descriptor;
2441 kfree(usb_dev->product);
2442 usb_dev->product = NULL;
2443 kfree(usb_dev->manufacturer);
2444 usb_dev->manufacturer = NULL;
2445 kfree(usb_dev->serial);
2446 usb_dev->serial = NULL;
2448 usb_dev->authorized = 1;
2449 result = usb_enumerate_device(usb_dev);
2451 goto error_enumerate;
2452 /* Choose and set the configuration. This registers the interfaces
2453 * with the driver core and lets interface drivers bind to them.
2455 c = usb_choose_configuration(usb_dev);
2457 result = usb_set_configuration(usb_dev, c);
2459 dev_err(&usb_dev->dev,
2460 "can't set config #%d, error %d\n", c, result);
2461 /* This need not be fatal. The user can try to
2462 * set other configurations. */
2465 dev_info(&usb_dev->dev, "authorized to connect\n");
2468 error_device_descriptor:
2469 usb_autosuspend_device(usb_dev);
2472 usb_unlock_device(usb_dev); // complements locktree
2477 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2478 static unsigned hub_is_wusb(struct usb_hub *hub)
2480 struct usb_hcd *hcd;
2481 if (hub->hdev->parent != NULL) /* not a root hub? */
2483 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2484 return hcd->wireless;
2488 #define PORT_RESET_TRIES 5
2489 #define SET_ADDRESS_TRIES 2
2490 #define GET_DESCRIPTOR_TRIES 2
2491 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2492 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2494 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2495 #define HUB_SHORT_RESET_TIME 10
2496 #define HUB_BH_RESET_TIME 50
2497 #define HUB_LONG_RESET_TIME 200
2498 #define HUB_RESET_TIMEOUT 800
2500 static int hub_port_reset(struct usb_hub *hub, int port1,
2501 struct usb_device *udev, unsigned int delay, bool warm);
2503 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2504 * Port worm reset is required to recover
2506 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2508 return hub_is_superspeed(hub->hdev) &&
2509 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2510 USB_SS_PORT_LS_SS_INACTIVE) ||
2511 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2512 USB_SS_PORT_LS_COMP_MOD)) ;
2515 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2516 struct usb_device *udev, unsigned int delay, bool warm)
2518 int delay_time, ret;
2522 for (delay_time = 0;
2523 delay_time < HUB_RESET_TIMEOUT;
2524 delay_time += delay) {
2525 /* wait to give the device a chance to reset */
2528 /* read and decode port status */
2529 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2533 /* The port state is unknown until the reset completes. */
2534 if (!(portstatus & USB_PORT_STAT_RESET))
2537 /* switch to the long delay after two short delay failures */
2538 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2539 delay = HUB_LONG_RESET_TIME;
2541 dev_dbg (hub->intfdev,
2542 "port %d not %sreset yet, waiting %dms\n",
2543 port1, warm ? "warm " : "", delay);
2546 if ((portstatus & USB_PORT_STAT_RESET))
2549 if (hub_port_warm_reset_required(hub, portstatus))
2552 /* Device went away? */
2553 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2556 /* bomb out completely if the connection bounced. A USB 3.0
2557 * connection may bounce if multiple warm resets were issued,
2558 * but the device may have successfully re-connected. Ignore it.
2560 if (!hub_is_superspeed(hub->hdev) &&
2561 (portchange & USB_PORT_STAT_C_CONNECTION))
2564 if (!(portstatus & USB_PORT_STAT_ENABLE))
2570 if (hub_is_wusb(hub))
2571 udev->speed = USB_SPEED_WIRELESS;
2572 else if (hub_is_superspeed(hub->hdev))
2573 udev->speed = USB_SPEED_SUPER;
2574 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2575 udev->speed = USB_SPEED_HIGH;
2576 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2577 udev->speed = USB_SPEED_LOW;
2579 udev->speed = USB_SPEED_FULL;
2583 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2584 struct usb_device *udev, int *status)
2588 /* TRSTRCY = 10 ms; plus some extra */
2591 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2593 update_devnum(udev, 0);
2594 /* The xHC may think the device is already reset,
2595 * so ignore the status.
2597 if (hcd->driver->reset_device)
2598 hcd->driver->reset_device(hcd, udev);
2603 usb_clear_port_feature(hub->hdev,
2604 port1, USB_PORT_FEAT_C_RESET);
2605 if (hub_is_superspeed(hub->hdev)) {
2606 usb_clear_port_feature(hub->hdev, port1,
2607 USB_PORT_FEAT_C_BH_PORT_RESET);
2608 usb_clear_port_feature(hub->hdev, port1,
2609 USB_PORT_FEAT_C_PORT_LINK_STATE);
2610 usb_clear_port_feature(hub->hdev, port1,
2611 USB_PORT_FEAT_C_CONNECTION);
2614 usb_set_device_state(udev, *status
2615 ? USB_STATE_NOTATTACHED
2616 : USB_STATE_DEFAULT);
2621 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2622 static int hub_port_reset(struct usb_hub *hub, int port1,
2623 struct usb_device *udev, unsigned int delay, bool warm)
2626 u16 portchange, portstatus;
2628 if (!hub_is_superspeed(hub->hdev)) {
2630 dev_err(hub->intfdev, "only USB3 hub support "
2634 /* Block EHCI CF initialization during the port reset.
2635 * Some companion controllers don't like it when they mix.
2637 down_read(&ehci_cf_port_reset_rwsem);
2640 * If the caller hasn't explicitly requested a warm reset,
2641 * double check and see if one is needed.
2643 status = hub_port_status(hub, port1,
2644 &portstatus, &portchange);
2648 if (hub_port_warm_reset_required(hub, portstatus))
2652 /* Reset the port */
2653 for (i = 0; i < PORT_RESET_TRIES; i++) {
2654 status = set_port_feature(hub->hdev, port1, (warm ?
2655 USB_PORT_FEAT_BH_PORT_RESET :
2656 USB_PORT_FEAT_RESET));
2657 if (status == -ENODEV) {
2658 ; /* The hub is gone */
2659 } else if (status) {
2660 dev_err(hub->intfdev,
2661 "cannot %sreset port %d (err = %d)\n",
2662 warm ? "warm " : "", port1, status);
2664 status = hub_port_wait_reset(hub, port1, udev, delay,
2666 if (status && status != -ENOTCONN && status != -ENODEV)
2667 dev_dbg(hub->intfdev,
2668 "port_wait_reset: err = %d\n",
2672 /* Check for disconnect or reset */
2673 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2674 hub_port_finish_reset(hub, port1, udev, &status);
2676 if (!hub_is_superspeed(hub->hdev))
2680 * If a USB 3.0 device migrates from reset to an error
2681 * state, re-issue the warm reset.
2683 if (hub_port_status(hub, port1,
2684 &portstatus, &portchange) < 0)
2687 if (!hub_port_warm_reset_required(hub, portstatus))
2691 * If the port is in SS.Inactive or Compliance Mode, the
2692 * hot or warm reset failed. Try another warm reset.
2695 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2701 dev_dbg (hub->intfdev,
2702 "port %d not enabled, trying %sreset again...\n",
2703 port1, warm ? "warm " : "");
2704 delay = HUB_LONG_RESET_TIME;
2707 dev_err (hub->intfdev,
2708 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2712 if (!hub_is_superspeed(hub->hdev))
2713 up_read(&ehci_cf_port_reset_rwsem);
2718 /* Check if a port is power on */
2719 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2723 if (hub_is_superspeed(hub->hdev)) {
2724 if (portstatus & USB_SS_PORT_STAT_POWER)
2727 if (portstatus & USB_PORT_STAT_POWER)
2736 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2737 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2741 if (hub_is_superspeed(hub->hdev)) {
2742 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2743 == USB_SS_PORT_LS_U3)
2746 if (portstatus & USB_PORT_STAT_SUSPEND)
2753 /* Determine whether the device on a port is ready for a normal resume,
2754 * is ready for a reset-resume, or should be disconnected.
2756 static int check_port_resume_type(struct usb_device *udev,
2757 struct usb_hub *hub, int port1,
2758 int status, unsigned portchange, unsigned portstatus)
2760 /* Is the device still present? */
2761 if (status || port_is_suspended(hub, portstatus) ||
2762 !port_is_power_on(hub, portstatus) ||
2763 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2768 /* Can't do a normal resume if the port isn't enabled,
2769 * so try a reset-resume instead.
2771 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2772 if (udev->persist_enabled)
2773 udev->reset_resume = 1;
2779 dev_dbg(hub->intfdev,
2780 "port %d status %04x.%04x after resume, %d\n",
2781 port1, portchange, portstatus, status);
2782 } else if (udev->reset_resume) {
2784 /* Late port handoff can set status-change bits */
2785 if (portchange & USB_PORT_STAT_C_CONNECTION)
2786 usb_clear_port_feature(hub->hdev, port1,
2787 USB_PORT_FEAT_C_CONNECTION);
2788 if (portchange & USB_PORT_STAT_C_ENABLE)
2789 usb_clear_port_feature(hub->hdev, port1,
2790 USB_PORT_FEAT_C_ENABLE);
2796 int usb_disable_ltm(struct usb_device *udev)
2798 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2800 /* Check if the roothub and device supports LTM. */
2801 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2802 !usb_device_supports_ltm(udev))
2805 /* Clear Feature LTM Enable can only be sent if the device is
2808 if (!udev->actconfig)
2811 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2812 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2813 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2814 USB_CTRL_SET_TIMEOUT);
2816 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2818 void usb_enable_ltm(struct usb_device *udev)
2820 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2822 /* Check if the roothub and device supports LTM. */
2823 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2824 !usb_device_supports_ltm(udev))
2827 /* Set Feature LTM Enable can only be sent if the device is
2830 if (!udev->actconfig)
2833 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2834 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2835 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2836 USB_CTRL_SET_TIMEOUT);
2838 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2841 * usb_enable_remote_wakeup - enable remote wakeup for a device
2842 * @udev: target device
2844 * For USB-2 devices: Set the device's remote wakeup feature.
2846 * For USB-3 devices: Assume there's only one function on the device and
2847 * enable remote wake for the first interface. FIXME if the interface
2848 * association descriptor shows there's more than one function.
2850 static int usb_enable_remote_wakeup(struct usb_device *udev)
2852 if (udev->speed < USB_SPEED_SUPER)
2853 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2854 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2855 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2856 USB_CTRL_SET_TIMEOUT);
2858 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2859 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2860 USB_INTRF_FUNC_SUSPEND,
2861 USB_INTRF_FUNC_SUSPEND_RW |
2862 USB_INTRF_FUNC_SUSPEND_LP,
2863 NULL, 0, USB_CTRL_SET_TIMEOUT);
2867 * usb_disable_remote_wakeup - disable remote wakeup for a device
2868 * @udev: target device
2870 * For USB-2 devices: Clear the device's remote wakeup feature.
2872 * For USB-3 devices: Assume there's only one function on the device and
2873 * disable remote wake for the first interface. FIXME if the interface
2874 * association descriptor shows there's more than one function.
2876 static int usb_disable_remote_wakeup(struct usb_device *udev)
2878 if (udev->speed < USB_SPEED_SUPER)
2879 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2880 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2881 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2882 USB_CTRL_SET_TIMEOUT);
2884 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2885 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2886 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2887 USB_CTRL_SET_TIMEOUT);
2890 /* Count of wakeup-enabled devices at or below udev */
2891 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2893 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2895 return udev->do_remote_wakeup +
2896 (hub ? hub->wakeup_enabled_descendants : 0);
2900 * usb_port_suspend - suspend a usb device's upstream port
2901 * @udev: device that's no longer in active use, not a root hub
2902 * Context: must be able to sleep; device not locked; pm locks held
2904 * Suspends a USB device that isn't in active use, conserving power.
2905 * Devices may wake out of a suspend, if anything important happens,
2906 * using the remote wakeup mechanism. They may also be taken out of
2907 * suspend by the host, using usb_port_resume(). It's also routine
2908 * to disconnect devices while they are suspended.
2910 * This only affects the USB hardware for a device; its interfaces
2911 * (and, for hubs, child devices) must already have been suspended.
2913 * Selective port suspend reduces power; most suspended devices draw
2914 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2915 * All devices below the suspended port are also suspended.
2917 * Devices leave suspend state when the host wakes them up. Some devices
2918 * also support "remote wakeup", where the device can activate the USB
2919 * tree above them to deliver data, such as a keypress or packet. In
2920 * some cases, this wakes the USB host.
2922 * Suspending OTG devices may trigger HNP, if that's been enabled
2923 * between a pair of dual-role devices. That will change roles, such
2924 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2926 * Devices on USB hub ports have only one "suspend" state, corresponding
2927 * to ACPI D2, "may cause the device to lose some context".
2928 * State transitions include:
2930 * - suspend, resume ... when the VBUS power link stays live
2931 * - suspend, disconnect ... VBUS lost
2933 * Once VBUS drop breaks the circuit, the port it's using has to go through
2934 * normal re-enumeration procedures, starting with enabling VBUS power.
2935 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2936 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2937 * timer, no SRP, no requests through sysfs.
2939 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2940 * suspended until their bus goes into global suspend (i.e., the root
2941 * hub is suspended). Nevertheless, we change @udev->state to
2942 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2943 * upstream port setting is stored in @udev->port_is_suspended.
2945 * Returns 0 on success, else negative errno.
2947 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2949 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2950 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2951 enum pm_qos_flags_status pm_qos_stat;
2952 int port1 = udev->portnum;
2954 bool really_suspend = true;
2956 /* enable remote wakeup when appropriate; this lets the device
2957 * wake up the upstream hub (including maybe the root hub).
2959 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2960 * we don't explicitly enable it here.
2962 if (udev->do_remote_wakeup) {
2963 status = usb_enable_remote_wakeup(udev);
2965 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2967 /* bail if autosuspend is requested */
2968 if (PMSG_IS_AUTO(msg))
2973 /* disable USB2 hardware LPM */
2974 if (udev->usb2_hw_lpm_enabled == 1)
2975 usb_set_usb2_hardware_lpm(udev, 0);
2977 if (usb_disable_ltm(udev)) {
2978 dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
2982 if (usb_unlocked_disable_lpm(udev)) {
2983 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2989 if (hub_is_superspeed(hub->hdev))
2990 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
2993 * For system suspend, we do not need to enable the suspend feature
2994 * on individual USB-2 ports. The devices will automatically go
2995 * into suspend a few ms after the root hub stops sending packets.
2996 * The USB 2.0 spec calls this "global suspend".
2998 * However, many USB hubs have a bug: They don't relay wakeup requests
2999 * from a downstream port if the port's suspend feature isn't on.
3000 * Therefore we will turn on the suspend feature if udev or any of its
3001 * descendants is enabled for remote wakeup.
3003 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3004 status = set_port_feature(hub->hdev, port1,
3005 USB_PORT_FEAT_SUSPEND);
3007 really_suspend = false;
3011 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3013 /* paranoia: "should not happen" */
3014 if (udev->do_remote_wakeup)
3015 (void) usb_disable_remote_wakeup(udev);
3017 /* Try to enable USB2 hardware LPM again */
3018 if (udev->usb2_hw_lpm_capable == 1)
3019 usb_set_usb2_hardware_lpm(udev, 1);
3021 /* Try to enable USB3 LTM and LPM again */
3022 usb_enable_ltm(udev);
3023 usb_unlocked_enable_lpm(udev);
3025 /* System sleep transitions should never fail */
3026 if (!PMSG_IS_AUTO(msg))
3029 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3030 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3031 udev->do_remote_wakeup);
3032 if (really_suspend) {
3033 udev->port_is_suspended = 1;
3035 /* device has up to 10 msec to fully suspend */
3038 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3042 * Check whether current status meets the requirement of
3043 * usb port power off mechanism
3045 pm_qos_stat = dev_pm_qos_flags(&port_dev->dev,
3046 PM_QOS_FLAG_NO_POWER_OFF);
3047 if (!udev->do_remote_wakeup
3048 && pm_qos_stat != PM_QOS_FLAGS_ALL
3049 && udev->persist_enabled
3051 pm_runtime_put_sync(&port_dev->dev);
3052 port_dev->did_runtime_put = true;
3055 usb_mark_last_busy(hub->hdev);
3060 * If the USB "suspend" state is in use (rather than "global suspend"),
3061 * many devices will be individually taken out of suspend state using
3062 * special "resume" signaling. This routine kicks in shortly after
3063 * hardware resume signaling is finished, either because of selective
3064 * resume (by host) or remote wakeup (by device) ... now see what changed
3065 * in the tree that's rooted at this device.
3067 * If @udev->reset_resume is set then the device is reset before the
3068 * status check is done.
3070 static int finish_port_resume(struct usb_device *udev)
3075 /* caller owns the udev device lock */
3076 dev_dbg(&udev->dev, "%s\n",
3077 udev->reset_resume ? "finish reset-resume" : "finish resume");
3079 /* usb ch9 identifies four variants of SUSPENDED, based on what
3080 * state the device resumes to. Linux currently won't see the
3081 * first two on the host side; they'd be inside hub_port_init()
3082 * during many timeouts, but khubd can't suspend until later.
3084 usb_set_device_state(udev, udev->actconfig
3085 ? USB_STATE_CONFIGURED
3086 : USB_STATE_ADDRESS);
3088 /* 10.5.4.5 says not to reset a suspended port if the attached
3089 * device is enabled for remote wakeup. Hence the reset
3090 * operation is carried out here, after the port has been
3093 if (udev->reset_resume)
3095 status = usb_reset_and_verify_device(udev);
3097 /* 10.5.4.5 says be sure devices in the tree are still there.
3098 * For now let's assume the device didn't go crazy on resume,
3099 * and device drivers will know about any resume quirks.
3103 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3105 /* If a normal resume failed, try doing a reset-resume */
3106 if (status && !udev->reset_resume && udev->persist_enabled) {
3107 dev_dbg(&udev->dev, "retry with reset-resume\n");
3108 udev->reset_resume = 1;
3109 goto retry_reset_resume;
3114 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3117 * There are a few quirky devices which violate the standard
3118 * by claiming to have remote wakeup enabled after a reset,
3119 * which crash if the feature is cleared, hence check for
3120 * udev->reset_resume
3122 } else if (udev->actconfig && !udev->reset_resume) {
3123 if (udev->speed < USB_SPEED_SUPER) {
3124 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3125 status = usb_disable_remote_wakeup(udev);
3127 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3129 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3130 | USB_INTRF_STAT_FUNC_RW))
3131 status = usb_disable_remote_wakeup(udev);
3136 "disable remote wakeup, status %d\n",
3144 * usb_port_resume - re-activate a suspended usb device's upstream port
3145 * @udev: device to re-activate, not a root hub
3146 * Context: must be able to sleep; device not locked; pm locks held
3148 * This will re-activate the suspended device, increasing power usage
3149 * while letting drivers communicate again with its endpoints.
3150 * USB resume explicitly guarantees that the power session between
3151 * the host and the device is the same as it was when the device
3154 * If @udev->reset_resume is set then this routine won't check that the
3155 * port is still enabled. Furthermore, finish_port_resume() above will
3156 * reset @udev. The end result is that a broken power session can be
3157 * recovered and @udev will appear to persist across a loss of VBUS power.
3159 * For example, if a host controller doesn't maintain VBUS suspend current
3160 * during a system sleep or is reset when the system wakes up, all the USB
3161 * power sessions below it will be broken. This is especially troublesome
3162 * for mass-storage devices containing mounted filesystems, since the
3163 * device will appear to have disconnected and all the memory mappings
3164 * to it will be lost. Using the USB_PERSIST facility, the device can be
3165 * made to appear as if it had not disconnected.
3167 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3168 * every effort to insure that the same device is present after the
3169 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3170 * quite possible for a device to remain unaltered but its media to be
3171 * changed. If the user replaces a flash memory card while the system is
3172 * asleep, he will have only himself to blame when the filesystem on the
3173 * new card is corrupted and the system crashes.
3175 * Returns 0 on success, else negative errno.
3177 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3179 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3180 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3181 int port1 = udev->portnum;
3183 u16 portchange, portstatus;
3185 if (port_dev->did_runtime_put) {
3186 status = pm_runtime_get_sync(&port_dev->dev);
3187 port_dev->did_runtime_put = false;
3189 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3195 /* Skip the initial Clear-Suspend step for a remote wakeup */
3196 status = hub_port_status(hub, port1, &portstatus, &portchange);
3197 if (status == 0 && !port_is_suspended(hub, portstatus))
3198 goto SuspendCleared;
3200 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3202 set_bit(port1, hub->busy_bits);
3204 /* see 7.1.7.7; affects power usage, but not budgeting */
3205 if (hub_is_superspeed(hub->hdev))
3206 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3208 status = usb_clear_port_feature(hub->hdev,
3209 port1, USB_PORT_FEAT_SUSPEND);
3211 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3214 /* drive resume for at least 20 msec */
3215 dev_dbg(&udev->dev, "usb %sresume\n",
3216 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3219 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3220 * stop resume signaling. Then finish the resume
3223 status = hub_port_status(hub, port1, &portstatus, &portchange);
3225 /* TRSMRCY = 10 msec */
3231 udev->port_is_suspended = 0;
3232 if (hub_is_superspeed(hub->hdev)) {
3233 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3234 usb_clear_port_feature(hub->hdev, port1,
3235 USB_PORT_FEAT_C_PORT_LINK_STATE);
3237 if (portchange & USB_PORT_STAT_C_SUSPEND)
3238 usb_clear_port_feature(hub->hdev, port1,
3239 USB_PORT_FEAT_C_SUSPEND);
3243 clear_bit(port1, hub->busy_bits);
3245 status = check_port_resume_type(udev,
3246 hub, port1, status, portchange, portstatus);
3248 status = finish_port_resume(udev);
3250 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3251 hub_port_logical_disconnect(hub, port1);
3253 /* Try to enable USB2 hardware LPM */
3254 if (udev->usb2_hw_lpm_capable == 1)
3255 usb_set_usb2_hardware_lpm(udev, 1);
3257 /* Try to enable USB3 LTM and LPM */
3258 usb_enable_ltm(udev);
3259 usb_unlocked_enable_lpm(udev);
3265 #ifdef CONFIG_PM_RUNTIME
3267 /* caller has locked udev */
3268 int usb_remote_wakeup(struct usb_device *udev)
3272 if (udev->state == USB_STATE_SUSPENDED) {
3273 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3274 status = usb_autoresume_device(udev);
3276 /* Let the drivers do their thing, then... */
3277 usb_autosuspend_device(udev);
3285 static int check_ports_changed(struct usb_hub *hub)
3289 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3290 u16 portstatus, portchange;
3293 status = hub_port_status(hub, port1, &portstatus, &portchange);
3294 if (!status && portchange)
3300 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3302 struct usb_hub *hub = usb_get_intfdata (intf);
3303 struct usb_device *hdev = hub->hdev;
3308 * Warn if children aren't already suspended.
3309 * Also, add up the number of wakeup-enabled descendants.
3311 hub->wakeup_enabled_descendants = 0;
3312 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3313 struct usb_device *udev;
3315 udev = hub->ports[port1 - 1]->child;
3316 if (udev && udev->can_submit) {
3317 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3318 if (PMSG_IS_AUTO(msg))
3322 hub->wakeup_enabled_descendants +=
3323 wakeup_enabled_descendants(udev);
3326 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3327 /* check if there are changes pending on hub ports */
3328 if (check_ports_changed(hub)) {
3329 if (PMSG_IS_AUTO(msg))
3331 pm_wakeup_event(&hdev->dev, 2000);
3335 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3336 /* Enable hub to send remote wakeup for all ports. */
3337 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3338 status = set_port_feature(hdev,
3340 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3341 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3342 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3343 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3347 dev_dbg(&intf->dev, "%s\n", __func__);
3349 /* stop khubd and related activity */
3350 hub_quiesce(hub, HUB_SUSPEND);
3354 static int hub_resume(struct usb_interface *intf)
3356 struct usb_hub *hub = usb_get_intfdata(intf);
3358 dev_dbg(&intf->dev, "%s\n", __func__);
3359 hub_activate(hub, HUB_RESUME);
3363 static int hub_reset_resume(struct usb_interface *intf)
3365 struct usb_hub *hub = usb_get_intfdata(intf);
3367 dev_dbg(&intf->dev, "%s\n", __func__);
3368 hub_activate(hub, HUB_RESET_RESUME);
3373 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3374 * @rhdev: struct usb_device for the root hub
3376 * The USB host controller driver calls this function when its root hub
3377 * is resumed and Vbus power has been interrupted or the controller
3378 * has been reset. The routine marks @rhdev as having lost power.
3379 * When the hub driver is resumed it will take notice and carry out
3380 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3381 * the others will be disconnected.
3383 void usb_root_hub_lost_power(struct usb_device *rhdev)
3385 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3386 rhdev->reset_resume = 1;
3388 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3390 static const char * const usb3_lpm_names[] = {
3398 * Send a Set SEL control transfer to the device, prior to enabling
3399 * device-initiated U1 or U2. This lets the device know the exit latencies from
3400 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3401 * packet from the host.
3403 * This function will fail if the SEL or PEL values for udev are greater than
3404 * the maximum allowed values for the link state to be enabled.
3406 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3408 struct usb_set_sel_req *sel_values;
3409 unsigned long long u1_sel;
3410 unsigned long long u1_pel;
3411 unsigned long long u2_sel;
3412 unsigned long long u2_pel;
3415 /* Convert SEL and PEL stored in ns to us */
3416 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3417 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3418 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3419 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3422 * Make sure that the calculated SEL and PEL values for the link
3423 * state we're enabling aren't bigger than the max SEL/PEL
3424 * value that will fit in the SET SEL control transfer.
3425 * Otherwise the device would get an incorrect idea of the exit
3426 * latency for the link state, and could start a device-initiated
3427 * U1/U2 when the exit latencies are too high.
3429 if ((state == USB3_LPM_U1 &&
3430 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3431 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3432 (state == USB3_LPM_U2 &&
3433 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3434 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3435 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3436 usb3_lpm_names[state], u1_sel, u1_pel);
3441 * If we're enabling device-initiated LPM for one link state,
3442 * but the other link state has a too high SEL or PEL value,
3443 * just set those values to the max in the Set SEL request.
3445 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3446 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3448 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3449 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3451 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3452 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3454 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3455 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3458 * usb_enable_lpm() can be called as part of a failed device reset,
3459 * which may be initiated by an error path of a mass storage driver.
3460 * Therefore, use GFP_NOIO.
3462 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3466 sel_values->u1_sel = u1_sel;
3467 sel_values->u1_pel = u1_pel;
3468 sel_values->u2_sel = cpu_to_le16(u2_sel);
3469 sel_values->u2_pel = cpu_to_le16(u2_pel);
3471 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3475 sel_values, sizeof *(sel_values),
3476 USB_CTRL_SET_TIMEOUT);
3482 * Enable or disable device-initiated U1 or U2 transitions.
3484 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3485 enum usb3_link_state state, bool enable)
3492 feature = USB_DEVICE_U1_ENABLE;
3495 feature = USB_DEVICE_U2_ENABLE;
3498 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3499 __func__, enable ? "enable" : "disable");
3503 if (udev->state != USB_STATE_CONFIGURED) {
3504 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3505 "for unconfigured device.\n",
3506 __func__, enable ? "enable" : "disable",
3507 usb3_lpm_names[state]);
3513 * Now send the control transfer to enable device-initiated LPM
3514 * for either U1 or U2.
3516 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3517 USB_REQ_SET_FEATURE,
3521 USB_CTRL_SET_TIMEOUT);
3523 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3524 USB_REQ_CLEAR_FEATURE,
3528 USB_CTRL_SET_TIMEOUT);
3531 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3532 enable ? "Enable" : "Disable",
3533 usb3_lpm_names[state]);
3539 static int usb_set_lpm_timeout(struct usb_device *udev,
3540 enum usb3_link_state state, int timeout)
3547 feature = USB_PORT_FEAT_U1_TIMEOUT;
3550 feature = USB_PORT_FEAT_U2_TIMEOUT;
3553 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3558 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3559 timeout != USB3_LPM_DEVICE_INITIATED) {
3560 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3561 "which is a reserved value.\n",
3562 usb3_lpm_names[state], timeout);
3566 ret = set_port_feature(udev->parent,
3567 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3570 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3571 "error code %i\n", usb3_lpm_names[state],
3575 if (state == USB3_LPM_U1)
3576 udev->u1_params.timeout = timeout;
3578 udev->u2_params.timeout = timeout;
3583 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3586 * We will attempt to enable U1 or U2, but there are no guarantees that the
3587 * control transfers to set the hub timeout or enable device-initiated U1/U2
3588 * will be successful.
3590 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3591 * driver know about it. If that call fails, it should be harmless, and just
3592 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3594 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3595 enum usb3_link_state state)
3598 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3599 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3601 /* If the device says it doesn't have *any* exit latency to come out of
3602 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3605 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3606 (state == USB3_LPM_U2 && u2_mel == 0))
3610 * First, let the device know about the exit latencies
3611 * associated with the link state we're about to enable.
3613 ret = usb_req_set_sel(udev, state);
3615 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3616 usb3_lpm_names[state]);
3620 /* We allow the host controller to set the U1/U2 timeout internally
3621 * first, so that it can change its schedule to account for the
3622 * additional latency to send data to a device in a lower power
3625 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3627 /* xHCI host controller doesn't want to enable this LPM state. */
3632 dev_warn(&udev->dev, "Could not enable %s link state, "
3633 "xHCI error %i.\n", usb3_lpm_names[state],
3638 if (usb_set_lpm_timeout(udev, state, timeout))
3639 /* If we can't set the parent hub U1/U2 timeout,
3640 * device-initiated LPM won't be allowed either, so let the xHCI
3641 * host know that this link state won't be enabled.
3643 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3645 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3646 else if (udev->actconfig)
3647 usb_set_device_initiated_lpm(udev, state, true);
3652 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3655 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3656 * If zero is returned, the parent will not allow the link to go into U1/U2.
3658 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3659 * it won't have an effect on the bus link state because the parent hub will
3660 * still disallow device-initiated U1/U2 entry.
3662 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3663 * possible. The result will be slightly more bus bandwidth will be taken up
3664 * (to account for U1/U2 exit latency), but it should be harmless.
3666 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3667 enum usb3_link_state state)
3673 feature = USB_PORT_FEAT_U1_TIMEOUT;
3676 feature = USB_PORT_FEAT_U2_TIMEOUT;
3679 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3684 if (usb_set_lpm_timeout(udev, state, 0))
3687 usb_set_device_initiated_lpm(udev, state, false);
3689 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3690 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3691 "bus schedule bandwidth may be impacted.\n",
3692 usb3_lpm_names[state]);
3697 * Disable hub-initiated and device-initiated U1 and U2 entry.
3698 * Caller must own the bandwidth_mutex.
3700 * This will call usb_enable_lpm() on failure, which will decrement
3701 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3703 int usb_disable_lpm(struct usb_device *udev)
3705 struct usb_hcd *hcd;
3707 if (!udev || !udev->parent ||
3708 udev->speed != USB_SPEED_SUPER ||
3712 hcd = bus_to_hcd(udev->bus);
3713 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3716 udev->lpm_disable_count++;
3717 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3720 /* If LPM is enabled, attempt to disable it. */
3721 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3723 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3729 usb_enable_lpm(udev);
3732 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3734 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3735 int usb_unlocked_disable_lpm(struct usb_device *udev)
3737 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3743 mutex_lock(hcd->bandwidth_mutex);
3744 ret = usb_disable_lpm(udev);
3745 mutex_unlock(hcd->bandwidth_mutex);
3749 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3752 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3753 * xHCI host policy may prevent U1 or U2 from being enabled.
3755 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3756 * until the lpm_disable_count drops to zero. Caller must own the
3759 void usb_enable_lpm(struct usb_device *udev)
3761 struct usb_hcd *hcd;
3763 if (!udev || !udev->parent ||
3764 udev->speed != USB_SPEED_SUPER ||
3768 udev->lpm_disable_count--;
3769 hcd = bus_to_hcd(udev->bus);
3770 /* Double check that we can both enable and disable LPM.
3771 * Device must be configured to accept set feature U1/U2 timeout.
3773 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3774 !hcd->driver->disable_usb3_lpm_timeout)
3777 if (udev->lpm_disable_count > 0)
3780 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3781 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3783 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3785 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3786 void usb_unlocked_enable_lpm(struct usb_device *udev)
3788 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3793 mutex_lock(hcd->bandwidth_mutex);
3794 usb_enable_lpm(udev);
3795 mutex_unlock(hcd->bandwidth_mutex);
3797 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3800 #else /* CONFIG_PM */
3802 #define hub_suspend NULL
3803 #define hub_resume NULL
3804 #define hub_reset_resume NULL
3806 int usb_disable_lpm(struct usb_device *udev)
3810 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3812 void usb_enable_lpm(struct usb_device *udev) { }
3813 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3815 int usb_unlocked_disable_lpm(struct usb_device *udev)
3819 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3821 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3822 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3824 int usb_disable_ltm(struct usb_device *udev)
3828 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3830 void usb_enable_ltm(struct usb_device *udev) { }
3831 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3833 #endif /* CONFIG_PM */
3836 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3838 * Between connect detection and reset signaling there must be a delay
3839 * of 100ms at least for debounce and power-settling. The corresponding
3840 * timer shall restart whenever the downstream port detects a disconnect.
3842 * Apparently there are some bluetooth and irda-dongles and a number of
3843 * low-speed devices for which this debounce period may last over a second.
3844 * Not covered by the spec - but easy to deal with.
3846 * This implementation uses a 1500ms total debounce timeout; if the
3847 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3848 * every 25ms for transient disconnects. When the port status has been
3849 * unchanged for 100ms it returns the port status.
3851 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3854 int total_time, stable_time = 0;
3855 u16 portchange, portstatus;
3856 unsigned connection = 0xffff;
3858 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3859 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3863 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3864 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3865 if (!must_be_connected ||
3866 (connection == USB_PORT_STAT_CONNECTION))
3867 stable_time += HUB_DEBOUNCE_STEP;
3868 if (stable_time >= HUB_DEBOUNCE_STABLE)
3872 connection = portstatus & USB_PORT_STAT_CONNECTION;
3875 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3876 usb_clear_port_feature(hub->hdev, port1,
3877 USB_PORT_FEAT_C_CONNECTION);
3880 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3882 msleep(HUB_DEBOUNCE_STEP);
3885 dev_dbg (hub->intfdev,
3886 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3887 port1, total_time, stable_time, portstatus);
3889 if (stable_time < HUB_DEBOUNCE_STABLE)
3894 void usb_ep0_reinit(struct usb_device *udev)
3896 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3897 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3898 usb_enable_endpoint(udev, &udev->ep0, true);
3900 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3902 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3903 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3905 static int hub_set_address(struct usb_device *udev, int devnum)
3908 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3911 * The host controller will choose the device address,
3912 * instead of the core having chosen it earlier
3914 if (!hcd->driver->address_device && devnum <= 1)
3916 if (udev->state == USB_STATE_ADDRESS)
3918 if (udev->state != USB_STATE_DEFAULT)
3920 if (hcd->driver->address_device)
3921 retval = hcd->driver->address_device(hcd, udev);
3923 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3924 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3925 NULL, 0, USB_CTRL_SET_TIMEOUT);
3927 update_devnum(udev, devnum);
3928 /* Device now using proper address. */
3929 usb_set_device_state(udev, USB_STATE_ADDRESS);
3930 usb_ep0_reinit(udev);
3935 /* Reset device, (re)assign address, get device descriptor.
3936 * Device connection must be stable, no more debouncing needed.
3937 * Returns device in USB_STATE_ADDRESS, except on error.
3939 * If this is called for an already-existing device (as part of
3940 * usb_reset_and_verify_device), the caller must own the device lock. For a
3941 * newly detected device that is not accessible through any global
3942 * pointers, it's not necessary to lock the device.
3945 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3948 static DEFINE_MUTEX(usb_address0_mutex);
3950 struct usb_device *hdev = hub->hdev;
3951 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3953 unsigned delay = HUB_SHORT_RESET_TIME;
3954 enum usb_device_speed oldspeed = udev->speed;
3956 int devnum = udev->devnum;
3958 /* root hub ports have a slightly longer reset period
3959 * (from USB 2.0 spec, section 7.1.7.5)
3961 if (!hdev->parent) {
3962 delay = HUB_ROOT_RESET_TIME;
3963 if (port1 == hdev->bus->otg_port)
3964 hdev->bus->b_hnp_enable = 0;
3967 /* Some low speed devices have problems with the quick delay, so */
3968 /* be a bit pessimistic with those devices. RHbug #23670 */
3969 if (oldspeed == USB_SPEED_LOW)
3970 delay = HUB_LONG_RESET_TIME;
3972 mutex_lock(&usb_address0_mutex);
3974 /* Reset the device; full speed may morph to high speed */
3975 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3976 retval = hub_port_reset(hub, port1, udev, delay, false);
3977 if (retval < 0) /* error or disconnect */
3979 /* success, speed is known */
3983 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3984 dev_dbg(&udev->dev, "device reset changed speed!\n");
3987 oldspeed = udev->speed;
3989 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3990 * it's fixed size except for full speed devices.
3991 * For Wireless USB devices, ep0 max packet is always 512 (tho
3992 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3994 switch (udev->speed) {
3995 case USB_SPEED_SUPER:
3996 case USB_SPEED_WIRELESS: /* fixed at 512 */
3997 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3999 case USB_SPEED_HIGH: /* fixed at 64 */
4000 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4002 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4003 /* to determine the ep0 maxpacket size, try to read
4004 * the device descriptor to get bMaxPacketSize0 and
4005 * then correct our initial guess.
4007 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4009 case USB_SPEED_LOW: /* fixed at 8 */
4010 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4016 if (udev->speed == USB_SPEED_WIRELESS)
4017 speed = "variable speed Wireless";
4019 speed = usb_speed_string(udev->speed);
4021 if (udev->speed != USB_SPEED_SUPER)
4022 dev_info(&udev->dev,
4023 "%s %s USB device number %d using %s\n",
4024 (udev->config) ? "reset" : "new", speed,
4025 devnum, udev->bus->controller->driver->name);
4027 /* Set up TT records, if needed */
4029 udev->tt = hdev->tt;
4030 udev->ttport = hdev->ttport;
4031 } else if (udev->speed != USB_SPEED_HIGH
4032 && hdev->speed == USB_SPEED_HIGH) {
4034 dev_err(&udev->dev, "parent hub has no TT\n");
4038 udev->tt = &hub->tt;
4039 udev->ttport = port1;
4042 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4043 * Because device hardware and firmware is sometimes buggy in
4044 * this area, and this is how Linux has done it for ages.
4045 * Change it cautiously.
4047 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4048 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4049 * so it may help with some non-standards-compliant devices.
4050 * Otherwise we start with SET_ADDRESS and then try to read the
4051 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4054 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4055 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
4056 struct usb_device_descriptor *buf;
4059 #define GET_DESCRIPTOR_BUFSIZE 64
4060 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4066 /* Retry on all errors; some devices are flakey.
4067 * 255 is for WUSB devices, we actually need to use
4068 * 512 (WUSB1.0[4.8.1]).
4070 for (j = 0; j < 3; ++j) {
4071 buf->bMaxPacketSize0 = 0;
4072 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4073 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4074 USB_DT_DEVICE << 8, 0,
4075 buf, GET_DESCRIPTOR_BUFSIZE,
4076 initial_descriptor_timeout);
4077 switch (buf->bMaxPacketSize0) {
4078 case 8: case 16: case 32: case 64: case 255:
4079 if (buf->bDescriptorType ==
4093 udev->descriptor.bMaxPacketSize0 =
4094 buf->bMaxPacketSize0;
4097 retval = hub_port_reset(hub, port1, udev, delay, false);
4098 if (retval < 0) /* error or disconnect */
4100 if (oldspeed != udev->speed) {
4102 "device reset changed speed!\n");
4108 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4113 #undef GET_DESCRIPTOR_BUFSIZE
4117 * If device is WUSB, we already assigned an
4118 * unauthorized address in the Connect Ack sequence;
4119 * authorization will assign the final address.
4121 if (udev->wusb == 0) {
4122 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4123 retval = hub_set_address(udev, devnum);
4129 if (retval != -ENODEV)
4130 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4134 if (udev->speed == USB_SPEED_SUPER) {
4135 devnum = udev->devnum;
4136 dev_info(&udev->dev,
4137 "%s SuperSpeed USB device number %d using %s\n",
4138 (udev->config) ? "reset" : "new",
4139 devnum, udev->bus->controller->driver->name);
4142 /* cope with hardware quirkiness:
4143 * - let SET_ADDRESS settle, some device hardware wants it
4144 * - read ep0 maxpacket even for high and low speed,
4147 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4151 retval = usb_get_device_descriptor(udev, 8);
4153 if (retval != -ENODEV)
4155 "device descriptor read/8, error %d\n",
4167 if (hcd->phy && !hdev->parent)
4168 usb_phy_notify_connect(hcd->phy, udev->speed);
4171 * Some superspeed devices have finished the link training process
4172 * and attached to a superspeed hub port, but the device descriptor
4173 * got from those devices show they aren't superspeed devices. Warm
4174 * reset the port attached by the devices can fix them.
4176 if ((udev->speed == USB_SPEED_SUPER) &&
4177 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4178 dev_err(&udev->dev, "got a wrong device descriptor, "
4179 "warm reset device\n");
4180 hub_port_reset(hub, port1, udev,
4181 HUB_BH_RESET_TIME, true);
4186 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4187 udev->speed == USB_SPEED_SUPER)
4190 i = udev->descriptor.bMaxPacketSize0;
4191 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4192 if (udev->speed == USB_SPEED_LOW ||
4193 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4194 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4198 if (udev->speed == USB_SPEED_FULL)
4199 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4201 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4202 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4203 usb_ep0_reinit(udev);
4206 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4207 if (retval < (signed)sizeof(udev->descriptor)) {
4208 if (retval != -ENODEV)
4209 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4216 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4217 retval = usb_get_bos_descriptor(udev);
4219 udev->lpm_capable = usb_device_supports_lpm(udev);
4220 usb_set_lpm_parameters(udev);
4225 /* notify HCD that we have a device connected and addressed */
4226 if (hcd->driver->update_device)
4227 hcd->driver->update_device(hcd, udev);
4230 hub_port_disable(hub, port1, 0);
4231 update_devnum(udev, devnum); /* for disconnect processing */
4233 mutex_unlock(&usb_address0_mutex);
4238 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4240 struct usb_qualifier_descriptor *qual;
4243 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4247 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4248 qual, sizeof *qual);
4249 if (status == sizeof *qual) {
4250 dev_info(&udev->dev, "not running at top speed; "
4251 "connect to a high speed hub\n");
4252 /* hub LEDs are probably harder to miss than syslog */
4253 if (hub->has_indicators) {
4254 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4255 schedule_delayed_work (&hub->leds, 0);
4262 hub_power_remaining (struct usb_hub *hub)
4264 struct usb_device *hdev = hub->hdev;
4268 if (!hub->limited_power)
4271 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4272 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4273 struct usb_device *udev = hub->ports[port1 - 1]->child;
4279 if (hub_is_superspeed(udev))
4285 * Unconfigured devices may not use more than one unit load,
4286 * or 8mA for OTG ports
4288 if (udev->actconfig)
4289 delta = usb_get_max_power(udev, udev->actconfig);
4290 else if (port1 != udev->bus->otg_port || hdev->parent)
4294 if (delta > hub->mA_per_port)
4295 dev_warn(&udev->dev,
4296 "%dmA is over %umA budget for port %d!\n",
4297 delta, hub->mA_per_port, port1);
4300 if (remaining < 0) {
4301 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4308 /* Handle physical or logical connection change events.
4309 * This routine is called when:
4310 * a port connection-change occurs;
4311 * a port enable-change occurs (often caused by EMI);
4312 * usb_reset_and_verify_device() encounters changed descriptors (as from
4313 * a firmware download)
4314 * caller already locked the hub
4316 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4317 u16 portstatus, u16 portchange)
4319 struct usb_device *hdev = hub->hdev;
4320 struct device *hub_dev = hub->intfdev;
4321 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4322 unsigned wHubCharacteristics =
4323 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4324 struct usb_device *udev;
4329 "port %d, status %04x, change %04x, %s\n",
4330 port1, portstatus, portchange, portspeed(hub, portstatus));
4332 if (hub->has_indicators) {
4333 set_port_led(hub, port1, HUB_LED_AUTO);
4334 hub->indicator[port1-1] = INDICATOR_AUTO;
4337 #ifdef CONFIG_USB_OTG
4338 /* during HNP, don't repeat the debounce */
4339 if (hdev->bus->is_b_host)
4340 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4341 USB_PORT_STAT_C_ENABLE);
4344 /* Try to resuscitate an existing device */
4345 udev = hub->ports[port1 - 1]->child;
4346 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4347 udev->state != USB_STATE_NOTATTACHED) {
4348 usb_lock_device(udev);
4349 if (portstatus & USB_PORT_STAT_ENABLE) {
4350 status = 0; /* Nothing to do */
4352 #ifdef CONFIG_PM_RUNTIME
4353 } else if (udev->state == USB_STATE_SUSPENDED &&
4354 udev->persist_enabled) {
4355 /* For a suspended device, treat this as a
4356 * remote wakeup event.
4358 status = usb_remote_wakeup(udev);
4362 status = -ENODEV; /* Don't resuscitate */
4364 usb_unlock_device(udev);
4367 clear_bit(port1, hub->change_bits);
4372 /* Disconnect any existing devices under this port */
4374 if (hcd->phy && !hdev->parent &&
4375 !(portstatus & USB_PORT_STAT_CONNECTION))
4376 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4377 usb_disconnect(&hub->ports[port1 - 1]->child);
4379 clear_bit(port1, hub->change_bits);
4381 /* We can forget about a "removed" device when there's a physical
4382 * disconnect or the connect status changes.
4384 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4385 (portchange & USB_PORT_STAT_C_CONNECTION))
4386 clear_bit(port1, hub->removed_bits);
4388 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4389 USB_PORT_STAT_C_ENABLE)) {
4390 status = hub_port_debounce_be_stable(hub, port1);
4392 if (status != -ENODEV && printk_ratelimit())
4393 dev_err(hub_dev, "connect-debounce failed, "
4394 "port %d disabled\n", port1);
4395 portstatus &= ~USB_PORT_STAT_CONNECTION;
4397 portstatus = status;
4401 /* Return now if debouncing failed or nothing is connected or
4402 * the device was "removed".
4404 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4405 test_bit(port1, hub->removed_bits)) {
4407 /* maybe switch power back on (e.g. root hub was reset) */
4408 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4409 && !port_is_power_on(hub, portstatus))
4410 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4412 if (portstatus & USB_PORT_STAT_ENABLE)
4416 if (hub_is_superspeed(hub->hdev))
4422 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4424 /* reallocate for each attempt, since references
4425 * to the previous one can escape in various ways
4427 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4430 "couldn't allocate port %d usb_device\n",
4435 usb_set_device_state(udev, USB_STATE_POWERED);
4436 udev->bus_mA = hub->mA_per_port;
4437 udev->level = hdev->level + 1;
4438 udev->wusb = hub_is_wusb(hub);
4440 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4441 if (hub_is_superspeed(hub->hdev))
4442 udev->speed = USB_SPEED_SUPER;
4444 udev->speed = USB_SPEED_UNKNOWN;
4446 choose_devnum(udev);
4447 if (udev->devnum <= 0) {
4448 status = -ENOTCONN; /* Don't retry */
4452 /* reset (non-USB 3.0 devices) and get descriptor */
4453 status = hub_port_init(hub, udev, port1, i);
4457 usb_detect_quirks(udev);
4458 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4461 /* consecutive bus-powered hubs aren't reliable; they can
4462 * violate the voltage drop budget. if the new child has
4463 * a "powered" LED, users should notice we didn't enable it
4464 * (without reading syslog), even without per-port LEDs
4467 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4468 && udev->bus_mA <= unit_load) {
4471 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4474 dev_dbg(&udev->dev, "get status %d ?\n", status);
4477 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4479 "can't connect bus-powered hub "
4481 if (hub->has_indicators) {
4482 hub->indicator[port1-1] =
4483 INDICATOR_AMBER_BLINK;
4484 schedule_delayed_work (&hub->leds, 0);
4486 status = -ENOTCONN; /* Don't retry */
4491 /* check for devices running slower than they could */
4492 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4493 && udev->speed == USB_SPEED_FULL
4494 && highspeed_hubs != 0)
4495 check_highspeed (hub, udev, port1);
4497 /* Store the parent's children[] pointer. At this point
4498 * udev becomes globally accessible, although presumably
4499 * no one will look at it until hdev is unlocked.
4503 /* We mustn't add new devices if the parent hub has
4504 * been disconnected; we would race with the
4505 * recursively_mark_NOTATTACHED() routine.
4507 spin_lock_irq(&device_state_lock);
4508 if (hdev->state == USB_STATE_NOTATTACHED)
4511 hub->ports[port1 - 1]->child = udev;
4512 spin_unlock_irq(&device_state_lock);
4514 /* Run it through the hoops (find a driver, etc) */
4516 status = usb_new_device(udev);
4518 spin_lock_irq(&device_state_lock);
4519 hub->ports[port1 - 1]->child = NULL;
4520 spin_unlock_irq(&device_state_lock);
4527 status = hub_power_remaining(hub);
4529 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4534 hub_port_disable(hub, port1, 1);
4536 usb_ep0_reinit(udev);
4537 release_devnum(udev);
4540 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4543 if (hub->hdev->parent ||
4544 !hcd->driver->port_handed_over ||
4545 !(hcd->driver->port_handed_over)(hcd, port1)) {
4546 if (status != -ENOTCONN && status != -ENODEV)
4547 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4552 hub_port_disable(hub, port1, 1);
4553 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4554 hcd->driver->relinquish_port(hcd, port1);
4557 /* Returns 1 if there was a remote wakeup and a connect status change. */
4558 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4559 u16 portstatus, u16 portchange)
4561 struct usb_device *hdev;
4562 struct usb_device *udev;
4563 int connect_change = 0;
4567 udev = hub->ports[port - 1]->child;
4568 if (!hub_is_superspeed(hdev)) {
4569 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4571 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4573 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4574 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4580 /* TRSMRCY = 10 msec */
4583 usb_lock_device(udev);
4584 ret = usb_remote_wakeup(udev);
4585 usb_unlock_device(udev);
4590 hub_port_disable(hub, port, 1);
4592 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4594 return connect_change;
4597 static void hub_events(void)
4599 struct list_head *tmp;
4600 struct usb_device *hdev;
4601 struct usb_interface *intf;
4602 struct usb_hub *hub;
4603 struct device *hub_dev;
4609 int connect_change, wakeup_change;
4612 * We restart the list every time to avoid a deadlock with
4613 * deleting hubs downstream from this one. This should be
4614 * safe since we delete the hub from the event list.
4615 * Not the most efficient, but avoids deadlocks.
4619 /* Grab the first entry at the beginning of the list */
4620 spin_lock_irq(&hub_event_lock);
4621 if (list_empty(&hub_event_list)) {
4622 spin_unlock_irq(&hub_event_lock);
4626 tmp = hub_event_list.next;
4629 hub = list_entry(tmp, struct usb_hub, event_list);
4630 kref_get(&hub->kref);
4631 spin_unlock_irq(&hub_event_lock);
4634 hub_dev = hub->intfdev;
4635 intf = to_usb_interface(hub_dev);
4636 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4637 hdev->state, hub->descriptor
4638 ? hub->descriptor->bNbrPorts
4640 /* NOTE: expects max 15 ports... */
4641 (u16) hub->change_bits[0],
4642 (u16) hub->event_bits[0]);
4644 /* Lock the device, then check to see if we were
4645 * disconnected while waiting for the lock to succeed. */
4646 usb_lock_device(hdev);
4647 if (unlikely(hub->disconnected))
4648 goto loop_disconnected;
4650 /* If the hub has died, clean up after it */
4651 if (hdev->state == USB_STATE_NOTATTACHED) {
4652 hub->error = -ENODEV;
4653 hub_quiesce(hub, HUB_DISCONNECT);
4658 ret = usb_autopm_get_interface(intf);
4660 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4664 /* If this is an inactive hub, do nothing */
4669 dev_dbg (hub_dev, "resetting for error %d\n",
4672 ret = usb_reset_device(hdev);
4675 "error resetting hub: %d\n", ret);
4683 /* deal with port status changes */
4684 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4685 if (test_bit(i, hub->busy_bits))
4687 connect_change = test_bit(i, hub->change_bits);
4688 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4689 if (!test_and_clear_bit(i, hub->event_bits) &&
4690 !connect_change && !wakeup_change)
4693 ret = hub_port_status(hub, i,
4694 &portstatus, &portchange);
4698 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4699 usb_clear_port_feature(hdev, i,
4700 USB_PORT_FEAT_C_CONNECTION);
4704 if (portchange & USB_PORT_STAT_C_ENABLE) {
4705 if (!connect_change)
4707 "port %d enable change, "
4710 usb_clear_port_feature(hdev, i,
4711 USB_PORT_FEAT_C_ENABLE);
4714 * EM interference sometimes causes badly
4715 * shielded USB devices to be shutdown by
4716 * the hub, this hack enables them again.
4717 * Works at least with mouse driver.
4719 if (!(portstatus & USB_PORT_STAT_ENABLE)
4721 && hub->ports[i - 1]->child) {
4724 "disabled by hub (EMI?), "
4731 if (hub_handle_remote_wakeup(hub, i,
4732 portstatus, portchange))
4735 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4739 dev_dbg(hub_dev, "over-current change on port "
4741 usb_clear_port_feature(hdev, i,
4742 USB_PORT_FEAT_C_OVER_CURRENT);
4743 msleep(100); /* Cool down */
4744 hub_power_on(hub, true);
4745 hub_port_status(hub, i, &status, &unused);
4746 if (status & USB_PORT_STAT_OVERCURRENT)
4747 dev_err(hub_dev, "over-current "
4748 "condition on port %d\n", i);
4751 if (portchange & USB_PORT_STAT_C_RESET) {
4753 "reset change on port %d\n",
4755 usb_clear_port_feature(hdev, i,
4756 USB_PORT_FEAT_C_RESET);
4758 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4759 hub_is_superspeed(hub->hdev)) {
4761 "warm reset change on port %d\n",
4763 usb_clear_port_feature(hdev, i,
4764 USB_PORT_FEAT_C_BH_PORT_RESET);
4766 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4767 usb_clear_port_feature(hub->hdev, i,
4768 USB_PORT_FEAT_C_PORT_LINK_STATE);
4770 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4772 "config error on port %d\n",
4774 usb_clear_port_feature(hub->hdev, i,
4775 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4778 /* Warm reset a USB3 protocol port if it's in
4779 * SS.Inactive state.
4781 if (hub_port_warm_reset_required(hub, portstatus)) {
4783 struct usb_device *udev =
4784 hub->ports[i - 1]->child;
4786 dev_dbg(hub_dev, "warm reset port %d\n", i);
4787 if (!udev || !(portstatus &
4788 USB_PORT_STAT_CONNECTION)) {
4789 status = hub_port_reset(hub, i,
4790 NULL, HUB_BH_RESET_TIME,
4793 hub_port_disable(hub, i, 1);
4795 usb_lock_device(udev);
4796 status = usb_reset_device(udev);
4797 usb_unlock_device(udev);
4803 hub_port_connect_change(hub, i,
4804 portstatus, portchange);
4807 /* deal with hub status changes */
4808 if (test_and_clear_bit(0, hub->event_bits) == 0)
4810 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4811 dev_err (hub_dev, "get_hub_status failed\n");
4813 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4814 dev_dbg (hub_dev, "power change\n");
4815 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4816 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4817 /* FIXME: Is this always true? */
4818 hub->limited_power = 1;
4820 hub->limited_power = 0;
4822 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4826 dev_dbg(hub_dev, "over-current change\n");
4827 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4828 msleep(500); /* Cool down */
4829 hub_power_on(hub, true);
4830 hub_hub_status(hub, &status, &unused);
4831 if (status & HUB_STATUS_OVERCURRENT)
4832 dev_err(hub_dev, "over-current "
4838 /* Balance the usb_autopm_get_interface() above */
4839 usb_autopm_put_interface_no_suspend(intf);
4841 /* Balance the usb_autopm_get_interface_no_resume() in
4842 * kick_khubd() and allow autosuspend.
4844 usb_autopm_put_interface(intf);
4846 usb_unlock_device(hdev);
4847 kref_put(&hub->kref, hub_release);
4849 } /* end while (1) */
4852 static int hub_thread(void *__unused)
4854 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4855 * port handover. Otherwise it might see that a full-speed device
4856 * was gone before the EHCI controller had handed its port over to
4857 * the companion full-speed controller.
4863 wait_event_freezable(khubd_wait,
4864 !list_empty(&hub_event_list) ||
4865 kthread_should_stop());
4866 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4868 pr_debug("%s: khubd exiting\n", usbcore_name);
4872 static const struct usb_device_id hub_id_table[] = {
4873 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4874 | USB_DEVICE_ID_MATCH_INT_CLASS,
4875 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4876 .bInterfaceClass = USB_CLASS_HUB,
4877 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4878 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4879 .bDeviceClass = USB_CLASS_HUB},
4880 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4881 .bInterfaceClass = USB_CLASS_HUB},
4882 { } /* Terminating entry */
4885 MODULE_DEVICE_TABLE (usb, hub_id_table);
4887 static struct usb_driver hub_driver = {
4890 .disconnect = hub_disconnect,
4891 .suspend = hub_suspend,
4892 .resume = hub_resume,
4893 .reset_resume = hub_reset_resume,
4894 .pre_reset = hub_pre_reset,
4895 .post_reset = hub_post_reset,
4896 .unlocked_ioctl = hub_ioctl,
4897 .id_table = hub_id_table,
4898 .supports_autosuspend = 1,
4901 int usb_hub_init(void)
4903 if (usb_register(&hub_driver) < 0) {
4904 printk(KERN_ERR "%s: can't register hub driver\n",
4909 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4910 if (!IS_ERR(khubd_task))
4913 /* Fall through if kernel_thread failed */
4914 usb_deregister(&hub_driver);
4915 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4920 void usb_hub_cleanup(void)
4922 kthread_stop(khubd_task);
4925 * Hub resources are freed for us by usb_deregister. It calls
4926 * usb_driver_purge on every device which in turn calls that
4927 * devices disconnect function if it is using this driver.
4928 * The hub_disconnect function takes care of releasing the
4929 * individual hub resources. -greg
4931 usb_deregister(&hub_driver);
4932 } /* usb_hub_cleanup() */
4934 static int descriptors_changed(struct usb_device *udev,
4935 struct usb_device_descriptor *old_device_descriptor)
4939 unsigned serial_len = 0;
4941 unsigned old_length;
4945 if (memcmp(&udev->descriptor, old_device_descriptor,
4946 sizeof(*old_device_descriptor)) != 0)
4949 /* Since the idVendor, idProduct, and bcdDevice values in the
4950 * device descriptor haven't changed, we will assume the
4951 * Manufacturer and Product strings haven't changed either.
4952 * But the SerialNumber string could be different (e.g., a
4953 * different flash card of the same brand).
4956 serial_len = strlen(udev->serial) + 1;
4959 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4960 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4961 len = max(len, old_length);
4964 buf = kmalloc(len, GFP_NOIO);
4966 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4967 /* assume the worst */
4970 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4971 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4972 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4974 if (length != old_length) {
4975 dev_dbg(&udev->dev, "config index %d, error %d\n",
4980 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4982 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4984 ((struct usb_config_descriptor *) buf)->
4985 bConfigurationValue);
4991 if (!changed && serial_len) {
4992 length = usb_string(udev, udev->descriptor.iSerialNumber,
4994 if (length + 1 != serial_len) {
4995 dev_dbg(&udev->dev, "serial string error %d\n",
4998 } else if (memcmp(buf, udev->serial, length) != 0) {
4999 dev_dbg(&udev->dev, "serial string changed\n");
5009 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5010 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5012 * WARNING - don't use this routine to reset a composite device
5013 * (one with multiple interfaces owned by separate drivers)!
5014 * Use usb_reset_device() instead.
5016 * Do a port reset, reassign the device's address, and establish its
5017 * former operating configuration. If the reset fails, or the device's
5018 * descriptors change from their values before the reset, or the original
5019 * configuration and altsettings cannot be restored, a flag will be set
5020 * telling khubd to pretend the device has been disconnected and then
5021 * re-connected. All drivers will be unbound, and the device will be
5022 * re-enumerated and probed all over again.
5024 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5025 * flagged for logical disconnection, or some other negative error code
5026 * if the reset wasn't even attempted.
5028 * The caller must own the device lock. For example, it's safe to use
5029 * this from a driver probe() routine after downloading new firmware.
5030 * For calls that might not occur during probe(), drivers should lock
5031 * the device using usb_lock_device_for_reset().
5033 * Locking exception: This routine may also be called from within an
5034 * autoresume handler. Such usage won't conflict with other tasks
5035 * holding the device lock because these tasks should always call
5036 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5038 static int usb_reset_and_verify_device(struct usb_device *udev)
5040 struct usb_device *parent_hdev = udev->parent;
5041 struct usb_hub *parent_hub;
5042 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5043 struct usb_device_descriptor descriptor = udev->descriptor;
5045 int port1 = udev->portnum;
5047 if (udev->state == USB_STATE_NOTATTACHED ||
5048 udev->state == USB_STATE_SUSPENDED) {
5049 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5055 /* this requires hcd-specific logic; see ohci_restart() */
5056 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5059 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5061 /* Disable LPM and LTM while we reset the device and reinstall the alt
5062 * settings. Device-initiated LPM settings, and system exit latency
5063 * settings are cleared when the device is reset, so we have to set
5066 ret = usb_unlocked_disable_lpm(udev);
5068 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5071 ret = usb_disable_ltm(udev);
5073 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5078 set_bit(port1, parent_hub->busy_bits);
5079 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5081 /* ep0 maxpacket size may change; let the HCD know about it.
5082 * Other endpoints will be handled by re-enumeration. */
5083 usb_ep0_reinit(udev);
5084 ret = hub_port_init(parent_hub, udev, port1, i);
5085 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5088 clear_bit(port1, parent_hub->busy_bits);
5093 /* Device might have changed firmware (DFU or similar) */
5094 if (descriptors_changed(udev, &descriptor)) {
5095 dev_info(&udev->dev, "device firmware changed\n");
5096 udev->descriptor = descriptor; /* for disconnect() calls */
5100 /* Restore the device's previous configuration */
5101 if (!udev->actconfig)
5104 mutex_lock(hcd->bandwidth_mutex);
5105 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5107 dev_warn(&udev->dev,
5108 "Busted HC? Not enough HCD resources for "
5109 "old configuration.\n");
5110 mutex_unlock(hcd->bandwidth_mutex);
5113 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5114 USB_REQ_SET_CONFIGURATION, 0,
5115 udev->actconfig->desc.bConfigurationValue, 0,
5116 NULL, 0, USB_CTRL_SET_TIMEOUT);
5119 "can't restore configuration #%d (error=%d)\n",
5120 udev->actconfig->desc.bConfigurationValue, ret);
5121 mutex_unlock(hcd->bandwidth_mutex);
5124 mutex_unlock(hcd->bandwidth_mutex);
5125 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5127 /* Put interfaces back into the same altsettings as before.
5128 * Don't bother to send the Set-Interface request for interfaces
5129 * that were already in altsetting 0; besides being unnecessary,
5130 * many devices can't handle it. Instead just reset the host-side
5133 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5134 struct usb_host_config *config = udev->actconfig;
5135 struct usb_interface *intf = config->interface[i];
5136 struct usb_interface_descriptor *desc;
5138 desc = &intf->cur_altsetting->desc;
5139 if (desc->bAlternateSetting == 0) {
5140 usb_disable_interface(udev, intf, true);
5141 usb_enable_interface(udev, intf, true);
5144 /* Let the bandwidth allocation function know that this
5145 * device has been reset, and it will have to use
5146 * alternate setting 0 as the current alternate setting.
5148 intf->resetting_device = 1;
5149 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5150 desc->bAlternateSetting);
5151 intf->resetting_device = 0;
5154 dev_err(&udev->dev, "failed to restore interface %d "
5155 "altsetting %d (error=%d)\n",
5156 desc->bInterfaceNumber,
5157 desc->bAlternateSetting,
5164 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5165 usb_unlocked_enable_lpm(udev);
5166 usb_enable_ltm(udev);
5170 /* LPM state doesn't matter when we're about to destroy the device. */
5171 hub_port_logical_disconnect(parent_hub, port1);
5176 * usb_reset_device - warn interface drivers and perform a USB port reset
5177 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5179 * Warns all drivers bound to registered interfaces (using their pre_reset
5180 * method), performs the port reset, and then lets the drivers know that
5181 * the reset is over (using their post_reset method).
5183 * Return value is the same as for usb_reset_and_verify_device().
5185 * The caller must own the device lock. For example, it's safe to use
5186 * this from a driver probe() routine after downloading new firmware.
5187 * For calls that might not occur during probe(), drivers should lock
5188 * the device using usb_lock_device_for_reset().
5190 * If an interface is currently being probed or disconnected, we assume
5191 * its driver knows how to handle resets. For all other interfaces,
5192 * if the driver doesn't have pre_reset and post_reset methods then
5193 * we attempt to unbind it and rebind afterward.
5195 int usb_reset_device(struct usb_device *udev)
5199 unsigned int noio_flag;
5200 struct usb_host_config *config = udev->actconfig;
5202 if (udev->state == USB_STATE_NOTATTACHED ||
5203 udev->state == USB_STATE_SUSPENDED) {
5204 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5210 * Don't allocate memory with GFP_KERNEL in current
5211 * context to avoid possible deadlock if usb mass
5212 * storage interface or usbnet interface(iSCSI case)
5213 * is included in current configuration. The easist
5214 * approach is to do it for every device reset,
5215 * because the device 'memalloc_noio' flag may have
5216 * not been set before reseting the usb device.
5218 noio_flag = memalloc_noio_save();
5220 /* Prevent autosuspend during the reset */
5221 usb_autoresume_device(udev);
5224 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5225 struct usb_interface *cintf = config->interface[i];
5226 struct usb_driver *drv;
5229 if (cintf->dev.driver) {
5230 drv = to_usb_driver(cintf->dev.driver);
5231 if (drv->pre_reset && drv->post_reset)
5232 unbind = (drv->pre_reset)(cintf);
5233 else if (cintf->condition ==
5234 USB_INTERFACE_BOUND)
5237 usb_forced_unbind_intf(cintf);
5242 ret = usb_reset_and_verify_device(udev);
5245 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5246 struct usb_interface *cintf = config->interface[i];
5247 struct usb_driver *drv;
5248 int rebind = cintf->needs_binding;
5250 if (!rebind && cintf->dev.driver) {
5251 drv = to_usb_driver(cintf->dev.driver);
5252 if (drv->post_reset)
5253 rebind = (drv->post_reset)(cintf);
5254 else if (cintf->condition ==
5255 USB_INTERFACE_BOUND)
5258 if (ret == 0 && rebind)
5259 usb_rebind_intf(cintf);
5263 usb_autosuspend_device(udev);
5264 memalloc_noio_restore(noio_flag);
5267 EXPORT_SYMBOL_GPL(usb_reset_device);
5271 * usb_queue_reset_device - Reset a USB device from an atomic context
5272 * @iface: USB interface belonging to the device to reset
5274 * This function can be used to reset a USB device from an atomic
5275 * context, where usb_reset_device() won't work (as it blocks).
5277 * Doing a reset via this method is functionally equivalent to calling
5278 * usb_reset_device(), except for the fact that it is delayed to a
5279 * workqueue. This means that any drivers bound to other interfaces
5280 * might be unbound, as well as users from usbfs in user space.
5284 * - Scheduling two resets at the same time from two different drivers
5285 * attached to two different interfaces of the same device is
5286 * possible; depending on how the driver attached to each interface
5287 * handles ->pre_reset(), the second reset might happen or not.
5289 * - If a driver is unbound and it had a pending reset, the reset will
5292 * - This function can be called during .probe() or .disconnect()
5293 * times. On return from .disconnect(), any pending resets will be
5296 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5299 * NOTE: We don't do any reference count tracking because it is not
5300 * needed. The lifecycle of the work_struct is tied to the
5301 * usb_interface. Before destroying the interface we cancel the
5302 * work_struct, so the fact that work_struct is queued and or
5303 * running means the interface (and thus, the device) exist and
5306 void usb_queue_reset_device(struct usb_interface *iface)
5308 schedule_work(&iface->reset_ws);
5310 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5313 * usb_hub_find_child - Get the pointer of child device
5314 * attached to the port which is specified by @port1.
5315 * @hdev: USB device belonging to the usb hub
5316 * @port1: port num to indicate which port the child device
5319 * USB drivers call this function to get hub's child device
5322 * Return NULL if input param is invalid and
5323 * child's usb_device pointer if non-NULL.
5325 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5328 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5330 if (port1 < 1 || port1 > hdev->maxchild)
5332 return hub->ports[port1 - 1]->child;
5334 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5337 * usb_set_hub_port_connect_type - set hub port connect type.
5338 * @hdev: USB device belonging to the usb hub
5339 * @port1: port num of the port
5340 * @type: connect type of the port
5342 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5343 enum usb_port_connect_type type)
5345 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5348 hub->ports[port1 - 1]->connect_type = type;
5352 * usb_get_hub_port_connect_type - Get the port's connect type
5353 * @hdev: USB device belonging to the usb hub
5354 * @port1: port num of the port
5356 * Return connect type of the port and if input params are
5357 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5359 enum usb_port_connect_type
5360 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5362 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5365 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5367 return hub->ports[port1 - 1]->connect_type;
5370 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5371 struct usb_hub_descriptor *desc)
5373 enum usb_port_connect_type connect_type;
5376 if (!hub_is_superspeed(hdev)) {
5377 for (i = 1; i <= hdev->maxchild; i++) {
5378 connect_type = usb_get_hub_port_connect_type(hdev, i);
5380 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5381 u8 mask = 1 << (i%8);
5383 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5384 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5386 desc->u.hs.DeviceRemovable[i/8] |= mask;
5391 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5393 for (i = 1; i <= hdev->maxchild; i++) {
5394 connect_type = usb_get_hub_port_connect_type(hdev, i);
5396 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5399 if (!(port_removable & mask)) {
5400 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5402 port_removable |= mask;
5407 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5413 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5414 * @hdev: USB device belonging to the usb hub
5415 * @port1: port num of the port
5417 * Return port's acpi handle if successful, NULL if params are
5420 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5423 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5428 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);