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/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
44 struct urb *urb; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
49 struct usb_hub_status hub;
50 struct usb_port_status port;
51 } *status; /* buffer for status reports */
52 struct mutex status_mutex; /* for the status buffer */
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
57 struct list_head event_list; /* hubs w/data or errs ready */
58 unsigned long event_bits[1]; /* status change bitmask */
59 unsigned long change_bits[1]; /* ports with logical connect
61 unsigned long busy_bits[1]; /* ports being reset or
63 unsigned long removed_bits[1]; /* ports with a "removed"
65 unsigned long wakeup_bits[1]; /* ports that have signaled
67 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
68 #error event_bits[] is too short!
71 struct usb_hub_descriptor *descriptor; /* class descriptor */
72 struct usb_tt tt; /* Transaction Translator */
74 unsigned mA_per_port; /* current for each child */
76 unsigned limited_power:1;
78 unsigned disconnected:1;
80 unsigned has_indicators:1;
81 u8 indicator[USB_MAXCHILDREN];
82 struct delayed_work leds;
83 struct delayed_work init_work;
87 static inline int hub_is_superspeed(struct usb_device *hdev)
89 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
92 /* Protect struct usb_device->state and ->children members
93 * Note: Both are also protected by ->dev.sem, except that ->state can
94 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
95 static DEFINE_SPINLOCK(device_state_lock);
97 /* khubd's worklist and its lock */
98 static DEFINE_SPINLOCK(hub_event_lock);
99 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
102 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
104 static struct task_struct *khubd_task;
106 /* cycle leds on hubs that aren't blinking for attention */
107 static bool blinkenlights = 0;
108 module_param (blinkenlights, bool, S_IRUGO);
109 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
112 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
113 * 10 seconds to send reply for the initial 64-byte descriptor request.
115 /* define initial 64-byte descriptor request timeout in milliseconds */
116 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
117 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
118 MODULE_PARM_DESC(initial_descriptor_timeout,
119 "initial 64-byte descriptor request timeout in milliseconds "
120 "(default 5000 - 5.0 seconds)");
123 * As of 2.6.10 we introduce a new USB device initialization scheme which
124 * closely resembles the way Windows works. Hopefully it will be compatible
125 * with a wider range of devices than the old scheme. However some previously
126 * working devices may start giving rise to "device not accepting address"
127 * errors; if that happens the user can try the old scheme by adjusting the
128 * following module parameters.
130 * For maximum flexibility there are two boolean parameters to control the
131 * hub driver's behavior. On the first initialization attempt, if the
132 * "old_scheme_first" parameter is set then the old scheme will be used,
133 * otherwise the new scheme is used. If that fails and "use_both_schemes"
134 * is set, then the driver will make another attempt, using the other scheme.
136 static bool old_scheme_first = 0;
137 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
138 MODULE_PARM_DESC(old_scheme_first,
139 "start with the old device initialization scheme");
141 static bool use_both_schemes = 1;
142 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
143 MODULE_PARM_DESC(use_both_schemes,
144 "try the other device initialization scheme if the "
147 /* Mutual exclusion for EHCI CF initialization. This interferes with
148 * port reset on some companion controllers.
150 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
151 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
153 #define HUB_DEBOUNCE_TIMEOUT 1500
154 #define HUB_DEBOUNCE_STEP 25
155 #define HUB_DEBOUNCE_STABLE 100
158 static int usb_reset_and_verify_device(struct usb_device *udev);
160 static inline char *portspeed(struct usb_hub *hub, int portstatus)
162 if (hub_is_superspeed(hub->hdev))
164 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
166 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
172 /* Note that hdev or one of its children must be locked! */
173 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
175 if (!hdev || !hdev->actconfig)
177 return usb_get_intfdata(hdev->actconfig->interface[0]);
180 /* USB 2.0 spec Section 11.24.4.5 */
181 static int get_hub_descriptor(struct usb_device *hdev, void *data)
186 if (hub_is_superspeed(hdev)) {
187 dtype = USB_DT_SS_HUB;
188 size = USB_DT_SS_HUB_SIZE;
191 size = sizeof(struct usb_hub_descriptor);
194 for (i = 0; i < 3; i++) {
195 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
196 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
197 dtype << 8, 0, data, size,
198 USB_CTRL_GET_TIMEOUT);
199 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
206 * USB 2.0 spec Section 11.24.2.1
208 static int clear_hub_feature(struct usb_device *hdev, int feature)
210 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
211 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
215 * USB 2.0 spec Section 11.24.2.2
217 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
219 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
220 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
225 * USB 2.0 spec Section 11.24.2.13
227 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
229 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
230 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
235 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
236 * for info about using port indicators
238 static void set_port_led(
244 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
245 USB_PORT_FEAT_INDICATOR);
247 dev_dbg (hub->intfdev,
248 "port %d indicator %s status %d\n",
250 ({ char *s; switch (selector) {
251 case HUB_LED_AMBER: s = "amber"; break;
252 case HUB_LED_GREEN: s = "green"; break;
253 case HUB_LED_OFF: s = "off"; break;
254 case HUB_LED_AUTO: s = "auto"; break;
255 default: s = "??"; break;
260 #define LED_CYCLE_PERIOD ((2*HZ)/3)
262 static void led_work (struct work_struct *work)
264 struct usb_hub *hub =
265 container_of(work, struct usb_hub, leds.work);
266 struct usb_device *hdev = hub->hdev;
268 unsigned changed = 0;
271 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
274 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
275 unsigned selector, mode;
277 /* 30%-50% duty cycle */
279 switch (hub->indicator[i]) {
281 case INDICATOR_CYCLE:
283 selector = HUB_LED_AUTO;
284 mode = INDICATOR_AUTO;
286 /* blinking green = sw attention */
287 case INDICATOR_GREEN_BLINK:
288 selector = HUB_LED_GREEN;
289 mode = INDICATOR_GREEN_BLINK_OFF;
291 case INDICATOR_GREEN_BLINK_OFF:
292 selector = HUB_LED_OFF;
293 mode = INDICATOR_GREEN_BLINK;
295 /* blinking amber = hw attention */
296 case INDICATOR_AMBER_BLINK:
297 selector = HUB_LED_AMBER;
298 mode = INDICATOR_AMBER_BLINK_OFF;
300 case INDICATOR_AMBER_BLINK_OFF:
301 selector = HUB_LED_OFF;
302 mode = INDICATOR_AMBER_BLINK;
304 /* blink green/amber = reserved */
305 case INDICATOR_ALT_BLINK:
306 selector = HUB_LED_GREEN;
307 mode = INDICATOR_ALT_BLINK_OFF;
309 case INDICATOR_ALT_BLINK_OFF:
310 selector = HUB_LED_AMBER;
311 mode = INDICATOR_ALT_BLINK;
316 if (selector != HUB_LED_AUTO)
318 set_port_led(hub, i + 1, selector);
319 hub->indicator[i] = mode;
321 if (!changed && blinkenlights) {
323 cursor %= hub->descriptor->bNbrPorts;
324 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
325 hub->indicator[cursor] = INDICATOR_CYCLE;
329 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
332 /* use a short timeout for hub/port status fetches */
333 #define USB_STS_TIMEOUT 1000
334 #define USB_STS_RETRIES 5
337 * USB 2.0 spec Section 11.24.2.6
339 static int get_hub_status(struct usb_device *hdev,
340 struct usb_hub_status *data)
342 int i, status = -ETIMEDOUT;
344 for (i = 0; i < USB_STS_RETRIES &&
345 (status == -ETIMEDOUT || status == -EPIPE); i++) {
346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
348 data, sizeof(*data), USB_STS_TIMEOUT);
354 * USB 2.0 spec Section 11.24.2.7
356 static int get_port_status(struct usb_device *hdev, int port1,
357 struct usb_port_status *data)
359 int i, status = -ETIMEDOUT;
361 for (i = 0; i < USB_STS_RETRIES &&
362 (status == -ETIMEDOUT || status == -EPIPE); i++) {
363 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
364 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
365 data, sizeof(*data), USB_STS_TIMEOUT);
370 static int hub_port_status(struct usb_hub *hub, int port1,
371 u16 *status, u16 *change)
375 mutex_lock(&hub->status_mutex);
376 ret = get_port_status(hub->hdev, port1, &hub->status->port);
378 dev_err(hub->intfdev,
379 "%s failed (err = %d)\n", __func__, ret);
383 *status = le16_to_cpu(hub->status->port.wPortStatus);
384 *change = le16_to_cpu(hub->status->port.wPortChange);
388 mutex_unlock(&hub->status_mutex);
392 static void kick_khubd(struct usb_hub *hub)
396 spin_lock_irqsave(&hub_event_lock, flags);
397 if (!hub->disconnected && list_empty(&hub->event_list)) {
398 list_add_tail(&hub->event_list, &hub_event_list);
400 /* Suppress autosuspend until khubd runs */
401 usb_autopm_get_interface_no_resume(
402 to_usb_interface(hub->intfdev));
403 wake_up(&khubd_wait);
405 spin_unlock_irqrestore(&hub_event_lock, flags);
408 void usb_kick_khubd(struct usb_device *hdev)
410 struct usb_hub *hub = hdev_to_hub(hdev);
417 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
418 * Notification, which indicates it had initiated remote wakeup.
420 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
421 * device initiates resume, so the USB core will not receive notice of the
422 * resume through the normal hub interrupt URB.
424 void usb_wakeup_notification(struct usb_device *hdev,
425 unsigned int portnum)
432 hub = hdev_to_hub(hdev);
434 set_bit(portnum, hub->wakeup_bits);
438 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
440 /* completion function, fires on port status changes and various faults */
441 static void hub_irq(struct urb *urb)
443 struct usb_hub *hub = urb->context;
444 int status = urb->status;
449 case -ENOENT: /* synchronous unlink */
450 case -ECONNRESET: /* async unlink */
451 case -ESHUTDOWN: /* hardware going away */
454 default: /* presumably an error */
455 /* Cause a hub reset after 10 consecutive errors */
456 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
457 if ((++hub->nerrors < 10) || hub->error)
462 /* let khubd handle things */
463 case 0: /* we got data: port status changed */
465 for (i = 0; i < urb->actual_length; ++i)
466 bits |= ((unsigned long) ((*hub->buffer)[i]))
468 hub->event_bits[0] = bits;
474 /* Something happened, let khubd figure it out */
481 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
482 && status != -ENODEV && status != -EPERM)
483 dev_err (hub->intfdev, "resubmit --> %d\n", status);
486 /* USB 2.0 spec Section 11.24.2.3 */
488 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
490 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
491 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
496 * enumeration blocks khubd for a long time. we use keventd instead, since
497 * long blocking there is the exception, not the rule. accordingly, HCDs
498 * talking to TTs must queue control transfers (not just bulk and iso), so
499 * both can talk to the same hub concurrently.
501 static void hub_tt_work(struct work_struct *work)
503 struct usb_hub *hub =
504 container_of(work, struct usb_hub, tt.clear_work);
508 spin_lock_irqsave (&hub->tt.lock, flags);
509 while (--limit && !list_empty (&hub->tt.clear_list)) {
510 struct list_head *next;
511 struct usb_tt_clear *clear;
512 struct usb_device *hdev = hub->hdev;
513 const struct hc_driver *drv;
516 next = hub->tt.clear_list.next;
517 clear = list_entry (next, struct usb_tt_clear, clear_list);
518 list_del (&clear->clear_list);
520 /* drop lock so HCD can concurrently report other TT errors */
521 spin_unlock_irqrestore (&hub->tt.lock, flags);
522 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
525 "clear tt %d (%04x) error %d\n",
526 clear->tt, clear->devinfo, status);
528 /* Tell the HCD, even if the operation failed */
529 drv = clear->hcd->driver;
530 if (drv->clear_tt_buffer_complete)
531 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
534 spin_lock_irqsave(&hub->tt.lock, flags);
536 spin_unlock_irqrestore (&hub->tt.lock, flags);
540 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
541 * @urb: an URB associated with the failed or incomplete split transaction
543 * High speed HCDs use this to tell the hub driver that some split control or
544 * bulk transaction failed in a way that requires clearing internal state of
545 * a transaction translator. This is normally detected (and reported) from
548 * It may not be possible for that hub to handle additional full (or low)
549 * speed transactions until that state is fully cleared out.
551 int usb_hub_clear_tt_buffer(struct urb *urb)
553 struct usb_device *udev = urb->dev;
554 int pipe = urb->pipe;
555 struct usb_tt *tt = udev->tt;
557 struct usb_tt_clear *clear;
559 /* we've got to cope with an arbitrary number of pending TT clears,
560 * since each TT has "at least two" buffers that can need it (and
561 * there can be many TTs per hub). even if they're uncommon.
563 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
564 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
565 /* FIXME recover somehow ... RESET_TT? */
569 /* info that CLEAR_TT_BUFFER needs */
570 clear->tt = tt->multi ? udev->ttport : 1;
571 clear->devinfo = usb_pipeendpoint (pipe);
572 clear->devinfo |= udev->devnum << 4;
573 clear->devinfo |= usb_pipecontrol (pipe)
574 ? (USB_ENDPOINT_XFER_CONTROL << 11)
575 : (USB_ENDPOINT_XFER_BULK << 11);
576 if (usb_pipein (pipe))
577 clear->devinfo |= 1 << 15;
579 /* info for completion callback */
580 clear->hcd = bus_to_hcd(udev->bus);
583 /* tell keventd to clear state for this TT */
584 spin_lock_irqsave (&tt->lock, flags);
585 list_add_tail (&clear->clear_list, &tt->clear_list);
586 schedule_work(&tt->clear_work);
587 spin_unlock_irqrestore (&tt->lock, flags);
590 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
592 /* If do_delay is false, return the number of milliseconds the caller
595 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
598 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
600 u16 wHubCharacteristics =
601 le16_to_cpu(hub->descriptor->wHubCharacteristics);
603 /* Enable power on each port. Some hubs have reserved values
604 * of LPSM (> 2) in their descriptors, even though they are
605 * USB 2.0 hubs. Some hubs do not implement port-power switching
606 * but only emulate it. In all cases, the ports won't work
607 * unless we send these messages to the hub.
609 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
610 dev_dbg(hub->intfdev, "enabling power on all ports\n");
612 dev_dbg(hub->intfdev, "trying to enable port power on "
613 "non-switchable hub\n");
614 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
615 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
617 /* Wait at least 100 msec for power to become stable */
618 delay = max(pgood_delay, (unsigned) 100);
624 static int hub_hub_status(struct usb_hub *hub,
625 u16 *status, u16 *change)
629 mutex_lock(&hub->status_mutex);
630 ret = get_hub_status(hub->hdev, &hub->status->hub);
632 dev_err (hub->intfdev,
633 "%s failed (err = %d)\n", __func__, ret);
635 *status = le16_to_cpu(hub->status->hub.wHubStatus);
636 *change = le16_to_cpu(hub->status->hub.wHubChange);
639 mutex_unlock(&hub->status_mutex);
643 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
645 struct usb_device *hdev = hub->hdev;
648 if (hdev->children[port1-1] && set_state)
649 usb_set_device_state(hdev->children[port1-1],
650 USB_STATE_NOTATTACHED);
651 if (!hub->error && !hub_is_superspeed(hub->hdev))
652 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
654 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
660 * Disable a port and mark a logical connect-change event, so that some
661 * time later khubd will disconnect() any existing usb_device on the port
662 * and will re-enumerate if there actually is a device attached.
664 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
666 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
667 hub_port_disable(hub, port1, 1);
669 /* FIXME let caller ask to power down the port:
670 * - some devices won't enumerate without a VBUS power cycle
671 * - SRP saves power that way
672 * - ... new call, TBD ...
673 * That's easy if this hub can switch power per-port, and
674 * khubd reactivates the port later (timer, SRP, etc).
675 * Powerdown must be optional, because of reset/DFU.
678 set_bit(port1, hub->change_bits);
683 * usb_remove_device - disable a device's port on its parent hub
684 * @udev: device to be disabled and removed
685 * Context: @udev locked, must be able to sleep.
687 * After @udev's port has been disabled, khubd is notified and it will
688 * see that the device has been disconnected. When the device is
689 * physically unplugged and something is plugged in, the events will
690 * be received and processed normally.
692 int usb_remove_device(struct usb_device *udev)
695 struct usb_interface *intf;
697 if (!udev->parent) /* Can't remove a root hub */
699 hub = hdev_to_hub(udev->parent);
700 intf = to_usb_interface(hub->intfdev);
702 usb_autopm_get_interface(intf);
703 set_bit(udev->portnum, hub->removed_bits);
704 hub_port_logical_disconnect(hub, udev->portnum);
705 usb_autopm_put_interface(intf);
709 enum hub_activation_type {
710 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
711 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
714 static void hub_init_func2(struct work_struct *ws);
715 static void hub_init_func3(struct work_struct *ws);
717 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
719 struct usb_device *hdev = hub->hdev;
724 bool need_debounce_delay = false;
727 /* Continue a partial initialization */
728 if (type == HUB_INIT2)
730 if (type == HUB_INIT3)
733 /* The superspeed hub except for root hub has to use Hub Depth
734 * value as an offset into the route string to locate the bits
735 * it uses to determine the downstream port number. So hub driver
736 * should send a set hub depth request to superspeed hub after
737 * the superspeed hub is set configuration in initialization or
740 * After a resume, port power should still be on.
741 * For any other type of activation, turn it on.
743 if (type != HUB_RESUME) {
744 if (hdev->parent && hub_is_superspeed(hdev)) {
745 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
746 HUB_SET_DEPTH, USB_RT_HUB,
747 hdev->level - 1, 0, NULL, 0,
748 USB_CTRL_SET_TIMEOUT);
750 dev_err(hub->intfdev,
751 "set hub depth failed\n");
754 /* Speed up system boot by using a delayed_work for the
755 * hub's initial power-up delays. This is pretty awkward
756 * and the implementation looks like a home-brewed sort of
757 * setjmp/longjmp, but it saves at least 100 ms for each
758 * root hub (assuming usbcore is compiled into the kernel
759 * rather than as a module). It adds up.
761 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
762 * because for those activation types the ports have to be
763 * operational when we return. In theory this could be done
764 * for HUB_POST_RESET, but it's easier not to.
766 if (type == HUB_INIT) {
767 delay = hub_power_on(hub, false);
768 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
769 schedule_delayed_work(&hub->init_work,
770 msecs_to_jiffies(delay));
772 /* Suppress autosuspend until init is done */
773 usb_autopm_get_interface_no_resume(
774 to_usb_interface(hub->intfdev));
775 return; /* Continues at init2: below */
776 } else if (type == HUB_RESET_RESUME) {
777 /* The internal host controller state for the hub device
778 * may be gone after a host power loss on system resume.
779 * Update the device's info so the HW knows it's a hub.
781 hcd = bus_to_hcd(hdev->bus);
782 if (hcd->driver->update_hub_device) {
783 ret = hcd->driver->update_hub_device(hcd, hdev,
786 dev_err(hub->intfdev, "Host not "
787 "accepting hub info "
789 dev_err(hub->intfdev, "LS/FS devices "
790 "and hubs may not work "
791 "under this hub\n.");
794 hub_power_on(hub, true);
796 hub_power_on(hub, true);
801 /* Check each port and set hub->change_bits to let khubd know
802 * which ports need attention.
804 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
805 struct usb_device *udev = hdev->children[port1-1];
806 u16 portstatus, portchange;
808 portstatus = portchange = 0;
809 status = hub_port_status(hub, port1, &portstatus, &portchange);
810 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
811 dev_dbg(hub->intfdev,
812 "port %d: status %04x change %04x\n",
813 port1, portstatus, portchange);
815 /* After anything other than HUB_RESUME (i.e., initialization
816 * or any sort of reset), every port should be disabled.
817 * Unconnected ports should likewise be disabled (paranoia),
818 * and so should ports for which we have no usb_device.
820 if ((portstatus & USB_PORT_STAT_ENABLE) && (
821 type != HUB_RESUME ||
822 !(portstatus & USB_PORT_STAT_CONNECTION) ||
824 udev->state == USB_STATE_NOTATTACHED)) {
826 * USB3 protocol ports will automatically transition
827 * to Enabled state when detect an USB3.0 device attach.
828 * Do not disable USB3 protocol ports.
830 if (!hub_is_superspeed(hdev)) {
831 clear_port_feature(hdev, port1,
832 USB_PORT_FEAT_ENABLE);
833 portstatus &= ~USB_PORT_STAT_ENABLE;
835 /* Pretend that power was lost for USB3 devs */
836 portstatus &= ~USB_PORT_STAT_ENABLE;
840 /* Clear status-change flags; we'll debounce later */
841 if (portchange & USB_PORT_STAT_C_CONNECTION) {
842 need_debounce_delay = true;
843 clear_port_feature(hub->hdev, port1,
844 USB_PORT_FEAT_C_CONNECTION);
846 if (portchange & USB_PORT_STAT_C_ENABLE) {
847 need_debounce_delay = true;
848 clear_port_feature(hub->hdev, port1,
849 USB_PORT_FEAT_C_ENABLE);
851 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
852 hub_is_superspeed(hub->hdev)) {
853 need_debounce_delay = true;
854 clear_port_feature(hub->hdev, port1,
855 USB_PORT_FEAT_C_BH_PORT_RESET);
857 /* We can forget about a "removed" device when there's a
858 * physical disconnect or the connect status changes.
860 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
861 (portchange & USB_PORT_STAT_C_CONNECTION))
862 clear_bit(port1, hub->removed_bits);
864 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
865 /* Tell khubd to disconnect the device or
866 * check for a new connection
868 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
869 set_bit(port1, hub->change_bits);
871 } else if (portstatus & USB_PORT_STAT_ENABLE) {
872 bool port_resumed = (portstatus &
873 USB_PORT_STAT_LINK_STATE) ==
875 /* The power session apparently survived the resume.
876 * If there was an overcurrent or suspend change
877 * (i.e., remote wakeup request), have khubd
878 * take care of it. Look at the port link state
879 * for USB 3.0 hubs, since they don't have a suspend
880 * change bit, and they don't set the port link change
881 * bit on device-initiated resume.
883 if (portchange || (hub_is_superspeed(hub->hdev) &&
885 set_bit(port1, hub->change_bits);
887 } else if (udev->persist_enabled) {
889 udev->reset_resume = 1;
891 set_bit(port1, hub->change_bits);
894 /* The power session is gone; tell khubd */
895 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
896 set_bit(port1, hub->change_bits);
900 /* If no port-status-change flags were set, we don't need any
901 * debouncing. If flags were set we can try to debounce the
902 * ports all at once right now, instead of letting khubd do them
903 * one at a time later on.
905 * If any port-status changes do occur during this delay, khubd
906 * will see them later and handle them normally.
908 if (need_debounce_delay) {
909 delay = HUB_DEBOUNCE_STABLE;
911 /* Don't do a long sleep inside a workqueue routine */
912 if (type == HUB_INIT2) {
913 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
914 schedule_delayed_work(&hub->init_work,
915 msecs_to_jiffies(delay));
916 return; /* Continues at init3: below */
924 status = usb_submit_urb(hub->urb, GFP_NOIO);
926 dev_err(hub->intfdev, "activate --> %d\n", status);
927 if (hub->has_indicators && blinkenlights)
928 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
930 /* Scan all ports that need attention */
933 /* Allow autosuspend if it was suppressed */
934 if (type <= HUB_INIT3)
935 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
938 /* Implement the continuations for the delays above */
939 static void hub_init_func2(struct work_struct *ws)
941 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
943 hub_activate(hub, HUB_INIT2);
946 static void hub_init_func3(struct work_struct *ws)
948 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
950 hub_activate(hub, HUB_INIT3);
953 enum hub_quiescing_type {
954 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
957 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
959 struct usb_device *hdev = hub->hdev;
962 cancel_delayed_work_sync(&hub->init_work);
964 /* khubd and related activity won't re-trigger */
967 if (type != HUB_SUSPEND) {
968 /* Disconnect all the children */
969 for (i = 0; i < hdev->maxchild; ++i) {
970 if (hdev->children[i])
971 usb_disconnect(&hdev->children[i]);
975 /* Stop khubd and related activity */
976 usb_kill_urb(hub->urb);
977 if (hub->has_indicators)
978 cancel_delayed_work_sync(&hub->leds);
980 cancel_work_sync(&hub->tt.clear_work);
983 /* caller has locked the hub device */
984 static int hub_pre_reset(struct usb_interface *intf)
986 struct usb_hub *hub = usb_get_intfdata(intf);
988 hub_quiesce(hub, HUB_PRE_RESET);
992 /* caller has locked the hub device */
993 static int hub_post_reset(struct usb_interface *intf)
995 struct usb_hub *hub = usb_get_intfdata(intf);
997 hub_activate(hub, HUB_POST_RESET);
1001 static int hub_configure(struct usb_hub *hub,
1002 struct usb_endpoint_descriptor *endpoint)
1004 struct usb_hcd *hcd;
1005 struct usb_device *hdev = hub->hdev;
1006 struct device *hub_dev = hub->intfdev;
1007 u16 hubstatus, hubchange;
1008 u16 wHubCharacteristics;
1011 char *message = "out of memory";
1013 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1019 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1024 mutex_init(&hub->status_mutex);
1026 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1027 if (!hub->descriptor) {
1032 /* Request the entire hub descriptor.
1033 * hub->descriptor can handle USB_MAXCHILDREN ports,
1034 * but the hub can/will return fewer bytes here.
1036 ret = get_hub_descriptor(hdev, hub->descriptor);
1038 message = "can't read hub descriptor";
1040 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1041 message = "hub has too many ports!";
1046 hdev->maxchild = hub->descriptor->bNbrPorts;
1047 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1048 (hdev->maxchild == 1) ? "" : "s");
1050 hdev->children = kzalloc(hdev->maxchild *
1051 sizeof(struct usb_device *), GFP_KERNEL);
1052 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1053 if (!hdev->children || !hub->port_owners) {
1058 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1060 /* FIXME for USB 3.0, skip for now */
1061 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1062 !(hub_is_superspeed(hdev))) {
1064 char portstr [USB_MAXCHILDREN + 1];
1066 for (i = 0; i < hdev->maxchild; i++)
1067 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1068 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1070 portstr[hdev->maxchild] = 0;
1071 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1073 dev_dbg(hub_dev, "standalone hub\n");
1075 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1076 case HUB_CHAR_COMMON_LPSM:
1077 dev_dbg(hub_dev, "ganged power switching\n");
1079 case HUB_CHAR_INDV_PORT_LPSM:
1080 dev_dbg(hub_dev, "individual port power switching\n");
1082 case HUB_CHAR_NO_LPSM:
1084 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1088 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1089 case HUB_CHAR_COMMON_OCPM:
1090 dev_dbg(hub_dev, "global over-current protection\n");
1092 case HUB_CHAR_INDV_PORT_OCPM:
1093 dev_dbg(hub_dev, "individual port over-current protection\n");
1095 case HUB_CHAR_NO_OCPM:
1097 dev_dbg(hub_dev, "no over-current protection\n");
1101 spin_lock_init (&hub->tt.lock);
1102 INIT_LIST_HEAD (&hub->tt.clear_list);
1103 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1104 switch (hdev->descriptor.bDeviceProtocol) {
1107 case USB_HUB_PR_HS_SINGLE_TT:
1108 dev_dbg(hub_dev, "Single TT\n");
1111 case USB_HUB_PR_HS_MULTI_TT:
1112 ret = usb_set_interface(hdev, 0, 1);
1114 dev_dbg(hub_dev, "TT per port\n");
1117 dev_err(hub_dev, "Using single TT (err %d)\n",
1122 /* USB 3.0 hubs don't have a TT */
1125 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1126 hdev->descriptor.bDeviceProtocol);
1130 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1131 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1132 case HUB_TTTT_8_BITS:
1133 if (hdev->descriptor.bDeviceProtocol != 0) {
1134 hub->tt.think_time = 666;
1135 dev_dbg(hub_dev, "TT requires at most %d "
1136 "FS bit times (%d ns)\n",
1137 8, hub->tt.think_time);
1140 case HUB_TTTT_16_BITS:
1141 hub->tt.think_time = 666 * 2;
1142 dev_dbg(hub_dev, "TT requires at most %d "
1143 "FS bit times (%d ns)\n",
1144 16, hub->tt.think_time);
1146 case HUB_TTTT_24_BITS:
1147 hub->tt.think_time = 666 * 3;
1148 dev_dbg(hub_dev, "TT requires at most %d "
1149 "FS bit times (%d ns)\n",
1150 24, hub->tt.think_time);
1152 case HUB_TTTT_32_BITS:
1153 hub->tt.think_time = 666 * 4;
1154 dev_dbg(hub_dev, "TT requires at most %d "
1155 "FS bit times (%d ns)\n",
1156 32, hub->tt.think_time);
1160 /* probe() zeroes hub->indicator[] */
1161 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1162 hub->has_indicators = 1;
1163 dev_dbg(hub_dev, "Port indicators are supported\n");
1166 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1167 hub->descriptor->bPwrOn2PwrGood * 2);
1169 /* power budgeting mostly matters with bus-powered hubs,
1170 * and battery-powered root hubs (may provide just 8 mA).
1172 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1174 message = "can't get hub status";
1177 le16_to_cpus(&hubstatus);
1178 if (hdev == hdev->bus->root_hub) {
1179 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1180 hub->mA_per_port = 500;
1182 hub->mA_per_port = hdev->bus_mA;
1183 hub->limited_power = 1;
1185 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1186 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1187 hub->descriptor->bHubContrCurrent);
1188 hub->limited_power = 1;
1189 if (hdev->maxchild > 0) {
1190 int remaining = hdev->bus_mA -
1191 hub->descriptor->bHubContrCurrent;
1193 if (remaining < hdev->maxchild * 100)
1195 "insufficient power available "
1196 "to use all downstream ports\n");
1197 hub->mA_per_port = 100; /* 7.2.1.1 */
1199 } else { /* Self-powered external hub */
1200 /* FIXME: What about battery-powered external hubs that
1201 * provide less current per port? */
1202 hub->mA_per_port = 500;
1204 if (hub->mA_per_port < 500)
1205 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1208 /* Update the HCD's internal representation of this hub before khubd
1209 * starts getting port status changes for devices under the hub.
1211 hcd = bus_to_hcd(hdev->bus);
1212 if (hcd->driver->update_hub_device) {
1213 ret = hcd->driver->update_hub_device(hcd, hdev,
1214 &hub->tt, GFP_KERNEL);
1216 message = "can't update HCD hub info";
1221 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1223 message = "can't get hub status";
1227 /* local power status reports aren't always correct */
1228 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1229 dev_dbg(hub_dev, "local power source is %s\n",
1230 (hubstatus & HUB_STATUS_LOCAL_POWER)
1231 ? "lost (inactive)" : "good");
1233 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1234 dev_dbg(hub_dev, "%sover-current condition exists\n",
1235 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1237 /* set up the interrupt endpoint
1238 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1239 * bytes as USB2.0[11.12.3] says because some hubs are known
1240 * to send more data (and thus cause overflow). For root hubs,
1241 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1242 * to be big enough for at least USB_MAXCHILDREN ports. */
1243 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1244 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1246 if (maxp > sizeof(*hub->buffer))
1247 maxp = sizeof(*hub->buffer);
1249 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1255 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1256 hub, endpoint->bInterval);
1258 /* maybe cycle the hub leds */
1259 if (hub->has_indicators && blinkenlights)
1260 hub->indicator [0] = INDICATOR_CYCLE;
1262 hub_activate(hub, HUB_INIT);
1266 dev_err (hub_dev, "config failed, %s (err %d)\n",
1268 /* hub_disconnect() frees urb and descriptor */
1272 static void hub_release(struct kref *kref)
1274 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1276 usb_put_intf(to_usb_interface(hub->intfdev));
1280 static unsigned highspeed_hubs;
1282 static void hub_disconnect(struct usb_interface *intf)
1284 struct usb_hub *hub = usb_get_intfdata(intf);
1285 struct usb_device *hdev = interface_to_usbdev(intf);
1287 /* Take the hub off the event list and don't let it be added again */
1288 spin_lock_irq(&hub_event_lock);
1289 if (!list_empty(&hub->event_list)) {
1290 list_del_init(&hub->event_list);
1291 usb_autopm_put_interface_no_suspend(intf);
1293 hub->disconnected = 1;
1294 spin_unlock_irq(&hub_event_lock);
1296 /* Disconnect all children and quiesce the hub */
1298 hub_quiesce(hub, HUB_DISCONNECT);
1300 usb_set_intfdata (intf, NULL);
1301 hub->hdev->maxchild = 0;
1303 if (hub->hdev->speed == USB_SPEED_HIGH)
1306 usb_free_urb(hub->urb);
1307 kfree(hdev->children);
1308 kfree(hub->port_owners);
1309 kfree(hub->descriptor);
1313 kref_put(&hub->kref, hub_release);
1316 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1318 struct usb_host_interface *desc;
1319 struct usb_endpoint_descriptor *endpoint;
1320 struct usb_device *hdev;
1321 struct usb_hub *hub;
1323 desc = intf->cur_altsetting;
1324 hdev = interface_to_usbdev(intf);
1326 /* Hubs have proper suspend/resume support. */
1327 usb_enable_autosuspend(hdev);
1329 if (hdev->level == MAX_TOPO_LEVEL) {
1331 "Unsupported bus topology: hub nested too deep\n");
1335 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1337 dev_warn(&intf->dev, "ignoring external hub\n");
1342 /* Some hubs have a subclass of 1, which AFAICT according to the */
1343 /* specs is not defined, but it works */
1344 if ((desc->desc.bInterfaceSubClass != 0) &&
1345 (desc->desc.bInterfaceSubClass != 1)) {
1347 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1351 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1352 if (desc->desc.bNumEndpoints != 1)
1353 goto descriptor_error;
1355 endpoint = &desc->endpoint[0].desc;
1357 /* If it's not an interrupt in endpoint, we'd better punt! */
1358 if (!usb_endpoint_is_int_in(endpoint))
1359 goto descriptor_error;
1361 /* We found a hub */
1362 dev_info (&intf->dev, "USB hub found\n");
1364 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1366 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1370 kref_init(&hub->kref);
1371 INIT_LIST_HEAD(&hub->event_list);
1372 hub->intfdev = &intf->dev;
1374 INIT_DELAYED_WORK(&hub->leds, led_work);
1375 INIT_DELAYED_WORK(&hub->init_work, NULL);
1378 usb_set_intfdata (intf, hub);
1379 intf->needs_remote_wakeup = 1;
1381 if (hdev->speed == USB_SPEED_HIGH)
1384 if (hub_configure(hub, endpoint) >= 0)
1387 hub_disconnect (intf);
1392 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1394 struct usb_device *hdev = interface_to_usbdev (intf);
1396 /* assert ifno == 0 (part of hub spec) */
1398 case USBDEVFS_HUB_PORTINFO: {
1399 struct usbdevfs_hub_portinfo *info = user_data;
1402 spin_lock_irq(&device_state_lock);
1403 if (hdev->devnum <= 0)
1406 info->nports = hdev->maxchild;
1407 for (i = 0; i < info->nports; i++) {
1408 if (hdev->children[i] == NULL)
1412 hdev->children[i]->devnum;
1415 spin_unlock_irq(&device_state_lock);
1417 return info->nports + 1;
1426 * Allow user programs to claim ports on a hub. When a device is attached
1427 * to one of these "claimed" ports, the program will "own" the device.
1429 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1432 if (hdev->state == USB_STATE_NOTATTACHED)
1434 if (port1 == 0 || port1 > hdev->maxchild)
1437 /* This assumes that devices not managed by the hub driver
1438 * will always have maxchild equal to 0.
1440 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1444 /* In the following three functions, the caller must hold hdev's lock */
1445 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1450 rc = find_port_owner(hdev, port1, &powner);
1459 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1464 rc = find_port_owner(hdev, port1, &powner);
1467 if (*powner != owner)
1473 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1478 n = find_port_owner(hdev, 1, &powner);
1480 for (; n < hdev->maxchild; (++n, ++powner)) {
1481 if (*powner == owner)
1487 /* The caller must hold udev's lock */
1488 bool usb_device_is_owned(struct usb_device *udev)
1490 struct usb_hub *hub;
1492 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1494 hub = hdev_to_hub(udev->parent);
1495 return !!hub->port_owners[udev->portnum - 1];
1499 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1503 for (i = 0; i < udev->maxchild; ++i) {
1504 if (udev->children[i])
1505 recursively_mark_NOTATTACHED(udev->children[i]);
1507 if (udev->state == USB_STATE_SUSPENDED)
1508 udev->active_duration -= jiffies;
1509 udev->state = USB_STATE_NOTATTACHED;
1513 * usb_set_device_state - change a device's current state (usbcore, hcds)
1514 * @udev: pointer to device whose state should be changed
1515 * @new_state: new state value to be stored
1517 * udev->state is _not_ fully protected by the device lock. Although
1518 * most transitions are made only while holding the lock, the state can
1519 * can change to USB_STATE_NOTATTACHED at almost any time. This
1520 * is so that devices can be marked as disconnected as soon as possible,
1521 * without having to wait for any semaphores to be released. As a result,
1522 * all changes to any device's state must be protected by the
1523 * device_state_lock spinlock.
1525 * Once a device has been added to the device tree, all changes to its state
1526 * should be made using this routine. The state should _not_ be set directly.
1528 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1529 * Otherwise udev->state is set to new_state, and if new_state is
1530 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1531 * to USB_STATE_NOTATTACHED.
1533 void usb_set_device_state(struct usb_device *udev,
1534 enum usb_device_state new_state)
1536 unsigned long flags;
1539 spin_lock_irqsave(&device_state_lock, flags);
1540 if (udev->state == USB_STATE_NOTATTACHED)
1542 else if (new_state != USB_STATE_NOTATTACHED) {
1544 /* root hub wakeup capabilities are managed out-of-band
1545 * and may involve silicon errata ... ignore them here.
1548 if (udev->state == USB_STATE_SUSPENDED
1549 || new_state == USB_STATE_SUSPENDED)
1550 ; /* No change to wakeup settings */
1551 else if (new_state == USB_STATE_CONFIGURED)
1552 wakeup = udev->actconfig->desc.bmAttributes
1553 & USB_CONFIG_ATT_WAKEUP;
1557 if (udev->state == USB_STATE_SUSPENDED &&
1558 new_state != USB_STATE_SUSPENDED)
1559 udev->active_duration -= jiffies;
1560 else if (new_state == USB_STATE_SUSPENDED &&
1561 udev->state != USB_STATE_SUSPENDED)
1562 udev->active_duration += jiffies;
1563 udev->state = new_state;
1565 recursively_mark_NOTATTACHED(udev);
1566 spin_unlock_irqrestore(&device_state_lock, flags);
1568 device_set_wakeup_capable(&udev->dev, wakeup);
1570 EXPORT_SYMBOL_GPL(usb_set_device_state);
1573 * Choose a device number.
1575 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1576 * USB-2.0 buses they are also used as device addresses, however on
1577 * USB-3.0 buses the address is assigned by the controller hardware
1578 * and it usually is not the same as the device number.
1580 * WUSB devices are simple: they have no hubs behind, so the mapping
1581 * device <-> virtual port number becomes 1:1. Why? to simplify the
1582 * life of the device connection logic in
1583 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1584 * handshake we need to assign a temporary address in the unauthorized
1585 * space. For simplicity we use the first virtual port number found to
1586 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1587 * and that becomes it's address [X < 128] or its unauthorized address
1590 * We add 1 as an offset to the one-based USB-stack port number
1591 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1592 * 0 is reserved by USB for default address; (b) Linux's USB stack
1593 * uses always #1 for the root hub of the controller. So USB stack's
1594 * port #1, which is wusb virtual-port #0 has address #2.
1596 * Devices connected under xHCI are not as simple. The host controller
1597 * supports virtualization, so the hardware assigns device addresses and
1598 * the HCD must setup data structures before issuing a set address
1599 * command to the hardware.
1601 static void choose_devnum(struct usb_device *udev)
1604 struct usb_bus *bus = udev->bus;
1606 /* If khubd ever becomes multithreaded, this will need a lock */
1608 devnum = udev->portnum + 1;
1609 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1611 /* Try to allocate the next devnum beginning at
1612 * bus->devnum_next. */
1613 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1616 devnum = find_next_zero_bit(bus->devmap.devicemap,
1618 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1621 set_bit(devnum, bus->devmap.devicemap);
1622 udev->devnum = devnum;
1626 static void release_devnum(struct usb_device *udev)
1628 if (udev->devnum > 0) {
1629 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1634 static void update_devnum(struct usb_device *udev, int devnum)
1636 /* The address for a WUSB device is managed by wusbcore. */
1638 udev->devnum = devnum;
1641 static void hub_free_dev(struct usb_device *udev)
1643 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1645 /* Root hubs aren't real devices, so don't free HCD resources */
1646 if (hcd->driver->free_dev && udev->parent)
1647 hcd->driver->free_dev(hcd, udev);
1651 * usb_disconnect - disconnect a device (usbcore-internal)
1652 * @pdev: pointer to device being disconnected
1653 * Context: !in_interrupt ()
1655 * Something got disconnected. Get rid of it and all of its children.
1657 * If *pdev is a normal device then the parent hub must already be locked.
1658 * If *pdev is a root hub then this routine will acquire the
1659 * usb_bus_list_lock on behalf of the caller.
1661 * Only hub drivers (including virtual root hub drivers for host
1662 * controllers) should ever call this.
1664 * This call is synchronous, and may not be used in an interrupt context.
1666 void usb_disconnect(struct usb_device **pdev)
1668 struct usb_device *udev = *pdev;
1670 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1672 /* mark the device as inactive, so any further urb submissions for
1673 * this device (and any of its children) will fail immediately.
1674 * this quiesces everything except pending urbs.
1676 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1677 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1680 usb_lock_device(udev);
1682 /* Free up all the children before we remove this device */
1683 for (i = 0; i < udev->maxchild; i++) {
1684 if (udev->children[i])
1685 usb_disconnect(&udev->children[i]);
1688 /* deallocate hcd/hardware state ... nuking all pending urbs and
1689 * cleaning up all state associated with the current configuration
1690 * so that the hardware is now fully quiesced.
1692 dev_dbg (&udev->dev, "unregistering device\n");
1693 mutex_lock(hcd->bandwidth_mutex);
1694 usb_disable_device(udev, 0);
1695 mutex_unlock(hcd->bandwidth_mutex);
1696 usb_hcd_synchronize_unlinks(udev);
1698 usb_remove_ep_devs(&udev->ep0);
1699 usb_unlock_device(udev);
1701 /* Unregister the device. The device driver is responsible
1702 * for de-configuring the device and invoking the remove-device
1703 * notifier chain (used by usbfs and possibly others).
1705 device_del(&udev->dev);
1707 /* Free the device number and delete the parent's children[]
1708 * (or root_hub) pointer.
1710 release_devnum(udev);
1712 /* Avoid races with recursively_mark_NOTATTACHED() */
1713 spin_lock_irq(&device_state_lock);
1715 spin_unlock_irq(&device_state_lock);
1719 put_device(&udev->dev);
1722 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1723 static void show_string(struct usb_device *udev, char *id, char *string)
1727 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1730 static void announce_device(struct usb_device *udev)
1732 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1733 le16_to_cpu(udev->descriptor.idVendor),
1734 le16_to_cpu(udev->descriptor.idProduct));
1735 dev_info(&udev->dev,
1736 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1737 udev->descriptor.iManufacturer,
1738 udev->descriptor.iProduct,
1739 udev->descriptor.iSerialNumber);
1740 show_string(udev, "Product", udev->product);
1741 show_string(udev, "Manufacturer", udev->manufacturer);
1742 show_string(udev, "SerialNumber", udev->serial);
1745 static inline void announce_device(struct usb_device *udev) { }
1748 #ifdef CONFIG_USB_OTG
1749 #include "otg_whitelist.h"
1753 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1754 * @udev: newly addressed device (in ADDRESS state)
1756 * Finish enumeration for On-The-Go devices
1758 static int usb_enumerate_device_otg(struct usb_device *udev)
1762 #ifdef CONFIG_USB_OTG
1764 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1765 * to wake us after we've powered off VBUS; and HNP, switching roles
1766 * "host" to "peripheral". The OTG descriptor helps figure this out.
1768 if (!udev->bus->is_b_host
1770 && udev->parent == udev->bus->root_hub) {
1771 struct usb_otg_descriptor *desc = NULL;
1772 struct usb_bus *bus = udev->bus;
1774 /* descriptor may appear anywhere in config */
1775 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1776 le16_to_cpu(udev->config[0].desc.wTotalLength),
1777 USB_DT_OTG, (void **) &desc) == 0) {
1778 if (desc->bmAttributes & USB_OTG_HNP) {
1779 unsigned port1 = udev->portnum;
1781 dev_info(&udev->dev,
1782 "Dual-Role OTG device on %sHNP port\n",
1783 (port1 == bus->otg_port)
1786 /* enable HNP before suspend, it's simpler */
1787 if (port1 == bus->otg_port)
1788 bus->b_hnp_enable = 1;
1789 err = usb_control_msg(udev,
1790 usb_sndctrlpipe(udev, 0),
1791 USB_REQ_SET_FEATURE, 0,
1793 ? USB_DEVICE_B_HNP_ENABLE
1794 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1795 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1797 /* OTG MESSAGE: report errors here,
1798 * customize to match your product.
1800 dev_info(&udev->dev,
1801 "can't set HNP mode: %d\n",
1803 bus->b_hnp_enable = 0;
1809 if (!is_targeted(udev)) {
1811 /* Maybe it can talk to us, though we can't talk to it.
1812 * (Includes HNP test device.)
1814 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1815 err = usb_port_suspend(udev, PMSG_SUSPEND);
1817 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1829 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1830 * @udev: newly addressed device (in ADDRESS state)
1832 * This is only called by usb_new_device() and usb_authorize_device()
1833 * and FIXME -- all comments that apply to them apply here wrt to
1836 * If the device is WUSB and not authorized, we don't attempt to read
1837 * the string descriptors, as they will be errored out by the device
1838 * until it has been authorized.
1840 static int usb_enumerate_device(struct usb_device *udev)
1844 if (udev->config == NULL) {
1845 err = usb_get_configuration(udev);
1847 dev_err(&udev->dev, "can't read configurations, error %d\n",
1852 if (udev->wusb == 1 && udev->authorized == 0) {
1853 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1854 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1855 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1858 /* read the standard strings and cache them if present */
1859 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1860 udev->manufacturer = usb_cache_string(udev,
1861 udev->descriptor.iManufacturer);
1862 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1864 err = usb_enumerate_device_otg(udev);
1869 static void set_usb_port_removable(struct usb_device *udev)
1871 struct usb_device *hdev = udev->parent;
1872 struct usb_hub *hub;
1873 u8 port = udev->portnum;
1874 u16 wHubCharacteristics;
1875 bool removable = true;
1880 hub = hdev_to_hub(udev->parent);
1882 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1884 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1887 if (hub_is_superspeed(hdev)) {
1888 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1891 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1896 udev->removable = USB_DEVICE_REMOVABLE;
1898 udev->removable = USB_DEVICE_FIXED;
1902 * usb_new_device - perform initial device setup (usbcore-internal)
1903 * @udev: newly addressed device (in ADDRESS state)
1905 * This is called with devices which have been detected but not fully
1906 * enumerated. The device descriptor is available, but not descriptors
1907 * for any device configuration. The caller must have locked either
1908 * the parent hub (if udev is a normal device) or else the
1909 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1910 * udev has already been installed, but udev is not yet visible through
1911 * sysfs or other filesystem code.
1913 * It will return if the device is configured properly or not. Zero if
1914 * the interface was registered with the driver core; else a negative
1917 * This call is synchronous, and may not be used in an interrupt context.
1919 * Only the hub driver or root-hub registrar should ever call this.
1921 int usb_new_device(struct usb_device *udev)
1926 /* Initialize non-root-hub device wakeup to disabled;
1927 * device (un)configuration controls wakeup capable
1928 * sysfs power/wakeup controls wakeup enabled/disabled
1930 device_init_wakeup(&udev->dev, 0);
1933 /* Tell the runtime-PM framework the device is active */
1934 pm_runtime_set_active(&udev->dev);
1935 pm_runtime_get_noresume(&udev->dev);
1936 pm_runtime_use_autosuspend(&udev->dev);
1937 pm_runtime_enable(&udev->dev);
1939 /* By default, forbid autosuspend for all devices. It will be
1940 * allowed for hubs during binding.
1942 usb_disable_autosuspend(udev);
1944 err = usb_enumerate_device(udev); /* Read descriptors */
1947 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1948 udev->devnum, udev->bus->busnum,
1949 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1950 /* export the usbdev device-node for libusb */
1951 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1952 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1954 /* Tell the world! */
1955 announce_device(udev);
1957 device_enable_async_suspend(&udev->dev);
1960 * check whether the hub marks this port as non-removable. Do it
1961 * now so that platform-specific data can override it in
1965 set_usb_port_removable(udev);
1967 /* Register the device. The device driver is responsible
1968 * for configuring the device and invoking the add-device
1969 * notifier chain (used by usbfs and possibly others).
1971 err = device_add(&udev->dev);
1973 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1977 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1978 usb_mark_last_busy(udev);
1979 pm_runtime_put_sync_autosuspend(&udev->dev);
1983 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1984 pm_runtime_disable(&udev->dev);
1985 pm_runtime_set_suspended(&udev->dev);
1991 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1992 * @usb_dev: USB device
1994 * Move the USB device to a very basic state where interfaces are disabled
1995 * and the device is in fact unconfigured and unusable.
1997 * We share a lock (that we have) with device_del(), so we need to
2000 int usb_deauthorize_device(struct usb_device *usb_dev)
2002 usb_lock_device(usb_dev);
2003 if (usb_dev->authorized == 0)
2004 goto out_unauthorized;
2006 usb_dev->authorized = 0;
2007 usb_set_configuration(usb_dev, -1);
2009 kfree(usb_dev->product);
2010 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2011 kfree(usb_dev->manufacturer);
2012 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2013 kfree(usb_dev->serial);
2014 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2016 usb_destroy_configuration(usb_dev);
2017 usb_dev->descriptor.bNumConfigurations = 0;
2020 usb_unlock_device(usb_dev);
2025 int usb_authorize_device(struct usb_device *usb_dev)
2029 usb_lock_device(usb_dev);
2030 if (usb_dev->authorized == 1)
2031 goto out_authorized;
2033 result = usb_autoresume_device(usb_dev);
2035 dev_err(&usb_dev->dev,
2036 "can't autoresume for authorization: %d\n", result);
2037 goto error_autoresume;
2039 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2041 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2042 "authorization: %d\n", result);
2043 goto error_device_descriptor;
2046 kfree(usb_dev->product);
2047 usb_dev->product = NULL;
2048 kfree(usb_dev->manufacturer);
2049 usb_dev->manufacturer = NULL;
2050 kfree(usb_dev->serial);
2051 usb_dev->serial = NULL;
2053 usb_dev->authorized = 1;
2054 result = usb_enumerate_device(usb_dev);
2056 goto error_enumerate;
2057 /* Choose and set the configuration. This registers the interfaces
2058 * with the driver core and lets interface drivers bind to them.
2060 c = usb_choose_configuration(usb_dev);
2062 result = usb_set_configuration(usb_dev, c);
2064 dev_err(&usb_dev->dev,
2065 "can't set config #%d, error %d\n", c, result);
2066 /* This need not be fatal. The user can try to
2067 * set other configurations. */
2070 dev_info(&usb_dev->dev, "authorized to connect\n");
2073 error_device_descriptor:
2074 usb_autosuspend_device(usb_dev);
2077 usb_unlock_device(usb_dev); // complements locktree
2082 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2083 static unsigned hub_is_wusb(struct usb_hub *hub)
2085 struct usb_hcd *hcd;
2086 if (hub->hdev->parent != NULL) /* not a root hub? */
2088 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2089 return hcd->wireless;
2093 #define PORT_RESET_TRIES 5
2094 #define SET_ADDRESS_TRIES 2
2095 #define GET_DESCRIPTOR_TRIES 2
2096 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2097 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2099 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2100 #define HUB_SHORT_RESET_TIME 10
2101 #define HUB_BH_RESET_TIME 50
2102 #define HUB_LONG_RESET_TIME 200
2103 #define HUB_RESET_TIMEOUT 500
2105 static int hub_port_reset(struct usb_hub *hub, int port1,
2106 struct usb_device *udev, unsigned int delay, bool warm);
2108 /* Is a USB 3.0 port in the Inactive state? */
2109 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2111 return hub_is_superspeed(hub->hdev) &&
2112 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2113 USB_SS_PORT_LS_SS_INACTIVE;
2116 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2117 struct usb_device *udev, unsigned int delay, bool warm)
2119 int delay_time, ret;
2123 for (delay_time = 0;
2124 delay_time < HUB_RESET_TIMEOUT;
2125 delay_time += delay) {
2126 /* wait to give the device a chance to reset */
2129 /* read and decode port status */
2130 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2135 * Some buggy devices require a warm reset to be issued even
2136 * when the port appears not to be connected.
2140 * Some buggy devices can cause an NEC host controller
2141 * to transition to the "Error" state after a hot port
2142 * reset. This will show up as the port state in
2143 * "Inactive", and the port may also report a
2144 * disconnect. Forcing a warm port reset seems to make
2147 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2149 if (hub_port_inactive(hub, portstatus)) {
2152 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2153 clear_port_feature(hub->hdev, port1,
2154 USB_PORT_FEAT_C_CONNECTION);
2155 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2156 clear_port_feature(hub->hdev, port1,
2157 USB_PORT_FEAT_C_PORT_LINK_STATE);
2158 if (portchange & USB_PORT_STAT_C_RESET)
2159 clear_port_feature(hub->hdev, port1,
2160 USB_PORT_FEAT_C_RESET);
2161 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2163 ret = hub_port_reset(hub, port1,
2164 udev, HUB_BH_RESET_TIME,
2166 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2167 clear_port_feature(hub->hdev, port1,
2168 USB_PORT_FEAT_C_CONNECTION);
2171 /* Device went away? */
2172 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2175 /* bomb out completely if the connection bounced */
2176 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2179 /* if we`ve finished resetting, then break out of
2182 if (!(portstatus & USB_PORT_STAT_RESET) &&
2183 (portstatus & USB_PORT_STAT_ENABLE)) {
2184 if (hub_is_wusb(hub))
2185 udev->speed = USB_SPEED_WIRELESS;
2186 else if (hub_is_superspeed(hub->hdev))
2187 udev->speed = USB_SPEED_SUPER;
2188 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2189 udev->speed = USB_SPEED_HIGH;
2190 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2191 udev->speed = USB_SPEED_LOW;
2193 udev->speed = USB_SPEED_FULL;
2197 if (portchange & USB_PORT_STAT_C_BH_RESET)
2201 /* switch to the long delay after two short delay failures */
2202 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2203 delay = HUB_LONG_RESET_TIME;
2205 dev_dbg (hub->intfdev,
2206 "port %d not %sreset yet, waiting %dms\n",
2207 port1, warm ? "warm " : "", delay);
2213 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2214 struct usb_device *udev, int *status, bool warm)
2219 struct usb_hcd *hcd;
2220 /* TRSTRCY = 10 ms; plus some extra */
2222 update_devnum(udev, 0);
2223 hcd = bus_to_hcd(udev->bus);
2224 if (hcd->driver->reset_device) {
2225 *status = hcd->driver->reset_device(hcd, udev);
2227 dev_err(&udev->dev, "Cannot reset "
2228 "HCD device state\n");
2236 clear_port_feature(hub->hdev,
2237 port1, USB_PORT_FEAT_C_RESET);
2238 /* FIXME need disconnect() for NOTATTACHED device */
2240 clear_port_feature(hub->hdev, port1,
2241 USB_PORT_FEAT_C_BH_PORT_RESET);
2242 clear_port_feature(hub->hdev, port1,
2243 USB_PORT_FEAT_C_PORT_LINK_STATE);
2245 usb_set_device_state(udev, *status
2246 ? USB_STATE_NOTATTACHED
2247 : USB_STATE_DEFAULT);
2253 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2254 static int hub_port_reset(struct usb_hub *hub, int port1,
2255 struct usb_device *udev, unsigned int delay, bool warm)
2260 /* Block EHCI CF initialization during the port reset.
2261 * Some companion controllers don't like it when they mix.
2263 down_read(&ehci_cf_port_reset_rwsem);
2265 if (!hub_is_superspeed(hub->hdev)) {
2266 dev_err(hub->intfdev, "only USB3 hub support "
2272 /* Reset the port */
2273 for (i = 0; i < PORT_RESET_TRIES; i++) {
2274 status = set_port_feature(hub->hdev, port1, (warm ?
2275 USB_PORT_FEAT_BH_PORT_RESET :
2276 USB_PORT_FEAT_RESET));
2278 dev_err(hub->intfdev,
2279 "cannot %sreset port %d (err = %d)\n",
2280 warm ? "warm " : "", port1, status);
2282 status = hub_port_wait_reset(hub, port1, udev, delay,
2284 if (status && status != -ENOTCONN)
2285 dev_dbg(hub->intfdev,
2286 "port_wait_reset: err = %d\n",
2290 /* return on disconnect or reset */
2291 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2292 hub_port_finish_reset(hub, port1, udev, &status, warm);
2296 dev_dbg (hub->intfdev,
2297 "port %d not enabled, trying %sreset again...\n",
2298 port1, warm ? "warm " : "");
2299 delay = HUB_LONG_RESET_TIME;
2302 dev_err (hub->intfdev,
2303 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2308 up_read(&ehci_cf_port_reset_rwsem);
2313 /* Check if a port is power on */
2314 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2318 if (hub_is_superspeed(hub->hdev)) {
2319 if (portstatus & USB_SS_PORT_STAT_POWER)
2322 if (portstatus & USB_PORT_STAT_POWER)
2331 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2332 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2336 if (hub_is_superspeed(hub->hdev)) {
2337 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2338 == USB_SS_PORT_LS_U3)
2341 if (portstatus & USB_PORT_STAT_SUSPEND)
2348 /* Determine whether the device on a port is ready for a normal resume,
2349 * is ready for a reset-resume, or should be disconnected.
2351 static int check_port_resume_type(struct usb_device *udev,
2352 struct usb_hub *hub, int port1,
2353 int status, unsigned portchange, unsigned portstatus)
2355 /* Is the device still present? */
2356 if (status || port_is_suspended(hub, portstatus) ||
2357 !port_is_power_on(hub, portstatus) ||
2358 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2363 /* Can't do a normal resume if the port isn't enabled,
2364 * so try a reset-resume instead.
2366 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2367 if (udev->persist_enabled)
2368 udev->reset_resume = 1;
2374 dev_dbg(hub->intfdev,
2375 "port %d status %04x.%04x after resume, %d\n",
2376 port1, portchange, portstatus, status);
2377 } else if (udev->reset_resume) {
2379 /* Late port handoff can set status-change bits */
2380 if (portchange & USB_PORT_STAT_C_CONNECTION)
2381 clear_port_feature(hub->hdev, port1,
2382 USB_PORT_FEAT_C_CONNECTION);
2383 if (portchange & USB_PORT_STAT_C_ENABLE)
2384 clear_port_feature(hub->hdev, port1,
2385 USB_PORT_FEAT_C_ENABLE);
2391 #ifdef CONFIG_USB_SUSPEND
2394 * usb_port_suspend - suspend a usb device's upstream port
2395 * @udev: device that's no longer in active use, not a root hub
2396 * Context: must be able to sleep; device not locked; pm locks held
2398 * Suspends a USB device that isn't in active use, conserving power.
2399 * Devices may wake out of a suspend, if anything important happens,
2400 * using the remote wakeup mechanism. They may also be taken out of
2401 * suspend by the host, using usb_port_resume(). It's also routine
2402 * to disconnect devices while they are suspended.
2404 * This only affects the USB hardware for a device; its interfaces
2405 * (and, for hubs, child devices) must already have been suspended.
2407 * Selective port suspend reduces power; most suspended devices draw
2408 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2409 * All devices below the suspended port are also suspended.
2411 * Devices leave suspend state when the host wakes them up. Some devices
2412 * also support "remote wakeup", where the device can activate the USB
2413 * tree above them to deliver data, such as a keypress or packet. In
2414 * some cases, this wakes the USB host.
2416 * Suspending OTG devices may trigger HNP, if that's been enabled
2417 * between a pair of dual-role devices. That will change roles, such
2418 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2420 * Devices on USB hub ports have only one "suspend" state, corresponding
2421 * to ACPI D2, "may cause the device to lose some context".
2422 * State transitions include:
2424 * - suspend, resume ... when the VBUS power link stays live
2425 * - suspend, disconnect ... VBUS lost
2427 * Once VBUS drop breaks the circuit, the port it's using has to go through
2428 * normal re-enumeration procedures, starting with enabling VBUS power.
2429 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2430 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2431 * timer, no SRP, no requests through sysfs.
2433 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2434 * the root hub for their bus goes into global suspend ... so we don't
2435 * (falsely) update the device power state to say it suspended.
2437 * Returns 0 on success, else negative errno.
2439 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2441 struct usb_hub *hub = hdev_to_hub(udev->parent);
2442 int port1 = udev->portnum;
2445 /* enable remote wakeup when appropriate; this lets the device
2446 * wake up the upstream hub (including maybe the root hub).
2448 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2449 * we don't explicitly enable it here.
2451 if (udev->do_remote_wakeup) {
2452 if (!hub_is_superspeed(hub->hdev)) {
2453 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2454 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2455 USB_DEVICE_REMOTE_WAKEUP, 0,
2457 USB_CTRL_SET_TIMEOUT);
2459 /* Assume there's only one function on the USB 3.0
2460 * device and enable remote wake for the first
2461 * interface. FIXME if the interface association
2462 * descriptor shows there's more than one function.
2464 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2465 USB_REQ_SET_FEATURE,
2466 USB_RECIP_INTERFACE,
2467 USB_INTRF_FUNC_SUSPEND,
2468 USB_INTRF_FUNC_SUSPEND_RW |
2469 USB_INTRF_FUNC_SUSPEND_LP,
2471 USB_CTRL_SET_TIMEOUT);
2474 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2476 /* bail if autosuspend is requested */
2477 if (PMSG_IS_AUTO(msg))
2482 /* disable USB2 hardware LPM */
2483 if (udev->usb2_hw_lpm_enabled == 1)
2484 usb_set_usb2_hardware_lpm(udev, 0);
2487 if (hub_is_superspeed(hub->hdev))
2488 status = set_port_feature(hub->hdev,
2489 port1 | (USB_SS_PORT_LS_U3 << 3),
2490 USB_PORT_FEAT_LINK_STATE);
2492 status = set_port_feature(hub->hdev, port1,
2493 USB_PORT_FEAT_SUSPEND);
2495 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2497 /* paranoia: "should not happen" */
2498 if (udev->do_remote_wakeup)
2499 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2500 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2501 USB_DEVICE_REMOTE_WAKEUP, 0,
2503 USB_CTRL_SET_TIMEOUT);
2505 /* System sleep transitions should never fail */
2506 if (!PMSG_IS_AUTO(msg))
2509 /* device has up to 10 msec to fully suspend */
2510 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2511 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2512 udev->do_remote_wakeup);
2513 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2516 usb_mark_last_busy(hub->hdev);
2521 * If the USB "suspend" state is in use (rather than "global suspend"),
2522 * many devices will be individually taken out of suspend state using
2523 * special "resume" signaling. This routine kicks in shortly after
2524 * hardware resume signaling is finished, either because of selective
2525 * resume (by host) or remote wakeup (by device) ... now see what changed
2526 * in the tree that's rooted at this device.
2528 * If @udev->reset_resume is set then the device is reset before the
2529 * status check is done.
2531 static int finish_port_resume(struct usb_device *udev)
2536 /* caller owns the udev device lock */
2537 dev_dbg(&udev->dev, "%s\n",
2538 udev->reset_resume ? "finish reset-resume" : "finish resume");
2540 /* usb ch9 identifies four variants of SUSPENDED, based on what
2541 * state the device resumes to. Linux currently won't see the
2542 * first two on the host side; they'd be inside hub_port_init()
2543 * during many timeouts, but khubd can't suspend until later.
2545 usb_set_device_state(udev, udev->actconfig
2546 ? USB_STATE_CONFIGURED
2547 : USB_STATE_ADDRESS);
2549 /* 10.5.4.5 says not to reset a suspended port if the attached
2550 * device is enabled for remote wakeup. Hence the reset
2551 * operation is carried out here, after the port has been
2554 if (udev->reset_resume)
2556 status = usb_reset_and_verify_device(udev);
2558 /* 10.5.4.5 says be sure devices in the tree are still there.
2559 * For now let's assume the device didn't go crazy on resume,
2560 * and device drivers will know about any resume quirks.
2564 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2566 status = (status > 0 ? 0 : -ENODEV);
2568 /* If a normal resume failed, try doing a reset-resume */
2569 if (status && !udev->reset_resume && udev->persist_enabled) {
2570 dev_dbg(&udev->dev, "retry with reset-resume\n");
2571 udev->reset_resume = 1;
2572 goto retry_reset_resume;
2577 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2579 } else if (udev->actconfig) {
2580 le16_to_cpus(&devstatus);
2581 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2582 status = usb_control_msg(udev,
2583 usb_sndctrlpipe(udev, 0),
2584 USB_REQ_CLEAR_FEATURE,
2586 USB_DEVICE_REMOTE_WAKEUP, 0,
2588 USB_CTRL_SET_TIMEOUT);
2591 "disable remote wakeup, status %d\n",
2600 * usb_port_resume - re-activate a suspended usb device's upstream port
2601 * @udev: device to re-activate, not a root hub
2602 * Context: must be able to sleep; device not locked; pm locks held
2604 * This will re-activate the suspended device, increasing power usage
2605 * while letting drivers communicate again with its endpoints.
2606 * USB resume explicitly guarantees that the power session between
2607 * the host and the device is the same as it was when the device
2610 * If @udev->reset_resume is set then this routine won't check that the
2611 * port is still enabled. Furthermore, finish_port_resume() above will
2612 * reset @udev. The end result is that a broken power session can be
2613 * recovered and @udev will appear to persist across a loss of VBUS power.
2615 * For example, if a host controller doesn't maintain VBUS suspend current
2616 * during a system sleep or is reset when the system wakes up, all the USB
2617 * power sessions below it will be broken. This is especially troublesome
2618 * for mass-storage devices containing mounted filesystems, since the
2619 * device will appear to have disconnected and all the memory mappings
2620 * to it will be lost. Using the USB_PERSIST facility, the device can be
2621 * made to appear as if it had not disconnected.
2623 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2624 * every effort to insure that the same device is present after the
2625 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2626 * quite possible for a device to remain unaltered but its media to be
2627 * changed. If the user replaces a flash memory card while the system is
2628 * asleep, he will have only himself to blame when the filesystem on the
2629 * new card is corrupted and the system crashes.
2631 * Returns 0 on success, else negative errno.
2633 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2635 struct usb_hub *hub = hdev_to_hub(udev->parent);
2636 int port1 = udev->portnum;
2638 u16 portchange, portstatus;
2640 /* Skip the initial Clear-Suspend step for a remote wakeup */
2641 status = hub_port_status(hub, port1, &portstatus, &portchange);
2642 if (status == 0 && !port_is_suspended(hub, portstatus))
2643 goto SuspendCleared;
2645 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2647 set_bit(port1, hub->busy_bits);
2649 /* see 7.1.7.7; affects power usage, but not budgeting */
2650 if (hub_is_superspeed(hub->hdev))
2651 status = set_port_feature(hub->hdev,
2652 port1 | (USB_SS_PORT_LS_U0 << 3),
2653 USB_PORT_FEAT_LINK_STATE);
2655 status = clear_port_feature(hub->hdev,
2656 port1, USB_PORT_FEAT_SUSPEND);
2658 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2661 /* drive resume for at least 20 msec */
2662 dev_dbg(&udev->dev, "usb %sresume\n",
2663 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2666 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2667 * stop resume signaling. Then finish the resume
2670 status = hub_port_status(hub, port1, &portstatus, &portchange);
2672 /* TRSMRCY = 10 msec */
2678 if (hub_is_superspeed(hub->hdev)) {
2679 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2680 clear_port_feature(hub->hdev, port1,
2681 USB_PORT_FEAT_C_PORT_LINK_STATE);
2683 if (portchange & USB_PORT_STAT_C_SUSPEND)
2684 clear_port_feature(hub->hdev, port1,
2685 USB_PORT_FEAT_C_SUSPEND);
2689 clear_bit(port1, hub->busy_bits);
2691 status = check_port_resume_type(udev,
2692 hub, port1, status, portchange, portstatus);
2694 status = finish_port_resume(udev);
2696 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2697 hub_port_logical_disconnect(hub, port1);
2699 /* Try to enable USB2 hardware LPM */
2700 if (udev->usb2_hw_lpm_capable == 1)
2701 usb_set_usb2_hardware_lpm(udev, 1);
2707 /* caller has locked udev */
2708 int usb_remote_wakeup(struct usb_device *udev)
2712 if (udev->state == USB_STATE_SUSPENDED) {
2713 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2714 status = usb_autoresume_device(udev);
2716 /* Let the drivers do their thing, then... */
2717 usb_autosuspend_device(udev);
2723 #else /* CONFIG_USB_SUSPEND */
2725 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2727 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2732 /* However we may need to do a reset-resume */
2734 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2736 struct usb_hub *hub = hdev_to_hub(udev->parent);
2737 int port1 = udev->portnum;
2739 u16 portchange, portstatus;
2741 status = hub_port_status(hub, port1, &portstatus, &portchange);
2742 status = check_port_resume_type(udev,
2743 hub, port1, status, portchange, portstatus);
2746 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2747 hub_port_logical_disconnect(hub, port1);
2748 } else if (udev->reset_resume) {
2749 dev_dbg(&udev->dev, "reset-resume\n");
2750 status = usb_reset_and_verify_device(udev);
2757 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2759 struct usb_hub *hub = usb_get_intfdata (intf);
2760 struct usb_device *hdev = hub->hdev;
2764 /* Warn if children aren't already suspended */
2765 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2766 struct usb_device *udev;
2768 udev = hdev->children [port1-1];
2769 if (udev && udev->can_submit) {
2770 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2771 if (PMSG_IS_AUTO(msg))
2775 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2776 /* Enable hub to send remote wakeup for all ports. */
2777 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2778 status = set_port_feature(hdev,
2780 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2781 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2782 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2783 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2787 dev_dbg(&intf->dev, "%s\n", __func__);
2789 /* stop khubd and related activity */
2790 hub_quiesce(hub, HUB_SUSPEND);
2794 static int hub_resume(struct usb_interface *intf)
2796 struct usb_hub *hub = usb_get_intfdata(intf);
2798 dev_dbg(&intf->dev, "%s\n", __func__);
2799 hub_activate(hub, HUB_RESUME);
2803 static int hub_reset_resume(struct usb_interface *intf)
2805 struct usb_hub *hub = usb_get_intfdata(intf);
2807 dev_dbg(&intf->dev, "%s\n", __func__);
2808 hub_activate(hub, HUB_RESET_RESUME);
2813 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2814 * @rhdev: struct usb_device for the root hub
2816 * The USB host controller driver calls this function when its root hub
2817 * is resumed and Vbus power has been interrupted or the controller
2818 * has been reset. The routine marks @rhdev as having lost power.
2819 * When the hub driver is resumed it will take notice and carry out
2820 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2821 * the others will be disconnected.
2823 void usb_root_hub_lost_power(struct usb_device *rhdev)
2825 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2826 rhdev->reset_resume = 1;
2828 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2830 #else /* CONFIG_PM */
2832 #define hub_suspend NULL
2833 #define hub_resume NULL
2834 #define hub_reset_resume NULL
2838 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2840 * Between connect detection and reset signaling there must be a delay
2841 * of 100ms at least for debounce and power-settling. The corresponding
2842 * timer shall restart whenever the downstream port detects a disconnect.
2844 * Apparently there are some bluetooth and irda-dongles and a number of
2845 * low-speed devices for which this debounce period may last over a second.
2846 * Not covered by the spec - but easy to deal with.
2848 * This implementation uses a 1500ms total debounce timeout; if the
2849 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2850 * every 25ms for transient disconnects. When the port status has been
2851 * unchanged for 100ms it returns the port status.
2853 static int hub_port_debounce(struct usb_hub *hub, int port1)
2856 int total_time, stable_time = 0;
2857 u16 portchange, portstatus;
2858 unsigned connection = 0xffff;
2860 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2861 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2865 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2866 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2867 stable_time += HUB_DEBOUNCE_STEP;
2868 if (stable_time >= HUB_DEBOUNCE_STABLE)
2872 connection = portstatus & USB_PORT_STAT_CONNECTION;
2875 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2876 clear_port_feature(hub->hdev, port1,
2877 USB_PORT_FEAT_C_CONNECTION);
2880 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2882 msleep(HUB_DEBOUNCE_STEP);
2885 dev_dbg (hub->intfdev,
2886 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2887 port1, total_time, stable_time, portstatus);
2889 if (stable_time < HUB_DEBOUNCE_STABLE)
2894 void usb_ep0_reinit(struct usb_device *udev)
2896 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2897 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2898 usb_enable_endpoint(udev, &udev->ep0, true);
2900 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2902 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2903 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2905 static int hub_set_address(struct usb_device *udev, int devnum)
2908 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2911 * The host controller will choose the device address,
2912 * instead of the core having chosen it earlier
2914 if (!hcd->driver->address_device && devnum <= 1)
2916 if (udev->state == USB_STATE_ADDRESS)
2918 if (udev->state != USB_STATE_DEFAULT)
2920 if (hcd->driver->address_device)
2921 retval = hcd->driver->address_device(hcd, udev);
2923 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2924 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2925 NULL, 0, USB_CTRL_SET_TIMEOUT);
2927 update_devnum(udev, devnum);
2928 /* Device now using proper address. */
2929 usb_set_device_state(udev, USB_STATE_ADDRESS);
2930 usb_ep0_reinit(udev);
2935 /* Reset device, (re)assign address, get device descriptor.
2936 * Device connection must be stable, no more debouncing needed.
2937 * Returns device in USB_STATE_ADDRESS, except on error.
2939 * If this is called for an already-existing device (as part of
2940 * usb_reset_and_verify_device), the caller must own the device lock. For a
2941 * newly detected device that is not accessible through any global
2942 * pointers, it's not necessary to lock the device.
2945 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2948 static DEFINE_MUTEX(usb_address0_mutex);
2950 struct usb_device *hdev = hub->hdev;
2951 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2953 unsigned delay = HUB_SHORT_RESET_TIME;
2954 enum usb_device_speed oldspeed = udev->speed;
2956 int devnum = udev->devnum;
2958 /* root hub ports have a slightly longer reset period
2959 * (from USB 2.0 spec, section 7.1.7.5)
2961 if (!hdev->parent) {
2962 delay = HUB_ROOT_RESET_TIME;
2963 if (port1 == hdev->bus->otg_port)
2964 hdev->bus->b_hnp_enable = 0;
2967 /* Some low speed devices have problems with the quick delay, so */
2968 /* be a bit pessimistic with those devices. RHbug #23670 */
2969 if (oldspeed == USB_SPEED_LOW)
2970 delay = HUB_LONG_RESET_TIME;
2972 mutex_lock(&usb_address0_mutex);
2974 /* Reset the device; full speed may morph to high speed */
2975 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2976 retval = hub_port_reset(hub, port1, udev, delay, false);
2977 if (retval < 0) /* error or disconnect */
2979 /* success, speed is known */
2983 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2984 dev_dbg(&udev->dev, "device reset changed speed!\n");
2987 oldspeed = udev->speed;
2989 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2990 * it's fixed size except for full speed devices.
2991 * For Wireless USB devices, ep0 max packet is always 512 (tho
2992 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2994 switch (udev->speed) {
2995 case USB_SPEED_SUPER:
2996 case USB_SPEED_WIRELESS: /* fixed at 512 */
2997 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2999 case USB_SPEED_HIGH: /* fixed at 64 */
3000 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3002 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3003 /* to determine the ep0 maxpacket size, try to read
3004 * the device descriptor to get bMaxPacketSize0 and
3005 * then correct our initial guess.
3007 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3009 case USB_SPEED_LOW: /* fixed at 8 */
3010 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3016 if (udev->speed == USB_SPEED_WIRELESS)
3017 speed = "variable speed Wireless";
3019 speed = usb_speed_string(udev->speed);
3021 if (udev->speed != USB_SPEED_SUPER)
3022 dev_info(&udev->dev,
3023 "%s %s USB device number %d using %s\n",
3024 (udev->config) ? "reset" : "new", speed,
3025 devnum, udev->bus->controller->driver->name);
3027 /* Set up TT records, if needed */
3029 udev->tt = hdev->tt;
3030 udev->ttport = hdev->ttport;
3031 } else if (udev->speed != USB_SPEED_HIGH
3032 && hdev->speed == USB_SPEED_HIGH) {
3034 dev_err(&udev->dev, "parent hub has no TT\n");
3038 udev->tt = &hub->tt;
3039 udev->ttport = port1;
3042 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3043 * Because device hardware and firmware is sometimes buggy in
3044 * this area, and this is how Linux has done it for ages.
3045 * Change it cautiously.
3047 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3048 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3049 * so it may help with some non-standards-compliant devices.
3050 * Otherwise we start with SET_ADDRESS and then try to read the
3051 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3054 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3055 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3056 struct usb_device_descriptor *buf;
3059 #define GET_DESCRIPTOR_BUFSIZE 64
3060 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3066 /* Retry on all errors; some devices are flakey.
3067 * 255 is for WUSB devices, we actually need to use
3068 * 512 (WUSB1.0[4.8.1]).
3070 for (j = 0; j < 3; ++j) {
3071 buf->bMaxPacketSize0 = 0;
3072 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3073 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3074 USB_DT_DEVICE << 8, 0,
3075 buf, GET_DESCRIPTOR_BUFSIZE,
3076 initial_descriptor_timeout);
3077 switch (buf->bMaxPacketSize0) {
3078 case 8: case 16: case 32: case 64: case 255:
3079 if (buf->bDescriptorType ==
3093 udev->descriptor.bMaxPacketSize0 =
3094 buf->bMaxPacketSize0;
3097 retval = hub_port_reset(hub, port1, udev, delay, false);
3098 if (retval < 0) /* error or disconnect */
3100 if (oldspeed != udev->speed) {
3102 "device reset changed speed!\n");
3108 "device descriptor read/64, error %d\n",
3113 #undef GET_DESCRIPTOR_BUFSIZE
3117 * If device is WUSB, we already assigned an
3118 * unauthorized address in the Connect Ack sequence;
3119 * authorization will assign the final address.
3121 if (udev->wusb == 0) {
3122 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3123 retval = hub_set_address(udev, devnum);
3130 "device not accepting address %d, error %d\n",
3134 if (udev->speed == USB_SPEED_SUPER) {
3135 devnum = udev->devnum;
3136 dev_info(&udev->dev,
3137 "%s SuperSpeed USB device number %d using %s\n",
3138 (udev->config) ? "reset" : "new",
3139 devnum, udev->bus->controller->driver->name);
3142 /* cope with hardware quirkiness:
3143 * - let SET_ADDRESS settle, some device hardware wants it
3144 * - read ep0 maxpacket even for high and low speed,
3147 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3151 retval = usb_get_device_descriptor(udev, 8);
3154 "device descriptor read/8, error %d\n",
3166 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3167 udev->speed == USB_SPEED_SUPER)
3170 i = udev->descriptor.bMaxPacketSize0;
3171 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3172 if (udev->speed == USB_SPEED_LOW ||
3173 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3174 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3178 if (udev->speed == USB_SPEED_FULL)
3179 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3181 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3182 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3183 usb_ep0_reinit(udev);
3186 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3187 if (retval < (signed)sizeof(udev->descriptor)) {
3188 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3195 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3196 retval = usb_get_bos_descriptor(udev);
3198 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3199 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3200 udev->lpm_capable = 1;
3205 /* notify HCD that we have a device connected and addressed */
3206 if (hcd->driver->update_device)
3207 hcd->driver->update_device(hcd, udev);
3210 hub_port_disable(hub, port1, 0);
3211 update_devnum(udev, devnum); /* for disconnect processing */
3213 mutex_unlock(&usb_address0_mutex);
3218 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3220 struct usb_qualifier_descriptor *qual;
3223 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3227 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3228 qual, sizeof *qual);
3229 if (status == sizeof *qual) {
3230 dev_info(&udev->dev, "not running at top speed; "
3231 "connect to a high speed hub\n");
3232 /* hub LEDs are probably harder to miss than syslog */
3233 if (hub->has_indicators) {
3234 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3235 schedule_delayed_work (&hub->leds, 0);
3242 hub_power_remaining (struct usb_hub *hub)
3244 struct usb_device *hdev = hub->hdev;
3248 if (!hub->limited_power)
3251 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3252 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3253 struct usb_device *udev = hdev->children[port1 - 1];
3259 /* Unconfigured devices may not use more than 100mA,
3260 * or 8mA for OTG ports */
3261 if (udev->actconfig)
3262 delta = udev->actconfig->desc.bMaxPower * 2;
3263 else if (port1 != udev->bus->otg_port || hdev->parent)
3267 if (delta > hub->mA_per_port)
3268 dev_warn(&udev->dev,
3269 "%dmA is over %umA budget for port %d!\n",
3270 delta, hub->mA_per_port, port1);
3273 if (remaining < 0) {
3274 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3281 /* Handle physical or logical connection change events.
3282 * This routine is called when:
3283 * a port connection-change occurs;
3284 * a port enable-change occurs (often caused by EMI);
3285 * usb_reset_and_verify_device() encounters changed descriptors (as from
3286 * a firmware download)
3287 * caller already locked the hub
3289 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3290 u16 portstatus, u16 portchange)
3292 struct usb_device *hdev = hub->hdev;
3293 struct device *hub_dev = hub->intfdev;
3294 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3295 unsigned wHubCharacteristics =
3296 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3297 struct usb_device *udev;
3301 "port %d, status %04x, change %04x, %s\n",
3302 port1, portstatus, portchange, portspeed(hub, portstatus));
3304 if (hub->has_indicators) {
3305 set_port_led(hub, port1, HUB_LED_AUTO);
3306 hub->indicator[port1-1] = INDICATOR_AUTO;
3309 #ifdef CONFIG_USB_OTG
3310 /* during HNP, don't repeat the debounce */
3311 if (hdev->bus->is_b_host)
3312 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3313 USB_PORT_STAT_C_ENABLE);
3316 /* Try to resuscitate an existing device */
3317 udev = hdev->children[port1-1];
3318 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3319 udev->state != USB_STATE_NOTATTACHED) {
3320 usb_lock_device(udev);
3321 if (portstatus & USB_PORT_STAT_ENABLE) {
3322 status = 0; /* Nothing to do */
3324 #ifdef CONFIG_USB_SUSPEND
3325 } else if (udev->state == USB_STATE_SUSPENDED &&
3326 udev->persist_enabled) {
3327 /* For a suspended device, treat this as a
3328 * remote wakeup event.
3330 status = usb_remote_wakeup(udev);
3334 status = -ENODEV; /* Don't resuscitate */
3336 usb_unlock_device(udev);
3339 clear_bit(port1, hub->change_bits);
3344 /* Disconnect any existing devices under this port */
3346 usb_disconnect(&hdev->children[port1-1]);
3347 clear_bit(port1, hub->change_bits);
3349 /* We can forget about a "removed" device when there's a physical
3350 * disconnect or the connect status changes.
3352 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3353 (portchange & USB_PORT_STAT_C_CONNECTION))
3354 clear_bit(port1, hub->removed_bits);
3356 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3357 USB_PORT_STAT_C_ENABLE)) {
3358 status = hub_port_debounce(hub, port1);
3360 if (printk_ratelimit())
3361 dev_err(hub_dev, "connect-debounce failed, "
3362 "port %d disabled\n", port1);
3363 portstatus &= ~USB_PORT_STAT_CONNECTION;
3365 portstatus = status;
3369 /* Return now if debouncing failed or nothing is connected or
3370 * the device was "removed".
3372 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3373 test_bit(port1, hub->removed_bits)) {
3375 /* maybe switch power back on (e.g. root hub was reset) */
3376 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3377 && !port_is_power_on(hub, portstatus))
3378 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3380 if (portstatus & USB_PORT_STAT_ENABLE)
3385 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3387 /* reallocate for each attempt, since references
3388 * to the previous one can escape in various ways
3390 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3393 "couldn't allocate port %d usb_device\n",
3398 usb_set_device_state(udev, USB_STATE_POWERED);
3399 udev->bus_mA = hub->mA_per_port;
3400 udev->level = hdev->level + 1;
3401 udev->wusb = hub_is_wusb(hub);
3403 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3404 if (hub_is_superspeed(hub->hdev))
3405 udev->speed = USB_SPEED_SUPER;
3407 udev->speed = USB_SPEED_UNKNOWN;
3409 choose_devnum(udev);
3410 if (udev->devnum <= 0) {
3411 status = -ENOTCONN; /* Don't retry */
3415 /* reset (non-USB 3.0 devices) and get descriptor */
3416 status = hub_port_init(hub, udev, port1, i);
3420 usb_detect_quirks(udev);
3421 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3424 /* consecutive bus-powered hubs aren't reliable; they can
3425 * violate the voltage drop budget. if the new child has
3426 * a "powered" LED, users should notice we didn't enable it
3427 * (without reading syslog), even without per-port LEDs
3430 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3431 && udev->bus_mA <= 100) {
3434 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3437 dev_dbg(&udev->dev, "get status %d ?\n", status);
3440 le16_to_cpus(&devstat);
3441 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3443 "can't connect bus-powered hub "
3445 if (hub->has_indicators) {
3446 hub->indicator[port1-1] =
3447 INDICATOR_AMBER_BLINK;
3448 schedule_delayed_work (&hub->leds, 0);
3450 status = -ENOTCONN; /* Don't retry */
3455 /* check for devices running slower than they could */
3456 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3457 && udev->speed == USB_SPEED_FULL
3458 && highspeed_hubs != 0)
3459 check_highspeed (hub, udev, port1);
3461 /* Store the parent's children[] pointer. At this point
3462 * udev becomes globally accessible, although presumably
3463 * no one will look at it until hdev is unlocked.
3467 /* We mustn't add new devices if the parent hub has
3468 * been disconnected; we would race with the
3469 * recursively_mark_NOTATTACHED() routine.
3471 spin_lock_irq(&device_state_lock);
3472 if (hdev->state == USB_STATE_NOTATTACHED)
3475 hdev->children[port1-1] = udev;
3476 spin_unlock_irq(&device_state_lock);
3478 /* Run it through the hoops (find a driver, etc) */
3480 status = usb_new_device(udev);
3482 spin_lock_irq(&device_state_lock);
3483 hdev->children[port1-1] = NULL;
3484 spin_unlock_irq(&device_state_lock);
3491 status = hub_power_remaining(hub);
3493 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3498 hub_port_disable(hub, port1, 1);
3500 usb_ep0_reinit(udev);
3501 release_devnum(udev);
3504 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3507 if (hub->hdev->parent ||
3508 !hcd->driver->port_handed_over ||
3509 !(hcd->driver->port_handed_over)(hcd, port1))
3510 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3514 hub_port_disable(hub, port1, 1);
3515 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3516 hcd->driver->relinquish_port(hcd, port1);
3519 /* Returns 1 if there was a remote wakeup and a connect status change. */
3520 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3521 u16 portstatus, u16 portchange)
3523 struct usb_device *hdev;
3524 struct usb_device *udev;
3525 int connect_change = 0;
3529 udev = hdev->children[port-1];
3530 if (!hub_is_superspeed(hdev)) {
3531 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3533 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3535 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3536 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3542 /* TRSMRCY = 10 msec */
3545 usb_lock_device(udev);
3546 ret = usb_remote_wakeup(udev);
3547 usb_unlock_device(udev);
3552 hub_port_disable(hub, port, 1);
3554 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3556 return connect_change;
3559 static void hub_events(void)
3561 struct list_head *tmp;
3562 struct usb_device *hdev;
3563 struct usb_interface *intf;
3564 struct usb_hub *hub;
3565 struct device *hub_dev;
3571 int connect_change, wakeup_change;
3574 * We restart the list every time to avoid a deadlock with
3575 * deleting hubs downstream from this one. This should be
3576 * safe since we delete the hub from the event list.
3577 * Not the most efficient, but avoids deadlocks.
3581 /* Grab the first entry at the beginning of the list */
3582 spin_lock_irq(&hub_event_lock);
3583 if (list_empty(&hub_event_list)) {
3584 spin_unlock_irq(&hub_event_lock);
3588 tmp = hub_event_list.next;
3591 hub = list_entry(tmp, struct usb_hub, event_list);
3592 kref_get(&hub->kref);
3593 spin_unlock_irq(&hub_event_lock);
3596 hub_dev = hub->intfdev;
3597 intf = to_usb_interface(hub_dev);
3598 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3599 hdev->state, hub->descriptor
3600 ? hub->descriptor->bNbrPorts
3602 /* NOTE: expects max 15 ports... */
3603 (u16) hub->change_bits[0],
3604 (u16) hub->event_bits[0]);
3606 /* Lock the device, then check to see if we were
3607 * disconnected while waiting for the lock to succeed. */
3608 usb_lock_device(hdev);
3609 if (unlikely(hub->disconnected))
3610 goto loop_disconnected;
3612 /* If the hub has died, clean up after it */
3613 if (hdev->state == USB_STATE_NOTATTACHED) {
3614 hub->error = -ENODEV;
3615 hub_quiesce(hub, HUB_DISCONNECT);
3620 ret = usb_autopm_get_interface(intf);
3622 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3626 /* If this is an inactive hub, do nothing */
3631 dev_dbg (hub_dev, "resetting for error %d\n",
3634 ret = usb_reset_device(hdev);
3637 "error resetting hub: %d\n", ret);
3645 /* deal with port status changes */
3646 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3647 if (test_bit(i, hub->busy_bits))
3649 connect_change = test_bit(i, hub->change_bits);
3650 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3651 if (!test_and_clear_bit(i, hub->event_bits) &&
3652 !connect_change && !wakeup_change)
3655 ret = hub_port_status(hub, i,
3656 &portstatus, &portchange);
3660 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3661 clear_port_feature(hdev, i,
3662 USB_PORT_FEAT_C_CONNECTION);
3666 if (portchange & USB_PORT_STAT_C_ENABLE) {
3667 if (!connect_change)
3669 "port %d enable change, "
3672 clear_port_feature(hdev, i,
3673 USB_PORT_FEAT_C_ENABLE);
3676 * EM interference sometimes causes badly
3677 * shielded USB devices to be shutdown by
3678 * the hub, this hack enables them again.
3679 * Works at least with mouse driver.
3681 if (!(portstatus & USB_PORT_STAT_ENABLE)
3683 && hdev->children[i-1]) {
3686 "disabled by hub (EMI?), "
3693 if (hub_handle_remote_wakeup(hub, i,
3694 portstatus, portchange))
3697 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3701 dev_dbg(hub_dev, "over-current change on port "
3703 clear_port_feature(hdev, i,
3704 USB_PORT_FEAT_C_OVER_CURRENT);
3705 msleep(100); /* Cool down */
3706 hub_power_on(hub, true);
3707 hub_port_status(hub, i, &status, &unused);
3708 if (status & USB_PORT_STAT_OVERCURRENT)
3709 dev_err(hub_dev, "over-current "
3710 "condition on port %d\n", i);
3713 if (portchange & USB_PORT_STAT_C_RESET) {
3715 "reset change on port %d\n",
3717 clear_port_feature(hdev, i,
3718 USB_PORT_FEAT_C_RESET);
3720 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3721 hub_is_superspeed(hub->hdev)) {
3723 "warm reset change on port %d\n",
3725 clear_port_feature(hdev, i,
3726 USB_PORT_FEAT_C_BH_PORT_RESET);
3728 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3729 clear_port_feature(hub->hdev, i,
3730 USB_PORT_FEAT_C_PORT_LINK_STATE);
3732 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3734 "config error on port %d\n",
3736 clear_port_feature(hub->hdev, i,
3737 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3740 /* Warm reset a USB3 protocol port if it's in
3741 * SS.Inactive state.
3743 if (hub_is_superspeed(hub->hdev) &&
3744 (portstatus & USB_PORT_STAT_LINK_STATE)
3745 == USB_SS_PORT_LS_SS_INACTIVE) {
3746 dev_dbg(hub_dev, "warm reset port %d\n", i);
3747 hub_port_reset(hub, i, NULL,
3748 HUB_BH_RESET_TIME, true);
3752 hub_port_connect_change(hub, i,
3753 portstatus, portchange);
3756 /* deal with hub status changes */
3757 if (test_and_clear_bit(0, hub->event_bits) == 0)
3759 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3760 dev_err (hub_dev, "get_hub_status failed\n");
3762 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3763 dev_dbg (hub_dev, "power change\n");
3764 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3765 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3766 /* FIXME: Is this always true? */
3767 hub->limited_power = 1;
3769 hub->limited_power = 0;
3771 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3775 dev_dbg(hub_dev, "over-current change\n");
3776 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3777 msleep(500); /* Cool down */
3778 hub_power_on(hub, true);
3779 hub_hub_status(hub, &status, &unused);
3780 if (status & HUB_STATUS_OVERCURRENT)
3781 dev_err(hub_dev, "over-current "
3787 /* Balance the usb_autopm_get_interface() above */
3788 usb_autopm_put_interface_no_suspend(intf);
3790 /* Balance the usb_autopm_get_interface_no_resume() in
3791 * kick_khubd() and allow autosuspend.
3793 usb_autopm_put_interface(intf);
3795 usb_unlock_device(hdev);
3796 kref_put(&hub->kref, hub_release);
3798 } /* end while (1) */
3801 static int hub_thread(void *__unused)
3803 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3804 * port handover. Otherwise it might see that a full-speed device
3805 * was gone before the EHCI controller had handed its port over to
3806 * the companion full-speed controller.
3812 wait_event_freezable(khubd_wait,
3813 !list_empty(&hub_event_list) ||
3814 kthread_should_stop());
3815 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3817 pr_debug("%s: khubd exiting\n", usbcore_name);
3821 static const struct usb_device_id hub_id_table[] = {
3822 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3823 .bDeviceClass = USB_CLASS_HUB},
3824 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3825 .bInterfaceClass = USB_CLASS_HUB},
3826 { } /* Terminating entry */
3829 MODULE_DEVICE_TABLE (usb, hub_id_table);
3831 static struct usb_driver hub_driver = {
3834 .disconnect = hub_disconnect,
3835 .suspend = hub_suspend,
3836 .resume = hub_resume,
3837 .reset_resume = hub_reset_resume,
3838 .pre_reset = hub_pre_reset,
3839 .post_reset = hub_post_reset,
3840 .unlocked_ioctl = hub_ioctl,
3841 .id_table = hub_id_table,
3842 .supports_autosuspend = 1,
3845 int usb_hub_init(void)
3847 if (usb_register(&hub_driver) < 0) {
3848 printk(KERN_ERR "%s: can't register hub driver\n",
3853 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3854 if (!IS_ERR(khubd_task))
3857 /* Fall through if kernel_thread failed */
3858 usb_deregister(&hub_driver);
3859 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3864 void usb_hub_cleanup(void)
3866 kthread_stop(khubd_task);
3869 * Hub resources are freed for us by usb_deregister. It calls
3870 * usb_driver_purge on every device which in turn calls that
3871 * devices disconnect function if it is using this driver.
3872 * The hub_disconnect function takes care of releasing the
3873 * individual hub resources. -greg
3875 usb_deregister(&hub_driver);
3876 } /* usb_hub_cleanup() */
3878 static int descriptors_changed(struct usb_device *udev,
3879 struct usb_device_descriptor *old_device_descriptor)
3883 unsigned serial_len = 0;
3885 unsigned old_length;
3889 if (memcmp(&udev->descriptor, old_device_descriptor,
3890 sizeof(*old_device_descriptor)) != 0)
3893 /* Since the idVendor, idProduct, and bcdDevice values in the
3894 * device descriptor haven't changed, we will assume the
3895 * Manufacturer and Product strings haven't changed either.
3896 * But the SerialNumber string could be different (e.g., a
3897 * different flash card of the same brand).
3900 serial_len = strlen(udev->serial) + 1;
3903 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3904 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3905 len = max(len, old_length);
3908 buf = kmalloc(len, GFP_NOIO);
3910 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3911 /* assume the worst */
3914 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3915 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3916 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3918 if (length != old_length) {
3919 dev_dbg(&udev->dev, "config index %d, error %d\n",
3924 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3926 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3928 ((struct usb_config_descriptor *) buf)->
3929 bConfigurationValue);
3935 if (!changed && serial_len) {
3936 length = usb_string(udev, udev->descriptor.iSerialNumber,
3938 if (length + 1 != serial_len) {
3939 dev_dbg(&udev->dev, "serial string error %d\n",
3942 } else if (memcmp(buf, udev->serial, length) != 0) {
3943 dev_dbg(&udev->dev, "serial string changed\n");
3953 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3954 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3956 * WARNING - don't use this routine to reset a composite device
3957 * (one with multiple interfaces owned by separate drivers)!
3958 * Use usb_reset_device() instead.
3960 * Do a port reset, reassign the device's address, and establish its
3961 * former operating configuration. If the reset fails, or the device's
3962 * descriptors change from their values before the reset, or the original
3963 * configuration and altsettings cannot be restored, a flag will be set
3964 * telling khubd to pretend the device has been disconnected and then
3965 * re-connected. All drivers will be unbound, and the device will be
3966 * re-enumerated and probed all over again.
3968 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3969 * flagged for logical disconnection, or some other negative error code
3970 * if the reset wasn't even attempted.
3972 * The caller must own the device lock. For example, it's safe to use
3973 * this from a driver probe() routine after downloading new firmware.
3974 * For calls that might not occur during probe(), drivers should lock
3975 * the device using usb_lock_device_for_reset().
3977 * Locking exception: This routine may also be called from within an
3978 * autoresume handler. Such usage won't conflict with other tasks
3979 * holding the device lock because these tasks should always call
3980 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3982 static int usb_reset_and_verify_device(struct usb_device *udev)
3984 struct usb_device *parent_hdev = udev->parent;
3985 struct usb_hub *parent_hub;
3986 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3987 struct usb_device_descriptor descriptor = udev->descriptor;
3989 int port1 = udev->portnum;
3991 if (udev->state == USB_STATE_NOTATTACHED ||
3992 udev->state == USB_STATE_SUSPENDED) {
3993 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3999 /* this requires hcd-specific logic; see ohci_restart() */
4000 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4003 parent_hub = hdev_to_hub(parent_hdev);
4005 set_bit(port1, parent_hub->busy_bits);
4006 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4008 /* ep0 maxpacket size may change; let the HCD know about it.
4009 * Other endpoints will be handled by re-enumeration. */
4010 usb_ep0_reinit(udev);
4011 ret = hub_port_init(parent_hub, udev, port1, i);
4012 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4015 clear_bit(port1, parent_hub->busy_bits);
4020 /* Device might have changed firmware (DFU or similar) */
4021 if (descriptors_changed(udev, &descriptor)) {
4022 dev_info(&udev->dev, "device firmware changed\n");
4023 udev->descriptor = descriptor; /* for disconnect() calls */
4027 /* Restore the device's previous configuration */
4028 if (!udev->actconfig)
4031 mutex_lock(hcd->bandwidth_mutex);
4032 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4034 dev_warn(&udev->dev,
4035 "Busted HC? Not enough HCD resources for "
4036 "old configuration.\n");
4037 mutex_unlock(hcd->bandwidth_mutex);
4040 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4041 USB_REQ_SET_CONFIGURATION, 0,
4042 udev->actconfig->desc.bConfigurationValue, 0,
4043 NULL, 0, USB_CTRL_SET_TIMEOUT);
4046 "can't restore configuration #%d (error=%d)\n",
4047 udev->actconfig->desc.bConfigurationValue, ret);
4048 mutex_unlock(hcd->bandwidth_mutex);
4051 mutex_unlock(hcd->bandwidth_mutex);
4052 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4054 /* Put interfaces back into the same altsettings as before.
4055 * Don't bother to send the Set-Interface request for interfaces
4056 * that were already in altsetting 0; besides being unnecessary,
4057 * many devices can't handle it. Instead just reset the host-side
4060 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4061 struct usb_host_config *config = udev->actconfig;
4062 struct usb_interface *intf = config->interface[i];
4063 struct usb_interface_descriptor *desc;
4065 desc = &intf->cur_altsetting->desc;
4066 if (desc->bAlternateSetting == 0) {
4067 usb_disable_interface(udev, intf, true);
4068 usb_enable_interface(udev, intf, true);
4071 /* Let the bandwidth allocation function know that this
4072 * device has been reset, and it will have to use
4073 * alternate setting 0 as the current alternate setting.
4075 intf->resetting_device = 1;
4076 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4077 desc->bAlternateSetting);
4078 intf->resetting_device = 0;
4081 dev_err(&udev->dev, "failed to restore interface %d "
4082 "altsetting %d (error=%d)\n",
4083 desc->bInterfaceNumber,
4084 desc->bAlternateSetting,
4094 hub_port_logical_disconnect(parent_hub, port1);
4099 * usb_reset_device - warn interface drivers and perform a USB port reset
4100 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4102 * Warns all drivers bound to registered interfaces (using their pre_reset
4103 * method), performs the port reset, and then lets the drivers know that
4104 * the reset is over (using their post_reset method).
4106 * Return value is the same as for usb_reset_and_verify_device().
4108 * The caller must own the device lock. For example, it's safe to use
4109 * this from a driver probe() routine after downloading new firmware.
4110 * For calls that might not occur during probe(), drivers should lock
4111 * the device using usb_lock_device_for_reset().
4113 * If an interface is currently being probed or disconnected, we assume
4114 * its driver knows how to handle resets. For all other interfaces,
4115 * if the driver doesn't have pre_reset and post_reset methods then
4116 * we attempt to unbind it and rebind afterward.
4118 int usb_reset_device(struct usb_device *udev)
4122 struct usb_host_config *config = udev->actconfig;
4124 if (udev->state == USB_STATE_NOTATTACHED ||
4125 udev->state == USB_STATE_SUSPENDED) {
4126 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4131 /* Prevent autosuspend during the reset */
4132 usb_autoresume_device(udev);
4135 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4136 struct usb_interface *cintf = config->interface[i];
4137 struct usb_driver *drv;
4140 if (cintf->dev.driver) {
4141 drv = to_usb_driver(cintf->dev.driver);
4142 if (drv->pre_reset && drv->post_reset)
4143 unbind = (drv->pre_reset)(cintf);
4144 else if (cintf->condition ==
4145 USB_INTERFACE_BOUND)
4148 usb_forced_unbind_intf(cintf);
4153 ret = usb_reset_and_verify_device(udev);
4156 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4157 struct usb_interface *cintf = config->interface[i];
4158 struct usb_driver *drv;
4159 int rebind = cintf->needs_binding;
4161 if (!rebind && cintf->dev.driver) {
4162 drv = to_usb_driver(cintf->dev.driver);
4163 if (drv->post_reset)
4164 rebind = (drv->post_reset)(cintf);
4165 else if (cintf->condition ==
4166 USB_INTERFACE_BOUND)
4169 if (ret == 0 && rebind)
4170 usb_rebind_intf(cintf);
4174 usb_autosuspend_device(udev);
4177 EXPORT_SYMBOL_GPL(usb_reset_device);
4181 * usb_queue_reset_device - Reset a USB device from an atomic context
4182 * @iface: USB interface belonging to the device to reset
4184 * This function can be used to reset a USB device from an atomic
4185 * context, where usb_reset_device() won't work (as it blocks).
4187 * Doing a reset via this method is functionally equivalent to calling
4188 * usb_reset_device(), except for the fact that it is delayed to a
4189 * workqueue. This means that any drivers bound to other interfaces
4190 * might be unbound, as well as users from usbfs in user space.
4194 * - Scheduling two resets at the same time from two different drivers
4195 * attached to two different interfaces of the same device is
4196 * possible; depending on how the driver attached to each interface
4197 * handles ->pre_reset(), the second reset might happen or not.
4199 * - If a driver is unbound and it had a pending reset, the reset will
4202 * - This function can be called during .probe() or .disconnect()
4203 * times. On return from .disconnect(), any pending resets will be
4206 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4209 * NOTE: We don't do any reference count tracking because it is not
4210 * needed. The lifecycle of the work_struct is tied to the
4211 * usb_interface. Before destroying the interface we cancel the
4212 * work_struct, so the fact that work_struct is queued and or
4213 * running means the interface (and thus, the device) exist and
4216 void usb_queue_reset_device(struct usb_interface *iface)
4218 schedule_work(&iface->reset_ws);
4220 EXPORT_SYMBOL_GPL(usb_queue_reset_device);