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 * Return: 0 if successful. A negative error code otherwise.
740 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
744 struct usb_port *port_dev = hub->ports[port1 - 1];
747 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
749 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
752 port_dev->power_is_on = set;
757 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
758 * @urb: an URB associated with the failed or incomplete split transaction
760 * High speed HCDs use this to tell the hub driver that some split control or
761 * bulk transaction failed in a way that requires clearing internal state of
762 * a transaction translator. This is normally detected (and reported) from
765 * It may not be possible for that hub to handle additional full (or low)
766 * speed transactions until that state is fully cleared out.
768 * Return: 0 if successful. A negative error code otherwise.
770 int usb_hub_clear_tt_buffer(struct urb *urb)
772 struct usb_device *udev = urb->dev;
773 int pipe = urb->pipe;
774 struct usb_tt *tt = udev->tt;
776 struct usb_tt_clear *clear;
778 /* we've got to cope with an arbitrary number of pending TT clears,
779 * since each TT has "at least two" buffers that can need it (and
780 * there can be many TTs per hub). even if they're uncommon.
782 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
783 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
784 /* FIXME recover somehow ... RESET_TT? */
788 /* info that CLEAR_TT_BUFFER needs */
789 clear->tt = tt->multi ? udev->ttport : 1;
790 clear->devinfo = usb_pipeendpoint (pipe);
791 clear->devinfo |= udev->devnum << 4;
792 clear->devinfo |= usb_pipecontrol (pipe)
793 ? (USB_ENDPOINT_XFER_CONTROL << 11)
794 : (USB_ENDPOINT_XFER_BULK << 11);
795 if (usb_pipein (pipe))
796 clear->devinfo |= 1 << 15;
798 /* info for completion callback */
799 clear->hcd = bus_to_hcd(udev->bus);
802 /* tell keventd to clear state for this TT */
803 spin_lock_irqsave (&tt->lock, flags);
804 list_add_tail (&clear->clear_list, &tt->clear_list);
805 schedule_work(&tt->clear_work);
806 spin_unlock_irqrestore (&tt->lock, flags);
809 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
811 /* If do_delay is false, return the number of milliseconds the caller
814 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
817 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
819 u16 wHubCharacteristics =
820 le16_to_cpu(hub->descriptor->wHubCharacteristics);
822 /* Enable power on each port. Some hubs have reserved values
823 * of LPSM (> 2) in their descriptors, even though they are
824 * USB 2.0 hubs. Some hubs do not implement port-power switching
825 * but only emulate it. In all cases, the ports won't work
826 * unless we send these messages to the hub.
828 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
829 dev_dbg(hub->intfdev, "enabling power on all ports\n");
831 dev_dbg(hub->intfdev, "trying to enable port power on "
832 "non-switchable hub\n");
833 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
834 if (hub->ports[port1 - 1]->power_is_on)
835 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
837 usb_clear_port_feature(hub->hdev, port1,
838 USB_PORT_FEAT_POWER);
840 /* Wait at least 100 msec for power to become stable */
841 delay = max(pgood_delay, (unsigned) 100);
847 static int hub_hub_status(struct usb_hub *hub,
848 u16 *status, u16 *change)
852 mutex_lock(&hub->status_mutex);
853 ret = get_hub_status(hub->hdev, &hub->status->hub);
856 dev_err(hub->intfdev,
857 "%s failed (err = %d)\n", __func__, ret);
859 *status = le16_to_cpu(hub->status->hub.wHubStatus);
860 *change = le16_to_cpu(hub->status->hub.wHubChange);
863 mutex_unlock(&hub->status_mutex);
867 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
868 unsigned int link_status)
870 return set_port_feature(hub->hdev,
871 port1 | (link_status << 3),
872 USB_PORT_FEAT_LINK_STATE);
876 * If USB 3.0 ports are placed into the Disabled state, they will no longer
877 * detect any device connects or disconnects. This is generally not what the
878 * USB core wants, since it expects a disabled port to produce a port status
879 * change event when a new device connects.
881 * Instead, set the link state to Disabled, wait for the link to settle into
882 * that state, clear any change bits, and then put the port into the RxDetect
885 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
889 u16 portchange, portstatus;
891 if (!hub_is_superspeed(hub->hdev))
894 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
898 /* Wait for the link to enter the disabled state. */
899 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
900 ret = hub_port_status(hub, port1, &portstatus, &portchange);
904 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
905 USB_SS_PORT_LS_SS_DISABLED)
907 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
909 msleep(HUB_DEBOUNCE_STEP);
911 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
912 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
915 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
918 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
920 struct usb_device *hdev = hub->hdev;
923 if (hub->ports[port1 - 1]->child && set_state)
924 usb_set_device_state(hub->ports[port1 - 1]->child,
925 USB_STATE_NOTATTACHED);
927 if (hub_is_superspeed(hub->hdev))
928 ret = hub_usb3_port_disable(hub, port1);
930 ret = usb_clear_port_feature(hdev, port1,
931 USB_PORT_FEAT_ENABLE);
933 if (ret && ret != -ENODEV)
934 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
940 * Disable a port and mark a logical connect-change event, so that some
941 * time later khubd will disconnect() any existing usb_device on the port
942 * and will re-enumerate if there actually is a device attached.
944 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
946 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
947 hub_port_disable(hub, port1, 1);
949 /* FIXME let caller ask to power down the port:
950 * - some devices won't enumerate without a VBUS power cycle
951 * - SRP saves power that way
952 * - ... new call, TBD ...
953 * That's easy if this hub can switch power per-port, and
954 * khubd reactivates the port later (timer, SRP, etc).
955 * Powerdown must be optional, because of reset/DFU.
958 set_bit(port1, hub->change_bits);
963 * usb_remove_device - disable a device's port on its parent hub
964 * @udev: device to be disabled and removed
965 * Context: @udev locked, must be able to sleep.
967 * After @udev's port has been disabled, khubd is notified and it will
968 * see that the device has been disconnected. When the device is
969 * physically unplugged and something is plugged in, the events will
970 * be received and processed normally.
972 * Return: 0 if successful. A negative error code otherwise.
974 int usb_remove_device(struct usb_device *udev)
977 struct usb_interface *intf;
979 if (!udev->parent) /* Can't remove a root hub */
981 hub = usb_hub_to_struct_hub(udev->parent);
982 intf = to_usb_interface(hub->intfdev);
984 usb_autopm_get_interface(intf);
985 set_bit(udev->portnum, hub->removed_bits);
986 hub_port_logical_disconnect(hub, udev->portnum);
987 usb_autopm_put_interface(intf);
991 enum hub_activation_type {
992 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
993 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
996 static void hub_init_func2(struct work_struct *ws);
997 static void hub_init_func3(struct work_struct *ws);
999 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1001 struct usb_device *hdev = hub->hdev;
1002 struct usb_hcd *hcd;
1006 bool need_debounce_delay = false;
1009 /* Continue a partial initialization */
1010 if (type == HUB_INIT2)
1012 if (type == HUB_INIT3)
1015 /* The superspeed hub except for root hub has to use Hub Depth
1016 * value as an offset into the route string to locate the bits
1017 * it uses to determine the downstream port number. So hub driver
1018 * should send a set hub depth request to superspeed hub after
1019 * the superspeed hub is set configuration in initialization or
1022 * After a resume, port power should still be on.
1023 * For any other type of activation, turn it on.
1025 if (type != HUB_RESUME) {
1026 if (hdev->parent && hub_is_superspeed(hdev)) {
1027 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1028 HUB_SET_DEPTH, USB_RT_HUB,
1029 hdev->level - 1, 0, NULL, 0,
1030 USB_CTRL_SET_TIMEOUT);
1032 dev_err(hub->intfdev,
1033 "set hub depth failed\n");
1036 /* Speed up system boot by using a delayed_work for the
1037 * hub's initial power-up delays. This is pretty awkward
1038 * and the implementation looks like a home-brewed sort of
1039 * setjmp/longjmp, but it saves at least 100 ms for each
1040 * root hub (assuming usbcore is compiled into the kernel
1041 * rather than as a module). It adds up.
1043 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1044 * because for those activation types the ports have to be
1045 * operational when we return. In theory this could be done
1046 * for HUB_POST_RESET, but it's easier not to.
1048 if (type == HUB_INIT) {
1049 delay = hub_power_on(hub, false);
1050 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1051 schedule_delayed_work(&hub->init_work,
1052 msecs_to_jiffies(delay));
1054 /* Suppress autosuspend until init is done */
1055 usb_autopm_get_interface_no_resume(
1056 to_usb_interface(hub->intfdev));
1057 return; /* Continues at init2: below */
1058 } else if (type == HUB_RESET_RESUME) {
1059 /* The internal host controller state for the hub device
1060 * may be gone after a host power loss on system resume.
1061 * Update the device's info so the HW knows it's a hub.
1063 hcd = bus_to_hcd(hdev->bus);
1064 if (hcd->driver->update_hub_device) {
1065 ret = hcd->driver->update_hub_device(hcd, hdev,
1066 &hub->tt, GFP_NOIO);
1068 dev_err(hub->intfdev, "Host not "
1069 "accepting hub info "
1071 dev_err(hub->intfdev, "LS/FS devices "
1072 "and hubs may not work "
1073 "under this hub\n.");
1076 hub_power_on(hub, true);
1078 hub_power_on(hub, true);
1083 /* Check each port and set hub->change_bits to let khubd know
1084 * which ports need attention.
1086 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1087 struct usb_device *udev = hub->ports[port1 - 1]->child;
1088 u16 portstatus, portchange;
1090 portstatus = portchange = 0;
1091 status = hub_port_status(hub, port1, &portstatus, &portchange);
1092 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1093 dev_dbg(hub->intfdev,
1094 "port %d: status %04x change %04x\n",
1095 port1, portstatus, portchange);
1097 /* After anything other than HUB_RESUME (i.e., initialization
1098 * or any sort of reset), every port should be disabled.
1099 * Unconnected ports should likewise be disabled (paranoia),
1100 * and so should ports for which we have no usb_device.
1102 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1103 type != HUB_RESUME ||
1104 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1106 udev->state == USB_STATE_NOTATTACHED)) {
1108 * USB3 protocol ports will automatically transition
1109 * to Enabled state when detect an USB3.0 device attach.
1110 * Do not disable USB3 protocol ports.
1112 if (!hub_is_superspeed(hdev)) {
1113 usb_clear_port_feature(hdev, port1,
1114 USB_PORT_FEAT_ENABLE);
1115 portstatus &= ~USB_PORT_STAT_ENABLE;
1117 /* Pretend that power was lost for USB3 devs */
1118 portstatus &= ~USB_PORT_STAT_ENABLE;
1122 /* Clear status-change flags; we'll debounce later */
1123 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1124 need_debounce_delay = true;
1125 usb_clear_port_feature(hub->hdev, port1,
1126 USB_PORT_FEAT_C_CONNECTION);
1128 if (portchange & USB_PORT_STAT_C_ENABLE) {
1129 need_debounce_delay = true;
1130 usb_clear_port_feature(hub->hdev, port1,
1131 USB_PORT_FEAT_C_ENABLE);
1133 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1134 hub_is_superspeed(hub->hdev)) {
1135 need_debounce_delay = true;
1136 usb_clear_port_feature(hub->hdev, port1,
1137 USB_PORT_FEAT_C_BH_PORT_RESET);
1139 /* We can forget about a "removed" device when there's a
1140 * physical disconnect or the connect status changes.
1142 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1143 (portchange & USB_PORT_STAT_C_CONNECTION))
1144 clear_bit(port1, hub->removed_bits);
1146 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1147 /* Tell khubd to disconnect the device or
1148 * check for a new connection
1150 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1151 set_bit(port1, hub->change_bits);
1153 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1154 bool port_resumed = (portstatus &
1155 USB_PORT_STAT_LINK_STATE) ==
1157 /* The power session apparently survived the resume.
1158 * If there was an overcurrent or suspend change
1159 * (i.e., remote wakeup request), have khubd
1160 * take care of it. Look at the port link state
1161 * for USB 3.0 hubs, since they don't have a suspend
1162 * change bit, and they don't set the port link change
1163 * bit on device-initiated resume.
1165 if (portchange || (hub_is_superspeed(hub->hdev) &&
1167 set_bit(port1, hub->change_bits);
1169 } else if (udev->persist_enabled) {
1170 struct usb_port *port_dev = hub->ports[port1 - 1];
1173 udev->reset_resume = 1;
1175 /* Don't set the change_bits when the device
1178 if (port_dev->power_is_on)
1179 set_bit(port1, hub->change_bits);
1182 /* The power session is gone; tell khubd */
1183 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1184 set_bit(port1, hub->change_bits);
1188 /* If no port-status-change flags were set, we don't need any
1189 * debouncing. If flags were set we can try to debounce the
1190 * ports all at once right now, instead of letting khubd do them
1191 * one at a time later on.
1193 * If any port-status changes do occur during this delay, khubd
1194 * will see them later and handle them normally.
1196 if (need_debounce_delay) {
1197 delay = HUB_DEBOUNCE_STABLE;
1199 /* Don't do a long sleep inside a workqueue routine */
1200 if (type == HUB_INIT2) {
1201 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1202 schedule_delayed_work(&hub->init_work,
1203 msecs_to_jiffies(delay));
1204 return; /* Continues at init3: below */
1212 status = usb_submit_urb(hub->urb, GFP_NOIO);
1214 dev_err(hub->intfdev, "activate --> %d\n", status);
1215 if (hub->has_indicators && blinkenlights)
1216 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1218 /* Scan all ports that need attention */
1221 /* Allow autosuspend if it was suppressed */
1222 if (type <= HUB_INIT3)
1223 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1226 /* Implement the continuations for the delays above */
1227 static void hub_init_func2(struct work_struct *ws)
1229 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1231 hub_activate(hub, HUB_INIT2);
1234 static void hub_init_func3(struct work_struct *ws)
1236 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1238 hub_activate(hub, HUB_INIT3);
1241 enum hub_quiescing_type {
1242 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1245 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1247 struct usb_device *hdev = hub->hdev;
1250 cancel_delayed_work_sync(&hub->init_work);
1252 /* khubd and related activity won't re-trigger */
1255 if (type != HUB_SUSPEND) {
1256 /* Disconnect all the children */
1257 for (i = 0; i < hdev->maxchild; ++i) {
1258 if (hub->ports[i]->child)
1259 usb_disconnect(&hub->ports[i]->child);
1263 /* Stop khubd and related activity */
1264 usb_kill_urb(hub->urb);
1265 if (hub->has_indicators)
1266 cancel_delayed_work_sync(&hub->leds);
1268 flush_work(&hub->tt.clear_work);
1271 /* caller has locked the hub device */
1272 static int hub_pre_reset(struct usb_interface *intf)
1274 struct usb_hub *hub = usb_get_intfdata(intf);
1276 hub_quiesce(hub, HUB_PRE_RESET);
1280 /* caller has locked the hub device */
1281 static int hub_post_reset(struct usb_interface *intf)
1283 struct usb_hub *hub = usb_get_intfdata(intf);
1285 hub_activate(hub, HUB_POST_RESET);
1289 static int hub_configure(struct usb_hub *hub,
1290 struct usb_endpoint_descriptor *endpoint)
1292 struct usb_hcd *hcd;
1293 struct usb_device *hdev = hub->hdev;
1294 struct device *hub_dev = hub->intfdev;
1295 u16 hubstatus, hubchange;
1296 u16 wHubCharacteristics;
1299 char *message = "out of memory";
1303 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1309 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1314 mutex_init(&hub->status_mutex);
1316 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1317 if (!hub->descriptor) {
1322 /* Request the entire hub descriptor.
1323 * hub->descriptor can handle USB_MAXCHILDREN ports,
1324 * but the hub can/will return fewer bytes here.
1326 ret = get_hub_descriptor(hdev, hub->descriptor);
1328 message = "can't read hub descriptor";
1330 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1331 message = "hub has too many ports!";
1334 } else if (hub->descriptor->bNbrPorts == 0) {
1335 message = "hub doesn't have any ports!";
1340 hdev->maxchild = hub->descriptor->bNbrPorts;
1341 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1342 (hdev->maxchild == 1) ? "" : "s");
1344 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1351 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1352 if (hub_is_superspeed(hdev)) {
1360 /* FIXME for USB 3.0, skip for now */
1361 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1362 !(hub_is_superspeed(hdev))) {
1364 char portstr [USB_MAXCHILDREN + 1];
1366 for (i = 0; i < hdev->maxchild; i++)
1367 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1368 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1370 portstr[hdev->maxchild] = 0;
1371 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1373 dev_dbg(hub_dev, "standalone hub\n");
1375 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1376 case HUB_CHAR_COMMON_LPSM:
1377 dev_dbg(hub_dev, "ganged power switching\n");
1379 case HUB_CHAR_INDV_PORT_LPSM:
1380 dev_dbg(hub_dev, "individual port power switching\n");
1382 case HUB_CHAR_NO_LPSM:
1384 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1388 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1389 case HUB_CHAR_COMMON_OCPM:
1390 dev_dbg(hub_dev, "global over-current protection\n");
1392 case HUB_CHAR_INDV_PORT_OCPM:
1393 dev_dbg(hub_dev, "individual port over-current protection\n");
1395 case HUB_CHAR_NO_OCPM:
1397 dev_dbg(hub_dev, "no over-current protection\n");
1401 spin_lock_init (&hub->tt.lock);
1402 INIT_LIST_HEAD (&hub->tt.clear_list);
1403 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1404 switch (hdev->descriptor.bDeviceProtocol) {
1407 case USB_HUB_PR_HS_SINGLE_TT:
1408 dev_dbg(hub_dev, "Single TT\n");
1411 case USB_HUB_PR_HS_MULTI_TT:
1412 ret = usb_set_interface(hdev, 0, 1);
1414 dev_dbg(hub_dev, "TT per port\n");
1417 dev_err(hub_dev, "Using single TT (err %d)\n",
1422 /* USB 3.0 hubs don't have a TT */
1425 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1426 hdev->descriptor.bDeviceProtocol);
1430 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1431 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1432 case HUB_TTTT_8_BITS:
1433 if (hdev->descriptor.bDeviceProtocol != 0) {
1434 hub->tt.think_time = 666;
1435 dev_dbg(hub_dev, "TT requires at most %d "
1436 "FS bit times (%d ns)\n",
1437 8, hub->tt.think_time);
1440 case HUB_TTTT_16_BITS:
1441 hub->tt.think_time = 666 * 2;
1442 dev_dbg(hub_dev, "TT requires at most %d "
1443 "FS bit times (%d ns)\n",
1444 16, hub->tt.think_time);
1446 case HUB_TTTT_24_BITS:
1447 hub->tt.think_time = 666 * 3;
1448 dev_dbg(hub_dev, "TT requires at most %d "
1449 "FS bit times (%d ns)\n",
1450 24, hub->tt.think_time);
1452 case HUB_TTTT_32_BITS:
1453 hub->tt.think_time = 666 * 4;
1454 dev_dbg(hub_dev, "TT requires at most %d "
1455 "FS bit times (%d ns)\n",
1456 32, hub->tt.think_time);
1460 /* probe() zeroes hub->indicator[] */
1461 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1462 hub->has_indicators = 1;
1463 dev_dbg(hub_dev, "Port indicators are supported\n");
1466 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1467 hub->descriptor->bPwrOn2PwrGood * 2);
1469 /* power budgeting mostly matters with bus-powered hubs,
1470 * and battery-powered root hubs (may provide just 8 mA).
1472 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1474 message = "can't get hub status";
1477 hcd = bus_to_hcd(hdev->bus);
1478 if (hdev == hdev->bus->root_hub) {
1479 if (hcd->power_budget > 0)
1480 hdev->bus_mA = hcd->power_budget;
1482 hdev->bus_mA = full_load * hdev->maxchild;
1483 if (hdev->bus_mA >= full_load)
1484 hub->mA_per_port = full_load;
1486 hub->mA_per_port = hdev->bus_mA;
1487 hub->limited_power = 1;
1489 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1490 int remaining = hdev->bus_mA -
1491 hub->descriptor->bHubContrCurrent;
1493 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1494 hub->descriptor->bHubContrCurrent);
1495 hub->limited_power = 1;
1497 if (remaining < hdev->maxchild * unit_load)
1499 "insufficient power available "
1500 "to use all downstream ports\n");
1501 hub->mA_per_port = unit_load; /* 7.2.1 */
1503 } else { /* Self-powered external hub */
1504 /* FIXME: What about battery-powered external hubs that
1505 * provide less current per port? */
1506 hub->mA_per_port = full_load;
1508 if (hub->mA_per_port < full_load)
1509 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1512 /* Update the HCD's internal representation of this hub before khubd
1513 * starts getting port status changes for devices under the hub.
1515 if (hcd->driver->update_hub_device) {
1516 ret = hcd->driver->update_hub_device(hcd, hdev,
1517 &hub->tt, GFP_KERNEL);
1519 message = "can't update HCD hub info";
1524 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1526 message = "can't get hub status";
1530 /* local power status reports aren't always correct */
1531 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1532 dev_dbg(hub_dev, "local power source is %s\n",
1533 (hubstatus & HUB_STATUS_LOCAL_POWER)
1534 ? "lost (inactive)" : "good");
1536 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1537 dev_dbg(hub_dev, "%sover-current condition exists\n",
1538 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1540 /* set up the interrupt endpoint
1541 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1542 * bytes as USB2.0[11.12.3] says because some hubs are known
1543 * to send more data (and thus cause overflow). For root hubs,
1544 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1545 * to be big enough for at least USB_MAXCHILDREN ports. */
1546 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1547 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1549 if (maxp > sizeof(*hub->buffer))
1550 maxp = sizeof(*hub->buffer);
1552 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1558 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1559 hub, endpoint->bInterval);
1561 /* maybe cycle the hub leds */
1562 if (hub->has_indicators && blinkenlights)
1563 hub->indicator [0] = INDICATOR_CYCLE;
1565 for (i = 0; i < hdev->maxchild; i++)
1566 if (usb_hub_create_port_device(hub, i + 1) < 0)
1567 dev_err(hub->intfdev,
1568 "couldn't create port%d device.\n", i + 1);
1570 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1572 hub_activate(hub, HUB_INIT);
1576 dev_err (hub_dev, "config failed, %s (err %d)\n",
1578 /* hub_disconnect() frees urb and descriptor */
1582 static void hub_release(struct kref *kref)
1584 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1586 usb_put_intf(to_usb_interface(hub->intfdev));
1590 static unsigned highspeed_hubs;
1592 static void hub_disconnect(struct usb_interface *intf)
1594 struct usb_hub *hub = usb_get_intfdata(intf);
1595 struct usb_device *hdev = interface_to_usbdev(intf);
1598 /* Take the hub off the event list and don't let it be added again */
1599 spin_lock_irq(&hub_event_lock);
1600 if (!list_empty(&hub->event_list)) {
1601 list_del_init(&hub->event_list);
1602 usb_autopm_put_interface_no_suspend(intf);
1604 hub->disconnected = 1;
1605 spin_unlock_irq(&hub_event_lock);
1607 /* Disconnect all children and quiesce the hub */
1609 hub_quiesce(hub, HUB_DISCONNECT);
1611 usb_set_intfdata (intf, NULL);
1613 for (i = 0; i < hdev->maxchild; i++)
1614 usb_hub_remove_port_device(hub, i + 1);
1615 hub->hdev->maxchild = 0;
1617 if (hub->hdev->speed == USB_SPEED_HIGH)
1620 usb_free_urb(hub->urb);
1622 kfree(hub->descriptor);
1626 pm_suspend_ignore_children(&intf->dev, false);
1627 kref_put(&hub->kref, hub_release);
1630 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1632 struct usb_host_interface *desc;
1633 struct usb_endpoint_descriptor *endpoint;
1634 struct usb_device *hdev;
1635 struct usb_hub *hub;
1637 desc = intf->cur_altsetting;
1638 hdev = interface_to_usbdev(intf);
1641 * Set default autosuspend delay as 0 to speedup bus suspend,
1642 * based on the below considerations:
1644 * - Unlike other drivers, the hub driver does not rely on the
1645 * autosuspend delay to provide enough time to handle a wakeup
1646 * event, and the submitted status URB is just to check future
1647 * change on hub downstream ports, so it is safe to do it.
1649 * - The patch might cause one or more auto supend/resume for
1650 * below very rare devices when they are plugged into hub
1653 * devices having trouble initializing, and disconnect
1654 * themselves from the bus and then reconnect a second
1657 * devices just for downloading firmware, and disconnects
1658 * themselves after completing it
1660 * For these quite rare devices, their drivers may change the
1661 * autosuspend delay of their parent hub in the probe() to one
1662 * appropriate value to avoid the subtle problem if someone
1665 * - The patch may cause one or more auto suspend/resume on
1666 * hub during running 'lsusb', but it is probably too
1667 * infrequent to worry about.
1669 * - Change autosuspend delay of hub can avoid unnecessary auto
1670 * suspend timer for hub, also may decrease power consumption
1673 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1675 /* Hubs have proper suspend/resume support. */
1676 usb_enable_autosuspend(hdev);
1678 if (hdev->level == MAX_TOPO_LEVEL) {
1680 "Unsupported bus topology: hub nested too deep\n");
1684 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1686 dev_warn(&intf->dev, "ignoring external hub\n");
1691 /* Some hubs have a subclass of 1, which AFAICT according to the */
1692 /* specs is not defined, but it works */
1693 if ((desc->desc.bInterfaceSubClass != 0) &&
1694 (desc->desc.bInterfaceSubClass != 1)) {
1696 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1700 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1701 if (desc->desc.bNumEndpoints != 1)
1702 goto descriptor_error;
1704 endpoint = &desc->endpoint[0].desc;
1706 /* If it's not an interrupt in endpoint, we'd better punt! */
1707 if (!usb_endpoint_is_int_in(endpoint))
1708 goto descriptor_error;
1710 /* We found a hub */
1711 dev_info (&intf->dev, "USB hub found\n");
1713 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1715 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1719 kref_init(&hub->kref);
1720 INIT_LIST_HEAD(&hub->event_list);
1721 hub->intfdev = &intf->dev;
1723 INIT_DELAYED_WORK(&hub->leds, led_work);
1724 INIT_DELAYED_WORK(&hub->init_work, NULL);
1727 usb_set_intfdata (intf, hub);
1728 intf->needs_remote_wakeup = 1;
1729 pm_suspend_ignore_children(&intf->dev, true);
1731 if (hdev->speed == USB_SPEED_HIGH)
1734 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1735 hub->quirk_check_port_auto_suspend = 1;
1737 if (hub_configure(hub, endpoint) >= 0)
1740 hub_disconnect (intf);
1745 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1747 struct usb_device *hdev = interface_to_usbdev (intf);
1748 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1750 /* assert ifno == 0 (part of hub spec) */
1752 case USBDEVFS_HUB_PORTINFO: {
1753 struct usbdevfs_hub_portinfo *info = user_data;
1756 spin_lock_irq(&device_state_lock);
1757 if (hdev->devnum <= 0)
1760 info->nports = hdev->maxchild;
1761 for (i = 0; i < info->nports; i++) {
1762 if (hub->ports[i]->child == NULL)
1766 hub->ports[i]->child->devnum;
1769 spin_unlock_irq(&device_state_lock);
1771 return info->nports + 1;
1780 * Allow user programs to claim ports on a hub. When a device is attached
1781 * to one of these "claimed" ports, the program will "own" the device.
1783 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1784 struct dev_state ***ppowner)
1786 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1788 if (hdev->state == USB_STATE_NOTATTACHED)
1790 if (port1 == 0 || port1 > hdev->maxchild)
1793 /* Devices not managed by the hub driver
1794 * will always have maxchild equal to 0.
1796 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1800 /* In the following three functions, the caller must hold hdev's lock */
1801 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1802 struct dev_state *owner)
1805 struct dev_state **powner;
1807 rc = find_port_owner(hdev, port1, &powner);
1816 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1817 struct dev_state *owner)
1820 struct dev_state **powner;
1822 rc = find_port_owner(hdev, port1, &powner);
1825 if (*powner != owner)
1831 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1833 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1836 for (n = 0; n < hdev->maxchild; n++) {
1837 if (hub->ports[n]->port_owner == owner)
1838 hub->ports[n]->port_owner = NULL;
1843 /* The caller must hold udev's lock */
1844 bool usb_device_is_owned(struct usb_device *udev)
1846 struct usb_hub *hub;
1848 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1850 hub = usb_hub_to_struct_hub(udev->parent);
1851 return !!hub->ports[udev->portnum - 1]->port_owner;
1854 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1856 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1859 for (i = 0; i < udev->maxchild; ++i) {
1860 if (hub->ports[i]->child)
1861 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1863 if (udev->state == USB_STATE_SUSPENDED)
1864 udev->active_duration -= jiffies;
1865 udev->state = USB_STATE_NOTATTACHED;
1869 * usb_set_device_state - change a device's current state (usbcore, hcds)
1870 * @udev: pointer to device whose state should be changed
1871 * @new_state: new state value to be stored
1873 * udev->state is _not_ fully protected by the device lock. Although
1874 * most transitions are made only while holding the lock, the state can
1875 * can change to USB_STATE_NOTATTACHED at almost any time. This
1876 * is so that devices can be marked as disconnected as soon as possible,
1877 * without having to wait for any semaphores to be released. As a result,
1878 * all changes to any device's state must be protected by the
1879 * device_state_lock spinlock.
1881 * Once a device has been added to the device tree, all changes to its state
1882 * should be made using this routine. The state should _not_ be set directly.
1884 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1885 * Otherwise udev->state is set to new_state, and if new_state is
1886 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1887 * to USB_STATE_NOTATTACHED.
1889 void usb_set_device_state(struct usb_device *udev,
1890 enum usb_device_state new_state)
1892 unsigned long flags;
1895 spin_lock_irqsave(&device_state_lock, flags);
1896 if (udev->state == USB_STATE_NOTATTACHED)
1898 else if (new_state != USB_STATE_NOTATTACHED) {
1900 /* root hub wakeup capabilities are managed out-of-band
1901 * and may involve silicon errata ... ignore them here.
1904 if (udev->state == USB_STATE_SUSPENDED
1905 || new_state == USB_STATE_SUSPENDED)
1906 ; /* No change to wakeup settings */
1907 else if (new_state == USB_STATE_CONFIGURED)
1908 wakeup = udev->actconfig->desc.bmAttributes
1909 & USB_CONFIG_ATT_WAKEUP;
1913 if (udev->state == USB_STATE_SUSPENDED &&
1914 new_state != USB_STATE_SUSPENDED)
1915 udev->active_duration -= jiffies;
1916 else if (new_state == USB_STATE_SUSPENDED &&
1917 udev->state != USB_STATE_SUSPENDED)
1918 udev->active_duration += jiffies;
1919 udev->state = new_state;
1921 recursively_mark_NOTATTACHED(udev);
1922 spin_unlock_irqrestore(&device_state_lock, flags);
1924 device_set_wakeup_capable(&udev->dev, wakeup);
1926 EXPORT_SYMBOL_GPL(usb_set_device_state);
1929 * Choose a device number.
1931 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1932 * USB-2.0 buses they are also used as device addresses, however on
1933 * USB-3.0 buses the address is assigned by the controller hardware
1934 * and it usually is not the same as the device number.
1936 * WUSB devices are simple: they have no hubs behind, so the mapping
1937 * device <-> virtual port number becomes 1:1. Why? to simplify the
1938 * life of the device connection logic in
1939 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1940 * handshake we need to assign a temporary address in the unauthorized
1941 * space. For simplicity we use the first virtual port number found to
1942 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1943 * and that becomes it's address [X < 128] or its unauthorized address
1946 * We add 1 as an offset to the one-based USB-stack port number
1947 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1948 * 0 is reserved by USB for default address; (b) Linux's USB stack
1949 * uses always #1 for the root hub of the controller. So USB stack's
1950 * port #1, which is wusb virtual-port #0 has address #2.
1952 * Devices connected under xHCI are not as simple. The host controller
1953 * supports virtualization, so the hardware assigns device addresses and
1954 * the HCD must setup data structures before issuing a set address
1955 * command to the hardware.
1957 static void choose_devnum(struct usb_device *udev)
1960 struct usb_bus *bus = udev->bus;
1962 /* If khubd ever becomes multithreaded, this will need a lock */
1964 devnum = udev->portnum + 1;
1965 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1967 /* Try to allocate the next devnum beginning at
1968 * bus->devnum_next. */
1969 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1972 devnum = find_next_zero_bit(bus->devmap.devicemap,
1974 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1977 set_bit(devnum, bus->devmap.devicemap);
1978 udev->devnum = devnum;
1982 static void release_devnum(struct usb_device *udev)
1984 if (udev->devnum > 0) {
1985 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1990 static void update_devnum(struct usb_device *udev, int devnum)
1992 /* The address for a WUSB device is managed by wusbcore. */
1994 udev->devnum = devnum;
1997 static void hub_free_dev(struct usb_device *udev)
1999 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2001 /* Root hubs aren't real devices, so don't free HCD resources */
2002 if (hcd->driver->free_dev && udev->parent)
2003 hcd->driver->free_dev(hcd, udev);
2007 * usb_disconnect - disconnect a device (usbcore-internal)
2008 * @pdev: pointer to device being disconnected
2009 * Context: !in_interrupt ()
2011 * Something got disconnected. Get rid of it and all of its children.
2013 * If *pdev is a normal device then the parent hub must already be locked.
2014 * If *pdev is a root hub then this routine will acquire the
2015 * usb_bus_list_lock on behalf of the caller.
2017 * Only hub drivers (including virtual root hub drivers for host
2018 * controllers) should ever call this.
2020 * This call is synchronous, and may not be used in an interrupt context.
2022 void usb_disconnect(struct usb_device **pdev)
2024 struct usb_device *udev = *pdev;
2025 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2028 /* mark the device as inactive, so any further urb submissions for
2029 * this device (and any of its children) will fail immediately.
2030 * this quiesces everything except pending urbs.
2032 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2033 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2036 usb_lock_device(udev);
2038 /* Free up all the children before we remove this device */
2039 for (i = 0; i < udev->maxchild; i++) {
2040 if (hub->ports[i]->child)
2041 usb_disconnect(&hub->ports[i]->child);
2044 /* deallocate hcd/hardware state ... nuking all pending urbs and
2045 * cleaning up all state associated with the current configuration
2046 * so that the hardware is now fully quiesced.
2048 dev_dbg (&udev->dev, "unregistering device\n");
2049 usb_disable_device(udev, 0);
2050 usb_hcd_synchronize_unlinks(udev);
2053 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2054 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2056 sysfs_remove_link(&udev->dev.kobj, "port");
2057 sysfs_remove_link(&port_dev->dev.kobj, "device");
2059 if (!port_dev->did_runtime_put)
2060 pm_runtime_put(&port_dev->dev);
2062 port_dev->did_runtime_put = false;
2065 usb_remove_ep_devs(&udev->ep0);
2066 usb_unlock_device(udev);
2068 /* Unregister the device. The device driver is responsible
2069 * for de-configuring the device and invoking the remove-device
2070 * notifier chain (used by usbfs and possibly others).
2072 device_del(&udev->dev);
2074 /* Free the device number and delete the parent's children[]
2075 * (or root_hub) pointer.
2077 release_devnum(udev);
2079 /* Avoid races with recursively_mark_NOTATTACHED() */
2080 spin_lock_irq(&device_state_lock);
2082 spin_unlock_irq(&device_state_lock);
2086 put_device(&udev->dev);
2089 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2090 static void show_string(struct usb_device *udev, char *id, char *string)
2094 dev_info(&udev->dev, "%s: %s\n", id, string);
2097 static void announce_device(struct usb_device *udev)
2099 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2100 le16_to_cpu(udev->descriptor.idVendor),
2101 le16_to_cpu(udev->descriptor.idProduct));
2102 dev_info(&udev->dev,
2103 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2104 udev->descriptor.iManufacturer,
2105 udev->descriptor.iProduct,
2106 udev->descriptor.iSerialNumber);
2107 show_string(udev, "Product", udev->product);
2108 show_string(udev, "Manufacturer", udev->manufacturer);
2109 show_string(udev, "SerialNumber", udev->serial);
2112 static inline void announce_device(struct usb_device *udev) { }
2115 #ifdef CONFIG_USB_OTG
2116 #include "otg_whitelist.h"
2120 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2121 * @udev: newly addressed device (in ADDRESS state)
2123 * Finish enumeration for On-The-Go devices
2125 * Return: 0 if successful. A negative error code otherwise.
2127 static int usb_enumerate_device_otg(struct usb_device *udev)
2131 #ifdef CONFIG_USB_OTG
2133 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2134 * to wake us after we've powered off VBUS; and HNP, switching roles
2135 * "host" to "peripheral". The OTG descriptor helps figure this out.
2137 if (!udev->bus->is_b_host
2139 && udev->parent == udev->bus->root_hub) {
2140 struct usb_otg_descriptor *desc = NULL;
2141 struct usb_bus *bus = udev->bus;
2143 /* descriptor may appear anywhere in config */
2144 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2145 le16_to_cpu(udev->config[0].desc.wTotalLength),
2146 USB_DT_OTG, (void **) &desc) == 0) {
2147 if (desc->bmAttributes & USB_OTG_HNP) {
2148 unsigned port1 = udev->portnum;
2150 dev_info(&udev->dev,
2151 "Dual-Role OTG device on %sHNP port\n",
2152 (port1 == bus->otg_port)
2155 /* enable HNP before suspend, it's simpler */
2156 if (port1 == bus->otg_port)
2157 bus->b_hnp_enable = 1;
2158 err = usb_control_msg(udev,
2159 usb_sndctrlpipe(udev, 0),
2160 USB_REQ_SET_FEATURE, 0,
2162 ? USB_DEVICE_B_HNP_ENABLE
2163 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2164 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2166 /* OTG MESSAGE: report errors here,
2167 * customize to match your product.
2169 dev_info(&udev->dev,
2170 "can't set HNP mode: %d\n",
2172 bus->b_hnp_enable = 0;
2178 if (!is_targeted(udev)) {
2180 /* Maybe it can talk to us, though we can't talk to it.
2181 * (Includes HNP test device.)
2183 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2184 err = usb_port_suspend(udev, PMSG_SUSPEND);
2186 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2198 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2199 * @udev: newly addressed device (in ADDRESS state)
2201 * This is only called by usb_new_device() and usb_authorize_device()
2202 * and FIXME -- all comments that apply to them apply here wrt to
2205 * If the device is WUSB and not authorized, we don't attempt to read
2206 * the string descriptors, as they will be errored out by the device
2207 * until it has been authorized.
2209 * Return: 0 if successful. A negative error code otherwise.
2211 static int usb_enumerate_device(struct usb_device *udev)
2215 if (udev->config == NULL) {
2216 err = usb_get_configuration(udev);
2219 dev_err(&udev->dev, "can't read configurations, error %d\n",
2224 if (udev->wusb == 1 && udev->authorized == 0) {
2225 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2226 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2227 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2230 /* read the standard strings and cache them if present */
2231 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2232 udev->manufacturer = usb_cache_string(udev,
2233 udev->descriptor.iManufacturer);
2234 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2236 err = usb_enumerate_device_otg(udev);
2240 usb_detect_interface_quirks(udev);
2245 static void set_usb_port_removable(struct usb_device *udev)
2247 struct usb_device *hdev = udev->parent;
2248 struct usb_hub *hub;
2249 u8 port = udev->portnum;
2250 u16 wHubCharacteristics;
2251 bool removable = true;
2256 hub = usb_hub_to_struct_hub(udev->parent);
2258 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2260 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2263 if (hub_is_superspeed(hdev)) {
2264 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2268 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2273 udev->removable = USB_DEVICE_REMOVABLE;
2275 udev->removable = USB_DEVICE_FIXED;
2279 * usb_new_device - perform initial device setup (usbcore-internal)
2280 * @udev: newly addressed device (in ADDRESS state)
2282 * This is called with devices which have been detected but not fully
2283 * enumerated. The device descriptor is available, but not descriptors
2284 * for any device configuration. The caller must have locked either
2285 * the parent hub (if udev is a normal device) or else the
2286 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2287 * udev has already been installed, but udev is not yet visible through
2288 * sysfs or other filesystem code.
2290 * This call is synchronous, and may not be used in an interrupt context.
2292 * Only the hub driver or root-hub registrar should ever call this.
2294 * Return: Whether the device is configured properly or not. Zero if the
2295 * interface was registered with the driver core; else a negative errno
2299 int usb_new_device(struct usb_device *udev)
2304 /* Initialize non-root-hub device wakeup to disabled;
2305 * device (un)configuration controls wakeup capable
2306 * sysfs power/wakeup controls wakeup enabled/disabled
2308 device_init_wakeup(&udev->dev, 0);
2311 /* Tell the runtime-PM framework the device is active */
2312 pm_runtime_set_active(&udev->dev);
2313 pm_runtime_get_noresume(&udev->dev);
2314 pm_runtime_use_autosuspend(&udev->dev);
2315 pm_runtime_enable(&udev->dev);
2317 /* By default, forbid autosuspend for all devices. It will be
2318 * allowed for hubs during binding.
2320 usb_disable_autosuspend(udev);
2322 err = usb_enumerate_device(udev); /* Read descriptors */
2325 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2326 udev->devnum, udev->bus->busnum,
2327 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2328 /* export the usbdev device-node for libusb */
2329 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2330 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2332 /* Tell the world! */
2333 announce_device(udev);
2336 add_device_randomness(udev->serial, strlen(udev->serial));
2338 add_device_randomness(udev->product, strlen(udev->product));
2339 if (udev->manufacturer)
2340 add_device_randomness(udev->manufacturer,
2341 strlen(udev->manufacturer));
2343 device_enable_async_suspend(&udev->dev);
2346 * check whether the hub marks this port as non-removable. Do it
2347 * now so that platform-specific data can override it in
2351 set_usb_port_removable(udev);
2353 /* Register the device. The device driver is responsible
2354 * for configuring the device and invoking the add-device
2355 * notifier chain (used by usbfs and possibly others).
2357 err = device_add(&udev->dev);
2359 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2363 /* Create link files between child device and usb port device. */
2365 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2366 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2368 err = sysfs_create_link(&udev->dev.kobj,
2369 &port_dev->dev.kobj, "port");
2373 err = sysfs_create_link(&port_dev->dev.kobj,
2374 &udev->dev.kobj, "device");
2376 sysfs_remove_link(&udev->dev.kobj, "port");
2380 pm_runtime_get_sync(&port_dev->dev);
2383 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2384 usb_mark_last_busy(udev);
2385 pm_runtime_put_sync_autosuspend(&udev->dev);
2389 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2390 pm_runtime_disable(&udev->dev);
2391 pm_runtime_set_suspended(&udev->dev);
2397 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2398 * @usb_dev: USB device
2400 * Move the USB device to a very basic state where interfaces are disabled
2401 * and the device is in fact unconfigured and unusable.
2403 * We share a lock (that we have) with device_del(), so we need to
2408 int usb_deauthorize_device(struct usb_device *usb_dev)
2410 usb_lock_device(usb_dev);
2411 if (usb_dev->authorized == 0)
2412 goto out_unauthorized;
2414 usb_dev->authorized = 0;
2415 usb_set_configuration(usb_dev, -1);
2417 kfree(usb_dev->product);
2418 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2419 kfree(usb_dev->manufacturer);
2420 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2421 kfree(usb_dev->serial);
2422 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2424 usb_destroy_configuration(usb_dev);
2425 usb_dev->descriptor.bNumConfigurations = 0;
2428 usb_unlock_device(usb_dev);
2433 int usb_authorize_device(struct usb_device *usb_dev)
2437 usb_lock_device(usb_dev);
2438 if (usb_dev->authorized == 1)
2439 goto out_authorized;
2441 result = usb_autoresume_device(usb_dev);
2443 dev_err(&usb_dev->dev,
2444 "can't autoresume for authorization: %d\n", result);
2445 goto error_autoresume;
2447 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2449 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2450 "authorization: %d\n", result);
2451 goto error_device_descriptor;
2454 kfree(usb_dev->product);
2455 usb_dev->product = NULL;
2456 kfree(usb_dev->manufacturer);
2457 usb_dev->manufacturer = NULL;
2458 kfree(usb_dev->serial);
2459 usb_dev->serial = NULL;
2461 usb_dev->authorized = 1;
2462 result = usb_enumerate_device(usb_dev);
2464 goto error_enumerate;
2465 /* Choose and set the configuration. This registers the interfaces
2466 * with the driver core and lets interface drivers bind to them.
2468 c = usb_choose_configuration(usb_dev);
2470 result = usb_set_configuration(usb_dev, c);
2472 dev_err(&usb_dev->dev,
2473 "can't set config #%d, error %d\n", c, result);
2474 /* This need not be fatal. The user can try to
2475 * set other configurations. */
2478 dev_info(&usb_dev->dev, "authorized to connect\n");
2481 error_device_descriptor:
2482 usb_autosuspend_device(usb_dev);
2485 usb_unlock_device(usb_dev); // complements locktree
2490 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2491 static unsigned hub_is_wusb(struct usb_hub *hub)
2493 struct usb_hcd *hcd;
2494 if (hub->hdev->parent != NULL) /* not a root hub? */
2496 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2497 return hcd->wireless;
2501 #define PORT_RESET_TRIES 5
2502 #define SET_ADDRESS_TRIES 2
2503 #define GET_DESCRIPTOR_TRIES 2
2504 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2505 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2507 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2508 #define HUB_SHORT_RESET_TIME 10
2509 #define HUB_BH_RESET_TIME 50
2510 #define HUB_LONG_RESET_TIME 200
2511 #define HUB_RESET_TIMEOUT 800
2513 static int hub_port_reset(struct usb_hub *hub, int port1,
2514 struct usb_device *udev, unsigned int delay, bool warm);
2516 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2517 * Port worm reset is required to recover
2519 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2521 return hub_is_superspeed(hub->hdev) &&
2522 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2523 USB_SS_PORT_LS_SS_INACTIVE) ||
2524 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2525 USB_SS_PORT_LS_COMP_MOD)) ;
2528 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2529 struct usb_device *udev, unsigned int delay, bool warm)
2531 int delay_time, ret;
2535 for (delay_time = 0;
2536 delay_time < HUB_RESET_TIMEOUT;
2537 delay_time += delay) {
2538 /* wait to give the device a chance to reset */
2541 /* read and decode port status */
2542 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2546 /* The port state is unknown until the reset completes. */
2547 if (!(portstatus & USB_PORT_STAT_RESET))
2550 /* switch to the long delay after two short delay failures */
2551 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2552 delay = HUB_LONG_RESET_TIME;
2554 dev_dbg (hub->intfdev,
2555 "port %d not %sreset yet, waiting %dms\n",
2556 port1, warm ? "warm " : "", delay);
2559 if ((portstatus & USB_PORT_STAT_RESET))
2562 if (hub_port_warm_reset_required(hub, portstatus))
2565 /* Device went away? */
2566 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2569 /* bomb out completely if the connection bounced. A USB 3.0
2570 * connection may bounce if multiple warm resets were issued,
2571 * but the device may have successfully re-connected. Ignore it.
2573 if (!hub_is_superspeed(hub->hdev) &&
2574 (portchange & USB_PORT_STAT_C_CONNECTION))
2577 if (!(portstatus & USB_PORT_STAT_ENABLE))
2583 if (hub_is_wusb(hub))
2584 udev->speed = USB_SPEED_WIRELESS;
2585 else if (hub_is_superspeed(hub->hdev))
2586 udev->speed = USB_SPEED_SUPER;
2587 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2588 udev->speed = USB_SPEED_HIGH;
2589 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2590 udev->speed = USB_SPEED_LOW;
2592 udev->speed = USB_SPEED_FULL;
2596 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2597 struct usb_device *udev, int *status)
2601 /* TRSTRCY = 10 ms; plus some extra */
2604 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2606 update_devnum(udev, 0);
2607 /* The xHC may think the device is already reset,
2608 * so ignore the status.
2610 if (hcd->driver->reset_device)
2611 hcd->driver->reset_device(hcd, udev);
2616 usb_clear_port_feature(hub->hdev,
2617 port1, USB_PORT_FEAT_C_RESET);
2618 if (hub_is_superspeed(hub->hdev)) {
2619 usb_clear_port_feature(hub->hdev, port1,
2620 USB_PORT_FEAT_C_BH_PORT_RESET);
2621 usb_clear_port_feature(hub->hdev, port1,
2622 USB_PORT_FEAT_C_PORT_LINK_STATE);
2623 usb_clear_port_feature(hub->hdev, port1,
2624 USB_PORT_FEAT_C_CONNECTION);
2627 usb_set_device_state(udev, *status
2628 ? USB_STATE_NOTATTACHED
2629 : USB_STATE_DEFAULT);
2634 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2635 static int hub_port_reset(struct usb_hub *hub, int port1,
2636 struct usb_device *udev, unsigned int delay, bool warm)
2639 u16 portchange, portstatus;
2641 if (!hub_is_superspeed(hub->hdev)) {
2643 dev_err(hub->intfdev, "only USB3 hub support "
2647 /* Block EHCI CF initialization during the port reset.
2648 * Some companion controllers don't like it when they mix.
2650 down_read(&ehci_cf_port_reset_rwsem);
2653 * If the caller hasn't explicitly requested a warm reset,
2654 * double check and see if one is needed.
2656 status = hub_port_status(hub, port1,
2657 &portstatus, &portchange);
2661 if (hub_port_warm_reset_required(hub, portstatus))
2665 /* Reset the port */
2666 for (i = 0; i < PORT_RESET_TRIES; i++) {
2667 status = set_port_feature(hub->hdev, port1, (warm ?
2668 USB_PORT_FEAT_BH_PORT_RESET :
2669 USB_PORT_FEAT_RESET));
2670 if (status == -ENODEV) {
2671 ; /* The hub is gone */
2672 } else if (status) {
2673 dev_err(hub->intfdev,
2674 "cannot %sreset port %d (err = %d)\n",
2675 warm ? "warm " : "", port1, status);
2677 status = hub_port_wait_reset(hub, port1, udev, delay,
2679 if (status && status != -ENOTCONN && status != -ENODEV)
2680 dev_dbg(hub->intfdev,
2681 "port_wait_reset: err = %d\n",
2685 /* Check for disconnect or reset */
2686 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2687 hub_port_finish_reset(hub, port1, udev, &status);
2689 if (!hub_is_superspeed(hub->hdev))
2693 * If a USB 3.0 device migrates from reset to an error
2694 * state, re-issue the warm reset.
2696 if (hub_port_status(hub, port1,
2697 &portstatus, &portchange) < 0)
2700 if (!hub_port_warm_reset_required(hub, portstatus))
2704 * If the port is in SS.Inactive or Compliance Mode, the
2705 * hot or warm reset failed. Try another warm reset.
2708 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2714 dev_dbg (hub->intfdev,
2715 "port %d not enabled, trying %sreset again...\n",
2716 port1, warm ? "warm " : "");
2717 delay = HUB_LONG_RESET_TIME;
2720 dev_err (hub->intfdev,
2721 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2725 if (!hub_is_superspeed(hub->hdev))
2726 up_read(&ehci_cf_port_reset_rwsem);
2731 /* Check if a port is power on */
2732 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2736 if (hub_is_superspeed(hub->hdev)) {
2737 if (portstatus & USB_SS_PORT_STAT_POWER)
2740 if (portstatus & USB_PORT_STAT_POWER)
2749 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2750 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2754 if (hub_is_superspeed(hub->hdev)) {
2755 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2756 == USB_SS_PORT_LS_U3)
2759 if (portstatus & USB_PORT_STAT_SUSPEND)
2766 /* Determine whether the device on a port is ready for a normal resume,
2767 * is ready for a reset-resume, or should be disconnected.
2769 static int check_port_resume_type(struct usb_device *udev,
2770 struct usb_hub *hub, int port1,
2771 int status, unsigned portchange, unsigned portstatus)
2773 /* Is the device still present? */
2774 if (status || port_is_suspended(hub, portstatus) ||
2775 !port_is_power_on(hub, portstatus) ||
2776 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2781 /* Can't do a normal resume if the port isn't enabled,
2782 * so try a reset-resume instead.
2784 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2785 if (udev->persist_enabled)
2786 udev->reset_resume = 1;
2792 dev_dbg(hub->intfdev,
2793 "port %d status %04x.%04x after resume, %d\n",
2794 port1, portchange, portstatus, status);
2795 } else if (udev->reset_resume) {
2797 /* Late port handoff can set status-change bits */
2798 if (portchange & USB_PORT_STAT_C_CONNECTION)
2799 usb_clear_port_feature(hub->hdev, port1,
2800 USB_PORT_FEAT_C_CONNECTION);
2801 if (portchange & USB_PORT_STAT_C_ENABLE)
2802 usb_clear_port_feature(hub->hdev, port1,
2803 USB_PORT_FEAT_C_ENABLE);
2809 int usb_disable_ltm(struct usb_device *udev)
2811 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2813 /* Check if the roothub and device supports LTM. */
2814 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2815 !usb_device_supports_ltm(udev))
2818 /* Clear Feature LTM Enable can only be sent if the device is
2821 if (!udev->actconfig)
2824 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2825 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2826 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2827 USB_CTRL_SET_TIMEOUT);
2829 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2831 void usb_enable_ltm(struct usb_device *udev)
2833 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2835 /* Check if the roothub and device supports LTM. */
2836 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2837 !usb_device_supports_ltm(udev))
2840 /* Set Feature LTM Enable can only be sent if the device is
2843 if (!udev->actconfig)
2846 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2847 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2848 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2849 USB_CTRL_SET_TIMEOUT);
2851 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2854 * usb_enable_remote_wakeup - enable remote wakeup for a device
2855 * @udev: target device
2857 * For USB-2 devices: Set the device's remote wakeup feature.
2859 * For USB-3 devices: Assume there's only one function on the device and
2860 * enable remote wake for the first interface. FIXME if the interface
2861 * association descriptor shows there's more than one function.
2863 static int usb_enable_remote_wakeup(struct usb_device *udev)
2865 if (udev->speed < USB_SPEED_SUPER)
2866 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2867 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2868 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2869 USB_CTRL_SET_TIMEOUT);
2871 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2872 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2873 USB_INTRF_FUNC_SUSPEND,
2874 USB_INTRF_FUNC_SUSPEND_RW |
2875 USB_INTRF_FUNC_SUSPEND_LP,
2876 NULL, 0, USB_CTRL_SET_TIMEOUT);
2880 * usb_disable_remote_wakeup - disable remote wakeup for a device
2881 * @udev: target device
2883 * For USB-2 devices: Clear the device's remote wakeup feature.
2885 * For USB-3 devices: Assume there's only one function on the device and
2886 * disable remote wake for the first interface. FIXME if the interface
2887 * association descriptor shows there's more than one function.
2889 static int usb_disable_remote_wakeup(struct usb_device *udev)
2891 if (udev->speed < USB_SPEED_SUPER)
2892 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2893 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2894 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2895 USB_CTRL_SET_TIMEOUT);
2897 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2898 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2899 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2900 USB_CTRL_SET_TIMEOUT);
2903 /* Count of wakeup-enabled devices at or below udev */
2904 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2906 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2908 return udev->do_remote_wakeup +
2909 (hub ? hub->wakeup_enabled_descendants : 0);
2913 * usb_port_suspend - suspend a usb device's upstream port
2914 * @udev: device that's no longer in active use, not a root hub
2915 * Context: must be able to sleep; device not locked; pm locks held
2917 * Suspends a USB device that isn't in active use, conserving power.
2918 * Devices may wake out of a suspend, if anything important happens,
2919 * using the remote wakeup mechanism. They may also be taken out of
2920 * suspend by the host, using usb_port_resume(). It's also routine
2921 * to disconnect devices while they are suspended.
2923 * This only affects the USB hardware for a device; its interfaces
2924 * (and, for hubs, child devices) must already have been suspended.
2926 * Selective port suspend reduces power; most suspended devices draw
2927 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2928 * All devices below the suspended port are also suspended.
2930 * Devices leave suspend state when the host wakes them up. Some devices
2931 * also support "remote wakeup", where the device can activate the USB
2932 * tree above them to deliver data, such as a keypress or packet. In
2933 * some cases, this wakes the USB host.
2935 * Suspending OTG devices may trigger HNP, if that's been enabled
2936 * between a pair of dual-role devices. That will change roles, such
2937 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2939 * Devices on USB hub ports have only one "suspend" state, corresponding
2940 * to ACPI D2, "may cause the device to lose some context".
2941 * State transitions include:
2943 * - suspend, resume ... when the VBUS power link stays live
2944 * - suspend, disconnect ... VBUS lost
2946 * Once VBUS drop breaks the circuit, the port it's using has to go through
2947 * normal re-enumeration procedures, starting with enabling VBUS power.
2948 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2949 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2950 * timer, no SRP, no requests through sysfs.
2952 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2953 * suspended until their bus goes into global suspend (i.e., the root
2954 * hub is suspended). Nevertheless, we change @udev->state to
2955 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2956 * upstream port setting is stored in @udev->port_is_suspended.
2958 * Returns 0 on success, else negative errno.
2960 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2962 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2963 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2964 int port1 = udev->portnum;
2966 bool really_suspend = true;
2968 /* enable remote wakeup when appropriate; this lets the device
2969 * wake up the upstream hub (including maybe the root hub).
2971 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2972 * we don't explicitly enable it here.
2974 if (udev->do_remote_wakeup) {
2975 status = usb_enable_remote_wakeup(udev);
2977 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2979 /* bail if autosuspend is requested */
2980 if (PMSG_IS_AUTO(msg))
2985 /* disable USB2 hardware LPM */
2986 if (udev->usb2_hw_lpm_enabled == 1)
2987 usb_set_usb2_hardware_lpm(udev, 0);
2989 if (usb_disable_ltm(udev)) {
2990 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
2992 if (PMSG_IS_AUTO(msg))
2995 if (usb_unlocked_disable_lpm(udev)) {
2996 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
2998 if (PMSG_IS_AUTO(msg))
3003 if (hub_is_superspeed(hub->hdev))
3004 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3007 * For system suspend, we do not need to enable the suspend feature
3008 * on individual USB-2 ports. The devices will automatically go
3009 * into suspend a few ms after the root hub stops sending packets.
3010 * The USB 2.0 spec calls this "global suspend".
3012 * However, many USB hubs have a bug: They don't relay wakeup requests
3013 * from a downstream port if the port's suspend feature isn't on.
3014 * Therefore we will turn on the suspend feature if udev or any of its
3015 * descendants is enabled for remote wakeup.
3017 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3018 status = set_port_feature(hub->hdev, port1,
3019 USB_PORT_FEAT_SUSPEND);
3021 really_suspend = false;
3025 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3028 /* Try to enable USB3 LPM and LTM again */
3029 usb_unlocked_enable_lpm(udev);
3031 usb_enable_ltm(udev);
3033 /* Try to enable USB2 hardware LPM again */
3034 if (udev->usb2_hw_lpm_capable == 1)
3035 usb_set_usb2_hardware_lpm(udev, 1);
3037 if (udev->do_remote_wakeup)
3038 (void) usb_disable_remote_wakeup(udev);
3041 /* System sleep transitions should never fail */
3042 if (!PMSG_IS_AUTO(msg))
3045 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3046 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3047 udev->do_remote_wakeup);
3048 if (really_suspend) {
3049 udev->port_is_suspended = 1;
3051 /* device has up to 10 msec to fully suspend */
3054 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3057 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3058 pm_runtime_put_sync(&port_dev->dev);
3059 port_dev->did_runtime_put = true;
3062 usb_mark_last_busy(hub->hdev);
3067 * If the USB "suspend" state is in use (rather than "global suspend"),
3068 * many devices will be individually taken out of suspend state using
3069 * special "resume" signaling. This routine kicks in shortly after
3070 * hardware resume signaling is finished, either because of selective
3071 * resume (by host) or remote wakeup (by device) ... now see what changed
3072 * in the tree that's rooted at this device.
3074 * If @udev->reset_resume is set then the device is reset before the
3075 * status check is done.
3077 static int finish_port_resume(struct usb_device *udev)
3082 /* caller owns the udev device lock */
3083 dev_dbg(&udev->dev, "%s\n",
3084 udev->reset_resume ? "finish reset-resume" : "finish resume");
3086 /* usb ch9 identifies four variants of SUSPENDED, based on what
3087 * state the device resumes to. Linux currently won't see the
3088 * first two on the host side; they'd be inside hub_port_init()
3089 * during many timeouts, but khubd can't suspend until later.
3091 usb_set_device_state(udev, udev->actconfig
3092 ? USB_STATE_CONFIGURED
3093 : USB_STATE_ADDRESS);
3095 /* 10.5.4.5 says not to reset a suspended port if the attached
3096 * device is enabled for remote wakeup. Hence the reset
3097 * operation is carried out here, after the port has been
3100 if (udev->reset_resume)
3102 status = usb_reset_and_verify_device(udev);
3104 /* 10.5.4.5 says be sure devices in the tree are still there.
3105 * For now let's assume the device didn't go crazy on resume,
3106 * and device drivers will know about any resume quirks.
3110 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3112 /* If a normal resume failed, try doing a reset-resume */
3113 if (status && !udev->reset_resume && udev->persist_enabled) {
3114 dev_dbg(&udev->dev, "retry with reset-resume\n");
3115 udev->reset_resume = 1;
3116 goto retry_reset_resume;
3121 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3124 * There are a few quirky devices which violate the standard
3125 * by claiming to have remote wakeup enabled after a reset,
3126 * which crash if the feature is cleared, hence check for
3127 * udev->reset_resume
3129 } else if (udev->actconfig && !udev->reset_resume) {
3130 if (udev->speed < USB_SPEED_SUPER) {
3131 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3132 status = usb_disable_remote_wakeup(udev);
3134 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3136 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3137 | USB_INTRF_STAT_FUNC_RW))
3138 status = usb_disable_remote_wakeup(udev);
3143 "disable remote wakeup, status %d\n",
3151 * usb_port_resume - re-activate a suspended usb device's upstream port
3152 * @udev: device to re-activate, not a root hub
3153 * Context: must be able to sleep; device not locked; pm locks held
3155 * This will re-activate the suspended device, increasing power usage
3156 * while letting drivers communicate again with its endpoints.
3157 * USB resume explicitly guarantees that the power session between
3158 * the host and the device is the same as it was when the device
3161 * If @udev->reset_resume is set then this routine won't check that the
3162 * port is still enabled. Furthermore, finish_port_resume() above will
3163 * reset @udev. The end result is that a broken power session can be
3164 * recovered and @udev will appear to persist across a loss of VBUS power.
3166 * For example, if a host controller doesn't maintain VBUS suspend current
3167 * during a system sleep or is reset when the system wakes up, all the USB
3168 * power sessions below it will be broken. This is especially troublesome
3169 * for mass-storage devices containing mounted filesystems, since the
3170 * device will appear to have disconnected and all the memory mappings
3171 * to it will be lost. Using the USB_PERSIST facility, the device can be
3172 * made to appear as if it had not disconnected.
3174 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3175 * every effort to insure that the same device is present after the
3176 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3177 * quite possible for a device to remain unaltered but its media to be
3178 * changed. If the user replaces a flash memory card while the system is
3179 * asleep, he will have only himself to blame when the filesystem on the
3180 * new card is corrupted and the system crashes.
3182 * Returns 0 on success, else negative errno.
3184 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3186 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3187 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3188 int port1 = udev->portnum;
3190 u16 portchange, portstatus;
3192 if (port_dev->did_runtime_put) {
3193 status = pm_runtime_get_sync(&port_dev->dev);
3194 port_dev->did_runtime_put = false;
3196 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3202 /* Skip the initial Clear-Suspend step for a remote wakeup */
3203 status = hub_port_status(hub, port1, &portstatus, &portchange);
3204 if (status == 0 && !port_is_suspended(hub, portstatus))
3205 goto SuspendCleared;
3207 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3209 set_bit(port1, hub->busy_bits);
3211 /* see 7.1.7.7; affects power usage, but not budgeting */
3212 if (hub_is_superspeed(hub->hdev))
3213 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3215 status = usb_clear_port_feature(hub->hdev,
3216 port1, USB_PORT_FEAT_SUSPEND);
3218 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3221 /* drive resume for at least 20 msec */
3222 dev_dbg(&udev->dev, "usb %sresume\n",
3223 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3226 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3227 * stop resume signaling. Then finish the resume
3230 status = hub_port_status(hub, port1, &portstatus, &portchange);
3232 /* TRSMRCY = 10 msec */
3238 udev->port_is_suspended = 0;
3239 if (hub_is_superspeed(hub->hdev)) {
3240 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3241 usb_clear_port_feature(hub->hdev, port1,
3242 USB_PORT_FEAT_C_PORT_LINK_STATE);
3244 if (portchange & USB_PORT_STAT_C_SUSPEND)
3245 usb_clear_port_feature(hub->hdev, port1,
3246 USB_PORT_FEAT_C_SUSPEND);
3250 clear_bit(port1, hub->busy_bits);
3252 status = check_port_resume_type(udev,
3253 hub, port1, status, portchange, portstatus);
3255 status = finish_port_resume(udev);
3257 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3258 hub_port_logical_disconnect(hub, port1);
3260 /* Try to enable USB2 hardware LPM */
3261 if (udev->usb2_hw_lpm_capable == 1)
3262 usb_set_usb2_hardware_lpm(udev, 1);
3264 /* Try to enable USB3 LTM and LPM */
3265 usb_enable_ltm(udev);
3266 usb_unlocked_enable_lpm(udev);
3272 #ifdef CONFIG_PM_RUNTIME
3274 /* caller has locked udev */
3275 int usb_remote_wakeup(struct usb_device *udev)
3279 if (udev->state == USB_STATE_SUSPENDED) {
3280 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3281 status = usb_autoresume_device(udev);
3283 /* Let the drivers do their thing, then... */
3284 usb_autosuspend_device(udev);
3292 static int check_ports_changed(struct usb_hub *hub)
3296 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3297 u16 portstatus, portchange;
3300 status = hub_port_status(hub, port1, &portstatus, &portchange);
3301 if (!status && portchange)
3307 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3309 struct usb_hub *hub = usb_get_intfdata (intf);
3310 struct usb_device *hdev = hub->hdev;
3315 * Warn if children aren't already suspended.
3316 * Also, add up the number of wakeup-enabled descendants.
3318 hub->wakeup_enabled_descendants = 0;
3319 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3320 struct usb_device *udev;
3322 udev = hub->ports[port1 - 1]->child;
3323 if (udev && udev->can_submit) {
3324 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3325 if (PMSG_IS_AUTO(msg))
3329 hub->wakeup_enabled_descendants +=
3330 wakeup_enabled_descendants(udev);
3333 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3334 /* check if there are changes pending on hub ports */
3335 if (check_ports_changed(hub)) {
3336 if (PMSG_IS_AUTO(msg))
3338 pm_wakeup_event(&hdev->dev, 2000);
3342 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3343 /* Enable hub to send remote wakeup for all ports. */
3344 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3345 status = set_port_feature(hdev,
3347 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3348 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3349 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3350 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3354 dev_dbg(&intf->dev, "%s\n", __func__);
3356 /* stop khubd and related activity */
3357 hub_quiesce(hub, HUB_SUSPEND);
3361 static int hub_resume(struct usb_interface *intf)
3363 struct usb_hub *hub = usb_get_intfdata(intf);
3365 dev_dbg(&intf->dev, "%s\n", __func__);
3366 hub_activate(hub, HUB_RESUME);
3370 static int hub_reset_resume(struct usb_interface *intf)
3372 struct usb_hub *hub = usb_get_intfdata(intf);
3374 dev_dbg(&intf->dev, "%s\n", __func__);
3375 hub_activate(hub, HUB_RESET_RESUME);
3380 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3381 * @rhdev: struct usb_device for the root hub
3383 * The USB host controller driver calls this function when its root hub
3384 * is resumed and Vbus power has been interrupted or the controller
3385 * has been reset. The routine marks @rhdev as having lost power.
3386 * When the hub driver is resumed it will take notice and carry out
3387 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3388 * the others will be disconnected.
3390 void usb_root_hub_lost_power(struct usb_device *rhdev)
3392 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3393 rhdev->reset_resume = 1;
3395 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3397 static const char * const usb3_lpm_names[] = {
3405 * Send a Set SEL control transfer to the device, prior to enabling
3406 * device-initiated U1 or U2. This lets the device know the exit latencies from
3407 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3408 * packet from the host.
3410 * This function will fail if the SEL or PEL values for udev are greater than
3411 * the maximum allowed values for the link state to be enabled.
3413 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3415 struct usb_set_sel_req *sel_values;
3416 unsigned long long u1_sel;
3417 unsigned long long u1_pel;
3418 unsigned long long u2_sel;
3419 unsigned long long u2_pel;
3422 /* Convert SEL and PEL stored in ns to us */
3423 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3424 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3425 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3426 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3429 * Make sure that the calculated SEL and PEL values for the link
3430 * state we're enabling aren't bigger than the max SEL/PEL
3431 * value that will fit in the SET SEL control transfer.
3432 * Otherwise the device would get an incorrect idea of the exit
3433 * latency for the link state, and could start a device-initiated
3434 * U1/U2 when the exit latencies are too high.
3436 if ((state == USB3_LPM_U1 &&
3437 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3438 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3439 (state == USB3_LPM_U2 &&
3440 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3441 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3442 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3443 usb3_lpm_names[state], u1_sel, u1_pel);
3448 * If we're enabling device-initiated LPM for one link state,
3449 * but the other link state has a too high SEL or PEL value,
3450 * just set those values to the max in the Set SEL request.
3452 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3453 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3455 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3456 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3458 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3459 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3461 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3462 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3465 * usb_enable_lpm() can be called as part of a failed device reset,
3466 * which may be initiated by an error path of a mass storage driver.
3467 * Therefore, use GFP_NOIO.
3469 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3473 sel_values->u1_sel = u1_sel;
3474 sel_values->u1_pel = u1_pel;
3475 sel_values->u2_sel = cpu_to_le16(u2_sel);
3476 sel_values->u2_pel = cpu_to_le16(u2_pel);
3478 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3482 sel_values, sizeof *(sel_values),
3483 USB_CTRL_SET_TIMEOUT);
3489 * Enable or disable device-initiated U1 or U2 transitions.
3491 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3492 enum usb3_link_state state, bool enable)
3499 feature = USB_DEVICE_U1_ENABLE;
3502 feature = USB_DEVICE_U2_ENABLE;
3505 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3506 __func__, enable ? "enable" : "disable");
3510 if (udev->state != USB_STATE_CONFIGURED) {
3511 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3512 "for unconfigured device.\n",
3513 __func__, enable ? "enable" : "disable",
3514 usb3_lpm_names[state]);
3520 * Now send the control transfer to enable device-initiated LPM
3521 * for either U1 or U2.
3523 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3524 USB_REQ_SET_FEATURE,
3528 USB_CTRL_SET_TIMEOUT);
3530 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3531 USB_REQ_CLEAR_FEATURE,
3535 USB_CTRL_SET_TIMEOUT);
3538 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3539 enable ? "Enable" : "Disable",
3540 usb3_lpm_names[state]);
3546 static int usb_set_lpm_timeout(struct usb_device *udev,
3547 enum usb3_link_state state, int timeout)
3554 feature = USB_PORT_FEAT_U1_TIMEOUT;
3557 feature = USB_PORT_FEAT_U2_TIMEOUT;
3560 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3565 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3566 timeout != USB3_LPM_DEVICE_INITIATED) {
3567 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3568 "which is a reserved value.\n",
3569 usb3_lpm_names[state], timeout);
3573 ret = set_port_feature(udev->parent,
3574 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3577 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3578 "error code %i\n", usb3_lpm_names[state],
3582 if (state == USB3_LPM_U1)
3583 udev->u1_params.timeout = timeout;
3585 udev->u2_params.timeout = timeout;
3590 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3593 * We will attempt to enable U1 or U2, but there are no guarantees that the
3594 * control transfers to set the hub timeout or enable device-initiated U1/U2
3595 * will be successful.
3597 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3598 * driver know about it. If that call fails, it should be harmless, and just
3599 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3601 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3602 enum usb3_link_state state)
3605 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3606 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3608 /* If the device says it doesn't have *any* exit latency to come out of
3609 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3612 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3613 (state == USB3_LPM_U2 && u2_mel == 0))
3617 * First, let the device know about the exit latencies
3618 * associated with the link state we're about to enable.
3620 ret = usb_req_set_sel(udev, state);
3622 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3623 usb3_lpm_names[state]);
3627 /* We allow the host controller to set the U1/U2 timeout internally
3628 * first, so that it can change its schedule to account for the
3629 * additional latency to send data to a device in a lower power
3632 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3634 /* xHCI host controller doesn't want to enable this LPM state. */
3639 dev_warn(&udev->dev, "Could not enable %s link state, "
3640 "xHCI error %i.\n", usb3_lpm_names[state],
3645 if (usb_set_lpm_timeout(udev, state, timeout))
3646 /* If we can't set the parent hub U1/U2 timeout,
3647 * device-initiated LPM won't be allowed either, so let the xHCI
3648 * host know that this link state won't be enabled.
3650 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3652 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3653 else if (udev->actconfig)
3654 usb_set_device_initiated_lpm(udev, state, true);
3659 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3662 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3663 * If zero is returned, the parent will not allow the link to go into U1/U2.
3665 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3666 * it won't have an effect on the bus link state because the parent hub will
3667 * still disallow device-initiated U1/U2 entry.
3669 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3670 * possible. The result will be slightly more bus bandwidth will be taken up
3671 * (to account for U1/U2 exit latency), but it should be harmless.
3673 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3674 enum usb3_link_state state)
3680 feature = USB_PORT_FEAT_U1_TIMEOUT;
3683 feature = USB_PORT_FEAT_U2_TIMEOUT;
3686 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3691 if (usb_set_lpm_timeout(udev, state, 0))
3694 usb_set_device_initiated_lpm(udev, state, false);
3696 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3697 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3698 "bus schedule bandwidth may be impacted.\n",
3699 usb3_lpm_names[state]);
3704 * Disable hub-initiated and device-initiated U1 and U2 entry.
3705 * Caller must own the bandwidth_mutex.
3707 * This will call usb_enable_lpm() on failure, which will decrement
3708 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3710 int usb_disable_lpm(struct usb_device *udev)
3712 struct usb_hcd *hcd;
3714 if (!udev || !udev->parent ||
3715 udev->speed != USB_SPEED_SUPER ||
3719 hcd = bus_to_hcd(udev->bus);
3720 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3723 udev->lpm_disable_count++;
3724 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3727 /* If LPM is enabled, attempt to disable it. */
3728 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3730 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3736 usb_enable_lpm(udev);
3739 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3741 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3742 int usb_unlocked_disable_lpm(struct usb_device *udev)
3744 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3750 mutex_lock(hcd->bandwidth_mutex);
3751 ret = usb_disable_lpm(udev);
3752 mutex_unlock(hcd->bandwidth_mutex);
3756 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3759 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3760 * xHCI host policy may prevent U1 or U2 from being enabled.
3762 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3763 * until the lpm_disable_count drops to zero. Caller must own the
3766 void usb_enable_lpm(struct usb_device *udev)
3768 struct usb_hcd *hcd;
3770 if (!udev || !udev->parent ||
3771 udev->speed != USB_SPEED_SUPER ||
3775 udev->lpm_disable_count--;
3776 hcd = bus_to_hcd(udev->bus);
3777 /* Double check that we can both enable and disable LPM.
3778 * Device must be configured to accept set feature U1/U2 timeout.
3780 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3781 !hcd->driver->disable_usb3_lpm_timeout)
3784 if (udev->lpm_disable_count > 0)
3787 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3788 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3790 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3792 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3793 void usb_unlocked_enable_lpm(struct usb_device *udev)
3795 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3800 mutex_lock(hcd->bandwidth_mutex);
3801 usb_enable_lpm(udev);
3802 mutex_unlock(hcd->bandwidth_mutex);
3804 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3807 #else /* CONFIG_PM */
3809 #define hub_suspend NULL
3810 #define hub_resume NULL
3811 #define hub_reset_resume NULL
3813 int usb_disable_lpm(struct usb_device *udev)
3817 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3819 void usb_enable_lpm(struct usb_device *udev) { }
3820 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3822 int usb_unlocked_disable_lpm(struct usb_device *udev)
3826 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3828 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3829 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3831 int usb_disable_ltm(struct usb_device *udev)
3835 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3837 void usb_enable_ltm(struct usb_device *udev) { }
3838 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3840 #endif /* CONFIG_PM */
3843 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3845 * Between connect detection and reset signaling there must be a delay
3846 * of 100ms at least for debounce and power-settling. The corresponding
3847 * timer shall restart whenever the downstream port detects a disconnect.
3849 * Apparently there are some bluetooth and irda-dongles and a number of
3850 * low-speed devices for which this debounce period may last over a second.
3851 * Not covered by the spec - but easy to deal with.
3853 * This implementation uses a 1500ms total debounce timeout; if the
3854 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3855 * every 25ms for transient disconnects. When the port status has been
3856 * unchanged for 100ms it returns the port status.
3858 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3861 int total_time, stable_time = 0;
3862 u16 portchange, portstatus;
3863 unsigned connection = 0xffff;
3865 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3866 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3870 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3871 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3872 if (!must_be_connected ||
3873 (connection == USB_PORT_STAT_CONNECTION))
3874 stable_time += HUB_DEBOUNCE_STEP;
3875 if (stable_time >= HUB_DEBOUNCE_STABLE)
3879 connection = portstatus & USB_PORT_STAT_CONNECTION;
3882 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3883 usb_clear_port_feature(hub->hdev, port1,
3884 USB_PORT_FEAT_C_CONNECTION);
3887 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3889 msleep(HUB_DEBOUNCE_STEP);
3892 dev_dbg (hub->intfdev,
3893 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3894 port1, total_time, stable_time, portstatus);
3896 if (stable_time < HUB_DEBOUNCE_STABLE)
3901 void usb_ep0_reinit(struct usb_device *udev)
3903 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3904 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3905 usb_enable_endpoint(udev, &udev->ep0, true);
3907 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3909 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3910 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3912 static int hub_set_address(struct usb_device *udev, int devnum)
3915 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3918 * The host controller will choose the device address,
3919 * instead of the core having chosen it earlier
3921 if (!hcd->driver->address_device && devnum <= 1)
3923 if (udev->state == USB_STATE_ADDRESS)
3925 if (udev->state != USB_STATE_DEFAULT)
3927 if (hcd->driver->address_device)
3928 retval = hcd->driver->address_device(hcd, udev);
3930 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3931 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3932 NULL, 0, USB_CTRL_SET_TIMEOUT);
3934 update_devnum(udev, devnum);
3935 /* Device now using proper address. */
3936 usb_set_device_state(udev, USB_STATE_ADDRESS);
3937 usb_ep0_reinit(udev);
3942 /* Reset device, (re)assign address, get device descriptor.
3943 * Device connection must be stable, no more debouncing needed.
3944 * Returns device in USB_STATE_ADDRESS, except on error.
3946 * If this is called for an already-existing device (as part of
3947 * usb_reset_and_verify_device), the caller must own the device lock. For a
3948 * newly detected device that is not accessible through any global
3949 * pointers, it's not necessary to lock the device.
3952 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3955 static DEFINE_MUTEX(usb_address0_mutex);
3957 struct usb_device *hdev = hub->hdev;
3958 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3960 unsigned delay = HUB_SHORT_RESET_TIME;
3961 enum usb_device_speed oldspeed = udev->speed;
3963 int devnum = udev->devnum;
3965 /* root hub ports have a slightly longer reset period
3966 * (from USB 2.0 spec, section 7.1.7.5)
3968 if (!hdev->parent) {
3969 delay = HUB_ROOT_RESET_TIME;
3970 if (port1 == hdev->bus->otg_port)
3971 hdev->bus->b_hnp_enable = 0;
3974 /* Some low speed devices have problems with the quick delay, so */
3975 /* be a bit pessimistic with those devices. RHbug #23670 */
3976 if (oldspeed == USB_SPEED_LOW)
3977 delay = HUB_LONG_RESET_TIME;
3979 mutex_lock(&usb_address0_mutex);
3981 /* Reset the device; full speed may morph to high speed */
3982 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3983 retval = hub_port_reset(hub, port1, udev, delay, false);
3984 if (retval < 0) /* error or disconnect */
3986 /* success, speed is known */
3990 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3991 dev_dbg(&udev->dev, "device reset changed speed!\n");
3994 oldspeed = udev->speed;
3996 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3997 * it's fixed size except for full speed devices.
3998 * For Wireless USB devices, ep0 max packet is always 512 (tho
3999 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4001 switch (udev->speed) {
4002 case USB_SPEED_SUPER:
4003 case USB_SPEED_WIRELESS: /* fixed at 512 */
4004 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4006 case USB_SPEED_HIGH: /* fixed at 64 */
4007 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4009 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4010 /* to determine the ep0 maxpacket size, try to read
4011 * the device descriptor to get bMaxPacketSize0 and
4012 * then correct our initial guess.
4014 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4016 case USB_SPEED_LOW: /* fixed at 8 */
4017 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4023 if (udev->speed == USB_SPEED_WIRELESS)
4024 speed = "variable speed Wireless";
4026 speed = usb_speed_string(udev->speed);
4028 if (udev->speed != USB_SPEED_SUPER)
4029 dev_info(&udev->dev,
4030 "%s %s USB device number %d using %s\n",
4031 (udev->config) ? "reset" : "new", speed,
4032 devnum, udev->bus->controller->driver->name);
4034 /* Set up TT records, if needed */
4036 udev->tt = hdev->tt;
4037 udev->ttport = hdev->ttport;
4038 } else if (udev->speed != USB_SPEED_HIGH
4039 && hdev->speed == USB_SPEED_HIGH) {
4041 dev_err(&udev->dev, "parent hub has no TT\n");
4045 udev->tt = &hub->tt;
4046 udev->ttport = port1;
4049 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4050 * Because device hardware and firmware is sometimes buggy in
4051 * this area, and this is how Linux has done it for ages.
4052 * Change it cautiously.
4054 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4055 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4056 * so it may help with some non-standards-compliant devices.
4057 * Otherwise we start with SET_ADDRESS and then try to read the
4058 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4061 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4062 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
4063 struct usb_device_descriptor *buf;
4066 #define GET_DESCRIPTOR_BUFSIZE 64
4067 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4073 /* Retry on all errors; some devices are flakey.
4074 * 255 is for WUSB devices, we actually need to use
4075 * 512 (WUSB1.0[4.8.1]).
4077 for (j = 0; j < 3; ++j) {
4078 buf->bMaxPacketSize0 = 0;
4079 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4080 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4081 USB_DT_DEVICE << 8, 0,
4082 buf, GET_DESCRIPTOR_BUFSIZE,
4083 initial_descriptor_timeout);
4084 switch (buf->bMaxPacketSize0) {
4085 case 8: case 16: case 32: case 64: case 255:
4086 if (buf->bDescriptorType ==
4100 udev->descriptor.bMaxPacketSize0 =
4101 buf->bMaxPacketSize0;
4104 retval = hub_port_reset(hub, port1, udev, delay, false);
4105 if (retval < 0) /* error or disconnect */
4107 if (oldspeed != udev->speed) {
4109 "device reset changed speed!\n");
4115 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4120 #undef GET_DESCRIPTOR_BUFSIZE
4124 * If device is WUSB, we already assigned an
4125 * unauthorized address in the Connect Ack sequence;
4126 * authorization will assign the final address.
4128 if (udev->wusb == 0) {
4129 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4130 retval = hub_set_address(udev, devnum);
4136 if (retval != -ENODEV)
4137 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4141 if (udev->speed == USB_SPEED_SUPER) {
4142 devnum = udev->devnum;
4143 dev_info(&udev->dev,
4144 "%s SuperSpeed USB device number %d using %s\n",
4145 (udev->config) ? "reset" : "new",
4146 devnum, udev->bus->controller->driver->name);
4149 /* cope with hardware quirkiness:
4150 * - let SET_ADDRESS settle, some device hardware wants it
4151 * - read ep0 maxpacket even for high and low speed,
4154 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4158 retval = usb_get_device_descriptor(udev, 8);
4160 if (retval != -ENODEV)
4162 "device descriptor read/8, error %d\n",
4174 if (hcd->phy && !hdev->parent)
4175 usb_phy_notify_connect(hcd->phy, udev->speed);
4178 * Some superspeed devices have finished the link training process
4179 * and attached to a superspeed hub port, but the device descriptor
4180 * got from those devices show they aren't superspeed devices. Warm
4181 * reset the port attached by the devices can fix them.
4183 if ((udev->speed == USB_SPEED_SUPER) &&
4184 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4185 dev_err(&udev->dev, "got a wrong device descriptor, "
4186 "warm reset device\n");
4187 hub_port_reset(hub, port1, udev,
4188 HUB_BH_RESET_TIME, true);
4193 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4194 udev->speed == USB_SPEED_SUPER)
4197 i = udev->descriptor.bMaxPacketSize0;
4198 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4199 if (udev->speed == USB_SPEED_LOW ||
4200 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4201 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4205 if (udev->speed == USB_SPEED_FULL)
4206 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4208 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4209 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4210 usb_ep0_reinit(udev);
4213 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4214 if (retval < (signed)sizeof(udev->descriptor)) {
4215 if (retval != -ENODEV)
4216 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4223 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4224 retval = usb_get_bos_descriptor(udev);
4226 udev->lpm_capable = usb_device_supports_lpm(udev);
4227 usb_set_lpm_parameters(udev);
4232 /* notify HCD that we have a device connected and addressed */
4233 if (hcd->driver->update_device)
4234 hcd->driver->update_device(hcd, udev);
4237 hub_port_disable(hub, port1, 0);
4238 update_devnum(udev, devnum); /* for disconnect processing */
4240 mutex_unlock(&usb_address0_mutex);
4245 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4247 struct usb_qualifier_descriptor *qual;
4250 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4254 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4255 qual, sizeof *qual);
4256 if (status == sizeof *qual) {
4257 dev_info(&udev->dev, "not running at top speed; "
4258 "connect to a high speed hub\n");
4259 /* hub LEDs are probably harder to miss than syslog */
4260 if (hub->has_indicators) {
4261 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4262 schedule_delayed_work (&hub->leds, 0);
4269 hub_power_remaining (struct usb_hub *hub)
4271 struct usb_device *hdev = hub->hdev;
4275 if (!hub->limited_power)
4278 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4279 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4280 struct usb_device *udev = hub->ports[port1 - 1]->child;
4286 if (hub_is_superspeed(udev))
4292 * Unconfigured devices may not use more than one unit load,
4293 * or 8mA for OTG ports
4295 if (udev->actconfig)
4296 delta = usb_get_max_power(udev, udev->actconfig);
4297 else if (port1 != udev->bus->otg_port || hdev->parent)
4301 if (delta > hub->mA_per_port)
4302 dev_warn(&udev->dev,
4303 "%dmA is over %umA budget for port %d!\n",
4304 delta, hub->mA_per_port, port1);
4307 if (remaining < 0) {
4308 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4315 /* Handle physical or logical connection change events.
4316 * This routine is called when:
4317 * a port connection-change occurs;
4318 * a port enable-change occurs (often caused by EMI);
4319 * usb_reset_and_verify_device() encounters changed descriptors (as from
4320 * a firmware download)
4321 * caller already locked the hub
4323 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4324 u16 portstatus, u16 portchange)
4326 struct usb_device *hdev = hub->hdev;
4327 struct device *hub_dev = hub->intfdev;
4328 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4329 unsigned wHubCharacteristics =
4330 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4331 struct usb_device *udev;
4336 "port %d, status %04x, change %04x, %s\n",
4337 port1, portstatus, portchange, portspeed(hub, portstatus));
4339 if (hub->has_indicators) {
4340 set_port_led(hub, port1, HUB_LED_AUTO);
4341 hub->indicator[port1-1] = INDICATOR_AUTO;
4344 #ifdef CONFIG_USB_OTG
4345 /* during HNP, don't repeat the debounce */
4346 if (hdev->bus->is_b_host)
4347 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4348 USB_PORT_STAT_C_ENABLE);
4351 /* Try to resuscitate an existing device */
4352 udev = hub->ports[port1 - 1]->child;
4353 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4354 udev->state != USB_STATE_NOTATTACHED) {
4355 usb_lock_device(udev);
4356 if (portstatus & USB_PORT_STAT_ENABLE) {
4357 status = 0; /* Nothing to do */
4359 #ifdef CONFIG_PM_RUNTIME
4360 } else if (udev->state == USB_STATE_SUSPENDED &&
4361 udev->persist_enabled) {
4362 /* For a suspended device, treat this as a
4363 * remote wakeup event.
4365 status = usb_remote_wakeup(udev);
4369 status = -ENODEV; /* Don't resuscitate */
4371 usb_unlock_device(udev);
4374 clear_bit(port1, hub->change_bits);
4379 /* Disconnect any existing devices under this port */
4381 if (hcd->phy && !hdev->parent &&
4382 !(portstatus & USB_PORT_STAT_CONNECTION))
4383 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4384 usb_disconnect(&hub->ports[port1 - 1]->child);
4386 clear_bit(port1, hub->change_bits);
4388 /* We can forget about a "removed" device when there's a physical
4389 * disconnect or the connect status changes.
4391 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4392 (portchange & USB_PORT_STAT_C_CONNECTION))
4393 clear_bit(port1, hub->removed_bits);
4395 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4396 USB_PORT_STAT_C_ENABLE)) {
4397 status = hub_port_debounce_be_stable(hub, port1);
4399 if (status != -ENODEV && printk_ratelimit())
4400 dev_err(hub_dev, "connect-debounce failed, "
4401 "port %d disabled\n", port1);
4402 portstatus &= ~USB_PORT_STAT_CONNECTION;
4404 portstatus = status;
4408 /* Return now if debouncing failed or nothing is connected or
4409 * the device was "removed".
4411 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4412 test_bit(port1, hub->removed_bits)) {
4414 /* maybe switch power back on (e.g. root hub was reset) */
4415 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4416 && !port_is_power_on(hub, portstatus))
4417 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4419 if (portstatus & USB_PORT_STAT_ENABLE)
4423 if (hub_is_superspeed(hub->hdev))
4429 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4431 /* reallocate for each attempt, since references
4432 * to the previous one can escape in various ways
4434 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4437 "couldn't allocate port %d usb_device\n",
4442 usb_set_device_state(udev, USB_STATE_POWERED);
4443 udev->bus_mA = hub->mA_per_port;
4444 udev->level = hdev->level + 1;
4445 udev->wusb = hub_is_wusb(hub);
4447 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4448 if (hub_is_superspeed(hub->hdev))
4449 udev->speed = USB_SPEED_SUPER;
4451 udev->speed = USB_SPEED_UNKNOWN;
4453 choose_devnum(udev);
4454 if (udev->devnum <= 0) {
4455 status = -ENOTCONN; /* Don't retry */
4459 /* reset (non-USB 3.0 devices) and get descriptor */
4460 status = hub_port_init(hub, udev, port1, i);
4464 usb_detect_quirks(udev);
4465 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4468 /* consecutive bus-powered hubs aren't reliable; they can
4469 * violate the voltage drop budget. if the new child has
4470 * a "powered" LED, users should notice we didn't enable it
4471 * (without reading syslog), even without per-port LEDs
4474 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4475 && udev->bus_mA <= unit_load) {
4478 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4481 dev_dbg(&udev->dev, "get status %d ?\n", status);
4484 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4486 "can't connect bus-powered hub "
4488 if (hub->has_indicators) {
4489 hub->indicator[port1-1] =
4490 INDICATOR_AMBER_BLINK;
4491 schedule_delayed_work (&hub->leds, 0);
4493 status = -ENOTCONN; /* Don't retry */
4498 /* check for devices running slower than they could */
4499 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4500 && udev->speed == USB_SPEED_FULL
4501 && highspeed_hubs != 0)
4502 check_highspeed (hub, udev, port1);
4504 /* Store the parent's children[] pointer. At this point
4505 * udev becomes globally accessible, although presumably
4506 * no one will look at it until hdev is unlocked.
4510 /* We mustn't add new devices if the parent hub has
4511 * been disconnected; we would race with the
4512 * recursively_mark_NOTATTACHED() routine.
4514 spin_lock_irq(&device_state_lock);
4515 if (hdev->state == USB_STATE_NOTATTACHED)
4518 hub->ports[port1 - 1]->child = udev;
4519 spin_unlock_irq(&device_state_lock);
4521 /* Run it through the hoops (find a driver, etc) */
4523 status = usb_new_device(udev);
4525 spin_lock_irq(&device_state_lock);
4526 hub->ports[port1 - 1]->child = NULL;
4527 spin_unlock_irq(&device_state_lock);
4534 status = hub_power_remaining(hub);
4536 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4541 hub_port_disable(hub, port1, 1);
4543 usb_ep0_reinit(udev);
4544 release_devnum(udev);
4547 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4550 if (hub->hdev->parent ||
4551 !hcd->driver->port_handed_over ||
4552 !(hcd->driver->port_handed_over)(hcd, port1)) {
4553 if (status != -ENOTCONN && status != -ENODEV)
4554 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4559 hub_port_disable(hub, port1, 1);
4560 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4561 hcd->driver->relinquish_port(hcd, port1);
4564 /* Returns 1 if there was a remote wakeup and a connect status change. */
4565 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4566 u16 portstatus, u16 portchange)
4568 struct usb_device *hdev;
4569 struct usb_device *udev;
4570 int connect_change = 0;
4574 udev = hub->ports[port - 1]->child;
4575 if (!hub_is_superspeed(hdev)) {
4576 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4578 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4580 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4581 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4587 /* TRSMRCY = 10 msec */
4590 usb_lock_device(udev);
4591 ret = usb_remote_wakeup(udev);
4592 usb_unlock_device(udev);
4597 hub_port_disable(hub, port, 1);
4599 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4601 return connect_change;
4604 static void hub_events(void)
4606 struct list_head *tmp;
4607 struct usb_device *hdev;
4608 struct usb_interface *intf;
4609 struct usb_hub *hub;
4610 struct device *hub_dev;
4616 int connect_change, wakeup_change;
4619 * We restart the list every time to avoid a deadlock with
4620 * deleting hubs downstream from this one. This should be
4621 * safe since we delete the hub from the event list.
4622 * Not the most efficient, but avoids deadlocks.
4626 /* Grab the first entry at the beginning of the list */
4627 spin_lock_irq(&hub_event_lock);
4628 if (list_empty(&hub_event_list)) {
4629 spin_unlock_irq(&hub_event_lock);
4633 tmp = hub_event_list.next;
4636 hub = list_entry(tmp, struct usb_hub, event_list);
4637 kref_get(&hub->kref);
4638 spin_unlock_irq(&hub_event_lock);
4641 hub_dev = hub->intfdev;
4642 intf = to_usb_interface(hub_dev);
4643 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4644 hdev->state, hub->descriptor
4645 ? hub->descriptor->bNbrPorts
4647 /* NOTE: expects max 15 ports... */
4648 (u16) hub->change_bits[0],
4649 (u16) hub->event_bits[0]);
4651 /* Lock the device, then check to see if we were
4652 * disconnected while waiting for the lock to succeed. */
4653 usb_lock_device(hdev);
4654 if (unlikely(hub->disconnected))
4655 goto loop_disconnected;
4657 /* If the hub has died, clean up after it */
4658 if (hdev->state == USB_STATE_NOTATTACHED) {
4659 hub->error = -ENODEV;
4660 hub_quiesce(hub, HUB_DISCONNECT);
4665 ret = usb_autopm_get_interface(intf);
4667 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4671 /* If this is an inactive hub, do nothing */
4676 dev_dbg (hub_dev, "resetting for error %d\n",
4679 ret = usb_reset_device(hdev);
4682 "error resetting hub: %d\n", ret);
4690 /* deal with port status changes */
4691 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4692 if (test_bit(i, hub->busy_bits))
4694 connect_change = test_bit(i, hub->change_bits);
4695 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4696 if (!test_and_clear_bit(i, hub->event_bits) &&
4697 !connect_change && !wakeup_change)
4700 ret = hub_port_status(hub, i,
4701 &portstatus, &portchange);
4705 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4706 usb_clear_port_feature(hdev, i,
4707 USB_PORT_FEAT_C_CONNECTION);
4711 if (portchange & USB_PORT_STAT_C_ENABLE) {
4712 if (!connect_change)
4714 "port %d enable change, "
4717 usb_clear_port_feature(hdev, i,
4718 USB_PORT_FEAT_C_ENABLE);
4721 * EM interference sometimes causes badly
4722 * shielded USB devices to be shutdown by
4723 * the hub, this hack enables them again.
4724 * Works at least with mouse driver.
4726 if (!(portstatus & USB_PORT_STAT_ENABLE)
4728 && hub->ports[i - 1]->child) {
4731 "disabled by hub (EMI?), "
4738 if (hub_handle_remote_wakeup(hub, i,
4739 portstatus, portchange))
4742 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4746 dev_dbg(hub_dev, "over-current change on port "
4748 usb_clear_port_feature(hdev, i,
4749 USB_PORT_FEAT_C_OVER_CURRENT);
4750 msleep(100); /* Cool down */
4751 hub_power_on(hub, true);
4752 hub_port_status(hub, i, &status, &unused);
4753 if (status & USB_PORT_STAT_OVERCURRENT)
4754 dev_err(hub_dev, "over-current "
4755 "condition on port %d\n", i);
4758 if (portchange & USB_PORT_STAT_C_RESET) {
4760 "reset change on port %d\n",
4762 usb_clear_port_feature(hdev, i,
4763 USB_PORT_FEAT_C_RESET);
4765 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4766 hub_is_superspeed(hub->hdev)) {
4768 "warm reset change on port %d\n",
4770 usb_clear_port_feature(hdev, i,
4771 USB_PORT_FEAT_C_BH_PORT_RESET);
4773 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4774 usb_clear_port_feature(hub->hdev, i,
4775 USB_PORT_FEAT_C_PORT_LINK_STATE);
4777 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4779 "config error on port %d\n",
4781 usb_clear_port_feature(hub->hdev, i,
4782 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4785 /* Warm reset a USB3 protocol port if it's in
4786 * SS.Inactive state.
4788 if (hub_port_warm_reset_required(hub, portstatus)) {
4790 struct usb_device *udev =
4791 hub->ports[i - 1]->child;
4793 dev_dbg(hub_dev, "warm reset port %d\n", i);
4794 if (!udev || !(portstatus &
4795 USB_PORT_STAT_CONNECTION)) {
4796 status = hub_port_reset(hub, i,
4797 NULL, HUB_BH_RESET_TIME,
4800 hub_port_disable(hub, i, 1);
4802 usb_lock_device(udev);
4803 status = usb_reset_device(udev);
4804 usb_unlock_device(udev);
4810 hub_port_connect_change(hub, i,
4811 portstatus, portchange);
4814 /* deal with hub status changes */
4815 if (test_and_clear_bit(0, hub->event_bits) == 0)
4817 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4818 dev_err (hub_dev, "get_hub_status failed\n");
4820 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4821 dev_dbg (hub_dev, "power change\n");
4822 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4823 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4824 /* FIXME: Is this always true? */
4825 hub->limited_power = 1;
4827 hub->limited_power = 0;
4829 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4833 dev_dbg(hub_dev, "over-current change\n");
4834 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4835 msleep(500); /* Cool down */
4836 hub_power_on(hub, true);
4837 hub_hub_status(hub, &status, &unused);
4838 if (status & HUB_STATUS_OVERCURRENT)
4839 dev_err(hub_dev, "over-current "
4845 /* Balance the usb_autopm_get_interface() above */
4846 usb_autopm_put_interface_no_suspend(intf);
4848 /* Balance the usb_autopm_get_interface_no_resume() in
4849 * kick_khubd() and allow autosuspend.
4851 usb_autopm_put_interface(intf);
4853 usb_unlock_device(hdev);
4854 kref_put(&hub->kref, hub_release);
4856 } /* end while (1) */
4859 static int hub_thread(void *__unused)
4861 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4862 * port handover. Otherwise it might see that a full-speed device
4863 * was gone before the EHCI controller had handed its port over to
4864 * the companion full-speed controller.
4870 wait_event_freezable(khubd_wait,
4871 !list_empty(&hub_event_list) ||
4872 kthread_should_stop());
4873 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4875 pr_debug("%s: khubd exiting\n", usbcore_name);
4879 static const struct usb_device_id hub_id_table[] = {
4880 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4881 | USB_DEVICE_ID_MATCH_INT_CLASS,
4882 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4883 .bInterfaceClass = USB_CLASS_HUB,
4884 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4885 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4886 .bDeviceClass = USB_CLASS_HUB},
4887 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4888 .bInterfaceClass = USB_CLASS_HUB},
4889 { } /* Terminating entry */
4892 MODULE_DEVICE_TABLE (usb, hub_id_table);
4894 static struct usb_driver hub_driver = {
4897 .disconnect = hub_disconnect,
4898 .suspend = hub_suspend,
4899 .resume = hub_resume,
4900 .reset_resume = hub_reset_resume,
4901 .pre_reset = hub_pre_reset,
4902 .post_reset = hub_post_reset,
4903 .unlocked_ioctl = hub_ioctl,
4904 .id_table = hub_id_table,
4905 .supports_autosuspend = 1,
4908 int usb_hub_init(void)
4910 if (usb_register(&hub_driver) < 0) {
4911 printk(KERN_ERR "%s: can't register hub driver\n",
4916 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4917 if (!IS_ERR(khubd_task))
4920 /* Fall through if kernel_thread failed */
4921 usb_deregister(&hub_driver);
4922 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4927 void usb_hub_cleanup(void)
4929 kthread_stop(khubd_task);
4932 * Hub resources are freed for us by usb_deregister. It calls
4933 * usb_driver_purge on every device which in turn calls that
4934 * devices disconnect function if it is using this driver.
4935 * The hub_disconnect function takes care of releasing the
4936 * individual hub resources. -greg
4938 usb_deregister(&hub_driver);
4939 } /* usb_hub_cleanup() */
4941 static int descriptors_changed(struct usb_device *udev,
4942 struct usb_device_descriptor *old_device_descriptor)
4946 unsigned serial_len = 0;
4948 unsigned old_length;
4952 if (memcmp(&udev->descriptor, old_device_descriptor,
4953 sizeof(*old_device_descriptor)) != 0)
4956 /* Since the idVendor, idProduct, and bcdDevice values in the
4957 * device descriptor haven't changed, we will assume the
4958 * Manufacturer and Product strings haven't changed either.
4959 * But the SerialNumber string could be different (e.g., a
4960 * different flash card of the same brand).
4963 serial_len = strlen(udev->serial) + 1;
4966 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4967 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4968 len = max(len, old_length);
4971 buf = kmalloc(len, GFP_NOIO);
4973 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4974 /* assume the worst */
4977 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4978 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4979 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4981 if (length != old_length) {
4982 dev_dbg(&udev->dev, "config index %d, error %d\n",
4987 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4989 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4991 ((struct usb_config_descriptor *) buf)->
4992 bConfigurationValue);
4998 if (!changed && serial_len) {
4999 length = usb_string(udev, udev->descriptor.iSerialNumber,
5001 if (length + 1 != serial_len) {
5002 dev_dbg(&udev->dev, "serial string error %d\n",
5005 } else if (memcmp(buf, udev->serial, length) != 0) {
5006 dev_dbg(&udev->dev, "serial string changed\n");
5016 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5017 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5019 * WARNING - don't use this routine to reset a composite device
5020 * (one with multiple interfaces owned by separate drivers)!
5021 * Use usb_reset_device() instead.
5023 * Do a port reset, reassign the device's address, and establish its
5024 * former operating configuration. If the reset fails, or the device's
5025 * descriptors change from their values before the reset, or the original
5026 * configuration and altsettings cannot be restored, a flag will be set
5027 * telling khubd to pretend the device has been disconnected and then
5028 * re-connected. All drivers will be unbound, and the device will be
5029 * re-enumerated and probed all over again.
5031 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5032 * flagged for logical disconnection, or some other negative error code
5033 * if the reset wasn't even attempted.
5036 * The caller must own the device lock. For example, it's safe to use
5037 * this from a driver probe() routine after downloading new firmware.
5038 * For calls that might not occur during probe(), drivers should lock
5039 * the device using usb_lock_device_for_reset().
5041 * Locking exception: This routine may also be called from within an
5042 * autoresume handler. Such usage won't conflict with other tasks
5043 * holding the device lock because these tasks should always call
5044 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5046 static int usb_reset_and_verify_device(struct usb_device *udev)
5048 struct usb_device *parent_hdev = udev->parent;
5049 struct usb_hub *parent_hub;
5050 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5051 struct usb_device_descriptor descriptor = udev->descriptor;
5053 int port1 = udev->portnum;
5055 if (udev->state == USB_STATE_NOTATTACHED ||
5056 udev->state == USB_STATE_SUSPENDED) {
5057 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5063 /* this requires hcd-specific logic; see ohci_restart() */
5064 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5067 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5069 /* Disable LPM and LTM while we reset the device and reinstall the alt
5070 * settings. Device-initiated LPM settings, and system exit latency
5071 * settings are cleared when the device is reset, so we have to set
5074 ret = usb_unlocked_disable_lpm(udev);
5076 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5079 ret = usb_disable_ltm(udev);
5081 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5086 set_bit(port1, parent_hub->busy_bits);
5087 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5089 /* ep0 maxpacket size may change; let the HCD know about it.
5090 * Other endpoints will be handled by re-enumeration. */
5091 usb_ep0_reinit(udev);
5092 ret = hub_port_init(parent_hub, udev, port1, i);
5093 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5096 clear_bit(port1, parent_hub->busy_bits);
5101 /* Device might have changed firmware (DFU or similar) */
5102 if (descriptors_changed(udev, &descriptor)) {
5103 dev_info(&udev->dev, "device firmware changed\n");
5104 udev->descriptor = descriptor; /* for disconnect() calls */
5108 /* Restore the device's previous configuration */
5109 if (!udev->actconfig)
5112 mutex_lock(hcd->bandwidth_mutex);
5113 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5115 dev_warn(&udev->dev,
5116 "Busted HC? Not enough HCD resources for "
5117 "old configuration.\n");
5118 mutex_unlock(hcd->bandwidth_mutex);
5121 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5122 USB_REQ_SET_CONFIGURATION, 0,
5123 udev->actconfig->desc.bConfigurationValue, 0,
5124 NULL, 0, USB_CTRL_SET_TIMEOUT);
5127 "can't restore configuration #%d (error=%d)\n",
5128 udev->actconfig->desc.bConfigurationValue, ret);
5129 mutex_unlock(hcd->bandwidth_mutex);
5132 mutex_unlock(hcd->bandwidth_mutex);
5133 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5135 /* Put interfaces back into the same altsettings as before.
5136 * Don't bother to send the Set-Interface request for interfaces
5137 * that were already in altsetting 0; besides being unnecessary,
5138 * many devices can't handle it. Instead just reset the host-side
5141 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5142 struct usb_host_config *config = udev->actconfig;
5143 struct usb_interface *intf = config->interface[i];
5144 struct usb_interface_descriptor *desc;
5146 desc = &intf->cur_altsetting->desc;
5147 if (desc->bAlternateSetting == 0) {
5148 usb_disable_interface(udev, intf, true);
5149 usb_enable_interface(udev, intf, true);
5152 /* Let the bandwidth allocation function know that this
5153 * device has been reset, and it will have to use
5154 * alternate setting 0 as the current alternate setting.
5156 intf->resetting_device = 1;
5157 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5158 desc->bAlternateSetting);
5159 intf->resetting_device = 0;
5162 dev_err(&udev->dev, "failed to restore interface %d "
5163 "altsetting %d (error=%d)\n",
5164 desc->bInterfaceNumber,
5165 desc->bAlternateSetting,
5172 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5173 usb_unlocked_enable_lpm(udev);
5174 usb_enable_ltm(udev);
5178 /* LPM state doesn't matter when we're about to destroy the device. */
5179 hub_port_logical_disconnect(parent_hub, port1);
5184 * usb_reset_device - warn interface drivers and perform a USB port reset
5185 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5187 * Warns all drivers bound to registered interfaces (using their pre_reset
5188 * method), performs the port reset, and then lets the drivers know that
5189 * the reset is over (using their post_reset method).
5191 * Return: The same as for usb_reset_and_verify_device().
5194 * The caller must own the device lock. For example, it's safe to use
5195 * this from a driver probe() routine after downloading new firmware.
5196 * For calls that might not occur during probe(), drivers should lock
5197 * the device using usb_lock_device_for_reset().
5199 * If an interface is currently being probed or disconnected, we assume
5200 * its driver knows how to handle resets. For all other interfaces,
5201 * if the driver doesn't have pre_reset and post_reset methods then
5202 * we attempt to unbind it and rebind afterward.
5204 int usb_reset_device(struct usb_device *udev)
5208 unsigned int noio_flag;
5209 struct usb_host_config *config = udev->actconfig;
5211 if (udev->state == USB_STATE_NOTATTACHED ||
5212 udev->state == USB_STATE_SUSPENDED) {
5213 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5219 * Don't allocate memory with GFP_KERNEL in current
5220 * context to avoid possible deadlock if usb mass
5221 * storage interface or usbnet interface(iSCSI case)
5222 * is included in current configuration. The easist
5223 * approach is to do it for every device reset,
5224 * because the device 'memalloc_noio' flag may have
5225 * not been set before reseting the usb device.
5227 noio_flag = memalloc_noio_save();
5229 /* Prevent autosuspend during the reset */
5230 usb_autoresume_device(udev);
5233 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5234 struct usb_interface *cintf = config->interface[i];
5235 struct usb_driver *drv;
5238 if (cintf->dev.driver) {
5239 drv = to_usb_driver(cintf->dev.driver);
5240 if (drv->pre_reset && drv->post_reset)
5241 unbind = (drv->pre_reset)(cintf);
5242 else if (cintf->condition ==
5243 USB_INTERFACE_BOUND)
5246 usb_forced_unbind_intf(cintf);
5251 ret = usb_reset_and_verify_device(udev);
5254 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5255 struct usb_interface *cintf = config->interface[i];
5256 struct usb_driver *drv;
5257 int rebind = cintf->needs_binding;
5259 if (!rebind && cintf->dev.driver) {
5260 drv = to_usb_driver(cintf->dev.driver);
5261 if (drv->post_reset)
5262 rebind = (drv->post_reset)(cintf);
5263 else if (cintf->condition ==
5264 USB_INTERFACE_BOUND)
5267 if (ret == 0 && rebind)
5268 usb_rebind_intf(cintf);
5272 usb_autosuspend_device(udev);
5273 memalloc_noio_restore(noio_flag);
5276 EXPORT_SYMBOL_GPL(usb_reset_device);
5280 * usb_queue_reset_device - Reset a USB device from an atomic context
5281 * @iface: USB interface belonging to the device to reset
5283 * This function can be used to reset a USB device from an atomic
5284 * context, where usb_reset_device() won't work (as it blocks).
5286 * Doing a reset via this method is functionally equivalent to calling
5287 * usb_reset_device(), except for the fact that it is delayed to a
5288 * workqueue. This means that any drivers bound to other interfaces
5289 * might be unbound, as well as users from usbfs in user space.
5293 * - Scheduling two resets at the same time from two different drivers
5294 * attached to two different interfaces of the same device is
5295 * possible; depending on how the driver attached to each interface
5296 * handles ->pre_reset(), the second reset might happen or not.
5298 * - If a driver is unbound and it had a pending reset, the reset will
5301 * - This function can be called during .probe() or .disconnect()
5302 * times. On return from .disconnect(), any pending resets will be
5305 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5308 * NOTE: We don't do any reference count tracking because it is not
5309 * needed. The lifecycle of the work_struct is tied to the
5310 * usb_interface. Before destroying the interface we cancel the
5311 * work_struct, so the fact that work_struct is queued and or
5312 * running means the interface (and thus, the device) exist and
5315 void usb_queue_reset_device(struct usb_interface *iface)
5317 schedule_work(&iface->reset_ws);
5319 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5322 * usb_hub_find_child - Get the pointer of child device
5323 * attached to the port which is specified by @port1.
5324 * @hdev: USB device belonging to the usb hub
5325 * @port1: port num to indicate which port the child device
5328 * USB drivers call this function to get hub's child device
5331 * Return: %NULL if input param is invalid and
5332 * child's usb_device pointer if non-NULL.
5334 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5337 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5339 if (port1 < 1 || port1 > hdev->maxchild)
5341 return hub->ports[port1 - 1]->child;
5343 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5346 * usb_set_hub_port_connect_type - set hub port connect type.
5347 * @hdev: USB device belonging to the usb hub
5348 * @port1: port num of the port
5349 * @type: connect type of the port
5351 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5352 enum usb_port_connect_type type)
5354 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5357 hub->ports[port1 - 1]->connect_type = type;
5361 * usb_get_hub_port_connect_type - Get the port's connect type
5362 * @hdev: USB device belonging to the usb hub
5363 * @port1: port num of the port
5365 * Return: The connect type of the port if successful. Or
5366 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5368 enum usb_port_connect_type
5369 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5371 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5374 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5376 return hub->ports[port1 - 1]->connect_type;
5379 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5380 struct usb_hub_descriptor *desc)
5382 enum usb_port_connect_type connect_type;
5385 if (!hub_is_superspeed(hdev)) {
5386 for (i = 1; i <= hdev->maxchild; i++) {
5387 connect_type = usb_get_hub_port_connect_type(hdev, i);
5389 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5390 u8 mask = 1 << (i%8);
5392 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5393 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5395 desc->u.hs.DeviceRemovable[i/8] |= mask;
5400 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5402 for (i = 1; i <= hdev->maxchild; i++) {
5403 connect_type = usb_get_hub_port_connect_type(hdev, i);
5405 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5408 if (!(port_removable & mask)) {
5409 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5411 port_removable |= mask;
5416 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5422 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5423 * @hdev: USB device belonging to the usb hub
5424 * @port1: port num of the port
5426 * Return: Port's acpi handle if successful, %NULL if params are
5429 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5432 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5437 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);