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 static int usb_device_supports_lpm(struct usb_device *udev)
182 /* USB 2.1 (and greater) devices indicate LPM support through
183 * their USB 2.0 Extended Capabilities BOS descriptor.
185 if (udev->speed == USB_SPEED_HIGH) {
186 if (udev->bos->ext_cap &&
188 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
195 /* USB 2.0 spec Section 11.24.4.5 */
196 static int get_hub_descriptor(struct usb_device *hdev, void *data)
201 if (hub_is_superspeed(hdev)) {
202 dtype = USB_DT_SS_HUB;
203 size = USB_DT_SS_HUB_SIZE;
206 size = sizeof(struct usb_hub_descriptor);
209 for (i = 0; i < 3; i++) {
210 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
211 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
212 dtype << 8, 0, data, size,
213 USB_CTRL_GET_TIMEOUT);
214 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
221 * USB 2.0 spec Section 11.24.2.1
223 static int clear_hub_feature(struct usb_device *hdev, int feature)
225 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
226 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
230 * USB 2.0 spec Section 11.24.2.2
232 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
234 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
235 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
240 * USB 2.0 spec Section 11.24.2.13
242 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
244 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
245 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
250 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
251 * for info about using port indicators
253 static void set_port_led(
259 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
260 USB_PORT_FEAT_INDICATOR);
262 dev_dbg (hub->intfdev,
263 "port %d indicator %s status %d\n",
265 ({ char *s; switch (selector) {
266 case HUB_LED_AMBER: s = "amber"; break;
267 case HUB_LED_GREEN: s = "green"; break;
268 case HUB_LED_OFF: s = "off"; break;
269 case HUB_LED_AUTO: s = "auto"; break;
270 default: s = "??"; break;
275 #define LED_CYCLE_PERIOD ((2*HZ)/3)
277 static void led_work (struct work_struct *work)
279 struct usb_hub *hub =
280 container_of(work, struct usb_hub, leds.work);
281 struct usb_device *hdev = hub->hdev;
283 unsigned changed = 0;
286 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
289 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
290 unsigned selector, mode;
292 /* 30%-50% duty cycle */
294 switch (hub->indicator[i]) {
296 case INDICATOR_CYCLE:
298 selector = HUB_LED_AUTO;
299 mode = INDICATOR_AUTO;
301 /* blinking green = sw attention */
302 case INDICATOR_GREEN_BLINK:
303 selector = HUB_LED_GREEN;
304 mode = INDICATOR_GREEN_BLINK_OFF;
306 case INDICATOR_GREEN_BLINK_OFF:
307 selector = HUB_LED_OFF;
308 mode = INDICATOR_GREEN_BLINK;
310 /* blinking amber = hw attention */
311 case INDICATOR_AMBER_BLINK:
312 selector = HUB_LED_AMBER;
313 mode = INDICATOR_AMBER_BLINK_OFF;
315 case INDICATOR_AMBER_BLINK_OFF:
316 selector = HUB_LED_OFF;
317 mode = INDICATOR_AMBER_BLINK;
319 /* blink green/amber = reserved */
320 case INDICATOR_ALT_BLINK:
321 selector = HUB_LED_GREEN;
322 mode = INDICATOR_ALT_BLINK_OFF;
324 case INDICATOR_ALT_BLINK_OFF:
325 selector = HUB_LED_AMBER;
326 mode = INDICATOR_ALT_BLINK;
331 if (selector != HUB_LED_AUTO)
333 set_port_led(hub, i + 1, selector);
334 hub->indicator[i] = mode;
336 if (!changed && blinkenlights) {
338 cursor %= hub->descriptor->bNbrPorts;
339 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
340 hub->indicator[cursor] = INDICATOR_CYCLE;
344 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
347 /* use a short timeout for hub/port status fetches */
348 #define USB_STS_TIMEOUT 1000
349 #define USB_STS_RETRIES 5
352 * USB 2.0 spec Section 11.24.2.6
354 static int get_hub_status(struct usb_device *hdev,
355 struct usb_hub_status *data)
357 int i, status = -ETIMEDOUT;
359 for (i = 0; i < USB_STS_RETRIES &&
360 (status == -ETIMEDOUT || status == -EPIPE); i++) {
361 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
362 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
363 data, sizeof(*data), USB_STS_TIMEOUT);
369 * USB 2.0 spec Section 11.24.2.7
371 static int get_port_status(struct usb_device *hdev, int port1,
372 struct usb_port_status *data)
374 int i, status = -ETIMEDOUT;
376 for (i = 0; i < USB_STS_RETRIES &&
377 (status == -ETIMEDOUT || status == -EPIPE); i++) {
378 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
379 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
380 data, sizeof(*data), USB_STS_TIMEOUT);
385 static int hub_port_status(struct usb_hub *hub, int port1,
386 u16 *status, u16 *change)
390 mutex_lock(&hub->status_mutex);
391 ret = get_port_status(hub->hdev, port1, &hub->status->port);
393 dev_err(hub->intfdev,
394 "%s failed (err = %d)\n", __func__, ret);
398 *status = le16_to_cpu(hub->status->port.wPortStatus);
399 *change = le16_to_cpu(hub->status->port.wPortChange);
403 mutex_unlock(&hub->status_mutex);
407 static void kick_khubd(struct usb_hub *hub)
411 spin_lock_irqsave(&hub_event_lock, flags);
412 if (!hub->disconnected && list_empty(&hub->event_list)) {
413 list_add_tail(&hub->event_list, &hub_event_list);
415 /* Suppress autosuspend until khubd runs */
416 usb_autopm_get_interface_no_resume(
417 to_usb_interface(hub->intfdev));
418 wake_up(&khubd_wait);
420 spin_unlock_irqrestore(&hub_event_lock, flags);
423 void usb_kick_khubd(struct usb_device *hdev)
425 struct usb_hub *hub = hdev_to_hub(hdev);
432 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
433 * Notification, which indicates it had initiated remote wakeup.
435 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
436 * device initiates resume, so the USB core will not receive notice of the
437 * resume through the normal hub interrupt URB.
439 void usb_wakeup_notification(struct usb_device *hdev,
440 unsigned int portnum)
447 hub = hdev_to_hub(hdev);
449 set_bit(portnum, hub->wakeup_bits);
453 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
455 /* completion function, fires on port status changes and various faults */
456 static void hub_irq(struct urb *urb)
458 struct usb_hub *hub = urb->context;
459 int status = urb->status;
464 case -ENOENT: /* synchronous unlink */
465 case -ECONNRESET: /* async unlink */
466 case -ESHUTDOWN: /* hardware going away */
469 default: /* presumably an error */
470 /* Cause a hub reset after 10 consecutive errors */
471 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
472 if ((++hub->nerrors < 10) || hub->error)
477 /* let khubd handle things */
478 case 0: /* we got data: port status changed */
480 for (i = 0; i < urb->actual_length; ++i)
481 bits |= ((unsigned long) ((*hub->buffer)[i]))
483 hub->event_bits[0] = bits;
489 /* Something happened, let khubd figure it out */
496 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
497 && status != -ENODEV && status != -EPERM)
498 dev_err (hub->intfdev, "resubmit --> %d\n", status);
501 /* USB 2.0 spec Section 11.24.2.3 */
503 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
505 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
506 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
511 * enumeration blocks khubd for a long time. we use keventd instead, since
512 * long blocking there is the exception, not the rule. accordingly, HCDs
513 * talking to TTs must queue control transfers (not just bulk and iso), so
514 * both can talk to the same hub concurrently.
516 static void hub_tt_work(struct work_struct *work)
518 struct usb_hub *hub =
519 container_of(work, struct usb_hub, tt.clear_work);
523 spin_lock_irqsave (&hub->tt.lock, flags);
524 while (--limit && !list_empty (&hub->tt.clear_list)) {
525 struct list_head *next;
526 struct usb_tt_clear *clear;
527 struct usb_device *hdev = hub->hdev;
528 const struct hc_driver *drv;
531 next = hub->tt.clear_list.next;
532 clear = list_entry (next, struct usb_tt_clear, clear_list);
533 list_del (&clear->clear_list);
535 /* drop lock so HCD can concurrently report other TT errors */
536 spin_unlock_irqrestore (&hub->tt.lock, flags);
537 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
540 "clear tt %d (%04x) error %d\n",
541 clear->tt, clear->devinfo, status);
543 /* Tell the HCD, even if the operation failed */
544 drv = clear->hcd->driver;
545 if (drv->clear_tt_buffer_complete)
546 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
549 spin_lock_irqsave(&hub->tt.lock, flags);
551 spin_unlock_irqrestore (&hub->tt.lock, flags);
555 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
556 * @urb: an URB associated with the failed or incomplete split transaction
558 * High speed HCDs use this to tell the hub driver that some split control or
559 * bulk transaction failed in a way that requires clearing internal state of
560 * a transaction translator. This is normally detected (and reported) from
563 * It may not be possible for that hub to handle additional full (or low)
564 * speed transactions until that state is fully cleared out.
566 int usb_hub_clear_tt_buffer(struct urb *urb)
568 struct usb_device *udev = urb->dev;
569 int pipe = urb->pipe;
570 struct usb_tt *tt = udev->tt;
572 struct usb_tt_clear *clear;
574 /* we've got to cope with an arbitrary number of pending TT clears,
575 * since each TT has "at least two" buffers that can need it (and
576 * there can be many TTs per hub). even if they're uncommon.
578 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
579 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
580 /* FIXME recover somehow ... RESET_TT? */
584 /* info that CLEAR_TT_BUFFER needs */
585 clear->tt = tt->multi ? udev->ttport : 1;
586 clear->devinfo = usb_pipeendpoint (pipe);
587 clear->devinfo |= udev->devnum << 4;
588 clear->devinfo |= usb_pipecontrol (pipe)
589 ? (USB_ENDPOINT_XFER_CONTROL << 11)
590 : (USB_ENDPOINT_XFER_BULK << 11);
591 if (usb_pipein (pipe))
592 clear->devinfo |= 1 << 15;
594 /* info for completion callback */
595 clear->hcd = bus_to_hcd(udev->bus);
598 /* tell keventd to clear state for this TT */
599 spin_lock_irqsave (&tt->lock, flags);
600 list_add_tail (&clear->clear_list, &tt->clear_list);
601 schedule_work(&tt->clear_work);
602 spin_unlock_irqrestore (&tt->lock, flags);
605 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
607 /* If do_delay is false, return the number of milliseconds the caller
610 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
613 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
615 u16 wHubCharacteristics =
616 le16_to_cpu(hub->descriptor->wHubCharacteristics);
618 /* Enable power on each port. Some hubs have reserved values
619 * of LPSM (> 2) in their descriptors, even though they are
620 * USB 2.0 hubs. Some hubs do not implement port-power switching
621 * but only emulate it. In all cases, the ports won't work
622 * unless we send these messages to the hub.
624 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
625 dev_dbg(hub->intfdev, "enabling power on all ports\n");
627 dev_dbg(hub->intfdev, "trying to enable port power on "
628 "non-switchable hub\n");
629 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
630 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
632 /* Wait at least 100 msec for power to become stable */
633 delay = max(pgood_delay, (unsigned) 100);
639 static int hub_hub_status(struct usb_hub *hub,
640 u16 *status, u16 *change)
644 mutex_lock(&hub->status_mutex);
645 ret = get_hub_status(hub->hdev, &hub->status->hub);
647 dev_err (hub->intfdev,
648 "%s failed (err = %d)\n", __func__, ret);
650 *status = le16_to_cpu(hub->status->hub.wHubStatus);
651 *change = le16_to_cpu(hub->status->hub.wHubChange);
654 mutex_unlock(&hub->status_mutex);
658 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
660 struct usb_device *hdev = hub->hdev;
663 if (hdev->children[port1-1] && set_state)
664 usb_set_device_state(hdev->children[port1-1],
665 USB_STATE_NOTATTACHED);
666 if (!hub->error && !hub_is_superspeed(hub->hdev))
667 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
669 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
675 * Disable a port and mark a logical connect-change event, so that some
676 * time later khubd will disconnect() any existing usb_device on the port
677 * and will re-enumerate if there actually is a device attached.
679 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
681 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
682 hub_port_disable(hub, port1, 1);
684 /* FIXME let caller ask to power down the port:
685 * - some devices won't enumerate without a VBUS power cycle
686 * - SRP saves power that way
687 * - ... new call, TBD ...
688 * That's easy if this hub can switch power per-port, and
689 * khubd reactivates the port later (timer, SRP, etc).
690 * Powerdown must be optional, because of reset/DFU.
693 set_bit(port1, hub->change_bits);
698 * usb_remove_device - disable a device's port on its parent hub
699 * @udev: device to be disabled and removed
700 * Context: @udev locked, must be able to sleep.
702 * After @udev's port has been disabled, khubd is notified and it will
703 * see that the device has been disconnected. When the device is
704 * physically unplugged and something is plugged in, the events will
705 * be received and processed normally.
707 int usb_remove_device(struct usb_device *udev)
710 struct usb_interface *intf;
712 if (!udev->parent) /* Can't remove a root hub */
714 hub = hdev_to_hub(udev->parent);
715 intf = to_usb_interface(hub->intfdev);
717 usb_autopm_get_interface(intf);
718 set_bit(udev->portnum, hub->removed_bits);
719 hub_port_logical_disconnect(hub, udev->portnum);
720 usb_autopm_put_interface(intf);
724 enum hub_activation_type {
725 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
726 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
729 static void hub_init_func2(struct work_struct *ws);
730 static void hub_init_func3(struct work_struct *ws);
732 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
734 struct usb_device *hdev = hub->hdev;
739 bool need_debounce_delay = false;
742 /* Continue a partial initialization */
743 if (type == HUB_INIT2)
745 if (type == HUB_INIT3)
748 /* The superspeed hub except for root hub has to use Hub Depth
749 * value as an offset into the route string to locate the bits
750 * it uses to determine the downstream port number. So hub driver
751 * should send a set hub depth request to superspeed hub after
752 * the superspeed hub is set configuration in initialization or
755 * After a resume, port power should still be on.
756 * For any other type of activation, turn it on.
758 if (type != HUB_RESUME) {
759 if (hdev->parent && hub_is_superspeed(hdev)) {
760 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
761 HUB_SET_DEPTH, USB_RT_HUB,
762 hdev->level - 1, 0, NULL, 0,
763 USB_CTRL_SET_TIMEOUT);
765 dev_err(hub->intfdev,
766 "set hub depth failed\n");
769 /* Speed up system boot by using a delayed_work for the
770 * hub's initial power-up delays. This is pretty awkward
771 * and the implementation looks like a home-brewed sort of
772 * setjmp/longjmp, but it saves at least 100 ms for each
773 * root hub (assuming usbcore is compiled into the kernel
774 * rather than as a module). It adds up.
776 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
777 * because for those activation types the ports have to be
778 * operational when we return. In theory this could be done
779 * for HUB_POST_RESET, but it's easier not to.
781 if (type == HUB_INIT) {
782 delay = hub_power_on(hub, false);
783 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
784 schedule_delayed_work(&hub->init_work,
785 msecs_to_jiffies(delay));
787 /* Suppress autosuspend until init is done */
788 usb_autopm_get_interface_no_resume(
789 to_usb_interface(hub->intfdev));
790 return; /* Continues at init2: below */
791 } else if (type == HUB_RESET_RESUME) {
792 /* The internal host controller state for the hub device
793 * may be gone after a host power loss on system resume.
794 * Update the device's info so the HW knows it's a hub.
796 hcd = bus_to_hcd(hdev->bus);
797 if (hcd->driver->update_hub_device) {
798 ret = hcd->driver->update_hub_device(hcd, hdev,
801 dev_err(hub->intfdev, "Host not "
802 "accepting hub info "
804 dev_err(hub->intfdev, "LS/FS devices "
805 "and hubs may not work "
806 "under this hub\n.");
809 hub_power_on(hub, true);
811 hub_power_on(hub, true);
816 /* Check each port and set hub->change_bits to let khubd know
817 * which ports need attention.
819 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
820 struct usb_device *udev = hdev->children[port1-1];
821 u16 portstatus, portchange;
823 portstatus = portchange = 0;
824 status = hub_port_status(hub, port1, &portstatus, &portchange);
825 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
826 dev_dbg(hub->intfdev,
827 "port %d: status %04x change %04x\n",
828 port1, portstatus, portchange);
830 /* After anything other than HUB_RESUME (i.e., initialization
831 * or any sort of reset), every port should be disabled.
832 * Unconnected ports should likewise be disabled (paranoia),
833 * and so should ports for which we have no usb_device.
835 if ((portstatus & USB_PORT_STAT_ENABLE) && (
836 type != HUB_RESUME ||
837 !(portstatus & USB_PORT_STAT_CONNECTION) ||
839 udev->state == USB_STATE_NOTATTACHED)) {
841 * USB3 protocol ports will automatically transition
842 * to Enabled state when detect an USB3.0 device attach.
843 * Do not disable USB3 protocol ports.
845 if (!hub_is_superspeed(hdev)) {
846 clear_port_feature(hdev, port1,
847 USB_PORT_FEAT_ENABLE);
848 portstatus &= ~USB_PORT_STAT_ENABLE;
850 /* Pretend that power was lost for USB3 devs */
851 portstatus &= ~USB_PORT_STAT_ENABLE;
855 /* Clear status-change flags; we'll debounce later */
856 if (portchange & USB_PORT_STAT_C_CONNECTION) {
857 need_debounce_delay = true;
858 clear_port_feature(hub->hdev, port1,
859 USB_PORT_FEAT_C_CONNECTION);
861 if (portchange & USB_PORT_STAT_C_ENABLE) {
862 need_debounce_delay = true;
863 clear_port_feature(hub->hdev, port1,
864 USB_PORT_FEAT_C_ENABLE);
866 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
867 hub_is_superspeed(hub->hdev)) {
868 need_debounce_delay = true;
869 clear_port_feature(hub->hdev, port1,
870 USB_PORT_FEAT_C_BH_PORT_RESET);
872 /* We can forget about a "removed" device when there's a
873 * physical disconnect or the connect status changes.
875 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
876 (portchange & USB_PORT_STAT_C_CONNECTION))
877 clear_bit(port1, hub->removed_bits);
879 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
880 /* Tell khubd to disconnect the device or
881 * check for a new connection
883 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
884 set_bit(port1, hub->change_bits);
886 } else if (portstatus & USB_PORT_STAT_ENABLE) {
887 bool port_resumed = (portstatus &
888 USB_PORT_STAT_LINK_STATE) ==
890 /* The power session apparently survived the resume.
891 * If there was an overcurrent or suspend change
892 * (i.e., remote wakeup request), have khubd
893 * take care of it. Look at the port link state
894 * for USB 3.0 hubs, since they don't have a suspend
895 * change bit, and they don't set the port link change
896 * bit on device-initiated resume.
898 if (portchange || (hub_is_superspeed(hub->hdev) &&
900 set_bit(port1, hub->change_bits);
902 } else if (udev->persist_enabled) {
904 udev->reset_resume = 1;
906 set_bit(port1, hub->change_bits);
909 /* The power session is gone; tell khubd */
910 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
911 set_bit(port1, hub->change_bits);
915 /* If no port-status-change flags were set, we don't need any
916 * debouncing. If flags were set we can try to debounce the
917 * ports all at once right now, instead of letting khubd do them
918 * one at a time later on.
920 * If any port-status changes do occur during this delay, khubd
921 * will see them later and handle them normally.
923 if (need_debounce_delay) {
924 delay = HUB_DEBOUNCE_STABLE;
926 /* Don't do a long sleep inside a workqueue routine */
927 if (type == HUB_INIT2) {
928 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
929 schedule_delayed_work(&hub->init_work,
930 msecs_to_jiffies(delay));
931 return; /* Continues at init3: below */
939 status = usb_submit_urb(hub->urb, GFP_NOIO);
941 dev_err(hub->intfdev, "activate --> %d\n", status);
942 if (hub->has_indicators && blinkenlights)
943 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
945 /* Scan all ports that need attention */
948 /* Allow autosuspend if it was suppressed */
949 if (type <= HUB_INIT3)
950 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
953 /* Implement the continuations for the delays above */
954 static void hub_init_func2(struct work_struct *ws)
956 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
958 hub_activate(hub, HUB_INIT2);
961 static void hub_init_func3(struct work_struct *ws)
963 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
965 hub_activate(hub, HUB_INIT3);
968 enum hub_quiescing_type {
969 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
972 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
974 struct usb_device *hdev = hub->hdev;
977 cancel_delayed_work_sync(&hub->init_work);
979 /* khubd and related activity won't re-trigger */
982 if (type != HUB_SUSPEND) {
983 /* Disconnect all the children */
984 for (i = 0; i < hdev->maxchild; ++i) {
985 if (hdev->children[i])
986 usb_disconnect(&hdev->children[i]);
990 /* Stop khubd and related activity */
991 usb_kill_urb(hub->urb);
992 if (hub->has_indicators)
993 cancel_delayed_work_sync(&hub->leds);
995 cancel_work_sync(&hub->tt.clear_work);
998 /* caller has locked the hub device */
999 static int hub_pre_reset(struct usb_interface *intf)
1001 struct usb_hub *hub = usb_get_intfdata(intf);
1003 hub_quiesce(hub, HUB_PRE_RESET);
1007 /* caller has locked the hub device */
1008 static int hub_post_reset(struct usb_interface *intf)
1010 struct usb_hub *hub = usb_get_intfdata(intf);
1012 hub_activate(hub, HUB_POST_RESET);
1016 static int hub_configure(struct usb_hub *hub,
1017 struct usb_endpoint_descriptor *endpoint)
1019 struct usb_hcd *hcd;
1020 struct usb_device *hdev = hub->hdev;
1021 struct device *hub_dev = hub->intfdev;
1022 u16 hubstatus, hubchange;
1023 u16 wHubCharacteristics;
1026 char *message = "out of memory";
1028 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1034 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1039 mutex_init(&hub->status_mutex);
1041 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1042 if (!hub->descriptor) {
1047 /* Request the entire hub descriptor.
1048 * hub->descriptor can handle USB_MAXCHILDREN ports,
1049 * but the hub can/will return fewer bytes here.
1051 ret = get_hub_descriptor(hdev, hub->descriptor);
1053 message = "can't read hub descriptor";
1055 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1056 message = "hub has too many ports!";
1061 hdev->maxchild = hub->descriptor->bNbrPorts;
1062 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1063 (hdev->maxchild == 1) ? "" : "s");
1065 hdev->children = kzalloc(hdev->maxchild *
1066 sizeof(struct usb_device *), GFP_KERNEL);
1067 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1068 if (!hdev->children || !hub->port_owners) {
1073 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1075 /* FIXME for USB 3.0, skip for now */
1076 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1077 !(hub_is_superspeed(hdev))) {
1079 char portstr [USB_MAXCHILDREN + 1];
1081 for (i = 0; i < hdev->maxchild; i++)
1082 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1083 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1085 portstr[hdev->maxchild] = 0;
1086 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1088 dev_dbg(hub_dev, "standalone hub\n");
1090 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1091 case HUB_CHAR_COMMON_LPSM:
1092 dev_dbg(hub_dev, "ganged power switching\n");
1094 case HUB_CHAR_INDV_PORT_LPSM:
1095 dev_dbg(hub_dev, "individual port power switching\n");
1097 case HUB_CHAR_NO_LPSM:
1099 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1103 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1104 case HUB_CHAR_COMMON_OCPM:
1105 dev_dbg(hub_dev, "global over-current protection\n");
1107 case HUB_CHAR_INDV_PORT_OCPM:
1108 dev_dbg(hub_dev, "individual port over-current protection\n");
1110 case HUB_CHAR_NO_OCPM:
1112 dev_dbg(hub_dev, "no over-current protection\n");
1116 spin_lock_init (&hub->tt.lock);
1117 INIT_LIST_HEAD (&hub->tt.clear_list);
1118 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1119 switch (hdev->descriptor.bDeviceProtocol) {
1122 case USB_HUB_PR_HS_SINGLE_TT:
1123 dev_dbg(hub_dev, "Single TT\n");
1126 case USB_HUB_PR_HS_MULTI_TT:
1127 ret = usb_set_interface(hdev, 0, 1);
1129 dev_dbg(hub_dev, "TT per port\n");
1132 dev_err(hub_dev, "Using single TT (err %d)\n",
1137 /* USB 3.0 hubs don't have a TT */
1140 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1141 hdev->descriptor.bDeviceProtocol);
1145 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1146 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1147 case HUB_TTTT_8_BITS:
1148 if (hdev->descriptor.bDeviceProtocol != 0) {
1149 hub->tt.think_time = 666;
1150 dev_dbg(hub_dev, "TT requires at most %d "
1151 "FS bit times (%d ns)\n",
1152 8, hub->tt.think_time);
1155 case HUB_TTTT_16_BITS:
1156 hub->tt.think_time = 666 * 2;
1157 dev_dbg(hub_dev, "TT requires at most %d "
1158 "FS bit times (%d ns)\n",
1159 16, hub->tt.think_time);
1161 case HUB_TTTT_24_BITS:
1162 hub->tt.think_time = 666 * 3;
1163 dev_dbg(hub_dev, "TT requires at most %d "
1164 "FS bit times (%d ns)\n",
1165 24, hub->tt.think_time);
1167 case HUB_TTTT_32_BITS:
1168 hub->tt.think_time = 666 * 4;
1169 dev_dbg(hub_dev, "TT requires at most %d "
1170 "FS bit times (%d ns)\n",
1171 32, hub->tt.think_time);
1175 /* probe() zeroes hub->indicator[] */
1176 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1177 hub->has_indicators = 1;
1178 dev_dbg(hub_dev, "Port indicators are supported\n");
1181 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1182 hub->descriptor->bPwrOn2PwrGood * 2);
1184 /* power budgeting mostly matters with bus-powered hubs,
1185 * and battery-powered root hubs (may provide just 8 mA).
1187 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1189 message = "can't get hub status";
1192 le16_to_cpus(&hubstatus);
1193 if (hdev == hdev->bus->root_hub) {
1194 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1195 hub->mA_per_port = 500;
1197 hub->mA_per_port = hdev->bus_mA;
1198 hub->limited_power = 1;
1200 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1201 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1202 hub->descriptor->bHubContrCurrent);
1203 hub->limited_power = 1;
1204 if (hdev->maxchild > 0) {
1205 int remaining = hdev->bus_mA -
1206 hub->descriptor->bHubContrCurrent;
1208 if (remaining < hdev->maxchild * 100)
1210 "insufficient power available "
1211 "to use all downstream ports\n");
1212 hub->mA_per_port = 100; /* 7.2.1.1 */
1214 } else { /* Self-powered external hub */
1215 /* FIXME: What about battery-powered external hubs that
1216 * provide less current per port? */
1217 hub->mA_per_port = 500;
1219 if (hub->mA_per_port < 500)
1220 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1223 /* Update the HCD's internal representation of this hub before khubd
1224 * starts getting port status changes for devices under the hub.
1226 hcd = bus_to_hcd(hdev->bus);
1227 if (hcd->driver->update_hub_device) {
1228 ret = hcd->driver->update_hub_device(hcd, hdev,
1229 &hub->tt, GFP_KERNEL);
1231 message = "can't update HCD hub info";
1236 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1238 message = "can't get hub status";
1242 /* local power status reports aren't always correct */
1243 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1244 dev_dbg(hub_dev, "local power source is %s\n",
1245 (hubstatus & HUB_STATUS_LOCAL_POWER)
1246 ? "lost (inactive)" : "good");
1248 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1249 dev_dbg(hub_dev, "%sover-current condition exists\n",
1250 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1252 /* set up the interrupt endpoint
1253 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1254 * bytes as USB2.0[11.12.3] says because some hubs are known
1255 * to send more data (and thus cause overflow). For root hubs,
1256 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1257 * to be big enough for at least USB_MAXCHILDREN ports. */
1258 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1259 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1261 if (maxp > sizeof(*hub->buffer))
1262 maxp = sizeof(*hub->buffer);
1264 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1270 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1271 hub, endpoint->bInterval);
1273 /* maybe cycle the hub leds */
1274 if (hub->has_indicators && blinkenlights)
1275 hub->indicator [0] = INDICATOR_CYCLE;
1277 hub_activate(hub, HUB_INIT);
1281 dev_err (hub_dev, "config failed, %s (err %d)\n",
1283 /* hub_disconnect() frees urb and descriptor */
1287 static void hub_release(struct kref *kref)
1289 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1291 usb_put_intf(to_usb_interface(hub->intfdev));
1295 static unsigned highspeed_hubs;
1297 static void hub_disconnect(struct usb_interface *intf)
1299 struct usb_hub *hub = usb_get_intfdata(intf);
1300 struct usb_device *hdev = interface_to_usbdev(intf);
1302 /* Take the hub off the event list and don't let it be added again */
1303 spin_lock_irq(&hub_event_lock);
1304 if (!list_empty(&hub->event_list)) {
1305 list_del_init(&hub->event_list);
1306 usb_autopm_put_interface_no_suspend(intf);
1308 hub->disconnected = 1;
1309 spin_unlock_irq(&hub_event_lock);
1311 /* Disconnect all children and quiesce the hub */
1313 hub_quiesce(hub, HUB_DISCONNECT);
1315 usb_set_intfdata (intf, NULL);
1316 hub->hdev->maxchild = 0;
1318 if (hub->hdev->speed == USB_SPEED_HIGH)
1321 usb_free_urb(hub->urb);
1322 kfree(hdev->children);
1323 kfree(hub->port_owners);
1324 kfree(hub->descriptor);
1328 kref_put(&hub->kref, hub_release);
1331 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1333 struct usb_host_interface *desc;
1334 struct usb_endpoint_descriptor *endpoint;
1335 struct usb_device *hdev;
1336 struct usb_hub *hub;
1338 desc = intf->cur_altsetting;
1339 hdev = interface_to_usbdev(intf);
1341 /* Hubs have proper suspend/resume support. */
1342 usb_enable_autosuspend(hdev);
1344 if (hdev->level == MAX_TOPO_LEVEL) {
1346 "Unsupported bus topology: hub nested too deep\n");
1350 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1352 dev_warn(&intf->dev, "ignoring external hub\n");
1357 /* Some hubs have a subclass of 1, which AFAICT according to the */
1358 /* specs is not defined, but it works */
1359 if ((desc->desc.bInterfaceSubClass != 0) &&
1360 (desc->desc.bInterfaceSubClass != 1)) {
1362 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1366 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1367 if (desc->desc.bNumEndpoints != 1)
1368 goto descriptor_error;
1370 endpoint = &desc->endpoint[0].desc;
1372 /* If it's not an interrupt in endpoint, we'd better punt! */
1373 if (!usb_endpoint_is_int_in(endpoint))
1374 goto descriptor_error;
1376 /* We found a hub */
1377 dev_info (&intf->dev, "USB hub found\n");
1379 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1381 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1385 kref_init(&hub->kref);
1386 INIT_LIST_HEAD(&hub->event_list);
1387 hub->intfdev = &intf->dev;
1389 INIT_DELAYED_WORK(&hub->leds, led_work);
1390 INIT_DELAYED_WORK(&hub->init_work, NULL);
1393 usb_set_intfdata (intf, hub);
1394 intf->needs_remote_wakeup = 1;
1396 if (hdev->speed == USB_SPEED_HIGH)
1399 if (hub_configure(hub, endpoint) >= 0)
1402 hub_disconnect (intf);
1407 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1409 struct usb_device *hdev = interface_to_usbdev (intf);
1411 /* assert ifno == 0 (part of hub spec) */
1413 case USBDEVFS_HUB_PORTINFO: {
1414 struct usbdevfs_hub_portinfo *info = user_data;
1417 spin_lock_irq(&device_state_lock);
1418 if (hdev->devnum <= 0)
1421 info->nports = hdev->maxchild;
1422 for (i = 0; i < info->nports; i++) {
1423 if (hdev->children[i] == NULL)
1427 hdev->children[i]->devnum;
1430 spin_unlock_irq(&device_state_lock);
1432 return info->nports + 1;
1441 * Allow user programs to claim ports on a hub. When a device is attached
1442 * to one of these "claimed" ports, the program will "own" the device.
1444 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1447 if (hdev->state == USB_STATE_NOTATTACHED)
1449 if (port1 == 0 || port1 > hdev->maxchild)
1452 /* This assumes that devices not managed by the hub driver
1453 * will always have maxchild equal to 0.
1455 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1459 /* In the following three functions, the caller must hold hdev's lock */
1460 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1465 rc = find_port_owner(hdev, port1, &powner);
1474 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1479 rc = find_port_owner(hdev, port1, &powner);
1482 if (*powner != owner)
1488 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1493 n = find_port_owner(hdev, 1, &powner);
1495 for (; n < hdev->maxchild; (++n, ++powner)) {
1496 if (*powner == owner)
1502 /* The caller must hold udev's lock */
1503 bool usb_device_is_owned(struct usb_device *udev)
1505 struct usb_hub *hub;
1507 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1509 hub = hdev_to_hub(udev->parent);
1510 return !!hub->port_owners[udev->portnum - 1];
1514 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1518 for (i = 0; i < udev->maxchild; ++i) {
1519 if (udev->children[i])
1520 recursively_mark_NOTATTACHED(udev->children[i]);
1522 if (udev->state == USB_STATE_SUSPENDED)
1523 udev->active_duration -= jiffies;
1524 udev->state = USB_STATE_NOTATTACHED;
1528 * usb_set_device_state - change a device's current state (usbcore, hcds)
1529 * @udev: pointer to device whose state should be changed
1530 * @new_state: new state value to be stored
1532 * udev->state is _not_ fully protected by the device lock. Although
1533 * most transitions are made only while holding the lock, the state can
1534 * can change to USB_STATE_NOTATTACHED at almost any time. This
1535 * is so that devices can be marked as disconnected as soon as possible,
1536 * without having to wait for any semaphores to be released. As a result,
1537 * all changes to any device's state must be protected by the
1538 * device_state_lock spinlock.
1540 * Once a device has been added to the device tree, all changes to its state
1541 * should be made using this routine. The state should _not_ be set directly.
1543 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1544 * Otherwise udev->state is set to new_state, and if new_state is
1545 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1546 * to USB_STATE_NOTATTACHED.
1548 void usb_set_device_state(struct usb_device *udev,
1549 enum usb_device_state new_state)
1551 unsigned long flags;
1554 spin_lock_irqsave(&device_state_lock, flags);
1555 if (udev->state == USB_STATE_NOTATTACHED)
1557 else if (new_state != USB_STATE_NOTATTACHED) {
1559 /* root hub wakeup capabilities are managed out-of-band
1560 * and may involve silicon errata ... ignore them here.
1563 if (udev->state == USB_STATE_SUSPENDED
1564 || new_state == USB_STATE_SUSPENDED)
1565 ; /* No change to wakeup settings */
1566 else if (new_state == USB_STATE_CONFIGURED)
1567 wakeup = udev->actconfig->desc.bmAttributes
1568 & USB_CONFIG_ATT_WAKEUP;
1572 if (udev->state == USB_STATE_SUSPENDED &&
1573 new_state != USB_STATE_SUSPENDED)
1574 udev->active_duration -= jiffies;
1575 else if (new_state == USB_STATE_SUSPENDED &&
1576 udev->state != USB_STATE_SUSPENDED)
1577 udev->active_duration += jiffies;
1578 udev->state = new_state;
1580 recursively_mark_NOTATTACHED(udev);
1581 spin_unlock_irqrestore(&device_state_lock, flags);
1583 device_set_wakeup_capable(&udev->dev, wakeup);
1585 EXPORT_SYMBOL_GPL(usb_set_device_state);
1588 * Choose a device number.
1590 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1591 * USB-2.0 buses they are also used as device addresses, however on
1592 * USB-3.0 buses the address is assigned by the controller hardware
1593 * and it usually is not the same as the device number.
1595 * WUSB devices are simple: they have no hubs behind, so the mapping
1596 * device <-> virtual port number becomes 1:1. Why? to simplify the
1597 * life of the device connection logic in
1598 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1599 * handshake we need to assign a temporary address in the unauthorized
1600 * space. For simplicity we use the first virtual port number found to
1601 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1602 * and that becomes it's address [X < 128] or its unauthorized address
1605 * We add 1 as an offset to the one-based USB-stack port number
1606 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1607 * 0 is reserved by USB for default address; (b) Linux's USB stack
1608 * uses always #1 for the root hub of the controller. So USB stack's
1609 * port #1, which is wusb virtual-port #0 has address #2.
1611 * Devices connected under xHCI are not as simple. The host controller
1612 * supports virtualization, so the hardware assigns device addresses and
1613 * the HCD must setup data structures before issuing a set address
1614 * command to the hardware.
1616 static void choose_devnum(struct usb_device *udev)
1619 struct usb_bus *bus = udev->bus;
1621 /* If khubd ever becomes multithreaded, this will need a lock */
1623 devnum = udev->portnum + 1;
1624 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1626 /* Try to allocate the next devnum beginning at
1627 * bus->devnum_next. */
1628 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1631 devnum = find_next_zero_bit(bus->devmap.devicemap,
1633 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1636 set_bit(devnum, bus->devmap.devicemap);
1637 udev->devnum = devnum;
1641 static void release_devnum(struct usb_device *udev)
1643 if (udev->devnum > 0) {
1644 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1649 static void update_devnum(struct usb_device *udev, int devnum)
1651 /* The address for a WUSB device is managed by wusbcore. */
1653 udev->devnum = devnum;
1656 static void hub_free_dev(struct usb_device *udev)
1658 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1660 /* Root hubs aren't real devices, so don't free HCD resources */
1661 if (hcd->driver->free_dev && udev->parent)
1662 hcd->driver->free_dev(hcd, udev);
1666 * usb_disconnect - disconnect a device (usbcore-internal)
1667 * @pdev: pointer to device being disconnected
1668 * Context: !in_interrupt ()
1670 * Something got disconnected. Get rid of it and all of its children.
1672 * If *pdev is a normal device then the parent hub must already be locked.
1673 * If *pdev is a root hub then this routine will acquire the
1674 * usb_bus_list_lock on behalf of the caller.
1676 * Only hub drivers (including virtual root hub drivers for host
1677 * controllers) should ever call this.
1679 * This call is synchronous, and may not be used in an interrupt context.
1681 void usb_disconnect(struct usb_device **pdev)
1683 struct usb_device *udev = *pdev;
1686 /* mark the device as inactive, so any further urb submissions for
1687 * this device (and any of its children) will fail immediately.
1688 * this quiesces everything except pending urbs.
1690 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1691 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1694 usb_lock_device(udev);
1696 /* Free up all the children before we remove this device */
1697 for (i = 0; i < udev->maxchild; i++) {
1698 if (udev->children[i])
1699 usb_disconnect(&udev->children[i]);
1702 /* deallocate hcd/hardware state ... nuking all pending urbs and
1703 * cleaning up all state associated with the current configuration
1704 * so that the hardware is now fully quiesced.
1706 dev_dbg (&udev->dev, "unregistering device\n");
1707 usb_disable_device(udev, 0);
1708 usb_hcd_synchronize_unlinks(udev);
1710 usb_remove_ep_devs(&udev->ep0);
1711 usb_unlock_device(udev);
1713 /* Unregister the device. The device driver is responsible
1714 * for de-configuring the device and invoking the remove-device
1715 * notifier chain (used by usbfs and possibly others).
1717 device_del(&udev->dev);
1719 /* Free the device number and delete the parent's children[]
1720 * (or root_hub) pointer.
1722 release_devnum(udev);
1724 /* Avoid races with recursively_mark_NOTATTACHED() */
1725 spin_lock_irq(&device_state_lock);
1727 spin_unlock_irq(&device_state_lock);
1731 put_device(&udev->dev);
1734 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1735 static void show_string(struct usb_device *udev, char *id, char *string)
1739 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1742 static void announce_device(struct usb_device *udev)
1744 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1745 le16_to_cpu(udev->descriptor.idVendor),
1746 le16_to_cpu(udev->descriptor.idProduct));
1747 dev_info(&udev->dev,
1748 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1749 udev->descriptor.iManufacturer,
1750 udev->descriptor.iProduct,
1751 udev->descriptor.iSerialNumber);
1752 show_string(udev, "Product", udev->product);
1753 show_string(udev, "Manufacturer", udev->manufacturer);
1754 show_string(udev, "SerialNumber", udev->serial);
1757 static inline void announce_device(struct usb_device *udev) { }
1760 #ifdef CONFIG_USB_OTG
1761 #include "otg_whitelist.h"
1765 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1766 * @udev: newly addressed device (in ADDRESS state)
1768 * Finish enumeration for On-The-Go devices
1770 static int usb_enumerate_device_otg(struct usb_device *udev)
1774 #ifdef CONFIG_USB_OTG
1776 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1777 * to wake us after we've powered off VBUS; and HNP, switching roles
1778 * "host" to "peripheral". The OTG descriptor helps figure this out.
1780 if (!udev->bus->is_b_host
1782 && udev->parent == udev->bus->root_hub) {
1783 struct usb_otg_descriptor *desc = NULL;
1784 struct usb_bus *bus = udev->bus;
1786 /* descriptor may appear anywhere in config */
1787 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1788 le16_to_cpu(udev->config[0].desc.wTotalLength),
1789 USB_DT_OTG, (void **) &desc) == 0) {
1790 if (desc->bmAttributes & USB_OTG_HNP) {
1791 unsigned port1 = udev->portnum;
1793 dev_info(&udev->dev,
1794 "Dual-Role OTG device on %sHNP port\n",
1795 (port1 == bus->otg_port)
1798 /* enable HNP before suspend, it's simpler */
1799 if (port1 == bus->otg_port)
1800 bus->b_hnp_enable = 1;
1801 err = usb_control_msg(udev,
1802 usb_sndctrlpipe(udev, 0),
1803 USB_REQ_SET_FEATURE, 0,
1805 ? USB_DEVICE_B_HNP_ENABLE
1806 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1807 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1809 /* OTG MESSAGE: report errors here,
1810 * customize to match your product.
1812 dev_info(&udev->dev,
1813 "can't set HNP mode: %d\n",
1815 bus->b_hnp_enable = 0;
1821 if (!is_targeted(udev)) {
1823 /* Maybe it can talk to us, though we can't talk to it.
1824 * (Includes HNP test device.)
1826 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1827 err = usb_port_suspend(udev, PMSG_SUSPEND);
1829 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1841 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1842 * @udev: newly addressed device (in ADDRESS state)
1844 * This is only called by usb_new_device() and usb_authorize_device()
1845 * and FIXME -- all comments that apply to them apply here wrt to
1848 * If the device is WUSB and not authorized, we don't attempt to read
1849 * the string descriptors, as they will be errored out by the device
1850 * until it has been authorized.
1852 static int usb_enumerate_device(struct usb_device *udev)
1856 if (udev->config == NULL) {
1857 err = usb_get_configuration(udev);
1859 dev_err(&udev->dev, "can't read configurations, error %d\n",
1864 if (udev->wusb == 1 && udev->authorized == 0) {
1865 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1866 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1867 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1870 /* read the standard strings and cache them if present */
1871 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1872 udev->manufacturer = usb_cache_string(udev,
1873 udev->descriptor.iManufacturer);
1874 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1876 err = usb_enumerate_device_otg(udev);
1881 static void set_usb_port_removable(struct usb_device *udev)
1883 struct usb_device *hdev = udev->parent;
1884 struct usb_hub *hub;
1885 u8 port = udev->portnum;
1886 u16 wHubCharacteristics;
1887 bool removable = true;
1892 hub = hdev_to_hub(udev->parent);
1894 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1896 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1899 if (hub_is_superspeed(hdev)) {
1900 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1903 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1908 udev->removable = USB_DEVICE_REMOVABLE;
1910 udev->removable = USB_DEVICE_FIXED;
1914 * usb_new_device - perform initial device setup (usbcore-internal)
1915 * @udev: newly addressed device (in ADDRESS state)
1917 * This is called with devices which have been detected but not fully
1918 * enumerated. The device descriptor is available, but not descriptors
1919 * for any device configuration. The caller must have locked either
1920 * the parent hub (if udev is a normal device) or else the
1921 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1922 * udev has already been installed, but udev is not yet visible through
1923 * sysfs or other filesystem code.
1925 * It will return if the device is configured properly or not. Zero if
1926 * the interface was registered with the driver core; else a negative
1929 * This call is synchronous, and may not be used in an interrupt context.
1931 * Only the hub driver or root-hub registrar should ever call this.
1933 int usb_new_device(struct usb_device *udev)
1938 /* Initialize non-root-hub device wakeup to disabled;
1939 * device (un)configuration controls wakeup capable
1940 * sysfs power/wakeup controls wakeup enabled/disabled
1942 device_init_wakeup(&udev->dev, 0);
1945 /* Tell the runtime-PM framework the device is active */
1946 pm_runtime_set_active(&udev->dev);
1947 pm_runtime_get_noresume(&udev->dev);
1948 pm_runtime_use_autosuspend(&udev->dev);
1949 pm_runtime_enable(&udev->dev);
1951 /* By default, forbid autosuspend for all devices. It will be
1952 * allowed for hubs during binding.
1954 usb_disable_autosuspend(udev);
1956 err = usb_enumerate_device(udev); /* Read descriptors */
1959 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1960 udev->devnum, udev->bus->busnum,
1961 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1962 /* export the usbdev device-node for libusb */
1963 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1964 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1966 /* Tell the world! */
1967 announce_device(udev);
1969 device_enable_async_suspend(&udev->dev);
1972 * check whether the hub marks this port as non-removable. Do it
1973 * now so that platform-specific data can override it in
1977 set_usb_port_removable(udev);
1979 /* Register the device. The device driver is responsible
1980 * for configuring the device and invoking the add-device
1981 * notifier chain (used by usbfs and possibly others).
1983 err = device_add(&udev->dev);
1985 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1989 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1990 usb_mark_last_busy(udev);
1991 pm_runtime_put_sync_autosuspend(&udev->dev);
1995 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1996 pm_runtime_disable(&udev->dev);
1997 pm_runtime_set_suspended(&udev->dev);
2003 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2004 * @usb_dev: USB device
2006 * Move the USB device to a very basic state where interfaces are disabled
2007 * and the device is in fact unconfigured and unusable.
2009 * We share a lock (that we have) with device_del(), so we need to
2012 int usb_deauthorize_device(struct usb_device *usb_dev)
2014 usb_lock_device(usb_dev);
2015 if (usb_dev->authorized == 0)
2016 goto out_unauthorized;
2018 usb_dev->authorized = 0;
2019 usb_set_configuration(usb_dev, -1);
2021 kfree(usb_dev->product);
2022 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2023 kfree(usb_dev->manufacturer);
2024 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2025 kfree(usb_dev->serial);
2026 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2028 usb_destroy_configuration(usb_dev);
2029 usb_dev->descriptor.bNumConfigurations = 0;
2032 usb_unlock_device(usb_dev);
2037 int usb_authorize_device(struct usb_device *usb_dev)
2041 usb_lock_device(usb_dev);
2042 if (usb_dev->authorized == 1)
2043 goto out_authorized;
2045 result = usb_autoresume_device(usb_dev);
2047 dev_err(&usb_dev->dev,
2048 "can't autoresume for authorization: %d\n", result);
2049 goto error_autoresume;
2051 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2053 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2054 "authorization: %d\n", result);
2055 goto error_device_descriptor;
2058 kfree(usb_dev->product);
2059 usb_dev->product = NULL;
2060 kfree(usb_dev->manufacturer);
2061 usb_dev->manufacturer = NULL;
2062 kfree(usb_dev->serial);
2063 usb_dev->serial = NULL;
2065 usb_dev->authorized = 1;
2066 result = usb_enumerate_device(usb_dev);
2068 goto error_enumerate;
2069 /* Choose and set the configuration. This registers the interfaces
2070 * with the driver core and lets interface drivers bind to them.
2072 c = usb_choose_configuration(usb_dev);
2074 result = usb_set_configuration(usb_dev, c);
2076 dev_err(&usb_dev->dev,
2077 "can't set config #%d, error %d\n", c, result);
2078 /* This need not be fatal. The user can try to
2079 * set other configurations. */
2082 dev_info(&usb_dev->dev, "authorized to connect\n");
2085 error_device_descriptor:
2086 usb_autosuspend_device(usb_dev);
2089 usb_unlock_device(usb_dev); // complements locktree
2094 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2095 static unsigned hub_is_wusb(struct usb_hub *hub)
2097 struct usb_hcd *hcd;
2098 if (hub->hdev->parent != NULL) /* not a root hub? */
2100 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2101 return hcd->wireless;
2105 #define PORT_RESET_TRIES 5
2106 #define SET_ADDRESS_TRIES 2
2107 #define GET_DESCRIPTOR_TRIES 2
2108 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2109 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2111 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2112 #define HUB_SHORT_RESET_TIME 10
2113 #define HUB_BH_RESET_TIME 50
2114 #define HUB_LONG_RESET_TIME 200
2115 #define HUB_RESET_TIMEOUT 500
2117 static int hub_port_reset(struct usb_hub *hub, int port1,
2118 struct usb_device *udev, unsigned int delay, bool warm);
2120 /* Is a USB 3.0 port in the Inactive state? */
2121 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2123 return hub_is_superspeed(hub->hdev) &&
2124 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2125 USB_SS_PORT_LS_SS_INACTIVE;
2128 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2129 struct usb_device *udev, unsigned int delay, bool warm)
2131 int delay_time, ret;
2135 for (delay_time = 0;
2136 delay_time < HUB_RESET_TIMEOUT;
2137 delay_time += delay) {
2138 /* wait to give the device a chance to reset */
2141 /* read and decode port status */
2142 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2147 * Some buggy devices require a warm reset to be issued even
2148 * when the port appears not to be connected.
2152 * Some buggy devices can cause an NEC host controller
2153 * to transition to the "Error" state after a hot port
2154 * reset. This will show up as the port state in
2155 * "Inactive", and the port may also report a
2156 * disconnect. Forcing a warm port reset seems to make
2159 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2161 if (hub_port_inactive(hub, portstatus)) {
2164 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2165 clear_port_feature(hub->hdev, port1,
2166 USB_PORT_FEAT_C_CONNECTION);
2167 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2168 clear_port_feature(hub->hdev, port1,
2169 USB_PORT_FEAT_C_PORT_LINK_STATE);
2170 if (portchange & USB_PORT_STAT_C_RESET)
2171 clear_port_feature(hub->hdev, port1,
2172 USB_PORT_FEAT_C_RESET);
2173 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2175 ret = hub_port_reset(hub, port1,
2176 udev, HUB_BH_RESET_TIME,
2178 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2179 clear_port_feature(hub->hdev, port1,
2180 USB_PORT_FEAT_C_CONNECTION);
2183 /* Device went away? */
2184 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2187 /* bomb out completely if the connection bounced */
2188 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2191 /* if we`ve finished resetting, then break out of
2194 if (!(portstatus & USB_PORT_STAT_RESET) &&
2195 (portstatus & USB_PORT_STAT_ENABLE)) {
2196 if (hub_is_wusb(hub))
2197 udev->speed = USB_SPEED_WIRELESS;
2198 else if (hub_is_superspeed(hub->hdev))
2199 udev->speed = USB_SPEED_SUPER;
2200 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2201 udev->speed = USB_SPEED_HIGH;
2202 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2203 udev->speed = USB_SPEED_LOW;
2205 udev->speed = USB_SPEED_FULL;
2209 if (portchange & USB_PORT_STAT_C_BH_RESET)
2213 /* switch to the long delay after two short delay failures */
2214 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2215 delay = HUB_LONG_RESET_TIME;
2217 dev_dbg (hub->intfdev,
2218 "port %d not %sreset yet, waiting %dms\n",
2219 port1, warm ? "warm " : "", delay);
2225 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2226 struct usb_device *udev, int *status, bool warm)
2231 struct usb_hcd *hcd;
2232 /* TRSTRCY = 10 ms; plus some extra */
2234 update_devnum(udev, 0);
2235 hcd = bus_to_hcd(udev->bus);
2236 if (hcd->driver->reset_device) {
2237 *status = hcd->driver->reset_device(hcd, udev);
2239 dev_err(&udev->dev, "Cannot reset "
2240 "HCD device state\n");
2248 clear_port_feature(hub->hdev,
2249 port1, USB_PORT_FEAT_C_RESET);
2250 /* FIXME need disconnect() for NOTATTACHED device */
2252 clear_port_feature(hub->hdev, port1,
2253 USB_PORT_FEAT_C_BH_PORT_RESET);
2254 clear_port_feature(hub->hdev, port1,
2255 USB_PORT_FEAT_C_PORT_LINK_STATE);
2257 usb_set_device_state(udev, *status
2258 ? USB_STATE_NOTATTACHED
2259 : USB_STATE_DEFAULT);
2265 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2266 static int hub_port_reset(struct usb_hub *hub, int port1,
2267 struct usb_device *udev, unsigned int delay, bool warm)
2272 /* Block EHCI CF initialization during the port reset.
2273 * Some companion controllers don't like it when they mix.
2275 down_read(&ehci_cf_port_reset_rwsem);
2277 if (!hub_is_superspeed(hub->hdev)) {
2278 dev_err(hub->intfdev, "only USB3 hub support "
2284 /* Reset the port */
2285 for (i = 0; i < PORT_RESET_TRIES; i++) {
2286 status = set_port_feature(hub->hdev, port1, (warm ?
2287 USB_PORT_FEAT_BH_PORT_RESET :
2288 USB_PORT_FEAT_RESET));
2290 dev_err(hub->intfdev,
2291 "cannot %sreset port %d (err = %d)\n",
2292 warm ? "warm " : "", port1, status);
2294 status = hub_port_wait_reset(hub, port1, udev, delay,
2296 if (status && status != -ENOTCONN)
2297 dev_dbg(hub->intfdev,
2298 "port_wait_reset: err = %d\n",
2302 /* return on disconnect or reset */
2303 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2304 hub_port_finish_reset(hub, port1, udev, &status, warm);
2308 dev_dbg (hub->intfdev,
2309 "port %d not enabled, trying %sreset again...\n",
2310 port1, warm ? "warm " : "");
2311 delay = HUB_LONG_RESET_TIME;
2314 dev_err (hub->intfdev,
2315 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2320 up_read(&ehci_cf_port_reset_rwsem);
2325 /* Check if a port is power on */
2326 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2330 if (hub_is_superspeed(hub->hdev)) {
2331 if (portstatus & USB_SS_PORT_STAT_POWER)
2334 if (portstatus & USB_PORT_STAT_POWER)
2343 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2344 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2348 if (hub_is_superspeed(hub->hdev)) {
2349 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2350 == USB_SS_PORT_LS_U3)
2353 if (portstatus & USB_PORT_STAT_SUSPEND)
2360 /* Determine whether the device on a port is ready for a normal resume,
2361 * is ready for a reset-resume, or should be disconnected.
2363 static int check_port_resume_type(struct usb_device *udev,
2364 struct usb_hub *hub, int port1,
2365 int status, unsigned portchange, unsigned portstatus)
2367 /* Is the device still present? */
2368 if (status || port_is_suspended(hub, portstatus) ||
2369 !port_is_power_on(hub, portstatus) ||
2370 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2375 /* Can't do a normal resume if the port isn't enabled,
2376 * so try a reset-resume instead.
2378 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2379 if (udev->persist_enabled)
2380 udev->reset_resume = 1;
2386 dev_dbg(hub->intfdev,
2387 "port %d status %04x.%04x after resume, %d\n",
2388 port1, portchange, portstatus, status);
2389 } else if (udev->reset_resume) {
2391 /* Late port handoff can set status-change bits */
2392 if (portchange & USB_PORT_STAT_C_CONNECTION)
2393 clear_port_feature(hub->hdev, port1,
2394 USB_PORT_FEAT_C_CONNECTION);
2395 if (portchange & USB_PORT_STAT_C_ENABLE)
2396 clear_port_feature(hub->hdev, port1,
2397 USB_PORT_FEAT_C_ENABLE);
2403 #ifdef CONFIG_USB_SUSPEND
2406 * usb_port_suspend - suspend a usb device's upstream port
2407 * @udev: device that's no longer in active use, not a root hub
2408 * Context: must be able to sleep; device not locked; pm locks held
2410 * Suspends a USB device that isn't in active use, conserving power.
2411 * Devices may wake out of a suspend, if anything important happens,
2412 * using the remote wakeup mechanism. They may also be taken out of
2413 * suspend by the host, using usb_port_resume(). It's also routine
2414 * to disconnect devices while they are suspended.
2416 * This only affects the USB hardware for a device; its interfaces
2417 * (and, for hubs, child devices) must already have been suspended.
2419 * Selective port suspend reduces power; most suspended devices draw
2420 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2421 * All devices below the suspended port are also suspended.
2423 * Devices leave suspend state when the host wakes them up. Some devices
2424 * also support "remote wakeup", where the device can activate the USB
2425 * tree above them to deliver data, such as a keypress or packet. In
2426 * some cases, this wakes the USB host.
2428 * Suspending OTG devices may trigger HNP, if that's been enabled
2429 * between a pair of dual-role devices. That will change roles, such
2430 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2432 * Devices on USB hub ports have only one "suspend" state, corresponding
2433 * to ACPI D2, "may cause the device to lose some context".
2434 * State transitions include:
2436 * - suspend, resume ... when the VBUS power link stays live
2437 * - suspend, disconnect ... VBUS lost
2439 * Once VBUS drop breaks the circuit, the port it's using has to go through
2440 * normal re-enumeration procedures, starting with enabling VBUS power.
2441 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2442 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2443 * timer, no SRP, no requests through sysfs.
2445 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2446 * the root hub for their bus goes into global suspend ... so we don't
2447 * (falsely) update the device power state to say it suspended.
2449 * Returns 0 on success, else negative errno.
2451 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2453 struct usb_hub *hub = hdev_to_hub(udev->parent);
2454 int port1 = udev->portnum;
2457 /* enable remote wakeup when appropriate; this lets the device
2458 * wake up the upstream hub (including maybe the root hub).
2460 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2461 * we don't explicitly enable it here.
2463 if (udev->do_remote_wakeup) {
2464 if (!hub_is_superspeed(hub->hdev)) {
2465 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2466 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2467 USB_DEVICE_REMOTE_WAKEUP, 0,
2469 USB_CTRL_SET_TIMEOUT);
2471 /* Assume there's only one function on the USB 3.0
2472 * device and enable remote wake for the first
2473 * interface. FIXME if the interface association
2474 * descriptor shows there's more than one function.
2476 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2477 USB_REQ_SET_FEATURE,
2478 USB_RECIP_INTERFACE,
2479 USB_INTRF_FUNC_SUSPEND,
2480 USB_INTRF_FUNC_SUSPEND_RW |
2481 USB_INTRF_FUNC_SUSPEND_LP,
2483 USB_CTRL_SET_TIMEOUT);
2486 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2488 /* bail if autosuspend is requested */
2489 if (PMSG_IS_AUTO(msg))
2494 /* disable USB2 hardware LPM */
2495 if (udev->usb2_hw_lpm_enabled == 1)
2496 usb_set_usb2_hardware_lpm(udev, 0);
2499 if (hub_is_superspeed(hub->hdev))
2500 status = set_port_feature(hub->hdev,
2501 port1 | (USB_SS_PORT_LS_U3 << 3),
2502 USB_PORT_FEAT_LINK_STATE);
2504 status = set_port_feature(hub->hdev, port1,
2505 USB_PORT_FEAT_SUSPEND);
2507 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2509 /* paranoia: "should not happen" */
2510 if (udev->do_remote_wakeup)
2511 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2512 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2513 USB_DEVICE_REMOTE_WAKEUP, 0,
2515 USB_CTRL_SET_TIMEOUT);
2517 /* Try to enable USB2 hardware LPM again */
2518 if (udev->usb2_hw_lpm_capable == 1)
2519 usb_set_usb2_hardware_lpm(udev, 1);
2521 /* System sleep transitions should never fail */
2522 if (!PMSG_IS_AUTO(msg))
2525 /* device has up to 10 msec to fully suspend */
2526 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2527 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2528 udev->do_remote_wakeup);
2529 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2532 usb_mark_last_busy(hub->hdev);
2537 * If the USB "suspend" state is in use (rather than "global suspend"),
2538 * many devices will be individually taken out of suspend state using
2539 * special "resume" signaling. This routine kicks in shortly after
2540 * hardware resume signaling is finished, either because of selective
2541 * resume (by host) or remote wakeup (by device) ... now see what changed
2542 * in the tree that's rooted at this device.
2544 * If @udev->reset_resume is set then the device is reset before the
2545 * status check is done.
2547 static int finish_port_resume(struct usb_device *udev)
2552 /* caller owns the udev device lock */
2553 dev_dbg(&udev->dev, "%s\n",
2554 udev->reset_resume ? "finish reset-resume" : "finish resume");
2556 /* usb ch9 identifies four variants of SUSPENDED, based on what
2557 * state the device resumes to. Linux currently won't see the
2558 * first two on the host side; they'd be inside hub_port_init()
2559 * during many timeouts, but khubd can't suspend until later.
2561 usb_set_device_state(udev, udev->actconfig
2562 ? USB_STATE_CONFIGURED
2563 : USB_STATE_ADDRESS);
2565 /* 10.5.4.5 says not to reset a suspended port if the attached
2566 * device is enabled for remote wakeup. Hence the reset
2567 * operation is carried out here, after the port has been
2570 if (udev->reset_resume)
2572 status = usb_reset_and_verify_device(udev);
2574 /* 10.5.4.5 says be sure devices in the tree are still there.
2575 * For now let's assume the device didn't go crazy on resume,
2576 * and device drivers will know about any resume quirks.
2580 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2582 status = (status > 0 ? 0 : -ENODEV);
2584 /* If a normal resume failed, try doing a reset-resume */
2585 if (status && !udev->reset_resume && udev->persist_enabled) {
2586 dev_dbg(&udev->dev, "retry with reset-resume\n");
2587 udev->reset_resume = 1;
2588 goto retry_reset_resume;
2593 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2595 } else if (udev->actconfig) {
2596 le16_to_cpus(&devstatus);
2597 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2598 status = usb_control_msg(udev,
2599 usb_sndctrlpipe(udev, 0),
2600 USB_REQ_CLEAR_FEATURE,
2602 USB_DEVICE_REMOTE_WAKEUP, 0,
2604 USB_CTRL_SET_TIMEOUT);
2607 "disable remote wakeup, status %d\n",
2616 * usb_port_resume - re-activate a suspended usb device's upstream port
2617 * @udev: device to re-activate, not a root hub
2618 * Context: must be able to sleep; device not locked; pm locks held
2620 * This will re-activate the suspended device, increasing power usage
2621 * while letting drivers communicate again with its endpoints.
2622 * USB resume explicitly guarantees that the power session between
2623 * the host and the device is the same as it was when the device
2626 * If @udev->reset_resume is set then this routine won't check that the
2627 * port is still enabled. Furthermore, finish_port_resume() above will
2628 * reset @udev. The end result is that a broken power session can be
2629 * recovered and @udev will appear to persist across a loss of VBUS power.
2631 * For example, if a host controller doesn't maintain VBUS suspend current
2632 * during a system sleep or is reset when the system wakes up, all the USB
2633 * power sessions below it will be broken. This is especially troublesome
2634 * for mass-storage devices containing mounted filesystems, since the
2635 * device will appear to have disconnected and all the memory mappings
2636 * to it will be lost. Using the USB_PERSIST facility, the device can be
2637 * made to appear as if it had not disconnected.
2639 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2640 * every effort to insure that the same device is present after the
2641 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2642 * quite possible for a device to remain unaltered but its media to be
2643 * changed. If the user replaces a flash memory card while the system is
2644 * asleep, he will have only himself to blame when the filesystem on the
2645 * new card is corrupted and the system crashes.
2647 * Returns 0 on success, else negative errno.
2649 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2651 struct usb_hub *hub = hdev_to_hub(udev->parent);
2652 int port1 = udev->portnum;
2654 u16 portchange, portstatus;
2656 /* Skip the initial Clear-Suspend step for a remote wakeup */
2657 status = hub_port_status(hub, port1, &portstatus, &portchange);
2658 if (status == 0 && !port_is_suspended(hub, portstatus))
2659 goto SuspendCleared;
2661 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2663 set_bit(port1, hub->busy_bits);
2665 /* see 7.1.7.7; affects power usage, but not budgeting */
2666 if (hub_is_superspeed(hub->hdev))
2667 status = set_port_feature(hub->hdev,
2668 port1 | (USB_SS_PORT_LS_U0 << 3),
2669 USB_PORT_FEAT_LINK_STATE);
2671 status = clear_port_feature(hub->hdev,
2672 port1, USB_PORT_FEAT_SUSPEND);
2674 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2677 /* drive resume for at least 20 msec */
2678 dev_dbg(&udev->dev, "usb %sresume\n",
2679 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2682 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2683 * stop resume signaling. Then finish the resume
2686 status = hub_port_status(hub, port1, &portstatus, &portchange);
2688 /* TRSMRCY = 10 msec */
2694 if (hub_is_superspeed(hub->hdev)) {
2695 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2696 clear_port_feature(hub->hdev, port1,
2697 USB_PORT_FEAT_C_PORT_LINK_STATE);
2699 if (portchange & USB_PORT_STAT_C_SUSPEND)
2700 clear_port_feature(hub->hdev, port1,
2701 USB_PORT_FEAT_C_SUSPEND);
2705 clear_bit(port1, hub->busy_bits);
2707 status = check_port_resume_type(udev,
2708 hub, port1, status, portchange, portstatus);
2710 status = finish_port_resume(udev);
2712 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2713 hub_port_logical_disconnect(hub, port1);
2715 /* Try to enable USB2 hardware LPM */
2716 if (udev->usb2_hw_lpm_capable == 1)
2717 usb_set_usb2_hardware_lpm(udev, 1);
2723 /* caller has locked udev */
2724 int usb_remote_wakeup(struct usb_device *udev)
2728 if (udev->state == USB_STATE_SUSPENDED) {
2729 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2730 status = usb_autoresume_device(udev);
2732 /* Let the drivers do their thing, then... */
2733 usb_autosuspend_device(udev);
2739 #else /* CONFIG_USB_SUSPEND */
2741 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2743 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2748 /* However we may need to do a reset-resume */
2750 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2752 struct usb_hub *hub = hdev_to_hub(udev->parent);
2753 int port1 = udev->portnum;
2755 u16 portchange, portstatus;
2757 status = hub_port_status(hub, port1, &portstatus, &portchange);
2758 status = check_port_resume_type(udev,
2759 hub, port1, status, portchange, portstatus);
2762 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2763 hub_port_logical_disconnect(hub, port1);
2764 } else if (udev->reset_resume) {
2765 dev_dbg(&udev->dev, "reset-resume\n");
2766 status = usb_reset_and_verify_device(udev);
2773 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2775 struct usb_hub *hub = usb_get_intfdata (intf);
2776 struct usb_device *hdev = hub->hdev;
2780 /* Warn if children aren't already suspended */
2781 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2782 struct usb_device *udev;
2784 udev = hdev->children [port1-1];
2785 if (udev && udev->can_submit) {
2786 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2787 if (PMSG_IS_AUTO(msg))
2791 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2792 /* Enable hub to send remote wakeup for all ports. */
2793 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2794 status = set_port_feature(hdev,
2796 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2797 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2798 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2799 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2803 dev_dbg(&intf->dev, "%s\n", __func__);
2805 /* stop khubd and related activity */
2806 hub_quiesce(hub, HUB_SUSPEND);
2810 static int hub_resume(struct usb_interface *intf)
2812 struct usb_hub *hub = usb_get_intfdata(intf);
2814 dev_dbg(&intf->dev, "%s\n", __func__);
2815 hub_activate(hub, HUB_RESUME);
2819 static int hub_reset_resume(struct usb_interface *intf)
2821 struct usb_hub *hub = usb_get_intfdata(intf);
2823 dev_dbg(&intf->dev, "%s\n", __func__);
2824 hub_activate(hub, HUB_RESET_RESUME);
2829 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2830 * @rhdev: struct usb_device for the root hub
2832 * The USB host controller driver calls this function when its root hub
2833 * is resumed and Vbus power has been interrupted or the controller
2834 * has been reset. The routine marks @rhdev as having lost power.
2835 * When the hub driver is resumed it will take notice and carry out
2836 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2837 * the others will be disconnected.
2839 void usb_root_hub_lost_power(struct usb_device *rhdev)
2841 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2842 rhdev->reset_resume = 1;
2844 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2846 #else /* CONFIG_PM */
2848 #define hub_suspend NULL
2849 #define hub_resume NULL
2850 #define hub_reset_resume NULL
2854 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2856 * Between connect detection and reset signaling there must be a delay
2857 * of 100ms at least for debounce and power-settling. The corresponding
2858 * timer shall restart whenever the downstream port detects a disconnect.
2860 * Apparently there are some bluetooth and irda-dongles and a number of
2861 * low-speed devices for which this debounce period may last over a second.
2862 * Not covered by the spec - but easy to deal with.
2864 * This implementation uses a 1500ms total debounce timeout; if the
2865 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2866 * every 25ms for transient disconnects. When the port status has been
2867 * unchanged for 100ms it returns the port status.
2869 static int hub_port_debounce(struct usb_hub *hub, int port1)
2872 int total_time, stable_time = 0;
2873 u16 portchange, portstatus;
2874 unsigned connection = 0xffff;
2876 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2877 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2881 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2882 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2883 stable_time += HUB_DEBOUNCE_STEP;
2884 if (stable_time >= HUB_DEBOUNCE_STABLE)
2888 connection = portstatus & USB_PORT_STAT_CONNECTION;
2891 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2892 clear_port_feature(hub->hdev, port1,
2893 USB_PORT_FEAT_C_CONNECTION);
2896 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2898 msleep(HUB_DEBOUNCE_STEP);
2901 dev_dbg (hub->intfdev,
2902 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2903 port1, total_time, stable_time, portstatus);
2905 if (stable_time < HUB_DEBOUNCE_STABLE)
2910 void usb_ep0_reinit(struct usb_device *udev)
2912 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2913 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2914 usb_enable_endpoint(udev, &udev->ep0, true);
2916 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2918 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2919 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2921 static int hub_set_address(struct usb_device *udev, int devnum)
2924 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2927 * The host controller will choose the device address,
2928 * instead of the core having chosen it earlier
2930 if (!hcd->driver->address_device && devnum <= 1)
2932 if (udev->state == USB_STATE_ADDRESS)
2934 if (udev->state != USB_STATE_DEFAULT)
2936 if (hcd->driver->address_device)
2937 retval = hcd->driver->address_device(hcd, udev);
2939 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2940 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2941 NULL, 0, USB_CTRL_SET_TIMEOUT);
2943 update_devnum(udev, devnum);
2944 /* Device now using proper address. */
2945 usb_set_device_state(udev, USB_STATE_ADDRESS);
2946 usb_ep0_reinit(udev);
2951 /* Reset device, (re)assign address, get device descriptor.
2952 * Device connection must be stable, no more debouncing needed.
2953 * Returns device in USB_STATE_ADDRESS, except on error.
2955 * If this is called for an already-existing device (as part of
2956 * usb_reset_and_verify_device), the caller must own the device lock. For a
2957 * newly detected device that is not accessible through any global
2958 * pointers, it's not necessary to lock the device.
2961 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2964 static DEFINE_MUTEX(usb_address0_mutex);
2966 struct usb_device *hdev = hub->hdev;
2967 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2969 unsigned delay = HUB_SHORT_RESET_TIME;
2970 enum usb_device_speed oldspeed = udev->speed;
2972 int devnum = udev->devnum;
2974 /* root hub ports have a slightly longer reset period
2975 * (from USB 2.0 spec, section 7.1.7.5)
2977 if (!hdev->parent) {
2978 delay = HUB_ROOT_RESET_TIME;
2979 if (port1 == hdev->bus->otg_port)
2980 hdev->bus->b_hnp_enable = 0;
2983 /* Some low speed devices have problems with the quick delay, so */
2984 /* be a bit pessimistic with those devices. RHbug #23670 */
2985 if (oldspeed == USB_SPEED_LOW)
2986 delay = HUB_LONG_RESET_TIME;
2988 mutex_lock(&usb_address0_mutex);
2990 /* Reset the device; full speed may morph to high speed */
2991 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2992 retval = hub_port_reset(hub, port1, udev, delay, false);
2993 if (retval < 0) /* error or disconnect */
2995 /* success, speed is known */
2999 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3000 dev_dbg(&udev->dev, "device reset changed speed!\n");
3003 oldspeed = udev->speed;
3005 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3006 * it's fixed size except for full speed devices.
3007 * For Wireless USB devices, ep0 max packet is always 512 (tho
3008 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3010 switch (udev->speed) {
3011 case USB_SPEED_SUPER:
3012 case USB_SPEED_WIRELESS: /* fixed at 512 */
3013 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3015 case USB_SPEED_HIGH: /* fixed at 64 */
3016 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3018 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3019 /* to determine the ep0 maxpacket size, try to read
3020 * the device descriptor to get bMaxPacketSize0 and
3021 * then correct our initial guess.
3023 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3025 case USB_SPEED_LOW: /* fixed at 8 */
3026 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3032 if (udev->speed == USB_SPEED_WIRELESS)
3033 speed = "variable speed Wireless";
3035 speed = usb_speed_string(udev->speed);
3037 if (udev->speed != USB_SPEED_SUPER)
3038 dev_info(&udev->dev,
3039 "%s %s USB device number %d using %s\n",
3040 (udev->config) ? "reset" : "new", speed,
3041 devnum, udev->bus->controller->driver->name);
3043 /* Set up TT records, if needed */
3045 udev->tt = hdev->tt;
3046 udev->ttport = hdev->ttport;
3047 } else if (udev->speed != USB_SPEED_HIGH
3048 && hdev->speed == USB_SPEED_HIGH) {
3050 dev_err(&udev->dev, "parent hub has no TT\n");
3054 udev->tt = &hub->tt;
3055 udev->ttport = port1;
3058 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3059 * Because device hardware and firmware is sometimes buggy in
3060 * this area, and this is how Linux has done it for ages.
3061 * Change it cautiously.
3063 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3064 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3065 * so it may help with some non-standards-compliant devices.
3066 * Otherwise we start with SET_ADDRESS and then try to read the
3067 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3070 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3071 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3072 struct usb_device_descriptor *buf;
3075 #define GET_DESCRIPTOR_BUFSIZE 64
3076 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3082 /* Retry on all errors; some devices are flakey.
3083 * 255 is for WUSB devices, we actually need to use
3084 * 512 (WUSB1.0[4.8.1]).
3086 for (j = 0; j < 3; ++j) {
3087 buf->bMaxPacketSize0 = 0;
3088 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3089 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3090 USB_DT_DEVICE << 8, 0,
3091 buf, GET_DESCRIPTOR_BUFSIZE,
3092 initial_descriptor_timeout);
3093 switch (buf->bMaxPacketSize0) {
3094 case 8: case 16: case 32: case 64: case 255:
3095 if (buf->bDescriptorType ==
3109 udev->descriptor.bMaxPacketSize0 =
3110 buf->bMaxPacketSize0;
3113 retval = hub_port_reset(hub, port1, udev, delay, false);
3114 if (retval < 0) /* error or disconnect */
3116 if (oldspeed != udev->speed) {
3118 "device reset changed speed!\n");
3124 "device descriptor read/64, error %d\n",
3129 #undef GET_DESCRIPTOR_BUFSIZE
3133 * If device is WUSB, we already assigned an
3134 * unauthorized address in the Connect Ack sequence;
3135 * authorization will assign the final address.
3137 if (udev->wusb == 0) {
3138 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3139 retval = hub_set_address(udev, devnum);
3146 "device not accepting address %d, error %d\n",
3150 if (udev->speed == USB_SPEED_SUPER) {
3151 devnum = udev->devnum;
3152 dev_info(&udev->dev,
3153 "%s SuperSpeed USB device number %d using %s\n",
3154 (udev->config) ? "reset" : "new",
3155 devnum, udev->bus->controller->driver->name);
3158 /* cope with hardware quirkiness:
3159 * - let SET_ADDRESS settle, some device hardware wants it
3160 * - read ep0 maxpacket even for high and low speed,
3163 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3167 retval = usb_get_device_descriptor(udev, 8);
3170 "device descriptor read/8, error %d\n",
3183 * Some superspeed devices have finished the link training process
3184 * and attached to a superspeed hub port, but the device descriptor
3185 * got from those devices show they aren't superspeed devices. Warm
3186 * reset the port attached by the devices can fix them.
3188 if ((udev->speed == USB_SPEED_SUPER) &&
3189 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3190 dev_err(&udev->dev, "got a wrong device descriptor, "
3191 "warm reset device\n");
3192 hub_port_reset(hub, port1, udev,
3193 HUB_BH_RESET_TIME, true);
3198 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3199 udev->speed == USB_SPEED_SUPER)
3202 i = udev->descriptor.bMaxPacketSize0;
3203 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3204 if (udev->speed == USB_SPEED_LOW ||
3205 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3206 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3210 if (udev->speed == USB_SPEED_FULL)
3211 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3213 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3214 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3215 usb_ep0_reinit(udev);
3218 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3219 if (retval < (signed)sizeof(udev->descriptor)) {
3220 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3227 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3228 retval = usb_get_bos_descriptor(udev);
3230 udev->lpm_capable = usb_device_supports_lpm(udev);
3234 /* notify HCD that we have a device connected and addressed */
3235 if (hcd->driver->update_device)
3236 hcd->driver->update_device(hcd, udev);
3239 hub_port_disable(hub, port1, 0);
3240 update_devnum(udev, devnum); /* for disconnect processing */
3242 mutex_unlock(&usb_address0_mutex);
3247 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3249 struct usb_qualifier_descriptor *qual;
3252 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3256 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3257 qual, sizeof *qual);
3258 if (status == sizeof *qual) {
3259 dev_info(&udev->dev, "not running at top speed; "
3260 "connect to a high speed hub\n");
3261 /* hub LEDs are probably harder to miss than syslog */
3262 if (hub->has_indicators) {
3263 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3264 schedule_delayed_work (&hub->leds, 0);
3271 hub_power_remaining (struct usb_hub *hub)
3273 struct usb_device *hdev = hub->hdev;
3277 if (!hub->limited_power)
3280 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3281 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3282 struct usb_device *udev = hdev->children[port1 - 1];
3288 /* Unconfigured devices may not use more than 100mA,
3289 * or 8mA for OTG ports */
3290 if (udev->actconfig)
3291 delta = udev->actconfig->desc.bMaxPower * 2;
3292 else if (port1 != udev->bus->otg_port || hdev->parent)
3296 if (delta > hub->mA_per_port)
3297 dev_warn(&udev->dev,
3298 "%dmA is over %umA budget for port %d!\n",
3299 delta, hub->mA_per_port, port1);
3302 if (remaining < 0) {
3303 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3310 /* Handle physical or logical connection change events.
3311 * This routine is called when:
3312 * a port connection-change occurs;
3313 * a port enable-change occurs (often caused by EMI);
3314 * usb_reset_and_verify_device() encounters changed descriptors (as from
3315 * a firmware download)
3316 * caller already locked the hub
3318 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3319 u16 portstatus, u16 portchange)
3321 struct usb_device *hdev = hub->hdev;
3322 struct device *hub_dev = hub->intfdev;
3323 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3324 unsigned wHubCharacteristics =
3325 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3326 struct usb_device *udev;
3330 "port %d, status %04x, change %04x, %s\n",
3331 port1, portstatus, portchange, portspeed(hub, portstatus));
3333 if (hub->has_indicators) {
3334 set_port_led(hub, port1, HUB_LED_AUTO);
3335 hub->indicator[port1-1] = INDICATOR_AUTO;
3338 #ifdef CONFIG_USB_OTG
3339 /* during HNP, don't repeat the debounce */
3340 if (hdev->bus->is_b_host)
3341 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3342 USB_PORT_STAT_C_ENABLE);
3345 /* Try to resuscitate an existing device */
3346 udev = hdev->children[port1-1];
3347 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3348 udev->state != USB_STATE_NOTATTACHED) {
3349 usb_lock_device(udev);
3350 if (portstatus & USB_PORT_STAT_ENABLE) {
3351 status = 0; /* Nothing to do */
3353 #ifdef CONFIG_USB_SUSPEND
3354 } else if (udev->state == USB_STATE_SUSPENDED &&
3355 udev->persist_enabled) {
3356 /* For a suspended device, treat this as a
3357 * remote wakeup event.
3359 status = usb_remote_wakeup(udev);
3363 status = -ENODEV; /* Don't resuscitate */
3365 usb_unlock_device(udev);
3368 clear_bit(port1, hub->change_bits);
3373 /* Disconnect any existing devices under this port */
3375 usb_disconnect(&hdev->children[port1-1]);
3376 clear_bit(port1, hub->change_bits);
3378 /* We can forget about a "removed" device when there's a physical
3379 * disconnect or the connect status changes.
3381 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3382 (portchange & USB_PORT_STAT_C_CONNECTION))
3383 clear_bit(port1, hub->removed_bits);
3385 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3386 USB_PORT_STAT_C_ENABLE)) {
3387 status = hub_port_debounce(hub, port1);
3389 if (printk_ratelimit())
3390 dev_err(hub_dev, "connect-debounce failed, "
3391 "port %d disabled\n", port1);
3392 portstatus &= ~USB_PORT_STAT_CONNECTION;
3394 portstatus = status;
3398 /* Return now if debouncing failed or nothing is connected or
3399 * the device was "removed".
3401 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3402 test_bit(port1, hub->removed_bits)) {
3404 /* maybe switch power back on (e.g. root hub was reset) */
3405 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3406 && !port_is_power_on(hub, portstatus))
3407 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3409 if (portstatus & USB_PORT_STAT_ENABLE)
3414 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3416 /* reallocate for each attempt, since references
3417 * to the previous one can escape in various ways
3419 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3422 "couldn't allocate port %d usb_device\n",
3427 usb_set_device_state(udev, USB_STATE_POWERED);
3428 udev->bus_mA = hub->mA_per_port;
3429 udev->level = hdev->level + 1;
3430 udev->wusb = hub_is_wusb(hub);
3432 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3433 if (hub_is_superspeed(hub->hdev))
3434 udev->speed = USB_SPEED_SUPER;
3436 udev->speed = USB_SPEED_UNKNOWN;
3438 choose_devnum(udev);
3439 if (udev->devnum <= 0) {
3440 status = -ENOTCONN; /* Don't retry */
3444 /* reset (non-USB 3.0 devices) and get descriptor */
3445 status = hub_port_init(hub, udev, port1, i);
3449 usb_detect_quirks(udev);
3450 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3453 /* consecutive bus-powered hubs aren't reliable; they can
3454 * violate the voltage drop budget. if the new child has
3455 * a "powered" LED, users should notice we didn't enable it
3456 * (without reading syslog), even without per-port LEDs
3459 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3460 && udev->bus_mA <= 100) {
3463 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3466 dev_dbg(&udev->dev, "get status %d ?\n", status);
3469 le16_to_cpus(&devstat);
3470 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3472 "can't connect bus-powered hub "
3474 if (hub->has_indicators) {
3475 hub->indicator[port1-1] =
3476 INDICATOR_AMBER_BLINK;
3477 schedule_delayed_work (&hub->leds, 0);
3479 status = -ENOTCONN; /* Don't retry */
3484 /* check for devices running slower than they could */
3485 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3486 && udev->speed == USB_SPEED_FULL
3487 && highspeed_hubs != 0)
3488 check_highspeed (hub, udev, port1);
3490 /* Store the parent's children[] pointer. At this point
3491 * udev becomes globally accessible, although presumably
3492 * no one will look at it until hdev is unlocked.
3496 /* We mustn't add new devices if the parent hub has
3497 * been disconnected; we would race with the
3498 * recursively_mark_NOTATTACHED() routine.
3500 spin_lock_irq(&device_state_lock);
3501 if (hdev->state == USB_STATE_NOTATTACHED)
3504 hdev->children[port1-1] = udev;
3505 spin_unlock_irq(&device_state_lock);
3507 /* Run it through the hoops (find a driver, etc) */
3509 status = usb_new_device(udev);
3511 spin_lock_irq(&device_state_lock);
3512 hdev->children[port1-1] = NULL;
3513 spin_unlock_irq(&device_state_lock);
3520 status = hub_power_remaining(hub);
3522 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3527 hub_port_disable(hub, port1, 1);
3529 usb_ep0_reinit(udev);
3530 release_devnum(udev);
3533 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3536 if (hub->hdev->parent ||
3537 !hcd->driver->port_handed_over ||
3538 !(hcd->driver->port_handed_over)(hcd, port1))
3539 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3543 hub_port_disable(hub, port1, 1);
3544 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3545 hcd->driver->relinquish_port(hcd, port1);
3548 /* Returns 1 if there was a remote wakeup and a connect status change. */
3549 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3550 u16 portstatus, u16 portchange)
3552 struct usb_device *hdev;
3553 struct usb_device *udev;
3554 int connect_change = 0;
3558 udev = hdev->children[port-1];
3559 if (!hub_is_superspeed(hdev)) {
3560 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3562 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3564 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3565 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3571 /* TRSMRCY = 10 msec */
3574 usb_lock_device(udev);
3575 ret = usb_remote_wakeup(udev);
3576 usb_unlock_device(udev);
3581 hub_port_disable(hub, port, 1);
3583 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3585 return connect_change;
3588 static void hub_events(void)
3590 struct list_head *tmp;
3591 struct usb_device *hdev;
3592 struct usb_interface *intf;
3593 struct usb_hub *hub;
3594 struct device *hub_dev;
3600 int connect_change, wakeup_change;
3603 * We restart the list every time to avoid a deadlock with
3604 * deleting hubs downstream from this one. This should be
3605 * safe since we delete the hub from the event list.
3606 * Not the most efficient, but avoids deadlocks.
3610 /* Grab the first entry at the beginning of the list */
3611 spin_lock_irq(&hub_event_lock);
3612 if (list_empty(&hub_event_list)) {
3613 spin_unlock_irq(&hub_event_lock);
3617 tmp = hub_event_list.next;
3620 hub = list_entry(tmp, struct usb_hub, event_list);
3621 kref_get(&hub->kref);
3622 spin_unlock_irq(&hub_event_lock);
3625 hub_dev = hub->intfdev;
3626 intf = to_usb_interface(hub_dev);
3627 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3628 hdev->state, hub->descriptor
3629 ? hub->descriptor->bNbrPorts
3631 /* NOTE: expects max 15 ports... */
3632 (u16) hub->change_bits[0],
3633 (u16) hub->event_bits[0]);
3635 /* Lock the device, then check to see if we were
3636 * disconnected while waiting for the lock to succeed. */
3637 usb_lock_device(hdev);
3638 if (unlikely(hub->disconnected))
3639 goto loop_disconnected;
3641 /* If the hub has died, clean up after it */
3642 if (hdev->state == USB_STATE_NOTATTACHED) {
3643 hub->error = -ENODEV;
3644 hub_quiesce(hub, HUB_DISCONNECT);
3649 ret = usb_autopm_get_interface(intf);
3651 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3655 /* If this is an inactive hub, do nothing */
3660 dev_dbg (hub_dev, "resetting for error %d\n",
3663 ret = usb_reset_device(hdev);
3666 "error resetting hub: %d\n", ret);
3674 /* deal with port status changes */
3675 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3676 if (test_bit(i, hub->busy_bits))
3678 connect_change = test_bit(i, hub->change_bits);
3679 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3680 if (!test_and_clear_bit(i, hub->event_bits) &&
3681 !connect_change && !wakeup_change)
3684 ret = hub_port_status(hub, i,
3685 &portstatus, &portchange);
3689 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3690 clear_port_feature(hdev, i,
3691 USB_PORT_FEAT_C_CONNECTION);
3695 if (portchange & USB_PORT_STAT_C_ENABLE) {
3696 if (!connect_change)
3698 "port %d enable change, "
3701 clear_port_feature(hdev, i,
3702 USB_PORT_FEAT_C_ENABLE);
3705 * EM interference sometimes causes badly
3706 * shielded USB devices to be shutdown by
3707 * the hub, this hack enables them again.
3708 * Works at least with mouse driver.
3710 if (!(portstatus & USB_PORT_STAT_ENABLE)
3712 && hdev->children[i-1]) {
3715 "disabled by hub (EMI?), "
3722 if (hub_handle_remote_wakeup(hub, i,
3723 portstatus, portchange))
3726 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3730 dev_dbg(hub_dev, "over-current change on port "
3732 clear_port_feature(hdev, i,
3733 USB_PORT_FEAT_C_OVER_CURRENT);
3734 msleep(100); /* Cool down */
3735 hub_power_on(hub, true);
3736 hub_port_status(hub, i, &status, &unused);
3737 if (status & USB_PORT_STAT_OVERCURRENT)
3738 dev_err(hub_dev, "over-current "
3739 "condition on port %d\n", i);
3742 if (portchange & USB_PORT_STAT_C_RESET) {
3744 "reset change on port %d\n",
3746 clear_port_feature(hdev, i,
3747 USB_PORT_FEAT_C_RESET);
3749 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3750 hub_is_superspeed(hub->hdev)) {
3752 "warm reset change on port %d\n",
3754 clear_port_feature(hdev, i,
3755 USB_PORT_FEAT_C_BH_PORT_RESET);
3757 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3758 clear_port_feature(hub->hdev, i,
3759 USB_PORT_FEAT_C_PORT_LINK_STATE);
3761 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3763 "config error on port %d\n",
3765 clear_port_feature(hub->hdev, i,
3766 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3769 /* Warm reset a USB3 protocol port if it's in
3770 * SS.Inactive state.
3772 if (hub_is_superspeed(hub->hdev) &&
3773 (portstatus & USB_PORT_STAT_LINK_STATE)
3774 == USB_SS_PORT_LS_SS_INACTIVE) {
3775 dev_dbg(hub_dev, "warm reset port %d\n", i);
3776 hub_port_reset(hub, i, NULL,
3777 HUB_BH_RESET_TIME, true);
3781 hub_port_connect_change(hub, i,
3782 portstatus, portchange);
3785 /* deal with hub status changes */
3786 if (test_and_clear_bit(0, hub->event_bits) == 0)
3788 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3789 dev_err (hub_dev, "get_hub_status failed\n");
3791 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3792 dev_dbg (hub_dev, "power change\n");
3793 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3794 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3795 /* FIXME: Is this always true? */
3796 hub->limited_power = 1;
3798 hub->limited_power = 0;
3800 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3804 dev_dbg(hub_dev, "over-current change\n");
3805 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3806 msleep(500); /* Cool down */
3807 hub_power_on(hub, true);
3808 hub_hub_status(hub, &status, &unused);
3809 if (status & HUB_STATUS_OVERCURRENT)
3810 dev_err(hub_dev, "over-current "
3816 /* Balance the usb_autopm_get_interface() above */
3817 usb_autopm_put_interface_no_suspend(intf);
3819 /* Balance the usb_autopm_get_interface_no_resume() in
3820 * kick_khubd() and allow autosuspend.
3822 usb_autopm_put_interface(intf);
3824 usb_unlock_device(hdev);
3825 kref_put(&hub->kref, hub_release);
3827 } /* end while (1) */
3830 static int hub_thread(void *__unused)
3832 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3833 * port handover. Otherwise it might see that a full-speed device
3834 * was gone before the EHCI controller had handed its port over to
3835 * the companion full-speed controller.
3841 wait_event_freezable(khubd_wait,
3842 !list_empty(&hub_event_list) ||
3843 kthread_should_stop());
3844 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3846 pr_debug("%s: khubd exiting\n", usbcore_name);
3850 static const struct usb_device_id hub_id_table[] = {
3851 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3852 .bDeviceClass = USB_CLASS_HUB},
3853 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3854 .bInterfaceClass = USB_CLASS_HUB},
3855 { } /* Terminating entry */
3858 MODULE_DEVICE_TABLE (usb, hub_id_table);
3860 static struct usb_driver hub_driver = {
3863 .disconnect = hub_disconnect,
3864 .suspend = hub_suspend,
3865 .resume = hub_resume,
3866 .reset_resume = hub_reset_resume,
3867 .pre_reset = hub_pre_reset,
3868 .post_reset = hub_post_reset,
3869 .unlocked_ioctl = hub_ioctl,
3870 .id_table = hub_id_table,
3871 .supports_autosuspend = 1,
3874 int usb_hub_init(void)
3876 if (usb_register(&hub_driver) < 0) {
3877 printk(KERN_ERR "%s: can't register hub driver\n",
3882 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3883 if (!IS_ERR(khubd_task))
3886 /* Fall through if kernel_thread failed */
3887 usb_deregister(&hub_driver);
3888 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3893 void usb_hub_cleanup(void)
3895 kthread_stop(khubd_task);
3898 * Hub resources are freed for us by usb_deregister. It calls
3899 * usb_driver_purge on every device which in turn calls that
3900 * devices disconnect function if it is using this driver.
3901 * The hub_disconnect function takes care of releasing the
3902 * individual hub resources. -greg
3904 usb_deregister(&hub_driver);
3905 } /* usb_hub_cleanup() */
3907 static int descriptors_changed(struct usb_device *udev,
3908 struct usb_device_descriptor *old_device_descriptor)
3912 unsigned serial_len = 0;
3914 unsigned old_length;
3918 if (memcmp(&udev->descriptor, old_device_descriptor,
3919 sizeof(*old_device_descriptor)) != 0)
3922 /* Since the idVendor, idProduct, and bcdDevice values in the
3923 * device descriptor haven't changed, we will assume the
3924 * Manufacturer and Product strings haven't changed either.
3925 * But the SerialNumber string could be different (e.g., a
3926 * different flash card of the same brand).
3929 serial_len = strlen(udev->serial) + 1;
3932 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3933 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3934 len = max(len, old_length);
3937 buf = kmalloc(len, GFP_NOIO);
3939 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3940 /* assume the worst */
3943 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3944 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3945 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3947 if (length != old_length) {
3948 dev_dbg(&udev->dev, "config index %d, error %d\n",
3953 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3955 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3957 ((struct usb_config_descriptor *) buf)->
3958 bConfigurationValue);
3964 if (!changed && serial_len) {
3965 length = usb_string(udev, udev->descriptor.iSerialNumber,
3967 if (length + 1 != serial_len) {
3968 dev_dbg(&udev->dev, "serial string error %d\n",
3971 } else if (memcmp(buf, udev->serial, length) != 0) {
3972 dev_dbg(&udev->dev, "serial string changed\n");
3982 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3983 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3985 * WARNING - don't use this routine to reset a composite device
3986 * (one with multiple interfaces owned by separate drivers)!
3987 * Use usb_reset_device() instead.
3989 * Do a port reset, reassign the device's address, and establish its
3990 * former operating configuration. If the reset fails, or the device's
3991 * descriptors change from their values before the reset, or the original
3992 * configuration and altsettings cannot be restored, a flag will be set
3993 * telling khubd to pretend the device has been disconnected and then
3994 * re-connected. All drivers will be unbound, and the device will be
3995 * re-enumerated and probed all over again.
3997 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3998 * flagged for logical disconnection, or some other negative error code
3999 * if the reset wasn't even attempted.
4001 * The caller must own the device lock. For example, it's safe to use
4002 * this from a driver probe() routine after downloading new firmware.
4003 * For calls that might not occur during probe(), drivers should lock
4004 * the device using usb_lock_device_for_reset().
4006 * Locking exception: This routine may also be called from within an
4007 * autoresume handler. Such usage won't conflict with other tasks
4008 * holding the device lock because these tasks should always call
4009 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4011 static int usb_reset_and_verify_device(struct usb_device *udev)
4013 struct usb_device *parent_hdev = udev->parent;
4014 struct usb_hub *parent_hub;
4015 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4016 struct usb_device_descriptor descriptor = udev->descriptor;
4018 int port1 = udev->portnum;
4020 if (udev->state == USB_STATE_NOTATTACHED ||
4021 udev->state == USB_STATE_SUSPENDED) {
4022 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4028 /* this requires hcd-specific logic; see ohci_restart() */
4029 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4032 parent_hub = hdev_to_hub(parent_hdev);
4034 set_bit(port1, parent_hub->busy_bits);
4035 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4037 /* ep0 maxpacket size may change; let the HCD know about it.
4038 * Other endpoints will be handled by re-enumeration. */
4039 usb_ep0_reinit(udev);
4040 ret = hub_port_init(parent_hub, udev, port1, i);
4041 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4044 clear_bit(port1, parent_hub->busy_bits);
4049 /* Device might have changed firmware (DFU or similar) */
4050 if (descriptors_changed(udev, &descriptor)) {
4051 dev_info(&udev->dev, "device firmware changed\n");
4052 udev->descriptor = descriptor; /* for disconnect() calls */
4056 /* Restore the device's previous configuration */
4057 if (!udev->actconfig)
4060 mutex_lock(hcd->bandwidth_mutex);
4061 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4063 dev_warn(&udev->dev,
4064 "Busted HC? Not enough HCD resources for "
4065 "old configuration.\n");
4066 mutex_unlock(hcd->bandwidth_mutex);
4069 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4070 USB_REQ_SET_CONFIGURATION, 0,
4071 udev->actconfig->desc.bConfigurationValue, 0,
4072 NULL, 0, USB_CTRL_SET_TIMEOUT);
4075 "can't restore configuration #%d (error=%d)\n",
4076 udev->actconfig->desc.bConfigurationValue, ret);
4077 mutex_unlock(hcd->bandwidth_mutex);
4080 mutex_unlock(hcd->bandwidth_mutex);
4081 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4083 /* Put interfaces back into the same altsettings as before.
4084 * Don't bother to send the Set-Interface request for interfaces
4085 * that were already in altsetting 0; besides being unnecessary,
4086 * many devices can't handle it. Instead just reset the host-side
4089 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4090 struct usb_host_config *config = udev->actconfig;
4091 struct usb_interface *intf = config->interface[i];
4092 struct usb_interface_descriptor *desc;
4094 desc = &intf->cur_altsetting->desc;
4095 if (desc->bAlternateSetting == 0) {
4096 usb_disable_interface(udev, intf, true);
4097 usb_enable_interface(udev, intf, true);
4100 /* Let the bandwidth allocation function know that this
4101 * device has been reset, and it will have to use
4102 * alternate setting 0 as the current alternate setting.
4104 intf->resetting_device = 1;
4105 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4106 desc->bAlternateSetting);
4107 intf->resetting_device = 0;
4110 dev_err(&udev->dev, "failed to restore interface %d "
4111 "altsetting %d (error=%d)\n",
4112 desc->bInterfaceNumber,
4113 desc->bAlternateSetting,
4123 hub_port_logical_disconnect(parent_hub, port1);
4128 * usb_reset_device - warn interface drivers and perform a USB port reset
4129 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4131 * Warns all drivers bound to registered interfaces (using their pre_reset
4132 * method), performs the port reset, and then lets the drivers know that
4133 * the reset is over (using their post_reset method).
4135 * Return value is the same as for usb_reset_and_verify_device().
4137 * The caller must own the device lock. For example, it's safe to use
4138 * this from a driver probe() routine after downloading new firmware.
4139 * For calls that might not occur during probe(), drivers should lock
4140 * the device using usb_lock_device_for_reset().
4142 * If an interface is currently being probed or disconnected, we assume
4143 * its driver knows how to handle resets. For all other interfaces,
4144 * if the driver doesn't have pre_reset and post_reset methods then
4145 * we attempt to unbind it and rebind afterward.
4147 int usb_reset_device(struct usb_device *udev)
4151 struct usb_host_config *config = udev->actconfig;
4153 if (udev->state == USB_STATE_NOTATTACHED ||
4154 udev->state == USB_STATE_SUSPENDED) {
4155 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4160 /* Prevent autosuspend during the reset */
4161 usb_autoresume_device(udev);
4164 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4165 struct usb_interface *cintf = config->interface[i];
4166 struct usb_driver *drv;
4169 if (cintf->dev.driver) {
4170 drv = to_usb_driver(cintf->dev.driver);
4171 if (drv->pre_reset && drv->post_reset)
4172 unbind = (drv->pre_reset)(cintf);
4173 else if (cintf->condition ==
4174 USB_INTERFACE_BOUND)
4177 usb_forced_unbind_intf(cintf);
4182 ret = usb_reset_and_verify_device(udev);
4185 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4186 struct usb_interface *cintf = config->interface[i];
4187 struct usb_driver *drv;
4188 int rebind = cintf->needs_binding;
4190 if (!rebind && cintf->dev.driver) {
4191 drv = to_usb_driver(cintf->dev.driver);
4192 if (drv->post_reset)
4193 rebind = (drv->post_reset)(cintf);
4194 else if (cintf->condition ==
4195 USB_INTERFACE_BOUND)
4198 if (ret == 0 && rebind)
4199 usb_rebind_intf(cintf);
4203 usb_autosuspend_device(udev);
4206 EXPORT_SYMBOL_GPL(usb_reset_device);
4210 * usb_queue_reset_device - Reset a USB device from an atomic context
4211 * @iface: USB interface belonging to the device to reset
4213 * This function can be used to reset a USB device from an atomic
4214 * context, where usb_reset_device() won't work (as it blocks).
4216 * Doing a reset via this method is functionally equivalent to calling
4217 * usb_reset_device(), except for the fact that it is delayed to a
4218 * workqueue. This means that any drivers bound to other interfaces
4219 * might be unbound, as well as users from usbfs in user space.
4223 * - Scheduling two resets at the same time from two different drivers
4224 * attached to two different interfaces of the same device is
4225 * possible; depending on how the driver attached to each interface
4226 * handles ->pre_reset(), the second reset might happen or not.
4228 * - If a driver is unbound and it had a pending reset, the reset will
4231 * - This function can be called during .probe() or .disconnect()
4232 * times. On return from .disconnect(), any pending resets will be
4235 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4238 * NOTE: We don't do any reference count tracking because it is not
4239 * needed. The lifecycle of the work_struct is tied to the
4240 * usb_interface. Before destroying the interface we cancel the
4241 * work_struct, so the fact that work_struct is queued and or
4242 * running means the interface (and thus, the device) exist and
4245 void usb_queue_reset_device(struct usb_interface *iface)
4247 schedule_work(&iface->reset_ws);
4249 EXPORT_SYMBOL_GPL(usb_queue_reset_device);