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 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
467 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
472 * enumeration blocks khubd for a long time. we use keventd instead, since
473 * long blocking there is the exception, not the rule. accordingly, HCDs
474 * talking to TTs must queue control transfers (not just bulk and iso), so
475 * both can talk to the same hub concurrently.
477 static void hub_tt_work(struct work_struct *work)
479 struct usb_hub *hub =
480 container_of(work, struct usb_hub, tt.clear_work);
484 spin_lock_irqsave (&hub->tt.lock, flags);
485 while (!list_empty(&hub->tt.clear_list)) {
486 struct list_head *next;
487 struct usb_tt_clear *clear;
488 struct usb_device *hdev = hub->hdev;
489 const struct hc_driver *drv;
492 if (!hub->quiescing && --limit < 0)
495 next = hub->tt.clear_list.next;
496 clear = list_entry (next, struct usb_tt_clear, clear_list);
497 list_del (&clear->clear_list);
499 /* drop lock so HCD can concurrently report other TT errors */
500 spin_unlock_irqrestore (&hub->tt.lock, flags);
501 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
504 "clear tt %d (%04x) error %d\n",
505 clear->tt, clear->devinfo, status);
507 /* Tell the HCD, even if the operation failed */
508 drv = clear->hcd->driver;
509 if (drv->clear_tt_buffer_complete)
510 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
513 spin_lock_irqsave(&hub->tt.lock, flags);
515 spin_unlock_irqrestore (&hub->tt.lock, flags);
519 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
520 * @urb: an URB associated with the failed or incomplete split transaction
522 * High speed HCDs use this to tell the hub driver that some split control or
523 * bulk transaction failed in a way that requires clearing internal state of
524 * a transaction translator. This is normally detected (and reported) from
527 * It may not be possible for that hub to handle additional full (or low)
528 * speed transactions until that state is fully cleared out.
530 int usb_hub_clear_tt_buffer(struct urb *urb)
532 struct usb_device *udev = urb->dev;
533 int pipe = urb->pipe;
534 struct usb_tt *tt = udev->tt;
536 struct usb_tt_clear *clear;
538 /* we've got to cope with an arbitrary number of pending TT clears,
539 * since each TT has "at least two" buffers that can need it (and
540 * there can be many TTs per hub). even if they're uncommon.
542 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
543 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
544 /* FIXME recover somehow ... RESET_TT? */
548 /* info that CLEAR_TT_BUFFER needs */
549 clear->tt = tt->multi ? udev->ttport : 1;
550 clear->devinfo = usb_pipeendpoint (pipe);
551 clear->devinfo |= udev->devnum << 4;
552 clear->devinfo |= usb_pipecontrol (pipe)
553 ? (USB_ENDPOINT_XFER_CONTROL << 11)
554 : (USB_ENDPOINT_XFER_BULK << 11);
555 if (usb_pipein (pipe))
556 clear->devinfo |= 1 << 15;
558 /* info for completion callback */
559 clear->hcd = bus_to_hcd(udev->bus);
562 /* tell keventd to clear state for this TT */
563 spin_lock_irqsave (&tt->lock, flags);
564 list_add_tail (&clear->clear_list, &tt->clear_list);
565 schedule_work(&tt->clear_work);
566 spin_unlock_irqrestore (&tt->lock, flags);
569 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
571 /* If do_delay is false, return the number of milliseconds the caller
574 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
577 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
579 u16 wHubCharacteristics =
580 le16_to_cpu(hub->descriptor->wHubCharacteristics);
582 /* Enable power on each port. Some hubs have reserved values
583 * of LPSM (> 2) in their descriptors, even though they are
584 * USB 2.0 hubs. Some hubs do not implement port-power switching
585 * but only emulate it. In all cases, the ports won't work
586 * unless we send these messages to the hub.
588 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
589 dev_dbg(hub->intfdev, "enabling power on all ports\n");
591 dev_dbg(hub->intfdev, "trying to enable port power on "
592 "non-switchable hub\n");
593 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
594 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
596 /* Wait at least 100 msec for power to become stable */
597 delay = max(pgood_delay, (unsigned) 100);
603 static int hub_hub_status(struct usb_hub *hub,
604 u16 *status, u16 *change)
608 mutex_lock(&hub->status_mutex);
609 ret = get_hub_status(hub->hdev, &hub->status->hub);
611 dev_err (hub->intfdev,
612 "%s failed (err = %d)\n", __func__, ret);
614 *status = le16_to_cpu(hub->status->hub.wHubStatus);
615 *change = le16_to_cpu(hub->status->hub.wHubChange);
618 mutex_unlock(&hub->status_mutex);
622 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
623 unsigned int link_status)
625 return set_port_feature(hub->hdev,
626 port1 | (link_status << 3),
627 USB_PORT_FEAT_LINK_STATE);
631 * If USB 3.0 ports are placed into the Disabled state, they will no longer
632 * detect any device connects or disconnects. This is generally not what the
633 * USB core wants, since it expects a disabled port to produce a port status
634 * change event when a new device connects.
636 * Instead, set the link state to Disabled, wait for the link to settle into
637 * that state, clear any change bits, and then put the port into the RxDetect
640 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
644 u16 portchange, portstatus;
646 if (!hub_is_superspeed(hub->hdev))
649 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
651 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
656 /* Wait for the link to enter the disabled state. */
657 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
658 ret = hub_port_status(hub, port1, &portstatus, &portchange);
662 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
663 USB_SS_PORT_LS_SS_DISABLED)
665 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
667 msleep(HUB_DEBOUNCE_STEP);
669 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
670 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
673 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
676 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
678 struct usb_device *hdev = hub->hdev;
681 if (hdev->children[port1-1] && set_state)
682 usb_set_device_state(hdev->children[port1-1],
683 USB_STATE_NOTATTACHED);
685 if (hub_is_superspeed(hub->hdev))
686 ret = hub_usb3_port_disable(hub, port1);
688 ret = clear_port_feature(hdev, port1,
689 USB_PORT_FEAT_ENABLE);
692 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
698 * Disable a port and mark a logical connect-change event, so that some
699 * time later khubd will disconnect() any existing usb_device on the port
700 * and will re-enumerate if there actually is a device attached.
702 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
704 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
705 hub_port_disable(hub, port1, 1);
707 /* FIXME let caller ask to power down the port:
708 * - some devices won't enumerate without a VBUS power cycle
709 * - SRP saves power that way
710 * - ... new call, TBD ...
711 * That's easy if this hub can switch power per-port, and
712 * khubd reactivates the port later (timer, SRP, etc).
713 * Powerdown must be optional, because of reset/DFU.
716 set_bit(port1, hub->change_bits);
721 * usb_remove_device - disable a device's port on its parent hub
722 * @udev: device to be disabled and removed
723 * Context: @udev locked, must be able to sleep.
725 * After @udev's port has been disabled, khubd is notified and it will
726 * see that the device has been disconnected. When the device is
727 * physically unplugged and something is plugged in, the events will
728 * be received and processed normally.
730 int usb_remove_device(struct usb_device *udev)
733 struct usb_interface *intf;
735 if (!udev->parent) /* Can't remove a root hub */
737 hub = hdev_to_hub(udev->parent);
738 intf = to_usb_interface(hub->intfdev);
740 usb_autopm_get_interface(intf);
741 set_bit(udev->portnum, hub->removed_bits);
742 hub_port_logical_disconnect(hub, udev->portnum);
743 usb_autopm_put_interface(intf);
747 enum hub_activation_type {
748 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
749 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
752 static void hub_init_func2(struct work_struct *ws);
753 static void hub_init_func3(struct work_struct *ws);
755 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
757 struct usb_device *hdev = hub->hdev;
762 bool need_debounce_delay = false;
765 /* Continue a partial initialization */
766 if (type == HUB_INIT2)
768 if (type == HUB_INIT3)
771 /* The superspeed hub except for root hub has to use Hub Depth
772 * value as an offset into the route string to locate the bits
773 * it uses to determine the downstream port number. So hub driver
774 * should send a set hub depth request to superspeed hub after
775 * the superspeed hub is set configuration in initialization or
778 * After a resume, port power should still be on.
779 * For any other type of activation, turn it on.
781 if (type != HUB_RESUME) {
782 if (hdev->parent && hub_is_superspeed(hdev)) {
783 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
784 HUB_SET_DEPTH, USB_RT_HUB,
785 hdev->level - 1, 0, NULL, 0,
786 USB_CTRL_SET_TIMEOUT);
788 dev_err(hub->intfdev,
789 "set hub depth failed\n");
792 /* Speed up system boot by using a delayed_work for the
793 * hub's initial power-up delays. This is pretty awkward
794 * and the implementation looks like a home-brewed sort of
795 * setjmp/longjmp, but it saves at least 100 ms for each
796 * root hub (assuming usbcore is compiled into the kernel
797 * rather than as a module). It adds up.
799 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
800 * because for those activation types the ports have to be
801 * operational when we return. In theory this could be done
802 * for HUB_POST_RESET, but it's easier not to.
804 if (type == HUB_INIT) {
805 delay = hub_power_on(hub, false);
806 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
807 schedule_delayed_work(&hub->init_work,
808 msecs_to_jiffies(delay));
810 /* Suppress autosuspend until init is done */
811 usb_autopm_get_interface_no_resume(
812 to_usb_interface(hub->intfdev));
813 return; /* Continues at init2: below */
814 } else if (type == HUB_RESET_RESUME) {
815 /* The internal host controller state for the hub device
816 * may be gone after a host power loss on system resume.
817 * Update the device's info so the HW knows it's a hub.
819 hcd = bus_to_hcd(hdev->bus);
820 if (hcd->driver->update_hub_device) {
821 ret = hcd->driver->update_hub_device(hcd, hdev,
824 dev_err(hub->intfdev, "Host not "
825 "accepting hub info "
827 dev_err(hub->intfdev, "LS/FS devices "
828 "and hubs may not work "
829 "under this hub\n.");
832 hub_power_on(hub, true);
834 hub_power_on(hub, true);
839 /* Check each port and set hub->change_bits to let khubd know
840 * which ports need attention.
842 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
843 struct usb_device *udev = hdev->children[port1-1];
844 u16 portstatus, portchange;
846 portstatus = portchange = 0;
847 status = hub_port_status(hub, port1, &portstatus, &portchange);
848 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
849 dev_dbg(hub->intfdev,
850 "port %d: status %04x change %04x\n",
851 port1, portstatus, portchange);
853 /* After anything other than HUB_RESUME (i.e., initialization
854 * or any sort of reset), every port should be disabled.
855 * Unconnected ports should likewise be disabled (paranoia),
856 * and so should ports for which we have no usb_device.
858 if ((portstatus & USB_PORT_STAT_ENABLE) && (
859 type != HUB_RESUME ||
860 !(portstatus & USB_PORT_STAT_CONNECTION) ||
862 udev->state == USB_STATE_NOTATTACHED)) {
864 * USB3 protocol ports will automatically transition
865 * to Enabled state when detect an USB3.0 device attach.
866 * Do not disable USB3 protocol ports.
868 if (!hub_is_superspeed(hdev)) {
869 clear_port_feature(hdev, port1,
870 USB_PORT_FEAT_ENABLE);
871 portstatus &= ~USB_PORT_STAT_ENABLE;
873 /* Pretend that power was lost for USB3 devs */
874 portstatus &= ~USB_PORT_STAT_ENABLE;
878 /* Clear status-change flags; we'll debounce later */
879 if (portchange & USB_PORT_STAT_C_CONNECTION) {
880 need_debounce_delay = true;
881 clear_port_feature(hub->hdev, port1,
882 USB_PORT_FEAT_C_CONNECTION);
884 if (portchange & USB_PORT_STAT_C_ENABLE) {
885 need_debounce_delay = true;
886 clear_port_feature(hub->hdev, port1,
887 USB_PORT_FEAT_C_ENABLE);
889 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
890 need_debounce_delay = true;
891 clear_port_feature(hub->hdev, port1,
892 USB_PORT_FEAT_C_PORT_LINK_STATE);
895 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
896 hub_is_superspeed(hub->hdev)) {
897 need_debounce_delay = true;
898 clear_port_feature(hub->hdev, port1,
899 USB_PORT_FEAT_C_BH_PORT_RESET);
901 /* We can forget about a "removed" device when there's a
902 * physical disconnect or the connect status changes.
904 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
905 (portchange & USB_PORT_STAT_C_CONNECTION))
906 clear_bit(port1, hub->removed_bits);
908 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
909 /* Tell khubd to disconnect the device or
910 * check for a new connection
912 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
913 set_bit(port1, hub->change_bits);
915 } else if (portstatus & USB_PORT_STAT_ENABLE) {
916 /* The power session apparently survived the resume.
917 * If there was an overcurrent or suspend change
918 * (i.e., remote wakeup request), have khubd
922 set_bit(port1, hub->change_bits);
924 } else if (udev->persist_enabled) {
926 udev->reset_resume = 1;
928 set_bit(port1, hub->change_bits);
931 /* The power session is gone; tell khubd */
932 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
933 set_bit(port1, hub->change_bits);
937 /* If no port-status-change flags were set, we don't need any
938 * debouncing. If flags were set we can try to debounce the
939 * ports all at once right now, instead of letting khubd do them
940 * one at a time later on.
942 * If any port-status changes do occur during this delay, khubd
943 * will see them later and handle them normally.
945 if (need_debounce_delay) {
946 delay = HUB_DEBOUNCE_STABLE;
948 /* Don't do a long sleep inside a workqueue routine */
949 if (type == HUB_INIT2) {
950 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
951 schedule_delayed_work(&hub->init_work,
952 msecs_to_jiffies(delay));
953 return; /* Continues at init3: below */
961 status = usb_submit_urb(hub->urb, GFP_NOIO);
963 dev_err(hub->intfdev, "activate --> %d\n", status);
964 if (hub->has_indicators && blinkenlights)
965 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
967 /* Scan all ports that need attention */
970 /* Allow autosuspend if it was suppressed */
971 if (type <= HUB_INIT3)
972 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
975 /* Implement the continuations for the delays above */
976 static void hub_init_func2(struct work_struct *ws)
978 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
980 hub_activate(hub, HUB_INIT2);
983 static void hub_init_func3(struct work_struct *ws)
985 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
987 hub_activate(hub, HUB_INIT3);
990 enum hub_quiescing_type {
991 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
994 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
996 struct usb_device *hdev = hub->hdev;
999 cancel_delayed_work_sync(&hub->init_work);
1001 /* khubd and related activity won't re-trigger */
1004 if (type != HUB_SUSPEND) {
1005 /* Disconnect all the children */
1006 for (i = 0; i < hdev->maxchild; ++i) {
1007 if (hdev->children[i])
1008 usb_disconnect(&hdev->children[i]);
1012 /* Stop khubd and related activity */
1013 usb_kill_urb(hub->urb);
1014 if (hub->has_indicators)
1015 cancel_delayed_work_sync(&hub->leds);
1017 flush_work_sync(&hub->tt.clear_work);
1020 /* caller has locked the hub device */
1021 static int hub_pre_reset(struct usb_interface *intf)
1023 struct usb_hub *hub = usb_get_intfdata(intf);
1025 hub_quiesce(hub, HUB_PRE_RESET);
1029 /* caller has locked the hub device */
1030 static int hub_post_reset(struct usb_interface *intf)
1032 struct usb_hub *hub = usb_get_intfdata(intf);
1034 hub_activate(hub, HUB_POST_RESET);
1038 static int hub_configure(struct usb_hub *hub,
1039 struct usb_endpoint_descriptor *endpoint)
1041 struct usb_hcd *hcd;
1042 struct usb_device *hdev = hub->hdev;
1043 struct device *hub_dev = hub->intfdev;
1044 u16 hubstatus, hubchange;
1045 u16 wHubCharacteristics;
1048 char *message = "out of memory";
1050 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1056 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1061 mutex_init(&hub->status_mutex);
1063 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1064 if (!hub->descriptor) {
1069 /* Request the entire hub descriptor.
1070 * hub->descriptor can handle USB_MAXCHILDREN ports,
1071 * but the hub can/will return fewer bytes here.
1073 ret = get_hub_descriptor(hdev, hub->descriptor);
1075 message = "can't read hub descriptor";
1077 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1078 message = "hub has too many ports!";
1083 hdev->maxchild = hub->descriptor->bNbrPorts;
1084 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1085 (hdev->maxchild == 1) ? "" : "s");
1087 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1088 if (!hub->port_owners) {
1093 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1095 /* FIXME for USB 3.0, skip for now */
1096 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1097 !(hub_is_superspeed(hdev))) {
1099 char portstr [USB_MAXCHILDREN + 1];
1101 for (i = 0; i < hdev->maxchild; i++)
1102 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1103 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1105 portstr[hdev->maxchild] = 0;
1106 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1108 dev_dbg(hub_dev, "standalone hub\n");
1110 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1112 dev_dbg(hub_dev, "ganged power switching\n");
1115 dev_dbg(hub_dev, "individual port power switching\n");
1119 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1123 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1125 dev_dbg(hub_dev, "global over-current protection\n");
1128 dev_dbg(hub_dev, "individual port over-current protection\n");
1132 dev_dbg(hub_dev, "no over-current protection\n");
1136 spin_lock_init (&hub->tt.lock);
1137 INIT_LIST_HEAD (&hub->tt.clear_list);
1138 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1139 switch (hdev->descriptor.bDeviceProtocol) {
1143 dev_dbg(hub_dev, "Single TT\n");
1147 ret = usb_set_interface(hdev, 0, 1);
1149 dev_dbg(hub_dev, "TT per port\n");
1152 dev_err(hub_dev, "Using single TT (err %d)\n",
1157 /* USB 3.0 hubs don't have a TT */
1160 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1161 hdev->descriptor.bDeviceProtocol);
1165 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1166 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1167 case HUB_TTTT_8_BITS:
1168 if (hdev->descriptor.bDeviceProtocol != 0) {
1169 hub->tt.think_time = 666;
1170 dev_dbg(hub_dev, "TT requires at most %d "
1171 "FS bit times (%d ns)\n",
1172 8, hub->tt.think_time);
1175 case HUB_TTTT_16_BITS:
1176 hub->tt.think_time = 666 * 2;
1177 dev_dbg(hub_dev, "TT requires at most %d "
1178 "FS bit times (%d ns)\n",
1179 16, hub->tt.think_time);
1181 case HUB_TTTT_24_BITS:
1182 hub->tt.think_time = 666 * 3;
1183 dev_dbg(hub_dev, "TT requires at most %d "
1184 "FS bit times (%d ns)\n",
1185 24, hub->tt.think_time);
1187 case HUB_TTTT_32_BITS:
1188 hub->tt.think_time = 666 * 4;
1189 dev_dbg(hub_dev, "TT requires at most %d "
1190 "FS bit times (%d ns)\n",
1191 32, hub->tt.think_time);
1195 /* probe() zeroes hub->indicator[] */
1196 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1197 hub->has_indicators = 1;
1198 dev_dbg(hub_dev, "Port indicators are supported\n");
1201 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1202 hub->descriptor->bPwrOn2PwrGood * 2);
1204 /* power budgeting mostly matters with bus-powered hubs,
1205 * and battery-powered root hubs (may provide just 8 mA).
1207 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1209 message = "can't get hub status";
1212 le16_to_cpus(&hubstatus);
1213 if (hdev == hdev->bus->root_hub) {
1214 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1215 hub->mA_per_port = 500;
1217 hub->mA_per_port = hdev->bus_mA;
1218 hub->limited_power = 1;
1220 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1221 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1222 hub->descriptor->bHubContrCurrent);
1223 hub->limited_power = 1;
1224 if (hdev->maxchild > 0) {
1225 int remaining = hdev->bus_mA -
1226 hub->descriptor->bHubContrCurrent;
1228 if (remaining < hdev->maxchild * 100)
1230 "insufficient power available "
1231 "to use all downstream ports\n");
1232 hub->mA_per_port = 100; /* 7.2.1.1 */
1234 } else { /* Self-powered external hub */
1235 /* FIXME: What about battery-powered external hubs that
1236 * provide less current per port? */
1237 hub->mA_per_port = 500;
1239 if (hub->mA_per_port < 500)
1240 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1243 /* Update the HCD's internal representation of this hub before khubd
1244 * starts getting port status changes for devices under the hub.
1246 hcd = bus_to_hcd(hdev->bus);
1247 if (hcd->driver->update_hub_device) {
1248 ret = hcd->driver->update_hub_device(hcd, hdev,
1249 &hub->tt, GFP_KERNEL);
1251 message = "can't update HCD hub info";
1256 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1258 message = "can't get hub status";
1262 /* local power status reports aren't always correct */
1263 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1264 dev_dbg(hub_dev, "local power source is %s\n",
1265 (hubstatus & HUB_STATUS_LOCAL_POWER)
1266 ? "lost (inactive)" : "good");
1268 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1269 dev_dbg(hub_dev, "%sover-current condition exists\n",
1270 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1272 /* set up the interrupt endpoint
1273 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1274 * bytes as USB2.0[11.12.3] says because some hubs are known
1275 * to send more data (and thus cause overflow). For root hubs,
1276 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1277 * to be big enough for at least USB_MAXCHILDREN ports. */
1278 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1279 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1281 if (maxp > sizeof(*hub->buffer))
1282 maxp = sizeof(*hub->buffer);
1284 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1290 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1291 hub, endpoint->bInterval);
1293 /* maybe cycle the hub leds */
1294 if (hub->has_indicators && blinkenlights)
1295 hub->indicator [0] = INDICATOR_CYCLE;
1297 hub_activate(hub, HUB_INIT);
1301 dev_err (hub_dev, "config failed, %s (err %d)\n",
1303 /* hub_disconnect() frees urb and descriptor */
1307 static void hub_release(struct kref *kref)
1309 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1311 usb_put_intf(to_usb_interface(hub->intfdev));
1315 static unsigned highspeed_hubs;
1317 static void hub_disconnect(struct usb_interface *intf)
1319 struct usb_hub *hub = usb_get_intfdata (intf);
1321 /* Take the hub off the event list and don't let it be added again */
1322 spin_lock_irq(&hub_event_lock);
1323 if (!list_empty(&hub->event_list)) {
1324 list_del_init(&hub->event_list);
1325 usb_autopm_put_interface_no_suspend(intf);
1327 hub->disconnected = 1;
1328 spin_unlock_irq(&hub_event_lock);
1330 /* Disconnect all children and quiesce the hub */
1332 hub_quiesce(hub, HUB_DISCONNECT);
1334 usb_set_intfdata (intf, NULL);
1335 hub->hdev->maxchild = 0;
1337 if (hub->hdev->speed == USB_SPEED_HIGH)
1340 usb_free_urb(hub->urb);
1341 kfree(hub->port_owners);
1342 kfree(hub->descriptor);
1346 kref_put(&hub->kref, hub_release);
1349 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1351 struct usb_host_interface *desc;
1352 struct usb_endpoint_descriptor *endpoint;
1353 struct usb_device *hdev;
1354 struct usb_hub *hub;
1356 desc = intf->cur_altsetting;
1357 hdev = interface_to_usbdev(intf);
1359 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1360 * different from USB 2.0/1.1 device suspend, and unfortunately we
1361 * don't support it yet. So leave autosuspend disabled for USB 3.0
1362 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1363 * since that isn't a "real" hub.
1365 if (!hub_is_superspeed(hdev) || !hdev->parent)
1366 usb_enable_autosuspend(hdev);
1368 if (hdev->level == MAX_TOPO_LEVEL) {
1370 "Unsupported bus topology: hub nested too deep\n");
1374 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1376 dev_warn(&intf->dev, "ignoring external hub\n");
1381 /* Some hubs have a subclass of 1, which AFAICT according to the */
1382 /* specs is not defined, but it works */
1383 if ((desc->desc.bInterfaceSubClass != 0) &&
1384 (desc->desc.bInterfaceSubClass != 1)) {
1386 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1390 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1391 if (desc->desc.bNumEndpoints != 1)
1392 goto descriptor_error;
1394 endpoint = &desc->endpoint[0].desc;
1396 /* If it's not an interrupt in endpoint, we'd better punt! */
1397 if (!usb_endpoint_is_int_in(endpoint))
1398 goto descriptor_error;
1400 /* We found a hub */
1401 dev_info (&intf->dev, "USB hub found\n");
1403 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1405 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1409 kref_init(&hub->kref);
1410 INIT_LIST_HEAD(&hub->event_list);
1411 hub->intfdev = &intf->dev;
1413 INIT_DELAYED_WORK(&hub->leds, led_work);
1414 INIT_DELAYED_WORK(&hub->init_work, NULL);
1417 usb_set_intfdata (intf, hub);
1418 intf->needs_remote_wakeup = 1;
1420 if (hdev->speed == USB_SPEED_HIGH)
1423 if (hub_configure(hub, endpoint) >= 0)
1426 hub_disconnect (intf);
1432 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1434 struct usb_device *hdev = interface_to_usbdev (intf);
1436 /* assert ifno == 0 (part of hub spec) */
1438 case USBDEVFS_HUB_PORTINFO: {
1439 struct usbdevfs_hub_portinfo *info = user_data;
1442 spin_lock_irq(&device_state_lock);
1443 if (hdev->devnum <= 0)
1446 info->nports = hdev->maxchild;
1447 for (i = 0; i < info->nports; i++) {
1448 if (hdev->children[i] == NULL)
1452 hdev->children[i]->devnum;
1455 spin_unlock_irq(&device_state_lock);
1457 return info->nports + 1;
1466 * Allow user programs to claim ports on a hub. When a device is attached
1467 * to one of these "claimed" ports, the program will "own" the device.
1469 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1472 if (hdev->state == USB_STATE_NOTATTACHED)
1474 if (port1 == 0 || port1 > hdev->maxchild)
1477 /* This assumes that devices not managed by the hub driver
1478 * will always have maxchild equal to 0.
1480 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1484 /* In the following three functions, the caller must hold hdev's lock */
1485 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1490 rc = find_port_owner(hdev, port1, &powner);
1499 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1504 rc = find_port_owner(hdev, port1, &powner);
1507 if (*powner != owner)
1513 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1518 n = find_port_owner(hdev, 1, &powner);
1520 for (; n < hdev->maxchild; (++n, ++powner)) {
1521 if (*powner == owner)
1527 /* The caller must hold udev's lock */
1528 bool usb_device_is_owned(struct usb_device *udev)
1530 struct usb_hub *hub;
1532 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1534 hub = hdev_to_hub(udev->parent);
1535 return !!hub->port_owners[udev->portnum - 1];
1539 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1543 for (i = 0; i < udev->maxchild; ++i) {
1544 if (udev->children[i])
1545 recursively_mark_NOTATTACHED(udev->children[i]);
1547 if (udev->state == USB_STATE_SUSPENDED)
1548 udev->active_duration -= jiffies;
1549 udev->state = USB_STATE_NOTATTACHED;
1553 * usb_set_device_state - change a device's current state (usbcore, hcds)
1554 * @udev: pointer to device whose state should be changed
1555 * @new_state: new state value to be stored
1557 * udev->state is _not_ fully protected by the device lock. Although
1558 * most transitions are made only while holding the lock, the state can
1559 * can change to USB_STATE_NOTATTACHED at almost any time. This
1560 * is so that devices can be marked as disconnected as soon as possible,
1561 * without having to wait for any semaphores to be released. As a result,
1562 * all changes to any device's state must be protected by the
1563 * device_state_lock spinlock.
1565 * Once a device has been added to the device tree, all changes to its state
1566 * should be made using this routine. The state should _not_ be set directly.
1568 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1569 * Otherwise udev->state is set to new_state, and if new_state is
1570 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1571 * to USB_STATE_NOTATTACHED.
1573 void usb_set_device_state(struct usb_device *udev,
1574 enum usb_device_state new_state)
1576 unsigned long flags;
1579 spin_lock_irqsave(&device_state_lock, flags);
1580 if (udev->state == USB_STATE_NOTATTACHED)
1582 else if (new_state != USB_STATE_NOTATTACHED) {
1584 /* root hub wakeup capabilities are managed out-of-band
1585 * and may involve silicon errata ... ignore them here.
1588 if (udev->state == USB_STATE_SUSPENDED
1589 || new_state == USB_STATE_SUSPENDED)
1590 ; /* No change to wakeup settings */
1591 else if (new_state == USB_STATE_CONFIGURED)
1592 wakeup = udev->actconfig->desc.bmAttributes
1593 & USB_CONFIG_ATT_WAKEUP;
1597 if (udev->state == USB_STATE_SUSPENDED &&
1598 new_state != USB_STATE_SUSPENDED)
1599 udev->active_duration -= jiffies;
1600 else if (new_state == USB_STATE_SUSPENDED &&
1601 udev->state != USB_STATE_SUSPENDED)
1602 udev->active_duration += jiffies;
1603 udev->state = new_state;
1605 recursively_mark_NOTATTACHED(udev);
1606 spin_unlock_irqrestore(&device_state_lock, flags);
1608 device_set_wakeup_capable(&udev->dev, wakeup);
1610 EXPORT_SYMBOL_GPL(usb_set_device_state);
1613 * Choose a device number.
1615 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1616 * USB-2.0 buses they are also used as device addresses, however on
1617 * USB-3.0 buses the address is assigned by the controller hardware
1618 * and it usually is not the same as the device number.
1620 * WUSB devices are simple: they have no hubs behind, so the mapping
1621 * device <-> virtual port number becomes 1:1. Why? to simplify the
1622 * life of the device connection logic in
1623 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1624 * handshake we need to assign a temporary address in the unauthorized
1625 * space. For simplicity we use the first virtual port number found to
1626 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1627 * and that becomes it's address [X < 128] or its unauthorized address
1630 * We add 1 as an offset to the one-based USB-stack port number
1631 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1632 * 0 is reserved by USB for default address; (b) Linux's USB stack
1633 * uses always #1 for the root hub of the controller. So USB stack's
1634 * port #1, which is wusb virtual-port #0 has address #2.
1636 * Devices connected under xHCI are not as simple. The host controller
1637 * supports virtualization, so the hardware assigns device addresses and
1638 * the HCD must setup data structures before issuing a set address
1639 * command to the hardware.
1641 static void choose_devnum(struct usb_device *udev)
1644 struct usb_bus *bus = udev->bus;
1646 /* If khubd ever becomes multithreaded, this will need a lock */
1648 devnum = udev->portnum + 1;
1649 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1651 /* Try to allocate the next devnum beginning at
1652 * bus->devnum_next. */
1653 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1656 devnum = find_next_zero_bit(bus->devmap.devicemap,
1658 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1661 set_bit(devnum, bus->devmap.devicemap);
1662 udev->devnum = devnum;
1666 static void release_devnum(struct usb_device *udev)
1668 if (udev->devnum > 0) {
1669 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1674 static void update_devnum(struct usb_device *udev, int devnum)
1676 /* The address for a WUSB device is managed by wusbcore. */
1678 udev->devnum = devnum;
1681 static void hub_free_dev(struct usb_device *udev)
1683 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1685 /* Root hubs aren't real devices, so don't free HCD resources */
1686 if (hcd->driver->free_dev && udev->parent)
1687 hcd->driver->free_dev(hcd, udev);
1691 * usb_disconnect - disconnect a device (usbcore-internal)
1692 * @pdev: pointer to device being disconnected
1693 * Context: !in_interrupt ()
1695 * Something got disconnected. Get rid of it and all of its children.
1697 * If *pdev is a normal device then the parent hub must already be locked.
1698 * If *pdev is a root hub then this routine will acquire the
1699 * usb_bus_list_lock on behalf of the caller.
1701 * Only hub drivers (including virtual root hub drivers for host
1702 * controllers) should ever call this.
1704 * This call is synchronous, and may not be used in an interrupt context.
1706 void usb_disconnect(struct usb_device **pdev)
1708 struct usb_device *udev = *pdev;
1711 /* mark the device as inactive, so any further urb submissions for
1712 * this device (and any of its children) will fail immediately.
1713 * this quiesces everything except pending urbs.
1715 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1716 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1719 usb_lock_device(udev);
1721 /* Free up all the children before we remove this device */
1722 for (i = 0; i < USB_MAXCHILDREN; i++) {
1723 if (udev->children[i])
1724 usb_disconnect(&udev->children[i]);
1727 /* deallocate hcd/hardware state ... nuking all pending urbs and
1728 * cleaning up all state associated with the current configuration
1729 * so that the hardware is now fully quiesced.
1731 dev_dbg (&udev->dev, "unregistering device\n");
1732 usb_disable_device(udev, 0);
1733 usb_hcd_synchronize_unlinks(udev);
1735 usb_remove_ep_devs(&udev->ep0);
1736 usb_unlock_device(udev);
1738 /* Unregister the device. The device driver is responsible
1739 * for de-configuring the device and invoking the remove-device
1740 * notifier chain (used by usbfs and possibly others).
1742 device_del(&udev->dev);
1744 /* Free the device number and delete the parent's children[]
1745 * (or root_hub) pointer.
1747 release_devnum(udev);
1749 /* Avoid races with recursively_mark_NOTATTACHED() */
1750 spin_lock_irq(&device_state_lock);
1752 spin_unlock_irq(&device_state_lock);
1756 put_device(&udev->dev);
1759 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1760 static void show_string(struct usb_device *udev, char *id, char *string)
1764 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1767 static void announce_device(struct usb_device *udev)
1769 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1770 le16_to_cpu(udev->descriptor.idVendor),
1771 le16_to_cpu(udev->descriptor.idProduct));
1772 dev_info(&udev->dev,
1773 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1774 udev->descriptor.iManufacturer,
1775 udev->descriptor.iProduct,
1776 udev->descriptor.iSerialNumber);
1777 show_string(udev, "Product", udev->product);
1778 show_string(udev, "Manufacturer", udev->manufacturer);
1779 show_string(udev, "SerialNumber", udev->serial);
1782 static inline void announce_device(struct usb_device *udev) { }
1785 #ifdef CONFIG_USB_OTG
1786 #include "otg_whitelist.h"
1790 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1791 * @udev: newly addressed device (in ADDRESS state)
1793 * Finish enumeration for On-The-Go devices
1795 static int usb_enumerate_device_otg(struct usb_device *udev)
1799 #ifdef CONFIG_USB_OTG
1801 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1802 * to wake us after we've powered off VBUS; and HNP, switching roles
1803 * "host" to "peripheral". The OTG descriptor helps figure this out.
1805 if (!udev->bus->is_b_host
1807 && udev->parent == udev->bus->root_hub) {
1808 struct usb_otg_descriptor *desc = NULL;
1809 struct usb_bus *bus = udev->bus;
1811 /* descriptor may appear anywhere in config */
1812 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1813 le16_to_cpu(udev->config[0].desc.wTotalLength),
1814 USB_DT_OTG, (void **) &desc) == 0) {
1815 if (desc->bmAttributes & USB_OTG_HNP) {
1816 unsigned port1 = udev->portnum;
1818 dev_info(&udev->dev,
1819 "Dual-Role OTG device on %sHNP port\n",
1820 (port1 == bus->otg_port)
1823 /* enable HNP before suspend, it's simpler */
1824 if (port1 == bus->otg_port)
1825 bus->b_hnp_enable = 1;
1826 err = usb_control_msg(udev,
1827 usb_sndctrlpipe(udev, 0),
1828 USB_REQ_SET_FEATURE, 0,
1830 ? USB_DEVICE_B_HNP_ENABLE
1831 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1832 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1834 /* OTG MESSAGE: report errors here,
1835 * customize to match your product.
1837 dev_info(&udev->dev,
1838 "can't set HNP mode: %d\n",
1840 bus->b_hnp_enable = 0;
1846 if (!is_targeted(udev)) {
1848 /* Maybe it can talk to us, though we can't talk to it.
1849 * (Includes HNP test device.)
1851 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1852 err = usb_port_suspend(udev, PMSG_SUSPEND);
1854 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1866 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1867 * @udev: newly addressed device (in ADDRESS state)
1869 * This is only called by usb_new_device() and usb_authorize_device()
1870 * and FIXME -- all comments that apply to them apply here wrt to
1873 * If the device is WUSB and not authorized, we don't attempt to read
1874 * the string descriptors, as they will be errored out by the device
1875 * until it has been authorized.
1877 static int usb_enumerate_device(struct usb_device *udev)
1881 if (udev->config == NULL) {
1882 err = usb_get_configuration(udev);
1884 dev_err(&udev->dev, "can't read configurations, error %d\n",
1889 if (udev->wusb == 1 && udev->authorized == 0) {
1890 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1891 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1892 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1895 /* read the standard strings and cache them if present */
1896 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1897 udev->manufacturer = usb_cache_string(udev,
1898 udev->descriptor.iManufacturer);
1899 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1901 err = usb_enumerate_device_otg(udev);
1908 * usb_new_device - perform initial device setup (usbcore-internal)
1909 * @udev: newly addressed device (in ADDRESS state)
1911 * This is called with devices which have been detected but not fully
1912 * enumerated. The device descriptor is available, but not descriptors
1913 * for any device configuration. The caller must have locked either
1914 * the parent hub (if udev is a normal device) or else the
1915 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1916 * udev has already been installed, but udev is not yet visible through
1917 * sysfs or other filesystem code.
1919 * It will return if the device is configured properly or not. Zero if
1920 * the interface was registered with the driver core; else a negative
1923 * This call is synchronous, and may not be used in an interrupt context.
1925 * Only the hub driver or root-hub registrar should ever call this.
1927 int usb_new_device(struct usb_device *udev)
1932 /* Initialize non-root-hub device wakeup to disabled;
1933 * device (un)configuration controls wakeup capable
1934 * sysfs power/wakeup controls wakeup enabled/disabled
1936 device_init_wakeup(&udev->dev, 0);
1939 /* Tell the runtime-PM framework the device is active */
1940 pm_runtime_set_active(&udev->dev);
1941 pm_runtime_get_noresume(&udev->dev);
1942 pm_runtime_use_autosuspend(&udev->dev);
1943 pm_runtime_enable(&udev->dev);
1945 /* By default, forbid autosuspend for all devices. It will be
1946 * allowed for hubs during binding.
1948 usb_disable_autosuspend(udev);
1950 err = usb_enumerate_device(udev); /* Read descriptors */
1953 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1954 udev->devnum, udev->bus->busnum,
1955 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1956 /* export the usbdev device-node for libusb */
1957 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1958 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1960 /* Tell the world! */
1961 announce_device(udev);
1964 add_device_randomness(udev->serial, strlen(udev->serial));
1966 add_device_randomness(udev->product, strlen(udev->product));
1967 if (udev->manufacturer)
1968 add_device_randomness(udev->manufacturer,
1969 strlen(udev->manufacturer));
1971 device_enable_async_suspend(&udev->dev);
1972 /* Register the device. The device driver is responsible
1973 * for configuring the device and invoking the add-device
1974 * notifier chain (used by usbfs and possibly others).
1976 err = device_add(&udev->dev);
1978 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1982 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1983 usb_mark_last_busy(udev);
1984 pm_runtime_put_sync_autosuspend(&udev->dev);
1988 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1989 pm_runtime_disable(&udev->dev);
1990 pm_runtime_set_suspended(&udev->dev);
1996 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1997 * @usb_dev: USB device
1999 * Move the USB device to a very basic state where interfaces are disabled
2000 * and the device is in fact unconfigured and unusable.
2002 * We share a lock (that we have) with device_del(), so we need to
2005 int usb_deauthorize_device(struct usb_device *usb_dev)
2007 usb_lock_device(usb_dev);
2008 if (usb_dev->authorized == 0)
2009 goto out_unauthorized;
2011 usb_dev->authorized = 0;
2012 usb_set_configuration(usb_dev, -1);
2014 kfree(usb_dev->product);
2015 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2016 kfree(usb_dev->manufacturer);
2017 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2018 kfree(usb_dev->serial);
2019 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2021 usb_destroy_configuration(usb_dev);
2022 usb_dev->descriptor.bNumConfigurations = 0;
2025 usb_unlock_device(usb_dev);
2030 int usb_authorize_device(struct usb_device *usb_dev)
2034 usb_lock_device(usb_dev);
2035 if (usb_dev->authorized == 1)
2036 goto out_authorized;
2038 result = usb_autoresume_device(usb_dev);
2040 dev_err(&usb_dev->dev,
2041 "can't autoresume for authorization: %d\n", result);
2042 goto error_autoresume;
2044 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2046 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2047 "authorization: %d\n", result);
2048 goto error_device_descriptor;
2051 kfree(usb_dev->product);
2052 usb_dev->product = NULL;
2053 kfree(usb_dev->manufacturer);
2054 usb_dev->manufacturer = NULL;
2055 kfree(usb_dev->serial);
2056 usb_dev->serial = NULL;
2058 usb_dev->authorized = 1;
2059 result = usb_enumerate_device(usb_dev);
2061 goto error_enumerate;
2062 /* Choose and set the configuration. This registers the interfaces
2063 * with the driver core and lets interface drivers bind to them.
2065 c = usb_choose_configuration(usb_dev);
2067 result = usb_set_configuration(usb_dev, c);
2069 dev_err(&usb_dev->dev,
2070 "can't set config #%d, error %d\n", c, result);
2071 /* This need not be fatal. The user can try to
2072 * set other configurations. */
2075 dev_info(&usb_dev->dev, "authorized to connect\n");
2078 error_device_descriptor:
2079 usb_autosuspend_device(usb_dev);
2082 usb_unlock_device(usb_dev); // complements locktree
2087 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2088 static unsigned hub_is_wusb(struct usb_hub *hub)
2090 struct usb_hcd *hcd;
2091 if (hub->hdev->parent != NULL) /* not a root hub? */
2093 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2094 return hcd->wireless;
2098 #define PORT_RESET_TRIES 5
2099 #define SET_ADDRESS_TRIES 2
2100 #define GET_DESCRIPTOR_TRIES 2
2101 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2102 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2104 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2105 #define HUB_SHORT_RESET_TIME 10
2106 #define HUB_BH_RESET_TIME 50
2107 #define HUB_LONG_RESET_TIME 200
2108 #define HUB_RESET_TIMEOUT 800
2110 static int hub_port_reset(struct usb_hub *hub, int port1,
2111 struct usb_device *udev, unsigned int delay, bool warm);
2113 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2114 * Port worm reset is required to recover
2116 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2118 return hub_is_superspeed(hub->hdev) &&
2119 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2120 USB_SS_PORT_LS_SS_INACTIVE) ||
2121 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2122 USB_SS_PORT_LS_COMP_MOD)) ;
2125 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2126 struct usb_device *udev, unsigned int delay, bool warm)
2128 int delay_time, ret;
2132 for (delay_time = 0;
2133 delay_time < HUB_RESET_TIMEOUT;
2134 delay_time += delay) {
2135 /* wait to give the device a chance to reset */
2138 /* read and decode port status */
2139 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2143 /* The port state is unknown until the reset completes. */
2144 if ((portstatus & USB_PORT_STAT_RESET))
2148 * Some buggy devices require a warm reset to be issued even
2149 * when the port appears not to be connected.
2153 * Some buggy devices can cause an NEC host controller
2154 * to transition to the "Error" state after a hot port
2155 * reset. This will show up as the port state in
2156 * "Inactive", and the port may also report a
2157 * disconnect. Forcing a warm port reset seems to make
2160 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2162 if (hub_port_warm_reset_required(hub, portstatus)) {
2165 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2166 clear_port_feature(hub->hdev, port1,
2167 USB_PORT_FEAT_C_CONNECTION);
2168 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2169 clear_port_feature(hub->hdev, port1,
2170 USB_PORT_FEAT_C_PORT_LINK_STATE);
2171 if (portchange & USB_PORT_STAT_C_RESET)
2172 clear_port_feature(hub->hdev, port1,
2173 USB_PORT_FEAT_C_RESET);
2174 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2176 ret = hub_port_reset(hub, port1,
2177 udev, HUB_BH_RESET_TIME,
2179 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2180 clear_port_feature(hub->hdev, port1,
2181 USB_PORT_FEAT_C_CONNECTION);
2184 /* Device went away? */
2185 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2188 /* bomb out completely if the connection bounced */
2189 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2192 if ((portstatus & USB_PORT_STAT_ENABLE)) {
2193 if (hub_is_wusb(hub))
2194 udev->speed = USB_SPEED_WIRELESS;
2195 else if (hub_is_superspeed(hub->hdev))
2196 udev->speed = USB_SPEED_SUPER;
2197 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2198 udev->speed = USB_SPEED_HIGH;
2199 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2200 udev->speed = USB_SPEED_LOW;
2202 udev->speed = USB_SPEED_FULL;
2210 /* switch to the long delay after two short delay failures */
2211 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2212 delay = HUB_LONG_RESET_TIME;
2214 dev_dbg (hub->intfdev,
2215 "port %d not %sreset yet, waiting %dms\n",
2216 port1, warm ? "warm " : "", delay);
2222 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2223 struct usb_device *udev, int *status, bool warm)
2228 struct usb_hcd *hcd;
2229 /* TRSTRCY = 10 ms; plus some extra */
2231 update_devnum(udev, 0);
2232 hcd = bus_to_hcd(udev->bus);
2233 /* The xHC may think the device is already reset,
2234 * so ignore the status.
2236 if (hcd->driver->reset_device)
2237 hcd->driver->reset_device(hcd, udev);
2242 clear_port_feature(hub->hdev,
2243 port1, USB_PORT_FEAT_C_RESET);
2244 /* FIXME need disconnect() for NOTATTACHED device */
2245 if (hub_is_superspeed(hub->hdev)) {
2246 clear_port_feature(hub->hdev, port1,
2247 USB_PORT_FEAT_C_BH_PORT_RESET);
2248 clear_port_feature(hub->hdev, port1,
2249 USB_PORT_FEAT_C_PORT_LINK_STATE);
2252 usb_set_device_state(udev, *status
2253 ? USB_STATE_NOTATTACHED
2254 : USB_STATE_DEFAULT);
2259 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2260 static int hub_port_reset(struct usb_hub *hub, int port1,
2261 struct usb_device *udev, unsigned int delay, bool warm)
2266 /* Block EHCI CF initialization during the port reset.
2267 * Some companion controllers don't like it when they mix.
2269 down_read(&ehci_cf_port_reset_rwsem);
2271 if (!hub_is_superspeed(hub->hdev)) {
2272 dev_err(hub->intfdev, "only USB3 hub support "
2278 /* Reset the port */
2279 for (i = 0; i < PORT_RESET_TRIES; i++) {
2280 status = set_port_feature(hub->hdev, port1, (warm ?
2281 USB_PORT_FEAT_BH_PORT_RESET :
2282 USB_PORT_FEAT_RESET));
2284 dev_err(hub->intfdev,
2285 "cannot %sreset port %d (err = %d)\n",
2286 warm ? "warm " : "", port1, status);
2288 status = hub_port_wait_reset(hub, port1, udev, delay,
2290 if (status && status != -ENOTCONN)
2291 dev_dbg(hub->intfdev,
2292 "port_wait_reset: err = %d\n",
2296 /* return on disconnect or reset */
2297 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2298 hub_port_finish_reset(hub, port1, udev, &status, warm);
2302 dev_dbg (hub->intfdev,
2303 "port %d not enabled, trying %sreset again...\n",
2304 port1, warm ? "warm " : "");
2305 delay = HUB_LONG_RESET_TIME;
2308 dev_err (hub->intfdev,
2309 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2314 up_read(&ehci_cf_port_reset_rwsem);
2319 /* Check if a port is power on */
2320 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2324 if (hub_is_superspeed(hub->hdev)) {
2325 if (portstatus & USB_SS_PORT_STAT_POWER)
2328 if (portstatus & USB_PORT_STAT_POWER)
2337 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2338 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2342 if (hub_is_superspeed(hub->hdev)) {
2343 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2344 == USB_SS_PORT_LS_U3)
2347 if (portstatus & USB_PORT_STAT_SUSPEND)
2354 /* Determine whether the device on a port is ready for a normal resume,
2355 * is ready for a reset-resume, or should be disconnected.
2357 static int check_port_resume_type(struct usb_device *udev,
2358 struct usb_hub *hub, int port1,
2359 int status, unsigned portchange, unsigned portstatus)
2361 /* Is the device still present? */
2362 if (status || port_is_suspended(hub, portstatus) ||
2363 !port_is_power_on(hub, portstatus) ||
2364 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2369 /* Can't do a normal resume if the port isn't enabled,
2370 * so try a reset-resume instead.
2372 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2373 if (udev->persist_enabled)
2374 udev->reset_resume = 1;
2380 dev_dbg(hub->intfdev,
2381 "port %d status %04x.%04x after resume, %d\n",
2382 port1, portchange, portstatus, status);
2383 } else if (udev->reset_resume) {
2385 /* Late port handoff can set status-change bits */
2386 if (portchange & USB_PORT_STAT_C_CONNECTION)
2387 clear_port_feature(hub->hdev, port1,
2388 USB_PORT_FEAT_C_CONNECTION);
2389 if (portchange & USB_PORT_STAT_C_ENABLE)
2390 clear_port_feature(hub->hdev, port1,
2391 USB_PORT_FEAT_C_ENABLE);
2397 #ifdef CONFIG_USB_SUSPEND
2400 * usb_port_suspend - suspend a usb device's upstream port
2401 * @udev: device that's no longer in active use, not a root hub
2402 * Context: must be able to sleep; device not locked; pm locks held
2404 * Suspends a USB device that isn't in active use, conserving power.
2405 * Devices may wake out of a suspend, if anything important happens,
2406 * using the remote wakeup mechanism. They may also be taken out of
2407 * suspend by the host, using usb_port_resume(). It's also routine
2408 * to disconnect devices while they are suspended.
2410 * This only affects the USB hardware for a device; its interfaces
2411 * (and, for hubs, child devices) must already have been suspended.
2413 * Selective port suspend reduces power; most suspended devices draw
2414 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2415 * All devices below the suspended port are also suspended.
2417 * Devices leave suspend state when the host wakes them up. Some devices
2418 * also support "remote wakeup", where the device can activate the USB
2419 * tree above them to deliver data, such as a keypress or packet. In
2420 * some cases, this wakes the USB host.
2422 * Suspending OTG devices may trigger HNP, if that's been enabled
2423 * between a pair of dual-role devices. That will change roles, such
2424 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2426 * Devices on USB hub ports have only one "suspend" state, corresponding
2427 * to ACPI D2, "may cause the device to lose some context".
2428 * State transitions include:
2430 * - suspend, resume ... when the VBUS power link stays live
2431 * - suspend, disconnect ... VBUS lost
2433 * Once VBUS drop breaks the circuit, the port it's using has to go through
2434 * normal re-enumeration procedures, starting with enabling VBUS power.
2435 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2436 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2437 * timer, no SRP, no requests through sysfs.
2439 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2440 * the root hub for their bus goes into global suspend ... so we don't
2441 * (falsely) update the device power state to say it suspended.
2443 * Returns 0 on success, else negative errno.
2445 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2447 struct usb_hub *hub = hdev_to_hub(udev->parent);
2448 int port1 = udev->portnum;
2451 /* enable remote wakeup when appropriate; this lets the device
2452 * wake up the upstream hub (including maybe the root hub).
2454 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2455 * we don't explicitly enable it here.
2457 if (udev->do_remote_wakeup) {
2458 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2459 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2460 USB_DEVICE_REMOTE_WAKEUP, 0,
2462 USB_CTRL_SET_TIMEOUT);
2464 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2466 /* bail if autosuspend is requested */
2467 if (PMSG_IS_AUTO(msg))
2472 /* disable USB2 hardware LPM */
2473 if (udev->usb2_hw_lpm_enabled == 1)
2474 usb_set_usb2_hardware_lpm(udev, 0);
2477 if (hub_is_superspeed(hub->hdev))
2478 status = set_port_feature(hub->hdev,
2479 port1 | (USB_SS_PORT_LS_U3 << 3),
2480 USB_PORT_FEAT_LINK_STATE);
2482 status = set_port_feature(hub->hdev, port1,
2483 USB_PORT_FEAT_SUSPEND);
2485 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2487 /* paranoia: "should not happen" */
2488 if (udev->do_remote_wakeup)
2489 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2490 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2491 USB_DEVICE_REMOTE_WAKEUP, 0,
2493 USB_CTRL_SET_TIMEOUT);
2495 /* Try to enable USB2 hardware LPM again */
2496 if (udev->usb2_hw_lpm_capable == 1)
2497 usb_set_usb2_hardware_lpm(udev, 1);
2499 /* System sleep transitions should never fail */
2500 if (!PMSG_IS_AUTO(msg))
2503 /* device has up to 10 msec to fully suspend */
2504 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2505 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2506 udev->do_remote_wakeup);
2507 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2510 usb_mark_last_busy(hub->hdev);
2515 * If the USB "suspend" state is in use (rather than "global suspend"),
2516 * many devices will be individually taken out of suspend state using
2517 * special "resume" signaling. This routine kicks in shortly after
2518 * hardware resume signaling is finished, either because of selective
2519 * resume (by host) or remote wakeup (by device) ... now see what changed
2520 * in the tree that's rooted at this device.
2522 * If @udev->reset_resume is set then the device is reset before the
2523 * status check is done.
2525 static int finish_port_resume(struct usb_device *udev)
2530 /* caller owns the udev device lock */
2531 dev_dbg(&udev->dev, "%s\n",
2532 udev->reset_resume ? "finish reset-resume" : "finish resume");
2534 /* usb ch9 identifies four variants of SUSPENDED, based on what
2535 * state the device resumes to. Linux currently won't see the
2536 * first two on the host side; they'd be inside hub_port_init()
2537 * during many timeouts, but khubd can't suspend until later.
2539 usb_set_device_state(udev, udev->actconfig
2540 ? USB_STATE_CONFIGURED
2541 : USB_STATE_ADDRESS);
2543 /* 10.5.4.5 says not to reset a suspended port if the attached
2544 * device is enabled for remote wakeup. Hence the reset
2545 * operation is carried out here, after the port has been
2548 if (udev->reset_resume)
2550 status = usb_reset_and_verify_device(udev);
2552 /* 10.5.4.5 says be sure devices in the tree are still there.
2553 * For now let's assume the device didn't go crazy on resume,
2554 * and device drivers will know about any resume quirks.
2558 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2560 status = (status > 0 ? 0 : -ENODEV);
2562 /* If a normal resume failed, try doing a reset-resume */
2563 if (status && !udev->reset_resume && udev->persist_enabled) {
2564 dev_dbg(&udev->dev, "retry with reset-resume\n");
2565 udev->reset_resume = 1;
2566 goto retry_reset_resume;
2571 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2573 } else if (udev->actconfig) {
2574 le16_to_cpus(&devstatus);
2575 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2576 status = usb_control_msg(udev,
2577 usb_sndctrlpipe(udev, 0),
2578 USB_REQ_CLEAR_FEATURE,
2580 USB_DEVICE_REMOTE_WAKEUP, 0,
2582 USB_CTRL_SET_TIMEOUT);
2585 "disable remote wakeup, status %d\n",
2594 * usb_port_resume - re-activate a suspended usb device's upstream port
2595 * @udev: device to re-activate, not a root hub
2596 * Context: must be able to sleep; device not locked; pm locks held
2598 * This will re-activate the suspended device, increasing power usage
2599 * while letting drivers communicate again with its endpoints.
2600 * USB resume explicitly guarantees that the power session between
2601 * the host and the device is the same as it was when the device
2604 * If @udev->reset_resume is set then this routine won't check that the
2605 * port is still enabled. Furthermore, finish_port_resume() above will
2606 * reset @udev. The end result is that a broken power session can be
2607 * recovered and @udev will appear to persist across a loss of VBUS power.
2609 * For example, if a host controller doesn't maintain VBUS suspend current
2610 * during a system sleep or is reset when the system wakes up, all the USB
2611 * power sessions below it will be broken. This is especially troublesome
2612 * for mass-storage devices containing mounted filesystems, since the
2613 * device will appear to have disconnected and all the memory mappings
2614 * to it will be lost. Using the USB_PERSIST facility, the device can be
2615 * made to appear as if it had not disconnected.
2617 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2618 * every effort to insure that the same device is present after the
2619 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2620 * quite possible for a device to remain unaltered but its media to be
2621 * changed. If the user replaces a flash memory card while the system is
2622 * asleep, he will have only himself to blame when the filesystem on the
2623 * new card is corrupted and the system crashes.
2625 * Returns 0 on success, else negative errno.
2627 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2629 struct usb_hub *hub = hdev_to_hub(udev->parent);
2630 int port1 = udev->portnum;
2632 u16 portchange, portstatus;
2634 /* Skip the initial Clear-Suspend step for a remote wakeup */
2635 status = hub_port_status(hub, port1, &portstatus, &portchange);
2636 if (status == 0 && !port_is_suspended(hub, portstatus))
2637 goto SuspendCleared;
2639 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2641 set_bit(port1, hub->busy_bits);
2643 /* see 7.1.7.7; affects power usage, but not budgeting */
2644 if (hub_is_superspeed(hub->hdev))
2645 status = set_port_feature(hub->hdev,
2646 port1 | (USB_SS_PORT_LS_U0 << 3),
2647 USB_PORT_FEAT_LINK_STATE);
2649 status = clear_port_feature(hub->hdev,
2650 port1, USB_PORT_FEAT_SUSPEND);
2652 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2655 /* drive resume for at least 20 msec */
2656 dev_dbg(&udev->dev, "usb %sresume\n",
2657 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2660 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2661 * stop resume signaling. Then finish the resume
2664 status = hub_port_status(hub, port1, &portstatus, &portchange);
2666 /* TRSMRCY = 10 msec */
2672 if (hub_is_superspeed(hub->hdev)) {
2673 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2674 clear_port_feature(hub->hdev, port1,
2675 USB_PORT_FEAT_C_PORT_LINK_STATE);
2677 if (portchange & USB_PORT_STAT_C_SUSPEND)
2678 clear_port_feature(hub->hdev, port1,
2679 USB_PORT_FEAT_C_SUSPEND);
2683 clear_bit(port1, hub->busy_bits);
2685 status = check_port_resume_type(udev,
2686 hub, port1, status, portchange, portstatus);
2688 status = finish_port_resume(udev);
2690 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2691 hub_port_logical_disconnect(hub, port1);
2693 /* Try to enable USB2 hardware LPM */
2694 if (udev->usb2_hw_lpm_capable == 1)
2695 usb_set_usb2_hardware_lpm(udev, 1);
2701 /* caller has locked udev */
2702 int usb_remote_wakeup(struct usb_device *udev)
2706 if (udev->state == USB_STATE_SUSPENDED) {
2707 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2708 status = usb_autoresume_device(udev);
2710 /* Let the drivers do their thing, then... */
2711 usb_autosuspend_device(udev);
2717 #else /* CONFIG_USB_SUSPEND */
2719 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2721 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2726 /* However we may need to do a reset-resume */
2728 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2730 struct usb_hub *hub = hdev_to_hub(udev->parent);
2731 int port1 = udev->portnum;
2733 u16 portchange, portstatus;
2735 status = hub_port_status(hub, port1, &portstatus, &portchange);
2736 status = check_port_resume_type(udev,
2737 hub, port1, status, portchange, portstatus);
2740 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2741 hub_port_logical_disconnect(hub, port1);
2742 } else if (udev->reset_resume) {
2743 dev_dbg(&udev->dev, "reset-resume\n");
2744 status = usb_reset_and_verify_device(udev);
2751 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2753 struct usb_hub *hub = usb_get_intfdata (intf);
2754 struct usb_device *hdev = hub->hdev;
2757 /* Warn if children aren't already suspended */
2758 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2759 struct usb_device *udev;
2761 udev = hdev->children [port1-1];
2762 if (udev && udev->can_submit) {
2763 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2764 if (PMSG_IS_AUTO(msg))
2769 dev_dbg(&intf->dev, "%s\n", __func__);
2771 /* stop khubd and related activity */
2772 hub_quiesce(hub, HUB_SUSPEND);
2776 static int hub_resume(struct usb_interface *intf)
2778 struct usb_hub *hub = usb_get_intfdata(intf);
2780 dev_dbg(&intf->dev, "%s\n", __func__);
2781 hub_activate(hub, HUB_RESUME);
2785 static int hub_reset_resume(struct usb_interface *intf)
2787 struct usb_hub *hub = usb_get_intfdata(intf);
2789 dev_dbg(&intf->dev, "%s\n", __func__);
2790 hub_activate(hub, HUB_RESET_RESUME);
2795 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2796 * @rhdev: struct usb_device for the root hub
2798 * The USB host controller driver calls this function when its root hub
2799 * is resumed and Vbus power has been interrupted or the controller
2800 * has been reset. The routine marks @rhdev as having lost power.
2801 * When the hub driver is resumed it will take notice and carry out
2802 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2803 * the others will be disconnected.
2805 void usb_root_hub_lost_power(struct usb_device *rhdev)
2807 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2808 rhdev->reset_resume = 1;
2810 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2812 #else /* CONFIG_PM */
2814 #define hub_suspend NULL
2815 #define hub_resume NULL
2816 #define hub_reset_resume NULL
2820 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2822 * Between connect detection and reset signaling there must be a delay
2823 * of 100ms at least for debounce and power-settling. The corresponding
2824 * timer shall restart whenever the downstream port detects a disconnect.
2826 * Apparently there are some bluetooth and irda-dongles and a number of
2827 * low-speed devices for which this debounce period may last over a second.
2828 * Not covered by the spec - but easy to deal with.
2830 * This implementation uses a 1500ms total debounce timeout; if the
2831 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2832 * every 25ms for transient disconnects. When the port status has been
2833 * unchanged for 100ms it returns the port status.
2835 static int hub_port_debounce(struct usb_hub *hub, int port1)
2838 int total_time, stable_time = 0;
2839 u16 portchange, portstatus;
2840 unsigned connection = 0xffff;
2842 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2843 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2847 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2848 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2849 stable_time += HUB_DEBOUNCE_STEP;
2850 if (stable_time >= HUB_DEBOUNCE_STABLE)
2854 connection = portstatus & USB_PORT_STAT_CONNECTION;
2857 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2858 clear_port_feature(hub->hdev, port1,
2859 USB_PORT_FEAT_C_CONNECTION);
2862 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2864 msleep(HUB_DEBOUNCE_STEP);
2867 dev_dbg (hub->intfdev,
2868 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2869 port1, total_time, stable_time, portstatus);
2871 if (stable_time < HUB_DEBOUNCE_STABLE)
2876 void usb_ep0_reinit(struct usb_device *udev)
2878 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2879 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2880 usb_enable_endpoint(udev, &udev->ep0, true);
2882 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2884 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2885 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2887 static int hub_set_address(struct usb_device *udev, int devnum)
2890 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2893 * The host controller will choose the device address,
2894 * instead of the core having chosen it earlier
2896 if (!hcd->driver->address_device && devnum <= 1)
2898 if (udev->state == USB_STATE_ADDRESS)
2900 if (udev->state != USB_STATE_DEFAULT)
2902 if (hcd->driver->address_device)
2903 retval = hcd->driver->address_device(hcd, udev);
2905 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2906 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2907 NULL, 0, USB_CTRL_SET_TIMEOUT);
2909 update_devnum(udev, devnum);
2910 /* Device now using proper address. */
2911 usb_set_device_state(udev, USB_STATE_ADDRESS);
2912 usb_ep0_reinit(udev);
2917 /* Reset device, (re)assign address, get device descriptor.
2918 * Device connection must be stable, no more debouncing needed.
2919 * Returns device in USB_STATE_ADDRESS, except on error.
2921 * If this is called for an already-existing device (as part of
2922 * usb_reset_and_verify_device), the caller must own the device lock. For a
2923 * newly detected device that is not accessible through any global
2924 * pointers, it's not necessary to lock the device.
2927 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2930 static DEFINE_MUTEX(usb_address0_mutex);
2932 struct usb_device *hdev = hub->hdev;
2933 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2935 unsigned delay = HUB_SHORT_RESET_TIME;
2936 enum usb_device_speed oldspeed = udev->speed;
2938 int devnum = udev->devnum;
2940 /* root hub ports have a slightly longer reset period
2941 * (from USB 2.0 spec, section 7.1.7.5)
2943 if (!hdev->parent) {
2944 delay = HUB_ROOT_RESET_TIME;
2945 if (port1 == hdev->bus->otg_port)
2946 hdev->bus->b_hnp_enable = 0;
2949 /* Some low speed devices have problems with the quick delay, so */
2950 /* be a bit pessimistic with those devices. RHbug #23670 */
2951 if (oldspeed == USB_SPEED_LOW)
2952 delay = HUB_LONG_RESET_TIME;
2954 mutex_lock(&usb_address0_mutex);
2956 /* Reset the device; full speed may morph to high speed */
2957 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2958 retval = hub_port_reset(hub, port1, udev, delay, false);
2959 if (retval < 0) /* error or disconnect */
2961 /* success, speed is known */
2965 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2966 dev_dbg(&udev->dev, "device reset changed speed!\n");
2969 oldspeed = udev->speed;
2971 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2972 * it's fixed size except for full speed devices.
2973 * For Wireless USB devices, ep0 max packet is always 512 (tho
2974 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2976 switch (udev->speed) {
2977 case USB_SPEED_SUPER:
2978 case USB_SPEED_WIRELESS: /* fixed at 512 */
2979 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2981 case USB_SPEED_HIGH: /* fixed at 64 */
2982 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2984 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2985 /* to determine the ep0 maxpacket size, try to read
2986 * the device descriptor to get bMaxPacketSize0 and
2987 * then correct our initial guess.
2989 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2991 case USB_SPEED_LOW: /* fixed at 8 */
2992 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2998 if (udev->speed == USB_SPEED_WIRELESS)
2999 speed = "variable speed Wireless";
3001 speed = usb_speed_string(udev->speed);
3003 if (udev->speed != USB_SPEED_SUPER)
3004 dev_info(&udev->dev,
3005 "%s %s USB device number %d using %s\n",
3006 (udev->config) ? "reset" : "new", speed,
3007 devnum, udev->bus->controller->driver->name);
3009 /* Set up TT records, if needed */
3011 udev->tt = hdev->tt;
3012 udev->ttport = hdev->ttport;
3013 } else if (udev->speed != USB_SPEED_HIGH
3014 && hdev->speed == USB_SPEED_HIGH) {
3016 dev_err(&udev->dev, "parent hub has no TT\n");
3020 udev->tt = &hub->tt;
3021 udev->ttport = port1;
3024 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3025 * Because device hardware and firmware is sometimes buggy in
3026 * this area, and this is how Linux has done it for ages.
3027 * Change it cautiously.
3029 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3030 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3031 * so it may help with some non-standards-compliant devices.
3032 * Otherwise we start with SET_ADDRESS and then try to read the
3033 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3036 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3037 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3038 struct usb_device_descriptor *buf;
3041 #define GET_DESCRIPTOR_BUFSIZE 64
3042 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3048 /* Retry on all errors; some devices are flakey.
3049 * 255 is for WUSB devices, we actually need to use
3050 * 512 (WUSB1.0[4.8.1]).
3052 for (j = 0; j < 3; ++j) {
3053 buf->bMaxPacketSize0 = 0;
3054 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3055 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3056 USB_DT_DEVICE << 8, 0,
3057 buf, GET_DESCRIPTOR_BUFSIZE,
3058 initial_descriptor_timeout);
3059 switch (buf->bMaxPacketSize0) {
3060 case 8: case 16: case 32: case 64: case 255:
3061 if (buf->bDescriptorType ==
3075 udev->descriptor.bMaxPacketSize0 =
3076 buf->bMaxPacketSize0;
3079 retval = hub_port_reset(hub, port1, udev, delay, false);
3080 if (retval < 0) /* error or disconnect */
3082 if (oldspeed != udev->speed) {
3084 "device reset changed speed!\n");
3090 "device descriptor read/64, error %d\n",
3095 #undef GET_DESCRIPTOR_BUFSIZE
3099 * If device is WUSB, we already assigned an
3100 * unauthorized address in the Connect Ack sequence;
3101 * authorization will assign the final address.
3103 if (udev->wusb == 0) {
3104 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3105 retval = hub_set_address(udev, devnum);
3112 "device not accepting address %d, error %d\n",
3116 if (udev->speed == USB_SPEED_SUPER) {
3117 devnum = udev->devnum;
3118 dev_info(&udev->dev,
3119 "%s SuperSpeed USB device number %d using %s\n",
3120 (udev->config) ? "reset" : "new",
3121 devnum, udev->bus->controller->driver->name);
3124 /* cope with hardware quirkiness:
3125 * - let SET_ADDRESS settle, some device hardware wants it
3126 * - read ep0 maxpacket even for high and low speed,
3129 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3133 retval = usb_get_device_descriptor(udev, 8);
3136 "device descriptor read/8, error %d\n",
3149 * Some superspeed devices have finished the link training process
3150 * and attached to a superspeed hub port, but the device descriptor
3151 * got from those devices show they aren't superspeed devices. Warm
3152 * reset the port attached by the devices can fix them.
3154 if ((udev->speed == USB_SPEED_SUPER) &&
3155 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3156 dev_err(&udev->dev, "got a wrong device descriptor, "
3157 "warm reset device\n");
3158 hub_port_reset(hub, port1, udev,
3159 HUB_BH_RESET_TIME, true);
3164 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3165 udev->speed == USB_SPEED_SUPER)
3168 i = udev->descriptor.bMaxPacketSize0;
3169 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3170 if (udev->speed == USB_SPEED_LOW ||
3171 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3172 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3176 if (udev->speed == USB_SPEED_FULL)
3177 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3179 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3180 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3181 usb_ep0_reinit(udev);
3184 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3185 if (retval < (signed)sizeof(udev->descriptor)) {
3186 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3193 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3194 retval = usb_get_bos_descriptor(udev);
3196 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3197 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3198 udev->lpm_capable = 1;
3203 /* notify HCD that we have a device connected and addressed */
3204 if (hcd->driver->update_device)
3205 hcd->driver->update_device(hcd, udev);
3208 hub_port_disable(hub, port1, 0);
3209 update_devnum(udev, devnum); /* for disconnect processing */
3211 mutex_unlock(&usb_address0_mutex);
3216 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3218 struct usb_qualifier_descriptor *qual;
3221 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3225 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3226 qual, sizeof *qual);
3227 if (status == sizeof *qual) {
3228 dev_info(&udev->dev, "not running at top speed; "
3229 "connect to a high speed hub\n");
3230 /* hub LEDs are probably harder to miss than syslog */
3231 if (hub->has_indicators) {
3232 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3233 schedule_delayed_work (&hub->leds, 0);
3240 hub_power_remaining (struct usb_hub *hub)
3242 struct usb_device *hdev = hub->hdev;
3246 if (!hub->limited_power)
3249 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3250 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3251 struct usb_device *udev = hdev->children[port1 - 1];
3257 /* Unconfigured devices may not use more than 100mA,
3258 * or 8mA for OTG ports */
3259 if (udev->actconfig)
3260 delta = udev->actconfig->desc.bMaxPower * 2;
3261 else if (port1 != udev->bus->otg_port || hdev->parent)
3265 if (delta > hub->mA_per_port)
3266 dev_warn(&udev->dev,
3267 "%dmA is over %umA budget for port %d!\n",
3268 delta, hub->mA_per_port, port1);
3271 if (remaining < 0) {
3272 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3279 /* Handle physical or logical connection change events.
3280 * This routine is called when:
3281 * a port connection-change occurs;
3282 * a port enable-change occurs (often caused by EMI);
3283 * usb_reset_and_verify_device() encounters changed descriptors (as from
3284 * a firmware download)
3285 * caller already locked the hub
3287 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3288 u16 portstatus, u16 portchange)
3290 struct usb_device *hdev = hub->hdev;
3291 struct device *hub_dev = hub->intfdev;
3292 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3293 unsigned wHubCharacteristics =
3294 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3295 struct usb_device *udev;
3299 "port %d, status %04x, change %04x, %s\n",
3300 port1, portstatus, portchange, portspeed(hub, portstatus));
3302 if (hub->has_indicators) {
3303 set_port_led(hub, port1, HUB_LED_AUTO);
3304 hub->indicator[port1-1] = INDICATOR_AUTO;
3307 #ifdef CONFIG_USB_OTG
3308 /* during HNP, don't repeat the debounce */
3309 if (hdev->bus->is_b_host)
3310 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3311 USB_PORT_STAT_C_ENABLE);
3314 /* Try to resuscitate an existing device */
3315 udev = hdev->children[port1-1];
3316 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3317 udev->state != USB_STATE_NOTATTACHED) {
3318 usb_lock_device(udev);
3319 if (portstatus & USB_PORT_STAT_ENABLE) {
3320 status = 0; /* Nothing to do */
3322 #ifdef CONFIG_USB_SUSPEND
3323 } else if (udev->state == USB_STATE_SUSPENDED &&
3324 udev->persist_enabled) {
3325 /* For a suspended device, treat this as a
3326 * remote wakeup event.
3328 status = usb_remote_wakeup(udev);
3332 status = -ENODEV; /* Don't resuscitate */
3334 usb_unlock_device(udev);
3337 clear_bit(port1, hub->change_bits);
3342 /* Disconnect any existing devices under this port */
3344 usb_disconnect(&hdev->children[port1-1]);
3345 clear_bit(port1, hub->change_bits);
3347 /* We can forget about a "removed" device when there's a physical
3348 * disconnect or the connect status changes.
3350 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3351 (portchange & USB_PORT_STAT_C_CONNECTION))
3352 clear_bit(port1, hub->removed_bits);
3354 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3355 USB_PORT_STAT_C_ENABLE)) {
3356 status = hub_port_debounce(hub, port1);
3358 if (printk_ratelimit())
3359 dev_err(hub_dev, "connect-debounce failed, "
3360 "port %d disabled\n", port1);
3361 portstatus &= ~USB_PORT_STAT_CONNECTION;
3363 portstatus = status;
3367 /* Return now if debouncing failed or nothing is connected or
3368 * the device was "removed".
3370 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3371 test_bit(port1, hub->removed_bits)) {
3373 /* maybe switch power back on (e.g. root hub was reset) */
3374 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3375 && !port_is_power_on(hub, portstatus))
3376 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3378 if (portstatus & USB_PORT_STAT_ENABLE)
3383 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3385 /* reallocate for each attempt, since references
3386 * to the previous one can escape in various ways
3388 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3391 "couldn't allocate port %d usb_device\n",
3396 usb_set_device_state(udev, USB_STATE_POWERED);
3397 udev->bus_mA = hub->mA_per_port;
3398 udev->level = hdev->level + 1;
3399 udev->wusb = hub_is_wusb(hub);
3401 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3402 if (hub_is_superspeed(hub->hdev))
3403 udev->speed = USB_SPEED_SUPER;
3405 udev->speed = USB_SPEED_UNKNOWN;
3407 choose_devnum(udev);
3408 if (udev->devnum <= 0) {
3409 status = -ENOTCONN; /* Don't retry */
3413 /* reset (non-USB 3.0 devices) and get descriptor */
3414 status = hub_port_init(hub, udev, port1, i);
3418 usb_detect_quirks(udev);
3419 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3422 /* consecutive bus-powered hubs aren't reliable; they can
3423 * violate the voltage drop budget. if the new child has
3424 * a "powered" LED, users should notice we didn't enable it
3425 * (without reading syslog), even without per-port LEDs
3428 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3429 && udev->bus_mA <= 100) {
3432 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3435 dev_dbg(&udev->dev, "get status %d ?\n", status);
3438 le16_to_cpus(&devstat);
3439 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3441 "can't connect bus-powered hub "
3443 if (hub->has_indicators) {
3444 hub->indicator[port1-1] =
3445 INDICATOR_AMBER_BLINK;
3446 schedule_delayed_work (&hub->leds, 0);
3448 status = -ENOTCONN; /* Don't retry */
3453 /* check for devices running slower than they could */
3454 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3455 && udev->speed == USB_SPEED_FULL
3456 && highspeed_hubs != 0)
3457 check_highspeed (hub, udev, port1);
3459 /* Store the parent's children[] pointer. At this point
3460 * udev becomes globally accessible, although presumably
3461 * no one will look at it until hdev is unlocked.
3465 /* We mustn't add new devices if the parent hub has
3466 * been disconnected; we would race with the
3467 * recursively_mark_NOTATTACHED() routine.
3469 spin_lock_irq(&device_state_lock);
3470 if (hdev->state == USB_STATE_NOTATTACHED)
3473 hdev->children[port1-1] = udev;
3474 spin_unlock_irq(&device_state_lock);
3476 /* Run it through the hoops (find a driver, etc) */
3478 status = usb_new_device(udev);
3480 spin_lock_irq(&device_state_lock);
3481 hdev->children[port1-1] = NULL;
3482 spin_unlock_irq(&device_state_lock);
3489 status = hub_power_remaining(hub);
3491 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3496 hub_port_disable(hub, port1, 1);
3498 usb_ep0_reinit(udev);
3499 release_devnum(udev);
3502 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3505 if (hub->hdev->parent ||
3506 !hcd->driver->port_handed_over ||
3507 !(hcd->driver->port_handed_over)(hcd, port1))
3508 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3512 hub_port_disable(hub, port1, 1);
3513 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3514 hcd->driver->relinquish_port(hcd, port1);
3517 static void hub_events(void)
3519 struct list_head *tmp;
3520 struct usb_device *hdev;
3521 struct usb_interface *intf;
3522 struct usb_hub *hub;
3523 struct device *hub_dev;
3532 * We restart the list every time to avoid a deadlock with
3533 * deleting hubs downstream from this one. This should be
3534 * safe since we delete the hub from the event list.
3535 * Not the most efficient, but avoids deadlocks.
3539 /* Grab the first entry at the beginning of the list */
3540 spin_lock_irq(&hub_event_lock);
3541 if (list_empty(&hub_event_list)) {
3542 spin_unlock_irq(&hub_event_lock);
3546 tmp = hub_event_list.next;
3549 hub = list_entry(tmp, struct usb_hub, event_list);
3550 kref_get(&hub->kref);
3551 spin_unlock_irq(&hub_event_lock);
3554 hub_dev = hub->intfdev;
3555 intf = to_usb_interface(hub_dev);
3556 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3557 hdev->state, hub->descriptor
3558 ? hub->descriptor->bNbrPorts
3560 /* NOTE: expects max 15 ports... */
3561 (u16) hub->change_bits[0],
3562 (u16) hub->event_bits[0]);
3564 /* Lock the device, then check to see if we were
3565 * disconnected while waiting for the lock to succeed. */
3566 usb_lock_device(hdev);
3567 if (unlikely(hub->disconnected))
3568 goto loop_disconnected;
3570 /* If the hub has died, clean up after it */
3571 if (hdev->state == USB_STATE_NOTATTACHED) {
3572 hub->error = -ENODEV;
3573 hub_quiesce(hub, HUB_DISCONNECT);
3578 ret = usb_autopm_get_interface(intf);
3580 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3584 /* If this is an inactive hub, do nothing */
3589 dev_dbg (hub_dev, "resetting for error %d\n",
3592 ret = usb_reset_device(hdev);
3595 "error resetting hub: %d\n", ret);
3603 /* deal with port status changes */
3604 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3605 if (test_bit(i, hub->busy_bits))
3607 connect_change = test_bit(i, hub->change_bits);
3608 if (!test_and_clear_bit(i, hub->event_bits) &&
3612 ret = hub_port_status(hub, i,
3613 &portstatus, &portchange);
3617 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3618 clear_port_feature(hdev, i,
3619 USB_PORT_FEAT_C_CONNECTION);
3623 if (portchange & USB_PORT_STAT_C_ENABLE) {
3624 if (!connect_change)
3626 "port %d enable change, "
3629 clear_port_feature(hdev, i,
3630 USB_PORT_FEAT_C_ENABLE);
3633 * EM interference sometimes causes badly
3634 * shielded USB devices to be shutdown by
3635 * the hub, this hack enables them again.
3636 * Works at least with mouse driver.
3638 if (!(portstatus & USB_PORT_STAT_ENABLE)
3640 && hdev->children[i-1]) {
3643 "disabled by hub (EMI?), "
3650 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3651 struct usb_device *udev;
3653 clear_port_feature(hdev, i,
3654 USB_PORT_FEAT_C_SUSPEND);
3655 udev = hdev->children[i-1];
3657 /* TRSMRCY = 10 msec */
3660 usb_lock_device(udev);
3661 ret = usb_remote_wakeup(hdev->
3663 usb_unlock_device(udev);
3668 hub_port_disable(hub, i, 1);
3671 "resume on port %d, status %d\n",
3675 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3679 dev_dbg(hub_dev, "over-current change on port "
3681 clear_port_feature(hdev, i,
3682 USB_PORT_FEAT_C_OVER_CURRENT);
3683 msleep(100); /* Cool down */
3684 hub_power_on(hub, true);
3685 hub_port_status(hub, i, &status, &unused);
3686 if (status & USB_PORT_STAT_OVERCURRENT)
3687 dev_err(hub_dev, "over-current "
3688 "condition on port %d\n", i);
3691 if (portchange & USB_PORT_STAT_C_RESET) {
3693 "reset change on port %d\n",
3695 clear_port_feature(hdev, i,
3696 USB_PORT_FEAT_C_RESET);
3698 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3699 hub_is_superspeed(hub->hdev)) {
3701 "warm reset change on port %d\n",
3703 clear_port_feature(hdev, i,
3704 USB_PORT_FEAT_C_BH_PORT_RESET);
3706 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3707 clear_port_feature(hub->hdev, i,
3708 USB_PORT_FEAT_C_PORT_LINK_STATE);
3710 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3712 "config error on port %d\n",
3714 clear_port_feature(hub->hdev, i,
3715 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3718 /* Warm reset a USB3 protocol port if it's in
3719 * SS.Inactive state.
3721 if (hub_port_warm_reset_required(hub, portstatus)) {
3722 dev_dbg(hub_dev, "warm reset port %d\n", i);
3723 hub_port_reset(hub, i, NULL,
3724 HUB_BH_RESET_TIME, true);
3728 hub_port_connect_change(hub, i,
3729 portstatus, portchange);
3732 /* deal with hub status changes */
3733 if (test_and_clear_bit(0, hub->event_bits) == 0)
3735 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3736 dev_err (hub_dev, "get_hub_status failed\n");
3738 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3739 dev_dbg (hub_dev, "power change\n");
3740 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3741 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3742 /* FIXME: Is this always true? */
3743 hub->limited_power = 1;
3745 hub->limited_power = 0;
3747 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3751 dev_dbg(hub_dev, "over-current change\n");
3752 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3753 msleep(500); /* Cool down */
3754 hub_power_on(hub, true);
3755 hub_hub_status(hub, &status, &unused);
3756 if (status & HUB_STATUS_OVERCURRENT)
3757 dev_err(hub_dev, "over-current "
3763 /* Balance the usb_autopm_get_interface() above */
3764 usb_autopm_put_interface_no_suspend(intf);
3766 /* Balance the usb_autopm_get_interface_no_resume() in
3767 * kick_khubd() and allow autosuspend.
3769 usb_autopm_put_interface(intf);
3771 usb_unlock_device(hdev);
3772 kref_put(&hub->kref, hub_release);
3774 } /* end while (1) */
3777 static int hub_thread(void *__unused)
3779 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3780 * port handover. Otherwise it might see that a full-speed device
3781 * was gone before the EHCI controller had handed its port over to
3782 * the companion full-speed controller.
3788 wait_event_freezable(khubd_wait,
3789 !list_empty(&hub_event_list) ||
3790 kthread_should_stop());
3791 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3793 pr_debug("%s: khubd exiting\n", usbcore_name);
3797 static const struct usb_device_id hub_id_table[] = {
3798 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3799 .bDeviceClass = USB_CLASS_HUB},
3800 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3801 .bInterfaceClass = USB_CLASS_HUB},
3802 { } /* Terminating entry */
3805 MODULE_DEVICE_TABLE (usb, hub_id_table);
3807 static struct usb_driver hub_driver = {
3810 .disconnect = hub_disconnect,
3811 .suspend = hub_suspend,
3812 .resume = hub_resume,
3813 .reset_resume = hub_reset_resume,
3814 .pre_reset = hub_pre_reset,
3815 .post_reset = hub_post_reset,
3816 .unlocked_ioctl = hub_ioctl,
3817 .id_table = hub_id_table,
3818 .supports_autosuspend = 1,
3821 int usb_hub_init(void)
3823 if (usb_register(&hub_driver) < 0) {
3824 printk(KERN_ERR "%s: can't register hub driver\n",
3829 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3830 if (!IS_ERR(khubd_task))
3833 /* Fall through if kernel_thread failed */
3834 usb_deregister(&hub_driver);
3835 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3840 void usb_hub_cleanup(void)
3842 kthread_stop(khubd_task);
3845 * Hub resources are freed for us by usb_deregister. It calls
3846 * usb_driver_purge on every device which in turn calls that
3847 * devices disconnect function if it is using this driver.
3848 * The hub_disconnect function takes care of releasing the
3849 * individual hub resources. -greg
3851 usb_deregister(&hub_driver);
3852 } /* usb_hub_cleanup() */
3854 static int descriptors_changed(struct usb_device *udev,
3855 struct usb_device_descriptor *old_device_descriptor)
3859 unsigned serial_len = 0;
3861 unsigned old_length;
3865 if (memcmp(&udev->descriptor, old_device_descriptor,
3866 sizeof(*old_device_descriptor)) != 0)
3869 /* Since the idVendor, idProduct, and bcdDevice values in the
3870 * device descriptor haven't changed, we will assume the
3871 * Manufacturer and Product strings haven't changed either.
3872 * But the SerialNumber string could be different (e.g., a
3873 * different flash card of the same brand).
3876 serial_len = strlen(udev->serial) + 1;
3879 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3880 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3881 len = max(len, old_length);
3884 buf = kmalloc(len, GFP_NOIO);
3886 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3887 /* assume the worst */
3890 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3891 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3892 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3894 if (length != old_length) {
3895 dev_dbg(&udev->dev, "config index %d, error %d\n",
3900 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3902 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3904 ((struct usb_config_descriptor *) buf)->
3905 bConfigurationValue);
3911 if (!changed && serial_len) {
3912 length = usb_string(udev, udev->descriptor.iSerialNumber,
3914 if (length + 1 != serial_len) {
3915 dev_dbg(&udev->dev, "serial string error %d\n",
3918 } else if (memcmp(buf, udev->serial, length) != 0) {
3919 dev_dbg(&udev->dev, "serial string changed\n");
3929 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3930 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3932 * WARNING - don't use this routine to reset a composite device
3933 * (one with multiple interfaces owned by separate drivers)!
3934 * Use usb_reset_device() instead.
3936 * Do a port reset, reassign the device's address, and establish its
3937 * former operating configuration. If the reset fails, or the device's
3938 * descriptors change from their values before the reset, or the original
3939 * configuration and altsettings cannot be restored, a flag will be set
3940 * telling khubd to pretend the device has been disconnected and then
3941 * re-connected. All drivers will be unbound, and the device will be
3942 * re-enumerated and probed all over again.
3944 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3945 * flagged for logical disconnection, or some other negative error code
3946 * if the reset wasn't even attempted.
3948 * The caller must own the device lock. For example, it's safe to use
3949 * this from a driver probe() routine after downloading new firmware.
3950 * For calls that might not occur during probe(), drivers should lock
3951 * the device using usb_lock_device_for_reset().
3953 * Locking exception: This routine may also be called from within an
3954 * autoresume handler. Such usage won't conflict with other tasks
3955 * holding the device lock because these tasks should always call
3956 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3958 static int usb_reset_and_verify_device(struct usb_device *udev)
3960 struct usb_device *parent_hdev = udev->parent;
3961 struct usb_hub *parent_hub;
3962 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3963 struct usb_device_descriptor descriptor = udev->descriptor;
3965 int port1 = udev->portnum;
3967 if (udev->state == USB_STATE_NOTATTACHED ||
3968 udev->state == USB_STATE_SUSPENDED) {
3969 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3975 /* this requires hcd-specific logic; see ohci_restart() */
3976 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3979 parent_hub = hdev_to_hub(parent_hdev);
3981 set_bit(port1, parent_hub->busy_bits);
3982 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3984 /* ep0 maxpacket size may change; let the HCD know about it.
3985 * Other endpoints will be handled by re-enumeration. */
3986 usb_ep0_reinit(udev);
3987 ret = hub_port_init(parent_hub, udev, port1, i);
3988 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3991 clear_bit(port1, parent_hub->busy_bits);
3996 /* Device might have changed firmware (DFU or similar) */
3997 if (descriptors_changed(udev, &descriptor)) {
3998 dev_info(&udev->dev, "device firmware changed\n");
3999 udev->descriptor = descriptor; /* for disconnect() calls */
4003 /* Restore the device's previous configuration */
4004 if (!udev->actconfig)
4007 mutex_lock(hcd->bandwidth_mutex);
4008 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4010 dev_warn(&udev->dev,
4011 "Busted HC? Not enough HCD resources for "
4012 "old configuration.\n");
4013 mutex_unlock(hcd->bandwidth_mutex);
4016 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4017 USB_REQ_SET_CONFIGURATION, 0,
4018 udev->actconfig->desc.bConfigurationValue, 0,
4019 NULL, 0, USB_CTRL_SET_TIMEOUT);
4022 "can't restore configuration #%d (error=%d)\n",
4023 udev->actconfig->desc.bConfigurationValue, ret);
4024 mutex_unlock(hcd->bandwidth_mutex);
4027 mutex_unlock(hcd->bandwidth_mutex);
4028 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4030 /* Put interfaces back into the same altsettings as before.
4031 * Don't bother to send the Set-Interface request for interfaces
4032 * that were already in altsetting 0; besides being unnecessary,
4033 * many devices can't handle it. Instead just reset the host-side
4036 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4037 struct usb_host_config *config = udev->actconfig;
4038 struct usb_interface *intf = config->interface[i];
4039 struct usb_interface_descriptor *desc;
4041 desc = &intf->cur_altsetting->desc;
4042 if (desc->bAlternateSetting == 0) {
4043 usb_disable_interface(udev, intf, true);
4044 usb_enable_interface(udev, intf, true);
4047 /* Let the bandwidth allocation function know that this
4048 * device has been reset, and it will have to use
4049 * alternate setting 0 as the current alternate setting.
4051 intf->resetting_device = 1;
4052 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4053 desc->bAlternateSetting);
4054 intf->resetting_device = 0;
4057 dev_err(&udev->dev, "failed to restore interface %d "
4058 "altsetting %d (error=%d)\n",
4059 desc->bInterfaceNumber,
4060 desc->bAlternateSetting,
4070 hub_port_logical_disconnect(parent_hub, port1);
4075 * usb_reset_device - warn interface drivers and perform a USB port reset
4076 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4078 * Warns all drivers bound to registered interfaces (using their pre_reset
4079 * method), performs the port reset, and then lets the drivers know that
4080 * the reset is over (using their post_reset method).
4082 * Return value is the same as for usb_reset_and_verify_device().
4084 * The caller must own the device lock. For example, it's safe to use
4085 * this from a driver probe() routine after downloading new firmware.
4086 * For calls that might not occur during probe(), drivers should lock
4087 * the device using usb_lock_device_for_reset().
4089 * If an interface is currently being probed or disconnected, we assume
4090 * its driver knows how to handle resets. For all other interfaces,
4091 * if the driver doesn't have pre_reset and post_reset methods then
4092 * we attempt to unbind it and rebind afterward.
4094 int usb_reset_device(struct usb_device *udev)
4098 struct usb_host_config *config = udev->actconfig;
4100 if (udev->state == USB_STATE_NOTATTACHED ||
4101 udev->state == USB_STATE_SUSPENDED) {
4102 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4107 /* Prevent autosuspend during the reset */
4108 usb_autoresume_device(udev);
4111 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4112 struct usb_interface *cintf = config->interface[i];
4113 struct usb_driver *drv;
4116 if (cintf->dev.driver) {
4117 drv = to_usb_driver(cintf->dev.driver);
4118 if (drv->pre_reset && drv->post_reset)
4119 unbind = (drv->pre_reset)(cintf);
4120 else if (cintf->condition ==
4121 USB_INTERFACE_BOUND)
4124 usb_forced_unbind_intf(cintf);
4129 ret = usb_reset_and_verify_device(udev);
4132 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4133 struct usb_interface *cintf = config->interface[i];
4134 struct usb_driver *drv;
4135 int rebind = cintf->needs_binding;
4137 if (!rebind && cintf->dev.driver) {
4138 drv = to_usb_driver(cintf->dev.driver);
4139 if (drv->post_reset)
4140 rebind = (drv->post_reset)(cintf);
4141 else if (cintf->condition ==
4142 USB_INTERFACE_BOUND)
4145 if (ret == 0 && rebind)
4146 usb_rebind_intf(cintf);
4150 usb_autosuspend_device(udev);
4153 EXPORT_SYMBOL_GPL(usb_reset_device);
4157 * usb_queue_reset_device - Reset a USB device from an atomic context
4158 * @iface: USB interface belonging to the device to reset
4160 * This function can be used to reset a USB device from an atomic
4161 * context, where usb_reset_device() won't work (as it blocks).
4163 * Doing a reset via this method is functionally equivalent to calling
4164 * usb_reset_device(), except for the fact that it is delayed to a
4165 * workqueue. This means that any drivers bound to other interfaces
4166 * might be unbound, as well as users from usbfs in user space.
4170 * - Scheduling two resets at the same time from two different drivers
4171 * attached to two different interfaces of the same device is
4172 * possible; depending on how the driver attached to each interface
4173 * handles ->pre_reset(), the second reset might happen or not.
4175 * - If a driver is unbound and it had a pending reset, the reset will
4178 * - This function can be called during .probe() or .disconnect()
4179 * times. On return from .disconnect(), any pending resets will be
4182 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4185 * NOTE: We don't do any reference count tracking because it is not
4186 * needed. The lifecycle of the work_struct is tied to the
4187 * usb_interface. Before destroying the interface we cancel the
4188 * work_struct, so the fact that work_struct is queued and or
4189 * running means the interface (and thus, the device) exist and
4192 void usb_queue_reset_device(struct usb_interface *iface)
4194 schedule_work(&iface->reset_ws);
4196 EXPORT_SYMBOL_GPL(usb_queue_reset_device);