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>
30 #include <asm/uaccess.h>
31 #include <asm/byteorder.h>
35 /* if we are in debug mode, always announce new devices */
37 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
38 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 #define USB_VENDOR_GENESYS_LOGIC 0x05e3
43 #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
46 struct usb_device *child;
48 struct dev_state *port_owner;
49 enum usb_port_connect_type connect_type;
53 struct device *intfdev; /* the "interface" device */
54 struct usb_device *hdev;
56 struct urb *urb; /* for interrupt polling pipe */
58 /* buffer for urb ... with extra space in case of babble */
61 struct usb_hub_status hub;
62 struct usb_port_status port;
63 } *status; /* buffer for status reports */
64 struct mutex status_mutex; /* for the status buffer */
66 int error; /* last reported error */
67 int nerrors; /* track consecutive errors */
69 struct list_head event_list; /* hubs w/data or errs ready */
70 unsigned long event_bits[1]; /* status change bitmask */
71 unsigned long change_bits[1]; /* ports with logical connect
73 unsigned long busy_bits[1]; /* ports being reset or
75 unsigned long removed_bits[1]; /* ports with a "removed"
77 unsigned long wakeup_bits[1]; /* ports that have signaled
79 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
80 #error event_bits[] is too short!
83 struct usb_hub_descriptor *descriptor; /* class descriptor */
84 struct usb_tt tt; /* Transaction Translator */
86 unsigned mA_per_port; /* current for each child */
88 unsigned limited_power:1;
90 unsigned disconnected:1;
92 unsigned quirk_check_port_auto_suspend:1;
94 unsigned has_indicators:1;
95 u8 indicator[USB_MAXCHILDREN];
96 struct delayed_work leds;
97 struct delayed_work init_work;
98 struct usb_port **ports;
101 static inline int hub_is_superspeed(struct usb_device *hdev)
103 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
106 /* Protect struct usb_device->state and ->children members
107 * Note: Both are also protected by ->dev.sem, except that ->state can
108 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
109 static DEFINE_SPINLOCK(device_state_lock);
111 /* khubd's worklist and its lock */
112 static DEFINE_SPINLOCK(hub_event_lock);
113 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
116 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
118 static struct task_struct *khubd_task;
120 /* cycle leds on hubs that aren't blinking for attention */
121 static bool blinkenlights = 0;
122 module_param (blinkenlights, bool, S_IRUGO);
123 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
126 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
127 * 10 seconds to send reply for the initial 64-byte descriptor request.
129 /* define initial 64-byte descriptor request timeout in milliseconds */
130 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
131 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
132 MODULE_PARM_DESC(initial_descriptor_timeout,
133 "initial 64-byte descriptor request timeout in milliseconds "
134 "(default 5000 - 5.0 seconds)");
137 * As of 2.6.10 we introduce a new USB device initialization scheme which
138 * closely resembles the way Windows works. Hopefully it will be compatible
139 * with a wider range of devices than the old scheme. However some previously
140 * working devices may start giving rise to "device not accepting address"
141 * errors; if that happens the user can try the old scheme by adjusting the
142 * following module parameters.
144 * For maximum flexibility there are two boolean parameters to control the
145 * hub driver's behavior. On the first initialization attempt, if the
146 * "old_scheme_first" parameter is set then the old scheme will be used,
147 * otherwise the new scheme is used. If that fails and "use_both_schemes"
148 * is set, then the driver will make another attempt, using the other scheme.
150 static bool old_scheme_first = 0;
151 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
152 MODULE_PARM_DESC(old_scheme_first,
153 "start with the old device initialization scheme");
155 static bool use_both_schemes = 1;
156 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
157 MODULE_PARM_DESC(use_both_schemes,
158 "try the other device initialization scheme if the "
161 /* Mutual exclusion for EHCI CF initialization. This interferes with
162 * port reset on some companion controllers.
164 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
165 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
167 #define HUB_DEBOUNCE_TIMEOUT 1500
168 #define HUB_DEBOUNCE_STEP 25
169 #define HUB_DEBOUNCE_STABLE 100
171 #define to_usb_port(_dev) \
172 container_of(_dev, struct usb_port, dev)
174 static int usb_reset_and_verify_device(struct usb_device *udev);
176 static inline char *portspeed(struct usb_hub *hub, int portstatus)
178 if (hub_is_superspeed(hub->hdev))
180 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
182 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
188 /* Note that hdev or one of its children must be locked! */
189 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
191 if (!hdev || !hdev->actconfig || !hdev->maxchild)
193 return usb_get_intfdata(hdev->actconfig->interface[0]);
196 static int usb_device_supports_lpm(struct usb_device *udev)
198 /* USB 2.1 (and greater) devices indicate LPM support through
199 * their USB 2.0 Extended Capabilities BOS descriptor.
201 if (udev->speed == USB_SPEED_HIGH) {
202 if (udev->bos->ext_cap &&
204 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
209 /* All USB 3.0 must support LPM, but we need their max exit latency
210 * information from the SuperSpeed Extended Capabilities BOS descriptor.
212 if (!udev->bos->ss_cap) {
213 dev_warn(&udev->dev, "No LPM exit latency info found. "
214 "Power management will be impacted.\n");
217 if (udev->parent->lpm_capable)
220 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
221 "Power management will be impacted.\n");
226 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
229 static void usb_set_lpm_mel(struct usb_device *udev,
230 struct usb3_lpm_parameters *udev_lpm_params,
231 unsigned int udev_exit_latency,
233 struct usb3_lpm_parameters *hub_lpm_params,
234 unsigned int hub_exit_latency)
236 unsigned int total_mel;
237 unsigned int device_mel;
238 unsigned int hub_mel;
241 * Calculate the time it takes to transition all links from the roothub
242 * to the parent hub into U0. The parent hub must then decode the
243 * packet (hub header decode latency) to figure out which port it was
246 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
247 * means 0.1us). Multiply that by 100 to get nanoseconds.
249 total_mel = hub_lpm_params->mel +
250 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
253 * How long will it take to transition the downstream hub's port into
254 * U0? The greater of either the hub exit latency or the device exit
257 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
258 * Multiply that by 1000 to get nanoseconds.
260 device_mel = udev_exit_latency * 1000;
261 hub_mel = hub_exit_latency * 1000;
262 if (device_mel > hub_mel)
263 total_mel += device_mel;
265 total_mel += hub_mel;
267 udev_lpm_params->mel = total_mel;
271 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
272 * a transition from either U1 or U2.
274 static void usb_set_lpm_pel(struct usb_device *udev,
275 struct usb3_lpm_parameters *udev_lpm_params,
276 unsigned int udev_exit_latency,
278 struct usb3_lpm_parameters *hub_lpm_params,
279 unsigned int hub_exit_latency,
280 unsigned int port_to_port_exit_latency)
282 unsigned int first_link_pel;
283 unsigned int hub_pel;
286 * First, the device sends an LFPS to transition the link between the
287 * device and the parent hub into U0. The exit latency is the bigger of
288 * the device exit latency or the hub exit latency.
290 if (udev_exit_latency > hub_exit_latency)
291 first_link_pel = udev_exit_latency * 1000;
293 first_link_pel = hub_exit_latency * 1000;
296 * When the hub starts to receive the LFPS, there is a slight delay for
297 * it to figure out that one of the ports is sending an LFPS. Then it
298 * will forward the LFPS to its upstream link. The exit latency is the
299 * delay, plus the PEL that we calculated for this hub.
301 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
304 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
305 * is the greater of the two exit latencies.
307 if (first_link_pel > hub_pel)
308 udev_lpm_params->pel = first_link_pel;
310 udev_lpm_params->pel = hub_pel;
314 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
315 * when a device initiates a transition to U0, until when it will receive the
316 * first packet from the host controller.
318 * Section C.1.5.1 describes the four components to this:
320 * - t2: time for the ERDY to make it from the device to the host.
321 * - t3: a host-specific delay to process the ERDY.
322 * - t4: time for the packet to make it from the host to the device.
324 * t3 is specific to both the xHCI host and the platform the host is integrated
325 * into. The Intel HW folks have said it's negligible, FIXME if a different
326 * vendor says otherwise.
328 static void usb_set_lpm_sel(struct usb_device *udev,
329 struct usb3_lpm_parameters *udev_lpm_params)
331 struct usb_device *parent;
332 unsigned int num_hubs;
333 unsigned int total_sel;
335 /* t1 = device PEL */
336 total_sel = udev_lpm_params->pel;
337 /* How many external hubs are in between the device & the root port. */
338 for (parent = udev->parent, num_hubs = 0; parent->parent;
339 parent = parent->parent)
341 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
343 total_sel += 2100 + 250 * (num_hubs - 1);
345 /* t4 = 250ns * num_hubs */
346 total_sel += 250 * num_hubs;
348 udev_lpm_params->sel = total_sel;
351 static void usb_set_lpm_parameters(struct usb_device *udev)
354 unsigned int port_to_port_delay;
355 unsigned int udev_u1_del;
356 unsigned int udev_u2_del;
357 unsigned int hub_u1_del;
358 unsigned int hub_u2_del;
360 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
363 hub = hdev_to_hub(udev->parent);
364 /* It doesn't take time to transition the roothub into U0, since it
365 * doesn't have an upstream link.
370 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
371 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
372 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
373 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
375 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
376 hub, &udev->parent->u1_params, hub_u1_del);
378 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
379 hub, &udev->parent->u2_params, hub_u2_del);
382 * Appendix C, section C.2.2.2, says that there is a slight delay from
383 * when the parent hub notices the downstream port is trying to
384 * transition to U0 to when the hub initiates a U0 transition on its
385 * upstream port. The section says the delays are tPort2PortU1EL and
386 * tPort2PortU2EL, but it doesn't define what they are.
388 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
389 * about the same delays. Use the maximum delay calculations from those
390 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
391 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
392 * assume the device exit latencies they are talking about are the hub
395 * What do we do if the U2 exit latency is less than the U1 exit
396 * latency? It's possible, although not likely...
398 port_to_port_delay = 1;
400 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
401 hub, &udev->parent->u1_params, hub_u1_del,
404 if (hub_u2_del > hub_u1_del)
405 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
407 port_to_port_delay = 1 + hub_u1_del;
409 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
410 hub, &udev->parent->u2_params, hub_u2_del,
413 /* Now that we've got PEL, calculate SEL. */
414 usb_set_lpm_sel(udev, &udev->u1_params);
415 usb_set_lpm_sel(udev, &udev->u2_params);
418 /* USB 2.0 spec Section 11.24.4.5 */
419 static int get_hub_descriptor(struct usb_device *hdev, void *data)
424 if (hub_is_superspeed(hdev)) {
425 dtype = USB_DT_SS_HUB;
426 size = USB_DT_SS_HUB_SIZE;
429 size = sizeof(struct usb_hub_descriptor);
432 for (i = 0; i < 3; i++) {
433 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
434 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
435 dtype << 8, 0, data, size,
436 USB_CTRL_GET_TIMEOUT);
437 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
444 * USB 2.0 spec Section 11.24.2.1
446 static int clear_hub_feature(struct usb_device *hdev, int feature)
448 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
449 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
453 * USB 2.0 spec Section 11.24.2.2
455 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
457 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
458 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
463 * USB 2.0 spec Section 11.24.2.13
465 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
467 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
468 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
473 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
474 * for info about using port indicators
476 static void set_port_led(
482 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
483 USB_PORT_FEAT_INDICATOR);
485 dev_dbg (hub->intfdev,
486 "port %d indicator %s status %d\n",
488 ({ char *s; switch (selector) {
489 case HUB_LED_AMBER: s = "amber"; break;
490 case HUB_LED_GREEN: s = "green"; break;
491 case HUB_LED_OFF: s = "off"; break;
492 case HUB_LED_AUTO: s = "auto"; break;
493 default: s = "??"; break;
498 #define LED_CYCLE_PERIOD ((2*HZ)/3)
500 static void led_work (struct work_struct *work)
502 struct usb_hub *hub =
503 container_of(work, struct usb_hub, leds.work);
504 struct usb_device *hdev = hub->hdev;
506 unsigned changed = 0;
509 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
512 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
513 unsigned selector, mode;
515 /* 30%-50% duty cycle */
517 switch (hub->indicator[i]) {
519 case INDICATOR_CYCLE:
521 selector = HUB_LED_AUTO;
522 mode = INDICATOR_AUTO;
524 /* blinking green = sw attention */
525 case INDICATOR_GREEN_BLINK:
526 selector = HUB_LED_GREEN;
527 mode = INDICATOR_GREEN_BLINK_OFF;
529 case INDICATOR_GREEN_BLINK_OFF:
530 selector = HUB_LED_OFF;
531 mode = INDICATOR_GREEN_BLINK;
533 /* blinking amber = hw attention */
534 case INDICATOR_AMBER_BLINK:
535 selector = HUB_LED_AMBER;
536 mode = INDICATOR_AMBER_BLINK_OFF;
538 case INDICATOR_AMBER_BLINK_OFF:
539 selector = HUB_LED_OFF;
540 mode = INDICATOR_AMBER_BLINK;
542 /* blink green/amber = reserved */
543 case INDICATOR_ALT_BLINK:
544 selector = HUB_LED_GREEN;
545 mode = INDICATOR_ALT_BLINK_OFF;
547 case INDICATOR_ALT_BLINK_OFF:
548 selector = HUB_LED_AMBER;
549 mode = INDICATOR_ALT_BLINK;
554 if (selector != HUB_LED_AUTO)
556 set_port_led(hub, i + 1, selector);
557 hub->indicator[i] = mode;
559 if (!changed && blinkenlights) {
561 cursor %= hub->descriptor->bNbrPorts;
562 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
563 hub->indicator[cursor] = INDICATOR_CYCLE;
567 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
570 /* use a short timeout for hub/port status fetches */
571 #define USB_STS_TIMEOUT 1000
572 #define USB_STS_RETRIES 5
575 * USB 2.0 spec Section 11.24.2.6
577 static int get_hub_status(struct usb_device *hdev,
578 struct usb_hub_status *data)
580 int i, status = -ETIMEDOUT;
582 for (i = 0; i < USB_STS_RETRIES &&
583 (status == -ETIMEDOUT || status == -EPIPE); i++) {
584 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
585 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
586 data, sizeof(*data), USB_STS_TIMEOUT);
592 * USB 2.0 spec Section 11.24.2.7
594 static int get_port_status(struct usb_device *hdev, int port1,
595 struct usb_port_status *data)
597 int i, status = -ETIMEDOUT;
599 for (i = 0; i < USB_STS_RETRIES &&
600 (status == -ETIMEDOUT || status == -EPIPE); i++) {
601 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
602 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
603 data, sizeof(*data), USB_STS_TIMEOUT);
608 static int hub_port_status(struct usb_hub *hub, int port1,
609 u16 *status, u16 *change)
613 mutex_lock(&hub->status_mutex);
614 ret = get_port_status(hub->hdev, port1, &hub->status->port);
616 dev_err(hub->intfdev,
617 "%s failed (err = %d)\n", __func__, ret);
621 *status = le16_to_cpu(hub->status->port.wPortStatus);
622 *change = le16_to_cpu(hub->status->port.wPortChange);
626 mutex_unlock(&hub->status_mutex);
630 static void kick_khubd(struct usb_hub *hub)
634 spin_lock_irqsave(&hub_event_lock, flags);
635 if (!hub->disconnected && list_empty(&hub->event_list)) {
636 list_add_tail(&hub->event_list, &hub_event_list);
638 /* Suppress autosuspend until khubd runs */
639 usb_autopm_get_interface_no_resume(
640 to_usb_interface(hub->intfdev));
641 wake_up(&khubd_wait);
643 spin_unlock_irqrestore(&hub_event_lock, flags);
646 void usb_kick_khubd(struct usb_device *hdev)
648 struct usb_hub *hub = hdev_to_hub(hdev);
655 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
656 * Notification, which indicates it had initiated remote wakeup.
658 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
659 * device initiates resume, so the USB core will not receive notice of the
660 * resume through the normal hub interrupt URB.
662 void usb_wakeup_notification(struct usb_device *hdev,
663 unsigned int portnum)
670 hub = hdev_to_hub(hdev);
672 set_bit(portnum, hub->wakeup_bits);
676 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
678 /* completion function, fires on port status changes and various faults */
679 static void hub_irq(struct urb *urb)
681 struct usb_hub *hub = urb->context;
682 int status = urb->status;
687 case -ENOENT: /* synchronous unlink */
688 case -ECONNRESET: /* async unlink */
689 case -ESHUTDOWN: /* hardware going away */
692 default: /* presumably an error */
693 /* Cause a hub reset after 10 consecutive errors */
694 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
695 if ((++hub->nerrors < 10) || hub->error)
700 /* let khubd handle things */
701 case 0: /* we got data: port status changed */
703 for (i = 0; i < urb->actual_length; ++i)
704 bits |= ((unsigned long) ((*hub->buffer)[i]))
706 hub->event_bits[0] = bits;
712 /* Something happened, let khubd figure it out */
719 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
720 && status != -ENODEV && status != -EPERM)
721 dev_err (hub->intfdev, "resubmit --> %d\n", status);
724 /* USB 2.0 spec Section 11.24.2.3 */
726 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
728 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
729 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
734 * enumeration blocks khubd for a long time. we use keventd instead, since
735 * long blocking there is the exception, not the rule. accordingly, HCDs
736 * talking to TTs must queue control transfers (not just bulk and iso), so
737 * both can talk to the same hub concurrently.
739 static void hub_tt_work(struct work_struct *work)
741 struct usb_hub *hub =
742 container_of(work, struct usb_hub, tt.clear_work);
745 spin_lock_irqsave (&hub->tt.lock, flags);
746 while (!list_empty(&hub->tt.clear_list)) {
747 struct list_head *next;
748 struct usb_tt_clear *clear;
749 struct usb_device *hdev = hub->hdev;
750 const struct hc_driver *drv;
753 next = hub->tt.clear_list.next;
754 clear = list_entry (next, struct usb_tt_clear, clear_list);
755 list_del (&clear->clear_list);
757 /* drop lock so HCD can concurrently report other TT errors */
758 spin_unlock_irqrestore (&hub->tt.lock, flags);
759 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
762 "clear tt %d (%04x) error %d\n",
763 clear->tt, clear->devinfo, status);
765 /* Tell the HCD, even if the operation failed */
766 drv = clear->hcd->driver;
767 if (drv->clear_tt_buffer_complete)
768 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
771 spin_lock_irqsave(&hub->tt.lock, flags);
773 spin_unlock_irqrestore (&hub->tt.lock, flags);
777 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
778 * @urb: an URB associated with the failed or incomplete split transaction
780 * High speed HCDs use this to tell the hub driver that some split control or
781 * bulk transaction failed in a way that requires clearing internal state of
782 * a transaction translator. This is normally detected (and reported) from
785 * It may not be possible for that hub to handle additional full (or low)
786 * speed transactions until that state is fully cleared out.
788 int usb_hub_clear_tt_buffer(struct urb *urb)
790 struct usb_device *udev = urb->dev;
791 int pipe = urb->pipe;
792 struct usb_tt *tt = udev->tt;
794 struct usb_tt_clear *clear;
796 /* we've got to cope with an arbitrary number of pending TT clears,
797 * since each TT has "at least two" buffers that can need it (and
798 * there can be many TTs per hub). even if they're uncommon.
800 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
801 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
802 /* FIXME recover somehow ... RESET_TT? */
806 /* info that CLEAR_TT_BUFFER needs */
807 clear->tt = tt->multi ? udev->ttport : 1;
808 clear->devinfo = usb_pipeendpoint (pipe);
809 clear->devinfo |= udev->devnum << 4;
810 clear->devinfo |= usb_pipecontrol (pipe)
811 ? (USB_ENDPOINT_XFER_CONTROL << 11)
812 : (USB_ENDPOINT_XFER_BULK << 11);
813 if (usb_pipein (pipe))
814 clear->devinfo |= 1 << 15;
816 /* info for completion callback */
817 clear->hcd = bus_to_hcd(udev->bus);
820 /* tell keventd to clear state for this TT */
821 spin_lock_irqsave (&tt->lock, flags);
822 list_add_tail (&clear->clear_list, &tt->clear_list);
823 schedule_work(&tt->clear_work);
824 spin_unlock_irqrestore (&tt->lock, flags);
827 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
829 /* If do_delay is false, return the number of milliseconds the caller
832 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
835 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
837 u16 wHubCharacteristics =
838 le16_to_cpu(hub->descriptor->wHubCharacteristics);
840 /* Enable power on each port. Some hubs have reserved values
841 * of LPSM (> 2) in their descriptors, even though they are
842 * USB 2.0 hubs. Some hubs do not implement port-power switching
843 * but only emulate it. In all cases, the ports won't work
844 * unless we send these messages to the hub.
846 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
847 dev_dbg(hub->intfdev, "enabling power on all ports\n");
849 dev_dbg(hub->intfdev, "trying to enable port power on "
850 "non-switchable hub\n");
851 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
852 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
854 /* Wait at least 100 msec for power to become stable */
855 delay = max(pgood_delay, (unsigned) 100);
861 static int hub_hub_status(struct usb_hub *hub,
862 u16 *status, u16 *change)
866 mutex_lock(&hub->status_mutex);
867 ret = get_hub_status(hub->hdev, &hub->status->hub);
869 dev_err (hub->intfdev,
870 "%s failed (err = %d)\n", __func__, ret);
872 *status = le16_to_cpu(hub->status->hub.wHubStatus);
873 *change = le16_to_cpu(hub->status->hub.wHubChange);
876 mutex_unlock(&hub->status_mutex);
880 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
882 struct usb_device *hdev = hub->hdev;
885 if (hub->ports[port1 - 1]->child && set_state)
886 usb_set_device_state(hub->ports[port1 - 1]->child,
887 USB_STATE_NOTATTACHED);
888 if (!hub->error && !hub_is_superspeed(hub->hdev))
889 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
891 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
897 * Disable a port and mark a logical connect-change event, so that some
898 * time later khubd will disconnect() any existing usb_device on the port
899 * and will re-enumerate if there actually is a device attached.
901 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
903 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
904 hub_port_disable(hub, port1, 1);
906 /* FIXME let caller ask to power down the port:
907 * - some devices won't enumerate without a VBUS power cycle
908 * - SRP saves power that way
909 * - ... new call, TBD ...
910 * That's easy if this hub can switch power per-port, and
911 * khubd reactivates the port later (timer, SRP, etc).
912 * Powerdown must be optional, because of reset/DFU.
915 set_bit(port1, hub->change_bits);
920 * usb_remove_device - disable a device's port on its parent hub
921 * @udev: device to be disabled and removed
922 * Context: @udev locked, must be able to sleep.
924 * After @udev's port has been disabled, khubd is notified and it will
925 * see that the device has been disconnected. When the device is
926 * physically unplugged and something is plugged in, the events will
927 * be received and processed normally.
929 int usb_remove_device(struct usb_device *udev)
932 struct usb_interface *intf;
934 if (!udev->parent) /* Can't remove a root hub */
936 hub = hdev_to_hub(udev->parent);
937 intf = to_usb_interface(hub->intfdev);
939 usb_autopm_get_interface(intf);
940 set_bit(udev->portnum, hub->removed_bits);
941 hub_port_logical_disconnect(hub, udev->portnum);
942 usb_autopm_put_interface(intf);
946 enum hub_activation_type {
947 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
948 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
951 static void hub_init_func2(struct work_struct *ws);
952 static void hub_init_func3(struct work_struct *ws);
954 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
956 struct usb_device *hdev = hub->hdev;
961 bool need_debounce_delay = false;
964 /* Continue a partial initialization */
965 if (type == HUB_INIT2)
967 if (type == HUB_INIT3)
970 /* The superspeed hub except for root hub has to use Hub Depth
971 * value as an offset into the route string to locate the bits
972 * it uses to determine the downstream port number. So hub driver
973 * should send a set hub depth request to superspeed hub after
974 * the superspeed hub is set configuration in initialization or
977 * After a resume, port power should still be on.
978 * For any other type of activation, turn it on.
980 if (type != HUB_RESUME) {
981 if (hdev->parent && hub_is_superspeed(hdev)) {
982 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
983 HUB_SET_DEPTH, USB_RT_HUB,
984 hdev->level - 1, 0, NULL, 0,
985 USB_CTRL_SET_TIMEOUT);
987 dev_err(hub->intfdev,
988 "set hub depth failed\n");
991 /* Speed up system boot by using a delayed_work for the
992 * hub's initial power-up delays. This is pretty awkward
993 * and the implementation looks like a home-brewed sort of
994 * setjmp/longjmp, but it saves at least 100 ms for each
995 * root hub (assuming usbcore is compiled into the kernel
996 * rather than as a module). It adds up.
998 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
999 * because for those activation types the ports have to be
1000 * operational when we return. In theory this could be done
1001 * for HUB_POST_RESET, but it's easier not to.
1003 if (type == HUB_INIT) {
1004 delay = hub_power_on(hub, false);
1005 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1006 schedule_delayed_work(&hub->init_work,
1007 msecs_to_jiffies(delay));
1009 /* Suppress autosuspend until init is done */
1010 usb_autopm_get_interface_no_resume(
1011 to_usb_interface(hub->intfdev));
1012 return; /* Continues at init2: below */
1013 } else if (type == HUB_RESET_RESUME) {
1014 /* The internal host controller state for the hub device
1015 * may be gone after a host power loss on system resume.
1016 * Update the device's info so the HW knows it's a hub.
1018 hcd = bus_to_hcd(hdev->bus);
1019 if (hcd->driver->update_hub_device) {
1020 ret = hcd->driver->update_hub_device(hcd, hdev,
1021 &hub->tt, GFP_NOIO);
1023 dev_err(hub->intfdev, "Host not "
1024 "accepting hub info "
1026 dev_err(hub->intfdev, "LS/FS devices "
1027 "and hubs may not work "
1028 "under this hub\n.");
1031 hub_power_on(hub, true);
1033 hub_power_on(hub, true);
1038 /* Check each port and set hub->change_bits to let khubd know
1039 * which ports need attention.
1041 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1042 struct usb_device *udev = hub->ports[port1 - 1]->child;
1043 u16 portstatus, portchange;
1045 portstatus = portchange = 0;
1046 status = hub_port_status(hub, port1, &portstatus, &portchange);
1047 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1048 dev_dbg(hub->intfdev,
1049 "port %d: status %04x change %04x\n",
1050 port1, portstatus, portchange);
1052 /* After anything other than HUB_RESUME (i.e., initialization
1053 * or any sort of reset), every port should be disabled.
1054 * Unconnected ports should likewise be disabled (paranoia),
1055 * and so should ports for which we have no usb_device.
1057 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1058 type != HUB_RESUME ||
1059 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1061 udev->state == USB_STATE_NOTATTACHED)) {
1063 * USB3 protocol ports will automatically transition
1064 * to Enabled state when detect an USB3.0 device attach.
1065 * Do not disable USB3 protocol ports.
1067 if (!hub_is_superspeed(hdev)) {
1068 clear_port_feature(hdev, port1,
1069 USB_PORT_FEAT_ENABLE);
1070 portstatus &= ~USB_PORT_STAT_ENABLE;
1072 /* Pretend that power was lost for USB3 devs */
1073 portstatus &= ~USB_PORT_STAT_ENABLE;
1077 /* Clear status-change flags; we'll debounce later */
1078 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1079 need_debounce_delay = true;
1080 clear_port_feature(hub->hdev, port1,
1081 USB_PORT_FEAT_C_CONNECTION);
1083 if (portchange & USB_PORT_STAT_C_ENABLE) {
1084 need_debounce_delay = true;
1085 clear_port_feature(hub->hdev, port1,
1086 USB_PORT_FEAT_C_ENABLE);
1088 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1089 hub_is_superspeed(hub->hdev)) {
1090 need_debounce_delay = true;
1091 clear_port_feature(hub->hdev, port1,
1092 USB_PORT_FEAT_C_BH_PORT_RESET);
1094 /* We can forget about a "removed" device when there's a
1095 * physical disconnect or the connect status changes.
1097 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1098 (portchange & USB_PORT_STAT_C_CONNECTION))
1099 clear_bit(port1, hub->removed_bits);
1101 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1102 /* Tell khubd to disconnect the device or
1103 * check for a new connection
1105 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1106 set_bit(port1, hub->change_bits);
1108 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1109 bool port_resumed = (portstatus &
1110 USB_PORT_STAT_LINK_STATE) ==
1112 /* The power session apparently survived the resume.
1113 * If there was an overcurrent or suspend change
1114 * (i.e., remote wakeup request), have khubd
1115 * take care of it. Look at the port link state
1116 * for USB 3.0 hubs, since they don't have a suspend
1117 * change bit, and they don't set the port link change
1118 * bit on device-initiated resume.
1120 if (portchange || (hub_is_superspeed(hub->hdev) &&
1122 set_bit(port1, hub->change_bits);
1124 } else if (udev->persist_enabled) {
1126 udev->reset_resume = 1;
1128 set_bit(port1, hub->change_bits);
1131 /* The power session is gone; tell khubd */
1132 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1133 set_bit(port1, hub->change_bits);
1137 /* If no port-status-change flags were set, we don't need any
1138 * debouncing. If flags were set we can try to debounce the
1139 * ports all at once right now, instead of letting khubd do them
1140 * one at a time later on.
1142 * If any port-status changes do occur during this delay, khubd
1143 * will see them later and handle them normally.
1145 if (need_debounce_delay) {
1146 delay = HUB_DEBOUNCE_STABLE;
1148 /* Don't do a long sleep inside a workqueue routine */
1149 if (type == HUB_INIT2) {
1150 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1151 schedule_delayed_work(&hub->init_work,
1152 msecs_to_jiffies(delay));
1153 return; /* Continues at init3: below */
1161 status = usb_submit_urb(hub->urb, GFP_NOIO);
1163 dev_err(hub->intfdev, "activate --> %d\n", status);
1164 if (hub->has_indicators && blinkenlights)
1165 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1167 /* Scan all ports that need attention */
1170 /* Allow autosuspend if it was suppressed */
1171 if (type <= HUB_INIT3)
1172 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1175 /* Implement the continuations for the delays above */
1176 static void hub_init_func2(struct work_struct *ws)
1178 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1180 hub_activate(hub, HUB_INIT2);
1183 static void hub_init_func3(struct work_struct *ws)
1185 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1187 hub_activate(hub, HUB_INIT3);
1190 enum hub_quiescing_type {
1191 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1194 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1196 struct usb_device *hdev = hub->hdev;
1199 cancel_delayed_work_sync(&hub->init_work);
1201 /* khubd and related activity won't re-trigger */
1204 if (type != HUB_SUSPEND) {
1205 /* Disconnect all the children */
1206 for (i = 0; i < hdev->maxchild; ++i) {
1207 if (hub->ports[i]->child)
1208 usb_disconnect(&hub->ports[i]->child);
1212 /* Stop khubd and related activity */
1213 usb_kill_urb(hub->urb);
1214 if (hub->has_indicators)
1215 cancel_delayed_work_sync(&hub->leds);
1217 flush_work(&hub->tt.clear_work);
1220 /* caller has locked the hub device */
1221 static int hub_pre_reset(struct usb_interface *intf)
1223 struct usb_hub *hub = usb_get_intfdata(intf);
1225 hub_quiesce(hub, HUB_PRE_RESET);
1229 /* caller has locked the hub device */
1230 static int hub_post_reset(struct usb_interface *intf)
1232 struct usb_hub *hub = usb_get_intfdata(intf);
1234 hub_activate(hub, HUB_POST_RESET);
1238 static void usb_port_device_release(struct device *dev)
1240 struct usb_port *port_dev = to_usb_port(dev);
1245 static void usb_hub_remove_port_device(struct usb_hub *hub,
1248 device_unregister(&hub->ports[port1 - 1]->dev);
1251 struct device_type usb_port_device_type = {
1253 .release = usb_port_device_release,
1256 static int usb_hub_create_port_device(struct usb_hub *hub,
1259 struct usb_port *port_dev = NULL;
1262 port_dev = kzalloc(sizeof(*port_dev), GFP_KERNEL);
1268 hub->ports[port1 - 1] = port_dev;
1269 port_dev->dev.parent = hub->intfdev;
1270 port_dev->dev.type = &usb_port_device_type;
1271 dev_set_name(&port_dev->dev, "port%d", port1);
1273 retval = device_register(&port_dev->dev);
1275 goto error_register;
1279 put_device(&port_dev->dev);
1284 static int hub_configure(struct usb_hub *hub,
1285 struct usb_endpoint_descriptor *endpoint)
1287 struct usb_hcd *hcd;
1288 struct usb_device *hdev = hub->hdev;
1289 struct device *hub_dev = hub->intfdev;
1290 u16 hubstatus, hubchange;
1291 u16 wHubCharacteristics;
1294 char *message = "out of memory";
1296 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1302 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1307 mutex_init(&hub->status_mutex);
1309 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1310 if (!hub->descriptor) {
1315 /* Request the entire hub descriptor.
1316 * hub->descriptor can handle USB_MAXCHILDREN ports,
1317 * but the hub can/will return fewer bytes here.
1319 ret = get_hub_descriptor(hdev, hub->descriptor);
1321 message = "can't read hub descriptor";
1323 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1324 message = "hub has too many ports!";
1329 hdev->maxchild = hub->descriptor->bNbrPorts;
1330 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1331 (hdev->maxchild == 1) ? "" : "s");
1333 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1340 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1342 /* FIXME for USB 3.0, skip for now */
1343 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1344 !(hub_is_superspeed(hdev))) {
1346 char portstr [USB_MAXCHILDREN + 1];
1348 for (i = 0; i < hdev->maxchild; i++)
1349 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1350 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1352 portstr[hdev->maxchild] = 0;
1353 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1355 dev_dbg(hub_dev, "standalone hub\n");
1357 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1358 case HUB_CHAR_COMMON_LPSM:
1359 dev_dbg(hub_dev, "ganged power switching\n");
1361 case HUB_CHAR_INDV_PORT_LPSM:
1362 dev_dbg(hub_dev, "individual port power switching\n");
1364 case HUB_CHAR_NO_LPSM:
1366 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1370 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1371 case HUB_CHAR_COMMON_OCPM:
1372 dev_dbg(hub_dev, "global over-current protection\n");
1374 case HUB_CHAR_INDV_PORT_OCPM:
1375 dev_dbg(hub_dev, "individual port over-current protection\n");
1377 case HUB_CHAR_NO_OCPM:
1379 dev_dbg(hub_dev, "no over-current protection\n");
1383 spin_lock_init (&hub->tt.lock);
1384 INIT_LIST_HEAD (&hub->tt.clear_list);
1385 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1386 switch (hdev->descriptor.bDeviceProtocol) {
1389 case USB_HUB_PR_HS_SINGLE_TT:
1390 dev_dbg(hub_dev, "Single TT\n");
1393 case USB_HUB_PR_HS_MULTI_TT:
1394 ret = usb_set_interface(hdev, 0, 1);
1396 dev_dbg(hub_dev, "TT per port\n");
1399 dev_err(hub_dev, "Using single TT (err %d)\n",
1404 /* USB 3.0 hubs don't have a TT */
1407 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1408 hdev->descriptor.bDeviceProtocol);
1412 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1413 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1414 case HUB_TTTT_8_BITS:
1415 if (hdev->descriptor.bDeviceProtocol != 0) {
1416 hub->tt.think_time = 666;
1417 dev_dbg(hub_dev, "TT requires at most %d "
1418 "FS bit times (%d ns)\n",
1419 8, hub->tt.think_time);
1422 case HUB_TTTT_16_BITS:
1423 hub->tt.think_time = 666 * 2;
1424 dev_dbg(hub_dev, "TT requires at most %d "
1425 "FS bit times (%d ns)\n",
1426 16, hub->tt.think_time);
1428 case HUB_TTTT_24_BITS:
1429 hub->tt.think_time = 666 * 3;
1430 dev_dbg(hub_dev, "TT requires at most %d "
1431 "FS bit times (%d ns)\n",
1432 24, hub->tt.think_time);
1434 case HUB_TTTT_32_BITS:
1435 hub->tt.think_time = 666 * 4;
1436 dev_dbg(hub_dev, "TT requires at most %d "
1437 "FS bit times (%d ns)\n",
1438 32, hub->tt.think_time);
1442 /* probe() zeroes hub->indicator[] */
1443 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1444 hub->has_indicators = 1;
1445 dev_dbg(hub_dev, "Port indicators are supported\n");
1448 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1449 hub->descriptor->bPwrOn2PwrGood * 2);
1451 /* power budgeting mostly matters with bus-powered hubs,
1452 * and battery-powered root hubs (may provide just 8 mA).
1454 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1456 message = "can't get hub status";
1459 le16_to_cpus(&hubstatus);
1460 if (hdev == hdev->bus->root_hub) {
1461 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1462 hub->mA_per_port = 500;
1464 hub->mA_per_port = hdev->bus_mA;
1465 hub->limited_power = 1;
1467 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1468 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1469 hub->descriptor->bHubContrCurrent);
1470 hub->limited_power = 1;
1471 if (hdev->maxchild > 0) {
1472 int remaining = hdev->bus_mA -
1473 hub->descriptor->bHubContrCurrent;
1475 if (remaining < hdev->maxchild * 100)
1477 "insufficient power available "
1478 "to use all downstream ports\n");
1479 hub->mA_per_port = 100; /* 7.2.1.1 */
1481 } else { /* Self-powered external hub */
1482 /* FIXME: What about battery-powered external hubs that
1483 * provide less current per port? */
1484 hub->mA_per_port = 500;
1486 if (hub->mA_per_port < 500)
1487 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1490 /* Update the HCD's internal representation of this hub before khubd
1491 * starts getting port status changes for devices under the hub.
1493 hcd = bus_to_hcd(hdev->bus);
1494 if (hcd->driver->update_hub_device) {
1495 ret = hcd->driver->update_hub_device(hcd, hdev,
1496 &hub->tt, GFP_KERNEL);
1498 message = "can't update HCD hub info";
1503 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1505 message = "can't get hub status";
1509 /* local power status reports aren't always correct */
1510 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1511 dev_dbg(hub_dev, "local power source is %s\n",
1512 (hubstatus & HUB_STATUS_LOCAL_POWER)
1513 ? "lost (inactive)" : "good");
1515 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1516 dev_dbg(hub_dev, "%sover-current condition exists\n",
1517 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1519 /* set up the interrupt endpoint
1520 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1521 * bytes as USB2.0[11.12.3] says because some hubs are known
1522 * to send more data (and thus cause overflow). For root hubs,
1523 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1524 * to be big enough for at least USB_MAXCHILDREN ports. */
1525 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1526 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1528 if (maxp > sizeof(*hub->buffer))
1529 maxp = sizeof(*hub->buffer);
1531 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1537 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1538 hub, endpoint->bInterval);
1540 /* maybe cycle the hub leds */
1541 if (hub->has_indicators && blinkenlights)
1542 hub->indicator [0] = INDICATOR_CYCLE;
1544 for (i = 0; i < hdev->maxchild; i++)
1545 if (usb_hub_create_port_device(hub, i + 1) < 0)
1546 dev_err(hub->intfdev,
1547 "couldn't create port%d device.\n", i + 1);
1549 hub_activate(hub, HUB_INIT);
1553 dev_err (hub_dev, "config failed, %s (err %d)\n",
1555 /* hub_disconnect() frees urb and descriptor */
1559 static void hub_release(struct kref *kref)
1561 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1563 usb_put_intf(to_usb_interface(hub->intfdev));
1567 static unsigned highspeed_hubs;
1569 static void hub_disconnect(struct usb_interface *intf)
1571 struct usb_hub *hub = usb_get_intfdata(intf);
1572 struct usb_device *hdev = interface_to_usbdev(intf);
1575 /* Take the hub off the event list and don't let it be added again */
1576 spin_lock_irq(&hub_event_lock);
1577 if (!list_empty(&hub->event_list)) {
1578 list_del_init(&hub->event_list);
1579 usb_autopm_put_interface_no_suspend(intf);
1581 hub->disconnected = 1;
1582 spin_unlock_irq(&hub_event_lock);
1584 /* Disconnect all children and quiesce the hub */
1586 hub_quiesce(hub, HUB_DISCONNECT);
1588 usb_set_intfdata (intf, NULL);
1590 for (i = 0; i < hdev->maxchild; i++)
1591 usb_hub_remove_port_device(hub, i + 1);
1592 hub->hdev->maxchild = 0;
1594 if (hub->hdev->speed == USB_SPEED_HIGH)
1597 usb_free_urb(hub->urb);
1599 kfree(hub->descriptor);
1603 kref_put(&hub->kref, hub_release);
1606 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1608 struct usb_host_interface *desc;
1609 struct usb_endpoint_descriptor *endpoint;
1610 struct usb_device *hdev;
1611 struct usb_hub *hub;
1613 desc = intf->cur_altsetting;
1614 hdev = interface_to_usbdev(intf);
1617 * Set default autosuspend delay as 0 to speedup bus suspend,
1618 * based on the below considerations:
1620 * - Unlike other drivers, the hub driver does not rely on the
1621 * autosuspend delay to provide enough time to handle a wakeup
1622 * event, and the submitted status URB is just to check future
1623 * change on hub downstream ports, so it is safe to do it.
1625 * - The patch might cause one or more auto supend/resume for
1626 * below very rare devices when they are plugged into hub
1629 * devices having trouble initializing, and disconnect
1630 * themselves from the bus and then reconnect a second
1633 * devices just for downloading firmware, and disconnects
1634 * themselves after completing it
1636 * For these quite rare devices, their drivers may change the
1637 * autosuspend delay of their parent hub in the probe() to one
1638 * appropriate value to avoid the subtle problem if someone
1641 * - The patch may cause one or more auto suspend/resume on
1642 * hub during running 'lsusb', but it is probably too
1643 * infrequent to worry about.
1645 * - Change autosuspend delay of hub can avoid unnecessary auto
1646 * suspend timer for hub, also may decrease power consumption
1649 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1651 /* Hubs have proper suspend/resume support. */
1652 usb_enable_autosuspend(hdev);
1654 if (hdev->level == MAX_TOPO_LEVEL) {
1656 "Unsupported bus topology: hub nested too deep\n");
1660 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1662 dev_warn(&intf->dev, "ignoring external hub\n");
1667 /* Some hubs have a subclass of 1, which AFAICT according to the */
1668 /* specs is not defined, but it works */
1669 if ((desc->desc.bInterfaceSubClass != 0) &&
1670 (desc->desc.bInterfaceSubClass != 1)) {
1672 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1676 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1677 if (desc->desc.bNumEndpoints != 1)
1678 goto descriptor_error;
1680 endpoint = &desc->endpoint[0].desc;
1682 /* If it's not an interrupt in endpoint, we'd better punt! */
1683 if (!usb_endpoint_is_int_in(endpoint))
1684 goto descriptor_error;
1686 /* We found a hub */
1687 dev_info (&intf->dev, "USB hub found\n");
1689 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1691 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1695 kref_init(&hub->kref);
1696 INIT_LIST_HEAD(&hub->event_list);
1697 hub->intfdev = &intf->dev;
1699 INIT_DELAYED_WORK(&hub->leds, led_work);
1700 INIT_DELAYED_WORK(&hub->init_work, NULL);
1703 usb_set_intfdata (intf, hub);
1704 intf->needs_remote_wakeup = 1;
1706 if (hdev->speed == USB_SPEED_HIGH)
1709 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1710 hub->quirk_check_port_auto_suspend = 1;
1712 if (hub_configure(hub, endpoint) >= 0)
1715 hub_disconnect (intf);
1720 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1722 struct usb_device *hdev = interface_to_usbdev (intf);
1723 struct usb_hub *hub = hdev_to_hub(hdev);
1725 /* assert ifno == 0 (part of hub spec) */
1727 case USBDEVFS_HUB_PORTINFO: {
1728 struct usbdevfs_hub_portinfo *info = user_data;
1731 spin_lock_irq(&device_state_lock);
1732 if (hdev->devnum <= 0)
1735 info->nports = hdev->maxchild;
1736 for (i = 0; i < info->nports; i++) {
1737 if (hub->ports[i]->child == NULL)
1741 hub->ports[i]->child->devnum;
1744 spin_unlock_irq(&device_state_lock);
1746 return info->nports + 1;
1755 * Allow user programs to claim ports on a hub. When a device is attached
1756 * to one of these "claimed" ports, the program will "own" the device.
1758 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1759 struct dev_state ***ppowner)
1761 if (hdev->state == USB_STATE_NOTATTACHED)
1763 if (port1 == 0 || port1 > hdev->maxchild)
1766 /* This assumes that devices not managed by the hub driver
1767 * will always have maxchild equal to 0.
1769 *ppowner = &(hdev_to_hub(hdev)->ports[port1 - 1]->port_owner);
1773 /* In the following three functions, the caller must hold hdev's lock */
1774 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1775 struct dev_state *owner)
1778 struct dev_state **powner;
1780 rc = find_port_owner(hdev, port1, &powner);
1789 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1790 struct dev_state *owner)
1793 struct dev_state **powner;
1795 rc = find_port_owner(hdev, port1, &powner);
1798 if (*powner != owner)
1804 void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1806 struct usb_hub *hub = hdev_to_hub(hdev);
1809 for (n = 0; n < hdev->maxchild; n++) {
1810 if (hub->ports[n]->port_owner == owner)
1811 hub->ports[n]->port_owner = NULL;
1816 /* The caller must hold udev's lock */
1817 bool usb_device_is_owned(struct usb_device *udev)
1819 struct usb_hub *hub;
1821 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1823 hub = hdev_to_hub(udev->parent);
1824 return !!hub->ports[udev->portnum - 1]->port_owner;
1827 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1829 struct usb_hub *hub = hdev_to_hub(udev);
1832 for (i = 0; i < udev->maxchild; ++i) {
1833 if (hub->ports[i]->child)
1834 recursively_mark_NOTATTACHED(hub->ports[i]->child);
1836 if (udev->state == USB_STATE_SUSPENDED)
1837 udev->active_duration -= jiffies;
1838 udev->state = USB_STATE_NOTATTACHED;
1842 * usb_set_device_state - change a device's current state (usbcore, hcds)
1843 * @udev: pointer to device whose state should be changed
1844 * @new_state: new state value to be stored
1846 * udev->state is _not_ fully protected by the device lock. Although
1847 * most transitions are made only while holding the lock, the state can
1848 * can change to USB_STATE_NOTATTACHED at almost any time. This
1849 * is so that devices can be marked as disconnected as soon as possible,
1850 * without having to wait for any semaphores to be released. As a result,
1851 * all changes to any device's state must be protected by the
1852 * device_state_lock spinlock.
1854 * Once a device has been added to the device tree, all changes to its state
1855 * should be made using this routine. The state should _not_ be set directly.
1857 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1858 * Otherwise udev->state is set to new_state, and if new_state is
1859 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1860 * to USB_STATE_NOTATTACHED.
1862 void usb_set_device_state(struct usb_device *udev,
1863 enum usb_device_state new_state)
1865 unsigned long flags;
1868 spin_lock_irqsave(&device_state_lock, flags);
1869 if (udev->state == USB_STATE_NOTATTACHED)
1871 else if (new_state != USB_STATE_NOTATTACHED) {
1873 /* root hub wakeup capabilities are managed out-of-band
1874 * and may involve silicon errata ... ignore them here.
1877 if (udev->state == USB_STATE_SUSPENDED
1878 || new_state == USB_STATE_SUSPENDED)
1879 ; /* No change to wakeup settings */
1880 else if (new_state == USB_STATE_CONFIGURED)
1881 wakeup = udev->actconfig->desc.bmAttributes
1882 & USB_CONFIG_ATT_WAKEUP;
1886 if (udev->state == USB_STATE_SUSPENDED &&
1887 new_state != USB_STATE_SUSPENDED)
1888 udev->active_duration -= jiffies;
1889 else if (new_state == USB_STATE_SUSPENDED &&
1890 udev->state != USB_STATE_SUSPENDED)
1891 udev->active_duration += jiffies;
1892 udev->state = new_state;
1894 recursively_mark_NOTATTACHED(udev);
1895 spin_unlock_irqrestore(&device_state_lock, flags);
1897 device_set_wakeup_capable(&udev->dev, wakeup);
1899 EXPORT_SYMBOL_GPL(usb_set_device_state);
1902 * Choose a device number.
1904 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1905 * USB-2.0 buses they are also used as device addresses, however on
1906 * USB-3.0 buses the address is assigned by the controller hardware
1907 * and it usually is not the same as the device number.
1909 * WUSB devices are simple: they have no hubs behind, so the mapping
1910 * device <-> virtual port number becomes 1:1. Why? to simplify the
1911 * life of the device connection logic in
1912 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1913 * handshake we need to assign a temporary address in the unauthorized
1914 * space. For simplicity we use the first virtual port number found to
1915 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1916 * and that becomes it's address [X < 128] or its unauthorized address
1919 * We add 1 as an offset to the one-based USB-stack port number
1920 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1921 * 0 is reserved by USB for default address; (b) Linux's USB stack
1922 * uses always #1 for the root hub of the controller. So USB stack's
1923 * port #1, which is wusb virtual-port #0 has address #2.
1925 * Devices connected under xHCI are not as simple. The host controller
1926 * supports virtualization, so the hardware assigns device addresses and
1927 * the HCD must setup data structures before issuing a set address
1928 * command to the hardware.
1930 static void choose_devnum(struct usb_device *udev)
1933 struct usb_bus *bus = udev->bus;
1935 /* If khubd ever becomes multithreaded, this will need a lock */
1937 devnum = udev->portnum + 1;
1938 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1940 /* Try to allocate the next devnum beginning at
1941 * bus->devnum_next. */
1942 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1945 devnum = find_next_zero_bit(bus->devmap.devicemap,
1947 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1950 set_bit(devnum, bus->devmap.devicemap);
1951 udev->devnum = devnum;
1955 static void release_devnum(struct usb_device *udev)
1957 if (udev->devnum > 0) {
1958 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1963 static void update_devnum(struct usb_device *udev, int devnum)
1965 /* The address for a WUSB device is managed by wusbcore. */
1967 udev->devnum = devnum;
1970 static void hub_free_dev(struct usb_device *udev)
1972 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1974 /* Root hubs aren't real devices, so don't free HCD resources */
1975 if (hcd->driver->free_dev && udev->parent)
1976 hcd->driver->free_dev(hcd, udev);
1980 * usb_disconnect - disconnect a device (usbcore-internal)
1981 * @pdev: pointer to device being disconnected
1982 * Context: !in_interrupt ()
1984 * Something got disconnected. Get rid of it and all of its children.
1986 * If *pdev is a normal device then the parent hub must already be locked.
1987 * If *pdev is a root hub then this routine will acquire the
1988 * usb_bus_list_lock on behalf of the caller.
1990 * Only hub drivers (including virtual root hub drivers for host
1991 * controllers) should ever call this.
1993 * This call is synchronous, and may not be used in an interrupt context.
1995 void usb_disconnect(struct usb_device **pdev)
1997 struct usb_device *udev = *pdev;
1998 struct usb_hub *hub = hdev_to_hub(udev);
2001 /* mark the device as inactive, so any further urb submissions for
2002 * this device (and any of its children) will fail immediately.
2003 * this quiesces everything except pending urbs.
2005 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2006 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2009 usb_lock_device(udev);
2011 /* Free up all the children before we remove this device */
2012 for (i = 0; i < udev->maxchild; i++) {
2013 if (hub->ports[i]->child)
2014 usb_disconnect(&hub->ports[i]->child);
2017 /* deallocate hcd/hardware state ... nuking all pending urbs and
2018 * cleaning up all state associated with the current configuration
2019 * so that the hardware is now fully quiesced.
2021 dev_dbg (&udev->dev, "unregistering device\n");
2022 usb_disable_device(udev, 0);
2023 usb_hcd_synchronize_unlinks(udev);
2025 usb_remove_ep_devs(&udev->ep0);
2026 usb_unlock_device(udev);
2028 /* Unregister the device. The device driver is responsible
2029 * for de-configuring the device and invoking the remove-device
2030 * notifier chain (used by usbfs and possibly others).
2032 device_del(&udev->dev);
2034 /* Free the device number and delete the parent's children[]
2035 * (or root_hub) pointer.
2037 release_devnum(udev);
2039 /* Avoid races with recursively_mark_NOTATTACHED() */
2040 spin_lock_irq(&device_state_lock);
2042 spin_unlock_irq(&device_state_lock);
2046 put_device(&udev->dev);
2049 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2050 static void show_string(struct usb_device *udev, char *id, char *string)
2054 dev_info(&udev->dev, "%s: %s\n", id, string);
2057 static void announce_device(struct usb_device *udev)
2059 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2060 le16_to_cpu(udev->descriptor.idVendor),
2061 le16_to_cpu(udev->descriptor.idProduct));
2062 dev_info(&udev->dev,
2063 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2064 udev->descriptor.iManufacturer,
2065 udev->descriptor.iProduct,
2066 udev->descriptor.iSerialNumber);
2067 show_string(udev, "Product", udev->product);
2068 show_string(udev, "Manufacturer", udev->manufacturer);
2069 show_string(udev, "SerialNumber", udev->serial);
2072 static inline void announce_device(struct usb_device *udev) { }
2075 #ifdef CONFIG_USB_OTG
2076 #include "otg_whitelist.h"
2080 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2081 * @udev: newly addressed device (in ADDRESS state)
2083 * Finish enumeration for On-The-Go devices
2085 static int usb_enumerate_device_otg(struct usb_device *udev)
2089 #ifdef CONFIG_USB_OTG
2091 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2092 * to wake us after we've powered off VBUS; and HNP, switching roles
2093 * "host" to "peripheral". The OTG descriptor helps figure this out.
2095 if (!udev->bus->is_b_host
2097 && udev->parent == udev->bus->root_hub) {
2098 struct usb_otg_descriptor *desc = NULL;
2099 struct usb_bus *bus = udev->bus;
2101 /* descriptor may appear anywhere in config */
2102 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2103 le16_to_cpu(udev->config[0].desc.wTotalLength),
2104 USB_DT_OTG, (void **) &desc) == 0) {
2105 if (desc->bmAttributes & USB_OTG_HNP) {
2106 unsigned port1 = udev->portnum;
2108 dev_info(&udev->dev,
2109 "Dual-Role OTG device on %sHNP port\n",
2110 (port1 == bus->otg_port)
2113 /* enable HNP before suspend, it's simpler */
2114 if (port1 == bus->otg_port)
2115 bus->b_hnp_enable = 1;
2116 err = usb_control_msg(udev,
2117 usb_sndctrlpipe(udev, 0),
2118 USB_REQ_SET_FEATURE, 0,
2120 ? USB_DEVICE_B_HNP_ENABLE
2121 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2122 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2124 /* OTG MESSAGE: report errors here,
2125 * customize to match your product.
2127 dev_info(&udev->dev,
2128 "can't set HNP mode: %d\n",
2130 bus->b_hnp_enable = 0;
2136 if (!is_targeted(udev)) {
2138 /* Maybe it can talk to us, though we can't talk to it.
2139 * (Includes HNP test device.)
2141 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2142 err = usb_port_suspend(udev, PMSG_SUSPEND);
2144 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2156 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2157 * @udev: newly addressed device (in ADDRESS state)
2159 * This is only called by usb_new_device() and usb_authorize_device()
2160 * and FIXME -- all comments that apply to them apply here wrt to
2163 * If the device is WUSB and not authorized, we don't attempt to read
2164 * the string descriptors, as they will be errored out by the device
2165 * until it has been authorized.
2167 static int usb_enumerate_device(struct usb_device *udev)
2171 if (udev->config == NULL) {
2172 err = usb_get_configuration(udev);
2174 dev_err(&udev->dev, "can't read configurations, error %d\n",
2179 if (udev->wusb == 1 && udev->authorized == 0) {
2180 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2181 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2182 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2185 /* read the standard strings and cache them if present */
2186 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2187 udev->manufacturer = usb_cache_string(udev,
2188 udev->descriptor.iManufacturer);
2189 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2191 err = usb_enumerate_device_otg(udev);
2195 usb_detect_interface_quirks(udev);
2200 static void set_usb_port_removable(struct usb_device *udev)
2202 struct usb_device *hdev = udev->parent;
2203 struct usb_hub *hub;
2204 u8 port = udev->portnum;
2205 u16 wHubCharacteristics;
2206 bool removable = true;
2211 hub = hdev_to_hub(udev->parent);
2213 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2215 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2218 if (hub_is_superspeed(hdev)) {
2219 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2223 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2228 udev->removable = USB_DEVICE_REMOVABLE;
2230 udev->removable = USB_DEVICE_FIXED;
2234 * usb_new_device - perform initial device setup (usbcore-internal)
2235 * @udev: newly addressed device (in ADDRESS state)
2237 * This is called with devices which have been detected but not fully
2238 * enumerated. The device descriptor is available, but not descriptors
2239 * for any device configuration. The caller must have locked either
2240 * the parent hub (if udev is a normal device) or else the
2241 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2242 * udev has already been installed, but udev is not yet visible through
2243 * sysfs or other filesystem code.
2245 * It will return if the device is configured properly or not. Zero if
2246 * the interface was registered with the driver core; else a negative
2249 * This call is synchronous, and may not be used in an interrupt context.
2251 * Only the hub driver or root-hub registrar should ever call this.
2253 int usb_new_device(struct usb_device *udev)
2258 /* Initialize non-root-hub device wakeup to disabled;
2259 * device (un)configuration controls wakeup capable
2260 * sysfs power/wakeup controls wakeup enabled/disabled
2262 device_init_wakeup(&udev->dev, 0);
2265 /* Tell the runtime-PM framework the device is active */
2266 pm_runtime_set_active(&udev->dev);
2267 pm_runtime_get_noresume(&udev->dev);
2268 pm_runtime_use_autosuspend(&udev->dev);
2269 pm_runtime_enable(&udev->dev);
2271 /* By default, forbid autosuspend for all devices. It will be
2272 * allowed for hubs during binding.
2274 usb_disable_autosuspend(udev);
2276 err = usb_enumerate_device(udev); /* Read descriptors */
2279 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2280 udev->devnum, udev->bus->busnum,
2281 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2282 /* export the usbdev device-node for libusb */
2283 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2284 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2286 /* Tell the world! */
2287 announce_device(udev);
2290 add_device_randomness(udev->serial, strlen(udev->serial));
2292 add_device_randomness(udev->product, strlen(udev->product));
2293 if (udev->manufacturer)
2294 add_device_randomness(udev->manufacturer,
2295 strlen(udev->manufacturer));
2297 device_enable_async_suspend(&udev->dev);
2300 * check whether the hub marks this port as non-removable. Do it
2301 * now so that platform-specific data can override it in
2305 set_usb_port_removable(udev);
2307 /* Register the device. The device driver is responsible
2308 * for configuring the device and invoking the add-device
2309 * notifier chain (used by usbfs and possibly others).
2311 err = device_add(&udev->dev);
2313 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2317 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2318 usb_mark_last_busy(udev);
2319 pm_runtime_put_sync_autosuspend(&udev->dev);
2323 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2324 pm_runtime_disable(&udev->dev);
2325 pm_runtime_set_suspended(&udev->dev);
2331 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2332 * @usb_dev: USB device
2334 * Move the USB device to a very basic state where interfaces are disabled
2335 * and the device is in fact unconfigured and unusable.
2337 * We share a lock (that we have) with device_del(), so we need to
2340 int usb_deauthorize_device(struct usb_device *usb_dev)
2342 usb_lock_device(usb_dev);
2343 if (usb_dev->authorized == 0)
2344 goto out_unauthorized;
2346 usb_dev->authorized = 0;
2347 usb_set_configuration(usb_dev, -1);
2349 kfree(usb_dev->product);
2350 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2351 kfree(usb_dev->manufacturer);
2352 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2353 kfree(usb_dev->serial);
2354 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2356 usb_destroy_configuration(usb_dev);
2357 usb_dev->descriptor.bNumConfigurations = 0;
2360 usb_unlock_device(usb_dev);
2365 int usb_authorize_device(struct usb_device *usb_dev)
2369 usb_lock_device(usb_dev);
2370 if (usb_dev->authorized == 1)
2371 goto out_authorized;
2373 result = usb_autoresume_device(usb_dev);
2375 dev_err(&usb_dev->dev,
2376 "can't autoresume for authorization: %d\n", result);
2377 goto error_autoresume;
2379 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2381 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2382 "authorization: %d\n", result);
2383 goto error_device_descriptor;
2386 kfree(usb_dev->product);
2387 usb_dev->product = NULL;
2388 kfree(usb_dev->manufacturer);
2389 usb_dev->manufacturer = NULL;
2390 kfree(usb_dev->serial);
2391 usb_dev->serial = NULL;
2393 usb_dev->authorized = 1;
2394 result = usb_enumerate_device(usb_dev);
2396 goto error_enumerate;
2397 /* Choose and set the configuration. This registers the interfaces
2398 * with the driver core and lets interface drivers bind to them.
2400 c = usb_choose_configuration(usb_dev);
2402 result = usb_set_configuration(usb_dev, c);
2404 dev_err(&usb_dev->dev,
2405 "can't set config #%d, error %d\n", c, result);
2406 /* This need not be fatal. The user can try to
2407 * set other configurations. */
2410 dev_info(&usb_dev->dev, "authorized to connect\n");
2413 error_device_descriptor:
2414 usb_autosuspend_device(usb_dev);
2417 usb_unlock_device(usb_dev); // complements locktree
2422 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2423 static unsigned hub_is_wusb(struct usb_hub *hub)
2425 struct usb_hcd *hcd;
2426 if (hub->hdev->parent != NULL) /* not a root hub? */
2428 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2429 return hcd->wireless;
2433 #define PORT_RESET_TRIES 5
2434 #define SET_ADDRESS_TRIES 2
2435 #define GET_DESCRIPTOR_TRIES 2
2436 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2437 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2439 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2440 #define HUB_SHORT_RESET_TIME 10
2441 #define HUB_BH_RESET_TIME 50
2442 #define HUB_LONG_RESET_TIME 200
2443 #define HUB_RESET_TIMEOUT 500
2445 static int hub_port_reset(struct usb_hub *hub, int port1,
2446 struct usb_device *udev, unsigned int delay, bool warm);
2448 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2449 * Port worm reset is required to recover
2451 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2453 return hub_is_superspeed(hub->hdev) &&
2454 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2455 USB_SS_PORT_LS_SS_INACTIVE) ||
2456 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2457 USB_SS_PORT_LS_COMP_MOD)) ;
2460 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2461 struct usb_device *udev, unsigned int delay, bool warm)
2463 int delay_time, ret;
2467 for (delay_time = 0;
2468 delay_time < HUB_RESET_TIMEOUT;
2469 delay_time += delay) {
2470 /* wait to give the device a chance to reset */
2473 /* read and decode port status */
2474 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2479 * Some buggy devices require a warm reset to be issued even
2480 * when the port appears not to be connected.
2484 * Some buggy devices can cause an NEC host controller
2485 * to transition to the "Error" state after a hot port
2486 * reset. This will show up as the port state in
2487 * "Inactive", and the port may also report a
2488 * disconnect. Forcing a warm port reset seems to make
2491 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2493 if (hub_port_warm_reset_required(hub, portstatus)) {
2496 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2497 clear_port_feature(hub->hdev, port1,
2498 USB_PORT_FEAT_C_CONNECTION);
2499 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2500 clear_port_feature(hub->hdev, port1,
2501 USB_PORT_FEAT_C_PORT_LINK_STATE);
2502 if (portchange & USB_PORT_STAT_C_RESET)
2503 clear_port_feature(hub->hdev, port1,
2504 USB_PORT_FEAT_C_RESET);
2505 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2507 ret = hub_port_reset(hub, port1,
2508 udev, HUB_BH_RESET_TIME,
2510 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2511 clear_port_feature(hub->hdev, port1,
2512 USB_PORT_FEAT_C_CONNECTION);
2515 /* Device went away? */
2516 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2519 /* bomb out completely if the connection bounced */
2520 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2523 /* if we`ve finished resetting, then break out of
2526 if (!(portstatus & USB_PORT_STAT_RESET) &&
2527 (portstatus & USB_PORT_STAT_ENABLE)) {
2528 if (hub_is_wusb(hub))
2529 udev->speed = USB_SPEED_WIRELESS;
2530 else if (hub_is_superspeed(hub->hdev))
2531 udev->speed = USB_SPEED_SUPER;
2532 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2533 udev->speed = USB_SPEED_HIGH;
2534 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2535 udev->speed = USB_SPEED_LOW;
2537 udev->speed = USB_SPEED_FULL;
2541 if (portchange & USB_PORT_STAT_C_BH_RESET)
2545 /* switch to the long delay after two short delay failures */
2546 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2547 delay = HUB_LONG_RESET_TIME;
2549 dev_dbg (hub->intfdev,
2550 "port %d not %sreset yet, waiting %dms\n",
2551 port1, warm ? "warm " : "", delay);
2557 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2558 struct usb_device *udev, int *status, bool warm)
2563 struct usb_hcd *hcd;
2564 /* TRSTRCY = 10 ms; plus some extra */
2566 update_devnum(udev, 0);
2567 hcd = bus_to_hcd(udev->bus);
2568 /* The xHC may think the device is already reset,
2569 * so ignore the status.
2571 if (hcd->driver->reset_device)
2572 hcd->driver->reset_device(hcd, udev);
2577 clear_port_feature(hub->hdev,
2578 port1, USB_PORT_FEAT_C_RESET);
2579 /* FIXME need disconnect() for NOTATTACHED device */
2580 if (hub_is_superspeed(hub->hdev)) {
2581 clear_port_feature(hub->hdev, port1,
2582 USB_PORT_FEAT_C_BH_PORT_RESET);
2583 clear_port_feature(hub->hdev, port1,
2584 USB_PORT_FEAT_C_PORT_LINK_STATE);
2587 usb_set_device_state(udev, *status
2588 ? USB_STATE_NOTATTACHED
2589 : USB_STATE_DEFAULT);
2594 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2595 static int hub_port_reset(struct usb_hub *hub, int port1,
2596 struct usb_device *udev, unsigned int delay, bool warm)
2601 /* Block EHCI CF initialization during the port reset.
2602 * Some companion controllers don't like it when they mix.
2604 down_read(&ehci_cf_port_reset_rwsem);
2606 if (!hub_is_superspeed(hub->hdev)) {
2607 dev_err(hub->intfdev, "only USB3 hub support "
2613 /* Reset the port */
2614 for (i = 0; i < PORT_RESET_TRIES; i++) {
2615 status = set_port_feature(hub->hdev, port1, (warm ?
2616 USB_PORT_FEAT_BH_PORT_RESET :
2617 USB_PORT_FEAT_RESET));
2619 dev_err(hub->intfdev,
2620 "cannot %sreset port %d (err = %d)\n",
2621 warm ? "warm " : "", port1, status);
2623 status = hub_port_wait_reset(hub, port1, udev, delay,
2625 if (status && status != -ENOTCONN)
2626 dev_dbg(hub->intfdev,
2627 "port_wait_reset: err = %d\n",
2631 /* return on disconnect or reset */
2632 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2633 hub_port_finish_reset(hub, port1, udev, &status, warm);
2637 dev_dbg (hub->intfdev,
2638 "port %d not enabled, trying %sreset again...\n",
2639 port1, warm ? "warm " : "");
2640 delay = HUB_LONG_RESET_TIME;
2643 dev_err (hub->intfdev,
2644 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2649 up_read(&ehci_cf_port_reset_rwsem);
2654 /* Check if a port is power on */
2655 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2659 if (hub_is_superspeed(hub->hdev)) {
2660 if (portstatus & USB_SS_PORT_STAT_POWER)
2663 if (portstatus & USB_PORT_STAT_POWER)
2672 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2673 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2677 if (hub_is_superspeed(hub->hdev)) {
2678 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2679 == USB_SS_PORT_LS_U3)
2682 if (portstatus & USB_PORT_STAT_SUSPEND)
2689 /* Determine whether the device on a port is ready for a normal resume,
2690 * is ready for a reset-resume, or should be disconnected.
2692 static int check_port_resume_type(struct usb_device *udev,
2693 struct usb_hub *hub, int port1,
2694 int status, unsigned portchange, unsigned portstatus)
2696 /* Is the device still present? */
2697 if (status || port_is_suspended(hub, portstatus) ||
2698 !port_is_power_on(hub, portstatus) ||
2699 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2704 /* Can't do a normal resume if the port isn't enabled,
2705 * so try a reset-resume instead.
2707 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2708 if (udev->persist_enabled)
2709 udev->reset_resume = 1;
2715 dev_dbg(hub->intfdev,
2716 "port %d status %04x.%04x after resume, %d\n",
2717 port1, portchange, portstatus, status);
2718 } else if (udev->reset_resume) {
2720 /* Late port handoff can set status-change bits */
2721 if (portchange & USB_PORT_STAT_C_CONNECTION)
2722 clear_port_feature(hub->hdev, port1,
2723 USB_PORT_FEAT_C_CONNECTION);
2724 if (portchange & USB_PORT_STAT_C_ENABLE)
2725 clear_port_feature(hub->hdev, port1,
2726 USB_PORT_FEAT_C_ENABLE);
2732 int usb_disable_ltm(struct usb_device *udev)
2734 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2736 /* Check if the roothub and device supports LTM. */
2737 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2738 !usb_device_supports_ltm(udev))
2741 /* Clear Feature LTM Enable can only be sent if the device is
2744 if (!udev->actconfig)
2747 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2748 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2749 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2750 USB_CTRL_SET_TIMEOUT);
2752 EXPORT_SYMBOL_GPL(usb_disable_ltm);
2754 void usb_enable_ltm(struct usb_device *udev)
2756 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2758 /* Check if the roothub and device supports LTM. */
2759 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2760 !usb_device_supports_ltm(udev))
2763 /* Set Feature LTM Enable can only be sent if the device is
2766 if (!udev->actconfig)
2769 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2770 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2771 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2772 USB_CTRL_SET_TIMEOUT);
2774 EXPORT_SYMBOL_GPL(usb_enable_ltm);
2776 #ifdef CONFIG_USB_SUSPEND
2779 * usb_port_suspend - suspend a usb device's upstream port
2780 * @udev: device that's no longer in active use, not a root hub
2781 * Context: must be able to sleep; device not locked; pm locks held
2783 * Suspends a USB device that isn't in active use, conserving power.
2784 * Devices may wake out of a suspend, if anything important happens,
2785 * using the remote wakeup mechanism. They may also be taken out of
2786 * suspend by the host, using usb_port_resume(). It's also routine
2787 * to disconnect devices while they are suspended.
2789 * This only affects the USB hardware for a device; its interfaces
2790 * (and, for hubs, child devices) must already have been suspended.
2792 * Selective port suspend reduces power; most suspended devices draw
2793 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2794 * All devices below the suspended port are also suspended.
2796 * Devices leave suspend state when the host wakes them up. Some devices
2797 * also support "remote wakeup", where the device can activate the USB
2798 * tree above them to deliver data, such as a keypress or packet. In
2799 * some cases, this wakes the USB host.
2801 * Suspending OTG devices may trigger HNP, if that's been enabled
2802 * between a pair of dual-role devices. That will change roles, such
2803 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2805 * Devices on USB hub ports have only one "suspend" state, corresponding
2806 * to ACPI D2, "may cause the device to lose some context".
2807 * State transitions include:
2809 * - suspend, resume ... when the VBUS power link stays live
2810 * - suspend, disconnect ... VBUS lost
2812 * Once VBUS drop breaks the circuit, the port it's using has to go through
2813 * normal re-enumeration procedures, starting with enabling VBUS power.
2814 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2815 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2816 * timer, no SRP, no requests through sysfs.
2818 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2819 * the root hub for their bus goes into global suspend ... so we don't
2820 * (falsely) update the device power state to say it suspended.
2822 * Returns 0 on success, else negative errno.
2824 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2826 struct usb_hub *hub = hdev_to_hub(udev->parent);
2827 int port1 = udev->portnum;
2830 /* enable remote wakeup when appropriate; this lets the device
2831 * wake up the upstream hub (including maybe the root hub).
2833 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2834 * we don't explicitly enable it here.
2836 if (udev->do_remote_wakeup) {
2837 if (!hub_is_superspeed(hub->hdev)) {
2838 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2839 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2840 USB_DEVICE_REMOTE_WAKEUP, 0,
2842 USB_CTRL_SET_TIMEOUT);
2844 /* Assume there's only one function on the USB 3.0
2845 * device and enable remote wake for the first
2846 * interface. FIXME if the interface association
2847 * descriptor shows there's more than one function.
2849 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2850 USB_REQ_SET_FEATURE,
2851 USB_RECIP_INTERFACE,
2852 USB_INTRF_FUNC_SUSPEND,
2853 USB_INTRF_FUNC_SUSPEND_RW |
2854 USB_INTRF_FUNC_SUSPEND_LP,
2856 USB_CTRL_SET_TIMEOUT);
2859 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2861 /* bail if autosuspend is requested */
2862 if (PMSG_IS_AUTO(msg))
2867 /* disable USB2 hardware LPM */
2868 if (udev->usb2_hw_lpm_enabled == 1)
2869 usb_set_usb2_hardware_lpm(udev, 0);
2871 if (usb_disable_ltm(udev)) {
2872 dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
2876 if (usb_unlocked_disable_lpm(udev)) {
2877 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2883 if (hub_is_superspeed(hub->hdev))
2884 status = set_port_feature(hub->hdev,
2885 port1 | (USB_SS_PORT_LS_U3 << 3),
2886 USB_PORT_FEAT_LINK_STATE);
2888 status = set_port_feature(hub->hdev, port1,
2889 USB_PORT_FEAT_SUSPEND);
2891 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2893 /* paranoia: "should not happen" */
2894 if (udev->do_remote_wakeup)
2895 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2896 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2897 USB_DEVICE_REMOTE_WAKEUP, 0,
2899 USB_CTRL_SET_TIMEOUT);
2901 /* Try to enable USB2 hardware LPM again */
2902 if (udev->usb2_hw_lpm_capable == 1)
2903 usb_set_usb2_hardware_lpm(udev, 1);
2905 /* Try to enable USB3 LTM and LPM again */
2906 usb_enable_ltm(udev);
2907 usb_unlocked_enable_lpm(udev);
2909 /* System sleep transitions should never fail */
2910 if (!PMSG_IS_AUTO(msg))
2913 /* device has up to 10 msec to fully suspend */
2914 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2915 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2916 udev->do_remote_wakeup);
2917 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2918 udev->port_is_suspended = 1;
2921 usb_mark_last_busy(hub->hdev);
2926 * If the USB "suspend" state is in use (rather than "global suspend"),
2927 * many devices will be individually taken out of suspend state using
2928 * special "resume" signaling. This routine kicks in shortly after
2929 * hardware resume signaling is finished, either because of selective
2930 * resume (by host) or remote wakeup (by device) ... now see what changed
2931 * in the tree that's rooted at this device.
2933 * If @udev->reset_resume is set then the device is reset before the
2934 * status check is done.
2936 static int finish_port_resume(struct usb_device *udev)
2941 /* caller owns the udev device lock */
2942 dev_dbg(&udev->dev, "%s\n",
2943 udev->reset_resume ? "finish reset-resume" : "finish resume");
2945 /* usb ch9 identifies four variants of SUSPENDED, based on what
2946 * state the device resumes to. Linux currently won't see the
2947 * first two on the host side; they'd be inside hub_port_init()
2948 * during many timeouts, but khubd can't suspend until later.
2950 usb_set_device_state(udev, udev->actconfig
2951 ? USB_STATE_CONFIGURED
2952 : USB_STATE_ADDRESS);
2954 /* 10.5.4.5 says not to reset a suspended port if the attached
2955 * device is enabled for remote wakeup. Hence the reset
2956 * operation is carried out here, after the port has been
2959 if (udev->reset_resume)
2961 status = usb_reset_and_verify_device(udev);
2963 /* 10.5.4.5 says be sure devices in the tree are still there.
2964 * For now let's assume the device didn't go crazy on resume,
2965 * and device drivers will know about any resume quirks.
2969 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2971 status = (status > 0 ? 0 : -ENODEV);
2973 /* If a normal resume failed, try doing a reset-resume */
2974 if (status && !udev->reset_resume && udev->persist_enabled) {
2975 dev_dbg(&udev->dev, "retry with reset-resume\n");
2976 udev->reset_resume = 1;
2977 goto retry_reset_resume;
2982 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2984 } else if (udev->actconfig) {
2985 le16_to_cpus(&devstatus);
2986 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2987 status = usb_control_msg(udev,
2988 usb_sndctrlpipe(udev, 0),
2989 USB_REQ_CLEAR_FEATURE,
2991 USB_DEVICE_REMOTE_WAKEUP, 0,
2993 USB_CTRL_SET_TIMEOUT);
2996 "disable remote wakeup, status %d\n",
3005 * usb_port_resume - re-activate a suspended usb device's upstream port
3006 * @udev: device to re-activate, not a root hub
3007 * Context: must be able to sleep; device not locked; pm locks held
3009 * This will re-activate the suspended device, increasing power usage
3010 * while letting drivers communicate again with its endpoints.
3011 * USB resume explicitly guarantees that the power session between
3012 * the host and the device is the same as it was when the device
3015 * If @udev->reset_resume is set then this routine won't check that the
3016 * port is still enabled. Furthermore, finish_port_resume() above will
3017 * reset @udev. The end result is that a broken power session can be
3018 * recovered and @udev will appear to persist across a loss of VBUS power.
3020 * For example, if a host controller doesn't maintain VBUS suspend current
3021 * during a system sleep or is reset when the system wakes up, all the USB
3022 * power sessions below it will be broken. This is especially troublesome
3023 * for mass-storage devices containing mounted filesystems, since the
3024 * device will appear to have disconnected and all the memory mappings
3025 * to it will be lost. Using the USB_PERSIST facility, the device can be
3026 * made to appear as if it had not disconnected.
3028 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3029 * every effort to insure that the same device is present after the
3030 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3031 * quite possible for a device to remain unaltered but its media to be
3032 * changed. If the user replaces a flash memory card while the system is
3033 * asleep, he will have only himself to blame when the filesystem on the
3034 * new card is corrupted and the system crashes.
3036 * Returns 0 on success, else negative errno.
3038 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3040 struct usb_hub *hub = hdev_to_hub(udev->parent);
3041 int port1 = udev->portnum;
3043 u16 portchange, portstatus;
3045 /* Skip the initial Clear-Suspend step for a remote wakeup */
3046 status = hub_port_status(hub, port1, &portstatus, &portchange);
3047 if (status == 0 && !port_is_suspended(hub, portstatus))
3048 goto SuspendCleared;
3050 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3052 set_bit(port1, hub->busy_bits);
3054 /* see 7.1.7.7; affects power usage, but not budgeting */
3055 if (hub_is_superspeed(hub->hdev))
3056 status = set_port_feature(hub->hdev,
3057 port1 | (USB_SS_PORT_LS_U0 << 3),
3058 USB_PORT_FEAT_LINK_STATE);
3060 status = clear_port_feature(hub->hdev,
3061 port1, USB_PORT_FEAT_SUSPEND);
3063 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3066 /* drive resume for at least 20 msec */
3067 dev_dbg(&udev->dev, "usb %sresume\n",
3068 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3071 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3072 * stop resume signaling. Then finish the resume
3075 status = hub_port_status(hub, port1, &portstatus, &portchange);
3077 /* TRSMRCY = 10 msec */
3083 udev->port_is_suspended = 0;
3084 if (hub_is_superspeed(hub->hdev)) {
3085 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3086 clear_port_feature(hub->hdev, port1,
3087 USB_PORT_FEAT_C_PORT_LINK_STATE);
3089 if (portchange & USB_PORT_STAT_C_SUSPEND)
3090 clear_port_feature(hub->hdev, port1,
3091 USB_PORT_FEAT_C_SUSPEND);
3095 clear_bit(port1, hub->busy_bits);
3097 status = check_port_resume_type(udev,
3098 hub, port1, status, portchange, portstatus);
3100 status = finish_port_resume(udev);
3102 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3103 hub_port_logical_disconnect(hub, port1);
3105 /* Try to enable USB2 hardware LPM */
3106 if (udev->usb2_hw_lpm_capable == 1)
3107 usb_set_usb2_hardware_lpm(udev, 1);
3109 /* Try to enable USB3 LTM and LPM */
3110 usb_enable_ltm(udev);
3111 usb_unlocked_enable_lpm(udev);
3117 /* caller has locked udev */
3118 int usb_remote_wakeup(struct usb_device *udev)
3122 if (udev->state == USB_STATE_SUSPENDED) {
3123 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3124 status = usb_autoresume_device(udev);
3126 /* Let the drivers do their thing, then... */
3127 usb_autosuspend_device(udev);
3133 #else /* CONFIG_USB_SUSPEND */
3135 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3137 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3142 /* However we may need to do a reset-resume */
3144 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3146 struct usb_hub *hub = hdev_to_hub(udev->parent);
3147 int port1 = udev->portnum;
3149 u16 portchange, portstatus;
3151 status = hub_port_status(hub, port1, &portstatus, &portchange);
3152 status = check_port_resume_type(udev,
3153 hub, port1, status, portchange, portstatus);
3156 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3157 hub_port_logical_disconnect(hub, port1);
3158 } else if (udev->reset_resume) {
3159 dev_dbg(&udev->dev, "reset-resume\n");
3160 status = usb_reset_and_verify_device(udev);
3167 static int check_ports_changed(struct usb_hub *hub)
3171 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3172 u16 portstatus, portchange;
3175 status = hub_port_status(hub, port1, &portstatus, &portchange);
3176 if (!status && portchange)
3182 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3184 struct usb_hub *hub = usb_get_intfdata (intf);
3185 struct usb_device *hdev = hub->hdev;
3189 /* Warn if children aren't already suspended */
3190 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3191 struct usb_device *udev;
3193 udev = hub->ports[port1 - 1]->child;
3194 if (udev && udev->can_submit) {
3195 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3196 if (PMSG_IS_AUTO(msg))
3201 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3202 /* check if there are changes pending on hub ports */
3203 if (check_ports_changed(hub)) {
3204 if (PMSG_IS_AUTO(msg))
3206 pm_wakeup_event(&hdev->dev, 2000);
3210 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3211 /* Enable hub to send remote wakeup for all ports. */
3212 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3213 status = set_port_feature(hdev,
3215 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3216 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3217 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3218 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3222 dev_dbg(&intf->dev, "%s\n", __func__);
3224 /* stop khubd and related activity */
3225 hub_quiesce(hub, HUB_SUSPEND);
3229 static int hub_resume(struct usb_interface *intf)
3231 struct usb_hub *hub = usb_get_intfdata(intf);
3233 dev_dbg(&intf->dev, "%s\n", __func__);
3234 hub_activate(hub, HUB_RESUME);
3238 static int hub_reset_resume(struct usb_interface *intf)
3240 struct usb_hub *hub = usb_get_intfdata(intf);
3242 dev_dbg(&intf->dev, "%s\n", __func__);
3243 hub_activate(hub, HUB_RESET_RESUME);
3248 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3249 * @rhdev: struct usb_device for the root hub
3251 * The USB host controller driver calls this function when its root hub
3252 * is resumed and Vbus power has been interrupted or the controller
3253 * has been reset. The routine marks @rhdev as having lost power.
3254 * When the hub driver is resumed it will take notice and carry out
3255 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3256 * the others will be disconnected.
3258 void usb_root_hub_lost_power(struct usb_device *rhdev)
3260 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3261 rhdev->reset_resume = 1;
3263 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3265 static const char * const usb3_lpm_names[] = {
3273 * Send a Set SEL control transfer to the device, prior to enabling
3274 * device-initiated U1 or U2. This lets the device know the exit latencies from
3275 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3276 * packet from the host.
3278 * This function will fail if the SEL or PEL values for udev are greater than
3279 * the maximum allowed values for the link state to be enabled.
3281 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3283 struct usb_set_sel_req *sel_values;
3284 unsigned long long u1_sel;
3285 unsigned long long u1_pel;
3286 unsigned long long u2_sel;
3287 unsigned long long u2_pel;
3290 /* Convert SEL and PEL stored in ns to us */
3291 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3292 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3293 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3294 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3297 * Make sure that the calculated SEL and PEL values for the link
3298 * state we're enabling aren't bigger than the max SEL/PEL
3299 * value that will fit in the SET SEL control transfer.
3300 * Otherwise the device would get an incorrect idea of the exit
3301 * latency for the link state, and could start a device-initiated
3302 * U1/U2 when the exit latencies are too high.
3304 if ((state == USB3_LPM_U1 &&
3305 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3306 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3307 (state == USB3_LPM_U2 &&
3308 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3309 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3310 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3311 usb3_lpm_names[state], u1_sel, u1_pel);
3316 * If we're enabling device-initiated LPM for one link state,
3317 * but the other link state has a too high SEL or PEL value,
3318 * just set those values to the max in the Set SEL request.
3320 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3321 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3323 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3324 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3326 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3327 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3329 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3330 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3333 * usb_enable_lpm() can be called as part of a failed device reset,
3334 * which may be initiated by an error path of a mass storage driver.
3335 * Therefore, use GFP_NOIO.
3337 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3341 sel_values->u1_sel = u1_sel;
3342 sel_values->u1_pel = u1_pel;
3343 sel_values->u2_sel = cpu_to_le16(u2_sel);
3344 sel_values->u2_pel = cpu_to_le16(u2_pel);
3346 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3350 sel_values, sizeof *(sel_values),
3351 USB_CTRL_SET_TIMEOUT);
3357 * Enable or disable device-initiated U1 or U2 transitions.
3359 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3360 enum usb3_link_state state, bool enable)
3367 feature = USB_DEVICE_U1_ENABLE;
3370 feature = USB_DEVICE_U2_ENABLE;
3373 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3374 __func__, enable ? "enable" : "disable");
3378 if (udev->state != USB_STATE_CONFIGURED) {
3379 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3380 "for unconfigured device.\n",
3381 __func__, enable ? "enable" : "disable",
3382 usb3_lpm_names[state]);
3388 * Now send the control transfer to enable device-initiated LPM
3389 * for either U1 or U2.
3391 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3392 USB_REQ_SET_FEATURE,
3396 USB_CTRL_SET_TIMEOUT);
3398 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3399 USB_REQ_CLEAR_FEATURE,
3403 USB_CTRL_SET_TIMEOUT);
3406 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3407 enable ? "Enable" : "Disable",
3408 usb3_lpm_names[state]);
3414 static int usb_set_lpm_timeout(struct usb_device *udev,
3415 enum usb3_link_state state, int timeout)
3422 feature = USB_PORT_FEAT_U1_TIMEOUT;
3425 feature = USB_PORT_FEAT_U2_TIMEOUT;
3428 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3433 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3434 timeout != USB3_LPM_DEVICE_INITIATED) {
3435 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3436 "which is a reserved value.\n",
3437 usb3_lpm_names[state], timeout);
3441 ret = set_port_feature(udev->parent,
3442 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3445 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3446 "error code %i\n", usb3_lpm_names[state],
3450 if (state == USB3_LPM_U1)
3451 udev->u1_params.timeout = timeout;
3453 udev->u2_params.timeout = timeout;
3458 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3461 * We will attempt to enable U1 or U2, but there are no guarantees that the
3462 * control transfers to set the hub timeout or enable device-initiated U1/U2
3463 * will be successful.
3465 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3466 * driver know about it. If that call fails, it should be harmless, and just
3467 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3469 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3470 enum usb3_link_state state)
3473 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3474 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3476 /* If the device says it doesn't have *any* exit latency to come out of
3477 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3480 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3481 (state == USB3_LPM_U2 && u2_mel == 0))
3485 * First, let the device know about the exit latencies
3486 * associated with the link state we're about to enable.
3488 ret = usb_req_set_sel(udev, state);
3490 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3491 usb3_lpm_names[state]);
3495 /* We allow the host controller to set the U1/U2 timeout internally
3496 * first, so that it can change its schedule to account for the
3497 * additional latency to send data to a device in a lower power
3500 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3502 /* xHCI host controller doesn't want to enable this LPM state. */
3507 dev_warn(&udev->dev, "Could not enable %s link state, "
3508 "xHCI error %i.\n", usb3_lpm_names[state],
3513 if (usb_set_lpm_timeout(udev, state, timeout))
3514 /* If we can't set the parent hub U1/U2 timeout,
3515 * device-initiated LPM won't be allowed either, so let the xHCI
3516 * host know that this link state won't be enabled.
3518 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3520 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3521 else if (udev->actconfig)
3522 usb_set_device_initiated_lpm(udev, state, true);
3527 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3530 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3531 * If zero is returned, the parent will not allow the link to go into U1/U2.
3533 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3534 * it won't have an effect on the bus link state because the parent hub will
3535 * still disallow device-initiated U1/U2 entry.
3537 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3538 * possible. The result will be slightly more bus bandwidth will be taken up
3539 * (to account for U1/U2 exit latency), but it should be harmless.
3541 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3542 enum usb3_link_state state)
3548 feature = USB_PORT_FEAT_U1_TIMEOUT;
3551 feature = USB_PORT_FEAT_U2_TIMEOUT;
3554 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3559 if (usb_set_lpm_timeout(udev, state, 0))
3562 usb_set_device_initiated_lpm(udev, state, false);
3564 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3565 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3566 "bus schedule bandwidth may be impacted.\n",
3567 usb3_lpm_names[state]);
3572 * Disable hub-initiated and device-initiated U1 and U2 entry.
3573 * Caller must own the bandwidth_mutex.
3575 * This will call usb_enable_lpm() on failure, which will decrement
3576 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3578 int usb_disable_lpm(struct usb_device *udev)
3580 struct usb_hcd *hcd;
3582 if (!udev || !udev->parent ||
3583 udev->speed != USB_SPEED_SUPER ||
3587 hcd = bus_to_hcd(udev->bus);
3588 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3591 udev->lpm_disable_count++;
3592 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3595 /* If LPM is enabled, attempt to disable it. */
3596 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3598 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3604 usb_enable_lpm(udev);
3607 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3609 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3610 int usb_unlocked_disable_lpm(struct usb_device *udev)
3612 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3618 mutex_lock(hcd->bandwidth_mutex);
3619 ret = usb_disable_lpm(udev);
3620 mutex_unlock(hcd->bandwidth_mutex);
3624 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3627 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3628 * xHCI host policy may prevent U1 or U2 from being enabled.
3630 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3631 * until the lpm_disable_count drops to zero. Caller must own the
3634 void usb_enable_lpm(struct usb_device *udev)
3636 struct usb_hcd *hcd;
3638 if (!udev || !udev->parent ||
3639 udev->speed != USB_SPEED_SUPER ||
3643 udev->lpm_disable_count--;
3644 hcd = bus_to_hcd(udev->bus);
3645 /* Double check that we can both enable and disable LPM.
3646 * Device must be configured to accept set feature U1/U2 timeout.
3648 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3649 !hcd->driver->disable_usb3_lpm_timeout)
3652 if (udev->lpm_disable_count > 0)
3655 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3656 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3658 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3660 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3661 void usb_unlocked_enable_lpm(struct usb_device *udev)
3663 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3668 mutex_lock(hcd->bandwidth_mutex);
3669 usb_enable_lpm(udev);
3670 mutex_unlock(hcd->bandwidth_mutex);
3672 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3675 #else /* CONFIG_PM */
3677 #define hub_suspend NULL
3678 #define hub_resume NULL
3679 #define hub_reset_resume NULL
3681 int usb_disable_lpm(struct usb_device *udev)
3685 EXPORT_SYMBOL_GPL(usb_disable_lpm);
3687 void usb_enable_lpm(struct usb_device *udev) { }
3688 EXPORT_SYMBOL_GPL(usb_enable_lpm);
3690 int usb_unlocked_disable_lpm(struct usb_device *udev)
3694 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3696 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3697 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3699 int usb_disable_ltm(struct usb_device *udev)
3703 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3705 void usb_enable_ltm(struct usb_device *udev) { }
3706 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3710 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3712 * Between connect detection and reset signaling there must be a delay
3713 * of 100ms at least for debounce and power-settling. The corresponding
3714 * timer shall restart whenever the downstream port detects a disconnect.
3716 * Apparently there are some bluetooth and irda-dongles and a number of
3717 * low-speed devices for which this debounce period may last over a second.
3718 * Not covered by the spec - but easy to deal with.
3720 * This implementation uses a 1500ms total debounce timeout; if the
3721 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3722 * every 25ms for transient disconnects. When the port status has been
3723 * unchanged for 100ms it returns the port status.
3725 static int hub_port_debounce(struct usb_hub *hub, int port1)
3728 int total_time, stable_time = 0;
3729 u16 portchange, portstatus;
3730 unsigned connection = 0xffff;
3732 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3733 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3737 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3738 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3739 stable_time += HUB_DEBOUNCE_STEP;
3740 if (stable_time >= HUB_DEBOUNCE_STABLE)
3744 connection = portstatus & USB_PORT_STAT_CONNECTION;
3747 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3748 clear_port_feature(hub->hdev, port1,
3749 USB_PORT_FEAT_C_CONNECTION);
3752 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3754 msleep(HUB_DEBOUNCE_STEP);
3757 dev_dbg (hub->intfdev,
3758 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3759 port1, total_time, stable_time, portstatus);
3761 if (stable_time < HUB_DEBOUNCE_STABLE)
3766 void usb_ep0_reinit(struct usb_device *udev)
3768 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3769 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3770 usb_enable_endpoint(udev, &udev->ep0, true);
3772 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
3774 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3775 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3777 static int hub_set_address(struct usb_device *udev, int devnum)
3780 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3783 * The host controller will choose the device address,
3784 * instead of the core having chosen it earlier
3786 if (!hcd->driver->address_device && devnum <= 1)
3788 if (udev->state == USB_STATE_ADDRESS)
3790 if (udev->state != USB_STATE_DEFAULT)
3792 if (hcd->driver->address_device)
3793 retval = hcd->driver->address_device(hcd, udev);
3795 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3796 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3797 NULL, 0, USB_CTRL_SET_TIMEOUT);
3799 update_devnum(udev, devnum);
3800 /* Device now using proper address. */
3801 usb_set_device_state(udev, USB_STATE_ADDRESS);
3802 usb_ep0_reinit(udev);
3807 /* Reset device, (re)assign address, get device descriptor.
3808 * Device connection must be stable, no more debouncing needed.
3809 * Returns device in USB_STATE_ADDRESS, except on error.
3811 * If this is called for an already-existing device (as part of
3812 * usb_reset_and_verify_device), the caller must own the device lock. For a
3813 * newly detected device that is not accessible through any global
3814 * pointers, it's not necessary to lock the device.
3817 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3820 static DEFINE_MUTEX(usb_address0_mutex);
3822 struct usb_device *hdev = hub->hdev;
3823 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3825 unsigned delay = HUB_SHORT_RESET_TIME;
3826 enum usb_device_speed oldspeed = udev->speed;
3828 int devnum = udev->devnum;
3830 /* root hub ports have a slightly longer reset period
3831 * (from USB 2.0 spec, section 7.1.7.5)
3833 if (!hdev->parent) {
3834 delay = HUB_ROOT_RESET_TIME;
3835 if (port1 == hdev->bus->otg_port)
3836 hdev->bus->b_hnp_enable = 0;
3839 /* Some low speed devices have problems with the quick delay, so */
3840 /* be a bit pessimistic with those devices. RHbug #23670 */
3841 if (oldspeed == USB_SPEED_LOW)
3842 delay = HUB_LONG_RESET_TIME;
3844 mutex_lock(&usb_address0_mutex);
3846 /* Reset the device; full speed may morph to high speed */
3847 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3848 retval = hub_port_reset(hub, port1, udev, delay, false);
3849 if (retval < 0) /* error or disconnect */
3851 /* success, speed is known */
3855 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3856 dev_dbg(&udev->dev, "device reset changed speed!\n");
3859 oldspeed = udev->speed;
3861 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3862 * it's fixed size except for full speed devices.
3863 * For Wireless USB devices, ep0 max packet is always 512 (tho
3864 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3866 switch (udev->speed) {
3867 case USB_SPEED_SUPER:
3868 case USB_SPEED_WIRELESS: /* fixed at 512 */
3869 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3871 case USB_SPEED_HIGH: /* fixed at 64 */
3872 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3874 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3875 /* to determine the ep0 maxpacket size, try to read
3876 * the device descriptor to get bMaxPacketSize0 and
3877 * then correct our initial guess.
3879 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3881 case USB_SPEED_LOW: /* fixed at 8 */
3882 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3888 if (udev->speed == USB_SPEED_WIRELESS)
3889 speed = "variable speed Wireless";
3891 speed = usb_speed_string(udev->speed);
3893 if (udev->speed != USB_SPEED_SUPER)
3894 dev_info(&udev->dev,
3895 "%s %s USB device number %d using %s\n",
3896 (udev->config) ? "reset" : "new", speed,
3897 devnum, udev->bus->controller->driver->name);
3899 /* Set up TT records, if needed */
3901 udev->tt = hdev->tt;
3902 udev->ttport = hdev->ttport;
3903 } else if (udev->speed != USB_SPEED_HIGH
3904 && hdev->speed == USB_SPEED_HIGH) {
3906 dev_err(&udev->dev, "parent hub has no TT\n");
3910 udev->tt = &hub->tt;
3911 udev->ttport = port1;
3914 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3915 * Because device hardware and firmware is sometimes buggy in
3916 * this area, and this is how Linux has done it for ages.
3917 * Change it cautiously.
3919 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3920 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3921 * so it may help with some non-standards-compliant devices.
3922 * Otherwise we start with SET_ADDRESS and then try to read the
3923 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3926 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3927 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3928 struct usb_device_descriptor *buf;
3931 #define GET_DESCRIPTOR_BUFSIZE 64
3932 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3938 /* Retry on all errors; some devices are flakey.
3939 * 255 is for WUSB devices, we actually need to use
3940 * 512 (WUSB1.0[4.8.1]).
3942 for (j = 0; j < 3; ++j) {
3943 buf->bMaxPacketSize0 = 0;
3944 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3945 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3946 USB_DT_DEVICE << 8, 0,
3947 buf, GET_DESCRIPTOR_BUFSIZE,
3948 initial_descriptor_timeout);
3949 switch (buf->bMaxPacketSize0) {
3950 case 8: case 16: case 32: case 64: case 255:
3951 if (buf->bDescriptorType ==
3965 udev->descriptor.bMaxPacketSize0 =
3966 buf->bMaxPacketSize0;
3969 retval = hub_port_reset(hub, port1, udev, delay, false);
3970 if (retval < 0) /* error or disconnect */
3972 if (oldspeed != udev->speed) {
3974 "device reset changed speed!\n");
3980 "device descriptor read/64, error %d\n",
3985 #undef GET_DESCRIPTOR_BUFSIZE
3989 * If device is WUSB, we already assigned an
3990 * unauthorized address in the Connect Ack sequence;
3991 * authorization will assign the final address.
3993 if (udev->wusb == 0) {
3994 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3995 retval = hub_set_address(udev, devnum);
4002 "device not accepting address %d, error %d\n",
4006 if (udev->speed == USB_SPEED_SUPER) {
4007 devnum = udev->devnum;
4008 dev_info(&udev->dev,
4009 "%s SuperSpeed USB device number %d using %s\n",
4010 (udev->config) ? "reset" : "new",
4011 devnum, udev->bus->controller->driver->name);
4014 /* cope with hardware quirkiness:
4015 * - let SET_ADDRESS settle, some device hardware wants it
4016 * - read ep0 maxpacket even for high and low speed,
4019 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4023 retval = usb_get_device_descriptor(udev, 8);
4026 "device descriptor read/8, error %d\n",
4038 if (hcd->phy && !hdev->parent)
4039 usb_phy_notify_connect(hcd->phy, udev->speed);
4042 * Some superspeed devices have finished the link training process
4043 * and attached to a superspeed hub port, but the device descriptor
4044 * got from those devices show they aren't superspeed devices. Warm
4045 * reset the port attached by the devices can fix them.
4047 if ((udev->speed == USB_SPEED_SUPER) &&
4048 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4049 dev_err(&udev->dev, "got a wrong device descriptor, "
4050 "warm reset device\n");
4051 hub_port_reset(hub, port1, udev,
4052 HUB_BH_RESET_TIME, true);
4057 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4058 udev->speed == USB_SPEED_SUPER)
4061 i = udev->descriptor.bMaxPacketSize0;
4062 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4063 if (udev->speed == USB_SPEED_LOW ||
4064 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4065 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4069 if (udev->speed == USB_SPEED_FULL)
4070 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4072 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4073 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4074 usb_ep0_reinit(udev);
4077 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4078 if (retval < (signed)sizeof(udev->descriptor)) {
4079 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4086 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4087 retval = usb_get_bos_descriptor(udev);
4089 udev->lpm_capable = usb_device_supports_lpm(udev);
4090 usb_set_lpm_parameters(udev);
4095 /* notify HCD that we have a device connected and addressed */
4096 if (hcd->driver->update_device)
4097 hcd->driver->update_device(hcd, udev);
4100 hub_port_disable(hub, port1, 0);
4101 update_devnum(udev, devnum); /* for disconnect processing */
4103 mutex_unlock(&usb_address0_mutex);
4108 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4110 struct usb_qualifier_descriptor *qual;
4113 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4117 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4118 qual, sizeof *qual);
4119 if (status == sizeof *qual) {
4120 dev_info(&udev->dev, "not running at top speed; "
4121 "connect to a high speed hub\n");
4122 /* hub LEDs are probably harder to miss than syslog */
4123 if (hub->has_indicators) {
4124 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4125 schedule_delayed_work (&hub->leds, 0);
4132 hub_power_remaining (struct usb_hub *hub)
4134 struct usb_device *hdev = hub->hdev;
4138 if (!hub->limited_power)
4141 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4142 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4143 struct usb_device *udev = hub->ports[port1 - 1]->child;
4149 /* Unconfigured devices may not use more than 100mA,
4150 * or 8mA for OTG ports */
4151 if (udev->actconfig)
4152 delta = udev->actconfig->desc.bMaxPower * 2;
4153 else if (port1 != udev->bus->otg_port || hdev->parent)
4157 if (delta > hub->mA_per_port)
4158 dev_warn(&udev->dev,
4159 "%dmA is over %umA budget for port %d!\n",
4160 delta, hub->mA_per_port, port1);
4163 if (remaining < 0) {
4164 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4171 /* Handle physical or logical connection change events.
4172 * This routine is called when:
4173 * a port connection-change occurs;
4174 * a port enable-change occurs (often caused by EMI);
4175 * usb_reset_and_verify_device() encounters changed descriptors (as from
4176 * a firmware download)
4177 * caller already locked the hub
4179 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4180 u16 portstatus, u16 portchange)
4182 struct usb_device *hdev = hub->hdev;
4183 struct device *hub_dev = hub->intfdev;
4184 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4185 unsigned wHubCharacteristics =
4186 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4187 struct usb_device *udev;
4191 "port %d, status %04x, change %04x, %s\n",
4192 port1, portstatus, portchange, portspeed(hub, portstatus));
4194 if (hub->has_indicators) {
4195 set_port_led(hub, port1, HUB_LED_AUTO);
4196 hub->indicator[port1-1] = INDICATOR_AUTO;
4199 #ifdef CONFIG_USB_OTG
4200 /* during HNP, don't repeat the debounce */
4201 if (hdev->bus->is_b_host)
4202 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4203 USB_PORT_STAT_C_ENABLE);
4206 /* Try to resuscitate an existing device */
4207 udev = hub->ports[port1 - 1]->child;
4208 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4209 udev->state != USB_STATE_NOTATTACHED) {
4210 usb_lock_device(udev);
4211 if (portstatus & USB_PORT_STAT_ENABLE) {
4212 status = 0; /* Nothing to do */
4214 #ifdef CONFIG_USB_SUSPEND
4215 } else if (udev->state == USB_STATE_SUSPENDED &&
4216 udev->persist_enabled) {
4217 /* For a suspended device, treat this as a
4218 * remote wakeup event.
4220 status = usb_remote_wakeup(udev);
4224 status = -ENODEV; /* Don't resuscitate */
4226 usb_unlock_device(udev);
4229 clear_bit(port1, hub->change_bits);
4234 /* Disconnect any existing devices under this port */
4236 if (hcd->phy && !hdev->parent &&
4237 !(portstatus & USB_PORT_STAT_CONNECTION))
4238 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4239 usb_disconnect(&hub->ports[port1 - 1]->child);
4241 clear_bit(port1, hub->change_bits);
4243 /* We can forget about a "removed" device when there's a physical
4244 * disconnect or the connect status changes.
4246 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4247 (portchange & USB_PORT_STAT_C_CONNECTION))
4248 clear_bit(port1, hub->removed_bits);
4250 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4251 USB_PORT_STAT_C_ENABLE)) {
4252 status = hub_port_debounce(hub, port1);
4254 if (printk_ratelimit())
4255 dev_err(hub_dev, "connect-debounce failed, "
4256 "port %d disabled\n", port1);
4257 portstatus &= ~USB_PORT_STAT_CONNECTION;
4259 portstatus = status;
4263 /* Return now if debouncing failed or nothing is connected or
4264 * the device was "removed".
4266 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4267 test_bit(port1, hub->removed_bits)) {
4269 /* maybe switch power back on (e.g. root hub was reset) */
4270 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4271 && !port_is_power_on(hub, portstatus))
4272 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4274 if (portstatus & USB_PORT_STAT_ENABLE)
4279 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4281 /* reallocate for each attempt, since references
4282 * to the previous one can escape in various ways
4284 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4287 "couldn't allocate port %d usb_device\n",
4292 usb_set_device_state(udev, USB_STATE_POWERED);
4293 udev->bus_mA = hub->mA_per_port;
4294 udev->level = hdev->level + 1;
4295 udev->wusb = hub_is_wusb(hub);
4297 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4298 if (hub_is_superspeed(hub->hdev))
4299 udev->speed = USB_SPEED_SUPER;
4301 udev->speed = USB_SPEED_UNKNOWN;
4303 choose_devnum(udev);
4304 if (udev->devnum <= 0) {
4305 status = -ENOTCONN; /* Don't retry */
4309 /* reset (non-USB 3.0 devices) and get descriptor */
4310 status = hub_port_init(hub, udev, port1, i);
4314 usb_detect_quirks(udev);
4315 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4318 /* consecutive bus-powered hubs aren't reliable; they can
4319 * violate the voltage drop budget. if the new child has
4320 * a "powered" LED, users should notice we didn't enable it
4321 * (without reading syslog), even without per-port LEDs
4324 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4325 && udev->bus_mA <= 100) {
4328 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4331 dev_dbg(&udev->dev, "get status %d ?\n", status);
4334 le16_to_cpus(&devstat);
4335 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4337 "can't connect bus-powered hub "
4339 if (hub->has_indicators) {
4340 hub->indicator[port1-1] =
4341 INDICATOR_AMBER_BLINK;
4342 schedule_delayed_work (&hub->leds, 0);
4344 status = -ENOTCONN; /* Don't retry */
4349 /* check for devices running slower than they could */
4350 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4351 && udev->speed == USB_SPEED_FULL
4352 && highspeed_hubs != 0)
4353 check_highspeed (hub, udev, port1);
4355 /* Store the parent's children[] pointer. At this point
4356 * udev becomes globally accessible, although presumably
4357 * no one will look at it until hdev is unlocked.
4361 /* We mustn't add new devices if the parent hub has
4362 * been disconnected; we would race with the
4363 * recursively_mark_NOTATTACHED() routine.
4365 spin_lock_irq(&device_state_lock);
4366 if (hdev->state == USB_STATE_NOTATTACHED)
4369 hub->ports[port1 - 1]->child = udev;
4370 spin_unlock_irq(&device_state_lock);
4372 /* Run it through the hoops (find a driver, etc) */
4374 status = usb_new_device(udev);
4376 spin_lock_irq(&device_state_lock);
4377 hub->ports[port1 - 1]->child = NULL;
4378 spin_unlock_irq(&device_state_lock);
4385 status = hub_power_remaining(hub);
4387 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4392 hub_port_disable(hub, port1, 1);
4394 usb_ep0_reinit(udev);
4395 release_devnum(udev);
4398 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4401 if (hub->hdev->parent ||
4402 !hcd->driver->port_handed_over ||
4403 !(hcd->driver->port_handed_over)(hcd, port1))
4404 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4408 hub_port_disable(hub, port1, 1);
4409 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4410 hcd->driver->relinquish_port(hcd, port1);
4413 /* Returns 1 if there was a remote wakeup and a connect status change. */
4414 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4415 u16 portstatus, u16 portchange)
4417 struct usb_device *hdev;
4418 struct usb_device *udev;
4419 int connect_change = 0;
4423 udev = hub->ports[port - 1]->child;
4424 if (!hub_is_superspeed(hdev)) {
4425 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4427 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4429 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4430 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4436 /* TRSMRCY = 10 msec */
4439 usb_lock_device(udev);
4440 ret = usb_remote_wakeup(udev);
4441 usb_unlock_device(udev);
4446 hub_port_disable(hub, port, 1);
4448 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4450 return connect_change;
4453 static void hub_events(void)
4455 struct list_head *tmp;
4456 struct usb_device *hdev;
4457 struct usb_interface *intf;
4458 struct usb_hub *hub;
4459 struct device *hub_dev;
4465 int connect_change, wakeup_change;
4468 * We restart the list every time to avoid a deadlock with
4469 * deleting hubs downstream from this one. This should be
4470 * safe since we delete the hub from the event list.
4471 * Not the most efficient, but avoids deadlocks.
4475 /* Grab the first entry at the beginning of the list */
4476 spin_lock_irq(&hub_event_lock);
4477 if (list_empty(&hub_event_list)) {
4478 spin_unlock_irq(&hub_event_lock);
4482 tmp = hub_event_list.next;
4485 hub = list_entry(tmp, struct usb_hub, event_list);
4486 kref_get(&hub->kref);
4487 spin_unlock_irq(&hub_event_lock);
4490 hub_dev = hub->intfdev;
4491 intf = to_usb_interface(hub_dev);
4492 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4493 hdev->state, hub->descriptor
4494 ? hub->descriptor->bNbrPorts
4496 /* NOTE: expects max 15 ports... */
4497 (u16) hub->change_bits[0],
4498 (u16) hub->event_bits[0]);
4500 /* Lock the device, then check to see if we were
4501 * disconnected while waiting for the lock to succeed. */
4502 usb_lock_device(hdev);
4503 if (unlikely(hub->disconnected))
4504 goto loop_disconnected;
4506 /* If the hub has died, clean up after it */
4507 if (hdev->state == USB_STATE_NOTATTACHED) {
4508 hub->error = -ENODEV;
4509 hub_quiesce(hub, HUB_DISCONNECT);
4514 ret = usb_autopm_get_interface(intf);
4516 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
4520 /* If this is an inactive hub, do nothing */
4525 dev_dbg (hub_dev, "resetting for error %d\n",
4528 ret = usb_reset_device(hdev);
4531 "error resetting hub: %d\n", ret);
4539 /* deal with port status changes */
4540 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4541 if (test_bit(i, hub->busy_bits))
4543 connect_change = test_bit(i, hub->change_bits);
4544 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
4545 if (!test_and_clear_bit(i, hub->event_bits) &&
4546 !connect_change && !wakeup_change)
4549 ret = hub_port_status(hub, i,
4550 &portstatus, &portchange);
4554 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4555 clear_port_feature(hdev, i,
4556 USB_PORT_FEAT_C_CONNECTION);
4560 if (portchange & USB_PORT_STAT_C_ENABLE) {
4561 if (!connect_change)
4563 "port %d enable change, "
4566 clear_port_feature(hdev, i,
4567 USB_PORT_FEAT_C_ENABLE);
4570 * EM interference sometimes causes badly
4571 * shielded USB devices to be shutdown by
4572 * the hub, this hack enables them again.
4573 * Works at least with mouse driver.
4575 if (!(portstatus & USB_PORT_STAT_ENABLE)
4577 && hub->ports[i - 1]->child) {
4580 "disabled by hub (EMI?), "
4587 if (hub_handle_remote_wakeup(hub, i,
4588 portstatus, portchange))
4591 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4595 dev_dbg(hub_dev, "over-current change on port "
4597 clear_port_feature(hdev, i,
4598 USB_PORT_FEAT_C_OVER_CURRENT);
4599 msleep(100); /* Cool down */
4600 hub_power_on(hub, true);
4601 hub_port_status(hub, i, &status, &unused);
4602 if (status & USB_PORT_STAT_OVERCURRENT)
4603 dev_err(hub_dev, "over-current "
4604 "condition on port %d\n", i);
4607 if (portchange & USB_PORT_STAT_C_RESET) {
4609 "reset change on port %d\n",
4611 clear_port_feature(hdev, i,
4612 USB_PORT_FEAT_C_RESET);
4614 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4615 hub_is_superspeed(hub->hdev)) {
4617 "warm reset change on port %d\n",
4619 clear_port_feature(hdev, i,
4620 USB_PORT_FEAT_C_BH_PORT_RESET);
4622 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4623 clear_port_feature(hub->hdev, i,
4624 USB_PORT_FEAT_C_PORT_LINK_STATE);
4626 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4628 "config error on port %d\n",
4630 clear_port_feature(hub->hdev, i,
4631 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4634 /* Warm reset a USB3 protocol port if it's in
4635 * SS.Inactive state.
4637 if (hub_port_warm_reset_required(hub, portstatus)) {
4638 dev_dbg(hub_dev, "warm reset port %d\n", i);
4639 hub_port_reset(hub, i, NULL,
4640 HUB_BH_RESET_TIME, true);
4644 hub_port_connect_change(hub, i,
4645 portstatus, portchange);
4648 /* deal with hub status changes */
4649 if (test_and_clear_bit(0, hub->event_bits) == 0)
4651 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4652 dev_err (hub_dev, "get_hub_status failed\n");
4654 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4655 dev_dbg (hub_dev, "power change\n");
4656 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4657 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4658 /* FIXME: Is this always true? */
4659 hub->limited_power = 1;
4661 hub->limited_power = 0;
4663 if (hubchange & HUB_CHANGE_OVERCURRENT) {
4667 dev_dbg(hub_dev, "over-current change\n");
4668 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4669 msleep(500); /* Cool down */
4670 hub_power_on(hub, true);
4671 hub_hub_status(hub, &status, &unused);
4672 if (status & HUB_STATUS_OVERCURRENT)
4673 dev_err(hub_dev, "over-current "
4679 /* Balance the usb_autopm_get_interface() above */
4680 usb_autopm_put_interface_no_suspend(intf);
4682 /* Balance the usb_autopm_get_interface_no_resume() in
4683 * kick_khubd() and allow autosuspend.
4685 usb_autopm_put_interface(intf);
4687 usb_unlock_device(hdev);
4688 kref_put(&hub->kref, hub_release);
4690 } /* end while (1) */
4693 static int hub_thread(void *__unused)
4695 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4696 * port handover. Otherwise it might see that a full-speed device
4697 * was gone before the EHCI controller had handed its port over to
4698 * the companion full-speed controller.
4704 wait_event_freezable(khubd_wait,
4705 !list_empty(&hub_event_list) ||
4706 kthread_should_stop());
4707 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
4709 pr_debug("%s: khubd exiting\n", usbcore_name);
4713 static const struct usb_device_id hub_id_table[] = {
4714 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4715 | USB_DEVICE_ID_MATCH_INT_CLASS,
4716 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4717 .bInterfaceClass = USB_CLASS_HUB,
4718 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
4719 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4720 .bDeviceClass = USB_CLASS_HUB},
4721 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4722 .bInterfaceClass = USB_CLASS_HUB},
4723 { } /* Terminating entry */
4726 MODULE_DEVICE_TABLE (usb, hub_id_table);
4728 static struct usb_driver hub_driver = {
4731 .disconnect = hub_disconnect,
4732 .suspend = hub_suspend,
4733 .resume = hub_resume,
4734 .reset_resume = hub_reset_resume,
4735 .pre_reset = hub_pre_reset,
4736 .post_reset = hub_post_reset,
4737 .unlocked_ioctl = hub_ioctl,
4738 .id_table = hub_id_table,
4739 .supports_autosuspend = 1,
4742 int usb_hub_init(void)
4744 if (usb_register(&hub_driver) < 0) {
4745 printk(KERN_ERR "%s: can't register hub driver\n",
4750 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4751 if (!IS_ERR(khubd_task))
4754 /* Fall through if kernel_thread failed */
4755 usb_deregister(&hub_driver);
4756 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4761 void usb_hub_cleanup(void)
4763 kthread_stop(khubd_task);
4766 * Hub resources are freed for us by usb_deregister. It calls
4767 * usb_driver_purge on every device which in turn calls that
4768 * devices disconnect function if it is using this driver.
4769 * The hub_disconnect function takes care of releasing the
4770 * individual hub resources. -greg
4772 usb_deregister(&hub_driver);
4773 } /* usb_hub_cleanup() */
4775 static int descriptors_changed(struct usb_device *udev,
4776 struct usb_device_descriptor *old_device_descriptor)
4780 unsigned serial_len = 0;
4782 unsigned old_length;
4786 if (memcmp(&udev->descriptor, old_device_descriptor,
4787 sizeof(*old_device_descriptor)) != 0)
4790 /* Since the idVendor, idProduct, and bcdDevice values in the
4791 * device descriptor haven't changed, we will assume the
4792 * Manufacturer and Product strings haven't changed either.
4793 * But the SerialNumber string could be different (e.g., a
4794 * different flash card of the same brand).
4797 serial_len = strlen(udev->serial) + 1;
4800 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4801 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4802 len = max(len, old_length);
4805 buf = kmalloc(len, GFP_NOIO);
4807 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4808 /* assume the worst */
4811 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4812 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4813 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4815 if (length != old_length) {
4816 dev_dbg(&udev->dev, "config index %d, error %d\n",
4821 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4823 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4825 ((struct usb_config_descriptor *) buf)->
4826 bConfigurationValue);
4832 if (!changed && serial_len) {
4833 length = usb_string(udev, udev->descriptor.iSerialNumber,
4835 if (length + 1 != serial_len) {
4836 dev_dbg(&udev->dev, "serial string error %d\n",
4839 } else if (memcmp(buf, udev->serial, length) != 0) {
4840 dev_dbg(&udev->dev, "serial string changed\n");
4850 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4851 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4853 * WARNING - don't use this routine to reset a composite device
4854 * (one with multiple interfaces owned by separate drivers)!
4855 * Use usb_reset_device() instead.
4857 * Do a port reset, reassign the device's address, and establish its
4858 * former operating configuration. If the reset fails, or the device's
4859 * descriptors change from their values before the reset, or the original
4860 * configuration and altsettings cannot be restored, a flag will be set
4861 * telling khubd to pretend the device has been disconnected and then
4862 * re-connected. All drivers will be unbound, and the device will be
4863 * re-enumerated and probed all over again.
4865 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4866 * flagged for logical disconnection, or some other negative error code
4867 * if the reset wasn't even attempted.
4869 * The caller must own the device lock. For example, it's safe to use
4870 * this from a driver probe() routine after downloading new firmware.
4871 * For calls that might not occur during probe(), drivers should lock
4872 * the device using usb_lock_device_for_reset().
4874 * Locking exception: This routine may also be called from within an
4875 * autoresume handler. Such usage won't conflict with other tasks
4876 * holding the device lock because these tasks should always call
4877 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4879 static int usb_reset_and_verify_device(struct usb_device *udev)
4881 struct usb_device *parent_hdev = udev->parent;
4882 struct usb_hub *parent_hub;
4883 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4884 struct usb_device_descriptor descriptor = udev->descriptor;
4886 int port1 = udev->portnum;
4888 if (udev->state == USB_STATE_NOTATTACHED ||
4889 udev->state == USB_STATE_SUSPENDED) {
4890 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4896 /* this requires hcd-specific logic; see ohci_restart() */
4897 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4900 parent_hub = hdev_to_hub(parent_hdev);
4902 /* Disable LPM and LTM while we reset the device and reinstall the alt
4903 * settings. Device-initiated LPM settings, and system exit latency
4904 * settings are cleared when the device is reset, so we have to set
4907 ret = usb_unlocked_disable_lpm(udev);
4909 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
4912 ret = usb_disable_ltm(udev);
4914 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
4919 set_bit(port1, parent_hub->busy_bits);
4920 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4922 /* ep0 maxpacket size may change; let the HCD know about it.
4923 * Other endpoints will be handled by re-enumeration. */
4924 usb_ep0_reinit(udev);
4925 ret = hub_port_init(parent_hub, udev, port1, i);
4926 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4929 clear_bit(port1, parent_hub->busy_bits);
4934 /* Device might have changed firmware (DFU or similar) */
4935 if (descriptors_changed(udev, &descriptor)) {
4936 dev_info(&udev->dev, "device firmware changed\n");
4937 udev->descriptor = descriptor; /* for disconnect() calls */
4941 /* Restore the device's previous configuration */
4942 if (!udev->actconfig)
4945 mutex_lock(hcd->bandwidth_mutex);
4946 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4948 dev_warn(&udev->dev,
4949 "Busted HC? Not enough HCD resources for "
4950 "old configuration.\n");
4951 mutex_unlock(hcd->bandwidth_mutex);
4954 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4955 USB_REQ_SET_CONFIGURATION, 0,
4956 udev->actconfig->desc.bConfigurationValue, 0,
4957 NULL, 0, USB_CTRL_SET_TIMEOUT);
4960 "can't restore configuration #%d (error=%d)\n",
4961 udev->actconfig->desc.bConfigurationValue, ret);
4962 mutex_unlock(hcd->bandwidth_mutex);
4965 mutex_unlock(hcd->bandwidth_mutex);
4966 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4968 /* Put interfaces back into the same altsettings as before.
4969 * Don't bother to send the Set-Interface request for interfaces
4970 * that were already in altsetting 0; besides being unnecessary,
4971 * many devices can't handle it. Instead just reset the host-side
4974 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4975 struct usb_host_config *config = udev->actconfig;
4976 struct usb_interface *intf = config->interface[i];
4977 struct usb_interface_descriptor *desc;
4979 desc = &intf->cur_altsetting->desc;
4980 if (desc->bAlternateSetting == 0) {
4981 usb_disable_interface(udev, intf, true);
4982 usb_enable_interface(udev, intf, true);
4985 /* Let the bandwidth allocation function know that this
4986 * device has been reset, and it will have to use
4987 * alternate setting 0 as the current alternate setting.
4989 intf->resetting_device = 1;
4990 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4991 desc->bAlternateSetting);
4992 intf->resetting_device = 0;
4995 dev_err(&udev->dev, "failed to restore interface %d "
4996 "altsetting %d (error=%d)\n",
4997 desc->bInterfaceNumber,
4998 desc->bAlternateSetting,
5005 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5006 usb_unlocked_enable_lpm(udev);
5007 usb_enable_ltm(udev);
5011 /* LPM state doesn't matter when we're about to destroy the device. */
5012 hub_port_logical_disconnect(parent_hub, port1);
5017 * usb_reset_device - warn interface drivers and perform a USB port reset
5018 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5020 * Warns all drivers bound to registered interfaces (using their pre_reset
5021 * method), performs the port reset, and then lets the drivers know that
5022 * the reset is over (using their post_reset method).
5024 * Return value is the same as for usb_reset_and_verify_device().
5026 * The caller must own the device lock. For example, it's safe to use
5027 * this from a driver probe() routine after downloading new firmware.
5028 * For calls that might not occur during probe(), drivers should lock
5029 * the device using usb_lock_device_for_reset().
5031 * If an interface is currently being probed or disconnected, we assume
5032 * its driver knows how to handle resets. For all other interfaces,
5033 * if the driver doesn't have pre_reset and post_reset methods then
5034 * we attempt to unbind it and rebind afterward.
5036 int usb_reset_device(struct usb_device *udev)
5040 struct usb_host_config *config = udev->actconfig;
5042 if (udev->state == USB_STATE_NOTATTACHED ||
5043 udev->state == USB_STATE_SUSPENDED) {
5044 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5049 /* Prevent autosuspend during the reset */
5050 usb_autoresume_device(udev);
5053 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5054 struct usb_interface *cintf = config->interface[i];
5055 struct usb_driver *drv;
5058 if (cintf->dev.driver) {
5059 drv = to_usb_driver(cintf->dev.driver);
5060 if (drv->pre_reset && drv->post_reset)
5061 unbind = (drv->pre_reset)(cintf);
5062 else if (cintf->condition ==
5063 USB_INTERFACE_BOUND)
5066 usb_forced_unbind_intf(cintf);
5071 ret = usb_reset_and_verify_device(udev);
5074 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5075 struct usb_interface *cintf = config->interface[i];
5076 struct usb_driver *drv;
5077 int rebind = cintf->needs_binding;
5079 if (!rebind && cintf->dev.driver) {
5080 drv = to_usb_driver(cintf->dev.driver);
5081 if (drv->post_reset)
5082 rebind = (drv->post_reset)(cintf);
5083 else if (cintf->condition ==
5084 USB_INTERFACE_BOUND)
5087 if (ret == 0 && rebind)
5088 usb_rebind_intf(cintf);
5092 usb_autosuspend_device(udev);
5095 EXPORT_SYMBOL_GPL(usb_reset_device);
5099 * usb_queue_reset_device - Reset a USB device from an atomic context
5100 * @iface: USB interface belonging to the device to reset
5102 * This function can be used to reset a USB device from an atomic
5103 * context, where usb_reset_device() won't work (as it blocks).
5105 * Doing a reset via this method is functionally equivalent to calling
5106 * usb_reset_device(), except for the fact that it is delayed to a
5107 * workqueue. This means that any drivers bound to other interfaces
5108 * might be unbound, as well as users from usbfs in user space.
5112 * - Scheduling two resets at the same time from two different drivers
5113 * attached to two different interfaces of the same device is
5114 * possible; depending on how the driver attached to each interface
5115 * handles ->pre_reset(), the second reset might happen or not.
5117 * - If a driver is unbound and it had a pending reset, the reset will
5120 * - This function can be called during .probe() or .disconnect()
5121 * times. On return from .disconnect(), any pending resets will be
5124 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5127 * NOTE: We don't do any reference count tracking because it is not
5128 * needed. The lifecycle of the work_struct is tied to the
5129 * usb_interface. Before destroying the interface we cancel the
5130 * work_struct, so the fact that work_struct is queued and or
5131 * running means the interface (and thus, the device) exist and
5134 void usb_queue_reset_device(struct usb_interface *iface)
5136 schedule_work(&iface->reset_ws);
5138 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5141 * usb_hub_find_child - Get the pointer of child device
5142 * attached to the port which is specified by @port1.
5143 * @hdev: USB device belonging to the usb hub
5144 * @port1: port num to indicate which port the child device
5147 * USB drivers call this function to get hub's child device
5150 * Return NULL if input param is invalid and
5151 * child's usb_device pointer if non-NULL.
5153 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5156 struct usb_hub *hub = hdev_to_hub(hdev);
5158 if (port1 < 1 || port1 > hdev->maxchild)
5160 return hub->ports[port1 - 1]->child;
5162 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5165 * usb_set_hub_port_connect_type - set hub port connect type.
5166 * @hdev: USB device belonging to the usb hub
5167 * @port1: port num of the port
5168 * @type: connect type of the port
5170 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5171 enum usb_port_connect_type type)
5173 struct usb_hub *hub = hdev_to_hub(hdev);
5175 hub->ports[port1 - 1]->connect_type = type;
5179 * usb_get_hub_port_connect_type - Get the port's connect type
5180 * @hdev: USB device belonging to the usb hub
5181 * @port1: port num of the port
5183 * Return connect type of the port and if input params are
5184 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5186 enum usb_port_connect_type
5187 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5189 struct usb_hub *hub = hdev_to_hub(hdev);
5191 return hub->ports[port1 - 1]->connect_type;
5196 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5197 * @hdev: USB device belonging to the usb hub
5198 * @port1: port num of the port
5200 * Return port's acpi handle if successful, NULL if params are
5203 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5206 struct usb_hub *hub = hdev_to_hub(hdev);
5208 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);