4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/usb/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct usb_device *child;
46 struct device *intfdev; /* the "interface" device */
47 struct usb_device *hdev;
49 struct urb *urb; /* for interrupt polling pipe */
51 /* buffer for urb ... with extra space in case of babble */
54 struct usb_hub_status hub;
55 struct usb_port_status port;
56 } *status; /* buffer for status reports */
57 struct mutex status_mutex; /* for the status buffer */
59 int error; /* last reported error */
60 int nerrors; /* track consecutive errors */
62 struct list_head event_list; /* hubs w/data or errs ready */
63 unsigned long event_bits[1]; /* status change bitmask */
64 unsigned long change_bits[1]; /* ports with logical connect
66 unsigned long busy_bits[1]; /* ports being reset or
68 unsigned long removed_bits[1]; /* ports with a "removed"
70 unsigned long wakeup_bits[1]; /* ports that have signaled
72 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
73 #error event_bits[] is too short!
76 struct usb_hub_descriptor *descriptor; /* class descriptor */
77 struct usb_tt tt; /* Transaction Translator */
79 unsigned mA_per_port; /* current for each child */
81 unsigned limited_power:1;
83 unsigned disconnected:1;
85 unsigned has_indicators:1;
86 u8 indicator[USB_MAXCHILDREN];
87 struct delayed_work leds;
88 struct delayed_work init_work;
89 struct usb_hub_port *port_data;
92 static inline int hub_is_superspeed(struct usb_device *hdev)
94 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
97 /* Protect struct usb_device->state and struct usb_hub_port->child members
98 * Note: Both are also protected by ->dev.sem, except that ->state can
99 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
100 static DEFINE_SPINLOCK(device_state_lock);
102 /* khubd's worklist and its lock */
103 static DEFINE_SPINLOCK(hub_event_lock);
104 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
107 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
109 static struct task_struct *khubd_task;
111 /* cycle leds on hubs that aren't blinking for attention */
112 static bool blinkenlights = 0;
113 module_param (blinkenlights, bool, S_IRUGO);
114 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
117 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
118 * 10 seconds to send reply for the initial 64-byte descriptor request.
120 /* define initial 64-byte descriptor request timeout in milliseconds */
121 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
122 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
123 MODULE_PARM_DESC(initial_descriptor_timeout,
124 "initial 64-byte descriptor request timeout in milliseconds "
125 "(default 5000 - 5.0 seconds)");
128 * As of 2.6.10 we introduce a new USB device initialization scheme which
129 * closely resembles the way Windows works. Hopefully it will be compatible
130 * with a wider range of devices than the old scheme. However some previously
131 * working devices may start giving rise to "device not accepting address"
132 * errors; if that happens the user can try the old scheme by adjusting the
133 * following module parameters.
135 * For maximum flexibility there are two boolean parameters to control the
136 * hub driver's behavior. On the first initialization attempt, if the
137 * "old_scheme_first" parameter is set then the old scheme will be used,
138 * otherwise the new scheme is used. If that fails and "use_both_schemes"
139 * is set, then the driver will make another attempt, using the other scheme.
141 static bool old_scheme_first = 0;
142 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
143 MODULE_PARM_DESC(old_scheme_first,
144 "start with the old device initialization scheme");
146 static bool use_both_schemes = 1;
147 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
148 MODULE_PARM_DESC(use_both_schemes,
149 "try the other device initialization scheme if the "
152 /* Mutual exclusion for EHCI CF initialization. This interferes with
153 * port reset on some companion controllers.
155 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
156 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
158 #define HUB_DEBOUNCE_TIMEOUT 1500
159 #define HUB_DEBOUNCE_STEP 25
160 #define HUB_DEBOUNCE_STABLE 100
163 static int usb_reset_and_verify_device(struct usb_device *udev);
165 static inline char *portspeed(struct usb_hub *hub, int portstatus)
167 if (hub_is_superspeed(hub->hdev))
169 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
171 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
177 /* Note that hdev or one of its children must be locked! */
178 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
180 if (!hdev || !hdev->actconfig || !hdev->maxchild)
182 return usb_get_intfdata(hdev->actconfig->interface[0]);
185 /* USB 2.0 spec Section 11.24.4.5 */
186 static int get_hub_descriptor(struct usb_device *hdev, void *data)
191 if (hub_is_superspeed(hdev)) {
192 dtype = USB_DT_SS_HUB;
193 size = USB_DT_SS_HUB_SIZE;
196 size = sizeof(struct usb_hub_descriptor);
199 for (i = 0; i < 3; i++) {
200 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
201 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
202 dtype << 8, 0, data, size,
203 USB_CTRL_GET_TIMEOUT);
204 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
211 * USB 2.0 spec Section 11.24.2.1
213 static int clear_hub_feature(struct usb_device *hdev, int feature)
215 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
216 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
220 * USB 2.0 spec Section 11.24.2.2
222 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
224 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
225 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
230 * USB 2.0 spec Section 11.24.2.13
232 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
234 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
235 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
240 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
241 * for info about using port indicators
243 static void set_port_led(
249 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
250 USB_PORT_FEAT_INDICATOR);
252 dev_dbg (hub->intfdev,
253 "port %d indicator %s status %d\n",
255 ({ char *s; switch (selector) {
256 case HUB_LED_AMBER: s = "amber"; break;
257 case HUB_LED_GREEN: s = "green"; break;
258 case HUB_LED_OFF: s = "off"; break;
259 case HUB_LED_AUTO: s = "auto"; break;
260 default: s = "??"; break;
265 #define LED_CYCLE_PERIOD ((2*HZ)/3)
267 static void led_work (struct work_struct *work)
269 struct usb_hub *hub =
270 container_of(work, struct usb_hub, leds.work);
271 struct usb_device *hdev = hub->hdev;
273 unsigned changed = 0;
276 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
279 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
280 unsigned selector, mode;
282 /* 30%-50% duty cycle */
284 switch (hub->indicator[i]) {
286 case INDICATOR_CYCLE:
288 selector = HUB_LED_AUTO;
289 mode = INDICATOR_AUTO;
291 /* blinking green = sw attention */
292 case INDICATOR_GREEN_BLINK:
293 selector = HUB_LED_GREEN;
294 mode = INDICATOR_GREEN_BLINK_OFF;
296 case INDICATOR_GREEN_BLINK_OFF:
297 selector = HUB_LED_OFF;
298 mode = INDICATOR_GREEN_BLINK;
300 /* blinking amber = hw attention */
301 case INDICATOR_AMBER_BLINK:
302 selector = HUB_LED_AMBER;
303 mode = INDICATOR_AMBER_BLINK_OFF;
305 case INDICATOR_AMBER_BLINK_OFF:
306 selector = HUB_LED_OFF;
307 mode = INDICATOR_AMBER_BLINK;
309 /* blink green/amber = reserved */
310 case INDICATOR_ALT_BLINK:
311 selector = HUB_LED_GREEN;
312 mode = INDICATOR_ALT_BLINK_OFF;
314 case INDICATOR_ALT_BLINK_OFF:
315 selector = HUB_LED_AMBER;
316 mode = INDICATOR_ALT_BLINK;
321 if (selector != HUB_LED_AUTO)
323 set_port_led(hub, i + 1, selector);
324 hub->indicator[i] = mode;
326 if (!changed && blinkenlights) {
328 cursor %= hub->descriptor->bNbrPorts;
329 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
330 hub->indicator[cursor] = INDICATOR_CYCLE;
334 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
337 /* use a short timeout for hub/port status fetches */
338 #define USB_STS_TIMEOUT 1000
339 #define USB_STS_RETRIES 5
342 * USB 2.0 spec Section 11.24.2.6
344 static int get_hub_status(struct usb_device *hdev,
345 struct usb_hub_status *data)
347 int i, status = -ETIMEDOUT;
349 for (i = 0; i < USB_STS_RETRIES &&
350 (status == -ETIMEDOUT || status == -EPIPE); i++) {
351 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
352 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
353 data, sizeof(*data), USB_STS_TIMEOUT);
359 * USB 2.0 spec Section 11.24.2.7
361 static int get_port_status(struct usb_device *hdev, int port1,
362 struct usb_port_status *data)
364 int i, status = -ETIMEDOUT;
366 for (i = 0; i < USB_STS_RETRIES &&
367 (status == -ETIMEDOUT || status == -EPIPE); i++) {
368 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
369 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
370 data, sizeof(*data), USB_STS_TIMEOUT);
375 static int hub_port_status(struct usb_hub *hub, int port1,
376 u16 *status, u16 *change)
380 mutex_lock(&hub->status_mutex);
381 ret = get_port_status(hub->hdev, port1, &hub->status->port);
383 dev_err(hub->intfdev,
384 "%s failed (err = %d)\n", __func__, ret);
388 *status = le16_to_cpu(hub->status->port.wPortStatus);
389 *change = le16_to_cpu(hub->status->port.wPortChange);
393 mutex_unlock(&hub->status_mutex);
397 static void kick_khubd(struct usb_hub *hub)
401 spin_lock_irqsave(&hub_event_lock, flags);
402 if (!hub->disconnected && list_empty(&hub->event_list)) {
403 list_add_tail(&hub->event_list, &hub_event_list);
405 /* Suppress autosuspend until khubd runs */
406 usb_autopm_get_interface_no_resume(
407 to_usb_interface(hub->intfdev));
408 wake_up(&khubd_wait);
410 spin_unlock_irqrestore(&hub_event_lock, flags);
413 void usb_kick_khubd(struct usb_device *hdev)
415 struct usb_hub *hub = hdev_to_hub(hdev);
422 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
423 * Notification, which indicates it had initiated remote wakeup.
425 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
426 * device initiates resume, so the USB core will not receive notice of the
427 * resume through the normal hub interrupt URB.
429 void usb_wakeup_notification(struct usb_device *hdev,
430 unsigned int portnum)
437 hub = hdev_to_hub(hdev);
439 set_bit(portnum, hub->wakeup_bits);
443 EXPORT_SYMBOL_GPL(usb_wakeup_notification);
445 /* completion function, fires on port status changes and various faults */
446 static void hub_irq(struct urb *urb)
448 struct usb_hub *hub = urb->context;
449 int status = urb->status;
454 case -ENOENT: /* synchronous unlink */
455 case -ECONNRESET: /* async unlink */
456 case -ESHUTDOWN: /* hardware going away */
459 default: /* presumably an error */
460 /* Cause a hub reset after 10 consecutive errors */
461 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
462 if ((++hub->nerrors < 10) || hub->error)
467 /* let khubd handle things */
468 case 0: /* we got data: port status changed */
470 for (i = 0; i < urb->actual_length; ++i)
471 bits |= ((unsigned long) ((*hub->buffer)[i]))
473 hub->event_bits[0] = bits;
479 /* Something happened, let khubd figure it out */
486 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
487 && status != -ENODEV && status != -EPERM)
488 dev_err (hub->intfdev, "resubmit --> %d\n", status);
491 /* USB 2.0 spec Section 11.24.2.3 */
493 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
495 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
496 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
501 * enumeration blocks khubd for a long time. we use keventd instead, since
502 * long blocking there is the exception, not the rule. accordingly, HCDs
503 * talking to TTs must queue control transfers (not just bulk and iso), so
504 * both can talk to the same hub concurrently.
506 static void hub_tt_work(struct work_struct *work)
508 struct usb_hub *hub =
509 container_of(work, struct usb_hub, tt.clear_work);
513 spin_lock_irqsave (&hub->tt.lock, flags);
514 while (--limit && !list_empty (&hub->tt.clear_list)) {
515 struct list_head *next;
516 struct usb_tt_clear *clear;
517 struct usb_device *hdev = hub->hdev;
518 const struct hc_driver *drv;
521 next = hub->tt.clear_list.next;
522 clear = list_entry (next, struct usb_tt_clear, clear_list);
523 list_del (&clear->clear_list);
525 /* drop lock so HCD can concurrently report other TT errors */
526 spin_unlock_irqrestore (&hub->tt.lock, flags);
527 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
530 "clear tt %d (%04x) error %d\n",
531 clear->tt, clear->devinfo, status);
533 /* Tell the HCD, even if the operation failed */
534 drv = clear->hcd->driver;
535 if (drv->clear_tt_buffer_complete)
536 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
539 spin_lock_irqsave(&hub->tt.lock, flags);
541 spin_unlock_irqrestore (&hub->tt.lock, flags);
545 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
546 * @urb: an URB associated with the failed or incomplete split transaction
548 * High speed HCDs use this to tell the hub driver that some split control or
549 * bulk transaction failed in a way that requires clearing internal state of
550 * a transaction translator. This is normally detected (and reported) from
553 * It may not be possible for that hub to handle additional full (or low)
554 * speed transactions until that state is fully cleared out.
556 int usb_hub_clear_tt_buffer(struct urb *urb)
558 struct usb_device *udev = urb->dev;
559 int pipe = urb->pipe;
560 struct usb_tt *tt = udev->tt;
562 struct usb_tt_clear *clear;
564 /* we've got to cope with an arbitrary number of pending TT clears,
565 * since each TT has "at least two" buffers that can need it (and
566 * there can be many TTs per hub). even if they're uncommon.
568 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
569 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
570 /* FIXME recover somehow ... RESET_TT? */
574 /* info that CLEAR_TT_BUFFER needs */
575 clear->tt = tt->multi ? udev->ttport : 1;
576 clear->devinfo = usb_pipeendpoint (pipe);
577 clear->devinfo |= udev->devnum << 4;
578 clear->devinfo |= usb_pipecontrol (pipe)
579 ? (USB_ENDPOINT_XFER_CONTROL << 11)
580 : (USB_ENDPOINT_XFER_BULK << 11);
581 if (usb_pipein (pipe))
582 clear->devinfo |= 1 << 15;
584 /* info for completion callback */
585 clear->hcd = bus_to_hcd(udev->bus);
588 /* tell keventd to clear state for this TT */
589 spin_lock_irqsave (&tt->lock, flags);
590 list_add_tail (&clear->clear_list, &tt->clear_list);
591 schedule_work(&tt->clear_work);
592 spin_unlock_irqrestore (&tt->lock, flags);
595 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
597 /* If do_delay is false, return the number of milliseconds the caller
600 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
603 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
605 u16 wHubCharacteristics =
606 le16_to_cpu(hub->descriptor->wHubCharacteristics);
608 /* Enable power on each port. Some hubs have reserved values
609 * of LPSM (> 2) in their descriptors, even though they are
610 * USB 2.0 hubs. Some hubs do not implement port-power switching
611 * but only emulate it. In all cases, the ports won't work
612 * unless we send these messages to the hub.
614 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
615 dev_dbg(hub->intfdev, "enabling power on all ports\n");
617 dev_dbg(hub->intfdev, "trying to enable port power on "
618 "non-switchable hub\n");
619 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
620 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
622 /* Wait at least 100 msec for power to become stable */
623 delay = max(pgood_delay, (unsigned) 100);
629 static int hub_hub_status(struct usb_hub *hub,
630 u16 *status, u16 *change)
634 mutex_lock(&hub->status_mutex);
635 ret = get_hub_status(hub->hdev, &hub->status->hub);
637 dev_err (hub->intfdev,
638 "%s failed (err = %d)\n", __func__, ret);
640 *status = le16_to_cpu(hub->status->hub.wHubStatus);
641 *change = le16_to_cpu(hub->status->hub.wHubChange);
644 mutex_unlock(&hub->status_mutex);
648 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
650 struct usb_device *hdev = hub->hdev;
653 if (hub->port_data[port1-1].child && set_state)
654 usb_set_device_state(hub->port_data[port1-1].child,
655 USB_STATE_NOTATTACHED);
656 if (!hub->error && !hub_is_superspeed(hub->hdev))
657 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
659 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
665 * Disable a port and mark a logical connect-change event, so that some
666 * time later khubd will disconnect() any existing usb_device on the port
667 * and will re-enumerate if there actually is a device attached.
669 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
671 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
672 hub_port_disable(hub, port1, 1);
674 /* FIXME let caller ask to power down the port:
675 * - some devices won't enumerate without a VBUS power cycle
676 * - SRP saves power that way
677 * - ... new call, TBD ...
678 * That's easy if this hub can switch power per-port, and
679 * khubd reactivates the port later (timer, SRP, etc).
680 * Powerdown must be optional, because of reset/DFU.
683 set_bit(port1, hub->change_bits);
688 * usb_remove_device - disable a device's port on its parent hub
689 * @udev: device to be disabled and removed
690 * Context: @udev locked, must be able to sleep.
692 * After @udev's port has been disabled, khubd is notified and it will
693 * see that the device has been disconnected. When the device is
694 * physically unplugged and something is plugged in, the events will
695 * be received and processed normally.
697 int usb_remove_device(struct usb_device *udev)
700 struct usb_interface *intf;
702 if (!udev->parent) /* Can't remove a root hub */
704 hub = hdev_to_hub(udev->parent);
705 intf = to_usb_interface(hub->intfdev);
707 usb_autopm_get_interface(intf);
708 set_bit(udev->portnum, hub->removed_bits);
709 hub_port_logical_disconnect(hub, udev->portnum);
710 usb_autopm_put_interface(intf);
714 enum hub_activation_type {
715 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
716 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
719 static void hub_init_func2(struct work_struct *ws);
720 static void hub_init_func3(struct work_struct *ws);
722 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
724 struct usb_device *hdev = hub->hdev;
729 bool need_debounce_delay = false;
732 /* Continue a partial initialization */
733 if (type == HUB_INIT2)
735 if (type == HUB_INIT3)
738 /* The superspeed hub except for root hub has to use Hub Depth
739 * value as an offset into the route string to locate the bits
740 * it uses to determine the downstream port number. So hub driver
741 * should send a set hub depth request to superspeed hub after
742 * the superspeed hub is set configuration in initialization or
745 * After a resume, port power should still be on.
746 * For any other type of activation, turn it on.
748 if (type != HUB_RESUME) {
749 if (hdev->parent && hub_is_superspeed(hdev)) {
750 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
751 HUB_SET_DEPTH, USB_RT_HUB,
752 hdev->level - 1, 0, NULL, 0,
753 USB_CTRL_SET_TIMEOUT);
755 dev_err(hub->intfdev,
756 "set hub depth failed\n");
759 /* Speed up system boot by using a delayed_work for the
760 * hub's initial power-up delays. This is pretty awkward
761 * and the implementation looks like a home-brewed sort of
762 * setjmp/longjmp, but it saves at least 100 ms for each
763 * root hub (assuming usbcore is compiled into the kernel
764 * rather than as a module). It adds up.
766 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
767 * because for those activation types the ports have to be
768 * operational when we return. In theory this could be done
769 * for HUB_POST_RESET, but it's easier not to.
771 if (type == HUB_INIT) {
772 delay = hub_power_on(hub, false);
773 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
774 schedule_delayed_work(&hub->init_work,
775 msecs_to_jiffies(delay));
777 /* Suppress autosuspend until init is done */
778 usb_autopm_get_interface_no_resume(
779 to_usb_interface(hub->intfdev));
780 return; /* Continues at init2: below */
781 } else if (type == HUB_RESET_RESUME) {
782 /* The internal host controller state for the hub device
783 * may be gone after a host power loss on system resume.
784 * Update the device's info so the HW knows it's a hub.
786 hcd = bus_to_hcd(hdev->bus);
787 if (hcd->driver->update_hub_device) {
788 ret = hcd->driver->update_hub_device(hcd, hdev,
791 dev_err(hub->intfdev, "Host not "
792 "accepting hub info "
794 dev_err(hub->intfdev, "LS/FS devices "
795 "and hubs may not work "
796 "under this hub\n.");
799 hub_power_on(hub, true);
801 hub_power_on(hub, true);
806 /* Check each port and set hub->change_bits to let khubd know
807 * which ports need attention.
809 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
810 struct usb_device *udev = hub->port_data[port1-1].child;
811 u16 portstatus, portchange;
813 portstatus = portchange = 0;
814 status = hub_port_status(hub, port1, &portstatus, &portchange);
815 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
816 dev_dbg(hub->intfdev,
817 "port %d: status %04x change %04x\n",
818 port1, portstatus, portchange);
820 /* After anything other than HUB_RESUME (i.e., initialization
821 * or any sort of reset), every port should be disabled.
822 * Unconnected ports should likewise be disabled (paranoia),
823 * and so should ports for which we have no usb_device.
825 if ((portstatus & USB_PORT_STAT_ENABLE) && (
826 type != HUB_RESUME ||
827 !(portstatus & USB_PORT_STAT_CONNECTION) ||
829 udev->state == USB_STATE_NOTATTACHED)) {
831 * USB3 protocol ports will automatically transition
832 * to Enabled state when detect an USB3.0 device attach.
833 * Do not disable USB3 protocol ports.
835 if (!hub_is_superspeed(hdev)) {
836 clear_port_feature(hdev, port1,
837 USB_PORT_FEAT_ENABLE);
838 portstatus &= ~USB_PORT_STAT_ENABLE;
840 /* Pretend that power was lost for USB3 devs */
841 portstatus &= ~USB_PORT_STAT_ENABLE;
845 /* Clear status-change flags; we'll debounce later */
846 if (portchange & USB_PORT_STAT_C_CONNECTION) {
847 need_debounce_delay = true;
848 clear_port_feature(hub->hdev, port1,
849 USB_PORT_FEAT_C_CONNECTION);
851 if (portchange & USB_PORT_STAT_C_ENABLE) {
852 need_debounce_delay = true;
853 clear_port_feature(hub->hdev, port1,
854 USB_PORT_FEAT_C_ENABLE);
856 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
857 hub_is_superspeed(hub->hdev)) {
858 need_debounce_delay = true;
859 clear_port_feature(hub->hdev, port1,
860 USB_PORT_FEAT_C_BH_PORT_RESET);
862 /* We can forget about a "removed" device when there's a
863 * physical disconnect or the connect status changes.
865 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
866 (portchange & USB_PORT_STAT_C_CONNECTION))
867 clear_bit(port1, hub->removed_bits);
869 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
870 /* Tell khubd to disconnect the device or
871 * check for a new connection
873 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
874 set_bit(port1, hub->change_bits);
876 } else if (portstatus & USB_PORT_STAT_ENABLE) {
877 bool port_resumed = (portstatus &
878 USB_PORT_STAT_LINK_STATE) ==
880 /* The power session apparently survived the resume.
881 * If there was an overcurrent or suspend change
882 * (i.e., remote wakeup request), have khubd
883 * take care of it. Look at the port link state
884 * for USB 3.0 hubs, since they don't have a suspend
885 * change bit, and they don't set the port link change
886 * bit on device-initiated resume.
888 if (portchange || (hub_is_superspeed(hub->hdev) &&
890 set_bit(port1, hub->change_bits);
892 } else if (udev->persist_enabled) {
894 udev->reset_resume = 1;
896 set_bit(port1, hub->change_bits);
899 /* The power session is gone; tell khubd */
900 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
901 set_bit(port1, hub->change_bits);
905 /* If no port-status-change flags were set, we don't need any
906 * debouncing. If flags were set we can try to debounce the
907 * ports all at once right now, instead of letting khubd do them
908 * one at a time later on.
910 * If any port-status changes do occur during this delay, khubd
911 * will see them later and handle them normally.
913 if (need_debounce_delay) {
914 delay = HUB_DEBOUNCE_STABLE;
916 /* Don't do a long sleep inside a workqueue routine */
917 if (type == HUB_INIT2) {
918 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
919 schedule_delayed_work(&hub->init_work,
920 msecs_to_jiffies(delay));
921 return; /* Continues at init3: below */
929 status = usb_submit_urb(hub->urb, GFP_NOIO);
931 dev_err(hub->intfdev, "activate --> %d\n", status);
932 if (hub->has_indicators && blinkenlights)
933 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
935 /* Scan all ports that need attention */
938 /* Allow autosuspend if it was suppressed */
939 if (type <= HUB_INIT3)
940 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
943 /* Implement the continuations for the delays above */
944 static void hub_init_func2(struct work_struct *ws)
946 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
948 hub_activate(hub, HUB_INIT2);
951 static void hub_init_func3(struct work_struct *ws)
953 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
955 hub_activate(hub, HUB_INIT3);
958 enum hub_quiescing_type {
959 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
962 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
964 struct usb_device *hdev = hub->hdev;
967 cancel_delayed_work_sync(&hub->init_work);
969 /* khubd and related activity won't re-trigger */
972 if (type != HUB_SUSPEND) {
973 /* Disconnect all the children */
974 for (i = 0; i < hdev->maxchild; ++i) {
975 if (hub->port_data[i].child)
976 usb_disconnect(&hub->port_data[i].child);
980 /* Stop khubd and related activity */
981 usb_kill_urb(hub->urb);
982 if (hub->has_indicators)
983 cancel_delayed_work_sync(&hub->leds);
985 cancel_work_sync(&hub->tt.clear_work);
988 /* caller has locked the hub device */
989 static int hub_pre_reset(struct usb_interface *intf)
991 struct usb_hub *hub = usb_get_intfdata(intf);
993 hub_quiesce(hub, HUB_PRE_RESET);
997 /* caller has locked the hub device */
998 static int hub_post_reset(struct usb_interface *intf)
1000 struct usb_hub *hub = usb_get_intfdata(intf);
1002 hub_activate(hub, HUB_POST_RESET);
1006 static int hub_configure(struct usb_hub *hub,
1007 struct usb_endpoint_descriptor *endpoint)
1009 struct usb_hcd *hcd;
1010 struct usb_device *hdev = hub->hdev;
1011 struct device *hub_dev = hub->intfdev;
1012 u16 hubstatus, hubchange;
1013 u16 wHubCharacteristics;
1016 char *message = "out of memory";
1018 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1024 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1029 mutex_init(&hub->status_mutex);
1031 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1032 if (!hub->descriptor) {
1037 /* Request the entire hub descriptor.
1038 * hub->descriptor can handle USB_MAXCHILDREN ports,
1039 * but the hub can/will return fewer bytes here.
1041 ret = get_hub_descriptor(hdev, hub->descriptor);
1043 message = "can't read hub descriptor";
1045 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1046 message = "hub has too many ports!";
1051 hdev->maxchild = hub->descriptor->bNbrPorts;
1052 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1053 (hdev->maxchild == 1) ? "" : "s");
1055 hub->port_data = kzalloc(hdev->maxchild * sizeof(struct usb_hub_port),
1057 if (!hub->port_data) {
1062 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1064 /* FIXME for USB 3.0, skip for now */
1065 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1066 !(hub_is_superspeed(hdev))) {
1068 char portstr [USB_MAXCHILDREN + 1];
1070 for (i = 0; i < hdev->maxchild; i++)
1071 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1072 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1074 portstr[hdev->maxchild] = 0;
1075 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1077 dev_dbg(hub_dev, "standalone hub\n");
1079 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1080 case HUB_CHAR_COMMON_LPSM:
1081 dev_dbg(hub_dev, "ganged power switching\n");
1083 case HUB_CHAR_INDV_PORT_LPSM:
1084 dev_dbg(hub_dev, "individual port power switching\n");
1086 case HUB_CHAR_NO_LPSM:
1088 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1092 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1093 case HUB_CHAR_COMMON_OCPM:
1094 dev_dbg(hub_dev, "global over-current protection\n");
1096 case HUB_CHAR_INDV_PORT_OCPM:
1097 dev_dbg(hub_dev, "individual port over-current protection\n");
1099 case HUB_CHAR_NO_OCPM:
1101 dev_dbg(hub_dev, "no over-current protection\n");
1105 spin_lock_init (&hub->tt.lock);
1106 INIT_LIST_HEAD (&hub->tt.clear_list);
1107 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1108 switch (hdev->descriptor.bDeviceProtocol) {
1111 case USB_HUB_PR_HS_SINGLE_TT:
1112 dev_dbg(hub_dev, "Single TT\n");
1115 case USB_HUB_PR_HS_MULTI_TT:
1116 ret = usb_set_interface(hdev, 0, 1);
1118 dev_dbg(hub_dev, "TT per port\n");
1121 dev_err(hub_dev, "Using single TT (err %d)\n",
1126 /* USB 3.0 hubs don't have a TT */
1129 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1130 hdev->descriptor.bDeviceProtocol);
1134 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1135 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1136 case HUB_TTTT_8_BITS:
1137 if (hdev->descriptor.bDeviceProtocol != 0) {
1138 hub->tt.think_time = 666;
1139 dev_dbg(hub_dev, "TT requires at most %d "
1140 "FS bit times (%d ns)\n",
1141 8, hub->tt.think_time);
1144 case HUB_TTTT_16_BITS:
1145 hub->tt.think_time = 666 * 2;
1146 dev_dbg(hub_dev, "TT requires at most %d "
1147 "FS bit times (%d ns)\n",
1148 16, hub->tt.think_time);
1150 case HUB_TTTT_24_BITS:
1151 hub->tt.think_time = 666 * 3;
1152 dev_dbg(hub_dev, "TT requires at most %d "
1153 "FS bit times (%d ns)\n",
1154 24, hub->tt.think_time);
1156 case HUB_TTTT_32_BITS:
1157 hub->tt.think_time = 666 * 4;
1158 dev_dbg(hub_dev, "TT requires at most %d "
1159 "FS bit times (%d ns)\n",
1160 32, hub->tt.think_time);
1164 /* probe() zeroes hub->indicator[] */
1165 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1166 hub->has_indicators = 1;
1167 dev_dbg(hub_dev, "Port indicators are supported\n");
1170 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1171 hub->descriptor->bPwrOn2PwrGood * 2);
1173 /* power budgeting mostly matters with bus-powered hubs,
1174 * and battery-powered root hubs (may provide just 8 mA).
1176 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1178 message = "can't get hub status";
1181 le16_to_cpus(&hubstatus);
1182 if (hdev == hdev->bus->root_hub) {
1183 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1184 hub->mA_per_port = 500;
1186 hub->mA_per_port = hdev->bus_mA;
1187 hub->limited_power = 1;
1189 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1190 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1191 hub->descriptor->bHubContrCurrent);
1192 hub->limited_power = 1;
1193 if (hdev->maxchild > 0) {
1194 int remaining = hdev->bus_mA -
1195 hub->descriptor->bHubContrCurrent;
1197 if (remaining < hdev->maxchild * 100)
1199 "insufficient power available "
1200 "to use all downstream ports\n");
1201 hub->mA_per_port = 100; /* 7.2.1.1 */
1203 } else { /* Self-powered external hub */
1204 /* FIXME: What about battery-powered external hubs that
1205 * provide less current per port? */
1206 hub->mA_per_port = 500;
1208 if (hub->mA_per_port < 500)
1209 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1212 /* Update the HCD's internal representation of this hub before khubd
1213 * starts getting port status changes for devices under the hub.
1215 hcd = bus_to_hcd(hdev->bus);
1216 if (hcd->driver->update_hub_device) {
1217 ret = hcd->driver->update_hub_device(hcd, hdev,
1218 &hub->tt, GFP_KERNEL);
1220 message = "can't update HCD hub info";
1225 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1227 message = "can't get hub status";
1231 /* local power status reports aren't always correct */
1232 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1233 dev_dbg(hub_dev, "local power source is %s\n",
1234 (hubstatus & HUB_STATUS_LOCAL_POWER)
1235 ? "lost (inactive)" : "good");
1237 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1238 dev_dbg(hub_dev, "%sover-current condition exists\n",
1239 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1241 /* set up the interrupt endpoint
1242 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1243 * bytes as USB2.0[11.12.3] says because some hubs are known
1244 * to send more data (and thus cause overflow). For root hubs,
1245 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1246 * to be big enough for at least USB_MAXCHILDREN ports. */
1247 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1248 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1250 if (maxp > sizeof(*hub->buffer))
1251 maxp = sizeof(*hub->buffer);
1253 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1259 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1260 hub, endpoint->bInterval);
1262 /* maybe cycle the hub leds */
1263 if (hub->has_indicators && blinkenlights)
1264 hub->indicator [0] = INDICATOR_CYCLE;
1266 hub_activate(hub, HUB_INIT);
1270 dev_err (hub_dev, "config failed, %s (err %d)\n",
1272 /* hub_disconnect() frees urb and descriptor */
1276 static void hub_release(struct kref *kref)
1278 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1280 usb_put_intf(to_usb_interface(hub->intfdev));
1284 static unsigned highspeed_hubs;
1286 static void hub_disconnect(struct usb_interface *intf)
1288 struct usb_hub *hub = usb_get_intfdata(intf);
1290 /* Take the hub off the event list and don't let it be added again */
1291 spin_lock_irq(&hub_event_lock);
1292 if (!list_empty(&hub->event_list)) {
1293 list_del_init(&hub->event_list);
1294 usb_autopm_put_interface_no_suspend(intf);
1296 hub->disconnected = 1;
1297 spin_unlock_irq(&hub_event_lock);
1299 /* Disconnect all children and quiesce the hub */
1301 hub_quiesce(hub, HUB_DISCONNECT);
1303 usb_set_intfdata (intf, NULL);
1304 hub->hdev->maxchild = 0;
1306 if (hub->hdev->speed == USB_SPEED_HIGH)
1309 usb_free_urb(hub->urb);
1310 kfree(hub->port_data);
1311 kfree(hub->descriptor);
1315 kref_put(&hub->kref, hub_release);
1318 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1320 struct usb_host_interface *desc;
1321 struct usb_endpoint_descriptor *endpoint;
1322 struct usb_device *hdev;
1323 struct usb_hub *hub;
1325 desc = intf->cur_altsetting;
1326 hdev = interface_to_usbdev(intf);
1328 /* Hubs have proper suspend/resume support. */
1329 usb_enable_autosuspend(hdev);
1331 if (hdev->level == MAX_TOPO_LEVEL) {
1333 "Unsupported bus topology: hub nested too deep\n");
1337 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1339 dev_warn(&intf->dev, "ignoring external hub\n");
1344 /* Some hubs have a subclass of 1, which AFAICT according to the */
1345 /* specs is not defined, but it works */
1346 if ((desc->desc.bInterfaceSubClass != 0) &&
1347 (desc->desc.bInterfaceSubClass != 1)) {
1349 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1353 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1354 if (desc->desc.bNumEndpoints != 1)
1355 goto descriptor_error;
1357 endpoint = &desc->endpoint[0].desc;
1359 /* If it's not an interrupt in endpoint, we'd better punt! */
1360 if (!usb_endpoint_is_int_in(endpoint))
1361 goto descriptor_error;
1363 /* We found a hub */
1364 dev_info (&intf->dev, "USB hub found\n");
1366 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1368 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1372 kref_init(&hub->kref);
1373 INIT_LIST_HEAD(&hub->event_list);
1374 hub->intfdev = &intf->dev;
1376 INIT_DELAYED_WORK(&hub->leds, led_work);
1377 INIT_DELAYED_WORK(&hub->init_work, NULL);
1380 usb_set_intfdata (intf, hub);
1381 intf->needs_remote_wakeup = 1;
1383 if (hdev->speed == USB_SPEED_HIGH)
1386 if (hub_configure(hub, endpoint) >= 0)
1389 hub_disconnect (intf);
1394 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1396 struct usb_device *hdev = interface_to_usbdev (intf);
1397 struct usb_hub *hub = usb_get_intfdata(intf);
1399 /* assert ifno == 0 (part of hub spec) */
1401 case USBDEVFS_HUB_PORTINFO: {
1402 struct usbdevfs_hub_portinfo *info = user_data;
1405 spin_lock_irq(&device_state_lock);
1406 if (hdev->devnum <= 0)
1409 info->nports = hdev->maxchild;
1410 for (i = 0; i < info->nports; i++) {
1411 if (hub->port_data[i].child == NULL)
1415 hub->port_data[i].child->devnum;
1418 spin_unlock_irq(&device_state_lock);
1420 return info->nports + 1;
1429 * Allow user programs to claim ports on a hub. When a device is attached
1430 * to one of these "claimed" ports, the program will "own" the device.
1432 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1435 if (hdev->state == USB_STATE_NOTATTACHED)
1437 if (port1 == 0 || port1 > hdev->maxchild)
1440 /* This assumes that devices not managed by the hub driver
1441 * will always have maxchild equal to 0.
1443 *ppowner = &(hdev_to_hub(hdev)->port_data[port1 - 1].port_owner);
1447 /* In the following three functions, the caller must hold hdev's lock */
1448 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1453 rc = find_port_owner(hdev, port1, &powner);
1462 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1467 rc = find_port_owner(hdev, port1, &powner);
1470 if (*powner != owner)
1476 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1478 struct usb_hub *hub = hdev_to_hub(hdev);
1481 for (n = 0; n < hdev->maxchild; n++) {
1482 if (hub->port_data[n].port_owner == owner)
1483 hub->port_data[n].port_owner = NULL;
1488 /* The caller must hold udev's lock */
1489 bool usb_device_is_owned(struct usb_device *udev)
1491 struct usb_hub *hub;
1493 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1495 hub = hdev_to_hub(udev->parent);
1496 return !!hub->port_data[udev->portnum - 1].port_owner;
1500 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1502 struct usb_hub *hub = hdev_to_hub(udev);
1505 for (i = 0; i < udev->maxchild; ++i) {
1506 if (hub->port_data[i].child)
1507 recursively_mark_NOTATTACHED(
1508 hub->port_data[i].child);
1510 if (udev->state == USB_STATE_SUSPENDED)
1511 udev->active_duration -= jiffies;
1512 udev->state = USB_STATE_NOTATTACHED;
1516 * usb_set_device_state - change a device's current state (usbcore, hcds)
1517 * @udev: pointer to device whose state should be changed
1518 * @new_state: new state value to be stored
1520 * udev->state is _not_ fully protected by the device lock. Although
1521 * most transitions are made only while holding the lock, the state can
1522 * can change to USB_STATE_NOTATTACHED at almost any time. This
1523 * is so that devices can be marked as disconnected as soon as possible,
1524 * without having to wait for any semaphores to be released. As a result,
1525 * all changes to any device's state must be protected by the
1526 * device_state_lock spinlock.
1528 * Once a device has been added to the device tree, all changes to its state
1529 * should be made using this routine. The state should _not_ be set directly.
1531 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1532 * Otherwise udev->state is set to new_state, and if new_state is
1533 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1534 * to USB_STATE_NOTATTACHED.
1536 void usb_set_device_state(struct usb_device *udev,
1537 enum usb_device_state new_state)
1539 unsigned long flags;
1542 spin_lock_irqsave(&device_state_lock, flags);
1543 if (udev->state == USB_STATE_NOTATTACHED)
1545 else if (new_state != USB_STATE_NOTATTACHED) {
1547 /* root hub wakeup capabilities are managed out-of-band
1548 * and may involve silicon errata ... ignore them here.
1551 if (udev->state == USB_STATE_SUSPENDED
1552 || new_state == USB_STATE_SUSPENDED)
1553 ; /* No change to wakeup settings */
1554 else if (new_state == USB_STATE_CONFIGURED)
1555 wakeup = udev->actconfig->desc.bmAttributes
1556 & USB_CONFIG_ATT_WAKEUP;
1560 if (udev->state == USB_STATE_SUSPENDED &&
1561 new_state != USB_STATE_SUSPENDED)
1562 udev->active_duration -= jiffies;
1563 else if (new_state == USB_STATE_SUSPENDED &&
1564 udev->state != USB_STATE_SUSPENDED)
1565 udev->active_duration += jiffies;
1566 udev->state = new_state;
1568 recursively_mark_NOTATTACHED(udev);
1569 spin_unlock_irqrestore(&device_state_lock, flags);
1571 device_set_wakeup_capable(&udev->dev, wakeup);
1573 EXPORT_SYMBOL_GPL(usb_set_device_state);
1576 * Choose a device number.
1578 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1579 * USB-2.0 buses they are also used as device addresses, however on
1580 * USB-3.0 buses the address is assigned by the controller hardware
1581 * and it usually is not the same as the device number.
1583 * WUSB devices are simple: they have no hubs behind, so the mapping
1584 * device <-> virtual port number becomes 1:1. Why? to simplify the
1585 * life of the device connection logic in
1586 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1587 * handshake we need to assign a temporary address in the unauthorized
1588 * space. For simplicity we use the first virtual port number found to
1589 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1590 * and that becomes it's address [X < 128] or its unauthorized address
1593 * We add 1 as an offset to the one-based USB-stack port number
1594 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1595 * 0 is reserved by USB for default address; (b) Linux's USB stack
1596 * uses always #1 for the root hub of the controller. So USB stack's
1597 * port #1, which is wusb virtual-port #0 has address #2.
1599 * Devices connected under xHCI are not as simple. The host controller
1600 * supports virtualization, so the hardware assigns device addresses and
1601 * the HCD must setup data structures before issuing a set address
1602 * command to the hardware.
1604 static void choose_devnum(struct usb_device *udev)
1607 struct usb_bus *bus = udev->bus;
1609 /* If khubd ever becomes multithreaded, this will need a lock */
1611 devnum = udev->portnum + 1;
1612 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1614 /* Try to allocate the next devnum beginning at
1615 * bus->devnum_next. */
1616 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1619 devnum = find_next_zero_bit(bus->devmap.devicemap,
1621 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1624 set_bit(devnum, bus->devmap.devicemap);
1625 udev->devnum = devnum;
1629 static void release_devnum(struct usb_device *udev)
1631 if (udev->devnum > 0) {
1632 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1637 static void update_devnum(struct usb_device *udev, int devnum)
1639 /* The address for a WUSB device is managed by wusbcore. */
1641 udev->devnum = devnum;
1644 static void hub_free_dev(struct usb_device *udev)
1646 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1648 /* Root hubs aren't real devices, so don't free HCD resources */
1649 if (hcd->driver->free_dev && udev->parent)
1650 hcd->driver->free_dev(hcd, udev);
1654 * usb_disconnect - disconnect a device (usbcore-internal)
1655 * @pdev: pointer to device being disconnected
1656 * Context: !in_interrupt ()
1658 * Something got disconnected. Get rid of it and all of its children.
1660 * If *pdev is a normal device then the parent hub must already be locked.
1661 * If *pdev is a root hub then this routine will acquire the
1662 * usb_bus_list_lock on behalf of the caller.
1664 * Only hub drivers (including virtual root hub drivers for host
1665 * controllers) should ever call this.
1667 * This call is synchronous, and may not be used in an interrupt context.
1669 void usb_disconnect(struct usb_device **pdev)
1671 struct usb_device *udev = *pdev;
1672 struct usb_hub *hub = hdev_to_hub(udev);
1675 /* mark the device as inactive, so any further urb submissions for
1676 * this device (and any of its children) will fail immediately.
1677 * this quiesces everything except pending urbs.
1679 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1680 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1683 usb_lock_device(udev);
1685 /* Free up all the children before we remove this device */
1686 for (i = 0; i < udev->maxchild; i++) {
1687 if (hub->port_data[i].child)
1688 usb_disconnect(&hub->port_data[i].child);
1691 /* deallocate hcd/hardware state ... nuking all pending urbs and
1692 * cleaning up all state associated with the current configuration
1693 * so that the hardware is now fully quiesced.
1695 dev_dbg (&udev->dev, "unregistering device\n");
1696 usb_disable_device(udev, 0);
1697 usb_hcd_synchronize_unlinks(udev);
1699 usb_remove_ep_devs(&udev->ep0);
1700 usb_unlock_device(udev);
1702 /* Unregister the device. The device driver is responsible
1703 * for de-configuring the device and invoking the remove-device
1704 * notifier chain (used by usbfs and possibly others).
1706 device_del(&udev->dev);
1708 /* Free the device number and delete the parent's children[]
1709 * (or root_hub) pointer.
1711 release_devnum(udev);
1713 /* Avoid races with recursively_mark_NOTATTACHED() */
1714 spin_lock_irq(&device_state_lock);
1716 spin_unlock_irq(&device_state_lock);
1720 put_device(&udev->dev);
1723 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1724 static void show_string(struct usb_device *udev, char *id, char *string)
1728 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1731 static void announce_device(struct usb_device *udev)
1733 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1734 le16_to_cpu(udev->descriptor.idVendor),
1735 le16_to_cpu(udev->descriptor.idProduct));
1736 dev_info(&udev->dev,
1737 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1738 udev->descriptor.iManufacturer,
1739 udev->descriptor.iProduct,
1740 udev->descriptor.iSerialNumber);
1741 show_string(udev, "Product", udev->product);
1742 show_string(udev, "Manufacturer", udev->manufacturer);
1743 show_string(udev, "SerialNumber", udev->serial);
1746 static inline void announce_device(struct usb_device *udev) { }
1749 #ifdef CONFIG_USB_OTG
1750 #include "otg_whitelist.h"
1754 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1755 * @udev: newly addressed device (in ADDRESS state)
1757 * Finish enumeration for On-The-Go devices
1759 static int usb_enumerate_device_otg(struct usb_device *udev)
1763 #ifdef CONFIG_USB_OTG
1765 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1766 * to wake us after we've powered off VBUS; and HNP, switching roles
1767 * "host" to "peripheral". The OTG descriptor helps figure this out.
1769 if (!udev->bus->is_b_host
1771 && udev->parent == udev->bus->root_hub) {
1772 struct usb_otg_descriptor *desc = NULL;
1773 struct usb_bus *bus = udev->bus;
1775 /* descriptor may appear anywhere in config */
1776 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1777 le16_to_cpu(udev->config[0].desc.wTotalLength),
1778 USB_DT_OTG, (void **) &desc) == 0) {
1779 if (desc->bmAttributes & USB_OTG_HNP) {
1780 unsigned port1 = udev->portnum;
1782 dev_info(&udev->dev,
1783 "Dual-Role OTG device on %sHNP port\n",
1784 (port1 == bus->otg_port)
1787 /* enable HNP before suspend, it's simpler */
1788 if (port1 == bus->otg_port)
1789 bus->b_hnp_enable = 1;
1790 err = usb_control_msg(udev,
1791 usb_sndctrlpipe(udev, 0),
1792 USB_REQ_SET_FEATURE, 0,
1794 ? USB_DEVICE_B_HNP_ENABLE
1795 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1796 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1798 /* OTG MESSAGE: report errors here,
1799 * customize to match your product.
1801 dev_info(&udev->dev,
1802 "can't set HNP mode: %d\n",
1804 bus->b_hnp_enable = 0;
1810 if (!is_targeted(udev)) {
1812 /* Maybe it can talk to us, though we can't talk to it.
1813 * (Includes HNP test device.)
1815 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1816 err = usb_port_suspend(udev, PMSG_SUSPEND);
1818 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1830 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1831 * @udev: newly addressed device (in ADDRESS state)
1833 * This is only called by usb_new_device() and usb_authorize_device()
1834 * and FIXME -- all comments that apply to them apply here wrt to
1837 * If the device is WUSB and not authorized, we don't attempt to read
1838 * the string descriptors, as they will be errored out by the device
1839 * until it has been authorized.
1841 static int usb_enumerate_device(struct usb_device *udev)
1845 if (udev->config == NULL) {
1846 err = usb_get_configuration(udev);
1848 dev_err(&udev->dev, "can't read configurations, error %d\n",
1853 if (udev->wusb == 1 && udev->authorized == 0) {
1854 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1855 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1856 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1859 /* read the standard strings and cache them if present */
1860 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1861 udev->manufacturer = usb_cache_string(udev,
1862 udev->descriptor.iManufacturer);
1863 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1865 err = usb_enumerate_device_otg(udev);
1870 static void set_usb_port_removable(struct usb_device *udev)
1872 struct usb_device *hdev = udev->parent;
1873 struct usb_hub *hub;
1874 u8 port = udev->portnum;
1875 u16 wHubCharacteristics;
1876 bool removable = true;
1881 hub = hdev_to_hub(udev->parent);
1883 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1885 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1888 if (hub_is_superspeed(hdev)) {
1889 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1892 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1897 udev->removable = USB_DEVICE_REMOVABLE;
1899 udev->removable = USB_DEVICE_FIXED;
1903 * usb_new_device - perform initial device setup (usbcore-internal)
1904 * @udev: newly addressed device (in ADDRESS state)
1906 * This is called with devices which have been detected but not fully
1907 * enumerated. The device descriptor is available, but not descriptors
1908 * for any device configuration. The caller must have locked either
1909 * the parent hub (if udev is a normal device) or else the
1910 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1911 * udev has already been installed, but udev is not yet visible through
1912 * sysfs or other filesystem code.
1914 * It will return if the device is configured properly or not. Zero if
1915 * the interface was registered with the driver core; else a negative
1918 * This call is synchronous, and may not be used in an interrupt context.
1920 * Only the hub driver or root-hub registrar should ever call this.
1922 int usb_new_device(struct usb_device *udev)
1927 /* Initialize non-root-hub device wakeup to disabled;
1928 * device (un)configuration controls wakeup capable
1929 * sysfs power/wakeup controls wakeup enabled/disabled
1931 device_init_wakeup(&udev->dev, 0);
1934 /* Tell the runtime-PM framework the device is active */
1935 pm_runtime_set_active(&udev->dev);
1936 pm_runtime_get_noresume(&udev->dev);
1937 pm_runtime_use_autosuspend(&udev->dev);
1938 pm_runtime_enable(&udev->dev);
1940 /* By default, forbid autosuspend for all devices. It will be
1941 * allowed for hubs during binding.
1943 usb_disable_autosuspend(udev);
1945 err = usb_enumerate_device(udev); /* Read descriptors */
1948 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1949 udev->devnum, udev->bus->busnum,
1950 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1951 /* export the usbdev device-node for libusb */
1952 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1953 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1955 /* Tell the world! */
1956 announce_device(udev);
1958 device_enable_async_suspend(&udev->dev);
1961 * check whether the hub marks this port as non-removable. Do it
1962 * now so that platform-specific data can override it in
1966 set_usb_port_removable(udev);
1968 /* Register the device. The device driver is responsible
1969 * for configuring the device and invoking the add-device
1970 * notifier chain (used by usbfs and possibly others).
1972 err = device_add(&udev->dev);
1974 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1978 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1979 usb_mark_last_busy(udev);
1980 pm_runtime_put_sync_autosuspend(&udev->dev);
1984 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1985 pm_runtime_disable(&udev->dev);
1986 pm_runtime_set_suspended(&udev->dev);
1992 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1993 * @usb_dev: USB device
1995 * Move the USB device to a very basic state where interfaces are disabled
1996 * and the device is in fact unconfigured and unusable.
1998 * We share a lock (that we have) with device_del(), so we need to
2001 int usb_deauthorize_device(struct usb_device *usb_dev)
2003 usb_lock_device(usb_dev);
2004 if (usb_dev->authorized == 0)
2005 goto out_unauthorized;
2007 usb_dev->authorized = 0;
2008 usb_set_configuration(usb_dev, -1);
2010 kfree(usb_dev->product);
2011 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2012 kfree(usb_dev->manufacturer);
2013 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2014 kfree(usb_dev->serial);
2015 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2017 usb_destroy_configuration(usb_dev);
2018 usb_dev->descriptor.bNumConfigurations = 0;
2021 usb_unlock_device(usb_dev);
2026 int usb_authorize_device(struct usb_device *usb_dev)
2030 usb_lock_device(usb_dev);
2031 if (usb_dev->authorized == 1)
2032 goto out_authorized;
2034 result = usb_autoresume_device(usb_dev);
2036 dev_err(&usb_dev->dev,
2037 "can't autoresume for authorization: %d\n", result);
2038 goto error_autoresume;
2040 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2042 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2043 "authorization: %d\n", result);
2044 goto error_device_descriptor;
2047 kfree(usb_dev->product);
2048 usb_dev->product = NULL;
2049 kfree(usb_dev->manufacturer);
2050 usb_dev->manufacturer = NULL;
2051 kfree(usb_dev->serial);
2052 usb_dev->serial = NULL;
2054 usb_dev->authorized = 1;
2055 result = usb_enumerate_device(usb_dev);
2057 goto error_enumerate;
2058 /* Choose and set the configuration. This registers the interfaces
2059 * with the driver core and lets interface drivers bind to them.
2061 c = usb_choose_configuration(usb_dev);
2063 result = usb_set_configuration(usb_dev, c);
2065 dev_err(&usb_dev->dev,
2066 "can't set config #%d, error %d\n", c, result);
2067 /* This need not be fatal. The user can try to
2068 * set other configurations. */
2071 dev_info(&usb_dev->dev, "authorized to connect\n");
2074 error_device_descriptor:
2075 usb_autosuspend_device(usb_dev);
2078 usb_unlock_device(usb_dev); // complements locktree
2083 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2084 static unsigned hub_is_wusb(struct usb_hub *hub)
2086 struct usb_hcd *hcd;
2087 if (hub->hdev->parent != NULL) /* not a root hub? */
2089 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2090 return hcd->wireless;
2094 #define PORT_RESET_TRIES 5
2095 #define SET_ADDRESS_TRIES 2
2096 #define GET_DESCRIPTOR_TRIES 2
2097 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2098 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2100 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2101 #define HUB_SHORT_RESET_TIME 10
2102 #define HUB_BH_RESET_TIME 50
2103 #define HUB_LONG_RESET_TIME 200
2104 #define HUB_RESET_TIMEOUT 500
2106 static int hub_port_reset(struct usb_hub *hub, int port1,
2107 struct usb_device *udev, unsigned int delay, bool warm);
2109 /* Is a USB 3.0 port in the Inactive state? */
2110 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2112 return hub_is_superspeed(hub->hdev) &&
2113 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2114 USB_SS_PORT_LS_SS_INACTIVE;
2117 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2118 struct usb_device *udev, unsigned int delay, bool warm)
2120 int delay_time, ret;
2124 for (delay_time = 0;
2125 delay_time < HUB_RESET_TIMEOUT;
2126 delay_time += delay) {
2127 /* wait to give the device a chance to reset */
2130 /* read and decode port status */
2131 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2136 * Some buggy devices require a warm reset to be issued even
2137 * when the port appears not to be connected.
2141 * Some buggy devices can cause an NEC host controller
2142 * to transition to the "Error" state after a hot port
2143 * reset. This will show up as the port state in
2144 * "Inactive", and the port may also report a
2145 * disconnect. Forcing a warm port reset seems to make
2148 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2150 if (hub_port_inactive(hub, portstatus)) {
2153 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2154 clear_port_feature(hub->hdev, port1,
2155 USB_PORT_FEAT_C_CONNECTION);
2156 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2157 clear_port_feature(hub->hdev, port1,
2158 USB_PORT_FEAT_C_PORT_LINK_STATE);
2159 if (portchange & USB_PORT_STAT_C_RESET)
2160 clear_port_feature(hub->hdev, port1,
2161 USB_PORT_FEAT_C_RESET);
2162 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2164 ret = hub_port_reset(hub, port1,
2165 udev, HUB_BH_RESET_TIME,
2167 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2168 clear_port_feature(hub->hdev, port1,
2169 USB_PORT_FEAT_C_CONNECTION);
2172 /* Device went away? */
2173 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2176 /* bomb out completely if the connection bounced */
2177 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2180 /* if we`ve finished resetting, then break out of
2183 if (!(portstatus & USB_PORT_STAT_RESET) &&
2184 (portstatus & USB_PORT_STAT_ENABLE)) {
2185 if (hub_is_wusb(hub))
2186 udev->speed = USB_SPEED_WIRELESS;
2187 else if (hub_is_superspeed(hub->hdev))
2188 udev->speed = USB_SPEED_SUPER;
2189 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2190 udev->speed = USB_SPEED_HIGH;
2191 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2192 udev->speed = USB_SPEED_LOW;
2194 udev->speed = USB_SPEED_FULL;
2198 if (portchange & USB_PORT_STAT_C_BH_RESET)
2202 /* switch to the long delay after two short delay failures */
2203 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2204 delay = HUB_LONG_RESET_TIME;
2206 dev_dbg (hub->intfdev,
2207 "port %d not %sreset yet, waiting %dms\n",
2208 port1, warm ? "warm " : "", delay);
2214 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2215 struct usb_device *udev, int *status, bool warm)
2220 struct usb_hcd *hcd;
2221 /* TRSTRCY = 10 ms; plus some extra */
2223 update_devnum(udev, 0);
2224 hcd = bus_to_hcd(udev->bus);
2225 if (hcd->driver->reset_device) {
2226 *status = hcd->driver->reset_device(hcd, udev);
2228 dev_err(&udev->dev, "Cannot reset "
2229 "HCD device state\n");
2237 clear_port_feature(hub->hdev,
2238 port1, USB_PORT_FEAT_C_RESET);
2239 /* FIXME need disconnect() for NOTATTACHED device */
2241 clear_port_feature(hub->hdev, port1,
2242 USB_PORT_FEAT_C_BH_PORT_RESET);
2243 clear_port_feature(hub->hdev, port1,
2244 USB_PORT_FEAT_C_PORT_LINK_STATE);
2246 usb_set_device_state(udev, *status
2247 ? USB_STATE_NOTATTACHED
2248 : USB_STATE_DEFAULT);
2254 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2255 static int hub_port_reset(struct usb_hub *hub, int port1,
2256 struct usb_device *udev, unsigned int delay, bool warm)
2261 /* Block EHCI CF initialization during the port reset.
2262 * Some companion controllers don't like it when they mix.
2264 down_read(&ehci_cf_port_reset_rwsem);
2266 if (!hub_is_superspeed(hub->hdev)) {
2267 dev_err(hub->intfdev, "only USB3 hub support "
2273 /* Reset the port */
2274 for (i = 0; i < PORT_RESET_TRIES; i++) {
2275 status = set_port_feature(hub->hdev, port1, (warm ?
2276 USB_PORT_FEAT_BH_PORT_RESET :
2277 USB_PORT_FEAT_RESET));
2279 dev_err(hub->intfdev,
2280 "cannot %sreset port %d (err = %d)\n",
2281 warm ? "warm " : "", port1, status);
2283 status = hub_port_wait_reset(hub, port1, udev, delay,
2285 if (status && status != -ENOTCONN)
2286 dev_dbg(hub->intfdev,
2287 "port_wait_reset: err = %d\n",
2291 /* return on disconnect or reset */
2292 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2293 hub_port_finish_reset(hub, port1, udev, &status, warm);
2297 dev_dbg (hub->intfdev,
2298 "port %d not enabled, trying %sreset again...\n",
2299 port1, warm ? "warm " : "");
2300 delay = HUB_LONG_RESET_TIME;
2303 dev_err (hub->intfdev,
2304 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2309 up_read(&ehci_cf_port_reset_rwsem);
2314 /* Check if a port is power on */
2315 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2319 if (hub_is_superspeed(hub->hdev)) {
2320 if (portstatus & USB_SS_PORT_STAT_POWER)
2323 if (portstatus & USB_PORT_STAT_POWER)
2332 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2333 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2337 if (hub_is_superspeed(hub->hdev)) {
2338 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2339 == USB_SS_PORT_LS_U3)
2342 if (portstatus & USB_PORT_STAT_SUSPEND)
2349 /* Determine whether the device on a port is ready for a normal resume,
2350 * is ready for a reset-resume, or should be disconnected.
2352 static int check_port_resume_type(struct usb_device *udev,
2353 struct usb_hub *hub, int port1,
2354 int status, unsigned portchange, unsigned portstatus)
2356 /* Is the device still present? */
2357 if (status || port_is_suspended(hub, portstatus) ||
2358 !port_is_power_on(hub, portstatus) ||
2359 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2364 /* Can't do a normal resume if the port isn't enabled,
2365 * so try a reset-resume instead.
2367 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2368 if (udev->persist_enabled)
2369 udev->reset_resume = 1;
2375 dev_dbg(hub->intfdev,
2376 "port %d status %04x.%04x after resume, %d\n",
2377 port1, portchange, portstatus, status);
2378 } else if (udev->reset_resume) {
2380 /* Late port handoff can set status-change bits */
2381 if (portchange & USB_PORT_STAT_C_CONNECTION)
2382 clear_port_feature(hub->hdev, port1,
2383 USB_PORT_FEAT_C_CONNECTION);
2384 if (portchange & USB_PORT_STAT_C_ENABLE)
2385 clear_port_feature(hub->hdev, port1,
2386 USB_PORT_FEAT_C_ENABLE);
2392 #ifdef CONFIG_USB_SUSPEND
2395 * usb_port_suspend - suspend a usb device's upstream port
2396 * @udev: device that's no longer in active use, not a root hub
2397 * Context: must be able to sleep; device not locked; pm locks held
2399 * Suspends a USB device that isn't in active use, conserving power.
2400 * Devices may wake out of a suspend, if anything important happens,
2401 * using the remote wakeup mechanism. They may also be taken out of
2402 * suspend by the host, using usb_port_resume(). It's also routine
2403 * to disconnect devices while they are suspended.
2405 * This only affects the USB hardware for a device; its interfaces
2406 * (and, for hubs, child devices) must already have been suspended.
2408 * Selective port suspend reduces power; most suspended devices draw
2409 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2410 * All devices below the suspended port are also suspended.
2412 * Devices leave suspend state when the host wakes them up. Some devices
2413 * also support "remote wakeup", where the device can activate the USB
2414 * tree above them to deliver data, such as a keypress or packet. In
2415 * some cases, this wakes the USB host.
2417 * Suspending OTG devices may trigger HNP, if that's been enabled
2418 * between a pair of dual-role devices. That will change roles, such
2419 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2421 * Devices on USB hub ports have only one "suspend" state, corresponding
2422 * to ACPI D2, "may cause the device to lose some context".
2423 * State transitions include:
2425 * - suspend, resume ... when the VBUS power link stays live
2426 * - suspend, disconnect ... VBUS lost
2428 * Once VBUS drop breaks the circuit, the port it's using has to go through
2429 * normal re-enumeration procedures, starting with enabling VBUS power.
2430 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2431 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2432 * timer, no SRP, no requests through sysfs.
2434 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2435 * the root hub for their bus goes into global suspend ... so we don't
2436 * (falsely) update the device power state to say it suspended.
2438 * Returns 0 on success, else negative errno.
2440 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2442 struct usb_hub *hub = hdev_to_hub(udev->parent);
2443 int port1 = udev->portnum;
2446 /* enable remote wakeup when appropriate; this lets the device
2447 * wake up the upstream hub (including maybe the root hub).
2449 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2450 * we don't explicitly enable it here.
2452 if (udev->do_remote_wakeup) {
2453 if (!hub_is_superspeed(hub->hdev)) {
2454 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2455 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2456 USB_DEVICE_REMOTE_WAKEUP, 0,
2458 USB_CTRL_SET_TIMEOUT);
2460 /* Assume there's only one function on the USB 3.0
2461 * device and enable remote wake for the first
2462 * interface. FIXME if the interface association
2463 * descriptor shows there's more than one function.
2465 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2466 USB_REQ_SET_FEATURE,
2467 USB_RECIP_INTERFACE,
2468 USB_INTRF_FUNC_SUSPEND,
2469 USB_INTRF_FUNC_SUSPEND_RW |
2470 USB_INTRF_FUNC_SUSPEND_LP,
2472 USB_CTRL_SET_TIMEOUT);
2475 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2477 /* bail if autosuspend is requested */
2478 if (PMSG_IS_AUTO(msg))
2483 /* disable USB2 hardware LPM */
2484 if (udev->usb2_hw_lpm_enabled == 1)
2485 usb_set_usb2_hardware_lpm(udev, 0);
2488 if (hub_is_superspeed(hub->hdev))
2489 status = set_port_feature(hub->hdev,
2490 port1 | (USB_SS_PORT_LS_U3 << 3),
2491 USB_PORT_FEAT_LINK_STATE);
2493 status = set_port_feature(hub->hdev, port1,
2494 USB_PORT_FEAT_SUSPEND);
2496 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2498 /* paranoia: "should not happen" */
2499 if (udev->do_remote_wakeup)
2500 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2501 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2502 USB_DEVICE_REMOTE_WAKEUP, 0,
2504 USB_CTRL_SET_TIMEOUT);
2506 /* System sleep transitions should never fail */
2507 if (!PMSG_IS_AUTO(msg))
2510 /* device has up to 10 msec to fully suspend */
2511 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2512 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2513 udev->do_remote_wakeup);
2514 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2517 usb_mark_last_busy(hub->hdev);
2522 * If the USB "suspend" state is in use (rather than "global suspend"),
2523 * many devices will be individually taken out of suspend state using
2524 * special "resume" signaling. This routine kicks in shortly after
2525 * hardware resume signaling is finished, either because of selective
2526 * resume (by host) or remote wakeup (by device) ... now see what changed
2527 * in the tree that's rooted at this device.
2529 * If @udev->reset_resume is set then the device is reset before the
2530 * status check is done.
2532 static int finish_port_resume(struct usb_device *udev)
2537 /* caller owns the udev device lock */
2538 dev_dbg(&udev->dev, "%s\n",
2539 udev->reset_resume ? "finish reset-resume" : "finish resume");
2541 /* usb ch9 identifies four variants of SUSPENDED, based on what
2542 * state the device resumes to. Linux currently won't see the
2543 * first two on the host side; they'd be inside hub_port_init()
2544 * during many timeouts, but khubd can't suspend until later.
2546 usb_set_device_state(udev, udev->actconfig
2547 ? USB_STATE_CONFIGURED
2548 : USB_STATE_ADDRESS);
2550 /* 10.5.4.5 says not to reset a suspended port if the attached
2551 * device is enabled for remote wakeup. Hence the reset
2552 * operation is carried out here, after the port has been
2555 if (udev->reset_resume)
2557 status = usb_reset_and_verify_device(udev);
2559 /* 10.5.4.5 says be sure devices in the tree are still there.
2560 * For now let's assume the device didn't go crazy on resume,
2561 * and device drivers will know about any resume quirks.
2565 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2567 status = (status > 0 ? 0 : -ENODEV);
2569 /* If a normal resume failed, try doing a reset-resume */
2570 if (status && !udev->reset_resume && udev->persist_enabled) {
2571 dev_dbg(&udev->dev, "retry with reset-resume\n");
2572 udev->reset_resume = 1;
2573 goto retry_reset_resume;
2578 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2580 } else if (udev->actconfig) {
2581 le16_to_cpus(&devstatus);
2582 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2583 status = usb_control_msg(udev,
2584 usb_sndctrlpipe(udev, 0),
2585 USB_REQ_CLEAR_FEATURE,
2587 USB_DEVICE_REMOTE_WAKEUP, 0,
2589 USB_CTRL_SET_TIMEOUT);
2592 "disable remote wakeup, status %d\n",
2601 * usb_port_resume - re-activate a suspended usb device's upstream port
2602 * @udev: device to re-activate, not a root hub
2603 * Context: must be able to sleep; device not locked; pm locks held
2605 * This will re-activate the suspended device, increasing power usage
2606 * while letting drivers communicate again with its endpoints.
2607 * USB resume explicitly guarantees that the power session between
2608 * the host and the device is the same as it was when the device
2611 * If @udev->reset_resume is set then this routine won't check that the
2612 * port is still enabled. Furthermore, finish_port_resume() above will
2613 * reset @udev. The end result is that a broken power session can be
2614 * recovered and @udev will appear to persist across a loss of VBUS power.
2616 * For example, if a host controller doesn't maintain VBUS suspend current
2617 * during a system sleep or is reset when the system wakes up, all the USB
2618 * power sessions below it will be broken. This is especially troublesome
2619 * for mass-storage devices containing mounted filesystems, since the
2620 * device will appear to have disconnected and all the memory mappings
2621 * to it will be lost. Using the USB_PERSIST facility, the device can be
2622 * made to appear as if it had not disconnected.
2624 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2625 * every effort to insure that the same device is present after the
2626 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2627 * quite possible for a device to remain unaltered but its media to be
2628 * changed. If the user replaces a flash memory card while the system is
2629 * asleep, he will have only himself to blame when the filesystem on the
2630 * new card is corrupted and the system crashes.
2632 * Returns 0 on success, else negative errno.
2634 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2636 struct usb_hub *hub = hdev_to_hub(udev->parent);
2637 int port1 = udev->portnum;
2639 u16 portchange, portstatus;
2641 /* Skip the initial Clear-Suspend step for a remote wakeup */
2642 status = hub_port_status(hub, port1, &portstatus, &portchange);
2643 if (status == 0 && !port_is_suspended(hub, portstatus))
2644 goto SuspendCleared;
2646 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2648 set_bit(port1, hub->busy_bits);
2650 /* see 7.1.7.7; affects power usage, but not budgeting */
2651 if (hub_is_superspeed(hub->hdev))
2652 status = set_port_feature(hub->hdev,
2653 port1 | (USB_SS_PORT_LS_U0 << 3),
2654 USB_PORT_FEAT_LINK_STATE);
2656 status = clear_port_feature(hub->hdev,
2657 port1, USB_PORT_FEAT_SUSPEND);
2659 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2662 /* drive resume for at least 20 msec */
2663 dev_dbg(&udev->dev, "usb %sresume\n",
2664 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2667 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2668 * stop resume signaling. Then finish the resume
2671 status = hub_port_status(hub, port1, &portstatus, &portchange);
2673 /* TRSMRCY = 10 msec */
2679 if (hub_is_superspeed(hub->hdev)) {
2680 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2681 clear_port_feature(hub->hdev, port1,
2682 USB_PORT_FEAT_C_PORT_LINK_STATE);
2684 if (portchange & USB_PORT_STAT_C_SUSPEND)
2685 clear_port_feature(hub->hdev, port1,
2686 USB_PORT_FEAT_C_SUSPEND);
2690 clear_bit(port1, hub->busy_bits);
2692 status = check_port_resume_type(udev,
2693 hub, port1, status, portchange, portstatus);
2695 status = finish_port_resume(udev);
2697 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2698 hub_port_logical_disconnect(hub, port1);
2700 /* Try to enable USB2 hardware LPM */
2701 if (udev->usb2_hw_lpm_capable == 1)
2702 usb_set_usb2_hardware_lpm(udev, 1);
2708 /* caller has locked udev */
2709 int usb_remote_wakeup(struct usb_device *udev)
2713 if (udev->state == USB_STATE_SUSPENDED) {
2714 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2715 status = usb_autoresume_device(udev);
2717 /* Let the drivers do their thing, then... */
2718 usb_autosuspend_device(udev);
2724 #else /* CONFIG_USB_SUSPEND */
2726 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2728 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2733 /* However we may need to do a reset-resume */
2735 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2737 struct usb_hub *hub = hdev_to_hub(udev->parent);
2738 int port1 = udev->portnum;
2740 u16 portchange, portstatus;
2742 status = hub_port_status(hub, port1, &portstatus, &portchange);
2743 status = check_port_resume_type(udev,
2744 hub, port1, status, portchange, portstatus);
2747 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2748 hub_port_logical_disconnect(hub, port1);
2749 } else if (udev->reset_resume) {
2750 dev_dbg(&udev->dev, "reset-resume\n");
2751 status = usb_reset_and_verify_device(udev);
2758 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2760 struct usb_hub *hub = usb_get_intfdata (intf);
2761 struct usb_device *hdev = hub->hdev;
2765 /* Warn if children aren't already suspended */
2766 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2767 struct usb_device *udev;
2769 udev = hub->port_data[port1-1].child;
2770 if (udev && udev->can_submit) {
2771 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2772 if (PMSG_IS_AUTO(msg))
2776 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2777 /* Enable hub to send remote wakeup for all ports. */
2778 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2779 status = set_port_feature(hdev,
2781 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2782 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2783 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2784 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2788 dev_dbg(&intf->dev, "%s\n", __func__);
2790 /* stop khubd and related activity */
2791 hub_quiesce(hub, HUB_SUSPEND);
2795 static int hub_resume(struct usb_interface *intf)
2797 struct usb_hub *hub = usb_get_intfdata(intf);
2799 dev_dbg(&intf->dev, "%s\n", __func__);
2800 hub_activate(hub, HUB_RESUME);
2804 static int hub_reset_resume(struct usb_interface *intf)
2806 struct usb_hub *hub = usb_get_intfdata(intf);
2808 dev_dbg(&intf->dev, "%s\n", __func__);
2809 hub_activate(hub, HUB_RESET_RESUME);
2814 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2815 * @rhdev: struct usb_device for the root hub
2817 * The USB host controller driver calls this function when its root hub
2818 * is resumed and Vbus power has been interrupted or the controller
2819 * has been reset. The routine marks @rhdev as having lost power.
2820 * When the hub driver is resumed it will take notice and carry out
2821 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2822 * the others will be disconnected.
2824 void usb_root_hub_lost_power(struct usb_device *rhdev)
2826 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2827 rhdev->reset_resume = 1;
2829 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2831 #else /* CONFIG_PM */
2833 #define hub_suspend NULL
2834 #define hub_resume NULL
2835 #define hub_reset_resume NULL
2839 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2841 * Between connect detection and reset signaling there must be a delay
2842 * of 100ms at least for debounce and power-settling. The corresponding
2843 * timer shall restart whenever the downstream port detects a disconnect.
2845 * Apparently there are some bluetooth and irda-dongles and a number of
2846 * low-speed devices for which this debounce period may last over a second.
2847 * Not covered by the spec - but easy to deal with.
2849 * This implementation uses a 1500ms total debounce timeout; if the
2850 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2851 * every 25ms for transient disconnects. When the port status has been
2852 * unchanged for 100ms it returns the port status.
2854 static int hub_port_debounce(struct usb_hub *hub, int port1)
2857 int total_time, stable_time = 0;
2858 u16 portchange, portstatus;
2859 unsigned connection = 0xffff;
2861 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2862 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2866 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2867 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2868 stable_time += HUB_DEBOUNCE_STEP;
2869 if (stable_time >= HUB_DEBOUNCE_STABLE)
2873 connection = portstatus & USB_PORT_STAT_CONNECTION;
2876 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2877 clear_port_feature(hub->hdev, port1,
2878 USB_PORT_FEAT_C_CONNECTION);
2881 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2883 msleep(HUB_DEBOUNCE_STEP);
2886 dev_dbg (hub->intfdev,
2887 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2888 port1, total_time, stable_time, portstatus);
2890 if (stable_time < HUB_DEBOUNCE_STABLE)
2895 void usb_ep0_reinit(struct usb_device *udev)
2897 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2898 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2899 usb_enable_endpoint(udev, &udev->ep0, true);
2901 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2903 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2904 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2906 static int hub_set_address(struct usb_device *udev, int devnum)
2909 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2912 * The host controller will choose the device address,
2913 * instead of the core having chosen it earlier
2915 if (!hcd->driver->address_device && devnum <= 1)
2917 if (udev->state == USB_STATE_ADDRESS)
2919 if (udev->state != USB_STATE_DEFAULT)
2921 if (hcd->driver->address_device)
2922 retval = hcd->driver->address_device(hcd, udev);
2924 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2925 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2926 NULL, 0, USB_CTRL_SET_TIMEOUT);
2928 update_devnum(udev, devnum);
2929 /* Device now using proper address. */
2930 usb_set_device_state(udev, USB_STATE_ADDRESS);
2931 usb_ep0_reinit(udev);
2936 /* Reset device, (re)assign address, get device descriptor.
2937 * Device connection must be stable, no more debouncing needed.
2938 * Returns device in USB_STATE_ADDRESS, except on error.
2940 * If this is called for an already-existing device (as part of
2941 * usb_reset_and_verify_device), the caller must own the device lock. For a
2942 * newly detected device that is not accessible through any global
2943 * pointers, it's not necessary to lock the device.
2946 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2949 static DEFINE_MUTEX(usb_address0_mutex);
2951 struct usb_device *hdev = hub->hdev;
2952 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2954 unsigned delay = HUB_SHORT_RESET_TIME;
2955 enum usb_device_speed oldspeed = udev->speed;
2957 int devnum = udev->devnum;
2959 /* root hub ports have a slightly longer reset period
2960 * (from USB 2.0 spec, section 7.1.7.5)
2962 if (!hdev->parent) {
2963 delay = HUB_ROOT_RESET_TIME;
2964 if (port1 == hdev->bus->otg_port)
2965 hdev->bus->b_hnp_enable = 0;
2968 /* Some low speed devices have problems with the quick delay, so */
2969 /* be a bit pessimistic with those devices. RHbug #23670 */
2970 if (oldspeed == USB_SPEED_LOW)
2971 delay = HUB_LONG_RESET_TIME;
2973 mutex_lock(&usb_address0_mutex);
2975 /* Reset the device; full speed may morph to high speed */
2976 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2977 retval = hub_port_reset(hub, port1, udev, delay, false);
2978 if (retval < 0) /* error or disconnect */
2980 /* success, speed is known */
2984 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2985 dev_dbg(&udev->dev, "device reset changed speed!\n");
2988 oldspeed = udev->speed;
2990 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2991 * it's fixed size except for full speed devices.
2992 * For Wireless USB devices, ep0 max packet is always 512 (tho
2993 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2995 switch (udev->speed) {
2996 case USB_SPEED_SUPER:
2997 case USB_SPEED_WIRELESS: /* fixed at 512 */
2998 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3000 case USB_SPEED_HIGH: /* fixed at 64 */
3001 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3003 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3004 /* to determine the ep0 maxpacket size, try to read
3005 * the device descriptor to get bMaxPacketSize0 and
3006 * then correct our initial guess.
3008 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
3010 case USB_SPEED_LOW: /* fixed at 8 */
3011 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
3017 if (udev->speed == USB_SPEED_WIRELESS)
3018 speed = "variable speed Wireless";
3020 speed = usb_speed_string(udev->speed);
3022 if (udev->speed != USB_SPEED_SUPER)
3023 dev_info(&udev->dev,
3024 "%s %s USB device number %d using %s\n",
3025 (udev->config) ? "reset" : "new", speed,
3026 devnum, udev->bus->controller->driver->name);
3028 /* Set up TT records, if needed */
3030 udev->tt = hdev->tt;
3031 udev->ttport = hdev->ttport;
3032 } else if (udev->speed != USB_SPEED_HIGH
3033 && hdev->speed == USB_SPEED_HIGH) {
3035 dev_err(&udev->dev, "parent hub has no TT\n");
3039 udev->tt = &hub->tt;
3040 udev->ttport = port1;
3043 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3044 * Because device hardware and firmware is sometimes buggy in
3045 * this area, and this is how Linux has done it for ages.
3046 * Change it cautiously.
3048 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3049 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3050 * so it may help with some non-standards-compliant devices.
3051 * Otherwise we start with SET_ADDRESS and then try to read the
3052 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3055 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3056 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
3057 struct usb_device_descriptor *buf;
3060 #define GET_DESCRIPTOR_BUFSIZE 64
3061 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3067 /* Retry on all errors; some devices are flakey.
3068 * 255 is for WUSB devices, we actually need to use
3069 * 512 (WUSB1.0[4.8.1]).
3071 for (j = 0; j < 3; ++j) {
3072 buf->bMaxPacketSize0 = 0;
3073 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3074 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3075 USB_DT_DEVICE << 8, 0,
3076 buf, GET_DESCRIPTOR_BUFSIZE,
3077 initial_descriptor_timeout);
3078 switch (buf->bMaxPacketSize0) {
3079 case 8: case 16: case 32: case 64: case 255:
3080 if (buf->bDescriptorType ==
3094 udev->descriptor.bMaxPacketSize0 =
3095 buf->bMaxPacketSize0;
3098 retval = hub_port_reset(hub, port1, udev, delay, false);
3099 if (retval < 0) /* error or disconnect */
3101 if (oldspeed != udev->speed) {
3103 "device reset changed speed!\n");
3109 "device descriptor read/64, error %d\n",
3114 #undef GET_DESCRIPTOR_BUFSIZE
3118 * If device is WUSB, we already assigned an
3119 * unauthorized address in the Connect Ack sequence;
3120 * authorization will assign the final address.
3122 if (udev->wusb == 0) {
3123 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3124 retval = hub_set_address(udev, devnum);
3131 "device not accepting address %d, error %d\n",
3135 if (udev->speed == USB_SPEED_SUPER) {
3136 devnum = udev->devnum;
3137 dev_info(&udev->dev,
3138 "%s SuperSpeed USB device number %d using %s\n",
3139 (udev->config) ? "reset" : "new",
3140 devnum, udev->bus->controller->driver->name);
3143 /* cope with hardware quirkiness:
3144 * - let SET_ADDRESS settle, some device hardware wants it
3145 * - read ep0 maxpacket even for high and low speed,
3148 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3152 retval = usb_get_device_descriptor(udev, 8);
3155 "device descriptor read/8, error %d\n",
3168 * Some superspeed devices have finished the link training process
3169 * and attached to a superspeed hub port, but the device descriptor
3170 * got from those devices show they aren't superspeed devices. Warm
3171 * reset the port attached by the devices can fix them.
3173 if ((udev->speed == USB_SPEED_SUPER) &&
3174 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
3175 dev_err(&udev->dev, "got a wrong device descriptor, "
3176 "warm reset device\n");
3177 hub_port_reset(hub, port1, udev,
3178 HUB_BH_RESET_TIME, true);
3183 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3184 udev->speed == USB_SPEED_SUPER)
3187 i = udev->descriptor.bMaxPacketSize0;
3188 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3189 if (udev->speed == USB_SPEED_LOW ||
3190 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3191 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3195 if (udev->speed == USB_SPEED_FULL)
3196 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3198 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3199 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3200 usb_ep0_reinit(udev);
3203 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3204 if (retval < (signed)sizeof(udev->descriptor)) {
3205 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3212 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3213 retval = usb_get_bos_descriptor(udev);
3215 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3216 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3217 udev->lpm_capable = 1;
3222 /* notify HCD that we have a device connected and addressed */
3223 if (hcd->driver->update_device)
3224 hcd->driver->update_device(hcd, udev);
3227 hub_port_disable(hub, port1, 0);
3228 update_devnum(udev, devnum); /* for disconnect processing */
3230 mutex_unlock(&usb_address0_mutex);
3235 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3237 struct usb_qualifier_descriptor *qual;
3240 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3244 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3245 qual, sizeof *qual);
3246 if (status == sizeof *qual) {
3247 dev_info(&udev->dev, "not running at top speed; "
3248 "connect to a high speed hub\n");
3249 /* hub LEDs are probably harder to miss than syslog */
3250 if (hub->has_indicators) {
3251 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3252 schedule_delayed_work (&hub->leds, 0);
3259 hub_power_remaining (struct usb_hub *hub)
3261 struct usb_device *hdev = hub->hdev;
3265 if (!hub->limited_power)
3268 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3269 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3270 struct usb_device *udev = hub->port_data[port1 - 1].child;
3276 /* Unconfigured devices may not use more than 100mA,
3277 * or 8mA for OTG ports */
3278 if (udev->actconfig)
3279 delta = udev->actconfig->desc.bMaxPower * 2;
3280 else if (port1 != udev->bus->otg_port || hdev->parent)
3284 if (delta > hub->mA_per_port)
3285 dev_warn(&udev->dev,
3286 "%dmA is over %umA budget for port %d!\n",
3287 delta, hub->mA_per_port, port1);
3290 if (remaining < 0) {
3291 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3298 /* Handle physical or logical connection change events.
3299 * This routine is called when:
3300 * a port connection-change occurs;
3301 * a port enable-change occurs (often caused by EMI);
3302 * usb_reset_and_verify_device() encounters changed descriptors (as from
3303 * a firmware download)
3304 * caller already locked the hub
3306 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3307 u16 portstatus, u16 portchange)
3309 struct usb_device *hdev = hub->hdev;
3310 struct device *hub_dev = hub->intfdev;
3311 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3312 unsigned wHubCharacteristics =
3313 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3314 struct usb_device *udev;
3318 "port %d, status %04x, change %04x, %s\n",
3319 port1, portstatus, portchange, portspeed(hub, portstatus));
3321 if (hub->has_indicators) {
3322 set_port_led(hub, port1, HUB_LED_AUTO);
3323 hub->indicator[port1-1] = INDICATOR_AUTO;
3326 #ifdef CONFIG_USB_OTG
3327 /* during HNP, don't repeat the debounce */
3328 if (hdev->bus->is_b_host)
3329 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3330 USB_PORT_STAT_C_ENABLE);
3333 /* Try to resuscitate an existing device */
3334 udev = hub->port_data[port1-1].child;
3335 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3336 udev->state != USB_STATE_NOTATTACHED) {
3337 usb_lock_device(udev);
3338 if (portstatus & USB_PORT_STAT_ENABLE) {
3339 status = 0; /* Nothing to do */
3341 #ifdef CONFIG_USB_SUSPEND
3342 } else if (udev->state == USB_STATE_SUSPENDED &&
3343 udev->persist_enabled) {
3344 /* For a suspended device, treat this as a
3345 * remote wakeup event.
3347 status = usb_remote_wakeup(udev);
3351 status = -ENODEV; /* Don't resuscitate */
3353 usb_unlock_device(udev);
3356 clear_bit(port1, hub->change_bits);
3361 /* Disconnect any existing devices under this port */
3363 usb_disconnect(&hub->port_data[port1-1].child);
3364 clear_bit(port1, hub->change_bits);
3366 /* We can forget about a "removed" device when there's a physical
3367 * disconnect or the connect status changes.
3369 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3370 (portchange & USB_PORT_STAT_C_CONNECTION))
3371 clear_bit(port1, hub->removed_bits);
3373 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3374 USB_PORT_STAT_C_ENABLE)) {
3375 status = hub_port_debounce(hub, port1);
3377 if (printk_ratelimit())
3378 dev_err(hub_dev, "connect-debounce failed, "
3379 "port %d disabled\n", port1);
3380 portstatus &= ~USB_PORT_STAT_CONNECTION;
3382 portstatus = status;
3386 /* Return now if debouncing failed or nothing is connected or
3387 * the device was "removed".
3389 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3390 test_bit(port1, hub->removed_bits)) {
3392 /* maybe switch power back on (e.g. root hub was reset) */
3393 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3394 && !port_is_power_on(hub, portstatus))
3395 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3397 if (portstatus & USB_PORT_STAT_ENABLE)
3402 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3404 /* reallocate for each attempt, since references
3405 * to the previous one can escape in various ways
3407 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3410 "couldn't allocate port %d usb_device\n",
3415 usb_set_device_state(udev, USB_STATE_POWERED);
3416 udev->bus_mA = hub->mA_per_port;
3417 udev->level = hdev->level + 1;
3418 udev->wusb = hub_is_wusb(hub);
3420 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3421 if (hub_is_superspeed(hub->hdev))
3422 udev->speed = USB_SPEED_SUPER;
3424 udev->speed = USB_SPEED_UNKNOWN;
3426 choose_devnum(udev);
3427 if (udev->devnum <= 0) {
3428 status = -ENOTCONN; /* Don't retry */
3432 /* reset (non-USB 3.0 devices) and get descriptor */
3433 status = hub_port_init(hub, udev, port1, i);
3437 usb_detect_quirks(udev);
3438 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3441 /* consecutive bus-powered hubs aren't reliable; they can
3442 * violate the voltage drop budget. if the new child has
3443 * a "powered" LED, users should notice we didn't enable it
3444 * (without reading syslog), even without per-port LEDs
3447 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3448 && udev->bus_mA <= 100) {
3451 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3454 dev_dbg(&udev->dev, "get status %d ?\n", status);
3457 le16_to_cpus(&devstat);
3458 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3460 "can't connect bus-powered hub "
3462 if (hub->has_indicators) {
3463 hub->indicator[port1-1] =
3464 INDICATOR_AMBER_BLINK;
3465 schedule_delayed_work (&hub->leds, 0);
3467 status = -ENOTCONN; /* Don't retry */
3472 /* check for devices running slower than they could */
3473 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3474 && udev->speed == USB_SPEED_FULL
3475 && highspeed_hubs != 0)
3476 check_highspeed (hub, udev, port1);
3478 /* Store the hub port's child pointer. At this point
3479 * udev becomes globally accessible, although presumably
3480 * no one will look at it until hdev is unlocked.
3484 /* We mustn't add new devices if the parent hub has
3485 * been disconnected; we would race with the
3486 * recursively_mark_NOTATTACHED() routine.
3488 spin_lock_irq(&device_state_lock);
3489 if (hdev->state == USB_STATE_NOTATTACHED)
3492 hub->port_data[port1-1].child = udev;
3493 spin_unlock_irq(&device_state_lock);
3495 /* Run it through the hoops (find a driver, etc) */
3497 status = usb_new_device(udev);
3499 spin_lock_irq(&device_state_lock);
3500 hub->port_data[port1-1].child = NULL;
3501 spin_unlock_irq(&device_state_lock);
3508 status = hub_power_remaining(hub);
3510 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3515 hub_port_disable(hub, port1, 1);
3517 usb_ep0_reinit(udev);
3518 release_devnum(udev);
3521 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3524 if (hub->hdev->parent ||
3525 !hcd->driver->port_handed_over ||
3526 !(hcd->driver->port_handed_over)(hcd, port1))
3527 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3531 hub_port_disable(hub, port1, 1);
3532 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3533 hcd->driver->relinquish_port(hcd, port1);
3536 /* Returns 1 if there was a remote wakeup and a connect status change. */
3537 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3538 u16 portstatus, u16 portchange)
3540 struct usb_device *hdev;
3541 struct usb_device *udev;
3542 int connect_change = 0;
3546 udev = hub->port_data[port - 1].child;
3547 if (!hub_is_superspeed(hdev)) {
3548 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3550 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3552 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3553 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3559 /* TRSMRCY = 10 msec */
3562 usb_lock_device(udev);
3563 ret = usb_remote_wakeup(udev);
3564 usb_unlock_device(udev);
3569 hub_port_disable(hub, port, 1);
3571 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
3573 return connect_change;
3576 static void hub_events(void)
3578 struct list_head *tmp;
3579 struct usb_device *hdev;
3580 struct usb_interface *intf;
3581 struct usb_hub *hub;
3582 struct device *hub_dev;
3588 int connect_change, wakeup_change;
3591 * We restart the list every time to avoid a deadlock with
3592 * deleting hubs downstream from this one. This should be
3593 * safe since we delete the hub from the event list.
3594 * Not the most efficient, but avoids deadlocks.
3598 /* Grab the first entry at the beginning of the list */
3599 spin_lock_irq(&hub_event_lock);
3600 if (list_empty(&hub_event_list)) {
3601 spin_unlock_irq(&hub_event_lock);
3605 tmp = hub_event_list.next;
3608 hub = list_entry(tmp, struct usb_hub, event_list);
3609 kref_get(&hub->kref);
3610 spin_unlock_irq(&hub_event_lock);
3613 hub_dev = hub->intfdev;
3614 intf = to_usb_interface(hub_dev);
3615 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3616 hdev->state, hub->descriptor
3617 ? hub->descriptor->bNbrPorts
3619 /* NOTE: expects max 15 ports... */
3620 (u16) hub->change_bits[0],
3621 (u16) hub->event_bits[0]);
3623 /* Lock the device, then check to see if we were
3624 * disconnected while waiting for the lock to succeed. */
3625 usb_lock_device(hdev);
3626 if (unlikely(hub->disconnected))
3627 goto loop_disconnected;
3629 /* If the hub has died, clean up after it */
3630 if (hdev->state == USB_STATE_NOTATTACHED) {
3631 hub->error = -ENODEV;
3632 hub_quiesce(hub, HUB_DISCONNECT);
3637 ret = usb_autopm_get_interface(intf);
3639 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3643 /* If this is an inactive hub, do nothing */
3648 dev_dbg (hub_dev, "resetting for error %d\n",
3651 ret = usb_reset_device(hdev);
3654 "error resetting hub: %d\n", ret);
3662 /* deal with port status changes */
3663 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3664 if (test_bit(i, hub->busy_bits))
3666 connect_change = test_bit(i, hub->change_bits);
3667 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
3668 if (!test_and_clear_bit(i, hub->event_bits) &&
3669 !connect_change && !wakeup_change)
3672 ret = hub_port_status(hub, i,
3673 &portstatus, &portchange);
3677 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3678 clear_port_feature(hdev, i,
3679 USB_PORT_FEAT_C_CONNECTION);
3683 if (portchange & USB_PORT_STAT_C_ENABLE) {
3684 if (!connect_change)
3686 "port %d enable change, "
3689 clear_port_feature(hdev, i,
3690 USB_PORT_FEAT_C_ENABLE);
3693 * EM interference sometimes causes badly
3694 * shielded USB devices to be shutdown by
3695 * the hub, this hack enables them again.
3696 * Works at least with mouse driver.
3698 if (!(portstatus & USB_PORT_STAT_ENABLE)
3700 && hub->port_data[i-1].child) {
3703 "disabled by hub (EMI?), "
3710 if (hub_handle_remote_wakeup(hub, i,
3711 portstatus, portchange))
3714 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3718 dev_dbg(hub_dev, "over-current change on port "
3720 clear_port_feature(hdev, i,
3721 USB_PORT_FEAT_C_OVER_CURRENT);
3722 msleep(100); /* Cool down */
3723 hub_power_on(hub, true);
3724 hub_port_status(hub, i, &status, &unused);
3725 if (status & USB_PORT_STAT_OVERCURRENT)
3726 dev_err(hub_dev, "over-current "
3727 "condition on port %d\n", i);
3730 if (portchange & USB_PORT_STAT_C_RESET) {
3732 "reset change on port %d\n",
3734 clear_port_feature(hdev, i,
3735 USB_PORT_FEAT_C_RESET);
3737 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3738 hub_is_superspeed(hub->hdev)) {
3740 "warm reset change on port %d\n",
3742 clear_port_feature(hdev, i,
3743 USB_PORT_FEAT_C_BH_PORT_RESET);
3745 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3746 clear_port_feature(hub->hdev, i,
3747 USB_PORT_FEAT_C_PORT_LINK_STATE);
3749 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3751 "config error on port %d\n",
3753 clear_port_feature(hub->hdev, i,
3754 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3757 /* Warm reset a USB3 protocol port if it's in
3758 * SS.Inactive state.
3760 if (hub_is_superspeed(hub->hdev) &&
3761 (portstatus & USB_PORT_STAT_LINK_STATE)
3762 == USB_SS_PORT_LS_SS_INACTIVE) {
3763 dev_dbg(hub_dev, "warm reset port %d\n", i);
3764 hub_port_reset(hub, i, NULL,
3765 HUB_BH_RESET_TIME, true);
3769 hub_port_connect_change(hub, i,
3770 portstatus, portchange);
3773 /* deal with hub status changes */
3774 if (test_and_clear_bit(0, hub->event_bits) == 0)
3776 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3777 dev_err (hub_dev, "get_hub_status failed\n");
3779 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3780 dev_dbg (hub_dev, "power change\n");
3781 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3782 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3783 /* FIXME: Is this always true? */
3784 hub->limited_power = 1;
3786 hub->limited_power = 0;
3788 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3792 dev_dbg(hub_dev, "over-current change\n");
3793 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3794 msleep(500); /* Cool down */
3795 hub_power_on(hub, true);
3796 hub_hub_status(hub, &status, &unused);
3797 if (status & HUB_STATUS_OVERCURRENT)
3798 dev_err(hub_dev, "over-current "
3804 /* Balance the usb_autopm_get_interface() above */
3805 usb_autopm_put_interface_no_suspend(intf);
3807 /* Balance the usb_autopm_get_interface_no_resume() in
3808 * kick_khubd() and allow autosuspend.
3810 usb_autopm_put_interface(intf);
3812 usb_unlock_device(hdev);
3813 kref_put(&hub->kref, hub_release);
3815 } /* end while (1) */
3818 static int hub_thread(void *__unused)
3820 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3821 * port handover. Otherwise it might see that a full-speed device
3822 * was gone before the EHCI controller had handed its port over to
3823 * the companion full-speed controller.
3829 wait_event_freezable(khubd_wait,
3830 !list_empty(&hub_event_list) ||
3831 kthread_should_stop());
3832 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3834 pr_debug("%s: khubd exiting\n", usbcore_name);
3838 static const struct usb_device_id hub_id_table[] = {
3839 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3840 .bDeviceClass = USB_CLASS_HUB},
3841 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3842 .bInterfaceClass = USB_CLASS_HUB},
3843 { } /* Terminating entry */
3846 MODULE_DEVICE_TABLE (usb, hub_id_table);
3848 static struct usb_driver hub_driver = {
3851 .disconnect = hub_disconnect,
3852 .suspend = hub_suspend,
3853 .resume = hub_resume,
3854 .reset_resume = hub_reset_resume,
3855 .pre_reset = hub_pre_reset,
3856 .post_reset = hub_post_reset,
3857 .unlocked_ioctl = hub_ioctl,
3858 .id_table = hub_id_table,
3859 .supports_autosuspend = 1,
3862 int usb_hub_init(void)
3864 if (usb_register(&hub_driver) < 0) {
3865 printk(KERN_ERR "%s: can't register hub driver\n",
3870 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3871 if (!IS_ERR(khubd_task))
3874 /* Fall through if kernel_thread failed */
3875 usb_deregister(&hub_driver);
3876 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3881 void usb_hub_cleanup(void)
3883 kthread_stop(khubd_task);
3886 * Hub resources are freed for us by usb_deregister. It calls
3887 * usb_driver_purge on every device which in turn calls that
3888 * devices disconnect function if it is using this driver.
3889 * The hub_disconnect function takes care of releasing the
3890 * individual hub resources. -greg
3892 usb_deregister(&hub_driver);
3893 } /* usb_hub_cleanup() */
3895 static int descriptors_changed(struct usb_device *udev,
3896 struct usb_device_descriptor *old_device_descriptor)
3900 unsigned serial_len = 0;
3902 unsigned old_length;
3906 if (memcmp(&udev->descriptor, old_device_descriptor,
3907 sizeof(*old_device_descriptor)) != 0)
3910 /* Since the idVendor, idProduct, and bcdDevice values in the
3911 * device descriptor haven't changed, we will assume the
3912 * Manufacturer and Product strings haven't changed either.
3913 * But the SerialNumber string could be different (e.g., a
3914 * different flash card of the same brand).
3917 serial_len = strlen(udev->serial) + 1;
3920 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3921 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3922 len = max(len, old_length);
3925 buf = kmalloc(len, GFP_NOIO);
3927 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3928 /* assume the worst */
3931 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3932 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3933 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3935 if (length != old_length) {
3936 dev_dbg(&udev->dev, "config index %d, error %d\n",
3941 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3943 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3945 ((struct usb_config_descriptor *) buf)->
3946 bConfigurationValue);
3952 if (!changed && serial_len) {
3953 length = usb_string(udev, udev->descriptor.iSerialNumber,
3955 if (length + 1 != serial_len) {
3956 dev_dbg(&udev->dev, "serial string error %d\n",
3959 } else if (memcmp(buf, udev->serial, length) != 0) {
3960 dev_dbg(&udev->dev, "serial string changed\n");
3970 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3971 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3973 * WARNING - don't use this routine to reset a composite device
3974 * (one with multiple interfaces owned by separate drivers)!
3975 * Use usb_reset_device() instead.
3977 * Do a port reset, reassign the device's address, and establish its
3978 * former operating configuration. If the reset fails, or the device's
3979 * descriptors change from their values before the reset, or the original
3980 * configuration and altsettings cannot be restored, a flag will be set
3981 * telling khubd to pretend the device has been disconnected and then
3982 * re-connected. All drivers will be unbound, and the device will be
3983 * re-enumerated and probed all over again.
3985 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3986 * flagged for logical disconnection, or some other negative error code
3987 * if the reset wasn't even attempted.
3989 * The caller must own the device lock. For example, it's safe to use
3990 * this from a driver probe() routine after downloading new firmware.
3991 * For calls that might not occur during probe(), drivers should lock
3992 * the device using usb_lock_device_for_reset().
3994 * Locking exception: This routine may also be called from within an
3995 * autoresume handler. Such usage won't conflict with other tasks
3996 * holding the device lock because these tasks should always call
3997 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3999 static int usb_reset_and_verify_device(struct usb_device *udev)
4001 struct usb_device *parent_hdev = udev->parent;
4002 struct usb_hub *parent_hub;
4003 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4004 struct usb_device_descriptor descriptor = udev->descriptor;
4006 int port1 = udev->portnum;
4008 if (udev->state == USB_STATE_NOTATTACHED ||
4009 udev->state == USB_STATE_SUSPENDED) {
4010 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4016 /* this requires hcd-specific logic; see ohci_restart() */
4017 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
4020 parent_hub = hdev_to_hub(parent_hdev);
4022 set_bit(port1, parent_hub->busy_bits);
4023 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4025 /* ep0 maxpacket size may change; let the HCD know about it.
4026 * Other endpoints will be handled by re-enumeration. */
4027 usb_ep0_reinit(udev);
4028 ret = hub_port_init(parent_hub, udev, port1, i);
4029 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
4032 clear_bit(port1, parent_hub->busy_bits);
4037 /* Device might have changed firmware (DFU or similar) */
4038 if (descriptors_changed(udev, &descriptor)) {
4039 dev_info(&udev->dev, "device firmware changed\n");
4040 udev->descriptor = descriptor; /* for disconnect() calls */
4044 /* Restore the device's previous configuration */
4045 if (!udev->actconfig)
4048 mutex_lock(hcd->bandwidth_mutex);
4049 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4051 dev_warn(&udev->dev,
4052 "Busted HC? Not enough HCD resources for "
4053 "old configuration.\n");
4054 mutex_unlock(hcd->bandwidth_mutex);
4057 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4058 USB_REQ_SET_CONFIGURATION, 0,
4059 udev->actconfig->desc.bConfigurationValue, 0,
4060 NULL, 0, USB_CTRL_SET_TIMEOUT);
4063 "can't restore configuration #%d (error=%d)\n",
4064 udev->actconfig->desc.bConfigurationValue, ret);
4065 mutex_unlock(hcd->bandwidth_mutex);
4068 mutex_unlock(hcd->bandwidth_mutex);
4069 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4071 /* Put interfaces back into the same altsettings as before.
4072 * Don't bother to send the Set-Interface request for interfaces
4073 * that were already in altsetting 0; besides being unnecessary,
4074 * many devices can't handle it. Instead just reset the host-side
4077 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4078 struct usb_host_config *config = udev->actconfig;
4079 struct usb_interface *intf = config->interface[i];
4080 struct usb_interface_descriptor *desc;
4082 desc = &intf->cur_altsetting->desc;
4083 if (desc->bAlternateSetting == 0) {
4084 usb_disable_interface(udev, intf, true);
4085 usb_enable_interface(udev, intf, true);
4088 /* Let the bandwidth allocation function know that this
4089 * device has been reset, and it will have to use
4090 * alternate setting 0 as the current alternate setting.
4092 intf->resetting_device = 1;
4093 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4094 desc->bAlternateSetting);
4095 intf->resetting_device = 0;
4098 dev_err(&udev->dev, "failed to restore interface %d "
4099 "altsetting %d (error=%d)\n",
4100 desc->bInterfaceNumber,
4101 desc->bAlternateSetting,
4111 hub_port_logical_disconnect(parent_hub, port1);
4116 * usb_reset_device - warn interface drivers and perform a USB port reset
4117 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4119 * Warns all drivers bound to registered interfaces (using their pre_reset
4120 * method), performs the port reset, and then lets the drivers know that
4121 * the reset is over (using their post_reset method).
4123 * Return value is the same as for usb_reset_and_verify_device().
4125 * The caller must own the device lock. For example, it's safe to use
4126 * this from a driver probe() routine after downloading new firmware.
4127 * For calls that might not occur during probe(), drivers should lock
4128 * the device using usb_lock_device_for_reset().
4130 * If an interface is currently being probed or disconnected, we assume
4131 * its driver knows how to handle resets. For all other interfaces,
4132 * if the driver doesn't have pre_reset and post_reset methods then
4133 * we attempt to unbind it and rebind afterward.
4135 int usb_reset_device(struct usb_device *udev)
4139 struct usb_host_config *config = udev->actconfig;
4141 if (udev->state == USB_STATE_NOTATTACHED ||
4142 udev->state == USB_STATE_SUSPENDED) {
4143 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4148 /* Prevent autosuspend during the reset */
4149 usb_autoresume_device(udev);
4152 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4153 struct usb_interface *cintf = config->interface[i];
4154 struct usb_driver *drv;
4157 if (cintf->dev.driver) {
4158 drv = to_usb_driver(cintf->dev.driver);
4159 if (drv->pre_reset && drv->post_reset)
4160 unbind = (drv->pre_reset)(cintf);
4161 else if (cintf->condition ==
4162 USB_INTERFACE_BOUND)
4165 usb_forced_unbind_intf(cintf);
4170 ret = usb_reset_and_verify_device(udev);
4173 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4174 struct usb_interface *cintf = config->interface[i];
4175 struct usb_driver *drv;
4176 int rebind = cintf->needs_binding;
4178 if (!rebind && cintf->dev.driver) {
4179 drv = to_usb_driver(cintf->dev.driver);
4180 if (drv->post_reset)
4181 rebind = (drv->post_reset)(cintf);
4182 else if (cintf->condition ==
4183 USB_INTERFACE_BOUND)
4186 if (ret == 0 && rebind)
4187 usb_rebind_intf(cintf);
4191 usb_autosuspend_device(udev);
4194 EXPORT_SYMBOL_GPL(usb_reset_device);
4198 * usb_queue_reset_device - Reset a USB device from an atomic context
4199 * @iface: USB interface belonging to the device to reset
4201 * This function can be used to reset a USB device from an atomic
4202 * context, where usb_reset_device() won't work (as it blocks).
4204 * Doing a reset via this method is functionally equivalent to calling
4205 * usb_reset_device(), except for the fact that it is delayed to a
4206 * workqueue. This means that any drivers bound to other interfaces
4207 * might be unbound, as well as users from usbfs in user space.
4211 * - Scheduling two resets at the same time from two different drivers
4212 * attached to two different interfaces of the same device is
4213 * possible; depending on how the driver attached to each interface
4214 * handles ->pre_reset(), the second reset might happen or not.
4216 * - If a driver is unbound and it had a pending reset, the reset will
4219 * - This function can be called during .probe() or .disconnect()
4220 * times. On return from .disconnect(), any pending resets will be
4223 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4226 * NOTE: We don't do any reference count tracking because it is not
4227 * needed. The lifecycle of the work_struct is tied to the
4228 * usb_interface. Before destroying the interface we cancel the
4229 * work_struct, so the fact that work_struct is queued and or
4230 * running means the interface (and thus, the device) exist and
4233 void usb_queue_reset_device(struct usb_interface *iface)
4235 schedule_work(&iface->reset_ws);
4237 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
4239 struct usb_device *usb_get_hub_child_device(struct usb_device *hdev,
4242 struct usb_hub *hub = hdev_to_hub(hdev);
4244 if (!hub || port1 > hdev->maxchild || port1 < 1)
4246 return hub->port_data[port1 - 1].child;
4248 EXPORT_SYMBOL_GPL(usb_get_hub_child_device);