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>
27 #include <linux/random.h>
29 #include <asm/uaccess.h>
30 #include <asm/byteorder.h>
34 /* if we are in debug mode, always announce new devices */
36 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct device *intfdev; /* the "interface" device */
43 struct usb_device *hdev;
45 struct urb *urb; /* for interrupt polling pipe */
47 /* buffer for urb ... with extra space in case of babble */
50 struct usb_hub_status hub;
51 struct usb_port_status port;
52 } *status; /* buffer for status reports */
53 struct mutex status_mutex; /* for the status buffer */
55 int error; /* last reported error */
56 int nerrors; /* track consecutive errors */
58 struct list_head event_list; /* hubs w/data or errs ready */
59 unsigned long event_bits[1]; /* status change bitmask */
60 unsigned long change_bits[1]; /* ports with logical connect
62 unsigned long busy_bits[1]; /* ports being reset or
64 unsigned long removed_bits[1]; /* ports with a "removed"
66 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
67 #error event_bits[] is too short!
70 struct usb_hub_descriptor *descriptor; /* class descriptor */
71 struct usb_tt tt; /* Transaction Translator */
73 unsigned mA_per_port; /* current for each child */
75 unsigned limited_power:1;
77 unsigned disconnected:1;
79 unsigned has_indicators:1;
80 u8 indicator[USB_MAXCHILDREN];
81 struct delayed_work leds;
82 struct delayed_work init_work;
86 static inline int hub_is_superspeed(struct usb_device *hdev)
88 return (hdev->descriptor.bDeviceProtocol == 3);
91 /* Protect struct usb_device->state and ->children members
92 * Note: Both are also protected by ->dev.sem, except that ->state can
93 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
94 static DEFINE_SPINLOCK(device_state_lock);
96 /* khubd's worklist and its lock */
97 static DEFINE_SPINLOCK(hub_event_lock);
98 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
101 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
103 static struct task_struct *khubd_task;
105 /* cycle leds on hubs that aren't blinking for attention */
106 static int blinkenlights = 0;
107 module_param (blinkenlights, bool, S_IRUGO);
108 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
111 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
112 * 10 seconds to send reply for the initial 64-byte descriptor request.
114 /* define initial 64-byte descriptor request timeout in milliseconds */
115 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
116 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
117 MODULE_PARM_DESC(initial_descriptor_timeout,
118 "initial 64-byte descriptor request timeout in milliseconds "
119 "(default 5000 - 5.0 seconds)");
122 * As of 2.6.10 we introduce a new USB device initialization scheme which
123 * closely resembles the way Windows works. Hopefully it will be compatible
124 * with a wider range of devices than the old scheme. However some previously
125 * working devices may start giving rise to "device not accepting address"
126 * errors; if that happens the user can try the old scheme by adjusting the
127 * following module parameters.
129 * For maximum flexibility there are two boolean parameters to control the
130 * hub driver's behavior. On the first initialization attempt, if the
131 * "old_scheme_first" parameter is set then the old scheme will be used,
132 * otherwise the new scheme is used. If that fails and "use_both_schemes"
133 * is set, then the driver will make another attempt, using the other scheme.
135 static int old_scheme_first = 0;
136 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
137 MODULE_PARM_DESC(old_scheme_first,
138 "start with the old device initialization scheme");
140 static int use_both_schemes = 1;
141 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
142 MODULE_PARM_DESC(use_both_schemes,
143 "try the other device initialization scheme if the "
146 /* Mutual exclusion for EHCI CF initialization. This interferes with
147 * port reset on some companion controllers.
149 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
150 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
152 #define HUB_DEBOUNCE_TIMEOUT 1500
153 #define HUB_DEBOUNCE_STEP 25
154 #define HUB_DEBOUNCE_STABLE 100
157 static int usb_reset_and_verify_device(struct usb_device *udev);
159 static inline char *portspeed(struct usb_hub *hub, int portstatus)
161 if (hub_is_superspeed(hub->hdev))
163 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
165 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
171 /* Note that hdev or one of its children must be locked! */
172 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
174 if (!hdev || !hdev->actconfig)
176 return usb_get_intfdata(hdev->actconfig->interface[0]);
179 /* USB 2.0 spec Section 11.24.4.5 */
180 static int get_hub_descriptor(struct usb_device *hdev, void *data)
185 if (hub_is_superspeed(hdev)) {
186 dtype = USB_DT_SS_HUB;
187 size = USB_DT_SS_HUB_SIZE;
190 size = sizeof(struct usb_hub_descriptor);
193 for (i = 0; i < 3; i++) {
194 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
195 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
196 dtype << 8, 0, data, size,
197 USB_CTRL_GET_TIMEOUT);
198 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
205 * USB 2.0 spec Section 11.24.2.1
207 static int clear_hub_feature(struct usb_device *hdev, int feature)
209 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
210 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
214 * USB 2.0 spec Section 11.24.2.2
216 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
218 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
219 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
224 * USB 2.0 spec Section 11.24.2.13
226 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
228 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
229 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
234 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
235 * for info about using port indicators
237 static void set_port_led(
243 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
244 USB_PORT_FEAT_INDICATOR);
246 dev_dbg (hub->intfdev,
247 "port %d indicator %s status %d\n",
249 ({ char *s; switch (selector) {
250 case HUB_LED_AMBER: s = "amber"; break;
251 case HUB_LED_GREEN: s = "green"; break;
252 case HUB_LED_OFF: s = "off"; break;
253 case HUB_LED_AUTO: s = "auto"; break;
254 default: s = "??"; break;
259 #define LED_CYCLE_PERIOD ((2*HZ)/3)
261 static void led_work (struct work_struct *work)
263 struct usb_hub *hub =
264 container_of(work, struct usb_hub, leds.work);
265 struct usb_device *hdev = hub->hdev;
267 unsigned changed = 0;
270 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
273 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
274 unsigned selector, mode;
276 /* 30%-50% duty cycle */
278 switch (hub->indicator[i]) {
280 case INDICATOR_CYCLE:
282 selector = HUB_LED_AUTO;
283 mode = INDICATOR_AUTO;
285 /* blinking green = sw attention */
286 case INDICATOR_GREEN_BLINK:
287 selector = HUB_LED_GREEN;
288 mode = INDICATOR_GREEN_BLINK_OFF;
290 case INDICATOR_GREEN_BLINK_OFF:
291 selector = HUB_LED_OFF;
292 mode = INDICATOR_GREEN_BLINK;
294 /* blinking amber = hw attention */
295 case INDICATOR_AMBER_BLINK:
296 selector = HUB_LED_AMBER;
297 mode = INDICATOR_AMBER_BLINK_OFF;
299 case INDICATOR_AMBER_BLINK_OFF:
300 selector = HUB_LED_OFF;
301 mode = INDICATOR_AMBER_BLINK;
303 /* blink green/amber = reserved */
304 case INDICATOR_ALT_BLINK:
305 selector = HUB_LED_GREEN;
306 mode = INDICATOR_ALT_BLINK_OFF;
308 case INDICATOR_ALT_BLINK_OFF:
309 selector = HUB_LED_AMBER;
310 mode = INDICATOR_ALT_BLINK;
315 if (selector != HUB_LED_AUTO)
317 set_port_led(hub, i + 1, selector);
318 hub->indicator[i] = mode;
320 if (!changed && blinkenlights) {
322 cursor %= hub->descriptor->bNbrPorts;
323 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
324 hub->indicator[cursor] = INDICATOR_CYCLE;
328 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
331 /* use a short timeout for hub/port status fetches */
332 #define USB_STS_TIMEOUT 1000
333 #define USB_STS_RETRIES 5
336 * USB 2.0 spec Section 11.24.2.6
338 static int get_hub_status(struct usb_device *hdev,
339 struct usb_hub_status *data)
341 int i, status = -ETIMEDOUT;
343 for (i = 0; i < USB_STS_RETRIES &&
344 (status == -ETIMEDOUT || status == -EPIPE); i++) {
345 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
346 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
347 data, sizeof(*data), USB_STS_TIMEOUT);
353 * USB 2.0 spec Section 11.24.2.7
355 static int get_port_status(struct usb_device *hdev, int port1,
356 struct usb_port_status *data)
358 int i, status = -ETIMEDOUT;
360 for (i = 0; i < USB_STS_RETRIES &&
361 (status == -ETIMEDOUT || status == -EPIPE); i++) {
362 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
363 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
364 data, sizeof(*data), USB_STS_TIMEOUT);
369 static int hub_port_status(struct usb_hub *hub, int port1,
370 u16 *status, u16 *change)
374 mutex_lock(&hub->status_mutex);
375 ret = get_port_status(hub->hdev, port1, &hub->status->port);
377 dev_err(hub->intfdev,
378 "%s failed (err = %d)\n", __func__, ret);
382 *status = le16_to_cpu(hub->status->port.wPortStatus);
383 *change = le16_to_cpu(hub->status->port.wPortChange);
387 mutex_unlock(&hub->status_mutex);
391 static void kick_khubd(struct usb_hub *hub)
395 spin_lock_irqsave(&hub_event_lock, flags);
396 if (!hub->disconnected && list_empty(&hub->event_list)) {
397 list_add_tail(&hub->event_list, &hub_event_list);
399 /* Suppress autosuspend until khubd runs */
400 usb_autopm_get_interface_no_resume(
401 to_usb_interface(hub->intfdev));
402 wake_up(&khubd_wait);
404 spin_unlock_irqrestore(&hub_event_lock, flags);
407 void usb_kick_khubd(struct usb_device *hdev)
409 struct usb_hub *hub = hdev_to_hub(hdev);
416 /* completion function, fires on port status changes and various faults */
417 static void hub_irq(struct urb *urb)
419 struct usb_hub *hub = urb->context;
420 int status = urb->status;
425 case -ENOENT: /* synchronous unlink */
426 case -ECONNRESET: /* async unlink */
427 case -ESHUTDOWN: /* hardware going away */
430 default: /* presumably an error */
431 /* Cause a hub reset after 10 consecutive errors */
432 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
433 if ((++hub->nerrors < 10) || hub->error)
438 /* let khubd handle things */
439 case 0: /* we got data: port status changed */
441 for (i = 0; i < urb->actual_length; ++i)
442 bits |= ((unsigned long) ((*hub->buffer)[i]))
444 hub->event_bits[0] = bits;
450 /* Something happened, let khubd figure it out */
457 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
458 && status != -ENODEV && status != -EPERM)
459 dev_err (hub->intfdev, "resubmit --> %d\n", status);
462 /* USB 2.0 spec Section 11.24.2.3 */
464 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
466 /* Need to clear both directions for control ep */
467 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
468 USB_ENDPOINT_XFER_CONTROL) {
469 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
470 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
471 devinfo ^ 0x8000, tt, NULL, 0, 1000);
475 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
476 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
481 * enumeration blocks khubd for a long time. we use keventd instead, since
482 * long blocking there is the exception, not the rule. accordingly, HCDs
483 * talking to TTs must queue control transfers (not just bulk and iso), so
484 * both can talk to the same hub concurrently.
486 static void hub_tt_work(struct work_struct *work)
488 struct usb_hub *hub =
489 container_of(work, struct usb_hub, tt.clear_work);
493 spin_lock_irqsave (&hub->tt.lock, flags);
494 while (!list_empty(&hub->tt.clear_list)) {
495 struct list_head *next;
496 struct usb_tt_clear *clear;
497 struct usb_device *hdev = hub->hdev;
498 const struct hc_driver *drv;
501 if (!hub->quiescing && --limit < 0)
504 next = hub->tt.clear_list.next;
505 clear = list_entry (next, struct usb_tt_clear, clear_list);
506 list_del (&clear->clear_list);
508 /* drop lock so HCD can concurrently report other TT errors */
509 spin_unlock_irqrestore (&hub->tt.lock, flags);
510 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
513 "clear tt %d (%04x) error %d\n",
514 clear->tt, clear->devinfo, status);
516 /* Tell the HCD, even if the operation failed */
517 drv = clear->hcd->driver;
518 if (drv->clear_tt_buffer_complete)
519 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
522 spin_lock_irqsave(&hub->tt.lock, flags);
524 spin_unlock_irqrestore (&hub->tt.lock, flags);
528 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
529 * @urb: an URB associated with the failed or incomplete split transaction
531 * High speed HCDs use this to tell the hub driver that some split control or
532 * bulk transaction failed in a way that requires clearing internal state of
533 * a transaction translator. This is normally detected (and reported) from
536 * It may not be possible for that hub to handle additional full (or low)
537 * speed transactions until that state is fully cleared out.
539 int usb_hub_clear_tt_buffer(struct urb *urb)
541 struct usb_device *udev = urb->dev;
542 int pipe = urb->pipe;
543 struct usb_tt *tt = udev->tt;
545 struct usb_tt_clear *clear;
547 /* we've got to cope with an arbitrary number of pending TT clears,
548 * since each TT has "at least two" buffers that can need it (and
549 * there can be many TTs per hub). even if they're uncommon.
551 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
552 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
553 /* FIXME recover somehow ... RESET_TT? */
557 /* info that CLEAR_TT_BUFFER needs */
558 clear->tt = tt->multi ? udev->ttport : 1;
559 clear->devinfo = usb_pipeendpoint (pipe);
560 clear->devinfo |= udev->devnum << 4;
561 clear->devinfo |= usb_pipecontrol (pipe)
562 ? (USB_ENDPOINT_XFER_CONTROL << 11)
563 : (USB_ENDPOINT_XFER_BULK << 11);
564 if (usb_pipein (pipe))
565 clear->devinfo |= 1 << 15;
567 /* info for completion callback */
568 clear->hcd = bus_to_hcd(udev->bus);
571 /* tell keventd to clear state for this TT */
572 spin_lock_irqsave (&tt->lock, flags);
573 list_add_tail (&clear->clear_list, &tt->clear_list);
574 schedule_work(&tt->clear_work);
575 spin_unlock_irqrestore (&tt->lock, flags);
578 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
580 /* If do_delay is false, return the number of milliseconds the caller
583 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
586 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
588 u16 wHubCharacteristics =
589 le16_to_cpu(hub->descriptor->wHubCharacteristics);
591 /* Enable power on each port. Some hubs have reserved values
592 * of LPSM (> 2) in their descriptors, even though they are
593 * USB 2.0 hubs. Some hubs do not implement port-power switching
594 * but only emulate it. In all cases, the ports won't work
595 * unless we send these messages to the hub.
597 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
598 dev_dbg(hub->intfdev, "enabling power on all ports\n");
600 dev_dbg(hub->intfdev, "trying to enable port power on "
601 "non-switchable hub\n");
602 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
603 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
605 /* Wait at least 100 msec for power to become stable */
606 delay = max(pgood_delay, (unsigned) 100);
612 static int hub_hub_status(struct usb_hub *hub,
613 u16 *status, u16 *change)
617 mutex_lock(&hub->status_mutex);
618 ret = get_hub_status(hub->hdev, &hub->status->hub);
620 dev_err (hub->intfdev,
621 "%s failed (err = %d)\n", __func__, ret);
623 *status = le16_to_cpu(hub->status->hub.wHubStatus);
624 *change = le16_to_cpu(hub->status->hub.wHubChange);
627 mutex_unlock(&hub->status_mutex);
631 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
632 unsigned int link_status)
634 return set_port_feature(hub->hdev,
635 port1 | (link_status << 3),
636 USB_PORT_FEAT_LINK_STATE);
640 * If USB 3.0 ports are placed into the Disabled state, they will no longer
641 * detect any device connects or disconnects. This is generally not what the
642 * USB core wants, since it expects a disabled port to produce a port status
643 * change event when a new device connects.
645 * Instead, set the link state to Disabled, wait for the link to settle into
646 * that state, clear any change bits, and then put the port into the RxDetect
649 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
653 u16 portchange, portstatus;
655 if (!hub_is_superspeed(hub->hdev))
658 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
660 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
665 /* Wait for the link to enter the disabled state. */
666 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
667 ret = hub_port_status(hub, port1, &portstatus, &portchange);
671 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
672 USB_SS_PORT_LS_SS_DISABLED)
674 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
676 msleep(HUB_DEBOUNCE_STEP);
678 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
679 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
682 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
685 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
687 struct usb_device *hdev = hub->hdev;
690 if (hdev->children[port1-1] && set_state)
691 usb_set_device_state(hdev->children[port1-1],
692 USB_STATE_NOTATTACHED);
694 if (hub_is_superspeed(hub->hdev))
695 ret = hub_usb3_port_disable(hub, port1);
697 ret = clear_port_feature(hdev, port1,
698 USB_PORT_FEAT_ENABLE);
701 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
707 * Disable a port and mark a logical connect-change event, so that some
708 * time later khubd will disconnect() any existing usb_device on the port
709 * and will re-enumerate if there actually is a device attached.
711 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
713 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
714 hub_port_disable(hub, port1, 1);
716 /* FIXME let caller ask to power down the port:
717 * - some devices won't enumerate without a VBUS power cycle
718 * - SRP saves power that way
719 * - ... new call, TBD ...
720 * That's easy if this hub can switch power per-port, and
721 * khubd reactivates the port later (timer, SRP, etc).
722 * Powerdown must be optional, because of reset/DFU.
725 set_bit(port1, hub->change_bits);
730 * usb_remove_device - disable a device's port on its parent hub
731 * @udev: device to be disabled and removed
732 * Context: @udev locked, must be able to sleep.
734 * After @udev's port has been disabled, khubd is notified and it will
735 * see that the device has been disconnected. When the device is
736 * physically unplugged and something is plugged in, the events will
737 * be received and processed normally.
739 int usb_remove_device(struct usb_device *udev)
742 struct usb_interface *intf;
744 if (!udev->parent) /* Can't remove a root hub */
746 hub = hdev_to_hub(udev->parent);
747 intf = to_usb_interface(hub->intfdev);
749 usb_autopm_get_interface(intf);
750 set_bit(udev->portnum, hub->removed_bits);
751 hub_port_logical_disconnect(hub, udev->portnum);
752 usb_autopm_put_interface(intf);
756 enum hub_activation_type {
757 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
758 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
761 static void hub_init_func2(struct work_struct *ws);
762 static void hub_init_func3(struct work_struct *ws);
764 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
766 struct usb_device *hdev = hub->hdev;
771 bool need_debounce_delay = false;
774 /* Continue a partial initialization */
775 if (type == HUB_INIT2)
777 if (type == HUB_INIT3)
780 /* The superspeed hub except for root hub has to use Hub Depth
781 * value as an offset into the route string to locate the bits
782 * it uses to determine the downstream port number. So hub driver
783 * should send a set hub depth request to superspeed hub after
784 * the superspeed hub is set configuration in initialization or
787 * After a resume, port power should still be on.
788 * For any other type of activation, turn it on.
790 if (type != HUB_RESUME) {
791 if (hdev->parent && hub_is_superspeed(hdev)) {
792 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
793 HUB_SET_DEPTH, USB_RT_HUB,
794 hdev->level - 1, 0, NULL, 0,
795 USB_CTRL_SET_TIMEOUT);
797 dev_err(hub->intfdev,
798 "set hub depth failed\n");
801 /* Speed up system boot by using a delayed_work for the
802 * hub's initial power-up delays. This is pretty awkward
803 * and the implementation looks like a home-brewed sort of
804 * setjmp/longjmp, but it saves at least 100 ms for each
805 * root hub (assuming usbcore is compiled into the kernel
806 * rather than as a module). It adds up.
808 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
809 * because for those activation types the ports have to be
810 * operational when we return. In theory this could be done
811 * for HUB_POST_RESET, but it's easier not to.
813 if (type == HUB_INIT) {
814 delay = hub_power_on(hub, false);
815 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
816 schedule_delayed_work(&hub->init_work,
817 msecs_to_jiffies(delay));
819 /* Suppress autosuspend until init is done */
820 usb_autopm_get_interface_no_resume(
821 to_usb_interface(hub->intfdev));
822 return; /* Continues at init2: below */
823 } else if (type == HUB_RESET_RESUME) {
824 /* The internal host controller state for the hub device
825 * may be gone after a host power loss on system resume.
826 * Update the device's info so the HW knows it's a hub.
828 hcd = bus_to_hcd(hdev->bus);
829 if (hcd->driver->update_hub_device) {
830 ret = hcd->driver->update_hub_device(hcd, hdev,
833 dev_err(hub->intfdev, "Host not "
834 "accepting hub info "
836 dev_err(hub->intfdev, "LS/FS devices "
837 "and hubs may not work "
838 "under this hub\n.");
841 hub_power_on(hub, true);
843 hub_power_on(hub, true);
848 /* Check each port and set hub->change_bits to let khubd know
849 * which ports need attention.
851 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
852 struct usb_device *udev = hdev->children[port1-1];
853 u16 portstatus, portchange;
855 portstatus = portchange = 0;
856 status = hub_port_status(hub, port1, &portstatus, &portchange);
857 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
858 dev_dbg(hub->intfdev,
859 "port %d: status %04x change %04x\n",
860 port1, portstatus, portchange);
862 /* After anything other than HUB_RESUME (i.e., initialization
863 * or any sort of reset), every port should be disabled.
864 * Unconnected ports should likewise be disabled (paranoia),
865 * and so should ports for which we have no usb_device.
867 if ((portstatus & USB_PORT_STAT_ENABLE) && (
868 type != HUB_RESUME ||
869 !(portstatus & USB_PORT_STAT_CONNECTION) ||
871 udev->state == USB_STATE_NOTATTACHED)) {
873 * USB3 protocol ports will automatically transition
874 * to Enabled state when detect an USB3.0 device attach.
875 * Do not disable USB3 protocol ports.
877 if (!hub_is_superspeed(hdev)) {
878 clear_port_feature(hdev, port1,
879 USB_PORT_FEAT_ENABLE);
880 portstatus &= ~USB_PORT_STAT_ENABLE;
882 /* Pretend that power was lost for USB3 devs */
883 portstatus &= ~USB_PORT_STAT_ENABLE;
887 /* Clear status-change flags; we'll debounce later */
888 if (portchange & USB_PORT_STAT_C_CONNECTION) {
889 need_debounce_delay = true;
890 clear_port_feature(hub->hdev, port1,
891 USB_PORT_FEAT_C_CONNECTION);
893 if (portchange & USB_PORT_STAT_C_ENABLE) {
894 need_debounce_delay = true;
895 clear_port_feature(hub->hdev, port1,
896 USB_PORT_FEAT_C_ENABLE);
898 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
899 need_debounce_delay = true;
900 clear_port_feature(hub->hdev, port1,
901 USB_PORT_FEAT_C_PORT_LINK_STATE);
903 if (portchange & USB_PORT_STAT_C_RESET) {
904 need_debounce_delay = true;
905 clear_port_feature(hub->hdev, port1,
906 USB_PORT_FEAT_C_RESET);
909 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
910 hub_is_superspeed(hub->hdev)) {
911 need_debounce_delay = true;
912 clear_port_feature(hub->hdev, port1,
913 USB_PORT_FEAT_C_BH_PORT_RESET);
915 /* We can forget about a "removed" device when there's a
916 * physical disconnect or the connect status changes.
918 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
919 (portchange & USB_PORT_STAT_C_CONNECTION))
920 clear_bit(port1, hub->removed_bits);
922 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
923 /* Tell khubd to disconnect the device or
924 * check for a new connection
926 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
927 set_bit(port1, hub->change_bits);
929 } else if (portstatus & USB_PORT_STAT_ENABLE) {
930 /* The power session apparently survived the resume.
931 * If there was an overcurrent or suspend change
932 * (i.e., remote wakeup request), have khubd
936 set_bit(port1, hub->change_bits);
938 } else if (udev->persist_enabled) {
940 udev->reset_resume = 1;
942 set_bit(port1, hub->change_bits);
945 /* The power session is gone; tell khubd */
946 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
947 set_bit(port1, hub->change_bits);
951 /* If no port-status-change flags were set, we don't need any
952 * debouncing. If flags were set we can try to debounce the
953 * ports all at once right now, instead of letting khubd do them
954 * one at a time later on.
956 * If any port-status changes do occur during this delay, khubd
957 * will see them later and handle them normally.
959 if (need_debounce_delay) {
960 delay = HUB_DEBOUNCE_STABLE;
962 /* Don't do a long sleep inside a workqueue routine */
963 if (type == HUB_INIT2) {
964 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
965 schedule_delayed_work(&hub->init_work,
966 msecs_to_jiffies(delay));
967 return; /* Continues at init3: below */
975 status = usb_submit_urb(hub->urb, GFP_NOIO);
977 dev_err(hub->intfdev, "activate --> %d\n", status);
978 if (hub->has_indicators && blinkenlights)
979 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
981 /* Scan all ports that need attention */
984 /* Allow autosuspend if it was suppressed */
985 if (type <= HUB_INIT3)
986 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
989 /* Implement the continuations for the delays above */
990 static void hub_init_func2(struct work_struct *ws)
992 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
994 hub_activate(hub, HUB_INIT2);
997 static void hub_init_func3(struct work_struct *ws)
999 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1001 hub_activate(hub, HUB_INIT3);
1004 enum hub_quiescing_type {
1005 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1008 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1010 struct usb_device *hdev = hub->hdev;
1013 cancel_delayed_work_sync(&hub->init_work);
1015 /* khubd and related activity won't re-trigger */
1018 if (type != HUB_SUSPEND) {
1019 /* Disconnect all the children */
1020 for (i = 0; i < hdev->maxchild; ++i) {
1021 if (hdev->children[i])
1022 usb_disconnect(&hdev->children[i]);
1026 /* Stop khubd and related activity */
1027 usb_kill_urb(hub->urb);
1028 if (hub->has_indicators)
1029 cancel_delayed_work_sync(&hub->leds);
1031 flush_work_sync(&hub->tt.clear_work);
1034 /* caller has locked the hub device */
1035 static int hub_pre_reset(struct usb_interface *intf)
1037 struct usb_hub *hub = usb_get_intfdata(intf);
1039 hub_quiesce(hub, HUB_PRE_RESET);
1043 /* caller has locked the hub device */
1044 static int hub_post_reset(struct usb_interface *intf)
1046 struct usb_hub *hub = usb_get_intfdata(intf);
1048 hub_activate(hub, HUB_POST_RESET);
1052 static int hub_configure(struct usb_hub *hub,
1053 struct usb_endpoint_descriptor *endpoint)
1055 struct usb_hcd *hcd;
1056 struct usb_device *hdev = hub->hdev;
1057 struct device *hub_dev = hub->intfdev;
1058 u16 hubstatus, hubchange;
1059 u16 wHubCharacteristics;
1062 char *message = "out of memory";
1064 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1070 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1075 mutex_init(&hub->status_mutex);
1077 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1078 if (!hub->descriptor) {
1083 /* Request the entire hub descriptor.
1084 * hub->descriptor can handle USB_MAXCHILDREN ports,
1085 * but the hub can/will return fewer bytes here.
1087 ret = get_hub_descriptor(hdev, hub->descriptor);
1089 message = "can't read hub descriptor";
1091 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1092 message = "hub has too many ports!";
1097 hdev->maxchild = hub->descriptor->bNbrPorts;
1098 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1099 (hdev->maxchild == 1) ? "" : "s");
1101 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1102 if (!hub->port_owners) {
1107 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1109 /* FIXME for USB 3.0, skip for now */
1110 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1111 !(hub_is_superspeed(hdev))) {
1113 char portstr [USB_MAXCHILDREN + 1];
1115 for (i = 0; i < hdev->maxchild; i++)
1116 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1117 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1119 portstr[hdev->maxchild] = 0;
1120 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1122 dev_dbg(hub_dev, "standalone hub\n");
1124 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1126 dev_dbg(hub_dev, "ganged power switching\n");
1129 dev_dbg(hub_dev, "individual port power switching\n");
1133 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1137 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1139 dev_dbg(hub_dev, "global over-current protection\n");
1142 dev_dbg(hub_dev, "individual port over-current protection\n");
1146 dev_dbg(hub_dev, "no over-current protection\n");
1150 spin_lock_init (&hub->tt.lock);
1151 INIT_LIST_HEAD (&hub->tt.clear_list);
1152 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1153 switch (hdev->descriptor.bDeviceProtocol) {
1157 dev_dbg(hub_dev, "Single TT\n");
1161 ret = usb_set_interface(hdev, 0, 1);
1163 dev_dbg(hub_dev, "TT per port\n");
1166 dev_err(hub_dev, "Using single TT (err %d)\n",
1171 /* USB 3.0 hubs don't have a TT */
1174 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1175 hdev->descriptor.bDeviceProtocol);
1179 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1180 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1181 case HUB_TTTT_8_BITS:
1182 if (hdev->descriptor.bDeviceProtocol != 0) {
1183 hub->tt.think_time = 666;
1184 dev_dbg(hub_dev, "TT requires at most %d "
1185 "FS bit times (%d ns)\n",
1186 8, hub->tt.think_time);
1189 case HUB_TTTT_16_BITS:
1190 hub->tt.think_time = 666 * 2;
1191 dev_dbg(hub_dev, "TT requires at most %d "
1192 "FS bit times (%d ns)\n",
1193 16, hub->tt.think_time);
1195 case HUB_TTTT_24_BITS:
1196 hub->tt.think_time = 666 * 3;
1197 dev_dbg(hub_dev, "TT requires at most %d "
1198 "FS bit times (%d ns)\n",
1199 24, hub->tt.think_time);
1201 case HUB_TTTT_32_BITS:
1202 hub->tt.think_time = 666 * 4;
1203 dev_dbg(hub_dev, "TT requires at most %d "
1204 "FS bit times (%d ns)\n",
1205 32, hub->tt.think_time);
1209 /* probe() zeroes hub->indicator[] */
1210 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1211 hub->has_indicators = 1;
1212 dev_dbg(hub_dev, "Port indicators are supported\n");
1215 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1216 hub->descriptor->bPwrOn2PwrGood * 2);
1218 /* power budgeting mostly matters with bus-powered hubs,
1219 * and battery-powered root hubs (may provide just 8 mA).
1221 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1223 message = "can't get hub status";
1226 le16_to_cpus(&hubstatus);
1227 if (hdev == hdev->bus->root_hub) {
1228 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1229 hub->mA_per_port = 500;
1231 hub->mA_per_port = hdev->bus_mA;
1232 hub->limited_power = 1;
1234 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1235 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1236 hub->descriptor->bHubContrCurrent);
1237 hub->limited_power = 1;
1238 if (hdev->maxchild > 0) {
1239 int remaining = hdev->bus_mA -
1240 hub->descriptor->bHubContrCurrent;
1242 if (remaining < hdev->maxchild * 100)
1244 "insufficient power available "
1245 "to use all downstream ports\n");
1246 hub->mA_per_port = 100; /* 7.2.1.1 */
1248 } else { /* Self-powered external hub */
1249 /* FIXME: What about battery-powered external hubs that
1250 * provide less current per port? */
1251 hub->mA_per_port = 500;
1253 if (hub->mA_per_port < 500)
1254 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1257 /* Update the HCD's internal representation of this hub before khubd
1258 * starts getting port status changes for devices under the hub.
1260 hcd = bus_to_hcd(hdev->bus);
1261 if (hcd->driver->update_hub_device) {
1262 ret = hcd->driver->update_hub_device(hcd, hdev,
1263 &hub->tt, GFP_KERNEL);
1265 message = "can't update HCD hub info";
1270 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1272 message = "can't get hub status";
1276 /* local power status reports aren't always correct */
1277 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1278 dev_dbg(hub_dev, "local power source is %s\n",
1279 (hubstatus & HUB_STATUS_LOCAL_POWER)
1280 ? "lost (inactive)" : "good");
1282 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1283 dev_dbg(hub_dev, "%sover-current condition exists\n",
1284 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1286 /* set up the interrupt endpoint
1287 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1288 * bytes as USB2.0[11.12.3] says because some hubs are known
1289 * to send more data (and thus cause overflow). For root hubs,
1290 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1291 * to be big enough for at least USB_MAXCHILDREN ports. */
1292 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1293 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1295 if (maxp > sizeof(*hub->buffer))
1296 maxp = sizeof(*hub->buffer);
1298 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1304 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1305 hub, endpoint->bInterval);
1307 /* maybe cycle the hub leds */
1308 if (hub->has_indicators && blinkenlights)
1309 hub->indicator [0] = INDICATOR_CYCLE;
1311 hub_activate(hub, HUB_INIT);
1315 dev_err (hub_dev, "config failed, %s (err %d)\n",
1317 /* hub_disconnect() frees urb and descriptor */
1321 static void hub_release(struct kref *kref)
1323 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1325 usb_put_intf(to_usb_interface(hub->intfdev));
1329 static unsigned highspeed_hubs;
1331 static void hub_disconnect(struct usb_interface *intf)
1333 struct usb_hub *hub = usb_get_intfdata (intf);
1335 /* Take the hub off the event list and don't let it be added again */
1336 spin_lock_irq(&hub_event_lock);
1337 if (!list_empty(&hub->event_list)) {
1338 list_del_init(&hub->event_list);
1339 usb_autopm_put_interface_no_suspend(intf);
1341 hub->disconnected = 1;
1342 spin_unlock_irq(&hub_event_lock);
1344 /* Disconnect all children and quiesce the hub */
1346 hub_quiesce(hub, HUB_DISCONNECT);
1348 usb_set_intfdata (intf, NULL);
1349 hub->hdev->maxchild = 0;
1351 if (hub->hdev->speed == USB_SPEED_HIGH)
1354 usb_free_urb(hub->urb);
1355 kfree(hub->port_owners);
1356 kfree(hub->descriptor);
1360 kref_put(&hub->kref, hub_release);
1363 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1365 struct usb_host_interface *desc;
1366 struct usb_endpoint_descriptor *endpoint;
1367 struct usb_device *hdev;
1368 struct usb_hub *hub;
1370 desc = intf->cur_altsetting;
1371 hdev = interface_to_usbdev(intf);
1373 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1374 * different from USB 2.0/1.1 device suspend, and unfortunately we
1375 * don't support it yet. So leave autosuspend disabled for USB 3.0
1376 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1377 * since that isn't a "real" hub.
1379 if (!hub_is_superspeed(hdev) || !hdev->parent)
1380 usb_enable_autosuspend(hdev);
1382 if (hdev->level == MAX_TOPO_LEVEL) {
1384 "Unsupported bus topology: hub nested too deep\n");
1388 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1390 dev_warn(&intf->dev, "ignoring external hub\n");
1395 /* Some hubs have a subclass of 1, which AFAICT according to the */
1396 /* specs is not defined, but it works */
1397 if ((desc->desc.bInterfaceSubClass != 0) &&
1398 (desc->desc.bInterfaceSubClass != 1)) {
1400 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1404 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1405 if (desc->desc.bNumEndpoints != 1)
1406 goto descriptor_error;
1408 endpoint = &desc->endpoint[0].desc;
1410 /* If it's not an interrupt in endpoint, we'd better punt! */
1411 if (!usb_endpoint_is_int_in(endpoint))
1412 goto descriptor_error;
1414 /* We found a hub */
1415 dev_info (&intf->dev, "USB hub found\n");
1417 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1419 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1423 kref_init(&hub->kref);
1424 INIT_LIST_HEAD(&hub->event_list);
1425 hub->intfdev = &intf->dev;
1427 INIT_DELAYED_WORK(&hub->leds, led_work);
1428 INIT_DELAYED_WORK(&hub->init_work, NULL);
1431 usb_set_intfdata (intf, hub);
1432 intf->needs_remote_wakeup = 1;
1434 if (hdev->speed == USB_SPEED_HIGH)
1437 if (hub_configure(hub, endpoint) >= 0)
1440 hub_disconnect (intf);
1446 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1448 struct usb_device *hdev = interface_to_usbdev (intf);
1450 /* assert ifno == 0 (part of hub spec) */
1452 case USBDEVFS_HUB_PORTINFO: {
1453 struct usbdevfs_hub_portinfo *info = user_data;
1456 spin_lock_irq(&device_state_lock);
1457 if (hdev->devnum <= 0)
1460 info->nports = hdev->maxchild;
1461 for (i = 0; i < info->nports; i++) {
1462 if (hdev->children[i] == NULL)
1466 hdev->children[i]->devnum;
1469 spin_unlock_irq(&device_state_lock);
1471 return info->nports + 1;
1480 * Allow user programs to claim ports on a hub. When a device is attached
1481 * to one of these "claimed" ports, the program will "own" the device.
1483 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1486 if (hdev->state == USB_STATE_NOTATTACHED)
1488 if (port1 == 0 || port1 > hdev->maxchild)
1491 /* This assumes that devices not managed by the hub driver
1492 * will always have maxchild equal to 0.
1494 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1498 /* In the following three functions, the caller must hold hdev's lock */
1499 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1504 rc = find_port_owner(hdev, port1, &powner);
1513 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1518 rc = find_port_owner(hdev, port1, &powner);
1521 if (*powner != owner)
1527 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1532 n = find_port_owner(hdev, 1, &powner);
1534 for (; n < hdev->maxchild; (++n, ++powner)) {
1535 if (*powner == owner)
1541 /* The caller must hold udev's lock */
1542 bool usb_device_is_owned(struct usb_device *udev)
1544 struct usb_hub *hub;
1546 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1548 hub = hdev_to_hub(udev->parent);
1549 return !!hub->port_owners[udev->portnum - 1];
1553 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1557 for (i = 0; i < udev->maxchild; ++i) {
1558 if (udev->children[i])
1559 recursively_mark_NOTATTACHED(udev->children[i]);
1561 if (udev->state == USB_STATE_SUSPENDED)
1562 udev->active_duration -= jiffies;
1563 udev->state = USB_STATE_NOTATTACHED;
1567 * usb_set_device_state - change a device's current state (usbcore, hcds)
1568 * @udev: pointer to device whose state should be changed
1569 * @new_state: new state value to be stored
1571 * udev->state is _not_ fully protected by the device lock. Although
1572 * most transitions are made only while holding the lock, the state can
1573 * can change to USB_STATE_NOTATTACHED at almost any time. This
1574 * is so that devices can be marked as disconnected as soon as possible,
1575 * without having to wait for any semaphores to be released. As a result,
1576 * all changes to any device's state must be protected by the
1577 * device_state_lock spinlock.
1579 * Once a device has been added to the device tree, all changes to its state
1580 * should be made using this routine. The state should _not_ be set directly.
1582 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1583 * Otherwise udev->state is set to new_state, and if new_state is
1584 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1585 * to USB_STATE_NOTATTACHED.
1587 void usb_set_device_state(struct usb_device *udev,
1588 enum usb_device_state new_state)
1590 unsigned long flags;
1593 spin_lock_irqsave(&device_state_lock, flags);
1594 if (udev->state == USB_STATE_NOTATTACHED)
1596 else if (new_state != USB_STATE_NOTATTACHED) {
1598 /* root hub wakeup capabilities are managed out-of-band
1599 * and may involve silicon errata ... ignore them here.
1602 if (udev->state == USB_STATE_SUSPENDED
1603 || new_state == USB_STATE_SUSPENDED)
1604 ; /* No change to wakeup settings */
1605 else if (new_state == USB_STATE_CONFIGURED)
1606 wakeup = udev->actconfig->desc.bmAttributes
1607 & USB_CONFIG_ATT_WAKEUP;
1611 if (udev->state == USB_STATE_SUSPENDED &&
1612 new_state != USB_STATE_SUSPENDED)
1613 udev->active_duration -= jiffies;
1614 else if (new_state == USB_STATE_SUSPENDED &&
1615 udev->state != USB_STATE_SUSPENDED)
1616 udev->active_duration += jiffies;
1617 udev->state = new_state;
1619 recursively_mark_NOTATTACHED(udev);
1620 spin_unlock_irqrestore(&device_state_lock, flags);
1622 device_set_wakeup_capable(&udev->dev, wakeup);
1624 EXPORT_SYMBOL_GPL(usb_set_device_state);
1627 * Choose a device number.
1629 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1630 * USB-2.0 buses they are also used as device addresses, however on
1631 * USB-3.0 buses the address is assigned by the controller hardware
1632 * and it usually is not the same as the device number.
1634 * WUSB devices are simple: they have no hubs behind, so the mapping
1635 * device <-> virtual port number becomes 1:1. Why? to simplify the
1636 * life of the device connection logic in
1637 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1638 * handshake we need to assign a temporary address in the unauthorized
1639 * space. For simplicity we use the first virtual port number found to
1640 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1641 * and that becomes it's address [X < 128] or its unauthorized address
1644 * We add 1 as an offset to the one-based USB-stack port number
1645 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1646 * 0 is reserved by USB for default address; (b) Linux's USB stack
1647 * uses always #1 for the root hub of the controller. So USB stack's
1648 * port #1, which is wusb virtual-port #0 has address #2.
1650 * Devices connected under xHCI are not as simple. The host controller
1651 * supports virtualization, so the hardware assigns device addresses and
1652 * the HCD must setup data structures before issuing a set address
1653 * command to the hardware.
1655 static void choose_devnum(struct usb_device *udev)
1658 struct usb_bus *bus = udev->bus;
1660 /* If khubd ever becomes multithreaded, this will need a lock */
1662 devnum = udev->portnum + 1;
1663 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1665 /* Try to allocate the next devnum beginning at
1666 * bus->devnum_next. */
1667 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1670 devnum = find_next_zero_bit(bus->devmap.devicemap,
1672 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1675 set_bit(devnum, bus->devmap.devicemap);
1676 udev->devnum = devnum;
1680 static void release_devnum(struct usb_device *udev)
1682 if (udev->devnum > 0) {
1683 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1688 static void update_devnum(struct usb_device *udev, int devnum)
1690 /* The address for a WUSB device is managed by wusbcore. */
1692 udev->devnum = devnum;
1695 static void hub_free_dev(struct usb_device *udev)
1697 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1699 /* Root hubs aren't real devices, so don't free HCD resources */
1700 if (hcd->driver->free_dev && udev->parent)
1701 hcd->driver->free_dev(hcd, udev);
1705 * usb_disconnect - disconnect a device (usbcore-internal)
1706 * @pdev: pointer to device being disconnected
1707 * Context: !in_interrupt ()
1709 * Something got disconnected. Get rid of it and all of its children.
1711 * If *pdev is a normal device then the parent hub must already be locked.
1712 * If *pdev is a root hub then this routine will acquire the
1713 * usb_bus_list_lock on behalf of the caller.
1715 * Only hub drivers (including virtual root hub drivers for host
1716 * controllers) should ever call this.
1718 * This call is synchronous, and may not be used in an interrupt context.
1720 void usb_disconnect(struct usb_device **pdev)
1722 struct usb_device *udev = *pdev;
1725 /* mark the device as inactive, so any further urb submissions for
1726 * this device (and any of its children) will fail immediately.
1727 * this quiesces everything except pending urbs.
1729 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1730 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1733 usb_lock_device(udev);
1735 /* Free up all the children before we remove this device */
1736 for (i = 0; i < USB_MAXCHILDREN; i++) {
1737 if (udev->children[i])
1738 usb_disconnect(&udev->children[i]);
1741 /* deallocate hcd/hardware state ... nuking all pending urbs and
1742 * cleaning up all state associated with the current configuration
1743 * so that the hardware is now fully quiesced.
1745 dev_dbg (&udev->dev, "unregistering device\n");
1746 usb_disable_device(udev, 0);
1747 usb_hcd_synchronize_unlinks(udev);
1749 usb_remove_ep_devs(&udev->ep0);
1750 usb_unlock_device(udev);
1752 /* Unregister the device. The device driver is responsible
1753 * for de-configuring the device and invoking the remove-device
1754 * notifier chain (used by usbfs and possibly others).
1756 device_del(&udev->dev);
1758 /* Free the device number and delete the parent's children[]
1759 * (or root_hub) pointer.
1761 release_devnum(udev);
1763 /* Avoid races with recursively_mark_NOTATTACHED() */
1764 spin_lock_irq(&device_state_lock);
1766 spin_unlock_irq(&device_state_lock);
1770 put_device(&udev->dev);
1773 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1774 static void show_string(struct usb_device *udev, char *id, char *string)
1778 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1781 static void announce_device(struct usb_device *udev)
1783 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1784 le16_to_cpu(udev->descriptor.idVendor),
1785 le16_to_cpu(udev->descriptor.idProduct));
1786 dev_info(&udev->dev,
1787 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1788 udev->descriptor.iManufacturer,
1789 udev->descriptor.iProduct,
1790 udev->descriptor.iSerialNumber);
1791 show_string(udev, "Product", udev->product);
1792 show_string(udev, "Manufacturer", udev->manufacturer);
1793 show_string(udev, "SerialNumber", udev->serial);
1796 static inline void announce_device(struct usb_device *udev) { }
1799 #ifdef CONFIG_USB_OTG
1800 #include "otg_whitelist.h"
1804 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1805 * @udev: newly addressed device (in ADDRESS state)
1807 * Finish enumeration for On-The-Go devices
1809 static int usb_enumerate_device_otg(struct usb_device *udev)
1813 #ifdef CONFIG_USB_OTG
1815 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1816 * to wake us after we've powered off VBUS; and HNP, switching roles
1817 * "host" to "peripheral". The OTG descriptor helps figure this out.
1819 if (!udev->bus->is_b_host
1821 && udev->parent == udev->bus->root_hub) {
1822 struct usb_otg_descriptor *desc = NULL;
1823 struct usb_bus *bus = udev->bus;
1825 /* descriptor may appear anywhere in config */
1826 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1827 le16_to_cpu(udev->config[0].desc.wTotalLength),
1828 USB_DT_OTG, (void **) &desc) == 0) {
1829 if (desc->bmAttributes & USB_OTG_HNP) {
1830 unsigned port1 = udev->portnum;
1832 dev_info(&udev->dev,
1833 "Dual-Role OTG device on %sHNP port\n",
1834 (port1 == bus->otg_port)
1837 /* enable HNP before suspend, it's simpler */
1838 if (port1 == bus->otg_port)
1839 bus->b_hnp_enable = 1;
1840 err = usb_control_msg(udev,
1841 usb_sndctrlpipe(udev, 0),
1842 USB_REQ_SET_FEATURE, 0,
1844 ? USB_DEVICE_B_HNP_ENABLE
1845 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1846 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1848 /* OTG MESSAGE: report errors here,
1849 * customize to match your product.
1851 dev_info(&udev->dev,
1852 "can't set HNP mode: %d\n",
1854 bus->b_hnp_enable = 0;
1860 if (!is_targeted(udev)) {
1862 /* Maybe it can talk to us, though we can't talk to it.
1863 * (Includes HNP test device.)
1865 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1866 err = usb_port_suspend(udev, PMSG_SUSPEND);
1868 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1880 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1881 * @udev: newly addressed device (in ADDRESS state)
1883 * This is only called by usb_new_device() and usb_authorize_device()
1884 * and FIXME -- all comments that apply to them apply here wrt to
1887 * If the device is WUSB and not authorized, we don't attempt to read
1888 * the string descriptors, as they will be errored out by the device
1889 * until it has been authorized.
1891 static int usb_enumerate_device(struct usb_device *udev)
1895 if (udev->config == NULL) {
1896 err = usb_get_configuration(udev);
1898 dev_err(&udev->dev, "can't read configurations, error %d\n",
1903 if (udev->wusb == 1 && udev->authorized == 0) {
1904 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1905 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1906 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1909 /* read the standard strings and cache them if present */
1910 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1911 udev->manufacturer = usb_cache_string(udev,
1912 udev->descriptor.iManufacturer);
1913 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1915 err = usb_enumerate_device_otg(udev);
1919 usb_detect_interface_quirks(udev);
1926 * usb_new_device - perform initial device setup (usbcore-internal)
1927 * @udev: newly addressed device (in ADDRESS state)
1929 * This is called with devices which have been detected but not fully
1930 * enumerated. The device descriptor is available, but not descriptors
1931 * for any device configuration. The caller must have locked either
1932 * the parent hub (if udev is a normal device) or else the
1933 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1934 * udev has already been installed, but udev is not yet visible through
1935 * sysfs or other filesystem code.
1937 * It will return if the device is configured properly or not. Zero if
1938 * the interface was registered with the driver core; else a negative
1941 * This call is synchronous, and may not be used in an interrupt context.
1943 * Only the hub driver or root-hub registrar should ever call this.
1945 int usb_new_device(struct usb_device *udev)
1950 /* Initialize non-root-hub device wakeup to disabled;
1951 * device (un)configuration controls wakeup capable
1952 * sysfs power/wakeup controls wakeup enabled/disabled
1954 device_init_wakeup(&udev->dev, 0);
1957 /* Tell the runtime-PM framework the device is active */
1958 pm_runtime_set_active(&udev->dev);
1959 pm_runtime_get_noresume(&udev->dev);
1960 pm_runtime_use_autosuspend(&udev->dev);
1961 pm_runtime_enable(&udev->dev);
1963 /* By default, forbid autosuspend for all devices. It will be
1964 * allowed for hubs during binding.
1966 usb_disable_autosuspend(udev);
1968 err = usb_enumerate_device(udev); /* Read descriptors */
1971 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1972 udev->devnum, udev->bus->busnum,
1973 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1974 /* export the usbdev device-node for libusb */
1975 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1976 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1978 /* Tell the world! */
1979 announce_device(udev);
1982 add_device_randomness(udev->serial, strlen(udev->serial));
1984 add_device_randomness(udev->product, strlen(udev->product));
1985 if (udev->manufacturer)
1986 add_device_randomness(udev->manufacturer,
1987 strlen(udev->manufacturer));
1989 device_enable_async_suspend(&udev->dev);
1990 /* Register the device. The device driver is responsible
1991 * for configuring the device and invoking the add-device
1992 * notifier chain (used by usbfs and possibly others).
1994 err = device_add(&udev->dev);
1996 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2000 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2001 usb_mark_last_busy(udev);
2002 pm_runtime_put_sync_autosuspend(&udev->dev);
2006 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2007 pm_runtime_disable(&udev->dev);
2008 pm_runtime_set_suspended(&udev->dev);
2014 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2015 * @usb_dev: USB device
2017 * Move the USB device to a very basic state where interfaces are disabled
2018 * and the device is in fact unconfigured and unusable.
2020 * We share a lock (that we have) with device_del(), so we need to
2023 int usb_deauthorize_device(struct usb_device *usb_dev)
2025 usb_lock_device(usb_dev);
2026 if (usb_dev->authorized == 0)
2027 goto out_unauthorized;
2029 usb_dev->authorized = 0;
2030 usb_set_configuration(usb_dev, -1);
2032 kfree(usb_dev->product);
2033 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2034 kfree(usb_dev->manufacturer);
2035 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2036 kfree(usb_dev->serial);
2037 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2039 usb_destroy_configuration(usb_dev);
2040 usb_dev->descriptor.bNumConfigurations = 0;
2043 usb_unlock_device(usb_dev);
2048 int usb_authorize_device(struct usb_device *usb_dev)
2052 usb_lock_device(usb_dev);
2053 if (usb_dev->authorized == 1)
2054 goto out_authorized;
2056 result = usb_autoresume_device(usb_dev);
2058 dev_err(&usb_dev->dev,
2059 "can't autoresume for authorization: %d\n", result);
2060 goto error_autoresume;
2062 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2064 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2065 "authorization: %d\n", result);
2066 goto error_device_descriptor;
2069 kfree(usb_dev->product);
2070 usb_dev->product = NULL;
2071 kfree(usb_dev->manufacturer);
2072 usb_dev->manufacturer = NULL;
2073 kfree(usb_dev->serial);
2074 usb_dev->serial = NULL;
2076 usb_dev->authorized = 1;
2077 result = usb_enumerate_device(usb_dev);
2079 goto error_enumerate;
2080 /* Choose and set the configuration. This registers the interfaces
2081 * with the driver core and lets interface drivers bind to them.
2083 c = usb_choose_configuration(usb_dev);
2085 result = usb_set_configuration(usb_dev, c);
2087 dev_err(&usb_dev->dev,
2088 "can't set config #%d, error %d\n", c, result);
2089 /* This need not be fatal. The user can try to
2090 * set other configurations. */
2093 dev_info(&usb_dev->dev, "authorized to connect\n");
2096 error_device_descriptor:
2097 usb_autosuspend_device(usb_dev);
2100 usb_unlock_device(usb_dev); // complements locktree
2105 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2106 static unsigned hub_is_wusb(struct usb_hub *hub)
2108 struct usb_hcd *hcd;
2109 if (hub->hdev->parent != NULL) /* not a root hub? */
2111 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2112 return hcd->wireless;
2116 #define PORT_RESET_TRIES 5
2117 #define SET_ADDRESS_TRIES 2
2118 #define GET_DESCRIPTOR_TRIES 2
2119 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2120 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2122 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2123 #define HUB_SHORT_RESET_TIME 10
2124 #define HUB_BH_RESET_TIME 50
2125 #define HUB_LONG_RESET_TIME 200
2126 #define HUB_RESET_TIMEOUT 800
2128 static int hub_port_reset(struct usb_hub *hub, int port1,
2129 struct usb_device *udev, unsigned int delay, bool warm);
2131 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2132 * Port worm reset is required to recover
2134 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2136 return hub_is_superspeed(hub->hdev) &&
2137 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2138 USB_SS_PORT_LS_SS_INACTIVE) ||
2139 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2140 USB_SS_PORT_LS_COMP_MOD)) ;
2143 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2144 struct usb_device *udev, unsigned int delay, bool warm)
2146 int delay_time, ret;
2150 for (delay_time = 0;
2151 delay_time < HUB_RESET_TIMEOUT;
2152 delay_time += delay) {
2153 /* wait to give the device a chance to reset */
2156 /* read and decode port status */
2157 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2161 /* The port state is unknown until the reset completes. */
2162 if ((portstatus & USB_PORT_STAT_RESET))
2165 if (hub_port_warm_reset_required(hub, portstatus))
2168 /* Device went away? */
2169 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2172 /* bomb out completely if the connection bounced. A USB 3.0
2173 * connection may bounce if multiple warm resets were issued,
2174 * but the device may have successfully re-connected. Ignore it.
2176 if (!hub_is_superspeed(hub->hdev) &&
2177 (portchange & USB_PORT_STAT_C_CONNECTION))
2180 if ((portstatus & USB_PORT_STAT_ENABLE)) {
2184 if (hub_is_wusb(hub))
2185 udev->speed = USB_SPEED_WIRELESS;
2186 else if (hub_is_superspeed(hub->hdev))
2187 udev->speed = USB_SPEED_SUPER;
2188 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2189 udev->speed = USB_SPEED_HIGH;
2190 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2191 udev->speed = USB_SPEED_LOW;
2193 udev->speed = USB_SPEED_FULL;
2198 /* switch to the long delay after two short delay failures */
2199 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2200 delay = HUB_LONG_RESET_TIME;
2202 dev_dbg (hub->intfdev,
2203 "port %d not %sreset yet, waiting %dms\n",
2204 port1, warm ? "warm " : "", delay);
2210 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2211 struct usb_device *udev, int *status)
2215 /* TRSTRCY = 10 ms; plus some extra */
2218 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2220 update_devnum(udev, 0);
2221 /* The xHC may think the device is already reset,
2222 * so ignore the status.
2224 if (hcd->driver->reset_device)
2225 hcd->driver->reset_device(hcd, udev);
2230 clear_port_feature(hub->hdev,
2231 port1, USB_PORT_FEAT_C_RESET);
2232 if (hub_is_superspeed(hub->hdev)) {
2233 clear_port_feature(hub->hdev, port1,
2234 USB_PORT_FEAT_C_BH_PORT_RESET);
2235 clear_port_feature(hub->hdev, port1,
2236 USB_PORT_FEAT_C_PORT_LINK_STATE);
2237 clear_port_feature(hub->hdev, port1,
2238 USB_PORT_FEAT_C_CONNECTION);
2241 usb_set_device_state(udev, *status
2242 ? USB_STATE_NOTATTACHED
2243 : USB_STATE_DEFAULT);
2248 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2249 static int hub_port_reset(struct usb_hub *hub, int port1,
2250 struct usb_device *udev, unsigned int delay, bool warm)
2253 u16 portchange, portstatus;
2255 if (!hub_is_superspeed(hub->hdev)) {
2257 dev_err(hub->intfdev, "only USB3 hub support "
2261 /* Block EHCI CF initialization during the port reset.
2262 * Some companion controllers don't like it when they mix.
2264 down_read(&ehci_cf_port_reset_rwsem);
2267 * If the caller hasn't explicitly requested a warm reset,
2268 * double check and see if one is needed.
2270 status = hub_port_status(hub, port1,
2271 &portstatus, &portchange);
2275 if (hub_port_warm_reset_required(hub, portstatus))
2279 /* Reset the port */
2280 for (i = 0; i < PORT_RESET_TRIES; i++) {
2281 status = set_port_feature(hub->hdev, port1, (warm ?
2282 USB_PORT_FEAT_BH_PORT_RESET :
2283 USB_PORT_FEAT_RESET));
2285 dev_err(hub->intfdev,
2286 "cannot %sreset port %d (err = %d)\n",
2287 warm ? "warm " : "", port1, status);
2289 status = hub_port_wait_reset(hub, port1, udev, delay,
2291 if (status && status != -ENOTCONN)
2292 dev_dbg(hub->intfdev,
2293 "port_wait_reset: err = %d\n",
2297 /* Check for disconnect or reset */
2298 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2299 hub_port_finish_reset(hub, port1, udev, &status);
2301 if (!hub_is_superspeed(hub->hdev))
2305 * If a USB 3.0 device migrates from reset to an error
2306 * state, re-issue the warm reset.
2308 if (hub_port_status(hub, port1,
2309 &portstatus, &portchange) < 0)
2312 if (!hub_port_warm_reset_required(hub, portstatus))
2316 * If the port is in SS.Inactive or Compliance Mode, the
2317 * hot or warm reset failed. Try another warm reset.
2320 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2326 dev_dbg (hub->intfdev,
2327 "port %d not enabled, trying %sreset again...\n",
2328 port1, warm ? "warm " : "");
2329 delay = HUB_LONG_RESET_TIME;
2332 dev_err (hub->intfdev,
2333 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2337 if (!hub_is_superspeed(hub->hdev))
2338 up_read(&ehci_cf_port_reset_rwsem);
2343 /* Check if a port is power on */
2344 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2348 if (hub_is_superspeed(hub->hdev)) {
2349 if (portstatus & USB_SS_PORT_STAT_POWER)
2352 if (portstatus & USB_PORT_STAT_POWER)
2361 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2362 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2366 if (hub_is_superspeed(hub->hdev)) {
2367 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2368 == USB_SS_PORT_LS_U3)
2371 if (portstatus & USB_PORT_STAT_SUSPEND)
2378 /* Determine whether the device on a port is ready for a normal resume,
2379 * is ready for a reset-resume, or should be disconnected.
2381 static int check_port_resume_type(struct usb_device *udev,
2382 struct usb_hub *hub, int port1,
2383 int status, unsigned portchange, unsigned portstatus)
2385 /* Is the device still present? */
2386 if (status || port_is_suspended(hub, portstatus) ||
2387 !port_is_power_on(hub, portstatus) ||
2388 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2393 /* Can't do a normal resume if the port isn't enabled,
2394 * so try a reset-resume instead.
2396 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2397 if (udev->persist_enabled)
2398 udev->reset_resume = 1;
2404 dev_dbg(hub->intfdev,
2405 "port %d status %04x.%04x after resume, %d\n",
2406 port1, portchange, portstatus, status);
2407 } else if (udev->reset_resume) {
2409 /* Late port handoff can set status-change bits */
2410 if (portchange & USB_PORT_STAT_C_CONNECTION)
2411 clear_port_feature(hub->hdev, port1,
2412 USB_PORT_FEAT_C_CONNECTION);
2413 if (portchange & USB_PORT_STAT_C_ENABLE)
2414 clear_port_feature(hub->hdev, port1,
2415 USB_PORT_FEAT_C_ENABLE);
2421 #ifdef CONFIG_USB_SUSPEND
2424 * usb_port_suspend - suspend a usb device's upstream port
2425 * @udev: device that's no longer in active use, not a root hub
2426 * Context: must be able to sleep; device not locked; pm locks held
2428 * Suspends a USB device that isn't in active use, conserving power.
2429 * Devices may wake out of a suspend, if anything important happens,
2430 * using the remote wakeup mechanism. They may also be taken out of
2431 * suspend by the host, using usb_port_resume(). It's also routine
2432 * to disconnect devices while they are suspended.
2434 * This only affects the USB hardware for a device; its interfaces
2435 * (and, for hubs, child devices) must already have been suspended.
2437 * Selective port suspend reduces power; most suspended devices draw
2438 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2439 * All devices below the suspended port are also suspended.
2441 * Devices leave suspend state when the host wakes them up. Some devices
2442 * also support "remote wakeup", where the device can activate the USB
2443 * tree above them to deliver data, such as a keypress or packet. In
2444 * some cases, this wakes the USB host.
2446 * Suspending OTG devices may trigger HNP, if that's been enabled
2447 * between a pair of dual-role devices. That will change roles, such
2448 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2450 * Devices on USB hub ports have only one "suspend" state, corresponding
2451 * to ACPI D2, "may cause the device to lose some context".
2452 * State transitions include:
2454 * - suspend, resume ... when the VBUS power link stays live
2455 * - suspend, disconnect ... VBUS lost
2457 * Once VBUS drop breaks the circuit, the port it's using has to go through
2458 * normal re-enumeration procedures, starting with enabling VBUS power.
2459 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2460 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2461 * timer, no SRP, no requests through sysfs.
2463 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2464 * the root hub for their bus goes into global suspend ... so we don't
2465 * (falsely) update the device power state to say it suspended.
2467 * Returns 0 on success, else negative errno.
2469 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2471 struct usb_hub *hub = hdev_to_hub(udev->parent);
2472 int port1 = udev->portnum;
2475 /* enable remote wakeup when appropriate; this lets the device
2476 * wake up the upstream hub (including maybe the root hub).
2478 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2479 * we don't explicitly enable it here.
2481 if (udev->do_remote_wakeup) {
2482 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2483 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2484 USB_DEVICE_REMOTE_WAKEUP, 0,
2486 USB_CTRL_SET_TIMEOUT);
2488 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2490 /* bail if autosuspend is requested */
2491 if (PMSG_IS_AUTO(msg))
2496 /* disable USB2 hardware LPM */
2497 if (udev->usb2_hw_lpm_enabled == 1)
2498 usb_set_usb2_hardware_lpm(udev, 0);
2501 if (hub_is_superspeed(hub->hdev))
2502 status = set_port_feature(hub->hdev,
2503 port1 | (USB_SS_PORT_LS_U3 << 3),
2504 USB_PORT_FEAT_LINK_STATE);
2506 status = set_port_feature(hub->hdev, port1,
2507 USB_PORT_FEAT_SUSPEND);
2509 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2511 /* paranoia: "should not happen" */
2512 if (udev->do_remote_wakeup)
2513 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2514 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2515 USB_DEVICE_REMOTE_WAKEUP, 0,
2517 USB_CTRL_SET_TIMEOUT);
2519 /* Try to enable USB2 hardware LPM again */
2520 if (udev->usb2_hw_lpm_capable == 1)
2521 usb_set_usb2_hardware_lpm(udev, 1);
2523 /* System sleep transitions should never fail */
2524 if (!PMSG_IS_AUTO(msg))
2527 /* device has up to 10 msec to fully suspend */
2528 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2529 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2530 udev->do_remote_wakeup);
2531 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2534 usb_mark_last_busy(hub->hdev);
2539 * If the USB "suspend" state is in use (rather than "global suspend"),
2540 * many devices will be individually taken out of suspend state using
2541 * special "resume" signaling. This routine kicks in shortly after
2542 * hardware resume signaling is finished, either because of selective
2543 * resume (by host) or remote wakeup (by device) ... now see what changed
2544 * in the tree that's rooted at this device.
2546 * If @udev->reset_resume is set then the device is reset before the
2547 * status check is done.
2549 static int finish_port_resume(struct usb_device *udev)
2554 /* caller owns the udev device lock */
2555 dev_dbg(&udev->dev, "%s\n",
2556 udev->reset_resume ? "finish reset-resume" : "finish resume");
2558 /* usb ch9 identifies four variants of SUSPENDED, based on what
2559 * state the device resumes to. Linux currently won't see the
2560 * first two on the host side; they'd be inside hub_port_init()
2561 * during many timeouts, but khubd can't suspend until later.
2563 usb_set_device_state(udev, udev->actconfig
2564 ? USB_STATE_CONFIGURED
2565 : USB_STATE_ADDRESS);
2567 /* 10.5.4.5 says not to reset a suspended port if the attached
2568 * device is enabled for remote wakeup. Hence the reset
2569 * operation is carried out here, after the port has been
2572 if (udev->reset_resume)
2574 status = usb_reset_and_verify_device(udev);
2576 /* 10.5.4.5 says be sure devices in the tree are still there.
2577 * For now let's assume the device didn't go crazy on resume,
2578 * and device drivers will know about any resume quirks.
2582 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2584 status = (status > 0 ? 0 : -ENODEV);
2586 /* If a normal resume failed, try doing a reset-resume */
2587 if (status && !udev->reset_resume && udev->persist_enabled) {
2588 dev_dbg(&udev->dev, "retry with reset-resume\n");
2589 udev->reset_resume = 1;
2590 goto retry_reset_resume;
2595 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2598 * There are a few quirky devices which violate the standard
2599 * by claiming to have remote wakeup enabled after a reset,
2600 * which crash if the feature is cleared, hence check for
2601 * udev->reset_resume
2603 } else if (udev->actconfig && !udev->reset_resume) {
2604 le16_to_cpus(&devstatus);
2605 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2606 status = usb_control_msg(udev,
2607 usb_sndctrlpipe(udev, 0),
2608 USB_REQ_CLEAR_FEATURE,
2610 USB_DEVICE_REMOTE_WAKEUP, 0,
2612 USB_CTRL_SET_TIMEOUT);
2615 "disable remote wakeup, status %d\n",
2624 * usb_port_resume - re-activate a suspended usb device's upstream port
2625 * @udev: device to re-activate, not a root hub
2626 * Context: must be able to sleep; device not locked; pm locks held
2628 * This will re-activate the suspended device, increasing power usage
2629 * while letting drivers communicate again with its endpoints.
2630 * USB resume explicitly guarantees that the power session between
2631 * the host and the device is the same as it was when the device
2634 * If @udev->reset_resume is set then this routine won't check that the
2635 * port is still enabled. Furthermore, finish_port_resume() above will
2636 * reset @udev. The end result is that a broken power session can be
2637 * recovered and @udev will appear to persist across a loss of VBUS power.
2639 * For example, if a host controller doesn't maintain VBUS suspend current
2640 * during a system sleep or is reset when the system wakes up, all the USB
2641 * power sessions below it will be broken. This is especially troublesome
2642 * for mass-storage devices containing mounted filesystems, since the
2643 * device will appear to have disconnected and all the memory mappings
2644 * to it will be lost. Using the USB_PERSIST facility, the device can be
2645 * made to appear as if it had not disconnected.
2647 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2648 * every effort to insure that the same device is present after the
2649 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2650 * quite possible for a device to remain unaltered but its media to be
2651 * changed. If the user replaces a flash memory card while the system is
2652 * asleep, he will have only himself to blame when the filesystem on the
2653 * new card is corrupted and the system crashes.
2655 * Returns 0 on success, else negative errno.
2657 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2659 struct usb_hub *hub = hdev_to_hub(udev->parent);
2660 int port1 = udev->portnum;
2662 u16 portchange, portstatus;
2664 /* Skip the initial Clear-Suspend step for a remote wakeup */
2665 status = hub_port_status(hub, port1, &portstatus, &portchange);
2666 if (status == 0 && !port_is_suspended(hub, portstatus))
2667 goto SuspendCleared;
2669 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2671 set_bit(port1, hub->busy_bits);
2673 /* see 7.1.7.7; affects power usage, but not budgeting */
2674 if (hub_is_superspeed(hub->hdev))
2675 status = set_port_feature(hub->hdev,
2676 port1 | (USB_SS_PORT_LS_U0 << 3),
2677 USB_PORT_FEAT_LINK_STATE);
2679 status = clear_port_feature(hub->hdev,
2680 port1, USB_PORT_FEAT_SUSPEND);
2682 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2685 /* drive resume for at least 20 msec */
2686 dev_dbg(&udev->dev, "usb %sresume\n",
2687 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2690 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2691 * stop resume signaling. Then finish the resume
2694 status = hub_port_status(hub, port1, &portstatus, &portchange);
2696 /* TRSMRCY = 10 msec */
2702 if (hub_is_superspeed(hub->hdev)) {
2703 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2704 clear_port_feature(hub->hdev, port1,
2705 USB_PORT_FEAT_C_PORT_LINK_STATE);
2707 if (portchange & USB_PORT_STAT_C_SUSPEND)
2708 clear_port_feature(hub->hdev, port1,
2709 USB_PORT_FEAT_C_SUSPEND);
2713 clear_bit(port1, hub->busy_bits);
2715 status = check_port_resume_type(udev,
2716 hub, port1, status, portchange, portstatus);
2718 status = finish_port_resume(udev);
2720 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2721 hub_port_logical_disconnect(hub, port1);
2723 /* Try to enable USB2 hardware LPM */
2724 if (udev->usb2_hw_lpm_capable == 1)
2725 usb_set_usb2_hardware_lpm(udev, 1);
2731 /* caller has locked udev */
2732 int usb_remote_wakeup(struct usb_device *udev)
2736 if (udev->state == USB_STATE_SUSPENDED) {
2737 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2738 status = usb_autoresume_device(udev);
2740 /* Let the drivers do their thing, then... */
2741 usb_autosuspend_device(udev);
2747 #else /* CONFIG_USB_SUSPEND */
2749 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2751 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2756 /* However we may need to do a reset-resume */
2758 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2760 struct usb_hub *hub = hdev_to_hub(udev->parent);
2761 int port1 = udev->portnum;
2763 u16 portchange, portstatus;
2765 status = hub_port_status(hub, port1, &portstatus, &portchange);
2766 status = check_port_resume_type(udev,
2767 hub, port1, status, portchange, portstatus);
2770 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2771 hub_port_logical_disconnect(hub, port1);
2772 } else if (udev->reset_resume) {
2773 dev_dbg(&udev->dev, "reset-resume\n");
2774 status = usb_reset_and_verify_device(udev);
2781 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2783 struct usb_hub *hub = usb_get_intfdata (intf);
2784 struct usb_device *hdev = hub->hdev;
2787 /* Warn if children aren't already suspended */
2788 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2789 struct usb_device *udev;
2791 udev = hdev->children [port1-1];
2792 if (udev && udev->can_submit) {
2793 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2794 if (PMSG_IS_AUTO(msg))
2799 dev_dbg(&intf->dev, "%s\n", __func__);
2801 /* stop khubd and related activity */
2802 hub_quiesce(hub, HUB_SUSPEND);
2806 static int hub_resume(struct usb_interface *intf)
2808 struct usb_hub *hub = usb_get_intfdata(intf);
2810 dev_dbg(&intf->dev, "%s\n", __func__);
2811 hub_activate(hub, HUB_RESUME);
2815 static int hub_reset_resume(struct usb_interface *intf)
2817 struct usb_hub *hub = usb_get_intfdata(intf);
2819 dev_dbg(&intf->dev, "%s\n", __func__);
2820 hub_activate(hub, HUB_RESET_RESUME);
2825 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2826 * @rhdev: struct usb_device for the root hub
2828 * The USB host controller driver calls this function when its root hub
2829 * is resumed and Vbus power has been interrupted or the controller
2830 * has been reset. The routine marks @rhdev as having lost power.
2831 * When the hub driver is resumed it will take notice and carry out
2832 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2833 * the others will be disconnected.
2835 void usb_root_hub_lost_power(struct usb_device *rhdev)
2837 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2838 rhdev->reset_resume = 1;
2840 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2842 #else /* CONFIG_PM */
2844 #define hub_suspend NULL
2845 #define hub_resume NULL
2846 #define hub_reset_resume NULL
2850 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2852 * Between connect detection and reset signaling there must be a delay
2853 * of 100ms at least for debounce and power-settling. The corresponding
2854 * timer shall restart whenever the downstream port detects a disconnect.
2856 * Apparently there are some bluetooth and irda-dongles and a number of
2857 * low-speed devices for which this debounce period may last over a second.
2858 * Not covered by the spec - but easy to deal with.
2860 * This implementation uses a 1500ms total debounce timeout; if the
2861 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2862 * every 25ms for transient disconnects. When the port status has been
2863 * unchanged for 100ms it returns the port status.
2865 static int hub_port_debounce(struct usb_hub *hub, int port1)
2868 int total_time, stable_time = 0;
2869 u16 portchange, portstatus;
2870 unsigned connection = 0xffff;
2872 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2873 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2877 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2878 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2879 stable_time += HUB_DEBOUNCE_STEP;
2880 if (stable_time >= HUB_DEBOUNCE_STABLE)
2884 connection = portstatus & USB_PORT_STAT_CONNECTION;
2887 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2888 clear_port_feature(hub->hdev, port1,
2889 USB_PORT_FEAT_C_CONNECTION);
2892 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2894 msleep(HUB_DEBOUNCE_STEP);
2897 dev_dbg (hub->intfdev,
2898 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2899 port1, total_time, stable_time, portstatus);
2901 if (stable_time < HUB_DEBOUNCE_STABLE)
2906 void usb_ep0_reinit(struct usb_device *udev)
2908 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2909 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2910 usb_enable_endpoint(udev, &udev->ep0, true);
2912 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2914 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2915 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2917 static int hub_set_address(struct usb_device *udev, int devnum)
2920 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2923 * The host controller will choose the device address,
2924 * instead of the core having chosen it earlier
2926 if (!hcd->driver->address_device && devnum <= 1)
2928 if (udev->state == USB_STATE_ADDRESS)
2930 if (udev->state != USB_STATE_DEFAULT)
2932 if (hcd->driver->address_device)
2933 retval = hcd->driver->address_device(hcd, udev);
2935 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2936 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2937 NULL, 0, USB_CTRL_SET_TIMEOUT);
2939 update_devnum(udev, devnum);
2940 /* Device now using proper address. */
2941 usb_set_device_state(udev, USB_STATE_ADDRESS);
2942 usb_ep0_reinit(udev);
2947 /* Reset device, (re)assign address, get device descriptor.
2948 * Device connection must be stable, no more debouncing needed.
2949 * Returns device in USB_STATE_ADDRESS, except on error.
2951 * If this is called for an already-existing device (as part of
2952 * usb_reset_and_verify_device), the caller must own the device lock. For a
2953 * newly detected device that is not accessible through any global
2954 * pointers, it's not necessary to lock the device.
2957 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2960 static DEFINE_MUTEX(usb_address0_mutex);
2962 struct usb_device *hdev = hub->hdev;
2963 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2965 unsigned delay = HUB_SHORT_RESET_TIME;
2966 enum usb_device_speed oldspeed = udev->speed;
2968 int devnum = udev->devnum;
2970 /* root hub ports have a slightly longer reset period
2971 * (from USB 2.0 spec, section 7.1.7.5)
2973 if (!hdev->parent) {
2974 delay = HUB_ROOT_RESET_TIME;
2975 if (port1 == hdev->bus->otg_port)
2976 hdev->bus->b_hnp_enable = 0;
2979 /* Some low speed devices have problems with the quick delay, so */
2980 /* be a bit pessimistic with those devices. RHbug #23670 */
2981 if (oldspeed == USB_SPEED_LOW)
2982 delay = HUB_LONG_RESET_TIME;
2984 mutex_lock(&usb_address0_mutex);
2986 /* Reset the device; full speed may morph to high speed */
2987 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2988 retval = hub_port_reset(hub, port1, udev, delay, false);
2989 if (retval < 0) /* error or disconnect */
2991 /* success, speed is known */
2995 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2996 dev_dbg(&udev->dev, "device reset changed speed!\n");
2999 oldspeed = udev->speed;
3001 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3002 * it's fixed size except for full speed devices.
3003 * For Wireless USB devices, ep0 max packet is always 512 (tho
3004 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3006 switch (udev->speed) {
3007 case USB_SPEED_SUPER:
3008 case USB_SPEED_WIRELESS: /* fixed at 512 */
3009 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3011 case USB_SPEED_HIGH: /* fixed at 64 */
3012 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3014 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3015 /* to determine the ep0 maxpacket size, try to read
3016 * the device descriptor to get bMaxPacketSize0 and
3017 * then correct our initial guess.
3019 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3021 case USB_SPEED_LOW: /* fixed at 8 */
3022 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3028 if (udev->speed == USB_SPEED_WIRELESS)
3029 speed = "variable speed Wireless";
3031 speed = usb_speed_string(udev->speed);
3033 if (udev->speed != USB_SPEED_SUPER)
3034 dev_info(&udev->dev,
3035 "%s %s USB device number %d using %s\n",
3036 (udev->config) ? "reset" : "new", speed,
3037 devnum, udev->bus->controller->driver->name);
3039 /* Set up TT records, if needed */
3041 udev->tt = hdev->tt;
3042 udev->ttport = hdev->ttport;
3043 } else if (udev->speed != USB_SPEED_HIGH
3044 && hdev->speed == USB_SPEED_HIGH) {
3046 dev_err(&udev->dev, "parent hub has no TT\n");
3050 udev->tt = &hub->tt;
3051 udev->ttport = port1;
3054 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3055 * Because device hardware and firmware is sometimes buggy in
3056 * this area, and this is how Linux has done it for ages.
3057 * Change it cautiously.
3059 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3060 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3061 * so it may help with some non-standards-compliant devices.
3062 * Otherwise we start with SET_ADDRESS and then try to read the
3063 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3066 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3067 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3068 struct usb_device_descriptor *buf;
3071 #define GET_DESCRIPTOR_BUFSIZE 64
3072 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3078 /* Retry on all errors; some devices are flakey.
3079 * 255 is for WUSB devices, we actually need to use
3080 * 512 (WUSB1.0[4.8.1]).
3082 for (j = 0; j < 3; ++j) {
3083 buf->bMaxPacketSize0 = 0;
3084 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3085 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3086 USB_DT_DEVICE << 8, 0,
3087 buf, GET_DESCRIPTOR_BUFSIZE,
3088 initial_descriptor_timeout);
3089 switch (buf->bMaxPacketSize0) {
3090 case 8: case 16: case 32: case 64: case 255:
3091 if (buf->bDescriptorType ==
3105 udev->descriptor.bMaxPacketSize0 =
3106 buf->bMaxPacketSize0;
3109 retval = hub_port_reset(hub, port1, udev, delay, false);
3110 if (retval < 0) /* error or disconnect */
3112 if (oldspeed != udev->speed) {
3114 "device reset changed speed!\n");
3120 "device descriptor read/64, error %d\n",
3125 #undef GET_DESCRIPTOR_BUFSIZE
3129 * If device is WUSB, we already assigned an
3130 * unauthorized address in the Connect Ack sequence;
3131 * authorization will assign the final address.
3133 if (udev->wusb == 0) {
3134 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3135 retval = hub_set_address(udev, devnum);
3142 "device not accepting address %d, error %d\n",
3146 if (udev->speed == USB_SPEED_SUPER) {
3147 devnum = udev->devnum;
3148 dev_info(&udev->dev,
3149 "%s SuperSpeed USB device number %d using %s\n",
3150 (udev->config) ? "reset" : "new",
3151 devnum, udev->bus->controller->driver->name);
3154 /* cope with hardware quirkiness:
3155 * - let SET_ADDRESS settle, some device hardware wants it
3156 * - read ep0 maxpacket even for high and low speed,
3159 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3163 retval = usb_get_device_descriptor(udev, 8);
3166 "device descriptor read/8, error %d\n",
3179 * Some superspeed devices have finished the link training process
3180 * and attached to a superspeed hub port, but the device descriptor
3181 * got from those devices show they aren't superspeed devices. Warm
3182 * reset the port attached by the devices can fix them.
3184 if ((udev->speed == USB_SPEED_SUPER) &&
3185 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3186 dev_err(&udev->dev, "got a wrong device descriptor, "
3187 "warm reset device\n");
3188 hub_port_reset(hub, port1, udev,
3189 HUB_BH_RESET_TIME, true);
3194 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3195 udev->speed == USB_SPEED_SUPER)
3198 i = udev->descriptor.bMaxPacketSize0;
3199 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3200 if (udev->speed == USB_SPEED_LOW ||
3201 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3202 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3206 if (udev->speed == USB_SPEED_FULL)
3207 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3209 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3210 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3211 usb_ep0_reinit(udev);
3214 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3215 if (retval < (signed)sizeof(udev->descriptor)) {
3216 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3223 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3224 retval = usb_get_bos_descriptor(udev);
3226 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3227 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3228 udev->lpm_capable = 1;
3233 /* notify HCD that we have a device connected and addressed */
3234 if (hcd->driver->update_device)
3235 hcd->driver->update_device(hcd, udev);
3238 hub_port_disable(hub, port1, 0);
3239 update_devnum(udev, devnum); /* for disconnect processing */
3241 mutex_unlock(&usb_address0_mutex);
3246 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3248 struct usb_qualifier_descriptor *qual;
3251 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3255 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3256 qual, sizeof *qual);
3257 if (status == sizeof *qual) {
3258 dev_info(&udev->dev, "not running at top speed; "
3259 "connect to a high speed hub\n");
3260 /* hub LEDs are probably harder to miss than syslog */
3261 if (hub->has_indicators) {
3262 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3263 schedule_delayed_work (&hub->leds, 0);
3270 hub_power_remaining (struct usb_hub *hub)
3272 struct usb_device *hdev = hub->hdev;
3276 if (!hub->limited_power)
3279 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3280 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3281 struct usb_device *udev = hdev->children[port1 - 1];
3287 /* Unconfigured devices may not use more than 100mA,
3288 * or 8mA for OTG ports */
3289 if (udev->actconfig)
3290 delta = udev->actconfig->desc.bMaxPower * 2;
3291 else if (port1 != udev->bus->otg_port || hdev->parent)
3295 if (delta > hub->mA_per_port)
3296 dev_warn(&udev->dev,
3297 "%dmA is over %umA budget for port %d!\n",
3298 delta, hub->mA_per_port, port1);
3301 if (remaining < 0) {
3302 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3309 /* Handle physical or logical connection change events.
3310 * This routine is called when:
3311 * a port connection-change occurs;
3312 * a port enable-change occurs (often caused by EMI);
3313 * usb_reset_and_verify_device() encounters changed descriptors (as from
3314 * a firmware download)
3315 * caller already locked the hub
3317 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3318 u16 portstatus, u16 portchange)
3320 struct usb_device *hdev = hub->hdev;
3321 struct device *hub_dev = hub->intfdev;
3322 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3323 unsigned wHubCharacteristics =
3324 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3325 struct usb_device *udev;
3329 "port %d, status %04x, change %04x, %s\n",
3330 port1, portstatus, portchange, portspeed(hub, portstatus));
3332 if (hub->has_indicators) {
3333 set_port_led(hub, port1, HUB_LED_AUTO);
3334 hub->indicator[port1-1] = INDICATOR_AUTO;
3337 #ifdef CONFIG_USB_OTG
3338 /* during HNP, don't repeat the debounce */
3339 if (hdev->bus->is_b_host)
3340 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3341 USB_PORT_STAT_C_ENABLE);
3344 /* Try to resuscitate an existing device */
3345 udev = hdev->children[port1-1];
3346 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3347 udev->state != USB_STATE_NOTATTACHED) {
3348 usb_lock_device(udev);
3349 if (portstatus & USB_PORT_STAT_ENABLE) {
3350 status = 0; /* Nothing to do */
3352 #ifdef CONFIG_USB_SUSPEND
3353 } else if (udev->state == USB_STATE_SUSPENDED &&
3354 udev->persist_enabled) {
3355 /* For a suspended device, treat this as a
3356 * remote wakeup event.
3358 status = usb_remote_wakeup(udev);
3362 status = -ENODEV; /* Don't resuscitate */
3364 usb_unlock_device(udev);
3367 clear_bit(port1, hub->change_bits);
3372 /* Disconnect any existing devices under this port */
3374 usb_disconnect(&hdev->children[port1-1]);
3375 clear_bit(port1, hub->change_bits);
3377 /* We can forget about a "removed" device when there's a physical
3378 * disconnect or the connect status changes.
3380 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3381 (portchange & USB_PORT_STAT_C_CONNECTION))
3382 clear_bit(port1, hub->removed_bits);
3384 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3385 USB_PORT_STAT_C_ENABLE)) {
3386 status = hub_port_debounce(hub, port1);
3388 if (printk_ratelimit())
3389 dev_err(hub_dev, "connect-debounce failed, "
3390 "port %d disabled\n", port1);
3391 portstatus &= ~USB_PORT_STAT_CONNECTION;
3393 portstatus = status;
3397 /* Return now if debouncing failed or nothing is connected or
3398 * the device was "removed".
3400 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3401 test_bit(port1, hub->removed_bits)) {
3403 /* maybe switch power back on (e.g. root hub was reset) */
3404 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3405 && !port_is_power_on(hub, portstatus))
3406 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3408 if (portstatus & USB_PORT_STAT_ENABLE)
3413 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3415 /* reallocate for each attempt, since references
3416 * to the previous one can escape in various ways
3418 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3421 "couldn't allocate port %d usb_device\n",
3426 usb_set_device_state(udev, USB_STATE_POWERED);
3427 udev->bus_mA = hub->mA_per_port;
3428 udev->level = hdev->level + 1;
3429 udev->wusb = hub_is_wusb(hub);
3431 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3432 if (hub_is_superspeed(hub->hdev))
3433 udev->speed = USB_SPEED_SUPER;
3435 udev->speed = USB_SPEED_UNKNOWN;
3437 choose_devnum(udev);
3438 if (udev->devnum <= 0) {
3439 status = -ENOTCONN; /* Don't retry */
3443 /* reset (non-USB 3.0 devices) and get descriptor */
3444 status = hub_port_init(hub, udev, port1, i);
3448 usb_detect_quirks(udev);
3449 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3452 /* consecutive bus-powered hubs aren't reliable; they can
3453 * violate the voltage drop budget. if the new child has
3454 * a "powered" LED, users should notice we didn't enable it
3455 * (without reading syslog), even without per-port LEDs
3458 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3459 && udev->bus_mA <= 100) {
3462 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3465 dev_dbg(&udev->dev, "get status %d ?\n", status);
3468 le16_to_cpus(&devstat);
3469 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3471 "can't connect bus-powered hub "
3473 if (hub->has_indicators) {
3474 hub->indicator[port1-1] =
3475 INDICATOR_AMBER_BLINK;
3476 schedule_delayed_work (&hub->leds, 0);
3478 status = -ENOTCONN; /* Don't retry */
3483 /* check for devices running slower than they could */
3484 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3485 && udev->speed == USB_SPEED_FULL
3486 && highspeed_hubs != 0)
3487 check_highspeed (hub, udev, port1);
3489 /* Store the parent's children[] pointer. At this point
3490 * udev becomes globally accessible, although presumably
3491 * no one will look at it until hdev is unlocked.
3495 /* We mustn't add new devices if the parent hub has
3496 * been disconnected; we would race with the
3497 * recursively_mark_NOTATTACHED() routine.
3499 spin_lock_irq(&device_state_lock);
3500 if (hdev->state == USB_STATE_NOTATTACHED)
3503 hdev->children[port1-1] = udev;
3504 spin_unlock_irq(&device_state_lock);
3506 /* Run it through the hoops (find a driver, etc) */
3508 status = usb_new_device(udev);
3510 spin_lock_irq(&device_state_lock);
3511 hdev->children[port1-1] = NULL;
3512 spin_unlock_irq(&device_state_lock);
3519 status = hub_power_remaining(hub);
3521 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3526 hub_port_disable(hub, port1, 1);
3528 usb_ep0_reinit(udev);
3529 release_devnum(udev);
3532 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3535 if (hub->hdev->parent ||
3536 !hcd->driver->port_handed_over ||
3537 !(hcd->driver->port_handed_over)(hcd, port1))
3538 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3542 hub_port_disable(hub, port1, 1);
3543 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3544 hcd->driver->relinquish_port(hcd, port1);
3547 static void hub_events(void)
3549 struct list_head *tmp;
3550 struct usb_device *hdev;
3551 struct usb_interface *intf;
3552 struct usb_hub *hub;
3553 struct device *hub_dev;
3562 * We restart the list every time to avoid a deadlock with
3563 * deleting hubs downstream from this one. This should be
3564 * safe since we delete the hub from the event list.
3565 * Not the most efficient, but avoids deadlocks.
3569 /* Grab the first entry at the beginning of the list */
3570 spin_lock_irq(&hub_event_lock);
3571 if (list_empty(&hub_event_list)) {
3572 spin_unlock_irq(&hub_event_lock);
3576 tmp = hub_event_list.next;
3579 hub = list_entry(tmp, struct usb_hub, event_list);
3580 kref_get(&hub->kref);
3581 spin_unlock_irq(&hub_event_lock);
3584 hub_dev = hub->intfdev;
3585 intf = to_usb_interface(hub_dev);
3586 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3587 hdev->state, hub->descriptor
3588 ? hub->descriptor->bNbrPorts
3590 /* NOTE: expects max 15 ports... */
3591 (u16) hub->change_bits[0],
3592 (u16) hub->event_bits[0]);
3594 /* Lock the device, then check to see if we were
3595 * disconnected while waiting for the lock to succeed. */
3596 usb_lock_device(hdev);
3597 if (unlikely(hub->disconnected))
3598 goto loop_disconnected;
3600 /* If the hub has died, clean up after it */
3601 if (hdev->state == USB_STATE_NOTATTACHED) {
3602 hub->error = -ENODEV;
3603 hub_quiesce(hub, HUB_DISCONNECT);
3608 ret = usb_autopm_get_interface(intf);
3610 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3614 /* If this is an inactive hub, do nothing */
3619 dev_dbg (hub_dev, "resetting for error %d\n",
3622 ret = usb_reset_device(hdev);
3625 "error resetting hub: %d\n", ret);
3633 /* deal with port status changes */
3634 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3635 if (test_bit(i, hub->busy_bits))
3637 connect_change = test_bit(i, hub->change_bits);
3638 if (!test_and_clear_bit(i, hub->event_bits) &&
3642 ret = hub_port_status(hub, i,
3643 &portstatus, &portchange);
3647 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3648 clear_port_feature(hdev, i,
3649 USB_PORT_FEAT_C_CONNECTION);
3653 if (portchange & USB_PORT_STAT_C_ENABLE) {
3654 if (!connect_change)
3656 "port %d enable change, "
3659 clear_port_feature(hdev, i,
3660 USB_PORT_FEAT_C_ENABLE);
3663 * EM interference sometimes causes badly
3664 * shielded USB devices to be shutdown by
3665 * the hub, this hack enables them again.
3666 * Works at least with mouse driver.
3668 if (!(portstatus & USB_PORT_STAT_ENABLE)
3670 && hdev->children[i-1]) {
3673 "disabled by hub (EMI?), "
3680 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3681 struct usb_device *udev;
3683 clear_port_feature(hdev, i,
3684 USB_PORT_FEAT_C_SUSPEND);
3685 udev = hdev->children[i-1];
3687 /* TRSMRCY = 10 msec */
3690 usb_lock_device(udev);
3691 ret = usb_remote_wakeup(hdev->
3693 usb_unlock_device(udev);
3698 hub_port_disable(hub, i, 1);
3701 "resume on port %d, status %d\n",
3705 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3709 dev_dbg(hub_dev, "over-current change on port "
3711 clear_port_feature(hdev, i,
3712 USB_PORT_FEAT_C_OVER_CURRENT);
3713 msleep(100); /* Cool down */
3714 hub_power_on(hub, true);
3715 hub_port_status(hub, i, &status, &unused);
3716 if (status & USB_PORT_STAT_OVERCURRENT)
3717 dev_err(hub_dev, "over-current "
3718 "condition on port %d\n", i);
3721 if (portchange & USB_PORT_STAT_C_RESET) {
3723 "reset change on port %d\n",
3725 clear_port_feature(hdev, i,
3726 USB_PORT_FEAT_C_RESET);
3728 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3729 hub_is_superspeed(hub->hdev)) {
3731 "warm reset change on port %d\n",
3733 clear_port_feature(hdev, i,
3734 USB_PORT_FEAT_C_BH_PORT_RESET);
3736 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3737 clear_port_feature(hub->hdev, i,
3738 USB_PORT_FEAT_C_PORT_LINK_STATE);
3740 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3742 "config error on port %d\n",
3744 clear_port_feature(hub->hdev, i,
3745 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3748 /* Warm reset a USB3 protocol port if it's in
3749 * SS.Inactive state.
3751 if (hub_port_warm_reset_required(hub, portstatus)) {
3753 struct usb_device *udev =
3754 hub->hdev->children[i - 1];
3756 dev_dbg(hub_dev, "warm reset port %d\n", i);
3758 !(portstatus & USB_PORT_STAT_CONNECTION) ||
3759 udev->state == USB_STATE_NOTATTACHED) {
3760 status = hub_port_reset(hub, i,
3761 NULL, HUB_BH_RESET_TIME,
3764 hub_port_disable(hub, i, 1);
3766 usb_lock_device(udev);
3767 status = usb_reset_device(udev);
3768 usb_unlock_device(udev);
3774 hub_port_connect_change(hub, i,
3775 portstatus, portchange);
3778 /* deal with hub status changes */
3779 if (test_and_clear_bit(0, hub->event_bits) == 0)
3781 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3782 dev_err (hub_dev, "get_hub_status failed\n");
3784 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3785 dev_dbg (hub_dev, "power change\n");
3786 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3787 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3788 /* FIXME: Is this always true? */
3789 hub->limited_power = 1;
3791 hub->limited_power = 0;
3793 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3797 dev_dbg(hub_dev, "over-current change\n");
3798 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3799 msleep(500); /* Cool down */
3800 hub_power_on(hub, true);
3801 hub_hub_status(hub, &status, &unused);
3802 if (status & HUB_STATUS_OVERCURRENT)
3803 dev_err(hub_dev, "over-current "
3809 /* Balance the usb_autopm_get_interface() above */
3810 usb_autopm_put_interface_no_suspend(intf);
3812 /* Balance the usb_autopm_get_interface_no_resume() in
3813 * kick_khubd() and allow autosuspend.
3815 usb_autopm_put_interface(intf);
3817 usb_unlock_device(hdev);
3818 kref_put(&hub->kref, hub_release);
3820 } /* end while (1) */
3823 static int hub_thread(void *__unused)
3825 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3826 * port handover. Otherwise it might see that a full-speed device
3827 * was gone before the EHCI controller had handed its port over to
3828 * the companion full-speed controller.
3834 wait_event_freezable(khubd_wait,
3835 !list_empty(&hub_event_list) ||
3836 kthread_should_stop());
3837 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3839 pr_debug("%s: khubd exiting\n", usbcore_name);
3843 static const struct usb_device_id hub_id_table[] = {
3844 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3845 .bDeviceClass = USB_CLASS_HUB},
3846 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3847 .bInterfaceClass = USB_CLASS_HUB},
3848 { } /* Terminating entry */
3851 MODULE_DEVICE_TABLE (usb, hub_id_table);
3853 static struct usb_driver hub_driver = {
3856 .disconnect = hub_disconnect,
3857 .suspend = hub_suspend,
3858 .resume = hub_resume,
3859 .reset_resume = hub_reset_resume,
3860 .pre_reset = hub_pre_reset,
3861 .post_reset = hub_post_reset,
3862 .unlocked_ioctl = hub_ioctl,
3863 .id_table = hub_id_table,
3864 .supports_autosuspend = 1,
3867 int usb_hub_init(void)
3869 if (usb_register(&hub_driver) < 0) {
3870 printk(KERN_ERR "%s: can't register hub driver\n",
3875 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3876 if (!IS_ERR(khubd_task))
3879 /* Fall through if kernel_thread failed */
3880 usb_deregister(&hub_driver);
3881 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3886 void usb_hub_cleanup(void)
3888 kthread_stop(khubd_task);
3891 * Hub resources are freed for us by usb_deregister. It calls
3892 * usb_driver_purge on every device which in turn calls that
3893 * devices disconnect function if it is using this driver.
3894 * The hub_disconnect function takes care of releasing the
3895 * individual hub resources. -greg
3897 usb_deregister(&hub_driver);
3898 } /* usb_hub_cleanup() */
3900 static int descriptors_changed(struct usb_device *udev,
3901 struct usb_device_descriptor *old_device_descriptor)
3905 unsigned serial_len = 0;
3907 unsigned old_length;
3911 if (memcmp(&udev->descriptor, old_device_descriptor,
3912 sizeof(*old_device_descriptor)) != 0)
3915 /* Since the idVendor, idProduct, and bcdDevice values in the
3916 * device descriptor haven't changed, we will assume the
3917 * Manufacturer and Product strings haven't changed either.
3918 * But the SerialNumber string could be different (e.g., a
3919 * different flash card of the same brand).
3922 serial_len = strlen(udev->serial) + 1;
3925 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3926 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3927 len = max(len, old_length);
3930 buf = kmalloc(len, GFP_NOIO);
3932 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3933 /* assume the worst */
3936 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3937 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3938 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3940 if (length != old_length) {
3941 dev_dbg(&udev->dev, "config index %d, error %d\n",
3946 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3948 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3950 ((struct usb_config_descriptor *) buf)->
3951 bConfigurationValue);
3957 if (!changed && serial_len) {
3958 length = usb_string(udev, udev->descriptor.iSerialNumber,
3960 if (length + 1 != serial_len) {
3961 dev_dbg(&udev->dev, "serial string error %d\n",
3964 } else if (memcmp(buf, udev->serial, length) != 0) {
3965 dev_dbg(&udev->dev, "serial string changed\n");
3975 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3976 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3978 * WARNING - don't use this routine to reset a composite device
3979 * (one with multiple interfaces owned by separate drivers)!
3980 * Use usb_reset_device() instead.
3982 * Do a port reset, reassign the device's address, and establish its
3983 * former operating configuration. If the reset fails, or the device's
3984 * descriptors change from their values before the reset, or the original
3985 * configuration and altsettings cannot be restored, a flag will be set
3986 * telling khubd to pretend the device has been disconnected and then
3987 * re-connected. All drivers will be unbound, and the device will be
3988 * re-enumerated and probed all over again.
3990 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3991 * flagged for logical disconnection, or some other negative error code
3992 * if the reset wasn't even attempted.
3994 * The caller must own the device lock. For example, it's safe to use
3995 * this from a driver probe() routine after downloading new firmware.
3996 * For calls that might not occur during probe(), drivers should lock
3997 * the device using usb_lock_device_for_reset().
3999 * Locking exception: This routine may also be called from within an
4000 * autoresume handler. Such usage won't conflict with other tasks
4001 * holding the device lock because these tasks should always call
4002 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4004 static int usb_reset_and_verify_device(struct usb_device *udev)
4006 struct usb_device *parent_hdev = udev->parent;
4007 struct usb_hub *parent_hub;
4008 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4009 struct usb_device_descriptor descriptor = udev->descriptor;
4011 int port1 = udev->portnum;
4013 if (udev->state == USB_STATE_NOTATTACHED ||
4014 udev->state == USB_STATE_SUSPENDED) {
4015 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4021 /* this requires hcd-specific logic; see ohci_restart() */
4022 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4025 parent_hub = hdev_to_hub(parent_hdev);
4027 /* Disable USB2 hardware LPM.
4028 * It will be re-enabled by the enumeration process.
4030 if (udev->usb2_hw_lpm_enabled == 1)
4031 usb_set_usb2_hardware_lpm(udev, 0);
4033 set_bit(port1, parent_hub->busy_bits);
4034 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4036 /* ep0 maxpacket size may change; let the HCD know about it.
4037 * Other endpoints will be handled by re-enumeration. */
4038 usb_ep0_reinit(udev);
4039 ret = hub_port_init(parent_hub, udev, port1, i);
4040 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4043 clear_bit(port1, parent_hub->busy_bits);
4048 /* Device might have changed firmware (DFU or similar) */
4049 if (descriptors_changed(udev, &descriptor)) {
4050 dev_info(&udev->dev, "device firmware changed\n");
4051 udev->descriptor = descriptor; /* for disconnect() calls */
4055 /* Restore the device's previous configuration */
4056 if (!udev->actconfig)
4059 mutex_lock(hcd->bandwidth_mutex);
4060 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4062 dev_warn(&udev->dev,
4063 "Busted HC? Not enough HCD resources for "
4064 "old configuration.\n");
4065 mutex_unlock(hcd->bandwidth_mutex);
4068 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4069 USB_REQ_SET_CONFIGURATION, 0,
4070 udev->actconfig->desc.bConfigurationValue, 0,
4071 NULL, 0, USB_CTRL_SET_TIMEOUT);
4074 "can't restore configuration #%d (error=%d)\n",
4075 udev->actconfig->desc.bConfigurationValue, ret);
4076 mutex_unlock(hcd->bandwidth_mutex);
4079 mutex_unlock(hcd->bandwidth_mutex);
4080 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4082 /* Put interfaces back into the same altsettings as before.
4083 * Don't bother to send the Set-Interface request for interfaces
4084 * that were already in altsetting 0; besides being unnecessary,
4085 * many devices can't handle it. Instead just reset the host-side
4088 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4089 struct usb_host_config *config = udev->actconfig;
4090 struct usb_interface *intf = config->interface[i];
4091 struct usb_interface_descriptor *desc;
4093 desc = &intf->cur_altsetting->desc;
4094 if (desc->bAlternateSetting == 0) {
4095 usb_disable_interface(udev, intf, true);
4096 usb_enable_interface(udev, intf, true);
4099 /* Let the bandwidth allocation function know that this
4100 * device has been reset, and it will have to use
4101 * alternate setting 0 as the current alternate setting.
4103 intf->resetting_device = 1;
4104 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4105 desc->bAlternateSetting);
4106 intf->resetting_device = 0;
4109 dev_err(&udev->dev, "failed to restore interface %d "
4110 "altsetting %d (error=%d)\n",
4111 desc->bInterfaceNumber,
4112 desc->bAlternateSetting,
4122 hub_port_logical_disconnect(parent_hub, port1);
4127 * usb_reset_device - warn interface drivers and perform a USB port reset
4128 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4130 * Warns all drivers bound to registered interfaces (using their pre_reset
4131 * method), performs the port reset, and then lets the drivers know that
4132 * the reset is over (using their post_reset method).
4134 * Return value is the same as for usb_reset_and_verify_device().
4136 * The caller must own the device lock. For example, it's safe to use
4137 * this from a driver probe() routine after downloading new firmware.
4138 * For calls that might not occur during probe(), drivers should lock
4139 * the device using usb_lock_device_for_reset().
4141 * If an interface is currently being probed or disconnected, we assume
4142 * its driver knows how to handle resets. For all other interfaces,
4143 * if the driver doesn't have pre_reset and post_reset methods then
4144 * we attempt to unbind it and rebind afterward.
4146 int usb_reset_device(struct usb_device *udev)
4150 struct usb_host_config *config = udev->actconfig;
4152 if (udev->state == USB_STATE_NOTATTACHED ||
4153 udev->state == USB_STATE_SUSPENDED) {
4154 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4159 /* Prevent autosuspend during the reset */
4160 usb_autoresume_device(udev);
4163 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4164 struct usb_interface *cintf = config->interface[i];
4165 struct usb_driver *drv;
4168 if (cintf->dev.driver) {
4169 drv = to_usb_driver(cintf->dev.driver);
4170 if (drv->pre_reset && drv->post_reset)
4171 unbind = (drv->pre_reset)(cintf);
4172 else if (cintf->condition ==
4173 USB_INTERFACE_BOUND)
4176 usb_forced_unbind_intf(cintf);
4181 ret = usb_reset_and_verify_device(udev);
4184 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4185 struct usb_interface *cintf = config->interface[i];
4186 struct usb_driver *drv;
4187 int rebind = cintf->needs_binding;
4189 if (!rebind && cintf->dev.driver) {
4190 drv = to_usb_driver(cintf->dev.driver);
4191 if (drv->post_reset)
4192 rebind = (drv->post_reset)(cintf);
4193 else if (cintf->condition ==
4194 USB_INTERFACE_BOUND)
4197 if (ret == 0 && rebind)
4198 usb_rebind_intf(cintf);
4202 usb_autosuspend_device(udev);
4205 EXPORT_SYMBOL_GPL(usb_reset_device);
4209 * usb_queue_reset_device - Reset a USB device from an atomic context
4210 * @iface: USB interface belonging to the device to reset
4212 * This function can be used to reset a USB device from an atomic
4213 * context, where usb_reset_device() won't work (as it blocks).
4215 * Doing a reset via this method is functionally equivalent to calling
4216 * usb_reset_device(), except for the fact that it is delayed to a
4217 * workqueue. This means that any drivers bound to other interfaces
4218 * might be unbound, as well as users from usbfs in user space.
4222 * - Scheduling two resets at the same time from two different drivers
4223 * attached to two different interfaces of the same device is
4224 * possible; depending on how the driver attached to each interface
4225 * handles ->pre_reset(), the second reset might happen or not.
4227 * - If a driver is unbound and it had a pending reset, the reset will
4230 * - This function can be called during .probe() or .disconnect()
4231 * times. On return from .disconnect(), any pending resets will be
4234 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4237 * NOTE: We don't do any reference count tracking because it is not
4238 * needed. The lifecycle of the work_struct is tied to the
4239 * usb_interface. Before destroying the interface we cancel the
4240 * work_struct, so the fact that work_struct is queued and or
4241 * running means the interface (and thus, the device) exist and
4244 void usb_queue_reset_device(struct usb_interface *iface)
4246 schedule_work(&iface->reset_ws);
4248 EXPORT_SYMBOL_GPL(usb_queue_reset_device);