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
156 static void hub_release(struct kref *kref);
157 static int usb_reset_and_verify_device(struct usb_device *udev);
159 static inline char *portspeed(struct usb_hub *hub, int portstatus)
161 if (hub_is_superspeed(hub->hdev))
163 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
165 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
171 /* Note that hdev or one of its children must be locked! */
172 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
174 if (!hdev || !hdev->actconfig)
176 return usb_get_intfdata(hdev->actconfig->interface[0]);
179 /* USB 2.0 spec Section 11.24.4.5 */
180 static int get_hub_descriptor(struct usb_device *hdev, void *data)
185 if (hub_is_superspeed(hdev)) {
186 dtype = USB_DT_SS_HUB;
187 size = USB_DT_SS_HUB_SIZE;
190 size = sizeof(struct usb_hub_descriptor);
193 for (i = 0; i < 3; i++) {
194 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
195 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
196 dtype << 8, 0, data, size,
197 USB_CTRL_GET_TIMEOUT);
198 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
205 * USB 2.0 spec Section 11.24.2.1
207 static int clear_hub_feature(struct usb_device *hdev, int feature)
209 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
210 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
214 * USB 2.0 spec Section 11.24.2.2
216 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
218 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
219 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
224 * USB 2.0 spec Section 11.24.2.13
226 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
228 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
229 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
234 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
235 * for info about using port indicators
237 static void set_port_led(
243 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
244 USB_PORT_FEAT_INDICATOR);
246 dev_dbg (hub->intfdev,
247 "port %d indicator %s status %d\n",
249 ({ char *s; switch (selector) {
250 case HUB_LED_AMBER: s = "amber"; break;
251 case HUB_LED_GREEN: s = "green"; break;
252 case HUB_LED_OFF: s = "off"; break;
253 case HUB_LED_AUTO: s = "auto"; break;
254 default: s = "??"; break;
259 #define LED_CYCLE_PERIOD ((2*HZ)/3)
261 static void led_work (struct work_struct *work)
263 struct usb_hub *hub =
264 container_of(work, struct usb_hub, leds.work);
265 struct usb_device *hdev = hub->hdev;
267 unsigned changed = 0;
270 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
273 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
274 unsigned selector, mode;
276 /* 30%-50% duty cycle */
278 switch (hub->indicator[i]) {
280 case INDICATOR_CYCLE:
282 selector = HUB_LED_AUTO;
283 mode = INDICATOR_AUTO;
285 /* blinking green = sw attention */
286 case INDICATOR_GREEN_BLINK:
287 selector = HUB_LED_GREEN;
288 mode = INDICATOR_GREEN_BLINK_OFF;
290 case INDICATOR_GREEN_BLINK_OFF:
291 selector = HUB_LED_OFF;
292 mode = INDICATOR_GREEN_BLINK;
294 /* blinking amber = hw attention */
295 case INDICATOR_AMBER_BLINK:
296 selector = HUB_LED_AMBER;
297 mode = INDICATOR_AMBER_BLINK_OFF;
299 case INDICATOR_AMBER_BLINK_OFF:
300 selector = HUB_LED_OFF;
301 mode = INDICATOR_AMBER_BLINK;
303 /* blink green/amber = reserved */
304 case INDICATOR_ALT_BLINK:
305 selector = HUB_LED_GREEN;
306 mode = INDICATOR_ALT_BLINK_OFF;
308 case INDICATOR_ALT_BLINK_OFF:
309 selector = HUB_LED_AMBER;
310 mode = INDICATOR_ALT_BLINK;
315 if (selector != HUB_LED_AUTO)
317 set_port_led(hub, i + 1, selector);
318 hub->indicator[i] = mode;
320 if (!changed && blinkenlights) {
322 cursor %= hub->descriptor->bNbrPorts;
323 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
324 hub->indicator[cursor] = INDICATOR_CYCLE;
328 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
331 /* use a short timeout for hub/port status fetches */
332 #define USB_STS_TIMEOUT 1000
333 #define USB_STS_RETRIES 5
336 * USB 2.0 spec Section 11.24.2.6
338 static int get_hub_status(struct usb_device *hdev,
339 struct usb_hub_status *data)
341 int i, status = -ETIMEDOUT;
343 for (i = 0; i < USB_STS_RETRIES &&
344 (status == -ETIMEDOUT || status == -EPIPE); i++) {
345 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
346 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
347 data, sizeof(*data), USB_STS_TIMEOUT);
353 * USB 2.0 spec Section 11.24.2.7
355 static int get_port_status(struct usb_device *hdev, int port1,
356 struct usb_port_status *data)
358 int i, status = -ETIMEDOUT;
360 for (i = 0; i < USB_STS_RETRIES &&
361 (status == -ETIMEDOUT || status == -EPIPE); i++) {
362 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
363 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
364 data, sizeof(*data), USB_STS_TIMEOUT);
369 static int hub_port_status(struct usb_hub *hub, int port1,
370 u16 *status, u16 *change)
374 mutex_lock(&hub->status_mutex);
375 ret = get_port_status(hub->hdev, port1, &hub->status->port);
377 dev_err(hub->intfdev,
378 "%s failed (err = %d)\n", __func__, ret);
382 *status = le16_to_cpu(hub->status->port.wPortStatus);
383 *change = le16_to_cpu(hub->status->port.wPortChange);
387 mutex_unlock(&hub->status_mutex);
391 static void kick_khubd(struct usb_hub *hub)
395 spin_lock_irqsave(&hub_event_lock, flags);
396 if (!hub->disconnected && list_empty(&hub->event_list)) {
397 list_add_tail(&hub->event_list, &hub_event_list);
399 /* Suppress autosuspend until khubd runs */
400 usb_autopm_get_interface_no_resume(
401 to_usb_interface(hub->intfdev));
402 wake_up(&khubd_wait);
404 spin_unlock_irqrestore(&hub_event_lock, flags);
407 void usb_kick_khubd(struct usb_device *hdev)
409 struct usb_hub *hub = hdev_to_hub(hdev);
416 /* completion function, fires on port status changes and various faults */
417 static void hub_irq(struct urb *urb)
419 struct usb_hub *hub = urb->context;
420 int status = urb->status;
425 case -ENOENT: /* synchronous unlink */
426 case -ECONNRESET: /* async unlink */
427 case -ESHUTDOWN: /* hardware going away */
430 default: /* presumably an error */
431 /* Cause a hub reset after 10 consecutive errors */
432 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
433 if ((++hub->nerrors < 10) || hub->error)
438 /* let khubd handle things */
439 case 0: /* we got data: port status changed */
441 for (i = 0; i < urb->actual_length; ++i)
442 bits |= ((unsigned long) ((*hub->buffer)[i]))
444 hub->event_bits[0] = bits;
450 /* Something happened, let khubd figure it out */
457 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
458 && status != -ENODEV && status != -EPERM)
459 dev_err (hub->intfdev, "resubmit --> %d\n", status);
462 /* USB 2.0 spec Section 11.24.2.3 */
464 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
466 /* Need to clear both directions for control ep */
467 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
468 USB_ENDPOINT_XFER_CONTROL) {
469 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
470 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
471 devinfo ^ 0x8000, tt, NULL, 0, 1000);
475 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
476 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
481 * enumeration blocks khubd for a long time. we use keventd instead, since
482 * long blocking there is the exception, not the rule. accordingly, HCDs
483 * talking to TTs must queue control transfers (not just bulk and iso), so
484 * both can talk to the same hub concurrently.
486 static void hub_tt_work(struct work_struct *work)
488 struct usb_hub *hub =
489 container_of(work, struct usb_hub, tt.clear_work);
493 spin_lock_irqsave (&hub->tt.lock, flags);
494 while (!list_empty(&hub->tt.clear_list)) {
495 struct list_head *next;
496 struct usb_tt_clear *clear;
497 struct usb_device *hdev = hub->hdev;
498 const struct hc_driver *drv;
501 if (!hub->quiescing && --limit < 0)
504 next = hub->tt.clear_list.next;
505 clear = list_entry (next, struct usb_tt_clear, clear_list);
506 list_del (&clear->clear_list);
508 /* drop lock so HCD can concurrently report other TT errors */
509 spin_unlock_irqrestore (&hub->tt.lock, flags);
510 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
513 "clear tt %d (%04x) error %d\n",
514 clear->tt, clear->devinfo, status);
516 /* Tell the HCD, even if the operation failed */
517 drv = clear->hcd->driver;
518 if (drv->clear_tt_buffer_complete)
519 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
522 spin_lock_irqsave(&hub->tt.lock, flags);
524 spin_unlock_irqrestore (&hub->tt.lock, flags);
528 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
529 * @urb: an URB associated with the failed or incomplete split transaction
531 * High speed HCDs use this to tell the hub driver that some split control or
532 * bulk transaction failed in a way that requires clearing internal state of
533 * a transaction translator. This is normally detected (and reported) from
536 * It may not be possible for that hub to handle additional full (or low)
537 * speed transactions until that state is fully cleared out.
539 int usb_hub_clear_tt_buffer(struct urb *urb)
541 struct usb_device *udev = urb->dev;
542 int pipe = urb->pipe;
543 struct usb_tt *tt = udev->tt;
545 struct usb_tt_clear *clear;
547 /* we've got to cope with an arbitrary number of pending TT clears,
548 * since each TT has "at least two" buffers that can need it (and
549 * there can be many TTs per hub). even if they're uncommon.
551 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
552 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
553 /* FIXME recover somehow ... RESET_TT? */
557 /* info that CLEAR_TT_BUFFER needs */
558 clear->tt = tt->multi ? udev->ttport : 1;
559 clear->devinfo = usb_pipeendpoint (pipe);
560 clear->devinfo |= udev->devnum << 4;
561 clear->devinfo |= usb_pipecontrol (pipe)
562 ? (USB_ENDPOINT_XFER_CONTROL << 11)
563 : (USB_ENDPOINT_XFER_BULK << 11);
564 if (usb_pipein (pipe))
565 clear->devinfo |= 1 << 15;
567 /* info for completion callback */
568 clear->hcd = bus_to_hcd(udev->bus);
571 /* tell keventd to clear state for this TT */
572 spin_lock_irqsave (&tt->lock, flags);
573 list_add_tail (&clear->clear_list, &tt->clear_list);
574 schedule_work(&tt->clear_work);
575 spin_unlock_irqrestore (&tt->lock, flags);
578 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
580 /* If do_delay is false, return the number of milliseconds the caller
583 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
586 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
588 u16 wHubCharacteristics =
589 le16_to_cpu(hub->descriptor->wHubCharacteristics);
591 /* Enable power on each port. Some hubs have reserved values
592 * of LPSM (> 2) in their descriptors, even though they are
593 * USB 2.0 hubs. Some hubs do not implement port-power switching
594 * but only emulate it. In all cases, the ports won't work
595 * unless we send these messages to the hub.
597 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
598 dev_dbg(hub->intfdev, "enabling power on all ports\n");
600 dev_dbg(hub->intfdev, "trying to enable port power on "
601 "non-switchable hub\n");
602 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
603 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
605 /* Wait at least 100 msec for power to become stable */
606 delay = max(pgood_delay, (unsigned) 100);
612 static int hub_hub_status(struct usb_hub *hub,
613 u16 *status, u16 *change)
617 mutex_lock(&hub->status_mutex);
618 ret = get_hub_status(hub->hdev, &hub->status->hub);
620 dev_err (hub->intfdev,
621 "%s failed (err = %d)\n", __func__, ret);
623 *status = le16_to_cpu(hub->status->hub.wHubStatus);
624 *change = le16_to_cpu(hub->status->hub.wHubChange);
627 mutex_unlock(&hub->status_mutex);
631 static int hub_set_port_link_state(struct usb_hub *hub, int port1,
632 unsigned int link_status)
634 return set_port_feature(hub->hdev,
635 port1 | (link_status << 3),
636 USB_PORT_FEAT_LINK_STATE);
640 * If USB 3.0 ports are placed into the Disabled state, they will no longer
641 * detect any device connects or disconnects. This is generally not what the
642 * USB core wants, since it expects a disabled port to produce a port status
643 * change event when a new device connects.
645 * Instead, set the link state to Disabled, wait for the link to settle into
646 * that state, clear any change bits, and then put the port into the RxDetect
649 static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
653 u16 portchange, portstatus;
655 if (!hub_is_superspeed(hub->hdev))
658 ret = hub_port_status(hub, port1, &portstatus, &portchange);
663 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
664 * Controller [1022:7814] will have spurious result making the following
665 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
666 * as high-speed device if we set the usb 3.0 port link state to
667 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
668 * check the state here to avoid the bug.
670 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
671 USB_SS_PORT_LS_RX_DETECT) {
672 dev_dbg(hub->intfdev,
673 "Not disabling port %d; link state is RxDetect\n",
678 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
680 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
685 /* Wait for the link to enter the disabled state. */
686 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
687 ret = hub_port_status(hub, port1, &portstatus, &portchange);
691 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
692 USB_SS_PORT_LS_SS_DISABLED)
694 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
696 msleep(HUB_DEBOUNCE_STEP);
698 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
699 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
702 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
705 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
707 struct usb_device *hdev = hub->hdev;
710 if (hdev->children[port1-1] && set_state)
711 usb_set_device_state(hdev->children[port1-1],
712 USB_STATE_NOTATTACHED);
714 if (hub_is_superspeed(hub->hdev))
715 ret = hub_usb3_port_disable(hub, port1);
717 ret = clear_port_feature(hdev, port1,
718 USB_PORT_FEAT_ENABLE);
721 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
727 * Disable a port and mark a logical connect-change event, so that some
728 * time later khubd will disconnect() any existing usb_device on the port
729 * and will re-enumerate if there actually is a device attached.
731 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
733 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
734 hub_port_disable(hub, port1, 1);
736 /* FIXME let caller ask to power down the port:
737 * - some devices won't enumerate without a VBUS power cycle
738 * - SRP saves power that way
739 * - ... new call, TBD ...
740 * That's easy if this hub can switch power per-port, and
741 * khubd reactivates the port later (timer, SRP, etc).
742 * Powerdown must be optional, because of reset/DFU.
745 set_bit(port1, hub->change_bits);
750 * usb_remove_device - disable a device's port on its parent hub
751 * @udev: device to be disabled and removed
752 * Context: @udev locked, must be able to sleep.
754 * After @udev's port has been disabled, khubd is notified and it will
755 * see that the device has been disconnected. When the device is
756 * physically unplugged and something is plugged in, the events will
757 * be received and processed normally.
759 int usb_remove_device(struct usb_device *udev)
762 struct usb_interface *intf;
764 if (!udev->parent) /* Can't remove a root hub */
766 hub = hdev_to_hub(udev->parent);
767 intf = to_usb_interface(hub->intfdev);
769 usb_autopm_get_interface(intf);
770 set_bit(udev->portnum, hub->removed_bits);
771 hub_port_logical_disconnect(hub, udev->portnum);
772 usb_autopm_put_interface(intf);
776 enum hub_activation_type {
777 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
778 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
781 static void hub_init_func2(struct work_struct *ws);
782 static void hub_init_func3(struct work_struct *ws);
784 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
786 struct usb_device *hdev = hub->hdev;
791 bool need_debounce_delay = false;
794 /* Continue a partial initialization */
795 if (type == HUB_INIT2 || type == HUB_INIT3) {
796 device_lock(hub->intfdev);
798 /* Was the hub disconnected while we were waiting? */
799 if (hub->disconnected) {
800 device_unlock(hub->intfdev);
801 kref_put(&hub->kref, hub_release);
804 if (type == HUB_INIT2)
808 kref_get(&hub->kref);
810 /* The superspeed hub except for root hub has to use Hub Depth
811 * value as an offset into the route string to locate the bits
812 * it uses to determine the downstream port number. So hub driver
813 * should send a set hub depth request to superspeed hub after
814 * the superspeed hub is set configuration in initialization or
817 * After a resume, port power should still be on.
818 * For any other type of activation, turn it on.
820 if (type != HUB_RESUME) {
821 if (hdev->parent && hub_is_superspeed(hdev)) {
822 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
823 HUB_SET_DEPTH, USB_RT_HUB,
824 hdev->level - 1, 0, NULL, 0,
825 USB_CTRL_SET_TIMEOUT);
827 dev_err(hub->intfdev,
828 "set hub depth failed\n");
831 /* Speed up system boot by using a delayed_work for the
832 * hub's initial power-up delays. This is pretty awkward
833 * and the implementation looks like a home-brewed sort of
834 * setjmp/longjmp, but it saves at least 100 ms for each
835 * root hub (assuming usbcore is compiled into the kernel
836 * rather than as a module). It adds up.
838 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
839 * because for those activation types the ports have to be
840 * operational when we return. In theory this could be done
841 * for HUB_POST_RESET, but it's easier not to.
843 if (type == HUB_INIT) {
844 delay = hub_power_on(hub, false);
845 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
846 schedule_delayed_work(&hub->init_work,
847 msecs_to_jiffies(delay));
849 /* Suppress autosuspend until init is done */
850 usb_autopm_get_interface_no_resume(
851 to_usb_interface(hub->intfdev));
852 return; /* Continues at init2: below */
853 } else if (type == HUB_RESET_RESUME) {
854 /* The internal host controller state for the hub device
855 * may be gone after a host power loss on system resume.
856 * Update the device's info so the HW knows it's a hub.
858 hcd = bus_to_hcd(hdev->bus);
859 if (hcd->driver->update_hub_device) {
860 ret = hcd->driver->update_hub_device(hcd, hdev,
863 dev_err(hub->intfdev, "Host not "
864 "accepting hub info "
866 dev_err(hub->intfdev, "LS/FS devices "
867 "and hubs may not work "
868 "under this hub\n.");
871 hub_power_on(hub, true);
873 hub_power_on(hub, true);
878 /* Check each port and set hub->change_bits to let khubd know
879 * which ports need attention.
881 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
882 struct usb_device *udev = hdev->children[port1-1];
883 u16 portstatus, portchange;
885 portstatus = portchange = 0;
886 status = hub_port_status(hub, port1, &portstatus, &portchange);
890 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
891 dev_dbg(hub->intfdev,
892 "port %d: status %04x change %04x\n",
893 port1, portstatus, portchange);
895 /* After anything other than HUB_RESUME (i.e., initialization
896 * or any sort of reset), every port should be disabled.
897 * Unconnected ports should likewise be disabled (paranoia),
898 * and so should ports for which we have no usb_device.
900 if ((portstatus & USB_PORT_STAT_ENABLE) && (
901 type != HUB_RESUME ||
902 !(portstatus & USB_PORT_STAT_CONNECTION) ||
904 udev->state == USB_STATE_NOTATTACHED)) {
906 * USB3 protocol ports will automatically transition
907 * to Enabled state when detect an USB3.0 device attach.
908 * Do not disable USB3 protocol ports.
910 if (!hub_is_superspeed(hdev)) {
911 clear_port_feature(hdev, port1,
912 USB_PORT_FEAT_ENABLE);
913 portstatus &= ~USB_PORT_STAT_ENABLE;
915 /* Pretend that power was lost for USB3 devs */
916 portstatus &= ~USB_PORT_STAT_ENABLE;
920 /* Clear status-change flags; we'll debounce later */
921 if (portchange & USB_PORT_STAT_C_CONNECTION) {
922 need_debounce_delay = true;
923 clear_port_feature(hub->hdev, port1,
924 USB_PORT_FEAT_C_CONNECTION);
926 if (portchange & USB_PORT_STAT_C_ENABLE) {
927 need_debounce_delay = true;
928 clear_port_feature(hub->hdev, port1,
929 USB_PORT_FEAT_C_ENABLE);
931 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
932 need_debounce_delay = true;
933 clear_port_feature(hub->hdev, port1,
934 USB_PORT_FEAT_C_PORT_LINK_STATE);
936 if (portchange & USB_PORT_STAT_C_RESET) {
937 need_debounce_delay = true;
938 clear_port_feature(hub->hdev, port1,
939 USB_PORT_FEAT_C_RESET);
942 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
943 hub_is_superspeed(hub->hdev)) {
944 need_debounce_delay = true;
945 clear_port_feature(hub->hdev, port1,
946 USB_PORT_FEAT_C_BH_PORT_RESET);
948 /* We can forget about a "removed" device when there's a
949 * physical disconnect or the connect status changes.
951 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
952 (portchange & USB_PORT_STAT_C_CONNECTION))
953 clear_bit(port1, hub->removed_bits);
955 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
956 /* Tell khubd to disconnect the device or
957 * check for a new connection
959 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
960 set_bit(port1, hub->change_bits);
962 } else if (portstatus & USB_PORT_STAT_ENABLE) {
963 /* The power session apparently survived the resume.
964 * If there was an overcurrent or suspend change
965 * (i.e., remote wakeup request), have khubd
969 set_bit(port1, hub->change_bits);
971 } else if (udev->persist_enabled) {
973 udev->reset_resume = 1;
975 set_bit(port1, hub->change_bits);
978 /* The power session is gone; tell khubd */
979 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
980 set_bit(port1, hub->change_bits);
984 /* If no port-status-change flags were set, we don't need any
985 * debouncing. If flags were set we can try to debounce the
986 * ports all at once right now, instead of letting khubd do them
987 * one at a time later on.
989 * If any port-status changes do occur during this delay, khubd
990 * will see them later and handle them normally.
992 if (need_debounce_delay) {
993 delay = HUB_DEBOUNCE_STABLE;
995 /* Don't do a long sleep inside a workqueue routine */
996 if (type == HUB_INIT2) {
997 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
998 schedule_delayed_work(&hub->init_work,
999 msecs_to_jiffies(delay));
1000 device_unlock(hub->intfdev);
1001 return; /* Continues at init3: below */
1009 status = usb_submit_urb(hub->urb, GFP_NOIO);
1011 dev_err(hub->intfdev, "activate --> %d\n", status);
1012 if (hub->has_indicators && blinkenlights)
1013 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1015 /* Scan all ports that need attention */
1018 /* Allow autosuspend if it was suppressed */
1019 if (type <= HUB_INIT3)
1020 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1022 if (type == HUB_INIT2 || type == HUB_INIT3)
1023 device_unlock(hub->intfdev);
1025 kref_put(&hub->kref, hub_release);
1028 /* Implement the continuations for the delays above */
1029 static void hub_init_func2(struct work_struct *ws)
1031 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1033 hub_activate(hub, HUB_INIT2);
1036 static void hub_init_func3(struct work_struct *ws)
1038 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1040 hub_activate(hub, HUB_INIT3);
1043 enum hub_quiescing_type {
1044 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1047 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1049 struct usb_device *hdev = hub->hdev;
1052 cancel_delayed_work_sync(&hub->init_work);
1054 /* khubd and related activity won't re-trigger */
1057 if (type != HUB_SUSPEND) {
1058 /* Disconnect all the children */
1059 for (i = 0; i < hdev->maxchild; ++i) {
1060 if (hdev->children[i])
1061 usb_disconnect(&hdev->children[i]);
1065 /* Stop khubd and related activity */
1066 usb_kill_urb(hub->urb);
1067 if (hub->has_indicators)
1068 cancel_delayed_work_sync(&hub->leds);
1070 flush_work_sync(&hub->tt.clear_work);
1073 /* caller has locked the hub device */
1074 static int hub_pre_reset(struct usb_interface *intf)
1076 struct usb_hub *hub = usb_get_intfdata(intf);
1078 hub_quiesce(hub, HUB_PRE_RESET);
1082 /* caller has locked the hub device */
1083 static int hub_post_reset(struct usb_interface *intf)
1085 struct usb_hub *hub = usb_get_intfdata(intf);
1087 hub_activate(hub, HUB_POST_RESET);
1091 static int hub_configure(struct usb_hub *hub,
1092 struct usb_endpoint_descriptor *endpoint)
1094 struct usb_hcd *hcd;
1095 struct usb_device *hdev = hub->hdev;
1096 struct device *hub_dev = hub->intfdev;
1097 u16 hubstatus, hubchange;
1098 u16 wHubCharacteristics;
1101 char *message = "out of memory";
1103 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1109 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1114 mutex_init(&hub->status_mutex);
1116 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1117 if (!hub->descriptor) {
1122 /* Request the entire hub descriptor.
1123 * hub->descriptor can handle USB_MAXCHILDREN ports,
1124 * but the hub can/will return fewer bytes here.
1126 ret = get_hub_descriptor(hdev, hub->descriptor);
1128 message = "can't read hub descriptor";
1130 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1131 message = "hub has too many ports!";
1136 hdev->maxchild = hub->descriptor->bNbrPorts;
1137 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1138 (hdev->maxchild == 1) ? "" : "s");
1140 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1141 if (!hub->port_owners) {
1146 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1148 /* FIXME for USB 3.0, skip for now */
1149 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1150 !(hub_is_superspeed(hdev))) {
1152 char portstr [USB_MAXCHILDREN + 1];
1154 for (i = 0; i < hdev->maxchild; i++)
1155 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1156 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1158 portstr[hdev->maxchild] = 0;
1159 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1161 dev_dbg(hub_dev, "standalone hub\n");
1163 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1165 dev_dbg(hub_dev, "ganged power switching\n");
1168 dev_dbg(hub_dev, "individual port power switching\n");
1172 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1176 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1178 dev_dbg(hub_dev, "global over-current protection\n");
1181 dev_dbg(hub_dev, "individual port over-current protection\n");
1185 dev_dbg(hub_dev, "no over-current protection\n");
1189 spin_lock_init (&hub->tt.lock);
1190 INIT_LIST_HEAD (&hub->tt.clear_list);
1191 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1192 switch (hdev->descriptor.bDeviceProtocol) {
1196 dev_dbg(hub_dev, "Single TT\n");
1200 ret = usb_set_interface(hdev, 0, 1);
1202 dev_dbg(hub_dev, "TT per port\n");
1205 dev_err(hub_dev, "Using single TT (err %d)\n",
1210 /* USB 3.0 hubs don't have a TT */
1213 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1214 hdev->descriptor.bDeviceProtocol);
1218 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1219 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1220 case HUB_TTTT_8_BITS:
1221 if (hdev->descriptor.bDeviceProtocol != 0) {
1222 hub->tt.think_time = 666;
1223 dev_dbg(hub_dev, "TT requires at most %d "
1224 "FS bit times (%d ns)\n",
1225 8, hub->tt.think_time);
1228 case HUB_TTTT_16_BITS:
1229 hub->tt.think_time = 666 * 2;
1230 dev_dbg(hub_dev, "TT requires at most %d "
1231 "FS bit times (%d ns)\n",
1232 16, hub->tt.think_time);
1234 case HUB_TTTT_24_BITS:
1235 hub->tt.think_time = 666 * 3;
1236 dev_dbg(hub_dev, "TT requires at most %d "
1237 "FS bit times (%d ns)\n",
1238 24, hub->tt.think_time);
1240 case HUB_TTTT_32_BITS:
1241 hub->tt.think_time = 666 * 4;
1242 dev_dbg(hub_dev, "TT requires at most %d "
1243 "FS bit times (%d ns)\n",
1244 32, hub->tt.think_time);
1248 /* probe() zeroes hub->indicator[] */
1249 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1250 hub->has_indicators = 1;
1251 dev_dbg(hub_dev, "Port indicators are supported\n");
1254 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1255 hub->descriptor->bPwrOn2PwrGood * 2);
1257 /* power budgeting mostly matters with bus-powered hubs,
1258 * and battery-powered root hubs (may provide just 8 mA).
1260 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1262 message = "can't get hub status";
1265 le16_to_cpus(&hubstatus);
1266 if (hdev == hdev->bus->root_hub) {
1267 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1268 hub->mA_per_port = 500;
1270 hub->mA_per_port = hdev->bus_mA;
1271 hub->limited_power = 1;
1273 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1274 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1275 hub->descriptor->bHubContrCurrent);
1276 hub->limited_power = 1;
1277 if (hdev->maxchild > 0) {
1278 int remaining = hdev->bus_mA -
1279 hub->descriptor->bHubContrCurrent;
1281 if (remaining < hdev->maxchild * 100)
1283 "insufficient power available "
1284 "to use all downstream ports\n");
1285 hub->mA_per_port = 100; /* 7.2.1.1 */
1287 } else { /* Self-powered external hub */
1288 /* FIXME: What about battery-powered external hubs that
1289 * provide less current per port? */
1290 hub->mA_per_port = 500;
1292 if (hub->mA_per_port < 500)
1293 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1296 /* Update the HCD's internal representation of this hub before khubd
1297 * starts getting port status changes for devices under the hub.
1299 hcd = bus_to_hcd(hdev->bus);
1300 if (hcd->driver->update_hub_device) {
1301 ret = hcd->driver->update_hub_device(hcd, hdev,
1302 &hub->tt, GFP_KERNEL);
1304 message = "can't update HCD hub info";
1309 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1311 message = "can't get hub status";
1315 /* local power status reports aren't always correct */
1316 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1317 dev_dbg(hub_dev, "local power source is %s\n",
1318 (hubstatus & HUB_STATUS_LOCAL_POWER)
1319 ? "lost (inactive)" : "good");
1321 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1322 dev_dbg(hub_dev, "%sover-current condition exists\n",
1323 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1325 /* set up the interrupt endpoint
1326 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1327 * bytes as USB2.0[11.12.3] says because some hubs are known
1328 * to send more data (and thus cause overflow). For root hubs,
1329 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1330 * to be big enough for at least USB_MAXCHILDREN ports. */
1331 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1332 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1334 if (maxp > sizeof(*hub->buffer))
1335 maxp = sizeof(*hub->buffer);
1337 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1343 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1344 hub, endpoint->bInterval);
1346 /* maybe cycle the hub leds */
1347 if (hub->has_indicators && blinkenlights)
1348 hub->indicator [0] = INDICATOR_CYCLE;
1350 hub_activate(hub, HUB_INIT);
1354 dev_err (hub_dev, "config failed, %s (err %d)\n",
1356 /* hub_disconnect() frees urb and descriptor */
1360 static void hub_release(struct kref *kref)
1362 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1364 usb_put_intf(to_usb_interface(hub->intfdev));
1368 static unsigned highspeed_hubs;
1370 static void hub_disconnect(struct usb_interface *intf)
1372 struct usb_hub *hub = usb_get_intfdata (intf);
1374 /* Take the hub off the event list and don't let it be added again */
1375 spin_lock_irq(&hub_event_lock);
1376 if (!list_empty(&hub->event_list)) {
1377 list_del_init(&hub->event_list);
1378 usb_autopm_put_interface_no_suspend(intf);
1380 hub->disconnected = 1;
1381 spin_unlock_irq(&hub_event_lock);
1383 /* Disconnect all children and quiesce the hub */
1385 hub_quiesce(hub, HUB_DISCONNECT);
1387 usb_set_intfdata (intf, NULL);
1388 hub->hdev->maxchild = 0;
1390 if (hub->hdev->speed == USB_SPEED_HIGH)
1393 usb_free_urb(hub->urb);
1394 kfree(hub->port_owners);
1395 kfree(hub->descriptor);
1399 kref_put(&hub->kref, hub_release);
1402 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1404 struct usb_host_interface *desc;
1405 struct usb_endpoint_descriptor *endpoint;
1406 struct usb_device *hdev;
1407 struct usb_hub *hub;
1409 desc = intf->cur_altsetting;
1410 hdev = interface_to_usbdev(intf);
1413 * Hubs have proper suspend/resume support, except for root hubs
1414 * where the controller driver doesn't have bus_suspend and
1415 * bus_resume methods. Also, USB 3.0 device suspend is
1416 * different from USB 2.0/1.1 device suspend, and unfortunately we
1417 * don't support it yet. So leave autosuspend disabled for USB 3.0
1418 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1419 * since that isn't a "real" hub.
1421 if (hdev->parent) { /* normal device */
1422 if (!hub_is_superspeed(hdev))
1423 usb_enable_autosuspend(hdev);
1424 } else { /* root hub */
1425 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1427 if (drv->bus_suspend && drv->bus_resume)
1428 usb_enable_autosuspend(hdev);
1431 if (hdev->level == MAX_TOPO_LEVEL) {
1433 "Unsupported bus topology: hub nested too deep\n");
1437 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1439 dev_warn(&intf->dev, "ignoring external hub\n");
1444 /* Some hubs have a subclass of 1, which AFAICT according to the */
1445 /* specs is not defined, but it works */
1446 if ((desc->desc.bInterfaceSubClass != 0) &&
1447 (desc->desc.bInterfaceSubClass != 1)) {
1449 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1453 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1454 if (desc->desc.bNumEndpoints != 1)
1455 goto descriptor_error;
1457 endpoint = &desc->endpoint[0].desc;
1459 /* If it's not an interrupt in endpoint, we'd better punt! */
1460 if (!usb_endpoint_is_int_in(endpoint))
1461 goto descriptor_error;
1463 /* We found a hub */
1464 dev_info (&intf->dev, "USB hub found\n");
1466 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1468 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1472 kref_init(&hub->kref);
1473 INIT_LIST_HEAD(&hub->event_list);
1474 hub->intfdev = &intf->dev;
1476 INIT_DELAYED_WORK(&hub->leds, led_work);
1477 INIT_DELAYED_WORK(&hub->init_work, NULL);
1480 usb_set_intfdata (intf, hub);
1481 intf->needs_remote_wakeup = 1;
1483 if (hdev->speed == USB_SPEED_HIGH)
1486 if (hub_configure(hub, endpoint) >= 0)
1489 hub_disconnect (intf);
1495 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1497 struct usb_device *hdev = interface_to_usbdev (intf);
1499 /* assert ifno == 0 (part of hub spec) */
1501 case USBDEVFS_HUB_PORTINFO: {
1502 struct usbdevfs_hub_portinfo *info = user_data;
1505 spin_lock_irq(&device_state_lock);
1506 if (hdev->devnum <= 0)
1509 info->nports = hdev->maxchild;
1510 for (i = 0; i < info->nports; i++) {
1511 if (hdev->children[i] == NULL)
1515 hdev->children[i]->devnum;
1518 spin_unlock_irq(&device_state_lock);
1520 return info->nports + 1;
1529 * Allow user programs to claim ports on a hub. When a device is attached
1530 * to one of these "claimed" ports, the program will "own" the device.
1532 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1535 if (hdev->state == USB_STATE_NOTATTACHED)
1537 if (port1 == 0 || port1 > hdev->maxchild)
1540 /* This assumes that devices not managed by the hub driver
1541 * will always have maxchild equal to 0.
1543 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1547 /* In the following three functions, the caller must hold hdev's lock */
1548 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1553 rc = find_port_owner(hdev, port1, &powner);
1562 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1567 rc = find_port_owner(hdev, port1, &powner);
1570 if (*powner != owner)
1576 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1581 n = find_port_owner(hdev, 1, &powner);
1583 for (; n < hdev->maxchild; (++n, ++powner)) {
1584 if (*powner == owner)
1590 /* The caller must hold udev's lock */
1591 bool usb_device_is_owned(struct usb_device *udev)
1593 struct usb_hub *hub;
1595 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1597 hub = hdev_to_hub(udev->parent);
1598 return !!hub->port_owners[udev->portnum - 1];
1602 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1606 for (i = 0; i < udev->maxchild; ++i) {
1607 if (udev->children[i])
1608 recursively_mark_NOTATTACHED(udev->children[i]);
1610 if (udev->state == USB_STATE_SUSPENDED)
1611 udev->active_duration -= jiffies;
1612 udev->state = USB_STATE_NOTATTACHED;
1616 * usb_set_device_state - change a device's current state (usbcore, hcds)
1617 * @udev: pointer to device whose state should be changed
1618 * @new_state: new state value to be stored
1620 * udev->state is _not_ fully protected by the device lock. Although
1621 * most transitions are made only while holding the lock, the state can
1622 * can change to USB_STATE_NOTATTACHED at almost any time. This
1623 * is so that devices can be marked as disconnected as soon as possible,
1624 * without having to wait for any semaphores to be released. As a result,
1625 * all changes to any device's state must be protected by the
1626 * device_state_lock spinlock.
1628 * Once a device has been added to the device tree, all changes to its state
1629 * should be made using this routine. The state should _not_ be set directly.
1631 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1632 * Otherwise udev->state is set to new_state, and if new_state is
1633 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1634 * to USB_STATE_NOTATTACHED.
1636 void usb_set_device_state(struct usb_device *udev,
1637 enum usb_device_state new_state)
1639 unsigned long flags;
1642 spin_lock_irqsave(&device_state_lock, flags);
1643 if (udev->state == USB_STATE_NOTATTACHED)
1645 else if (new_state != USB_STATE_NOTATTACHED) {
1647 /* root hub wakeup capabilities are managed out-of-band
1648 * and may involve silicon errata ... ignore them here.
1651 if (udev->state == USB_STATE_SUSPENDED
1652 || new_state == USB_STATE_SUSPENDED)
1653 ; /* No change to wakeup settings */
1654 else if (new_state == USB_STATE_CONFIGURED)
1655 wakeup = (udev->quirks &
1656 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1657 udev->actconfig->desc.bmAttributes &
1658 USB_CONFIG_ATT_WAKEUP;
1662 if (udev->state == USB_STATE_SUSPENDED &&
1663 new_state != USB_STATE_SUSPENDED)
1664 udev->active_duration -= jiffies;
1665 else if (new_state == USB_STATE_SUSPENDED &&
1666 udev->state != USB_STATE_SUSPENDED)
1667 udev->active_duration += jiffies;
1668 udev->state = new_state;
1670 recursively_mark_NOTATTACHED(udev);
1671 spin_unlock_irqrestore(&device_state_lock, flags);
1673 device_set_wakeup_capable(&udev->dev, wakeup);
1675 EXPORT_SYMBOL_GPL(usb_set_device_state);
1678 * Choose a device number.
1680 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1681 * USB-2.0 buses they are also used as device addresses, however on
1682 * USB-3.0 buses the address is assigned by the controller hardware
1683 * and it usually is not the same as the device number.
1685 * WUSB devices are simple: they have no hubs behind, so the mapping
1686 * device <-> virtual port number becomes 1:1. Why? to simplify the
1687 * life of the device connection logic in
1688 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1689 * handshake we need to assign a temporary address in the unauthorized
1690 * space. For simplicity we use the first virtual port number found to
1691 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1692 * and that becomes it's address [X < 128] or its unauthorized address
1695 * We add 1 as an offset to the one-based USB-stack port number
1696 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1697 * 0 is reserved by USB for default address; (b) Linux's USB stack
1698 * uses always #1 for the root hub of the controller. So USB stack's
1699 * port #1, which is wusb virtual-port #0 has address #2.
1701 * Devices connected under xHCI are not as simple. The host controller
1702 * supports virtualization, so the hardware assigns device addresses and
1703 * the HCD must setup data structures before issuing a set address
1704 * command to the hardware.
1706 static void choose_devnum(struct usb_device *udev)
1709 struct usb_bus *bus = udev->bus;
1711 /* If khubd ever becomes multithreaded, this will need a lock */
1713 devnum = udev->portnum + 1;
1714 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1716 /* Try to allocate the next devnum beginning at
1717 * bus->devnum_next. */
1718 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1721 devnum = find_next_zero_bit(bus->devmap.devicemap,
1723 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1726 set_bit(devnum, bus->devmap.devicemap);
1727 udev->devnum = devnum;
1731 static void release_devnum(struct usb_device *udev)
1733 if (udev->devnum > 0) {
1734 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1739 static void update_devnum(struct usb_device *udev, int devnum)
1741 /* The address for a WUSB device is managed by wusbcore. */
1743 udev->devnum = devnum;
1746 static void hub_free_dev(struct usb_device *udev)
1748 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1750 /* Root hubs aren't real devices, so don't free HCD resources */
1751 if (hcd->driver->free_dev && udev->parent)
1752 hcd->driver->free_dev(hcd, udev);
1756 * usb_disconnect - disconnect a device (usbcore-internal)
1757 * @pdev: pointer to device being disconnected
1758 * Context: !in_interrupt ()
1760 * Something got disconnected. Get rid of it and all of its children.
1762 * If *pdev is a normal device then the parent hub must already be locked.
1763 * If *pdev is a root hub then this routine will acquire the
1764 * usb_bus_list_lock on behalf of the caller.
1766 * Only hub drivers (including virtual root hub drivers for host
1767 * controllers) should ever call this.
1769 * This call is synchronous, and may not be used in an interrupt context.
1771 void usb_disconnect(struct usb_device **pdev)
1773 struct usb_device *udev = *pdev;
1776 /* mark the device as inactive, so any further urb submissions for
1777 * this device (and any of its children) will fail immediately.
1778 * this quiesces everything except pending urbs.
1780 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1781 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1784 usb_lock_device(udev);
1786 /* Free up all the children before we remove this device */
1787 for (i = 0; i < USB_MAXCHILDREN; i++) {
1788 if (udev->children[i])
1789 usb_disconnect(&udev->children[i]);
1792 /* deallocate hcd/hardware state ... nuking all pending urbs and
1793 * cleaning up all state associated with the current configuration
1794 * so that the hardware is now fully quiesced.
1796 dev_dbg (&udev->dev, "unregistering device\n");
1797 usb_disable_device(udev, 0);
1798 usb_hcd_synchronize_unlinks(udev);
1800 usb_remove_ep_devs(&udev->ep0);
1801 usb_unlock_device(udev);
1803 /* Unregister the device. The device driver is responsible
1804 * for de-configuring the device and invoking the remove-device
1805 * notifier chain (used by usbfs and possibly others).
1807 device_del(&udev->dev);
1809 /* Free the device number and delete the parent's children[]
1810 * (or root_hub) pointer.
1812 release_devnum(udev);
1814 /* Avoid races with recursively_mark_NOTATTACHED() */
1815 spin_lock_irq(&device_state_lock);
1817 spin_unlock_irq(&device_state_lock);
1821 put_device(&udev->dev);
1824 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1825 static void show_string(struct usb_device *udev, char *id, char *string)
1829 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1832 static void announce_device(struct usb_device *udev)
1834 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1835 le16_to_cpu(udev->descriptor.idVendor),
1836 le16_to_cpu(udev->descriptor.idProduct));
1837 dev_info(&udev->dev,
1838 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1839 udev->descriptor.iManufacturer,
1840 udev->descriptor.iProduct,
1841 udev->descriptor.iSerialNumber);
1842 show_string(udev, "Product", udev->product);
1843 show_string(udev, "Manufacturer", udev->manufacturer);
1844 show_string(udev, "SerialNumber", udev->serial);
1847 static inline void announce_device(struct usb_device *udev) { }
1850 #ifdef CONFIG_USB_OTG
1851 #include "otg_whitelist.h"
1855 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1856 * @udev: newly addressed device (in ADDRESS state)
1858 * Finish enumeration for On-The-Go devices
1860 static int usb_enumerate_device_otg(struct usb_device *udev)
1864 #ifdef CONFIG_USB_OTG
1866 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1867 * to wake us after we've powered off VBUS; and HNP, switching roles
1868 * "host" to "peripheral". The OTG descriptor helps figure this out.
1870 if (!udev->bus->is_b_host
1872 && udev->parent == udev->bus->root_hub) {
1873 struct usb_otg_descriptor *desc = NULL;
1874 struct usb_bus *bus = udev->bus;
1876 /* descriptor may appear anywhere in config */
1877 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1878 le16_to_cpu(udev->config[0].desc.wTotalLength),
1879 USB_DT_OTG, (void **) &desc) == 0) {
1880 if (desc->bmAttributes & USB_OTG_HNP) {
1881 unsigned port1 = udev->portnum;
1883 dev_info(&udev->dev,
1884 "Dual-Role OTG device on %sHNP port\n",
1885 (port1 == bus->otg_port)
1888 /* enable HNP before suspend, it's simpler */
1889 if (port1 == bus->otg_port)
1890 bus->b_hnp_enable = 1;
1891 err = usb_control_msg(udev,
1892 usb_sndctrlpipe(udev, 0),
1893 USB_REQ_SET_FEATURE, 0,
1895 ? USB_DEVICE_B_HNP_ENABLE
1896 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1897 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1899 /* OTG MESSAGE: report errors here,
1900 * customize to match your product.
1902 dev_info(&udev->dev,
1903 "can't set HNP mode: %d\n",
1905 bus->b_hnp_enable = 0;
1911 if (!is_targeted(udev)) {
1913 /* Maybe it can talk to us, though we can't talk to it.
1914 * (Includes HNP test device.)
1916 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1917 err = usb_port_suspend(udev, PMSG_SUSPEND);
1919 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1931 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1932 * @udev: newly addressed device (in ADDRESS state)
1934 * This is only called by usb_new_device() and usb_authorize_device()
1935 * and FIXME -- all comments that apply to them apply here wrt to
1938 * If the device is WUSB and not authorized, we don't attempt to read
1939 * the string descriptors, as they will be errored out by the device
1940 * until it has been authorized.
1942 static int usb_enumerate_device(struct usb_device *udev)
1946 if (udev->config == NULL) {
1947 err = usb_get_configuration(udev);
1949 dev_err(&udev->dev, "can't read configurations, error %d\n",
1954 if (udev->wusb == 1 && udev->authorized == 0) {
1955 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1956 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1957 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1960 /* read the standard strings and cache them if present */
1961 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1962 udev->manufacturer = usb_cache_string(udev,
1963 udev->descriptor.iManufacturer);
1964 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1966 err = usb_enumerate_device_otg(udev);
1970 usb_detect_interface_quirks(udev);
1977 * usb_new_device - perform initial device setup (usbcore-internal)
1978 * @udev: newly addressed device (in ADDRESS state)
1980 * This is called with devices which have been detected but not fully
1981 * enumerated. The device descriptor is available, but not descriptors
1982 * for any device configuration. The caller must have locked either
1983 * the parent hub (if udev is a normal device) or else the
1984 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1985 * udev has already been installed, but udev is not yet visible through
1986 * sysfs or other filesystem code.
1988 * It will return if the device is configured properly or not. Zero if
1989 * the interface was registered with the driver core; else a negative
1992 * This call is synchronous, and may not be used in an interrupt context.
1994 * Only the hub driver or root-hub registrar should ever call this.
1996 int usb_new_device(struct usb_device *udev)
2001 /* Initialize non-root-hub device wakeup to disabled;
2002 * device (un)configuration controls wakeup capable
2003 * sysfs power/wakeup controls wakeup enabled/disabled
2005 device_init_wakeup(&udev->dev, 0);
2008 /* Tell the runtime-PM framework the device is active */
2009 pm_runtime_set_active(&udev->dev);
2010 pm_runtime_get_noresume(&udev->dev);
2011 pm_runtime_use_autosuspend(&udev->dev);
2012 pm_runtime_enable(&udev->dev);
2014 /* By default, forbid autosuspend for all devices. It will be
2015 * allowed for hubs during binding.
2017 usb_disable_autosuspend(udev);
2019 err = usb_enumerate_device(udev); /* Read descriptors */
2022 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2023 udev->devnum, udev->bus->busnum,
2024 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2025 /* export the usbdev device-node for libusb */
2026 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2027 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2029 /* Tell the world! */
2030 announce_device(udev);
2033 add_device_randomness(udev->serial, strlen(udev->serial));
2035 add_device_randomness(udev->product, strlen(udev->product));
2036 if (udev->manufacturer)
2037 add_device_randomness(udev->manufacturer,
2038 strlen(udev->manufacturer));
2040 device_enable_async_suspend(&udev->dev);
2041 /* Register the device. The device driver is responsible
2042 * for configuring the device and invoking the add-device
2043 * notifier chain (used by usbfs and possibly others).
2045 err = device_add(&udev->dev);
2047 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2051 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2052 usb_mark_last_busy(udev);
2053 pm_runtime_put_sync_autosuspend(&udev->dev);
2057 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2058 pm_runtime_disable(&udev->dev);
2059 pm_runtime_set_suspended(&udev->dev);
2065 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2066 * @usb_dev: USB device
2068 * Move the USB device to a very basic state where interfaces are disabled
2069 * and the device is in fact unconfigured and unusable.
2071 * We share a lock (that we have) with device_del(), so we need to
2074 int usb_deauthorize_device(struct usb_device *usb_dev)
2076 usb_lock_device(usb_dev);
2077 if (usb_dev->authorized == 0)
2078 goto out_unauthorized;
2080 usb_dev->authorized = 0;
2081 usb_set_configuration(usb_dev, -1);
2083 kfree(usb_dev->product);
2084 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2085 kfree(usb_dev->manufacturer);
2086 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2087 kfree(usb_dev->serial);
2088 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2090 usb_destroy_configuration(usb_dev);
2091 usb_dev->descriptor.bNumConfigurations = 0;
2094 usb_unlock_device(usb_dev);
2099 int usb_authorize_device(struct usb_device *usb_dev)
2103 usb_lock_device(usb_dev);
2104 if (usb_dev->authorized == 1)
2105 goto out_authorized;
2107 result = usb_autoresume_device(usb_dev);
2109 dev_err(&usb_dev->dev,
2110 "can't autoresume for authorization: %d\n", result);
2111 goto error_autoresume;
2113 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2115 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2116 "authorization: %d\n", result);
2117 goto error_device_descriptor;
2120 kfree(usb_dev->product);
2121 usb_dev->product = NULL;
2122 kfree(usb_dev->manufacturer);
2123 usb_dev->manufacturer = NULL;
2124 kfree(usb_dev->serial);
2125 usb_dev->serial = NULL;
2127 usb_dev->authorized = 1;
2128 result = usb_enumerate_device(usb_dev);
2130 goto error_enumerate;
2131 /* Choose and set the configuration. This registers the interfaces
2132 * with the driver core and lets interface drivers bind to them.
2134 c = usb_choose_configuration(usb_dev);
2136 result = usb_set_configuration(usb_dev, c);
2138 dev_err(&usb_dev->dev,
2139 "can't set config #%d, error %d\n", c, result);
2140 /* This need not be fatal. The user can try to
2141 * set other configurations. */
2144 dev_info(&usb_dev->dev, "authorized to connect\n");
2147 error_device_descriptor:
2148 usb_autosuspend_device(usb_dev);
2151 usb_unlock_device(usb_dev); // complements locktree
2156 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2157 static unsigned hub_is_wusb(struct usb_hub *hub)
2159 struct usb_hcd *hcd;
2160 if (hub->hdev->parent != NULL) /* not a root hub? */
2162 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2163 return hcd->wireless;
2167 #define PORT_RESET_TRIES 5
2168 #define SET_ADDRESS_TRIES 2
2169 #define GET_DESCRIPTOR_TRIES 2
2170 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2171 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2173 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2174 #define HUB_SHORT_RESET_TIME 10
2175 #define HUB_BH_RESET_TIME 50
2176 #define HUB_LONG_RESET_TIME 200
2177 #define HUB_RESET_TIMEOUT 800
2179 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2180 * Port worm reset is required to recover
2182 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2184 return hub_is_superspeed(hub->hdev) &&
2185 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2186 USB_SS_PORT_LS_SS_INACTIVE) ||
2187 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2188 USB_SS_PORT_LS_COMP_MOD)) ;
2191 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2192 struct usb_device *udev, unsigned int delay, bool warm)
2194 int delay_time, ret;
2198 for (delay_time = 0;
2199 delay_time < HUB_RESET_TIMEOUT;
2200 delay_time += delay) {
2201 /* wait to give the device a chance to reset */
2204 /* read and decode port status */
2205 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2209 /* The port state is unknown until the reset completes. */
2210 if ((portstatus & USB_PORT_STAT_RESET))
2213 if (hub_port_warm_reset_required(hub, portstatus))
2216 /* Device went away? */
2217 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2220 /* bomb out completely if the connection bounced. A USB 3.0
2221 * connection may bounce if multiple warm resets were issued,
2222 * but the device may have successfully re-connected. Ignore it.
2224 if (!hub_is_superspeed(hub->hdev) &&
2225 (portchange & USB_PORT_STAT_C_CONNECTION))
2228 if ((portstatus & USB_PORT_STAT_ENABLE)) {
2232 if (hub_is_wusb(hub))
2233 udev->speed = USB_SPEED_WIRELESS;
2234 else if (hub_is_superspeed(hub->hdev))
2235 udev->speed = USB_SPEED_SUPER;
2236 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2237 udev->speed = USB_SPEED_HIGH;
2238 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2239 udev->speed = USB_SPEED_LOW;
2241 udev->speed = USB_SPEED_FULL;
2246 /* switch to the long delay after two short delay failures */
2247 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2248 delay = HUB_LONG_RESET_TIME;
2250 dev_dbg (hub->intfdev,
2251 "port %d not %sreset yet, waiting %dms\n",
2252 port1, warm ? "warm " : "", delay);
2258 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2259 static int hub_port_reset(struct usb_hub *hub, int port1,
2260 struct usb_device *udev, unsigned int delay, bool warm)
2263 u16 portchange, portstatus;
2265 if (!hub_is_superspeed(hub->hdev)) {
2267 dev_err(hub->intfdev, "only USB3 hub support "
2271 /* Block EHCI CF initialization during the port reset.
2272 * Some companion controllers don't like it when they mix.
2274 down_read(&ehci_cf_port_reset_rwsem);
2277 * If the caller hasn't explicitly requested a warm reset,
2278 * double check and see if one is needed.
2280 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2281 if (hub_port_warm_reset_required(hub, portstatus))
2285 /* Reset the port */
2286 for (i = 0; i < PORT_RESET_TRIES; i++) {
2287 status = set_port_feature(hub->hdev, port1, (warm ?
2288 USB_PORT_FEAT_BH_PORT_RESET :
2289 USB_PORT_FEAT_RESET));
2291 dev_err(hub->intfdev,
2292 "cannot %sreset port %d (err = %d)\n",
2293 warm ? "warm " : "", port1, status);
2295 status = hub_port_wait_reset(hub, port1, udev, delay,
2297 if (status && status != -ENOTCONN)
2298 dev_dbg(hub->intfdev,
2299 "port_wait_reset: err = %d\n",
2303 /* Check for disconnect or reset */
2304 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2305 clear_port_feature(hub->hdev, port1,
2306 USB_PORT_FEAT_C_RESET);
2308 if (!hub_is_superspeed(hub->hdev))
2311 clear_port_feature(hub->hdev, port1,
2312 USB_PORT_FEAT_C_BH_PORT_RESET);
2313 clear_port_feature(hub->hdev, port1,
2314 USB_PORT_FEAT_C_PORT_LINK_STATE);
2315 clear_port_feature(hub->hdev, port1,
2316 USB_PORT_FEAT_C_CONNECTION);
2319 * If a USB 3.0 device migrates from reset to an error
2320 * state, re-issue the warm reset.
2322 if (hub_port_status(hub, port1,
2323 &portstatus, &portchange) < 0)
2326 if (!hub_port_warm_reset_required(hub, portstatus))
2330 * If the port is in SS.Inactive or Compliance Mode, the
2331 * hot or warm reset failed. Try another warm reset.
2334 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2340 dev_dbg (hub->intfdev,
2341 "port %d not enabled, trying %sreset again...\n",
2342 port1, warm ? "warm " : "");
2343 delay = HUB_LONG_RESET_TIME;
2346 dev_err (hub->intfdev,
2347 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2352 /* TRSTRCY = 10 ms; plus some extra */
2355 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2357 update_devnum(udev, 0);
2358 /* The xHC may think the device is already reset,
2359 * so ignore the status.
2361 if (hcd->driver->reset_device)
2362 hcd->driver->reset_device(hcd, udev);
2364 usb_set_device_state(udev, USB_STATE_DEFAULT);
2368 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2371 if (!hub_is_superspeed(hub->hdev))
2372 up_read(&ehci_cf_port_reset_rwsem);
2377 /* Check if a port is power on */
2378 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2382 if (hub_is_superspeed(hub->hdev)) {
2383 if (portstatus & USB_SS_PORT_STAT_POWER)
2386 if (portstatus & USB_PORT_STAT_POWER)
2395 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2396 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2400 if (hub_is_superspeed(hub->hdev)) {
2401 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2402 == USB_SS_PORT_LS_U3)
2405 if (portstatus & USB_PORT_STAT_SUSPEND)
2412 /* Determine whether the device on a port is ready for a normal resume,
2413 * is ready for a reset-resume, or should be disconnected.
2415 static int check_port_resume_type(struct usb_device *udev,
2416 struct usb_hub *hub, int port1,
2417 int status, unsigned portchange, unsigned portstatus)
2419 /* Is the device still present? */
2420 if (status || port_is_suspended(hub, portstatus) ||
2421 !port_is_power_on(hub, portstatus) ||
2422 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2427 /* Can't do a normal resume if the port isn't enabled,
2428 * so try a reset-resume instead.
2430 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2431 if (udev->persist_enabled)
2432 udev->reset_resume = 1;
2438 dev_dbg(hub->intfdev,
2439 "port %d status %04x.%04x after resume, %d\n",
2440 port1, portchange, portstatus, status);
2441 } else if (udev->reset_resume) {
2443 /* Late port handoff can set status-change bits */
2444 if (portchange & USB_PORT_STAT_C_CONNECTION)
2445 clear_port_feature(hub->hdev, port1,
2446 USB_PORT_FEAT_C_CONNECTION);
2447 if (portchange & USB_PORT_STAT_C_ENABLE)
2448 clear_port_feature(hub->hdev, port1,
2449 USB_PORT_FEAT_C_ENABLE);
2455 #ifdef CONFIG_USB_SUSPEND
2458 * usb_port_suspend - suspend a usb device's upstream port
2459 * @udev: device that's no longer in active use, not a root hub
2460 * Context: must be able to sleep; device not locked; pm locks held
2462 * Suspends a USB device that isn't in active use, conserving power.
2463 * Devices may wake out of a suspend, if anything important happens,
2464 * using the remote wakeup mechanism. They may also be taken out of
2465 * suspend by the host, using usb_port_resume(). It's also routine
2466 * to disconnect devices while they are suspended.
2468 * This only affects the USB hardware for a device; its interfaces
2469 * (and, for hubs, child devices) must already have been suspended.
2471 * Selective port suspend reduces power; most suspended devices draw
2472 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2473 * All devices below the suspended port are also suspended.
2475 * Devices leave suspend state when the host wakes them up. Some devices
2476 * also support "remote wakeup", where the device can activate the USB
2477 * tree above them to deliver data, such as a keypress or packet. In
2478 * some cases, this wakes the USB host.
2480 * Suspending OTG devices may trigger HNP, if that's been enabled
2481 * between a pair of dual-role devices. That will change roles, such
2482 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2484 * Devices on USB hub ports have only one "suspend" state, corresponding
2485 * to ACPI D2, "may cause the device to lose some context".
2486 * State transitions include:
2488 * - suspend, resume ... when the VBUS power link stays live
2489 * - suspend, disconnect ... VBUS lost
2491 * Once VBUS drop breaks the circuit, the port it's using has to go through
2492 * normal re-enumeration procedures, starting with enabling VBUS power.
2493 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2494 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2495 * timer, no SRP, no requests through sysfs.
2497 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2498 * the root hub for their bus goes into global suspend ... so we don't
2499 * (falsely) update the device power state to say it suspended.
2501 * Returns 0 on success, else negative errno.
2503 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2505 struct usb_hub *hub = hdev_to_hub(udev->parent);
2506 int port1 = udev->portnum;
2509 /* enable remote wakeup when appropriate; this lets the device
2510 * wake up the upstream hub (including maybe the root hub).
2512 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2513 * we don't explicitly enable it here.
2515 if (udev->do_remote_wakeup) {
2516 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2517 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2518 USB_DEVICE_REMOTE_WAKEUP, 0,
2520 USB_CTRL_SET_TIMEOUT);
2522 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2524 /* bail if autosuspend is requested */
2525 if (PMSG_IS_AUTO(msg))
2530 /* disable USB2 hardware LPM */
2531 if (udev->usb2_hw_lpm_enabled == 1)
2532 usb_set_usb2_hardware_lpm(udev, 0);
2535 if (hub_is_superspeed(hub->hdev))
2536 status = set_port_feature(hub->hdev,
2537 port1 | (USB_SS_PORT_LS_U3 << 3),
2538 USB_PORT_FEAT_LINK_STATE);
2540 status = set_port_feature(hub->hdev, port1,
2541 USB_PORT_FEAT_SUSPEND);
2543 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2545 /* paranoia: "should not happen" */
2546 if (udev->do_remote_wakeup)
2547 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2548 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2549 USB_DEVICE_REMOTE_WAKEUP, 0,
2551 USB_CTRL_SET_TIMEOUT);
2553 /* Try to enable USB2 hardware LPM again */
2554 if (udev->usb2_hw_lpm_capable == 1)
2555 usb_set_usb2_hardware_lpm(udev, 1);
2557 /* System sleep transitions should never fail */
2558 if (!PMSG_IS_AUTO(msg))
2561 /* device has up to 10 msec to fully suspend */
2562 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2563 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2564 udev->do_remote_wakeup);
2565 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2568 usb_mark_last_busy(hub->hdev);
2573 * If the USB "suspend" state is in use (rather than "global suspend"),
2574 * many devices will be individually taken out of suspend state using
2575 * special "resume" signaling. This routine kicks in shortly after
2576 * hardware resume signaling is finished, either because of selective
2577 * resume (by host) or remote wakeup (by device) ... now see what changed
2578 * in the tree that's rooted at this device.
2580 * If @udev->reset_resume is set then the device is reset before the
2581 * status check is done.
2583 static int finish_port_resume(struct usb_device *udev)
2588 /* caller owns the udev device lock */
2589 dev_dbg(&udev->dev, "%s\n",
2590 udev->reset_resume ? "finish reset-resume" : "finish resume");
2592 /* usb ch9 identifies four variants of SUSPENDED, based on what
2593 * state the device resumes to. Linux currently won't see the
2594 * first two on the host side; they'd be inside hub_port_init()
2595 * during many timeouts, but khubd can't suspend until later.
2597 usb_set_device_state(udev, udev->actconfig
2598 ? USB_STATE_CONFIGURED
2599 : USB_STATE_ADDRESS);
2601 /* 10.5.4.5 says not to reset a suspended port if the attached
2602 * device is enabled for remote wakeup. Hence the reset
2603 * operation is carried out here, after the port has been
2606 if (udev->reset_resume)
2608 status = usb_reset_and_verify_device(udev);
2610 /* 10.5.4.5 says be sure devices in the tree are still there.
2611 * For now let's assume the device didn't go crazy on resume,
2612 * and device drivers will know about any resume quirks.
2616 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2618 status = (status > 0 ? 0 : -ENODEV);
2620 /* If a normal resume failed, try doing a reset-resume */
2621 if (status && !udev->reset_resume && udev->persist_enabled) {
2622 dev_dbg(&udev->dev, "retry with reset-resume\n");
2623 udev->reset_resume = 1;
2624 goto retry_reset_resume;
2629 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2632 * There are a few quirky devices which violate the standard
2633 * by claiming to have remote wakeup enabled after a reset,
2634 * which crash if the feature is cleared, hence check for
2635 * udev->reset_resume
2637 } else if (udev->actconfig && !udev->reset_resume) {
2638 le16_to_cpus(&devstatus);
2639 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2640 status = usb_control_msg(udev,
2641 usb_sndctrlpipe(udev, 0),
2642 USB_REQ_CLEAR_FEATURE,
2644 USB_DEVICE_REMOTE_WAKEUP, 0,
2646 USB_CTRL_SET_TIMEOUT);
2649 "disable remote wakeup, status %d\n",
2658 * There are some SS USB devices which take longer time for link training.
2659 * XHCI specs 4.19.4 says that when Link training is successful, port
2660 * sets CSC bit to 1. So if SW reads port status before successful link
2661 * training, then it will not find device to be present.
2662 * USB Analyzer log with such buggy devices show that in some cases
2663 * device switch on the RX termination after long delay of host enabling
2664 * the VBUS. In few other cases it has been seen that device fails to
2665 * negotiate link training in first attempt. It has been
2666 * reported till now that few devices take as long as 2000 ms to train
2667 * the link after host enabling its VBUS and termination. Following
2668 * routine implements a 2000 ms timeout for link training. If in a case
2669 * link trains before timeout, loop will exit earlier.
2671 * FIXME: If a device was connected before suspend, but was removed
2672 * while system was asleep, then the loop in the following routine will
2673 * only exit at timeout.
2675 * This routine should only be called when persist is enabled for a SS
2678 static int wait_for_ss_port_enable(struct usb_device *udev,
2679 struct usb_hub *hub, int *port1,
2680 u16 *portchange, u16 *portstatus)
2682 int status = 0, delay_ms = 0;
2684 while (delay_ms < 2000) {
2685 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
2689 status = hub_port_status(hub, *port1, portstatus, portchange);
2695 * usb_port_resume - re-activate a suspended usb device's upstream port
2696 * @udev: device to re-activate, not a root hub
2697 * Context: must be able to sleep; device not locked; pm locks held
2699 * This will re-activate the suspended device, increasing power usage
2700 * while letting drivers communicate again with its endpoints.
2701 * USB resume explicitly guarantees that the power session between
2702 * the host and the device is the same as it was when the device
2705 * If @udev->reset_resume is set then this routine won't check that the
2706 * port is still enabled. Furthermore, finish_port_resume() above will
2707 * reset @udev. The end result is that a broken power session can be
2708 * recovered and @udev will appear to persist across a loss of VBUS power.
2710 * For example, if a host controller doesn't maintain VBUS suspend current
2711 * during a system sleep or is reset when the system wakes up, all the USB
2712 * power sessions below it will be broken. This is especially troublesome
2713 * for mass-storage devices containing mounted filesystems, since the
2714 * device will appear to have disconnected and all the memory mappings
2715 * to it will be lost. Using the USB_PERSIST facility, the device can be
2716 * made to appear as if it had not disconnected.
2718 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2719 * every effort to insure that the same device is present after the
2720 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2721 * quite possible for a device to remain unaltered but its media to be
2722 * changed. If the user replaces a flash memory card while the system is
2723 * asleep, he will have only himself to blame when the filesystem on the
2724 * new card is corrupted and the system crashes.
2726 * Returns 0 on success, else negative errno.
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 /* Skip the initial Clear-Suspend step for a remote wakeup */
2736 status = hub_port_status(hub, port1, &portstatus, &portchange);
2737 if (status == 0 && !port_is_suspended(hub, portstatus))
2738 goto SuspendCleared;
2740 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2742 set_bit(port1, hub->busy_bits);
2744 /* see 7.1.7.7; affects power usage, but not budgeting */
2745 if (hub_is_superspeed(hub->hdev))
2746 status = set_port_feature(hub->hdev,
2747 port1 | (USB_SS_PORT_LS_U0 << 3),
2748 USB_PORT_FEAT_LINK_STATE);
2750 status = clear_port_feature(hub->hdev,
2751 port1, USB_PORT_FEAT_SUSPEND);
2753 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2756 /* drive resume for at least 20 msec */
2757 dev_dbg(&udev->dev, "usb %sresume\n",
2758 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2761 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2762 * stop resume signaling. Then finish the resume
2765 status = hub_port_status(hub, port1, &portstatus, &portchange);
2767 /* TRSMRCY = 10 msec */
2773 if (hub_is_superspeed(hub->hdev)) {
2774 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2775 clear_port_feature(hub->hdev, port1,
2776 USB_PORT_FEAT_C_PORT_LINK_STATE);
2778 if (portchange & USB_PORT_STAT_C_SUSPEND)
2779 clear_port_feature(hub->hdev, port1,
2780 USB_PORT_FEAT_C_SUSPEND);
2784 clear_bit(port1, hub->busy_bits);
2786 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
2787 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
2790 status = check_port_resume_type(udev,
2791 hub, port1, status, portchange, portstatus);
2793 status = finish_port_resume(udev);
2795 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2796 hub_port_logical_disconnect(hub, port1);
2798 /* Try to enable USB2 hardware LPM */
2799 if (udev->usb2_hw_lpm_capable == 1)
2800 usb_set_usb2_hardware_lpm(udev, 1);
2806 /* caller has locked udev */
2807 int usb_remote_wakeup(struct usb_device *udev)
2811 if (udev->state == USB_STATE_SUSPENDED) {
2812 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2813 status = usb_autoresume_device(udev);
2815 /* Let the drivers do their thing, then... */
2816 usb_autosuspend_device(udev);
2822 #else /* CONFIG_USB_SUSPEND */
2824 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2826 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2831 /* However we may need to do a reset-resume */
2833 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2835 struct usb_hub *hub = hdev_to_hub(udev->parent);
2836 int port1 = udev->portnum;
2838 u16 portchange, portstatus;
2840 status = hub_port_status(hub, port1, &portstatus, &portchange);
2841 status = check_port_resume_type(udev,
2842 hub, port1, status, portchange, portstatus);
2845 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2846 hub_port_logical_disconnect(hub, port1);
2847 } else if (udev->reset_resume) {
2848 dev_dbg(&udev->dev, "reset-resume\n");
2849 status = usb_reset_and_verify_device(udev);
2856 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2858 struct usb_hub *hub = usb_get_intfdata (intf);
2859 struct usb_device *hdev = hub->hdev;
2862 /* Warn if children aren't already suspended */
2863 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2864 struct usb_device *udev;
2866 udev = hdev->children [port1-1];
2867 if (udev && udev->can_submit) {
2868 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2869 if (PMSG_IS_AUTO(msg))
2874 dev_dbg(&intf->dev, "%s\n", __func__);
2876 /* stop khubd and related activity */
2877 hub_quiesce(hub, HUB_SUSPEND);
2881 static int hub_resume(struct usb_interface *intf)
2883 struct usb_hub *hub = usb_get_intfdata(intf);
2885 dev_dbg(&intf->dev, "%s\n", __func__);
2886 hub_activate(hub, HUB_RESUME);
2890 static int hub_reset_resume(struct usb_interface *intf)
2892 struct usb_hub *hub = usb_get_intfdata(intf);
2894 dev_dbg(&intf->dev, "%s\n", __func__);
2895 hub_activate(hub, HUB_RESET_RESUME);
2900 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2901 * @rhdev: struct usb_device for the root hub
2903 * The USB host controller driver calls this function when its root hub
2904 * is resumed and Vbus power has been interrupted or the controller
2905 * has been reset. The routine marks @rhdev as having lost power.
2906 * When the hub driver is resumed it will take notice and carry out
2907 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2908 * the others will be disconnected.
2910 void usb_root_hub_lost_power(struct usb_device *rhdev)
2912 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2913 rhdev->reset_resume = 1;
2915 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2917 #else /* CONFIG_PM */
2919 #define hub_suspend NULL
2920 #define hub_resume NULL
2921 #define hub_reset_resume NULL
2925 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2927 * Between connect detection and reset signaling there must be a delay
2928 * of 100ms at least for debounce and power-settling. The corresponding
2929 * timer shall restart whenever the downstream port detects a disconnect.
2931 * Apparently there are some bluetooth and irda-dongles and a number of
2932 * low-speed devices for which this debounce period may last over a second.
2933 * Not covered by the spec - but easy to deal with.
2935 * This implementation uses a 1500ms total debounce timeout; if the
2936 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2937 * every 25ms for transient disconnects. When the port status has been
2938 * unchanged for 100ms it returns the port status.
2940 static int hub_port_debounce(struct usb_hub *hub, int port1)
2943 int total_time, stable_time = 0;
2944 u16 portchange, portstatus;
2945 unsigned connection = 0xffff;
2947 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2948 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2952 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2953 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2954 stable_time += HUB_DEBOUNCE_STEP;
2955 if (stable_time >= HUB_DEBOUNCE_STABLE)
2959 connection = portstatus & USB_PORT_STAT_CONNECTION;
2962 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2963 clear_port_feature(hub->hdev, port1,
2964 USB_PORT_FEAT_C_CONNECTION);
2967 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2969 msleep(HUB_DEBOUNCE_STEP);
2972 dev_dbg (hub->intfdev,
2973 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2974 port1, total_time, stable_time, portstatus);
2976 if (stable_time < HUB_DEBOUNCE_STABLE)
2981 void usb_ep0_reinit(struct usb_device *udev)
2983 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2984 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2985 usb_enable_endpoint(udev, &udev->ep0, true);
2987 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2989 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2990 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2992 static int hub_set_address(struct usb_device *udev, int devnum)
2995 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2998 * The host controller will choose the device address,
2999 * instead of the core having chosen it earlier
3001 if (!hcd->driver->address_device && devnum <= 1)
3003 if (udev->state == USB_STATE_ADDRESS)
3005 if (udev->state != USB_STATE_DEFAULT)
3007 if (hcd->driver->address_device)
3008 retval = hcd->driver->address_device(hcd, udev);
3010 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3011 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3012 NULL, 0, USB_CTRL_SET_TIMEOUT);
3014 update_devnum(udev, devnum);
3015 /* Device now using proper address. */
3016 usb_set_device_state(udev, USB_STATE_ADDRESS);
3017 usb_ep0_reinit(udev);
3022 /* Reset device, (re)assign address, get device descriptor.
3023 * Device connection must be stable, no more debouncing needed.
3024 * Returns device in USB_STATE_ADDRESS, except on error.
3026 * If this is called for an already-existing device (as part of
3027 * usb_reset_and_verify_device), the caller must own the device lock. For a
3028 * newly detected device that is not accessible through any global
3029 * pointers, it's not necessary to lock the device.
3032 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3035 static DEFINE_MUTEX(usb_address0_mutex);
3037 struct usb_device *hdev = hub->hdev;
3038 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3039 int retries, operations, retval, i;
3040 unsigned delay = HUB_SHORT_RESET_TIME;
3041 enum usb_device_speed oldspeed = udev->speed;
3043 int devnum = udev->devnum;
3045 /* root hub ports have a slightly longer reset period
3046 * (from USB 2.0 spec, section 7.1.7.5)
3048 if (!hdev->parent) {
3049 delay = HUB_ROOT_RESET_TIME;
3050 if (port1 == hdev->bus->otg_port)
3051 hdev->bus->b_hnp_enable = 0;
3054 /* Some low speed devices have problems with the quick delay, so */
3055 /* be a bit pessimistic with those devices. RHbug #23670 */
3056 if (oldspeed == USB_SPEED_LOW)
3057 delay = HUB_LONG_RESET_TIME;
3059 mutex_lock(&usb_address0_mutex);
3061 /* Reset the device; full speed may morph to high speed */
3062 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
3063 retval = hub_port_reset(hub, port1, udev, delay, false);
3064 if (retval < 0) /* error or disconnect */
3066 /* success, speed is known */
3070 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3071 dev_dbg(&udev->dev, "device reset changed speed!\n");
3074 oldspeed = udev->speed;
3076 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3077 * it's fixed size except for full speed devices.
3078 * For Wireless USB devices, ep0 max packet is always 512 (tho
3079 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
3081 switch (udev->speed) {
3082 case USB_SPEED_SUPER:
3083 case USB_SPEED_WIRELESS: /* fixed at 512 */
3084 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3086 case USB_SPEED_HIGH: /* fixed at 64 */
3087 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3089 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3090 /* to determine the ep0 maxpacket size, try to read
3091 * the device descriptor to get bMaxPacketSize0 and
3092 * then correct our initial guess.
3094 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3096 case USB_SPEED_LOW: /* fixed at 8 */
3097 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3103 if (udev->speed == USB_SPEED_WIRELESS)
3104 speed = "variable speed Wireless";
3106 speed = usb_speed_string(udev->speed);
3108 if (udev->speed != USB_SPEED_SUPER)
3109 dev_info(&udev->dev,
3110 "%s %s USB device number %d using %s\n",
3111 (udev->config) ? "reset" : "new", speed,
3112 devnum, udev->bus->controller->driver->name);
3114 /* Set up TT records, if needed */
3116 udev->tt = hdev->tt;
3117 udev->ttport = hdev->ttport;
3118 } else if (udev->speed != USB_SPEED_HIGH
3119 && hdev->speed == USB_SPEED_HIGH) {
3121 dev_err(&udev->dev, "parent hub has no TT\n");
3125 udev->tt = &hub->tt;
3126 udev->ttport = port1;
3129 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3130 * Because device hardware and firmware is sometimes buggy in
3131 * this area, and this is how Linux has done it for ages.
3132 * Change it cautiously.
3134 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3135 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3136 * so it may help with some non-standards-compliant devices.
3137 * Otherwise we start with SET_ADDRESS and then try to read the
3138 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3141 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
3142 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3143 struct usb_device_descriptor *buf;
3146 #define GET_DESCRIPTOR_BUFSIZE 64
3147 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3153 /* Retry on all errors; some devices are flakey.
3154 * 255 is for WUSB devices, we actually need to use
3155 * 512 (WUSB1.0[4.8.1]).
3157 for (operations = 0; operations < 3; ++operations) {
3158 buf->bMaxPacketSize0 = 0;
3159 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3160 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3161 USB_DT_DEVICE << 8, 0,
3162 buf, GET_DESCRIPTOR_BUFSIZE,
3163 initial_descriptor_timeout);
3164 switch (buf->bMaxPacketSize0) {
3165 case 8: case 16: case 32: case 64: case 255:
3166 if (buf->bDescriptorType ==
3178 * Some devices time out if they are powered on
3179 * when already connected. They need a second
3180 * reset. But only on the first attempt,
3181 * lest we get into a time out/reset loop
3183 if (r == 0 || (r == -ETIMEDOUT && retries == 0))
3186 udev->descriptor.bMaxPacketSize0 =
3187 buf->bMaxPacketSize0;
3190 retval = hub_port_reset(hub, port1, udev, delay, false);
3191 if (retval < 0) /* error or disconnect */
3193 if (oldspeed != udev->speed) {
3195 "device reset changed speed!\n");
3201 "device descriptor read/64, error %d\n",
3206 #undef GET_DESCRIPTOR_BUFSIZE
3210 * If device is WUSB, we already assigned an
3211 * unauthorized address in the Connect Ack sequence;
3212 * authorization will assign the final address.
3214 if (udev->wusb == 0) {
3215 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
3216 retval = hub_set_address(udev, devnum);
3223 "device not accepting address %d, error %d\n",
3227 if (udev->speed == USB_SPEED_SUPER) {
3228 devnum = udev->devnum;
3229 dev_info(&udev->dev,
3230 "%s SuperSpeed USB device number %d using %s\n",
3231 (udev->config) ? "reset" : "new",
3232 devnum, udev->bus->controller->driver->name);
3235 /* cope with hardware quirkiness:
3236 * - let SET_ADDRESS settle, some device hardware wants it
3237 * - read ep0 maxpacket even for high and low speed,
3240 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3244 retval = usb_get_device_descriptor(udev, 8);
3247 "device descriptor read/8, error %d\n",
3260 * Some superspeed devices have finished the link training process
3261 * and attached to a superspeed hub port, but the device descriptor
3262 * got from those devices show they aren't superspeed devices. Warm
3263 * reset the port attached by the devices can fix them.
3265 if ((udev->speed == USB_SPEED_SUPER) &&
3266 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3267 dev_err(&udev->dev, "got a wrong device descriptor, "
3268 "warm reset device\n");
3269 hub_port_reset(hub, port1, udev,
3270 HUB_BH_RESET_TIME, true);
3275 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3276 udev->speed == USB_SPEED_SUPER)
3279 i = udev->descriptor.bMaxPacketSize0;
3280 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3281 if (udev->speed == USB_SPEED_LOW ||
3282 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3283 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3287 if (udev->speed == USB_SPEED_FULL)
3288 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3290 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3291 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3292 usb_ep0_reinit(udev);
3295 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3296 if (retval < (signed)sizeof(udev->descriptor)) {
3297 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3304 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3305 retval = usb_get_bos_descriptor(udev);
3307 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3308 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3309 udev->lpm_capable = 1;
3314 /* notify HCD that we have a device connected and addressed */
3315 if (hcd->driver->update_device)
3316 hcd->driver->update_device(hcd, udev);
3319 hub_port_disable(hub, port1, 0);
3320 update_devnum(udev, devnum); /* for disconnect processing */
3322 mutex_unlock(&usb_address0_mutex);
3327 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3329 struct usb_qualifier_descriptor *qual;
3332 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3336 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3337 qual, sizeof *qual);
3338 if (status == sizeof *qual) {
3339 dev_info(&udev->dev, "not running at top speed; "
3340 "connect to a high speed hub\n");
3341 /* hub LEDs are probably harder to miss than syslog */
3342 if (hub->has_indicators) {
3343 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3344 schedule_delayed_work (&hub->leds, 0);
3351 hub_power_remaining (struct usb_hub *hub)
3353 struct usb_device *hdev = hub->hdev;
3357 if (!hub->limited_power)
3360 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3361 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3362 struct usb_device *udev = hdev->children[port1 - 1];
3368 /* Unconfigured devices may not use more than 100mA,
3369 * or 8mA for OTG ports */
3370 if (udev->actconfig)
3371 delta = udev->actconfig->desc.bMaxPower * 2;
3372 else if (port1 != udev->bus->otg_port || hdev->parent)
3376 if (delta > hub->mA_per_port)
3377 dev_warn(&udev->dev,
3378 "%dmA is over %umA budget for port %d!\n",
3379 delta, hub->mA_per_port, port1);
3382 if (remaining < 0) {
3383 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3390 /* Handle physical or logical connection change events.
3391 * This routine is called when:
3392 * a port connection-change occurs;
3393 * a port enable-change occurs (often caused by EMI);
3394 * usb_reset_and_verify_device() encounters changed descriptors (as from
3395 * a firmware download)
3396 * caller already locked the hub
3398 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3399 u16 portstatus, u16 portchange)
3401 struct usb_device *hdev = hub->hdev;
3402 struct device *hub_dev = hub->intfdev;
3403 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3404 unsigned wHubCharacteristics =
3405 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3406 struct usb_device *udev;
3408 static int unreliable_port = -1;
3411 "port %d, status %04x, change %04x, %s\n",
3412 port1, portstatus, portchange, portspeed(hub, portstatus));
3414 if (hub->has_indicators) {
3415 set_port_led(hub, port1, HUB_LED_AUTO);
3416 hub->indicator[port1-1] = INDICATOR_AUTO;
3419 #ifdef CONFIG_USB_OTG
3420 /* during HNP, don't repeat the debounce */
3421 if (hdev->bus->is_b_host)
3422 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3423 USB_PORT_STAT_C_ENABLE);
3426 /* Try to resuscitate an existing device */
3427 udev = hdev->children[port1-1];
3428 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3429 udev->state != USB_STATE_NOTATTACHED) {
3430 usb_lock_device(udev);
3431 if (portstatus & USB_PORT_STAT_ENABLE) {
3432 status = 0; /* Nothing to do */
3434 #ifdef CONFIG_USB_SUSPEND
3435 } else if (udev->state == USB_STATE_SUSPENDED &&
3436 udev->persist_enabled) {
3437 /* For a suspended device, treat this as a
3438 * remote wakeup event.
3440 status = usb_remote_wakeup(udev);
3444 status = -ENODEV; /* Don't resuscitate */
3446 usb_unlock_device(udev);
3449 clear_bit(port1, hub->change_bits);
3454 /* Disconnect any existing devices under this port */
3456 usb_disconnect(&hdev->children[port1-1]);
3457 clear_bit(port1, hub->change_bits);
3459 /* We can forget about a "removed" device when there's a physical
3460 * disconnect or the connect status changes.
3462 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3463 (portchange & USB_PORT_STAT_C_CONNECTION))
3464 clear_bit(port1, hub->removed_bits);
3466 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3467 USB_PORT_STAT_C_ENABLE)) {
3468 status = hub_port_debounce(hub, port1);
3470 if (port1 != unreliable_port && printk_ratelimit())
3471 dev_err(hub_dev, "connect-debounce failed, "
3472 "port %d disabled\n", port1);
3473 portstatus &= ~USB_PORT_STAT_CONNECTION;
3474 unreliable_port = port1;
3476 portstatus = status;
3480 /* Return now if debouncing failed or nothing is connected or
3481 * the device was "removed".
3483 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3484 test_bit(port1, hub->removed_bits)) {
3486 /* maybe switch power back on (e.g. root hub was reset) */
3487 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3488 && !port_is_power_on(hub, portstatus))
3489 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3491 if (portstatus & USB_PORT_STAT_ENABLE)
3496 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3498 /* reallocate for each attempt, since references
3499 * to the previous one can escape in various ways
3501 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3504 "couldn't allocate port %d usb_device\n",
3509 usb_set_device_state(udev, USB_STATE_POWERED);
3510 udev->bus_mA = hub->mA_per_port;
3511 udev->level = hdev->level + 1;
3512 udev->wusb = hub_is_wusb(hub);
3514 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3515 if (hub_is_superspeed(hub->hdev))
3516 udev->speed = USB_SPEED_SUPER;
3518 udev->speed = USB_SPEED_UNKNOWN;
3520 choose_devnum(udev);
3521 if (udev->devnum <= 0) {
3522 status = -ENOTCONN; /* Don't retry */
3526 /* reset (non-USB 3.0 devices) and get descriptor */
3527 status = hub_port_init(hub, udev, port1, i);
3531 usb_detect_quirks(udev);
3532 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3535 /* consecutive bus-powered hubs aren't reliable; they can
3536 * violate the voltage drop budget. if the new child has
3537 * a "powered" LED, users should notice we didn't enable it
3538 * (without reading syslog), even without per-port LEDs
3541 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3542 && udev->bus_mA <= 100) {
3545 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3548 dev_dbg(&udev->dev, "get status %d ?\n", status);
3551 le16_to_cpus(&devstat);
3552 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3554 "can't connect bus-powered hub "
3556 if (hub->has_indicators) {
3557 hub->indicator[port1-1] =
3558 INDICATOR_AMBER_BLINK;
3559 schedule_delayed_work (&hub->leds, 0);
3561 status = -ENOTCONN; /* Don't retry */
3566 /* check for devices running slower than they could */
3567 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3568 && udev->speed == USB_SPEED_FULL
3569 && highspeed_hubs != 0)
3570 check_highspeed (hub, udev, port1);
3572 /* Store the parent's children[] pointer. At this point
3573 * udev becomes globally accessible, although presumably
3574 * no one will look at it until hdev is unlocked.
3578 /* We mustn't add new devices if the parent hub has
3579 * been disconnected; we would race with the
3580 * recursively_mark_NOTATTACHED() routine.
3582 spin_lock_irq(&device_state_lock);
3583 if (hdev->state == USB_STATE_NOTATTACHED)
3586 hdev->children[port1-1] = udev;
3587 spin_unlock_irq(&device_state_lock);
3589 /* Run it through the hoops (find a driver, etc) */
3591 status = usb_new_device(udev);
3593 spin_lock_irq(&device_state_lock);
3594 hdev->children[port1-1] = NULL;
3595 spin_unlock_irq(&device_state_lock);
3602 status = hub_power_remaining(hub);
3604 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3609 hub_port_disable(hub, port1, 1);
3611 usb_ep0_reinit(udev);
3612 release_devnum(udev);
3615 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3618 if (hub->hdev->parent ||
3619 !hcd->driver->port_handed_over ||
3620 !(hcd->driver->port_handed_over)(hcd, port1))
3621 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3625 hub_port_disable(hub, port1, 1);
3626 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3627 hcd->driver->relinquish_port(hcd, port1);
3630 static void hub_events(void)
3632 struct list_head *tmp;
3633 struct usb_device *hdev;
3634 struct usb_interface *intf;
3635 struct usb_hub *hub;
3636 struct device *hub_dev;
3645 * We restart the list every time to avoid a deadlock with
3646 * deleting hubs downstream from this one. This should be
3647 * safe since we delete the hub from the event list.
3648 * Not the most efficient, but avoids deadlocks.
3652 /* Grab the first entry at the beginning of the list */
3653 spin_lock_irq(&hub_event_lock);
3654 if (list_empty(&hub_event_list)) {
3655 spin_unlock_irq(&hub_event_lock);
3659 tmp = hub_event_list.next;
3662 hub = list_entry(tmp, struct usb_hub, event_list);
3663 kref_get(&hub->kref);
3666 spin_unlock_irq(&hub_event_lock);
3668 hub_dev = hub->intfdev;
3669 intf = to_usb_interface(hub_dev);
3670 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3671 hdev->state, hub->descriptor
3672 ? hub->descriptor->bNbrPorts
3674 /* NOTE: expects max 15 ports... */
3675 (u16) hub->change_bits[0],
3676 (u16) hub->event_bits[0]);
3678 /* Lock the device, then check to see if we were
3679 * disconnected while waiting for the lock to succeed. */
3680 usb_lock_device(hdev);
3681 if (unlikely(hub->disconnected))
3682 goto loop_disconnected;
3684 /* If the hub has died, clean up after it */
3685 if (hdev->state == USB_STATE_NOTATTACHED) {
3686 hub->error = -ENODEV;
3687 hub_quiesce(hub, HUB_DISCONNECT);
3692 ret = usb_autopm_get_interface(intf);
3694 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3698 /* If this is an inactive hub, do nothing */
3703 dev_dbg (hub_dev, "resetting for error %d\n",
3706 ret = usb_reset_device(hdev);
3709 "error resetting hub: %d\n", ret);
3717 /* deal with port status changes */
3718 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3719 if (test_bit(i, hub->busy_bits))
3721 connect_change = test_bit(i, hub->change_bits);
3722 if (!test_and_clear_bit(i, hub->event_bits) &&
3726 ret = hub_port_status(hub, i,
3727 &portstatus, &portchange);
3731 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3732 clear_port_feature(hdev, i,
3733 USB_PORT_FEAT_C_CONNECTION);
3737 if (portchange & USB_PORT_STAT_C_ENABLE) {
3738 if (!connect_change)
3740 "port %d enable change, "
3743 clear_port_feature(hdev, i,
3744 USB_PORT_FEAT_C_ENABLE);
3747 * EM interference sometimes causes badly
3748 * shielded USB devices to be shutdown by
3749 * the hub, this hack enables them again.
3750 * Works at least with mouse driver.
3752 if (!(portstatus & USB_PORT_STAT_ENABLE)
3754 && hdev->children[i-1]) {
3757 "disabled by hub (EMI?), "
3764 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3765 struct usb_device *udev;
3767 clear_port_feature(hdev, i,
3768 USB_PORT_FEAT_C_SUSPEND);
3769 udev = hdev->children[i-1];
3771 /* TRSMRCY = 10 msec */
3774 usb_lock_device(udev);
3775 ret = usb_remote_wakeup(hdev->
3777 usb_unlock_device(udev);
3782 hub_port_disable(hub, i, 1);
3785 "resume on port %d, status %d\n",
3789 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3793 dev_dbg(hub_dev, "over-current change on port "
3795 clear_port_feature(hdev, i,
3796 USB_PORT_FEAT_C_OVER_CURRENT);
3797 msleep(100); /* Cool down */
3798 hub_power_on(hub, true);
3799 hub_port_status(hub, i, &status, &unused);
3800 if (status & USB_PORT_STAT_OVERCURRENT)
3801 dev_err(hub_dev, "over-current "
3802 "condition on port %d\n", i);
3805 if (portchange & USB_PORT_STAT_C_RESET) {
3807 "reset change on port %d\n",
3809 clear_port_feature(hdev, i,
3810 USB_PORT_FEAT_C_RESET);
3812 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3813 hub_is_superspeed(hub->hdev)) {
3815 "warm reset change on port %d\n",
3817 clear_port_feature(hdev, i,
3818 USB_PORT_FEAT_C_BH_PORT_RESET);
3820 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3821 clear_port_feature(hub->hdev, i,
3822 USB_PORT_FEAT_C_PORT_LINK_STATE);
3824 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3826 "config error on port %d\n",
3828 clear_port_feature(hub->hdev, i,
3829 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3832 /* Warm reset a USB3 protocol port if it's in
3833 * SS.Inactive state.
3835 if (hub_port_warm_reset_required(hub, portstatus)) {
3837 struct usb_device *udev =
3838 hub->hdev->children[i - 1];
3840 dev_dbg(hub_dev, "warm reset port %d\n", i);
3842 !(portstatus & USB_PORT_STAT_CONNECTION) ||
3843 udev->state == USB_STATE_NOTATTACHED) {
3844 status = hub_port_reset(hub, i,
3845 NULL, HUB_BH_RESET_TIME,
3848 hub_port_disable(hub, i, 1);
3850 usb_lock_device(udev);
3851 status = usb_reset_device(udev);
3852 usb_unlock_device(udev);
3858 hub_port_connect_change(hub, i,
3859 portstatus, portchange);
3862 /* deal with hub status changes */
3863 if (test_and_clear_bit(0, hub->event_bits) == 0)
3865 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3866 dev_err (hub_dev, "get_hub_status failed\n");
3868 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3869 dev_dbg (hub_dev, "power change\n");
3870 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3871 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3872 /* FIXME: Is this always true? */
3873 hub->limited_power = 1;
3875 hub->limited_power = 0;
3877 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3881 dev_dbg(hub_dev, "over-current change\n");
3882 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3883 msleep(500); /* Cool down */
3884 hub_power_on(hub, true);
3885 hub_hub_status(hub, &status, &unused);
3886 if (status & HUB_STATUS_OVERCURRENT)
3887 dev_err(hub_dev, "over-current "
3893 /* Balance the usb_autopm_get_interface() above */
3894 usb_autopm_put_interface_no_suspend(intf);
3896 /* Balance the usb_autopm_get_interface_no_resume() in
3897 * kick_khubd() and allow autosuspend.
3899 usb_autopm_put_interface(intf);
3901 usb_unlock_device(hdev);
3903 kref_put(&hub->kref, hub_release);
3905 } /* end while (1) */
3908 static int hub_thread(void *__unused)
3910 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3911 * port handover. Otherwise it might see that a full-speed device
3912 * was gone before the EHCI controller had handed its port over to
3913 * the companion full-speed controller.
3919 wait_event_freezable(khubd_wait,
3920 !list_empty(&hub_event_list) ||
3921 kthread_should_stop());
3922 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3924 pr_debug("%s: khubd exiting\n", usbcore_name);
3928 static const struct usb_device_id hub_id_table[] = {
3929 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3930 .bDeviceClass = USB_CLASS_HUB},
3931 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3932 .bInterfaceClass = USB_CLASS_HUB},
3933 { } /* Terminating entry */
3936 MODULE_DEVICE_TABLE (usb, hub_id_table);
3938 static struct usb_driver hub_driver = {
3941 .disconnect = hub_disconnect,
3942 .suspend = hub_suspend,
3943 .resume = hub_resume,
3944 .reset_resume = hub_reset_resume,
3945 .pre_reset = hub_pre_reset,
3946 .post_reset = hub_post_reset,
3947 .unlocked_ioctl = hub_ioctl,
3948 .id_table = hub_id_table,
3949 .supports_autosuspend = 1,
3952 int usb_hub_init(void)
3954 if (usb_register(&hub_driver) < 0) {
3955 printk(KERN_ERR "%s: can't register hub driver\n",
3960 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3961 if (!IS_ERR(khubd_task))
3964 /* Fall through if kernel_thread failed */
3965 usb_deregister(&hub_driver);
3966 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3971 void usb_hub_cleanup(void)
3973 kthread_stop(khubd_task);
3976 * Hub resources are freed for us by usb_deregister. It calls
3977 * usb_driver_purge on every device which in turn calls that
3978 * devices disconnect function if it is using this driver.
3979 * The hub_disconnect function takes care of releasing the
3980 * individual hub resources. -greg
3982 usb_deregister(&hub_driver);
3983 } /* usb_hub_cleanup() */
3985 static int descriptors_changed(struct usb_device *udev,
3986 struct usb_device_descriptor *old_device_descriptor)
3990 unsigned serial_len = 0;
3992 unsigned old_length;
3996 if (memcmp(&udev->descriptor, old_device_descriptor,
3997 sizeof(*old_device_descriptor)) != 0)
4000 /* Since the idVendor, idProduct, and bcdDevice values in the
4001 * device descriptor haven't changed, we will assume the
4002 * Manufacturer and Product strings haven't changed either.
4003 * But the SerialNumber string could be different (e.g., a
4004 * different flash card of the same brand).
4007 serial_len = strlen(udev->serial) + 1;
4010 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4011 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4012 len = max(len, old_length);
4015 buf = kmalloc(len, GFP_NOIO);
4017 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4018 /* assume the worst */
4021 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4022 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4023 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4025 if (length != old_length) {
4026 dev_dbg(&udev->dev, "config index %d, error %d\n",
4031 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4033 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4035 ((struct usb_config_descriptor *) buf)->
4036 bConfigurationValue);
4042 if (!changed && serial_len) {
4043 length = usb_string(udev, udev->descriptor.iSerialNumber,
4045 if (length + 1 != serial_len) {
4046 dev_dbg(&udev->dev, "serial string error %d\n",
4049 } else if (memcmp(buf, udev->serial, length) != 0) {
4050 dev_dbg(&udev->dev, "serial string changed\n");
4060 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
4061 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4063 * WARNING - don't use this routine to reset a composite device
4064 * (one with multiple interfaces owned by separate drivers)!
4065 * Use usb_reset_device() instead.
4067 * Do a port reset, reassign the device's address, and establish its
4068 * former operating configuration. If the reset fails, or the device's
4069 * descriptors change from their values before the reset, or the original
4070 * configuration and altsettings cannot be restored, a flag will be set
4071 * telling khubd to pretend the device has been disconnected and then
4072 * re-connected. All drivers will be unbound, and the device will be
4073 * re-enumerated and probed all over again.
4075 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4076 * flagged for logical disconnection, or some other negative error code
4077 * if the reset wasn't even attempted.
4079 * The caller must own the device lock. For example, it's safe to use
4080 * this from a driver probe() routine after downloading new firmware.
4081 * For calls that might not occur during probe(), drivers should lock
4082 * the device using usb_lock_device_for_reset().
4084 * Locking exception: This routine may also be called from within an
4085 * autoresume handler. Such usage won't conflict with other tasks
4086 * holding the device lock because these tasks should always call
4087 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
4089 static int usb_reset_and_verify_device(struct usb_device *udev)
4091 struct usb_device *parent_hdev = udev->parent;
4092 struct usb_hub *parent_hub;
4093 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4094 struct usb_device_descriptor descriptor = udev->descriptor;
4096 int port1 = udev->portnum;
4098 if (udev->state == USB_STATE_NOTATTACHED ||
4099 udev->state == USB_STATE_SUSPENDED) {
4100 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4106 /* this requires hcd-specific logic; see ohci_restart() */
4107 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4110 parent_hub = hdev_to_hub(parent_hdev);
4112 /* Disable USB2 hardware LPM.
4113 * It will be re-enabled by the enumeration process.
4115 if (udev->usb2_hw_lpm_enabled == 1)
4116 usb_set_usb2_hardware_lpm(udev, 0);
4118 set_bit(port1, parent_hub->busy_bits);
4119 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4121 /* ep0 maxpacket size may change; let the HCD know about it.
4122 * Other endpoints will be handled by re-enumeration. */
4123 usb_ep0_reinit(udev);
4124 ret = hub_port_init(parent_hub, udev, port1, i);
4125 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4128 clear_bit(port1, parent_hub->busy_bits);
4133 /* Device might have changed firmware (DFU or similar) */
4134 if (descriptors_changed(udev, &descriptor)) {
4135 dev_info(&udev->dev, "device firmware changed\n");
4136 udev->descriptor = descriptor; /* for disconnect() calls */
4140 /* Restore the device's previous configuration */
4141 if (!udev->actconfig)
4144 mutex_lock(hcd->bandwidth_mutex);
4145 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4147 dev_warn(&udev->dev,
4148 "Busted HC? Not enough HCD resources for "
4149 "old configuration.\n");
4150 mutex_unlock(hcd->bandwidth_mutex);
4153 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4154 USB_REQ_SET_CONFIGURATION, 0,
4155 udev->actconfig->desc.bConfigurationValue, 0,
4156 NULL, 0, USB_CTRL_SET_TIMEOUT);
4159 "can't restore configuration #%d (error=%d)\n",
4160 udev->actconfig->desc.bConfigurationValue, ret);
4161 mutex_unlock(hcd->bandwidth_mutex);
4164 mutex_unlock(hcd->bandwidth_mutex);
4165 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4167 /* Put interfaces back into the same altsettings as before.
4168 * Don't bother to send the Set-Interface request for interfaces
4169 * that were already in altsetting 0; besides being unnecessary,
4170 * many devices can't handle it. Instead just reset the host-side
4173 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4174 struct usb_host_config *config = udev->actconfig;
4175 struct usb_interface *intf = config->interface[i];
4176 struct usb_interface_descriptor *desc;
4178 desc = &intf->cur_altsetting->desc;
4179 if (desc->bAlternateSetting == 0) {
4180 usb_disable_interface(udev, intf, true);
4181 usb_enable_interface(udev, intf, true);
4184 /* Let the bandwidth allocation function know that this
4185 * device has been reset, and it will have to use
4186 * alternate setting 0 as the current alternate setting.
4188 intf->resetting_device = 1;
4189 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4190 desc->bAlternateSetting);
4191 intf->resetting_device = 0;
4194 dev_err(&udev->dev, "failed to restore interface %d "
4195 "altsetting %d (error=%d)\n",
4196 desc->bInterfaceNumber,
4197 desc->bAlternateSetting,
4207 hub_port_logical_disconnect(parent_hub, port1);
4212 * usb_reset_device - warn interface drivers and perform a USB port reset
4213 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4215 * Warns all drivers bound to registered interfaces (using their pre_reset
4216 * method), performs the port reset, and then lets the drivers know that
4217 * the reset is over (using their post_reset method).
4219 * Return value is the same as for usb_reset_and_verify_device().
4221 * The caller must own the device lock. For example, it's safe to use
4222 * this from a driver probe() routine after downloading new firmware.
4223 * For calls that might not occur during probe(), drivers should lock
4224 * the device using usb_lock_device_for_reset().
4226 * If an interface is currently being probed or disconnected, we assume
4227 * its driver knows how to handle resets. For all other interfaces,
4228 * if the driver doesn't have pre_reset and post_reset methods then
4229 * we attempt to unbind it and rebind afterward.
4231 int usb_reset_device(struct usb_device *udev)
4235 struct usb_host_config *config = udev->actconfig;
4237 if (udev->state == USB_STATE_NOTATTACHED ||
4238 udev->state == USB_STATE_SUSPENDED) {
4239 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4244 /* Prevent autosuspend during the reset */
4245 usb_autoresume_device(udev);
4248 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4249 struct usb_interface *cintf = config->interface[i];
4250 struct usb_driver *drv;
4253 if (cintf->dev.driver) {
4254 drv = to_usb_driver(cintf->dev.driver);
4255 if (drv->pre_reset && drv->post_reset)
4256 unbind = (drv->pre_reset)(cintf);
4257 else if (cintf->condition ==
4258 USB_INTERFACE_BOUND)
4261 usb_forced_unbind_intf(cintf);
4266 ret = usb_reset_and_verify_device(udev);
4269 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4270 struct usb_interface *cintf = config->interface[i];
4271 struct usb_driver *drv;
4272 int rebind = cintf->needs_binding;
4274 if (!rebind && cintf->dev.driver) {
4275 drv = to_usb_driver(cintf->dev.driver);
4276 if (drv->post_reset)
4277 rebind = (drv->post_reset)(cintf);
4278 else if (cintf->condition ==
4279 USB_INTERFACE_BOUND)
4282 if (ret == 0 && rebind)
4283 usb_rebind_intf(cintf);
4287 usb_autosuspend_device(udev);
4290 EXPORT_SYMBOL_GPL(usb_reset_device);
4294 * usb_queue_reset_device - Reset a USB device from an atomic context
4295 * @iface: USB interface belonging to the device to reset
4297 * This function can be used to reset a USB device from an atomic
4298 * context, where usb_reset_device() won't work (as it blocks).
4300 * Doing a reset via this method is functionally equivalent to calling
4301 * usb_reset_device(), except for the fact that it is delayed to a
4302 * workqueue. This means that any drivers bound to other interfaces
4303 * might be unbound, as well as users from usbfs in user space.
4307 * - Scheduling two resets at the same time from two different drivers
4308 * attached to two different interfaces of the same device is
4309 * possible; depending on how the driver attached to each interface
4310 * handles ->pre_reset(), the second reset might happen or not.
4312 * - If a driver is unbound and it had a pending reset, the reset will
4315 * - This function can be called during .probe() or .disconnect()
4316 * times. On return from .disconnect(), any pending resets will be
4319 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4322 * NOTE: We don't do any reference count tracking because it is not
4323 * needed. The lifecycle of the work_struct is tied to the
4324 * usb_interface. Before destroying the interface we cancel the
4325 * work_struct, so the fact that work_struct is queued and or
4326 * running means the interface (and thus, the device) exist and
4329 void usb_queue_reset_device(struct usb_interface *iface)
4331 schedule_work(&iface->reset_ws);
4333 EXPORT_SYMBOL_GPL(usb_queue_reset_device);