4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/otg.h>
24 #include <linux/usb/quirks.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/freezer.h>
28 #include <linux/random.h>
29 #include <linux/pm_qos.h>
31 #include <asm/uaccess.h>
32 #include <asm/byteorder.h>
36 /* if we are in debug mode, always announce new devices */
38 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
39 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
43 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
44 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
46 static inline int hub_is_superspeed(struct usb_device *hdev)
48 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
51 /* Protect struct usb_device->state and ->children members
52 * Note: Both are also protected by ->dev.sem, except that ->state can
53 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
54 static DEFINE_SPINLOCK(device_state_lock);
56 /* khubd's worklist and its lock */
57 static DEFINE_SPINLOCK(hub_event_lock);
58 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
61 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
63 static struct task_struct *khubd_task;
65 /* cycle leds on hubs that aren't blinking for attention */
66 static bool blinkenlights = 0;
67 module_param (blinkenlights, bool, S_IRUGO);
68 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
74 /* define initial 64-byte descriptor request timeout in milliseconds */
75 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
76 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
77 MODULE_PARM_DESC(initial_descriptor_timeout,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
95 static bool old_scheme_first = 0;
96 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
97 MODULE_PARM_DESC(old_scheme_first,
98 "start with the old device initialization scheme");
100 static bool use_both_schemes = 1;
101 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
102 MODULE_PARM_DESC(use_both_schemes,
103 "try the other device initialization scheme if the "
106 /* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
109 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
110 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
112 #define HUB_DEBOUNCE_TIMEOUT 2000
113 #define HUB_DEBOUNCE_STEP 25
114 #define HUB_DEBOUNCE_STABLE 100
116 static int usb_reset_and_verify_device(struct usb_device *udev);
118 static inline char *portspeed(struct usb_hub *hub, int portstatus)
120 if (hub_is_superspeed(hub->hdev))
122 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
124 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
130 /* Note that hdev or one of its children must be locked! */
131 struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
133 if (!hdev || !hdev->actconfig || !hdev->maxchild)
135 return usb_get_intfdata(hdev->actconfig->interface[0]);
138 int usb_device_supports_lpm(struct usb_device *udev)
140 /* USB 2.1 (and greater) devices indicate LPM support through
141 * their USB 2.0 Extended Capabilities BOS descriptor.
143 if (udev->speed == USB_SPEED_HIGH) {
144 if (udev->bos->ext_cap &&
146 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
151 /* All USB 3.0 must support LPM, but we need their max exit latency
152 * information from the SuperSpeed Extended Capabilities BOS descriptor.
154 if (!udev->bos->ss_cap) {
155 dev_warn(&udev->dev, "No LPM exit latency info found. "
156 "Power management will be impacted.\n");
160 /* udev is root hub */
164 if (udev->parent->lpm_capable)
167 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
168 "Power management will be impacted.\n");
173 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
176 static void usb_set_lpm_mel(struct usb_device *udev,
177 struct usb3_lpm_parameters *udev_lpm_params,
178 unsigned int udev_exit_latency,
180 struct usb3_lpm_parameters *hub_lpm_params,
181 unsigned int hub_exit_latency)
183 unsigned int total_mel;
184 unsigned int device_mel;
185 unsigned int hub_mel;
188 * Calculate the time it takes to transition all links from the roothub
189 * to the parent hub into U0. The parent hub must then decode the
190 * packet (hub header decode latency) to figure out which port it was
193 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
194 * means 0.1us). Multiply that by 100 to get nanoseconds.
196 total_mel = hub_lpm_params->mel +
197 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
200 * How long will it take to transition the downstream hub's port into
201 * U0? The greater of either the hub exit latency or the device exit
204 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
205 * Multiply that by 1000 to get nanoseconds.
207 device_mel = udev_exit_latency * 1000;
208 hub_mel = hub_exit_latency * 1000;
209 if (device_mel > hub_mel)
210 total_mel += device_mel;
212 total_mel += hub_mel;
214 udev_lpm_params->mel = total_mel;
218 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
219 * a transition from either U1 or U2.
221 static void usb_set_lpm_pel(struct usb_device *udev,
222 struct usb3_lpm_parameters *udev_lpm_params,
223 unsigned int udev_exit_latency,
225 struct usb3_lpm_parameters *hub_lpm_params,
226 unsigned int hub_exit_latency,
227 unsigned int port_to_port_exit_latency)
229 unsigned int first_link_pel;
230 unsigned int hub_pel;
233 * First, the device sends an LFPS to transition the link between the
234 * device and the parent hub into U0. The exit latency is the bigger of
235 * the device exit latency or the hub exit latency.
237 if (udev_exit_latency > hub_exit_latency)
238 first_link_pel = udev_exit_latency * 1000;
240 first_link_pel = hub_exit_latency * 1000;
243 * When the hub starts to receive the LFPS, there is a slight delay for
244 * it to figure out that one of the ports is sending an LFPS. Then it
245 * will forward the LFPS to its upstream link. The exit latency is the
246 * delay, plus the PEL that we calculated for this hub.
248 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
251 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
252 * is the greater of the two exit latencies.
254 if (first_link_pel > hub_pel)
255 udev_lpm_params->pel = first_link_pel;
257 udev_lpm_params->pel = hub_pel;
261 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
262 * when a device initiates a transition to U0, until when it will receive the
263 * first packet from the host controller.
265 * Section C.1.5.1 describes the four components to this:
267 * - t2: time for the ERDY to make it from the device to the host.
268 * - t3: a host-specific delay to process the ERDY.
269 * - t4: time for the packet to make it from the host to the device.
271 * t3 is specific to both the xHCI host and the platform the host is integrated
272 * into. The Intel HW folks have said it's negligible, FIXME if a different
273 * vendor says otherwise.
275 static void usb_set_lpm_sel(struct usb_device *udev,
276 struct usb3_lpm_parameters *udev_lpm_params)
278 struct usb_device *parent;
279 unsigned int num_hubs;
280 unsigned int total_sel;
282 /* t1 = device PEL */
283 total_sel = udev_lpm_params->pel;
284 /* How many external hubs are in between the device & the root port. */
285 for (parent = udev->parent, num_hubs = 0; parent->parent;
286 parent = parent->parent)
288 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
290 total_sel += 2100 + 250 * (num_hubs - 1);
292 /* t4 = 250ns * num_hubs */
293 total_sel += 250 * num_hubs;
295 udev_lpm_params->sel = total_sel;
298 static void usb_set_lpm_parameters(struct usb_device *udev)
301 unsigned int port_to_port_delay;
302 unsigned int udev_u1_del;
303 unsigned int udev_u2_del;
304 unsigned int hub_u1_del;
305 unsigned int hub_u2_del;
307 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
310 hub = usb_hub_to_struct_hub(udev->parent);
311 /* It doesn't take time to transition the roothub into U0, since it
312 * doesn't have an upstream link.
317 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
318 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
319 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
320 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
322 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
323 hub, &udev->parent->u1_params, hub_u1_del);
325 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
326 hub, &udev->parent->u2_params, hub_u2_del);
329 * Appendix C, section C.2.2.2, says that there is a slight delay from
330 * when the parent hub notices the downstream port is trying to
331 * transition to U0 to when the hub initiates a U0 transition on its
332 * upstream port. The section says the delays are tPort2PortU1EL and
333 * tPort2PortU2EL, but it doesn't define what they are.
335 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
336 * about the same delays. Use the maximum delay calculations from those
337 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
338 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
339 * assume the device exit latencies they are talking about are the hub
342 * What do we do if the U2 exit latency is less than the U1 exit
343 * latency? It's possible, although not likely...
345 port_to_port_delay = 1;
347 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
348 hub, &udev->parent->u1_params, hub_u1_del,
351 if (hub_u2_del > hub_u1_del)
352 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
354 port_to_port_delay = 1 + hub_u1_del;
356 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
357 hub, &udev->parent->u2_params, hub_u2_del,
360 /* Now that we've got PEL, calculate SEL. */
361 usb_set_lpm_sel(udev, &udev->u1_params);
362 usb_set_lpm_sel(udev, &udev->u2_params);
365 /* USB 2.0 spec Section 11.24.4.5 */
366 static int get_hub_descriptor(struct usb_device *hdev, void *data)
371 if (hub_is_superspeed(hdev)) {
372 dtype = USB_DT_SS_HUB;
373 size = USB_DT_SS_HUB_SIZE;
376 size = sizeof(struct usb_hub_descriptor);
379 for (i = 0; i < 3; i++) {
380 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
381 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
382 dtype << 8, 0, data, size,
383 USB_CTRL_GET_TIMEOUT);
384 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
391 * USB 2.0 spec Section 11.24.2.1
393 static int clear_hub_feature(struct usb_device *hdev, int feature)
395 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
396 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
400 * USB 2.0 spec Section 11.24.2.2
402 int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
404 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
405 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
410 * USB 2.0 spec Section 11.24.2.13
412 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
414 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
415 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
420 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
421 * for info about using port indicators
423 static void set_port_led(
429 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
430 USB_PORT_FEAT_INDICATOR);
432 dev_dbg (hub->intfdev,
433 "port %d indicator %s status %d\n",
435 ({ char *s; switch (selector) {
436 case HUB_LED_AMBER: s = "amber"; break;
437 case HUB_LED_GREEN: s = "green"; break;
438 case HUB_LED_OFF: s = "off"; break;
439 case HUB_LED_AUTO: s = "auto"; break;
440 default: s = "??"; break;
445 #define LED_CYCLE_PERIOD ((2*HZ)/3)
447 static void led_work (struct work_struct *work)
449 struct usb_hub *hub =
450 container_of(work, struct usb_hub, leds.work);
451 struct usb_device *hdev = hub->hdev;
453 unsigned changed = 0;
456 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
459 for (i = 0; i < hdev->maxchild; i++) {
460 unsigned selector, mode;
462 /* 30%-50% duty cycle */
464 switch (hub->indicator[i]) {
466 case INDICATOR_CYCLE:
468 selector = HUB_LED_AUTO;
469 mode = INDICATOR_AUTO;
471 /* blinking green = sw attention */
472 case INDICATOR_GREEN_BLINK:
473 selector = HUB_LED_GREEN;
474 mode = INDICATOR_GREEN_BLINK_OFF;
476 case INDICATOR_GREEN_BLINK_OFF:
477 selector = HUB_LED_OFF;
478 mode = INDICATOR_GREEN_BLINK;
480 /* blinking amber = hw attention */
481 case INDICATOR_AMBER_BLINK:
482 selector = HUB_LED_AMBER;
483 mode = INDICATOR_AMBER_BLINK_OFF;
485 case INDICATOR_AMBER_BLINK_OFF:
486 selector = HUB_LED_OFF;
487 mode = INDICATOR_AMBER_BLINK;
489 /* blink green/amber = reserved */
490 case INDICATOR_ALT_BLINK:
491 selector = HUB_LED_GREEN;
492 mode = INDICATOR_ALT_BLINK_OFF;
494 case INDICATOR_ALT_BLINK_OFF:
495 selector = HUB_LED_AMBER;
496 mode = INDICATOR_ALT_BLINK;
501 if (selector != HUB_LED_AUTO)
503 set_port_led(hub, i + 1, selector);
504 hub->indicator[i] = mode;
506 if (!changed && blinkenlights) {
508 cursor %= hdev->maxchild;
509 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
510 hub->indicator[cursor] = INDICATOR_CYCLE;
514 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
517 /* use a short timeout for hub/port status fetches */
518 #define USB_STS_TIMEOUT 1000
519 #define USB_STS_RETRIES 5
522 * USB 2.0 spec Section 11.24.2.6
524 static int get_hub_status(struct usb_device *hdev,
525 struct usb_hub_status *data)
527 int i, status = -ETIMEDOUT;
529 for (i = 0; i < USB_STS_RETRIES &&
530 (status == -ETIMEDOUT || status == -EPIPE); i++) {
531 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
532 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
533 data, sizeof(*data), USB_STS_TIMEOUT);
539 * USB 2.0 spec Section 11.24.2.7
541 static int get_port_status(struct usb_device *hdev, int port1,
542 struct usb_port_status *data)
544 int i, status = -ETIMEDOUT;
546 for (i = 0; i < USB_STS_RETRIES &&
547 (status == -ETIMEDOUT || status == -EPIPE); i++) {
548 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
549 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
550 data, sizeof(*data), USB_STS_TIMEOUT);
555 static int hub_port_status(struct usb_hub *hub, int port1,
556 u16 *status, u16 *change)
560 mutex_lock(&hub->status_mutex);
561 ret = get_port_status(hub->hdev, port1, &hub->status->port);
564 dev_err(hub->intfdev,
565 "%s failed (err = %d)\n", __func__, ret);
569 *status = le16_to_cpu(hub->status->port.wPortStatus);
570 *change = le16_to_cpu(hub->status->port.wPortChange);
574 mutex_unlock(&hub->status_mutex);
578 static void kick_khubd(struct usb_hub *hub)
582 spin_lock_irqsave(&hub_event_lock, flags);
583 if (!hub->disconnected && list_empty(&hub->event_list)) {
584 list_add_tail(&hub->event_list, &hub_event_list);
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub->intfdev));
589 wake_up(&khubd_wait);
591 spin_unlock_irqrestore(&hub_event_lock, flags);
594 void usb_kick_khubd(struct usb_device *hdev)
596 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
610 void usb_wakeup_notification(struct usb_device *hdev,
611 unsigned int portnum)
618 hub = usb_hub_to_struct_hub(hdev);
620 set_bit(portnum, hub->wakeup_bits);
624 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
626 /* completion function, fires on port status changes and various faults */
627 static void hub_irq(struct urb *urb)
629 struct usb_hub *hub = urb->context;
630 int status = urb->status;
635 case -ENOENT: /* synchronous unlink */
636 case -ECONNRESET: /* async unlink */
637 case -ESHUTDOWN: /* hardware going away */
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
642 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
643 if ((++hub->nerrors < 10) || hub->error)
648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
651 for (i = 0; i < urb->actual_length; ++i)
652 bits |= ((unsigned long) ((*hub->buffer)[i]))
654 hub->event_bits[0] = bits;
660 /* Something happened, let khubd figure it out */
667 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
668 && status != -ENODEV && status != -EPERM)
669 dev_err (hub->intfdev, "resubmit --> %d\n", status);
672 /* USB 2.0 spec Section 11.24.2.3 */
674 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
676 /* Need to clear both directions for control ep */
677 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
678 USB_ENDPOINT_XFER_CONTROL) {
679 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
680 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
681 devinfo ^ 0x8000, tt, NULL, 0, 1000);
685 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
686 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
696 static void hub_tt_work(struct work_struct *work)
698 struct usb_hub *hub =
699 container_of(work, struct usb_hub, tt.clear_work);
702 spin_lock_irqsave (&hub->tt.lock, flags);
703 while (!list_empty(&hub->tt.clear_list)) {
704 struct list_head *next;
705 struct usb_tt_clear *clear;
706 struct usb_device *hdev = hub->hdev;
707 const struct hc_driver *drv;
710 next = hub->tt.clear_list.next;
711 clear = list_entry (next, struct usb_tt_clear, clear_list);
712 list_del (&clear->clear_list);
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub->tt.lock, flags);
716 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
717 if (status && status != -ENODEV)
719 "clear tt %d (%04x) error %d\n",
720 clear->tt, clear->devinfo, status);
722 /* Tell the HCD, even if the operation failed */
723 drv = clear->hcd->driver;
724 if (drv->clear_tt_buffer_complete)
725 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
728 spin_lock_irqsave(&hub->tt.lock, flags);
730 spin_unlock_irqrestore (&hub->tt.lock, flags);
734 * usb_hub_set_port_power - control hub port's power state
735 * @hdev: USB device belonging to the usb hub
738 * @set: expected status
740 * call this function to control port's power via setting or
741 * clearing the port's PORT_POWER feature.
743 * Return: 0 if successful. A negative error code otherwise.
745 int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
749 struct usb_port *port_dev = hub->ports[port1 - 1];
752 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
754 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
757 port_dev->power_is_on = set;
762 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
763 * @urb: an URB associated with the failed or incomplete split transaction
765 * High speed HCDs use this to tell the hub driver that some split control or
766 * bulk transaction failed in a way that requires clearing internal state of
767 * a transaction translator. This is normally detected (and reported) from
770 * It may not be possible for that hub to handle additional full (or low)
771 * speed transactions until that state is fully cleared out.
773 * Return: 0 if successful. A negative error code otherwise.
775 int usb_hub_clear_tt_buffer(struct urb *urb)
777 struct usb_device *udev = urb->dev;
778 int pipe = urb->pipe;
779 struct usb_tt *tt = udev->tt;
781 struct usb_tt_clear *clear;
783 /* we've got to cope with an arbitrary number of pending TT clears,
784 * since each TT has "at least two" buffers that can need it (and
785 * there can be many TTs per hub). even if they're uncommon.
787 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
788 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
789 /* FIXME recover somehow ... RESET_TT? */
793 /* info that CLEAR_TT_BUFFER needs */
794 clear->tt = tt->multi ? udev->ttport : 1;
795 clear->devinfo = usb_pipeendpoint (pipe);
796 clear->devinfo |= udev->devnum << 4;
797 clear->devinfo |= usb_pipecontrol (pipe)
798 ? (USB_ENDPOINT_XFER_CONTROL << 11)
799 : (USB_ENDPOINT_XFER_BULK << 11);
800 if (usb_pipein (pipe))
801 clear->devinfo |= 1 << 15;
803 /* info for completion callback */
804 clear->hcd = bus_to_hcd(udev->bus);
807 /* tell keventd to clear state for this TT */
808 spin_lock_irqsave (&tt->lock, flags);
809 list_add_tail (&clear->clear_list, &tt->clear_list);
810 schedule_work(&tt->clear_work);
811 spin_unlock_irqrestore (&tt->lock, flags);
814 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
816 /* If do_delay is false, return the number of milliseconds the caller
819 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
822 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
824 u16 wHubCharacteristics =
825 le16_to_cpu(hub->descriptor->wHubCharacteristics);
827 /* Enable power on each port. Some hubs have reserved values
828 * of LPSM (> 2) in their descriptors, even though they are
829 * USB 2.0 hubs. Some hubs do not implement port-power switching
830 * but only emulate it. In all cases, the ports won't work
831 * unless we send these messages to the hub.
833 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
834 dev_dbg(hub->intfdev, "enabling power on all ports\n");
836 dev_dbg(hub->intfdev, "trying to enable port power on "
837 "non-switchable hub\n");
838 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
839 if (hub->ports[port1 - 1]->power_is_on)
840 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
842 usb_clear_port_feature(hub->hdev, port1,
843 USB_PORT_FEAT_POWER);
845 /* Wait at least 100 msec for power to become stable */
846 delay = max(pgood_delay, (unsigned) 100);
852 static int hub_hub_status(struct usb_hub *hub,
853 u16 *status, u16 *change)
857 mutex_lock(&hub->status_mutex);
858 ret = get_hub_status(hub->hdev, &hub->status->hub);
861 dev_err(hub->intfdev,
862 "%s failed (err = %d)\n", __func__, ret);
864 *status = le16_to_cpu(hub->status->hub.wHubStatus);
865 *change = le16_to_cpu(hub->status->hub.wHubChange);
868 mutex_unlock(&hub->status_mutex);
872 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
873 unsigned int link_status)
875 return set_port_feature(hub->hdev,
876 port1 | (link_status << 3),
877 USB_PORT_FEAT_LINK_STATE);
881 * If USB 3.0 ports are placed into the Disabled state, they will no longer
882 * detect any device connects or disconnects. This is generally not what the
883 * USB core wants, since it expects a disabled port to produce a port status
884 * change event when a new device connects.
886 * Instead, set the link state to Disabled, wait for the link to settle into
887 * that state, clear any change bits, and then put the port into the RxDetect
890 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
894 u16 portchange, portstatus;
896 if (!hub_is_superspeed(hub->hdev))
899 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
903 /* Wait for the link to enter the disabled state. */
904 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
905 ret = hub_port_status(hub, port1, &portstatus, &portchange);
909 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
910 USB_SS_PORT_LS_SS_DISABLED)
912 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
914 msleep(HUB_DEBOUNCE_STEP);
916 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
917 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
920 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
923 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
925 struct usb_device *hdev = hub->hdev;
928 if (hub->ports[port1 - 1]->child && set_state)
929 usb_set_device_state(hub->ports[port1 - 1]->child,
930 USB_STATE_NOTATTACHED);
932 if (hub_is_superspeed(hub->hdev))
933 ret = hub_usb3_port_disable(hub, port1);
935 ret = usb_clear_port_feature(hdev, port1,
936 USB_PORT_FEAT_ENABLE);
938 if (ret && ret != -ENODEV)
939 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
945 * Disable a port and mark a logical connect-change event, so that some
946 * time later khubd will disconnect() any existing usb_device on the port
947 * and will re-enumerate if there actually is a device attached.
949 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
951 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
952 hub_port_disable(hub, port1, 1);
954 /* FIXME let caller ask to power down the port:
955 * - some devices won't enumerate without a VBUS power cycle
956 * - SRP saves power that way
957 * - ... new call, TBD ...
958 * That's easy if this hub can switch power per-port, and
959 * khubd reactivates the port later (timer, SRP, etc).
960 * Powerdown must be optional, because of reset/DFU.
963 set_bit(port1, hub->change_bits);
968 * usb_remove_device - disable a device's port on its parent hub
969 * @udev: device to be disabled and removed
970 * Context: @udev locked, must be able to sleep.
972 * After @udev's port has been disabled, khubd is notified and it will
973 * see that the device has been disconnected. When the device is
974 * physically unplugged and something is plugged in, the events will
975 * be received and processed normally.
977 * Return: 0 if successful. A negative error code otherwise.
979 int usb_remove_device(struct usb_device *udev)
982 struct usb_interface *intf;
984 if (!udev->parent) /* Can't remove a root hub */
986 hub = usb_hub_to_struct_hub(udev->parent);
987 intf = to_usb_interface(hub->intfdev);
989 usb_autopm_get_interface(intf);
990 set_bit(udev->portnum, hub->removed_bits);
991 hub_port_logical_disconnect(hub, udev->portnum);
992 usb_autopm_put_interface(intf);
996 enum hub_activation_type {
997 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
998 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1001 static void hub_init_func2(struct work_struct *ws);
1002 static void hub_init_func3(struct work_struct *ws);
1004 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1006 struct usb_device *hdev = hub->hdev;
1007 struct usb_hcd *hcd;
1011 bool need_debounce_delay = false;
1014 /* Continue a partial initialization */
1015 if (type == HUB_INIT2)
1017 if (type == HUB_INIT3)
1020 /* The superspeed hub except for root hub has to use Hub Depth
1021 * value as an offset into the route string to locate the bits
1022 * it uses to determine the downstream port number. So hub driver
1023 * should send a set hub depth request to superspeed hub after
1024 * the superspeed hub is set configuration in initialization or
1027 * After a resume, port power should still be on.
1028 * For any other type of activation, turn it on.
1030 if (type != HUB_RESUME) {
1031 if (hdev->parent && hub_is_superspeed(hdev)) {
1032 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1033 HUB_SET_DEPTH, USB_RT_HUB,
1034 hdev->level - 1, 0, NULL, 0,
1035 USB_CTRL_SET_TIMEOUT);
1037 dev_err(hub->intfdev,
1038 "set hub depth failed\n");
1041 /* Speed up system boot by using a delayed_work for the
1042 * hub's initial power-up delays. This is pretty awkward
1043 * and the implementation looks like a home-brewed sort of
1044 * setjmp/longjmp, but it saves at least 100 ms for each
1045 * root hub (assuming usbcore is compiled into the kernel
1046 * rather than as a module). It adds up.
1048 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1049 * because for those activation types the ports have to be
1050 * operational when we return. In theory this could be done
1051 * for HUB_POST_RESET, but it's easier not to.
1053 if (type == HUB_INIT) {
1054 delay = hub_power_on(hub, false);
1055 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1056 schedule_delayed_work(&hub->init_work,
1057 msecs_to_jiffies(delay));
1059 /* Suppress autosuspend until init is done */
1060 usb_autopm_get_interface_no_resume(
1061 to_usb_interface(hub->intfdev));
1062 return; /* Continues at init2: below */
1063 } else if (type == HUB_RESET_RESUME) {
1064 /* The internal host controller state for the hub device
1065 * may be gone after a host power loss on system resume.
1066 * Update the device's info so the HW knows it's a hub.
1068 hcd = bus_to_hcd(hdev->bus);
1069 if (hcd->driver->update_hub_device) {
1070 ret = hcd->driver->update_hub_device(hcd, hdev,
1071 &hub->tt, GFP_NOIO);
1073 dev_err(hub->intfdev, "Host not "
1074 "accepting hub info "
1076 dev_err(hub->intfdev, "LS/FS devices "
1077 "and hubs may not work "
1078 "under this hub\n.");
1081 hub_power_on(hub, true);
1083 hub_power_on(hub, true);
1088 /* Check each port and set hub->change_bits to let khubd know
1089 * which ports need attention.
1091 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1092 struct usb_device *udev = hub->ports[port1 - 1]->child;
1093 u16 portstatus, portchange;
1095 portstatus = portchange = 0;
1096 status = hub_port_status(hub, port1, &portstatus, &portchange);
1097 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1098 dev_dbg(hub->intfdev,
1099 "port %d: status %04x change %04x\n",
1100 port1, portstatus, portchange);
1102 /* After anything other than HUB_RESUME (i.e., initialization
1103 * or any sort of reset), every port should be disabled.
1104 * Unconnected ports should likewise be disabled (paranoia),
1105 * and so should ports for which we have no usb_device.
1107 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1108 type != HUB_RESUME ||
1109 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1111 udev->state == USB_STATE_NOTATTACHED)) {
1113 * USB3 protocol ports will automatically transition
1114 * to Enabled state when detect an USB3.0 device attach.
1115 * Do not disable USB3 protocol ports.
1117 if (!hub_is_superspeed(hdev)) {
1118 usb_clear_port_feature(hdev, port1,
1119 USB_PORT_FEAT_ENABLE);
1120 portstatus &= ~USB_PORT_STAT_ENABLE;
1122 /* Pretend that power was lost for USB3 devs */
1123 portstatus &= ~USB_PORT_STAT_ENABLE;
1127 /* Clear status-change flags; we'll debounce later */
1128 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1129 need_debounce_delay = true;
1130 usb_clear_port_feature(hub->hdev, port1,
1131 USB_PORT_FEAT_C_CONNECTION);
1133 if (portchange & USB_PORT_STAT_C_ENABLE) {
1134 need_debounce_delay = true;
1135 usb_clear_port_feature(hub->hdev, port1,
1136 USB_PORT_FEAT_C_ENABLE);
1138 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1139 hub_is_superspeed(hub->hdev)) {
1140 need_debounce_delay = true;
1141 usb_clear_port_feature(hub->hdev, port1,
1142 USB_PORT_FEAT_C_BH_PORT_RESET);
1144 /* We can forget about a "removed" device when there's a
1145 * physical disconnect or the connect status changes.
1147 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1148 (portchange & USB_PORT_STAT_C_CONNECTION))
1149 clear_bit(port1, hub->removed_bits);
1151 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1152 /* Tell khubd to disconnect the device or
1153 * check for a new connection
1155 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1156 set_bit(port1, hub->change_bits);
1158 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1159 bool port_resumed = (portstatus &
1160 USB_PORT_STAT_LINK_STATE) ==
1162 /* The power session apparently survived the resume.
1163 * If there was an overcurrent or suspend change
1164 * (i.e., remote wakeup request), have khubd
1165 * take care of it. Look at the port link state
1166 * for USB 3.0 hubs, since they don't have a suspend
1167 * change bit, and they don't set the port link change
1168 * bit on device-initiated resume.
1170 if (portchange || (hub_is_superspeed(hub->hdev) &&
1172 set_bit(port1, hub->change_bits);
1174 } else if (udev->persist_enabled) {
1175 struct usb_port *port_dev = hub->ports[port1 - 1];
1178 udev->reset_resume = 1;
1180 /* Don't set the change_bits when the device
1183 if (port_dev->power_is_on)
1184 set_bit(port1, hub->change_bits);
1187 /* The power session is gone; tell khubd */
1188 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1189 set_bit(port1, hub->change_bits);
1193 /* If no port-status-change flags were set, we don't need any
1194 * debouncing. If flags were set we can try to debounce the
1195 * ports all at once right now, instead of letting khubd do them
1196 * one at a time later on.
1198 * If any port-status changes do occur during this delay, khubd
1199 * will see them later and handle them normally.
1201 if (need_debounce_delay) {
1202 delay = HUB_DEBOUNCE_STABLE;
1204 /* Don't do a long sleep inside a workqueue routine */
1205 if (type == HUB_INIT2) {
1206 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1207 schedule_delayed_work(&hub->init_work,
1208 msecs_to_jiffies(delay));
1209 return; /* Continues at init3: below */
1217 status = usb_submit_urb(hub->urb, GFP_NOIO);
1219 dev_err(hub->intfdev, "activate --> %d\n", status);
1220 if (hub->has_indicators && blinkenlights)
1221 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1223 /* Scan all ports that need attention */
1226 /* Allow autosuspend if it was suppressed */
1227 if (type <= HUB_INIT3)
1228 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1231 /* Implement the continuations for the delays above */
1232 static void hub_init_func2(struct work_struct *ws)
1234 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1236 hub_activate(hub, HUB_INIT2);
1239 static void hub_init_func3(struct work_struct *ws)
1241 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1243 hub_activate(hub, HUB_INIT3);
1246 enum hub_quiescing_type {
1247 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1250 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1252 struct usb_device *hdev = hub->hdev;
1255 cancel_delayed_work_sync(&hub->init_work);
1257 /* khubd and related activity won't re-trigger */
1260 if (type != HUB_SUSPEND) {
1261 /* Disconnect all the children */
1262 for (i = 0; i < hdev->maxchild; ++i) {
1263 if (hub->ports[i]->child)
1264 usb_disconnect(&hub->ports[i]->child);
1268 /* Stop khubd and related activity */
1269 usb_kill_urb(hub->urb);
1270 if (hub->has_indicators)
1271 cancel_delayed_work_sync(&hub->leds);
1273 flush_work(&hub->tt.clear_work);
1276 /* caller has locked the hub device */
1277 static int hub_pre_reset(struct usb_interface *intf)
1279 struct usb_hub *hub = usb_get_intfdata(intf);
1281 hub_quiesce(hub, HUB_PRE_RESET);
1285 /* caller has locked the hub device */
1286 static int hub_post_reset(struct usb_interface *intf)
1288 struct usb_hub *hub = usb_get_intfdata(intf);
1290 hub_activate(hub, HUB_POST_RESET);
1294 static int hub_configure(struct usb_hub *hub,
1295 struct usb_endpoint_descriptor *endpoint)
1297 struct usb_hcd *hcd;
1298 struct usb_device *hdev = hub->hdev;
1299 struct device *hub_dev = hub->intfdev;
1300 u16 hubstatus, hubchange;
1301 u16 wHubCharacteristics;
1304 char *message = "out of memory";
1308 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1314 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1319 mutex_init(&hub->status_mutex);
1321 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1322 if (!hub->descriptor) {
1327 /* Request the entire hub descriptor.
1328 * hub->descriptor can handle USB_MAXCHILDREN ports,
1329 * but the hub can/will return fewer bytes here.
1331 ret = get_hub_descriptor(hdev, hub->descriptor);
1333 message = "can't read hub descriptor";
1335 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1336 message = "hub has too many ports!";
1339 } else if (hub->descriptor->bNbrPorts == 0) {
1340 message = "hub doesn't have any ports!";
1345 hdev->maxchild = hub->descriptor->bNbrPorts;
1346 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1347 (hdev->maxchild == 1) ? "" : "s");
1349 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1356 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1357 if (hub_is_superspeed(hdev)) {
1365 /* FIXME for USB 3.0, skip for now */
1366 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1367 !(hub_is_superspeed(hdev))) {
1369 char portstr [USB_MAXCHILDREN + 1];
1371 for (i = 0; i < hdev->maxchild; i++)
1372 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1373 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1375 portstr[hdev->maxchild] = 0;
1376 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1378 dev_dbg(hub_dev, "standalone hub\n");
1380 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1381 case HUB_CHAR_COMMON_LPSM:
1382 dev_dbg(hub_dev, "ganged power switching\n");
1384 case HUB_CHAR_INDV_PORT_LPSM:
1385 dev_dbg(hub_dev, "individual port power switching\n");
1387 case HUB_CHAR_NO_LPSM:
1389 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1393 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1394 case HUB_CHAR_COMMON_OCPM:
1395 dev_dbg(hub_dev, "global over-current protection\n");
1397 case HUB_CHAR_INDV_PORT_OCPM:
1398 dev_dbg(hub_dev, "individual port over-current protection\n");
1400 case HUB_CHAR_NO_OCPM:
1402 dev_dbg(hub_dev, "no over-current protection\n");
1406 spin_lock_init (&hub->tt.lock);
1407 INIT_LIST_HEAD (&hub->tt.clear_list);
1408 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1409 switch (hdev->descriptor.bDeviceProtocol) {
1412 case USB_HUB_PR_HS_SINGLE_TT:
1413 dev_dbg(hub_dev, "Single TT\n");
1416 case USB_HUB_PR_HS_MULTI_TT:
1417 ret = usb_set_interface(hdev, 0, 1);
1419 dev_dbg(hub_dev, "TT per port\n");
1422 dev_err(hub_dev, "Using single TT (err %d)\n",
1427 /* USB 3.0 hubs don't have a TT */
1430 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1431 hdev->descriptor.bDeviceProtocol);
1435 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1436 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1437 case HUB_TTTT_8_BITS:
1438 if (hdev->descriptor.bDeviceProtocol != 0) {
1439 hub->tt.think_time = 666;
1440 dev_dbg(hub_dev, "TT requires at most %d "
1441 "FS bit times (%d ns)\n",
1442 8, hub->tt.think_time);
1445 case HUB_TTTT_16_BITS:
1446 hub->tt.think_time = 666 * 2;
1447 dev_dbg(hub_dev, "TT requires at most %d "
1448 "FS bit times (%d ns)\n",
1449 16, hub->tt.think_time);
1451 case HUB_TTTT_24_BITS:
1452 hub->tt.think_time = 666 * 3;
1453 dev_dbg(hub_dev, "TT requires at most %d "
1454 "FS bit times (%d ns)\n",
1455 24, hub->tt.think_time);
1457 case HUB_TTTT_32_BITS:
1458 hub->tt.think_time = 666 * 4;
1459 dev_dbg(hub_dev, "TT requires at most %d "
1460 "FS bit times (%d ns)\n",
1461 32, hub->tt.think_time);
1465 /* probe() zeroes hub->indicator[] */
1466 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1467 hub->has_indicators = 1;
1468 dev_dbg(hub_dev, "Port indicators are supported\n");
1471 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1472 hub->descriptor->bPwrOn2PwrGood * 2);
1474 /* power budgeting mostly matters with bus-powered hubs,
1475 * and battery-powered root hubs (may provide just 8 mA).
1477 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1479 message = "can't get hub status";
1482 hcd = bus_to_hcd(hdev->bus);
1483 if (hdev == hdev->bus->root_hub) {
1484 if (hcd->power_budget > 0)
1485 hdev->bus_mA = hcd->power_budget;
1487 hdev->bus_mA = full_load * hdev->maxchild;
1488 if (hdev->bus_mA >= full_load)
1489 hub->mA_per_port = full_load;
1491 hub->mA_per_port = hdev->bus_mA;
1492 hub->limited_power = 1;
1494 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1495 int remaining = hdev->bus_mA -
1496 hub->descriptor->bHubContrCurrent;
1498 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1499 hub->descriptor->bHubContrCurrent);
1500 hub->limited_power = 1;
1502 if (remaining < hdev->maxchild * unit_load)
1504 "insufficient power available "
1505 "to use all downstream ports\n");
1506 hub->mA_per_port = unit_load; /* 7.2.1 */
1508 } else { /* Self-powered external hub */
1509 /* FIXME: What about battery-powered external hubs that
1510 * provide less current per port? */
1511 hub->mA_per_port = full_load;
1513 if (hub->mA_per_port < full_load)
1514 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1517 /* Update the HCD's internal representation of this hub before khubd
1518 * starts getting port status changes for devices under the hub.
1520 if (hcd->driver->update_hub_device) {
1521 ret = hcd->driver->update_hub_device(hcd, hdev,
1522 &hub->tt, GFP_KERNEL);
1524 message = "can't update HCD hub info";
1529 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1531 message = "can't get hub status";
1535 /* local power status reports aren't always correct */
1536 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1537 dev_dbg(hub_dev, "local power source is %s\n",
1538 (hubstatus & HUB_STATUS_LOCAL_POWER)
1539 ? "lost (inactive)" : "good");
1541 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1542 dev_dbg(hub_dev, "%sover-current condition exists\n",
1543 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1545 /* set up the interrupt endpoint
1546 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1547 * bytes as USB2.0[11.12.3] says because some hubs are known
1548 * to send more data (and thus cause overflow). For root hubs,
1549 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1550 * to be big enough for at least USB_MAXCHILDREN ports. */
1551 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1552 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1554 if (maxp > sizeof(*hub->buffer))
1555 maxp = sizeof(*hub->buffer);
1557 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1563 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1564 hub, endpoint->bInterval);
1566 /* maybe cycle the hub leds */
1567 if (hub->has_indicators && blinkenlights)
1568 hub->indicator [0] = INDICATOR_CYCLE;
1570 for (i = 0; i < hdev->maxchild; i++) {
1571 ret = usb_hub_create_port_device(hub, i + 1);
1573 dev_err(hub->intfdev,
1574 "couldn't create port%d device.\n", i + 1);
1576 goto fail_keep_maxchild;
1580 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1582 hub_activate(hub, HUB_INIT);
1588 dev_err (hub_dev, "config failed, %s (err %d)\n",
1590 /* hub_disconnect() frees urb and descriptor */
1594 static void hub_release(struct kref *kref)
1596 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1598 usb_put_intf(to_usb_interface(hub->intfdev));
1602 static unsigned highspeed_hubs;
1604 static void hub_disconnect(struct usb_interface *intf)
1606 struct usb_hub *hub = usb_get_intfdata(intf);
1607 struct usb_device *hdev = interface_to_usbdev(intf);
1610 /* Take the hub off the event list and don't let it be added again */
1611 spin_lock_irq(&hub_event_lock);
1612 if (!list_empty(&hub->event_list)) {
1613 list_del_init(&hub->event_list);
1614 usb_autopm_put_interface_no_suspend(intf);
1616 hub->disconnected = 1;
1617 spin_unlock_irq(&hub_event_lock);
1619 /* Disconnect all children and quiesce the hub */
1621 hub_quiesce(hub, HUB_DISCONNECT);
1623 usb_set_intfdata (intf, NULL);
1625 for (i = 0; i < hdev->maxchild; i++)
1626 usb_hub_remove_port_device(hub, i + 1);
1627 hub->hdev->maxchild = 0;
1629 if (hub->hdev->speed == USB_SPEED_HIGH)
1632 usb_free_urb(hub->urb);
1634 kfree(hub->descriptor);
1638 pm_suspend_ignore_children(&intf->dev, false);
1639 kref_put(&hub->kref, hub_release);
1642 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1644 struct usb_host_interface *desc;
1645 struct usb_endpoint_descriptor *endpoint;
1646 struct usb_device *hdev;
1647 struct usb_hub *hub;
1649 desc = intf->cur_altsetting;
1650 hdev = interface_to_usbdev(intf);
1653 * Set default autosuspend delay as 0 to speedup bus suspend,
1654 * based on the below considerations:
1656 * - Unlike other drivers, the hub driver does not rely on the
1657 * autosuspend delay to provide enough time to handle a wakeup
1658 * event, and the submitted status URB is just to check future
1659 * change on hub downstream ports, so it is safe to do it.
1661 * - The patch might cause one or more auto supend/resume for
1662 * below very rare devices when they are plugged into hub
1665 * devices having trouble initializing, and disconnect
1666 * themselves from the bus and then reconnect a second
1669 * devices just for downloading firmware, and disconnects
1670 * themselves after completing it
1672 * For these quite rare devices, their drivers may change the
1673 * autosuspend delay of their parent hub in the probe() to one
1674 * appropriate value to avoid the subtle problem if someone
1677 * - The patch may cause one or more auto suspend/resume on
1678 * hub during running 'lsusb', but it is probably too
1679 * infrequent to worry about.
1681 * - Change autosuspend delay of hub can avoid unnecessary auto
1682 * suspend timer for hub, also may decrease power consumption
1685 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1687 /* Hubs have proper suspend/resume support. */
1688 usb_enable_autosuspend(hdev);
1690 if (hdev->level == MAX_TOPO_LEVEL) {
1692 "Unsupported bus topology: hub nested too deep\n");
1696 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1698 dev_warn(&intf->dev, "ignoring external hub\n");
1703 /* Some hubs have a subclass of 1, which AFAICT according to the */
1704 /* specs is not defined, but it works */
1705 if ((desc->desc.bInterfaceSubClass != 0) &&
1706 (desc->desc.bInterfaceSubClass != 1)) {
1708 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1712 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1713 if (desc->desc.bNumEndpoints != 1)
1714 goto descriptor_error;
1716 endpoint = &desc->endpoint[0].desc;
1718 /* If it's not an interrupt in endpoint, we'd better punt! */
1719 if (!usb_endpoint_is_int_in(endpoint))
1720 goto descriptor_error;
1722 /* We found a hub */
1723 dev_info (&intf->dev, "USB hub found\n");
1725 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1727 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1731 kref_init(&hub->kref);
1732 INIT_LIST_HEAD(&hub->event_list);
1733 hub->intfdev = &intf->dev;
1735 INIT_DELAYED_WORK(&hub->leds, led_work);
1736 INIT_DELAYED_WORK(&hub->init_work, NULL);
1739 usb_set_intfdata (intf, hub);
1740 intf->needs_remote_wakeup = 1;
1741 pm_suspend_ignore_children(&intf->dev, true);
1743 if (hdev->speed == USB_SPEED_HIGH)
1746 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1747 hub->quirk_check_port_auto_suspend = 1;
1749 if (hub_configure(hub, endpoint) >= 0)
1752 hub_disconnect (intf);
1757 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1759 struct usb_device *hdev = interface_to_usbdev (intf);
1760 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1762 /* assert ifno == 0 (part of hub spec) */
1764 case USBDEVFS_HUB_PORTINFO: {
1765 struct usbdevfs_hub_portinfo *info = user_data;
1768 spin_lock_irq(&device_state_lock);
1769 if (hdev->devnum <= 0)
1772 info->nports = hdev->maxchild;
1773 for (i = 0; i < info->nports; i++) {
1774 if (hub->ports[i]->child == NULL)
1778 hub->ports[i]->child->devnum;
1781 spin_unlock_irq(&device_state_lock);
1783 return info->nports + 1;
1792 * Allow user programs to claim ports on a hub. When a device is attached
1793 * to one of these "claimed" ports, the program will "own" the device.
1795 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1796 struct dev_state ***ppowner)
1798 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1800 if (hdev->state == USB_STATE_NOTATTACHED)
1802 if (port1 == 0 || port1 > hdev->maxchild)
1805 /* Devices not managed by the hub driver
1806 * will always have maxchild equal to 0.
1808 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1812 /* In the following three functions, the caller must hold hdev's lock */
1813 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1814 struct dev_state *owner)
1817 struct dev_state **powner;
1819 rc = find_port_owner(hdev, port1, &powner);
1828 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1829 struct dev_state *owner)
1832 struct dev_state **powner;
1834 rc = find_port_owner(hdev, port1, &powner);
1837 if (*powner != owner)
1843 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1845 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1848 for (n = 0; n < hdev->maxchild; n++) {
1849 if (hub->ports[n]->port_owner == owner)
1850 hub->ports[n]->port_owner = NULL;
1855 /* The caller must hold udev's lock */
1856 bool usb_device_is_owned(struct usb_device *udev)
1858 struct usb_hub *hub;
1860 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1862 hub = usb_hub_to_struct_hub(udev->parent);
1863 return !!hub->ports[udev->portnum - 1]->port_owner;
1866 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1868 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
1871 for (i = 0; i < udev->maxchild; ++i) {
1872 if (hub->ports[i]->child)
1873 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1875 if (udev->state == USB_STATE_SUSPENDED)
1876 udev->active_duration -= jiffies;
1877 udev->state = USB_STATE_NOTATTACHED;
1881 * usb_set_device_state - change a device's current state (usbcore, hcds)
1882 * @udev: pointer to device whose state should be changed
1883 * @new_state: new state value to be stored
1885 * udev->state is _not_ fully protected by the device lock. Although
1886 * most transitions are made only while holding the lock, the state can
1887 * can change to USB_STATE_NOTATTACHED at almost any time. This
1888 * is so that devices can be marked as disconnected as soon as possible,
1889 * without having to wait for any semaphores to be released. As a result,
1890 * all changes to any device's state must be protected by the
1891 * device_state_lock spinlock.
1893 * Once a device has been added to the device tree, all changes to its state
1894 * should be made using this routine. The state should _not_ be set directly.
1896 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1897 * Otherwise udev->state is set to new_state, and if new_state is
1898 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1899 * to USB_STATE_NOTATTACHED.
1901 void usb_set_device_state(struct usb_device *udev,
1902 enum usb_device_state new_state)
1904 unsigned long flags;
1907 spin_lock_irqsave(&device_state_lock, flags);
1908 if (udev->state == USB_STATE_NOTATTACHED)
1910 else if (new_state != USB_STATE_NOTATTACHED) {
1912 /* root hub wakeup capabilities are managed out-of-band
1913 * and may involve silicon errata ... ignore them here.
1916 if (udev->state == USB_STATE_SUSPENDED
1917 || new_state == USB_STATE_SUSPENDED)
1918 ; /* No change to wakeup settings */
1919 else if (new_state == USB_STATE_CONFIGURED)
1920 wakeup = udev->actconfig->desc.bmAttributes
1921 & USB_CONFIG_ATT_WAKEUP;
1925 if (udev->state == USB_STATE_SUSPENDED &&
1926 new_state != USB_STATE_SUSPENDED)
1927 udev->active_duration -= jiffies;
1928 else if (new_state == USB_STATE_SUSPENDED &&
1929 udev->state != USB_STATE_SUSPENDED)
1930 udev->active_duration += jiffies;
1931 udev->state = new_state;
1933 recursively_mark_NOTATTACHED(udev);
1934 spin_unlock_irqrestore(&device_state_lock, flags);
1936 device_set_wakeup_capable(&udev->dev, wakeup);
1938 EXPORT_SYMBOL_GPL(usb_set_device_state);
1941 * Choose a device number.
1943 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1944 * USB-2.0 buses they are also used as device addresses, however on
1945 * USB-3.0 buses the address is assigned by the controller hardware
1946 * and it usually is not the same as the device number.
1948 * WUSB devices are simple: they have no hubs behind, so the mapping
1949 * device <-> virtual port number becomes 1:1. Why? to simplify the
1950 * life of the device connection logic in
1951 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1952 * handshake we need to assign a temporary address in the unauthorized
1953 * space. For simplicity we use the first virtual port number found to
1954 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1955 * and that becomes it's address [X < 128] or its unauthorized address
1958 * We add 1 as an offset to the one-based USB-stack port number
1959 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1960 * 0 is reserved by USB for default address; (b) Linux's USB stack
1961 * uses always #1 for the root hub of the controller. So USB stack's
1962 * port #1, which is wusb virtual-port #0 has address #2.
1964 * Devices connected under xHCI are not as simple. The host controller
1965 * supports virtualization, so the hardware assigns device addresses and
1966 * the HCD must setup data structures before issuing a set address
1967 * command to the hardware.
1969 static void choose_devnum(struct usb_device *udev)
1972 struct usb_bus *bus = udev->bus;
1974 /* If khubd ever becomes multithreaded, this will need a lock */
1976 devnum = udev->portnum + 1;
1977 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1979 /* Try to allocate the next devnum beginning at
1980 * bus->devnum_next. */
1981 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1984 devnum = find_next_zero_bit(bus->devmap.devicemap,
1986 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1989 set_bit(devnum, bus->devmap.devicemap);
1990 udev->devnum = devnum;
1994 static void release_devnum(struct usb_device *udev)
1996 if (udev->devnum > 0) {
1997 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2002 static void update_devnum(struct usb_device *udev, int devnum)
2004 /* The address for a WUSB device is managed by wusbcore. */
2006 udev->devnum = devnum;
2009 static void hub_free_dev(struct usb_device *udev)
2011 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2013 /* Root hubs aren't real devices, so don't free HCD resources */
2014 if (hcd->driver->free_dev && udev->parent)
2015 hcd->driver->free_dev(hcd, udev);
2019 * usb_disconnect - disconnect a device (usbcore-internal)
2020 * @pdev: pointer to device being disconnected
2021 * Context: !in_interrupt ()
2023 * Something got disconnected. Get rid of it and all of its children.
2025 * If *pdev is a normal device then the parent hub must already be locked.
2026 * If *pdev is a root hub then this routine will acquire the
2027 * usb_bus_list_lock on behalf of the caller.
2029 * Only hub drivers (including virtual root hub drivers for host
2030 * controllers) should ever call this.
2032 * This call is synchronous, and may not be used in an interrupt context.
2034 void usb_disconnect(struct usb_device **pdev)
2036 struct usb_device *udev = *pdev;
2037 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2040 /* mark the device as inactive, so any further urb submissions for
2041 * this device (and any of its children) will fail immediately.
2042 * this quiesces everything except pending urbs.
2044 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2045 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2048 usb_lock_device(udev);
2050 /* Free up all the children before we remove this device */
2051 for (i = 0; i < udev->maxchild; i++) {
2052 if (hub->ports[i]->child)
2053 usb_disconnect(&hub->ports[i]->child);
2056 /* deallocate hcd/hardware state ... nuking all pending urbs and
2057 * cleaning up all state associated with the current configuration
2058 * so that the hardware is now fully quiesced.
2060 dev_dbg (&udev->dev, "unregistering device\n");
2061 usb_disable_device(udev, 0);
2062 usb_hcd_synchronize_unlinks(udev);
2065 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2066 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2068 sysfs_remove_link(&udev->dev.kobj, "port");
2069 sysfs_remove_link(&port_dev->dev.kobj, "device");
2071 if (!port_dev->did_runtime_put)
2072 pm_runtime_put(&port_dev->dev);
2074 port_dev->did_runtime_put = false;
2077 usb_remove_ep_devs(&udev->ep0);
2078 usb_unlock_device(udev);
2080 /* Unregister the device. The device driver is responsible
2081 * for de-configuring the device and invoking the remove-device
2082 * notifier chain (used by usbfs and possibly others).
2084 device_del(&udev->dev);
2086 /* Free the device number and delete the parent's children[]
2087 * (or root_hub) pointer.
2089 release_devnum(udev);
2091 /* Avoid races with recursively_mark_NOTATTACHED() */
2092 spin_lock_irq(&device_state_lock);
2094 spin_unlock_irq(&device_state_lock);
2098 put_device(&udev->dev);
2101 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2102 static void show_string(struct usb_device *udev, char *id, char *string)
2106 dev_info(&udev->dev, "%s: %s\n", id, string);
2109 static void announce_device(struct usb_device *udev)
2111 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2112 le16_to_cpu(udev->descriptor.idVendor),
2113 le16_to_cpu(udev->descriptor.idProduct));
2114 dev_info(&udev->dev,
2115 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2116 udev->descriptor.iManufacturer,
2117 udev->descriptor.iProduct,
2118 udev->descriptor.iSerialNumber);
2119 show_string(udev, "Product", udev->product);
2120 show_string(udev, "Manufacturer", udev->manufacturer);
2121 show_string(udev, "SerialNumber", udev->serial);
2124 static inline void announce_device(struct usb_device *udev) { }
2127 #ifdef CONFIG_USB_OTG
2128 #include "otg_whitelist.h"
2132 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2133 * @udev: newly addressed device (in ADDRESS state)
2135 * Finish enumeration for On-The-Go devices
2137 * Return: 0 if successful. A negative error code otherwise.
2139 static int usb_enumerate_device_otg(struct usb_device *udev)
2143 #ifdef CONFIG_USB_OTG
2145 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2146 * to wake us after we've powered off VBUS; and HNP, switching roles
2147 * "host" to "peripheral". The OTG descriptor helps figure this out.
2149 if (!udev->bus->is_b_host
2151 && udev->parent == udev->bus->root_hub) {
2152 struct usb_otg_descriptor *desc = NULL;
2153 struct usb_bus *bus = udev->bus;
2155 /* descriptor may appear anywhere in config */
2156 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2157 le16_to_cpu(udev->config[0].desc.wTotalLength),
2158 USB_DT_OTG, (void **) &desc) == 0) {
2159 if (desc->bmAttributes & USB_OTG_HNP) {
2160 unsigned port1 = udev->portnum;
2162 dev_info(&udev->dev,
2163 "Dual-Role OTG device on %sHNP port\n",
2164 (port1 == bus->otg_port)
2167 /* enable HNP before suspend, it's simpler */
2168 if (port1 == bus->otg_port)
2169 bus->b_hnp_enable = 1;
2170 err = usb_control_msg(udev,
2171 usb_sndctrlpipe(udev, 0),
2172 USB_REQ_SET_FEATURE, 0,
2174 ? USB_DEVICE_B_HNP_ENABLE
2175 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2176 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2178 /* OTG MESSAGE: report errors here,
2179 * customize to match your product.
2181 dev_info(&udev->dev,
2182 "can't set HNP mode: %d\n",
2184 bus->b_hnp_enable = 0;
2190 if (!is_targeted(udev)) {
2192 /* Maybe it can talk to us, though we can't talk to it.
2193 * (Includes HNP test device.)
2195 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2196 err = usb_port_suspend(udev, PMSG_SUSPEND);
2198 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2210 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2211 * @udev: newly addressed device (in ADDRESS state)
2213 * This is only called by usb_new_device() and usb_authorize_device()
2214 * and FIXME -- all comments that apply to them apply here wrt to
2217 * If the device is WUSB and not authorized, we don't attempt to read
2218 * the string descriptors, as they will be errored out by the device
2219 * until it has been authorized.
2221 * Return: 0 if successful. A negative error code otherwise.
2223 static int usb_enumerate_device(struct usb_device *udev)
2227 if (udev->config == NULL) {
2228 err = usb_get_configuration(udev);
2231 dev_err(&udev->dev, "can't read configurations, error %d\n",
2236 if (udev->wusb == 1 && udev->authorized == 0) {
2237 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2238 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2239 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2242 /* read the standard strings and cache them if present */
2243 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2244 udev->manufacturer = usb_cache_string(udev,
2245 udev->descriptor.iManufacturer);
2246 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2248 err = usb_enumerate_device_otg(udev);
2252 usb_detect_interface_quirks(udev);
2257 static void set_usb_port_removable(struct usb_device *udev)
2259 struct usb_device *hdev = udev->parent;
2260 struct usb_hub *hub;
2261 u8 port = udev->portnum;
2262 u16 wHubCharacteristics;
2263 bool removable = true;
2268 hub = usb_hub_to_struct_hub(udev->parent);
2270 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2272 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2275 if (hub_is_superspeed(hdev)) {
2276 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2280 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2285 udev->removable = USB_DEVICE_REMOVABLE;
2287 udev->removable = USB_DEVICE_FIXED;
2291 * usb_new_device - perform initial device setup (usbcore-internal)
2292 * @udev: newly addressed device (in ADDRESS state)
2294 * This is called with devices which have been detected but not fully
2295 * enumerated. The device descriptor is available, but not descriptors
2296 * for any device configuration. The caller must have locked either
2297 * the parent hub (if udev is a normal device) or else the
2298 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2299 * udev has already been installed, but udev is not yet visible through
2300 * sysfs or other filesystem code.
2302 * This call is synchronous, and may not be used in an interrupt context.
2304 * Only the hub driver or root-hub registrar should ever call this.
2306 * Return: Whether the device is configured properly or not. Zero if the
2307 * interface was registered with the driver core; else a negative errno
2311 int usb_new_device(struct usb_device *udev)
2316 /* Initialize non-root-hub device wakeup to disabled;
2317 * device (un)configuration controls wakeup capable
2318 * sysfs power/wakeup controls wakeup enabled/disabled
2320 device_init_wakeup(&udev->dev, 0);
2323 /* Tell the runtime-PM framework the device is active */
2324 pm_runtime_set_active(&udev->dev);
2325 pm_runtime_get_noresume(&udev->dev);
2326 pm_runtime_use_autosuspend(&udev->dev);
2327 pm_runtime_enable(&udev->dev);
2329 /* By default, forbid autosuspend for all devices. It will be
2330 * allowed for hubs during binding.
2332 usb_disable_autosuspend(udev);
2334 err = usb_enumerate_device(udev); /* Read descriptors */
2337 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2338 udev->devnum, udev->bus->busnum,
2339 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2340 /* export the usbdev device-node for libusb */
2341 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2342 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2344 /* Tell the world! */
2345 announce_device(udev);
2348 add_device_randomness(udev->serial, strlen(udev->serial));
2350 add_device_randomness(udev->product, strlen(udev->product));
2351 if (udev->manufacturer)
2352 add_device_randomness(udev->manufacturer,
2353 strlen(udev->manufacturer));
2355 device_enable_async_suspend(&udev->dev);
2358 * check whether the hub marks this port as non-removable. Do it
2359 * now so that platform-specific data can override it in
2363 set_usb_port_removable(udev);
2365 /* Register the device. The device driver is responsible
2366 * for configuring the device and invoking the add-device
2367 * notifier chain (used by usbfs and possibly others).
2369 err = device_add(&udev->dev);
2371 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2375 /* Create link files between child device and usb port device. */
2377 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2378 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2380 err = sysfs_create_link(&udev->dev.kobj,
2381 &port_dev->dev.kobj, "port");
2385 err = sysfs_create_link(&port_dev->dev.kobj,
2386 &udev->dev.kobj, "device");
2388 sysfs_remove_link(&udev->dev.kobj, "port");
2392 pm_runtime_get_sync(&port_dev->dev);
2395 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2396 usb_mark_last_busy(udev);
2397 pm_runtime_put_sync_autosuspend(&udev->dev);
2401 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2402 pm_runtime_disable(&udev->dev);
2403 pm_runtime_set_suspended(&udev->dev);
2409 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2410 * @usb_dev: USB device
2412 * Move the USB device to a very basic state where interfaces are disabled
2413 * and the device is in fact unconfigured and unusable.
2415 * We share a lock (that we have) with device_del(), so we need to
2420 int usb_deauthorize_device(struct usb_device *usb_dev)
2422 usb_lock_device(usb_dev);
2423 if (usb_dev->authorized == 0)
2424 goto out_unauthorized;
2426 usb_dev->authorized = 0;
2427 usb_set_configuration(usb_dev, -1);
2429 kfree(usb_dev->product);
2430 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2431 kfree(usb_dev->manufacturer);
2432 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2433 kfree(usb_dev->serial);
2434 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2436 usb_destroy_configuration(usb_dev);
2437 usb_dev->descriptor.bNumConfigurations = 0;
2440 usb_unlock_device(usb_dev);
2445 int usb_authorize_device(struct usb_device *usb_dev)
2449 usb_lock_device(usb_dev);
2450 if (usb_dev->authorized == 1)
2451 goto out_authorized;
2453 result = usb_autoresume_device(usb_dev);
2455 dev_err(&usb_dev->dev,
2456 "can't autoresume for authorization: %d\n", result);
2457 goto error_autoresume;
2459 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2461 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2462 "authorization: %d\n", result);
2463 goto error_device_descriptor;
2466 kfree(usb_dev->product);
2467 usb_dev->product = NULL;
2468 kfree(usb_dev->manufacturer);
2469 usb_dev->manufacturer = NULL;
2470 kfree(usb_dev->serial);
2471 usb_dev->serial = NULL;
2473 usb_dev->authorized = 1;
2474 result = usb_enumerate_device(usb_dev);
2476 goto error_enumerate;
2477 /* Choose and set the configuration. This registers the interfaces
2478 * with the driver core and lets interface drivers bind to them.
2480 c = usb_choose_configuration(usb_dev);
2482 result = usb_set_configuration(usb_dev, c);
2484 dev_err(&usb_dev->dev,
2485 "can't set config #%d, error %d\n", c, result);
2486 /* This need not be fatal. The user can try to
2487 * set other configurations. */
2490 dev_info(&usb_dev->dev, "authorized to connect\n");
2493 error_device_descriptor:
2494 usb_autosuspend_device(usb_dev);
2497 usb_unlock_device(usb_dev); // complements locktree
2502 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2503 static unsigned hub_is_wusb(struct usb_hub *hub)
2505 struct usb_hcd *hcd;
2506 if (hub->hdev->parent != NULL) /* not a root hub? */
2508 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2509 return hcd->wireless;
2513 #define PORT_RESET_TRIES 5
2514 #define SET_ADDRESS_TRIES 2
2515 #define GET_DESCRIPTOR_TRIES 2
2516 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2517 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2519 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2520 #define HUB_SHORT_RESET_TIME 10
2521 #define HUB_BH_RESET_TIME 50
2522 #define HUB_LONG_RESET_TIME 200
2523 #define HUB_RESET_TIMEOUT 800
2525 static int hub_port_reset(struct usb_hub *hub, int port1,
2526 struct usb_device *udev, unsigned int delay, bool warm);
2528 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2529 * Port worm reset is required to recover
2531 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2533 return hub_is_superspeed(hub->hdev) &&
2534 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2535 USB_SS_PORT_LS_SS_INACTIVE) ||
2536 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2537 USB_SS_PORT_LS_COMP_MOD)) ;
2540 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2541 struct usb_device *udev, unsigned int delay, bool warm)
2543 int delay_time, ret;
2547 for (delay_time = 0;
2548 delay_time < HUB_RESET_TIMEOUT;
2549 delay_time += delay) {
2550 /* wait to give the device a chance to reset */
2553 /* read and decode port status */
2554 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2558 /* The port state is unknown until the reset completes. */
2559 if (!(portstatus & USB_PORT_STAT_RESET))
2562 /* switch to the long delay after two short delay failures */
2563 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2564 delay = HUB_LONG_RESET_TIME;
2566 dev_dbg (hub->intfdev,
2567 "port %d not %sreset yet, waiting %dms\n",
2568 port1, warm ? "warm " : "", delay);
2571 if ((portstatus & USB_PORT_STAT_RESET))
2574 if (hub_port_warm_reset_required(hub, portstatus))
2577 /* Device went away? */
2578 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2581 /* bomb out completely if the connection bounced. A USB 3.0
2582 * connection may bounce if multiple warm resets were issued,
2583 * but the device may have successfully re-connected. Ignore it.
2585 if (!hub_is_superspeed(hub->hdev) &&
2586 (portchange & USB_PORT_STAT_C_CONNECTION))
2589 if (!(portstatus & USB_PORT_STAT_ENABLE))
2595 if (hub_is_wusb(hub))
2596 udev->speed = USB_SPEED_WIRELESS;
2597 else if (hub_is_superspeed(hub->hdev))
2598 udev->speed = USB_SPEED_SUPER;
2599 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2600 udev->speed = USB_SPEED_HIGH;
2601 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2602 udev->speed = USB_SPEED_LOW;
2604 udev->speed = USB_SPEED_FULL;
2608 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2609 struct usb_device *udev, int *status)
2613 /* TRSTRCY = 10 ms; plus some extra */
2616 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2618 update_devnum(udev, 0);
2619 /* The xHC may think the device is already reset,
2620 * so ignore the status.
2622 if (hcd->driver->reset_device)
2623 hcd->driver->reset_device(hcd, udev);
2628 usb_clear_port_feature(hub->hdev,
2629 port1, USB_PORT_FEAT_C_RESET);
2630 if (hub_is_superspeed(hub->hdev)) {
2631 usb_clear_port_feature(hub->hdev, port1,
2632 USB_PORT_FEAT_C_BH_PORT_RESET);
2633 usb_clear_port_feature(hub->hdev, port1,
2634 USB_PORT_FEAT_C_PORT_LINK_STATE);
2635 usb_clear_port_feature(hub->hdev, port1,
2636 USB_PORT_FEAT_C_CONNECTION);
2639 usb_set_device_state(udev, *status
2640 ? USB_STATE_NOTATTACHED
2641 : USB_STATE_DEFAULT);
2646 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2647 static int hub_port_reset(struct usb_hub *hub, int port1,
2648 struct usb_device *udev, unsigned int delay, bool warm)
2651 u16 portchange, portstatus;
2653 if (!hub_is_superspeed(hub->hdev)) {
2655 dev_err(hub->intfdev, "only USB3 hub support "
2659 /* Block EHCI CF initialization during the port reset.
2660 * Some companion controllers don't like it when they mix.
2662 down_read(&ehci_cf_port_reset_rwsem);
2665 * If the caller hasn't explicitly requested a warm reset,
2666 * double check and see if one is needed.
2668 status = hub_port_status(hub, port1,
2669 &portstatus, &portchange);
2673 if (hub_port_warm_reset_required(hub, portstatus))
2677 /* Reset the port */
2678 for (i = 0; i < PORT_RESET_TRIES; i++) {
2679 status = set_port_feature(hub->hdev, port1, (warm ?
2680 USB_PORT_FEAT_BH_PORT_RESET :
2681 USB_PORT_FEAT_RESET));
2682 if (status == -ENODEV) {
2683 ; /* The hub is gone */
2684 } else if (status) {
2685 dev_err(hub->intfdev,
2686 "cannot %sreset port %d (err = %d)\n",
2687 warm ? "warm " : "", port1, status);
2689 status = hub_port_wait_reset(hub, port1, udev, delay,
2691 if (status && status != -ENOTCONN && status != -ENODEV)
2692 dev_dbg(hub->intfdev,
2693 "port_wait_reset: err = %d\n",
2697 /* Check for disconnect or reset */
2698 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2699 hub_port_finish_reset(hub, port1, udev, &status);
2701 if (!hub_is_superspeed(hub->hdev))
2705 * If a USB 3.0 device migrates from reset to an error
2706 * state, re-issue the warm reset.
2708 if (hub_port_status(hub, port1,
2709 &portstatus, &portchange) < 0)
2712 if (!hub_port_warm_reset_required(hub, portstatus))
2716 * If the port is in SS.Inactive or Compliance Mode, the
2717 * hot or warm reset failed. Try another warm reset.
2720 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2726 dev_dbg (hub->intfdev,
2727 "port %d not enabled, trying %sreset again...\n",
2728 port1, warm ? "warm " : "");
2729 delay = HUB_LONG_RESET_TIME;
2732 dev_err (hub->intfdev,
2733 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2737 if (!hub_is_superspeed(hub->hdev))
2738 up_read(&ehci_cf_port_reset_rwsem);
2743 /* Check if a port is power on */
2744 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2748 if (hub_is_superspeed(hub->hdev)) {
2749 if (portstatus & USB_SS_PORT_STAT_POWER)
2752 if (portstatus & USB_PORT_STAT_POWER)
2761 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2762 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2766 if (hub_is_superspeed(hub->hdev)) {
2767 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2768 == USB_SS_PORT_LS_U3)
2771 if (portstatus & USB_PORT_STAT_SUSPEND)
2778 /* Determine whether the device on a port is ready for a normal resume,
2779 * is ready for a reset-resume, or should be disconnected.
2781 static int check_port_resume_type(struct usb_device *udev,
2782 struct usb_hub *hub, int port1,
2783 int status, unsigned portchange, unsigned portstatus)
2785 /* Is the device still present? */
2786 if (status || port_is_suspended(hub, portstatus) ||
2787 !port_is_power_on(hub, portstatus) ||
2788 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2793 /* Can't do a normal resume if the port isn't enabled,
2794 * so try a reset-resume instead.
2796 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2797 if (udev->persist_enabled)
2798 udev->reset_resume = 1;
2804 dev_dbg(hub->intfdev,
2805 "port %d status %04x.%04x after resume, %d\n",
2806 port1, portchange, portstatus, status);
2807 } else if (udev->reset_resume) {
2809 /* Late port handoff can set status-change bits */
2810 if (portchange & USB_PORT_STAT_C_CONNECTION)
2811 usb_clear_port_feature(hub->hdev, port1,
2812 USB_PORT_FEAT_C_CONNECTION);
2813 if (portchange & USB_PORT_STAT_C_ENABLE)
2814 usb_clear_port_feature(hub->hdev, port1,
2815 USB_PORT_FEAT_C_ENABLE);
2821 int usb_disable_ltm(struct usb_device *udev)
2823 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2825 /* Check if the roothub and device supports LTM. */
2826 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2827 !usb_device_supports_ltm(udev))
2830 /* Clear Feature LTM Enable can only be sent if the device is
2833 if (!udev->actconfig)
2836 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2837 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2838 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2839 USB_CTRL_SET_TIMEOUT);
2841 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2843 void usb_enable_ltm(struct usb_device *udev)
2845 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2847 /* Check if the roothub and device supports LTM. */
2848 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2849 !usb_device_supports_ltm(udev))
2852 /* Set Feature LTM Enable can only be sent if the device is
2855 if (!udev->actconfig)
2858 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2859 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2860 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2861 USB_CTRL_SET_TIMEOUT);
2863 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2866 * usb_enable_remote_wakeup - enable remote wakeup for a device
2867 * @udev: target device
2869 * For USB-2 devices: Set the device's remote wakeup feature.
2871 * For USB-3 devices: Assume there's only one function on the device and
2872 * enable remote wake for the first interface. FIXME if the interface
2873 * association descriptor shows there's more than one function.
2875 static int usb_enable_remote_wakeup(struct usb_device *udev)
2877 if (udev->speed < USB_SPEED_SUPER)
2878 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2879 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2880 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2881 USB_CTRL_SET_TIMEOUT);
2883 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2884 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2885 USB_INTRF_FUNC_SUSPEND,
2886 USB_INTRF_FUNC_SUSPEND_RW |
2887 USB_INTRF_FUNC_SUSPEND_LP,
2888 NULL, 0, USB_CTRL_SET_TIMEOUT);
2892 * usb_disable_remote_wakeup - disable remote wakeup for a device
2893 * @udev: target device
2895 * For USB-2 devices: Clear the device's remote wakeup feature.
2897 * For USB-3 devices: Assume there's only one function on the device and
2898 * disable remote wake for the first interface. FIXME if the interface
2899 * association descriptor shows there's more than one function.
2901 static int usb_disable_remote_wakeup(struct usb_device *udev)
2903 if (udev->speed < USB_SPEED_SUPER)
2904 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2905 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2906 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2907 USB_CTRL_SET_TIMEOUT);
2909 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2910 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
2911 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
2912 USB_CTRL_SET_TIMEOUT);
2915 /* Count of wakeup-enabled devices at or below udev */
2916 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
2918 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2920 return udev->do_remote_wakeup +
2921 (hub ? hub->wakeup_enabled_descendants : 0);
2925 * usb_port_suspend - suspend a usb device's upstream port
2926 * @udev: device that's no longer in active use, not a root hub
2927 * Context: must be able to sleep; device not locked; pm locks held
2929 * Suspends a USB device that isn't in active use, conserving power.
2930 * Devices may wake out of a suspend, if anything important happens,
2931 * using the remote wakeup mechanism. They may also be taken out of
2932 * suspend by the host, using usb_port_resume(). It's also routine
2933 * to disconnect devices while they are suspended.
2935 * This only affects the USB hardware for a device; its interfaces
2936 * (and, for hubs, child devices) must already have been suspended.
2938 * Selective port suspend reduces power; most suspended devices draw
2939 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2940 * All devices below the suspended port are also suspended.
2942 * Devices leave suspend state when the host wakes them up. Some devices
2943 * also support "remote wakeup", where the device can activate the USB
2944 * tree above them to deliver data, such as a keypress or packet. In
2945 * some cases, this wakes the USB host.
2947 * Suspending OTG devices may trigger HNP, if that's been enabled
2948 * between a pair of dual-role devices. That will change roles, such
2949 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2951 * Devices on USB hub ports have only one "suspend" state, corresponding
2952 * to ACPI D2, "may cause the device to lose some context".
2953 * State transitions include:
2955 * - suspend, resume ... when the VBUS power link stays live
2956 * - suspend, disconnect ... VBUS lost
2958 * Once VBUS drop breaks the circuit, the port it's using has to go through
2959 * normal re-enumeration procedures, starting with enabling VBUS power.
2960 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2961 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2962 * timer, no SRP, no requests through sysfs.
2964 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
2965 * suspended until their bus goes into global suspend (i.e., the root
2966 * hub is suspended). Nevertheless, we change @udev->state to
2967 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
2968 * upstream port setting is stored in @udev->port_is_suspended.
2970 * Returns 0 on success, else negative errno.
2972 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2974 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2975 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2976 int port1 = udev->portnum;
2978 bool really_suspend = true;
2980 /* enable remote wakeup when appropriate; this lets the device
2981 * wake up the upstream hub (including maybe the root hub).
2983 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2984 * we don't explicitly enable it here.
2986 if (udev->do_remote_wakeup) {
2987 status = usb_enable_remote_wakeup(udev);
2989 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2991 /* bail if autosuspend is requested */
2992 if (PMSG_IS_AUTO(msg))
2997 /* disable USB2 hardware LPM */
2998 if (udev->usb2_hw_lpm_enabled == 1)
2999 usb_set_usb2_hardware_lpm(udev, 0);
3001 if (usb_disable_ltm(udev)) {
3002 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3004 if (PMSG_IS_AUTO(msg))
3007 if (usb_unlocked_disable_lpm(udev)) {
3008 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3010 if (PMSG_IS_AUTO(msg))
3015 if (hub_is_superspeed(hub->hdev))
3016 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3019 * For system suspend, we do not need to enable the suspend feature
3020 * on individual USB-2 ports. The devices will automatically go
3021 * into suspend a few ms after the root hub stops sending packets.
3022 * The USB 2.0 spec calls this "global suspend".
3024 * However, many USB hubs have a bug: They don't relay wakeup requests
3025 * from a downstream port if the port's suspend feature isn't on.
3026 * Therefore we will turn on the suspend feature if udev or any of its
3027 * descendants is enabled for remote wakeup.
3029 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3030 status = set_port_feature(hub->hdev, port1,
3031 USB_PORT_FEAT_SUSPEND);
3033 really_suspend = false;
3037 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3040 /* Try to enable USB3 LPM and LTM again */
3041 usb_unlocked_enable_lpm(udev);
3043 usb_enable_ltm(udev);
3045 /* Try to enable USB2 hardware LPM again */
3046 if (udev->usb2_hw_lpm_capable == 1)
3047 usb_set_usb2_hardware_lpm(udev, 1);
3049 if (udev->do_remote_wakeup)
3050 (void) usb_disable_remote_wakeup(udev);
3053 /* System sleep transitions should never fail */
3054 if (!PMSG_IS_AUTO(msg))
3057 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3058 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3059 udev->do_remote_wakeup);
3060 if (really_suspend) {
3061 udev->port_is_suspended = 1;
3063 /* device has up to 10 msec to fully suspend */
3066 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3069 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3070 pm_runtime_put_sync(&port_dev->dev);
3071 port_dev->did_runtime_put = true;
3074 usb_mark_last_busy(hub->hdev);
3079 * If the USB "suspend" state is in use (rather than "global suspend"),
3080 * many devices will be individually taken out of suspend state using
3081 * special "resume" signaling. This routine kicks in shortly after
3082 * hardware resume signaling is finished, either because of selective
3083 * resume (by host) or remote wakeup (by device) ... now see what changed
3084 * in the tree that's rooted at this device.
3086 * If @udev->reset_resume is set then the device is reset before the
3087 * status check is done.
3089 static int finish_port_resume(struct usb_device *udev)
3094 /* caller owns the udev device lock */
3095 dev_dbg(&udev->dev, "%s\n",
3096 udev->reset_resume ? "finish reset-resume" : "finish resume");
3098 /* usb ch9 identifies four variants of SUSPENDED, based on what
3099 * state the device resumes to. Linux currently won't see the
3100 * first two on the host side; they'd be inside hub_port_init()
3101 * during many timeouts, but khubd can't suspend until later.
3103 usb_set_device_state(udev, udev->actconfig
3104 ? USB_STATE_CONFIGURED
3105 : USB_STATE_ADDRESS);
3107 /* 10.5.4.5 says not to reset a suspended port if the attached
3108 * device is enabled for remote wakeup. Hence the reset
3109 * operation is carried out here, after the port has been
3112 if (udev->reset_resume)
3114 status = usb_reset_and_verify_device(udev);
3116 /* 10.5.4.5 says be sure devices in the tree are still there.
3117 * For now let's assume the device didn't go crazy on resume,
3118 * and device drivers will know about any resume quirks.
3122 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3124 /* If a normal resume failed, try doing a reset-resume */
3125 if (status && !udev->reset_resume && udev->persist_enabled) {
3126 dev_dbg(&udev->dev, "retry with reset-resume\n");
3127 udev->reset_resume = 1;
3128 goto retry_reset_resume;
3133 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3136 * There are a few quirky devices which violate the standard
3137 * by claiming to have remote wakeup enabled after a reset,
3138 * which crash if the feature is cleared, hence check for
3139 * udev->reset_resume
3141 } else if (udev->actconfig && !udev->reset_resume) {
3142 if (udev->speed < USB_SPEED_SUPER) {
3143 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3144 status = usb_disable_remote_wakeup(udev);
3146 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3148 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3149 | USB_INTRF_STAT_FUNC_RW))
3150 status = usb_disable_remote_wakeup(udev);
3155 "disable remote wakeup, status %d\n",
3163 * usb_port_resume - re-activate a suspended usb device's upstream port
3164 * @udev: device to re-activate, not a root hub
3165 * Context: must be able to sleep; device not locked; pm locks held
3167 * This will re-activate the suspended device, increasing power usage
3168 * while letting drivers communicate again with its endpoints.
3169 * USB resume explicitly guarantees that the power session between
3170 * the host and the device is the same as it was when the device
3173 * If @udev->reset_resume is set then this routine won't check that the
3174 * port is still enabled. Furthermore, finish_port_resume() above will
3175 * reset @udev. The end result is that a broken power session can be
3176 * recovered and @udev will appear to persist across a loss of VBUS power.
3178 * For example, if a host controller doesn't maintain VBUS suspend current
3179 * during a system sleep or is reset when the system wakes up, all the USB
3180 * power sessions below it will be broken. This is especially troublesome
3181 * for mass-storage devices containing mounted filesystems, since the
3182 * device will appear to have disconnected and all the memory mappings
3183 * to it will be lost. Using the USB_PERSIST facility, the device can be
3184 * made to appear as if it had not disconnected.
3186 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3187 * every effort to insure that the same device is present after the
3188 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3189 * quite possible for a device to remain unaltered but its media to be
3190 * changed. If the user replaces a flash memory card while the system is
3191 * asleep, he will have only himself to blame when the filesystem on the
3192 * new card is corrupted and the system crashes.
3194 * Returns 0 on success, else negative errno.
3196 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3198 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3199 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3200 int port1 = udev->portnum;
3202 u16 portchange, portstatus;
3204 if (port_dev->did_runtime_put) {
3205 status = pm_runtime_get_sync(&port_dev->dev);
3206 port_dev->did_runtime_put = false;
3208 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3214 /* Skip the initial Clear-Suspend step for a remote wakeup */
3215 status = hub_port_status(hub, port1, &portstatus, &portchange);
3216 if (status == 0 && !port_is_suspended(hub, portstatus))
3217 goto SuspendCleared;
3219 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3221 set_bit(port1, hub->busy_bits);
3223 /* see 7.1.7.7; affects power usage, but not budgeting */
3224 if (hub_is_superspeed(hub->hdev))
3225 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3227 status = usb_clear_port_feature(hub->hdev,
3228 port1, USB_PORT_FEAT_SUSPEND);
3230 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3233 /* drive resume for at least 20 msec */
3234 dev_dbg(&udev->dev, "usb %sresume\n",
3235 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3238 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3239 * stop resume signaling. Then finish the resume
3242 status = hub_port_status(hub, port1, &portstatus, &portchange);
3244 /* TRSMRCY = 10 msec */
3250 udev->port_is_suspended = 0;
3251 if (hub_is_superspeed(hub->hdev)) {
3252 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3253 usb_clear_port_feature(hub->hdev, port1,
3254 USB_PORT_FEAT_C_PORT_LINK_STATE);
3256 if (portchange & USB_PORT_STAT_C_SUSPEND)
3257 usb_clear_port_feature(hub->hdev, port1,
3258 USB_PORT_FEAT_C_SUSPEND);
3262 clear_bit(port1, hub->busy_bits);
3264 status = check_port_resume_type(udev,
3265 hub, port1, status, portchange, portstatus);
3267 status = finish_port_resume(udev);
3269 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3270 hub_port_logical_disconnect(hub, port1);
3272 /* Try to enable USB2 hardware LPM */
3273 if (udev->usb2_hw_lpm_capable == 1)
3274 usb_set_usb2_hardware_lpm(udev, 1);
3276 /* Try to enable USB3 LTM and LPM */
3277 usb_enable_ltm(udev);
3278 usb_unlocked_enable_lpm(udev);
3284 #ifdef CONFIG_PM_RUNTIME
3286 /* caller has locked udev */
3287 int usb_remote_wakeup(struct usb_device *udev)
3291 if (udev->state == USB_STATE_SUSPENDED) {
3292 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3293 status = usb_autoresume_device(udev);
3295 /* Let the drivers do their thing, then... */
3296 usb_autosuspend_device(udev);
3304 static int check_ports_changed(struct usb_hub *hub)
3308 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3309 u16 portstatus, portchange;
3312 status = hub_port_status(hub, port1, &portstatus, &portchange);
3313 if (!status && portchange)
3319 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3321 struct usb_hub *hub = usb_get_intfdata (intf);
3322 struct usb_device *hdev = hub->hdev;
3327 * Warn if children aren't already suspended.
3328 * Also, add up the number of wakeup-enabled descendants.
3330 hub->wakeup_enabled_descendants = 0;
3331 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3332 struct usb_device *udev;
3334 udev = hub->ports[port1 - 1]->child;
3335 if (udev && udev->can_submit) {
3336 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3337 if (PMSG_IS_AUTO(msg))
3341 hub->wakeup_enabled_descendants +=
3342 wakeup_enabled_descendants(udev);
3345 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3346 /* check if there are changes pending on hub ports */
3347 if (check_ports_changed(hub)) {
3348 if (PMSG_IS_AUTO(msg))
3350 pm_wakeup_event(&hdev->dev, 2000);
3354 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3355 /* Enable hub to send remote wakeup for all ports. */
3356 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3357 status = set_port_feature(hdev,
3359 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3360 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3361 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3362 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3366 dev_dbg(&intf->dev, "%s\n", __func__);
3368 /* stop khubd and related activity */
3369 hub_quiesce(hub, HUB_SUSPEND);
3373 static int hub_resume(struct usb_interface *intf)
3375 struct usb_hub *hub = usb_get_intfdata(intf);
3377 dev_dbg(&intf->dev, "%s\n", __func__);
3378 hub_activate(hub, HUB_RESUME);
3382 static int hub_reset_resume(struct usb_interface *intf)
3384 struct usb_hub *hub = usb_get_intfdata(intf);
3386 dev_dbg(&intf->dev, "%s\n", __func__);
3387 hub_activate(hub, HUB_RESET_RESUME);
3392 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3393 * @rhdev: struct usb_device for the root hub
3395 * The USB host controller driver calls this function when its root hub
3396 * is resumed and Vbus power has been interrupted or the controller
3397 * has been reset. The routine marks @rhdev as having lost power.
3398 * When the hub driver is resumed it will take notice and carry out
3399 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3400 * the others will be disconnected.
3402 void usb_root_hub_lost_power(struct usb_device *rhdev)
3404 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3405 rhdev->reset_resume = 1;
3407 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3409 static const char * const usb3_lpm_names[] = {
3417 * Send a Set SEL control transfer to the device, prior to enabling
3418 * device-initiated U1 or U2. This lets the device know the exit latencies from
3419 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3420 * packet from the host.
3422 * This function will fail if the SEL or PEL values for udev are greater than
3423 * the maximum allowed values for the link state to be enabled.
3425 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3427 struct usb_set_sel_req *sel_values;
3428 unsigned long long u1_sel;
3429 unsigned long long u1_pel;
3430 unsigned long long u2_sel;
3431 unsigned long long u2_pel;
3434 /* Convert SEL and PEL stored in ns to us */
3435 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3436 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3437 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3438 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3441 * Make sure that the calculated SEL and PEL values for the link
3442 * state we're enabling aren't bigger than the max SEL/PEL
3443 * value that will fit in the SET SEL control transfer.
3444 * Otherwise the device would get an incorrect idea of the exit
3445 * latency for the link state, and could start a device-initiated
3446 * U1/U2 when the exit latencies are too high.
3448 if ((state == USB3_LPM_U1 &&
3449 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3450 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3451 (state == USB3_LPM_U2 &&
3452 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3453 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3454 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3455 usb3_lpm_names[state], u1_sel, u1_pel);
3460 * If we're enabling device-initiated LPM for one link state,
3461 * but the other link state has a too high SEL or PEL value,
3462 * just set those values to the max in the Set SEL request.
3464 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3465 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3467 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3468 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3470 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3471 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3473 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3474 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3477 * usb_enable_lpm() can be called as part of a failed device reset,
3478 * which may be initiated by an error path of a mass storage driver.
3479 * Therefore, use GFP_NOIO.
3481 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3485 sel_values->u1_sel = u1_sel;
3486 sel_values->u1_pel = u1_pel;
3487 sel_values->u2_sel = cpu_to_le16(u2_sel);
3488 sel_values->u2_pel = cpu_to_le16(u2_pel);
3490 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3494 sel_values, sizeof *(sel_values),
3495 USB_CTRL_SET_TIMEOUT);
3501 * Enable or disable device-initiated U1 or U2 transitions.
3503 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3504 enum usb3_link_state state, bool enable)
3511 feature = USB_DEVICE_U1_ENABLE;
3514 feature = USB_DEVICE_U2_ENABLE;
3517 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3518 __func__, enable ? "enable" : "disable");
3522 if (udev->state != USB_STATE_CONFIGURED) {
3523 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3524 "for unconfigured device.\n",
3525 __func__, enable ? "enable" : "disable",
3526 usb3_lpm_names[state]);
3532 * Now send the control transfer to enable device-initiated LPM
3533 * for either U1 or U2.
3535 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3536 USB_REQ_SET_FEATURE,
3540 USB_CTRL_SET_TIMEOUT);
3542 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3543 USB_REQ_CLEAR_FEATURE,
3547 USB_CTRL_SET_TIMEOUT);
3550 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3551 enable ? "Enable" : "Disable",
3552 usb3_lpm_names[state]);
3558 static int usb_set_lpm_timeout(struct usb_device *udev,
3559 enum usb3_link_state state, int timeout)
3566 feature = USB_PORT_FEAT_U1_TIMEOUT;
3569 feature = USB_PORT_FEAT_U2_TIMEOUT;
3572 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3577 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3578 timeout != USB3_LPM_DEVICE_INITIATED) {
3579 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3580 "which is a reserved value.\n",
3581 usb3_lpm_names[state], timeout);
3585 ret = set_port_feature(udev->parent,
3586 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3589 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3590 "error code %i\n", usb3_lpm_names[state],
3594 if (state == USB3_LPM_U1)
3595 udev->u1_params.timeout = timeout;
3597 udev->u2_params.timeout = timeout;
3602 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3605 * We will attempt to enable U1 or U2, but there are no guarantees that the
3606 * control transfers to set the hub timeout or enable device-initiated U1/U2
3607 * will be successful.
3609 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3610 * driver know about it. If that call fails, it should be harmless, and just
3611 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3613 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3614 enum usb3_link_state state)
3617 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3618 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3620 /* If the device says it doesn't have *any* exit latency to come out of
3621 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3624 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3625 (state == USB3_LPM_U2 && u2_mel == 0))
3629 * First, let the device know about the exit latencies
3630 * associated with the link state we're about to enable.
3632 ret = usb_req_set_sel(udev, state);
3634 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3635 usb3_lpm_names[state]);
3639 /* We allow the host controller to set the U1/U2 timeout internally
3640 * first, so that it can change its schedule to account for the
3641 * additional latency to send data to a device in a lower power
3644 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3646 /* xHCI host controller doesn't want to enable this LPM state. */
3651 dev_warn(&udev->dev, "Could not enable %s link state, "
3652 "xHCI error %i.\n", usb3_lpm_names[state],
3657 if (usb_set_lpm_timeout(udev, state, timeout))
3658 /* If we can't set the parent hub U1/U2 timeout,
3659 * device-initiated LPM won't be allowed either, so let the xHCI
3660 * host know that this link state won't be enabled.
3662 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3664 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3665 else if (udev->actconfig)
3666 usb_set_device_initiated_lpm(udev, state, true);
3671 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3674 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3675 * If zero is returned, the parent will not allow the link to go into U1/U2.
3677 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3678 * it won't have an effect on the bus link state because the parent hub will
3679 * still disallow device-initiated U1/U2 entry.
3681 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3682 * possible. The result will be slightly more bus bandwidth will be taken up
3683 * (to account for U1/U2 exit latency), but it should be harmless.
3685 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3686 enum usb3_link_state state)
3692 feature = USB_PORT_FEAT_U1_TIMEOUT;
3695 feature = USB_PORT_FEAT_U2_TIMEOUT;
3698 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3703 if (usb_set_lpm_timeout(udev, state, 0))
3706 usb_set_device_initiated_lpm(udev, state, false);
3708 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3709 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3710 "bus schedule bandwidth may be impacted.\n",
3711 usb3_lpm_names[state]);
3716 * Disable hub-initiated and device-initiated U1 and U2 entry.
3717 * Caller must own the bandwidth_mutex.
3719 * This will call usb_enable_lpm() on failure, which will decrement
3720 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3722 int usb_disable_lpm(struct usb_device *udev)
3724 struct usb_hcd *hcd;
3726 if (!udev || !udev->parent ||
3727 udev->speed != USB_SPEED_SUPER ||
3731 hcd = bus_to_hcd(udev->bus);
3732 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3735 udev->lpm_disable_count++;
3736 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3739 /* If LPM is enabled, attempt to disable it. */
3740 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3742 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3748 usb_enable_lpm(udev);
3751 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3753 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3754 int usb_unlocked_disable_lpm(struct usb_device *udev)
3756 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3762 mutex_lock(hcd->bandwidth_mutex);
3763 ret = usb_disable_lpm(udev);
3764 mutex_unlock(hcd->bandwidth_mutex);
3768 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3771 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3772 * xHCI host policy may prevent U1 or U2 from being enabled.
3774 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3775 * until the lpm_disable_count drops to zero. Caller must own the
3778 void usb_enable_lpm(struct usb_device *udev)
3780 struct usb_hcd *hcd;
3782 if (!udev || !udev->parent ||
3783 udev->speed != USB_SPEED_SUPER ||
3787 udev->lpm_disable_count--;
3788 hcd = bus_to_hcd(udev->bus);
3789 /* Double check that we can both enable and disable LPM.
3790 * Device must be configured to accept set feature U1/U2 timeout.
3792 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3793 !hcd->driver->disable_usb3_lpm_timeout)
3796 if (udev->lpm_disable_count > 0)
3799 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3800 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3802 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3804 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3805 void usb_unlocked_enable_lpm(struct usb_device *udev)
3807 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3812 mutex_lock(hcd->bandwidth_mutex);
3813 usb_enable_lpm(udev);
3814 mutex_unlock(hcd->bandwidth_mutex);
3816 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3819 #else /* CONFIG_PM */
3821 #define hub_suspend NULL
3822 #define hub_resume NULL
3823 #define hub_reset_resume NULL
3825 int usb_disable_lpm(struct usb_device *udev)
3829 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3831 void usb_enable_lpm(struct usb_device *udev) { }
3832 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3834 int usb_unlocked_disable_lpm(struct usb_device *udev)
3838 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3840 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3841 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3843 int usb_disable_ltm(struct usb_device *udev)
3847 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3849 void usb_enable_ltm(struct usb_device *udev) { }
3850 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3852 #endif /* CONFIG_PM */
3855 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3857 * Between connect detection and reset signaling there must be a delay
3858 * of 100ms at least for debounce and power-settling. The corresponding
3859 * timer shall restart whenever the downstream port detects a disconnect.
3861 * Apparently there are some bluetooth and irda-dongles and a number of
3862 * low-speed devices for which this debounce period may last over a second.
3863 * Not covered by the spec - but easy to deal with.
3865 * This implementation uses a 1500ms total debounce timeout; if the
3866 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3867 * every 25ms for transient disconnects. When the port status has been
3868 * unchanged for 100ms it returns the port status.
3870 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
3873 int total_time, stable_time = 0;
3874 u16 portchange, portstatus;
3875 unsigned connection = 0xffff;
3877 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3878 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3882 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3883 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3884 if (!must_be_connected ||
3885 (connection == USB_PORT_STAT_CONNECTION))
3886 stable_time += HUB_DEBOUNCE_STEP;
3887 if (stable_time >= HUB_DEBOUNCE_STABLE)
3891 connection = portstatus & USB_PORT_STAT_CONNECTION;
3894 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3895 usb_clear_port_feature(hub->hdev, port1,
3896 USB_PORT_FEAT_C_CONNECTION);
3899 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3901 msleep(HUB_DEBOUNCE_STEP);
3904 dev_dbg (hub->intfdev,
3905 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3906 port1, total_time, stable_time, portstatus);
3908 if (stable_time < HUB_DEBOUNCE_STABLE)
3913 void usb_ep0_reinit(struct usb_device *udev)
3915 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3916 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3917 usb_enable_endpoint(udev, &udev->ep0, true);
3919 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3921 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3922 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3924 static int hub_set_address(struct usb_device *udev, int devnum)
3927 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3930 * The host controller will choose the device address,
3931 * instead of the core having chosen it earlier
3933 if (!hcd->driver->address_device && devnum <= 1)
3935 if (udev->state == USB_STATE_ADDRESS)
3937 if (udev->state != USB_STATE_DEFAULT)
3939 if (hcd->driver->address_device)
3940 retval = hcd->driver->address_device(hcd, udev);
3942 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3943 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3944 NULL, 0, USB_CTRL_SET_TIMEOUT);
3946 update_devnum(udev, devnum);
3947 /* Device now using proper address. */
3948 usb_set_device_state(udev, USB_STATE_ADDRESS);
3949 usb_ep0_reinit(udev);
3954 /* Reset device, (re)assign address, get device descriptor.
3955 * Device connection must be stable, no more debouncing needed.
3956 * Returns device in USB_STATE_ADDRESS, except on error.
3958 * If this is called for an already-existing device (as part of
3959 * usb_reset_and_verify_device), the caller must own the device lock. For a
3960 * newly detected device that is not accessible through any global
3961 * pointers, it's not necessary to lock the device.
3964 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3967 static DEFINE_MUTEX(usb_address0_mutex);
3969 struct usb_device *hdev = hub->hdev;
3970 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3972 unsigned delay = HUB_SHORT_RESET_TIME;
3973 enum usb_device_speed oldspeed = udev->speed;
3975 int devnum = udev->devnum;
3977 /* root hub ports have a slightly longer reset period
3978 * (from USB 2.0 spec, section 7.1.7.5)
3980 if (!hdev->parent) {
3981 delay = HUB_ROOT_RESET_TIME;
3982 if (port1 == hdev->bus->otg_port)
3983 hdev->bus->b_hnp_enable = 0;
3986 /* Some low speed devices have problems with the quick delay, so */
3987 /* be a bit pessimistic with those devices. RHbug #23670 */
3988 if (oldspeed == USB_SPEED_LOW)
3989 delay = HUB_LONG_RESET_TIME;
3991 mutex_lock(&usb_address0_mutex);
3993 /* Reset the device; full speed may morph to high speed */
3994 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3995 retval = hub_port_reset(hub, port1, udev, delay, false);
3996 if (retval < 0) /* error or disconnect */
3998 /* success, speed is known */
4002 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4003 dev_dbg(&udev->dev, "device reset changed speed!\n");
4006 oldspeed = udev->speed;
4008 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4009 * it's fixed size except for full speed devices.
4010 * For Wireless USB devices, ep0 max packet is always 512 (tho
4011 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4013 switch (udev->speed) {
4014 case USB_SPEED_SUPER:
4015 case USB_SPEED_WIRELESS: /* fixed at 512 */
4016 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4018 case USB_SPEED_HIGH: /* fixed at 64 */
4019 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4021 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4022 /* to determine the ep0 maxpacket size, try to read
4023 * the device descriptor to get bMaxPacketSize0 and
4024 * then correct our initial guess.
4026 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4028 case USB_SPEED_LOW: /* fixed at 8 */
4029 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4035 if (udev->speed == USB_SPEED_WIRELESS)
4036 speed = "variable speed Wireless";
4038 speed = usb_speed_string(udev->speed);
4040 if (udev->speed != USB_SPEED_SUPER)
4041 dev_info(&udev->dev,
4042 "%s %s USB device number %d using %s\n",
4043 (udev->config) ? "reset" : "new", speed,
4044 devnum, udev->bus->controller->driver->name);
4046 /* Set up TT records, if needed */
4048 udev->tt = hdev->tt;
4049 udev->ttport = hdev->ttport;
4050 } else if (udev->speed != USB_SPEED_HIGH
4051 && hdev->speed == USB_SPEED_HIGH) {
4053 dev_err(&udev->dev, "parent hub has no TT\n");
4057 udev->tt = &hub->tt;
4058 udev->ttport = port1;
4061 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4062 * Because device hardware and firmware is sometimes buggy in
4063 * this area, and this is how Linux has done it for ages.
4064 * Change it cautiously.
4066 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4067 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4068 * so it may help with some non-standards-compliant devices.
4069 * Otherwise we start with SET_ADDRESS and then try to read the
4070 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4073 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4074 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
4075 struct usb_device_descriptor *buf;
4078 #define GET_DESCRIPTOR_BUFSIZE 64
4079 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4085 /* Retry on all errors; some devices are flakey.
4086 * 255 is for WUSB devices, we actually need to use
4087 * 512 (WUSB1.0[4.8.1]).
4089 for (j = 0; j < 3; ++j) {
4090 buf->bMaxPacketSize0 = 0;
4091 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4092 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4093 USB_DT_DEVICE << 8, 0,
4094 buf, GET_DESCRIPTOR_BUFSIZE,
4095 initial_descriptor_timeout);
4096 switch (buf->bMaxPacketSize0) {
4097 case 8: case 16: case 32: case 64: case 255:
4098 if (buf->bDescriptorType ==
4112 udev->descriptor.bMaxPacketSize0 =
4113 buf->bMaxPacketSize0;
4116 retval = hub_port_reset(hub, port1, udev, delay, false);
4117 if (retval < 0) /* error or disconnect */
4119 if (oldspeed != udev->speed) {
4121 "device reset changed speed!\n");
4127 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4132 #undef GET_DESCRIPTOR_BUFSIZE
4136 * If device is WUSB, we already assigned an
4137 * unauthorized address in the Connect Ack sequence;
4138 * authorization will assign the final address.
4140 if (udev->wusb == 0) {
4141 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4142 retval = hub_set_address(udev, devnum);
4148 if (retval != -ENODEV)
4149 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4153 if (udev->speed == USB_SPEED_SUPER) {
4154 devnum = udev->devnum;
4155 dev_info(&udev->dev,
4156 "%s SuperSpeed USB device number %d using %s\n",
4157 (udev->config) ? "reset" : "new",
4158 devnum, udev->bus->controller->driver->name);
4161 /* cope with hardware quirkiness:
4162 * - let SET_ADDRESS settle, some device hardware wants it
4163 * - read ep0 maxpacket even for high and low speed,
4166 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4170 retval = usb_get_device_descriptor(udev, 8);
4172 if (retval != -ENODEV)
4174 "device descriptor read/8, error %d\n",
4186 if (hcd->phy && !hdev->parent)
4187 usb_phy_notify_connect(hcd->phy, udev->speed);
4190 * Some superspeed devices have finished the link training process
4191 * and attached to a superspeed hub port, but the device descriptor
4192 * got from those devices show they aren't superspeed devices. Warm
4193 * reset the port attached by the devices can fix them.
4195 if ((udev->speed == USB_SPEED_SUPER) &&
4196 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4197 dev_err(&udev->dev, "got a wrong device descriptor, "
4198 "warm reset device\n");
4199 hub_port_reset(hub, port1, udev,
4200 HUB_BH_RESET_TIME, true);
4205 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4206 udev->speed == USB_SPEED_SUPER)
4209 i = udev->descriptor.bMaxPacketSize0;
4210 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4211 if (udev->speed == USB_SPEED_LOW ||
4212 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4213 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4217 if (udev->speed == USB_SPEED_FULL)
4218 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4220 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4221 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4222 usb_ep0_reinit(udev);
4225 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4226 if (retval < (signed)sizeof(udev->descriptor)) {
4227 if (retval != -ENODEV)
4228 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4235 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4236 retval = usb_get_bos_descriptor(udev);
4238 udev->lpm_capable = usb_device_supports_lpm(udev);
4239 usb_set_lpm_parameters(udev);
4244 /* notify HCD that we have a device connected and addressed */
4245 if (hcd->driver->update_device)
4246 hcd->driver->update_device(hcd, udev);
4249 hub_port_disable(hub, port1, 0);
4250 update_devnum(udev, devnum); /* for disconnect processing */
4252 mutex_unlock(&usb_address0_mutex);
4257 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4259 struct usb_qualifier_descriptor *qual;
4262 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4266 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4267 qual, sizeof *qual);
4268 if (status == sizeof *qual) {
4269 dev_info(&udev->dev, "not running at top speed; "
4270 "connect to a high speed hub\n");
4271 /* hub LEDs are probably harder to miss than syslog */
4272 if (hub->has_indicators) {
4273 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4274 schedule_delayed_work (&hub->leds, 0);
4281 hub_power_remaining (struct usb_hub *hub)
4283 struct usb_device *hdev = hub->hdev;
4287 if (!hub->limited_power)
4290 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4291 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4292 struct usb_device *udev = hub->ports[port1 - 1]->child;
4298 if (hub_is_superspeed(udev))
4304 * Unconfigured devices may not use more than one unit load,
4305 * or 8mA for OTG ports
4307 if (udev->actconfig)
4308 delta = usb_get_max_power(udev, udev->actconfig);
4309 else if (port1 != udev->bus->otg_port || hdev->parent)
4313 if (delta > hub->mA_per_port)
4314 dev_warn(&udev->dev,
4315 "%dmA is over %umA budget for port %d!\n",
4316 delta, hub->mA_per_port, port1);
4319 if (remaining < 0) {
4320 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4327 /* Handle physical or logical connection change events.
4328 * This routine is called when:
4329 * a port connection-change occurs;
4330 * a port enable-change occurs (often caused by EMI);
4331 * usb_reset_and_verify_device() encounters changed descriptors (as from
4332 * a firmware download)
4333 * caller already locked the hub
4335 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4336 u16 portstatus, u16 portchange)
4338 struct usb_device *hdev = hub->hdev;
4339 struct device *hub_dev = hub->intfdev;
4340 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4341 unsigned wHubCharacteristics =
4342 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4343 struct usb_device *udev;
4348 "port %d, status %04x, change %04x, %s\n",
4349 port1, portstatus, portchange, portspeed(hub, portstatus));
4351 if (hub->has_indicators) {
4352 set_port_led(hub, port1, HUB_LED_AUTO);
4353 hub->indicator[port1-1] = INDICATOR_AUTO;
4356 #ifdef CONFIG_USB_OTG
4357 /* during HNP, don't repeat the debounce */
4358 if (hdev->bus->is_b_host)
4359 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4360 USB_PORT_STAT_C_ENABLE);
4363 /* Try to resuscitate an existing device */
4364 udev = hub->ports[port1 - 1]->child;
4365 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4366 udev->state != USB_STATE_NOTATTACHED) {
4367 usb_lock_device(udev);
4368 if (portstatus & USB_PORT_STAT_ENABLE) {
4369 status = 0; /* Nothing to do */
4371 #ifdef CONFIG_PM_RUNTIME
4372 } else if (udev->state == USB_STATE_SUSPENDED &&
4373 udev->persist_enabled) {
4374 /* For a suspended device, treat this as a
4375 * remote wakeup event.
4377 status = usb_remote_wakeup(udev);
4381 status = -ENODEV; /* Don't resuscitate */
4383 usb_unlock_device(udev);
4386 clear_bit(port1, hub->change_bits);
4391 /* Disconnect any existing devices under this port */
4393 if (hcd->phy && !hdev->parent &&
4394 !(portstatus & USB_PORT_STAT_CONNECTION))
4395 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4396 usb_disconnect(&hub->ports[port1 - 1]->child);
4398 clear_bit(port1, hub->change_bits);
4400 /* We can forget about a "removed" device when there's a physical
4401 * disconnect or the connect status changes.
4403 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4404 (portchange & USB_PORT_STAT_C_CONNECTION))
4405 clear_bit(port1, hub->removed_bits);
4407 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4408 USB_PORT_STAT_C_ENABLE)) {
4409 status = hub_port_debounce_be_stable(hub, port1);
4411 if (status != -ENODEV && printk_ratelimit())
4412 dev_err(hub_dev, "connect-debounce failed, "
4413 "port %d disabled\n", port1);
4414 portstatus &= ~USB_PORT_STAT_CONNECTION;
4416 portstatus = status;
4420 /* Return now if debouncing failed or nothing is connected or
4421 * the device was "removed".
4423 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4424 test_bit(port1, hub->removed_bits)) {
4426 /* maybe switch power back on (e.g. root hub was reset) */
4427 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4428 && !port_is_power_on(hub, portstatus))
4429 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4431 if (portstatus & USB_PORT_STAT_ENABLE)
4435 if (hub_is_superspeed(hub->hdev))
4441 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4443 /* reallocate for each attempt, since references
4444 * to the previous one can escape in various ways
4446 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4449 "couldn't allocate port %d usb_device\n",
4454 usb_set_device_state(udev, USB_STATE_POWERED);
4455 udev->bus_mA = hub->mA_per_port;
4456 udev->level = hdev->level + 1;
4457 udev->wusb = hub_is_wusb(hub);
4459 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4460 if (hub_is_superspeed(hub->hdev))
4461 udev->speed = USB_SPEED_SUPER;
4463 udev->speed = USB_SPEED_UNKNOWN;
4465 choose_devnum(udev);
4466 if (udev->devnum <= 0) {
4467 status = -ENOTCONN; /* Don't retry */
4471 /* reset (non-USB 3.0 devices) and get descriptor */
4472 status = hub_port_init(hub, udev, port1, i);
4476 usb_detect_quirks(udev);
4477 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4480 /* consecutive bus-powered hubs aren't reliable; they can
4481 * violate the voltage drop budget. if the new child has
4482 * a "powered" LED, users should notice we didn't enable it
4483 * (without reading syslog), even without per-port LEDs
4486 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4487 && udev->bus_mA <= unit_load) {
4490 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4493 dev_dbg(&udev->dev, "get status %d ?\n", status);
4496 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4498 "can't connect bus-powered hub "
4500 if (hub->has_indicators) {
4501 hub->indicator[port1-1] =
4502 INDICATOR_AMBER_BLINK;
4503 schedule_delayed_work (&hub->leds, 0);
4505 status = -ENOTCONN; /* Don't retry */
4510 /* check for devices running slower than they could */
4511 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4512 && udev->speed == USB_SPEED_FULL
4513 && highspeed_hubs != 0)
4514 check_highspeed (hub, udev, port1);
4516 /* Store the parent's children[] pointer. At this point
4517 * udev becomes globally accessible, although presumably
4518 * no one will look at it until hdev is unlocked.
4522 /* We mustn't add new devices if the parent hub has
4523 * been disconnected; we would race with the
4524 * recursively_mark_NOTATTACHED() routine.
4526 spin_lock_irq(&device_state_lock);
4527 if (hdev->state == USB_STATE_NOTATTACHED)
4530 hub->ports[port1 - 1]->child = udev;
4531 spin_unlock_irq(&device_state_lock);
4533 /* Run it through the hoops (find a driver, etc) */
4535 status = usb_new_device(udev);
4537 spin_lock_irq(&device_state_lock);
4538 hub->ports[port1 - 1]->child = NULL;
4539 spin_unlock_irq(&device_state_lock);
4546 status = hub_power_remaining(hub);
4548 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4553 hub_port_disable(hub, port1, 1);
4555 usb_ep0_reinit(udev);
4556 release_devnum(udev);
4559 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4562 if (hub->hdev->parent ||
4563 !hcd->driver->port_handed_over ||
4564 !(hcd->driver->port_handed_over)(hcd, port1)) {
4565 if (status != -ENOTCONN && status != -ENODEV)
4566 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4571 hub_port_disable(hub, port1, 1);
4572 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4573 hcd->driver->relinquish_port(hcd, port1);
4576 /* Returns 1 if there was a remote wakeup and a connect status change. */
4577 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4578 u16 portstatus, u16 portchange)
4580 struct usb_device *hdev;
4581 struct usb_device *udev;
4582 int connect_change = 0;
4586 udev = hub->ports[port - 1]->child;
4587 if (!hub_is_superspeed(hdev)) {
4588 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4590 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4592 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4593 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4599 /* TRSMRCY = 10 msec */
4602 usb_lock_device(udev);
4603 ret = usb_remote_wakeup(udev);
4604 usb_unlock_device(udev);
4609 hub_port_disable(hub, port, 1);
4611 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4613 return connect_change;
4616 static void hub_events(void)
4618 struct list_head *tmp;
4619 struct usb_device *hdev;
4620 struct usb_interface *intf;
4621 struct usb_hub *hub;
4622 struct device *hub_dev;
4628 int connect_change, wakeup_change;
4631 * We restart the list every time to avoid a deadlock with
4632 * deleting hubs downstream from this one. This should be
4633 * safe since we delete the hub from the event list.
4634 * Not the most efficient, but avoids deadlocks.
4638 /* Grab the first entry at the beginning of the list */
4639 spin_lock_irq(&hub_event_lock);
4640 if (list_empty(&hub_event_list)) {
4641 spin_unlock_irq(&hub_event_lock);
4645 tmp = hub_event_list.next;
4648 hub = list_entry(tmp, struct usb_hub, event_list);
4649 kref_get(&hub->kref);
4650 spin_unlock_irq(&hub_event_lock);
4653 hub_dev = hub->intfdev;
4654 intf = to_usb_interface(hub_dev);
4655 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4656 hdev->state, hdev->maxchild,
4657 /* NOTE: expects max 15 ports... */
4658 (u16) hub->change_bits[0],
4659 (u16) hub->event_bits[0]);
4661 /* Lock the device, then check to see if we were
4662 * disconnected while waiting for the lock to succeed. */
4663 usb_lock_device(hdev);
4664 if (unlikely(hub->disconnected))
4665 goto loop_disconnected;
4667 /* If the hub has died, clean up after it */
4668 if (hdev->state == USB_STATE_NOTATTACHED) {
4669 hub->error = -ENODEV;
4670 hub_quiesce(hub, HUB_DISCONNECT);
4675 ret = usb_autopm_get_interface(intf);
4677 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4681 /* If this is an inactive hub, do nothing */
4686 dev_dbg (hub_dev, "resetting for error %d\n",
4689 ret = usb_reset_device(hdev);
4692 "error resetting hub: %d\n", ret);
4700 /* deal with port status changes */
4701 for (i = 1; i <= hdev->maxchild; i++) {
4702 if (test_bit(i, hub->busy_bits))
4704 connect_change = test_bit(i, hub->change_bits);
4705 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4706 if (!test_and_clear_bit(i, hub->event_bits) &&
4707 !connect_change && !wakeup_change)
4710 ret = hub_port_status(hub, i,
4711 &portstatus, &portchange);
4715 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4716 usb_clear_port_feature(hdev, i,
4717 USB_PORT_FEAT_C_CONNECTION);
4721 if (portchange & USB_PORT_STAT_C_ENABLE) {
4722 if (!connect_change)
4724 "port %d enable change, "
4727 usb_clear_port_feature(hdev, i,
4728 USB_PORT_FEAT_C_ENABLE);
4731 * EM interference sometimes causes badly
4732 * shielded USB devices to be shutdown by
4733 * the hub, this hack enables them again.
4734 * Works at least with mouse driver.
4736 if (!(portstatus & USB_PORT_STAT_ENABLE)
4738 && hub->ports[i - 1]->child) {
4741 "disabled by hub (EMI?), "
4748 if (hub_handle_remote_wakeup(hub, i,
4749 portstatus, portchange))
4752 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4756 dev_dbg(hub_dev, "over-current change on port "
4758 usb_clear_port_feature(hdev, i,
4759 USB_PORT_FEAT_C_OVER_CURRENT);
4760 msleep(100); /* Cool down */
4761 hub_power_on(hub, true);
4762 hub_port_status(hub, i, &status, &unused);
4763 if (status & USB_PORT_STAT_OVERCURRENT)
4764 dev_err(hub_dev, "over-current "
4765 "condition on port %d\n", i);
4768 if (portchange & USB_PORT_STAT_C_RESET) {
4770 "reset change on port %d\n",
4772 usb_clear_port_feature(hdev, i,
4773 USB_PORT_FEAT_C_RESET);
4775 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4776 hub_is_superspeed(hub->hdev)) {
4778 "warm reset change on port %d\n",
4780 usb_clear_port_feature(hdev, i,
4781 USB_PORT_FEAT_C_BH_PORT_RESET);
4783 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4784 usb_clear_port_feature(hub->hdev, i,
4785 USB_PORT_FEAT_C_PORT_LINK_STATE);
4787 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4789 "config error on port %d\n",
4791 usb_clear_port_feature(hub->hdev, i,
4792 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4795 /* Warm reset a USB3 protocol port if it's in
4796 * SS.Inactive state.
4798 if (hub_port_warm_reset_required(hub, portstatus)) {
4800 struct usb_device *udev =
4801 hub->ports[i - 1]->child;
4803 dev_dbg(hub_dev, "warm reset port %d\n", i);
4804 if (!udev || !(portstatus &
4805 USB_PORT_STAT_CONNECTION)) {
4806 status = hub_port_reset(hub, i,
4807 NULL, HUB_BH_RESET_TIME,
4810 hub_port_disable(hub, i, 1);
4812 usb_lock_device(udev);
4813 status = usb_reset_device(udev);
4814 usb_unlock_device(udev);
4820 hub_port_connect_change(hub, i,
4821 portstatus, portchange);
4824 /* deal with hub status changes */
4825 if (test_and_clear_bit(0, hub->event_bits) == 0)
4827 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4828 dev_err (hub_dev, "get_hub_status failed\n");
4830 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4831 dev_dbg (hub_dev, "power change\n");
4832 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4833 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4834 /* FIXME: Is this always true? */
4835 hub->limited_power = 1;
4837 hub->limited_power = 0;
4839 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4843 dev_dbg(hub_dev, "over-current change\n");
4844 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4845 msleep(500); /* Cool down */
4846 hub_power_on(hub, true);
4847 hub_hub_status(hub, &status, &unused);
4848 if (status & HUB_STATUS_OVERCURRENT)
4849 dev_err(hub_dev, "over-current "
4855 /* Balance the usb_autopm_get_interface() above */
4856 usb_autopm_put_interface_no_suspend(intf);
4858 /* Balance the usb_autopm_get_interface_no_resume() in
4859 * kick_khubd() and allow autosuspend.
4861 usb_autopm_put_interface(intf);
4863 usb_unlock_device(hdev);
4864 kref_put(&hub->kref, hub_release);
4866 } /* end while (1) */
4869 static int hub_thread(void *__unused)
4871 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4872 * port handover. Otherwise it might see that a full-speed device
4873 * was gone before the EHCI controller had handed its port over to
4874 * the companion full-speed controller.
4880 wait_event_freezable(khubd_wait,
4881 !list_empty(&hub_event_list) ||
4882 kthread_should_stop());
4883 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4885 pr_debug("%s: khubd exiting\n", usbcore_name);
4889 static const struct usb_device_id hub_id_table[] = {
4890 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4891 | USB_DEVICE_ID_MATCH_INT_CLASS,
4892 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4893 .bInterfaceClass = USB_CLASS_HUB,
4894 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4895 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4896 .bDeviceClass = USB_CLASS_HUB},
4897 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4898 .bInterfaceClass = USB_CLASS_HUB},
4899 { } /* Terminating entry */
4902 MODULE_DEVICE_TABLE (usb, hub_id_table);
4904 static struct usb_driver hub_driver = {
4907 .disconnect = hub_disconnect,
4908 .suspend = hub_suspend,
4909 .resume = hub_resume,
4910 .reset_resume = hub_reset_resume,
4911 .pre_reset = hub_pre_reset,
4912 .post_reset = hub_post_reset,
4913 .unlocked_ioctl = hub_ioctl,
4914 .id_table = hub_id_table,
4915 .supports_autosuspend = 1,
4918 int usb_hub_init(void)
4920 if (usb_register(&hub_driver) < 0) {
4921 printk(KERN_ERR "%s: can't register hub driver\n",
4926 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4927 if (!IS_ERR(khubd_task))
4930 /* Fall through if kernel_thread failed */
4931 usb_deregister(&hub_driver);
4932 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4937 void usb_hub_cleanup(void)
4939 kthread_stop(khubd_task);
4942 * Hub resources are freed for us by usb_deregister. It calls
4943 * usb_driver_purge on every device which in turn calls that
4944 * devices disconnect function if it is using this driver.
4945 * The hub_disconnect function takes care of releasing the
4946 * individual hub resources. -greg
4948 usb_deregister(&hub_driver);
4949 } /* usb_hub_cleanup() */
4951 static int descriptors_changed(struct usb_device *udev,
4952 struct usb_device_descriptor *old_device_descriptor,
4953 struct usb_host_bos *old_bos)
4957 unsigned serial_len = 0;
4959 unsigned old_length;
4963 if (memcmp(&udev->descriptor, old_device_descriptor,
4964 sizeof(*old_device_descriptor)) != 0)
4967 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
4970 len = le16_to_cpu(udev->bos->desc->wTotalLength);
4971 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
4973 if (memcmp(udev->bos->desc, old_bos->desc, len))
4977 /* Since the idVendor, idProduct, and bcdDevice values in the
4978 * device descriptor haven't changed, we will assume the
4979 * Manufacturer and Product strings haven't changed either.
4980 * But the SerialNumber string could be different (e.g., a
4981 * different flash card of the same brand).
4984 serial_len = strlen(udev->serial) + 1;
4987 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4988 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4989 len = max(len, old_length);
4992 buf = kmalloc(len, GFP_NOIO);
4994 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4995 /* assume the worst */
4998 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4999 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5000 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5002 if (length != old_length) {
5003 dev_dbg(&udev->dev, "config index %d, error %d\n",
5008 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5010 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5012 ((struct usb_config_descriptor *) buf)->
5013 bConfigurationValue);
5019 if (!changed && serial_len) {
5020 length = usb_string(udev, udev->descriptor.iSerialNumber,
5022 if (length + 1 != serial_len) {
5023 dev_dbg(&udev->dev, "serial string error %d\n",
5026 } else if (memcmp(buf, udev->serial, length) != 0) {
5027 dev_dbg(&udev->dev, "serial string changed\n");
5037 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5038 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5040 * WARNING - don't use this routine to reset a composite device
5041 * (one with multiple interfaces owned by separate drivers)!
5042 * Use usb_reset_device() instead.
5044 * Do a port reset, reassign the device's address, and establish its
5045 * former operating configuration. If the reset fails, or the device's
5046 * descriptors change from their values before the reset, or the original
5047 * configuration and altsettings cannot be restored, a flag will be set
5048 * telling khubd to pretend the device has been disconnected and then
5049 * re-connected. All drivers will be unbound, and the device will be
5050 * re-enumerated and probed all over again.
5052 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5053 * flagged for logical disconnection, or some other negative error code
5054 * if the reset wasn't even attempted.
5057 * The caller must own the device lock. For example, it's safe to use
5058 * this from a driver probe() routine after downloading new firmware.
5059 * For calls that might not occur during probe(), drivers should lock
5060 * the device using usb_lock_device_for_reset().
5062 * Locking exception: This routine may also be called from within an
5063 * autoresume handler. Such usage won't conflict with other tasks
5064 * holding the device lock because these tasks should always call
5065 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5067 static int usb_reset_and_verify_device(struct usb_device *udev)
5069 struct usb_device *parent_hdev = udev->parent;
5070 struct usb_hub *parent_hub;
5071 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5072 struct usb_device_descriptor descriptor = udev->descriptor;
5073 struct usb_host_bos *bos;
5075 int port1 = udev->portnum;
5077 if (udev->state == USB_STATE_NOTATTACHED ||
5078 udev->state == USB_STATE_SUSPENDED) {
5079 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5085 /* this requires hcd-specific logic; see ohci_restart() */
5086 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5089 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5094 /* Disable LPM and LTM while we reset the device and reinstall the alt
5095 * settings. Device-initiated LPM settings, and system exit latency
5096 * settings are cleared when the device is reset, so we have to set
5099 ret = usb_unlocked_disable_lpm(udev);
5101 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5104 ret = usb_disable_ltm(udev);
5106 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5111 set_bit(port1, parent_hub->busy_bits);
5112 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5114 /* ep0 maxpacket size may change; let the HCD know about it.
5115 * Other endpoints will be handled by re-enumeration. */
5116 usb_ep0_reinit(udev);
5117 ret = hub_port_init(parent_hub, udev, port1, i);
5118 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5121 clear_bit(port1, parent_hub->busy_bits);
5126 /* Device might have changed firmware (DFU or similar) */
5127 if (descriptors_changed(udev, &descriptor, bos)) {
5128 dev_info(&udev->dev, "device firmware changed\n");
5129 udev->descriptor = descriptor; /* for disconnect() calls */
5133 /* Restore the device's previous configuration */
5134 if (!udev->actconfig)
5137 mutex_lock(hcd->bandwidth_mutex);
5138 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5140 dev_warn(&udev->dev,
5141 "Busted HC? Not enough HCD resources for "
5142 "old configuration.\n");
5143 mutex_unlock(hcd->bandwidth_mutex);
5146 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5147 USB_REQ_SET_CONFIGURATION, 0,
5148 udev->actconfig->desc.bConfigurationValue, 0,
5149 NULL, 0, USB_CTRL_SET_TIMEOUT);
5152 "can't restore configuration #%d (error=%d)\n",
5153 udev->actconfig->desc.bConfigurationValue, ret);
5154 mutex_unlock(hcd->bandwidth_mutex);
5157 mutex_unlock(hcd->bandwidth_mutex);
5158 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5160 /* Put interfaces back into the same altsettings as before.
5161 * Don't bother to send the Set-Interface request for interfaces
5162 * that were already in altsetting 0; besides being unnecessary,
5163 * many devices can't handle it. Instead just reset the host-side
5166 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5167 struct usb_host_config *config = udev->actconfig;
5168 struct usb_interface *intf = config->interface[i];
5169 struct usb_interface_descriptor *desc;
5171 desc = &intf->cur_altsetting->desc;
5172 if (desc->bAlternateSetting == 0) {
5173 usb_disable_interface(udev, intf, true);
5174 usb_enable_interface(udev, intf, true);
5177 /* Let the bandwidth allocation function know that this
5178 * device has been reset, and it will have to use
5179 * alternate setting 0 as the current alternate setting.
5181 intf->resetting_device = 1;
5182 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5183 desc->bAlternateSetting);
5184 intf->resetting_device = 0;
5187 dev_err(&udev->dev, "failed to restore interface %d "
5188 "altsetting %d (error=%d)\n",
5189 desc->bInterfaceNumber,
5190 desc->bAlternateSetting,
5197 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5198 usb_unlocked_enable_lpm(udev);
5199 usb_enable_ltm(udev);
5200 usb_release_bos_descriptor(udev);
5205 /* LPM state doesn't matter when we're about to destroy the device. */
5206 hub_port_logical_disconnect(parent_hub, port1);
5207 usb_release_bos_descriptor(udev);
5213 * usb_reset_device - warn interface drivers and perform a USB port reset
5214 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5216 * Warns all drivers bound to registered interfaces (using their pre_reset
5217 * method), performs the port reset, and then lets the drivers know that
5218 * the reset is over (using their post_reset method).
5220 * Return: The same as for usb_reset_and_verify_device().
5223 * The caller must own the device lock. For example, it's safe to use
5224 * this from a driver probe() routine after downloading new firmware.
5225 * For calls that might not occur during probe(), drivers should lock
5226 * the device using usb_lock_device_for_reset().
5228 * If an interface is currently being probed or disconnected, we assume
5229 * its driver knows how to handle resets. For all other interfaces,
5230 * if the driver doesn't have pre_reset and post_reset methods then
5231 * we attempt to unbind it and rebind afterward.
5233 int usb_reset_device(struct usb_device *udev)
5237 unsigned int noio_flag;
5238 struct usb_host_config *config = udev->actconfig;
5240 if (udev->state == USB_STATE_NOTATTACHED ||
5241 udev->state == USB_STATE_SUSPENDED) {
5242 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5248 * Don't allocate memory with GFP_KERNEL in current
5249 * context to avoid possible deadlock if usb mass
5250 * storage interface or usbnet interface(iSCSI case)
5251 * is included in current configuration. The easist
5252 * approach is to do it for every device reset,
5253 * because the device 'memalloc_noio' flag may have
5254 * not been set before reseting the usb device.
5256 noio_flag = memalloc_noio_save();
5258 /* Prevent autosuspend during the reset */
5259 usb_autoresume_device(udev);
5262 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5263 struct usb_interface *cintf = config->interface[i];
5264 struct usb_driver *drv;
5267 if (cintf->dev.driver) {
5268 drv = to_usb_driver(cintf->dev.driver);
5269 if (drv->pre_reset && drv->post_reset)
5270 unbind = (drv->pre_reset)(cintf);
5271 else if (cintf->condition ==
5272 USB_INTERFACE_BOUND)
5275 usb_forced_unbind_intf(cintf);
5280 ret = usb_reset_and_verify_device(udev);
5283 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5284 struct usb_interface *cintf = config->interface[i];
5285 struct usb_driver *drv;
5286 int rebind = cintf->needs_binding;
5288 if (!rebind && cintf->dev.driver) {
5289 drv = to_usb_driver(cintf->dev.driver);
5290 if (drv->post_reset)
5291 rebind = (drv->post_reset)(cintf);
5292 else if (cintf->condition ==
5293 USB_INTERFACE_BOUND)
5296 if (ret == 0 && rebind)
5297 usb_rebind_intf(cintf);
5301 usb_autosuspend_device(udev);
5302 memalloc_noio_restore(noio_flag);
5305 EXPORT_SYMBOL_GPL(usb_reset_device);
5309 * usb_queue_reset_device - Reset a USB device from an atomic context
5310 * @iface: USB interface belonging to the device to reset
5312 * This function can be used to reset a USB device from an atomic
5313 * context, where usb_reset_device() won't work (as it blocks).
5315 * Doing a reset via this method is functionally equivalent to calling
5316 * usb_reset_device(), except for the fact that it is delayed to a
5317 * workqueue. This means that any drivers bound to other interfaces
5318 * might be unbound, as well as users from usbfs in user space.
5322 * - Scheduling two resets at the same time from two different drivers
5323 * attached to two different interfaces of the same device is
5324 * possible; depending on how the driver attached to each interface
5325 * handles ->pre_reset(), the second reset might happen or not.
5327 * - If a driver is unbound and it had a pending reset, the reset will
5330 * - This function can be called during .probe() or .disconnect()
5331 * times. On return from .disconnect(), any pending resets will be
5334 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5337 * NOTE: We don't do any reference count tracking because it is not
5338 * needed. The lifecycle of the work_struct is tied to the
5339 * usb_interface. Before destroying the interface we cancel the
5340 * work_struct, so the fact that work_struct is queued and or
5341 * running means the interface (and thus, the device) exist and
5344 void usb_queue_reset_device(struct usb_interface *iface)
5346 schedule_work(&iface->reset_ws);
5348 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5351 * usb_hub_find_child - Get the pointer of child device
5352 * attached to the port which is specified by @port1.
5353 * @hdev: USB device belonging to the usb hub
5354 * @port1: port num to indicate which port the child device
5357 * USB drivers call this function to get hub's child device
5360 * Return: %NULL if input param is invalid and
5361 * child's usb_device pointer if non-NULL.
5363 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5366 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5368 if (port1 < 1 || port1 > hdev->maxchild)
5370 return hub->ports[port1 - 1]->child;
5372 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5375 * usb_set_hub_port_connect_type - set hub port connect type.
5376 * @hdev: USB device belonging to the usb hub
5377 * @port1: port num of the port
5378 * @type: connect type of the port
5380 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5381 enum usb_port_connect_type type)
5383 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5386 hub->ports[port1 - 1]->connect_type = type;
5390 * usb_get_hub_port_connect_type - Get the port's connect type
5391 * @hdev: USB device belonging to the usb hub
5392 * @port1: port num of the port
5394 * Return: The connect type of the port if successful. Or
5395 * USB_PORT_CONNECT_TYPE_UNKNOWN if input params are invalid.
5397 enum usb_port_connect_type
5398 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5400 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5403 return USB_PORT_CONNECT_TYPE_UNKNOWN;
5405 return hub->ports[port1 - 1]->connect_type;
5408 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5409 struct usb_hub_descriptor *desc)
5411 enum usb_port_connect_type connect_type;
5414 if (!hub_is_superspeed(hdev)) {
5415 for (i = 1; i <= hdev->maxchild; i++) {
5416 connect_type = usb_get_hub_port_connect_type(hdev, i);
5418 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5419 u8 mask = 1 << (i%8);
5421 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5422 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5424 desc->u.hs.DeviceRemovable[i/8] |= mask;
5429 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5431 for (i = 1; i <= hdev->maxchild; i++) {
5432 connect_type = usb_get_hub_port_connect_type(hdev, i);
5434 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5437 if (!(port_removable & mask)) {
5438 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5440 port_removable |= mask;
5445 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5451 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5452 * @hdev: USB device belonging to the usb hub
5453 * @port1: port num of the port
5455 * Return: Port's acpi handle if successful, %NULL if params are
5458 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5461 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5466 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);